From e0434bdcbe3c93266134b997b5c1743450507794 Mon Sep 17 00:00:00 2001 From: "Api (Codebuild)" Date: Fri, 19 Jan 2024 17:58:39 +0000 Subject: [PATCH] Look for details in API documentation's changelog --- .openapi-generator/FILES | 192 +++ README.md | 75 + ...teEzsignelementsPositionedByWordRequest.md | 33 + docs/CustomDiscussionconfigurationResponse.md | 34 + ...tomEzmaxinvoicingEzsigndocumentResponse.md | 1 + ...ustomEzmaxinvoicingEzsignfolderResponse.md | 1 + docs/CustomEzsignfoldertypeResponse.md | 2 + docs/CustomEzsignformfieldRequest.md | 2 +- ...teEzsignelementsPositionedByWordRequest.md | 49 + ...teEzsignelementsPositionedByWordRequest.md | 55 + docs/CustomWebhookResponse.md | 1 + docs/DiscussionCreateObjectV1Request.md | 30 + docs/DiscussionCreateObjectV1Response.md | 32 + ...iscussionCreateObjectV1ResponseMPayload.md | 30 + docs/DiscussionDeleteObjectV1Response.md | 31 + docs/DiscussionGetObjectV2Response.md | 32 + docs/DiscussionGetObjectV2ResponseMPayload.md | 30 + docs/DiscussionPatchObjectV1Request.md | 30 + docs/DiscussionPatchObjectV1Response.md | 31 + docs/DiscussionRequest.md | 32 + docs/DiscussionRequestCompound.md | 32 + docs/DiscussionRequestPatch.md | 31 + docs/DiscussionResponse.md | 36 + docs/DiscussionResponseCompound.md | 38 + ...sionUpdateDiscussionreadstatusV1Request.md | 30 + ...ionUpdateDiscussionreadstatusV1Response.md | 31 + ...scussionmembershipCreateObjectV1Request.md | 30 + ...cussionmembershipCreateObjectV1Response.md | 32 + ...embershipCreateObjectV1ResponseMPayload.md | 30 + ...cussionmembershipDeleteObjectV1Response.md | 31 + docs/DiscussionmembershipRequest.md | 35 + docs/DiscussionmembershipRequestCompound.md | 35 + docs/DiscussionmembershipResponse.md | 36 + docs/DiscussionmembershipResponseCompound.md | 36 + .../DiscussionmessageCreateObjectV1Request.md | 30 + ...DiscussionmessageCreateObjectV1Response.md | 32 + ...onmessageCreateObjectV1ResponseMPayload.md | 30 + ...DiscussionmessageDeleteObjectV1Response.md | 31 + docs/DiscussionmessagePatchObjectV1Request.md | 30 + .../DiscussionmessagePatchObjectV1Response.md | 31 + docs/DiscussionmessageRequest.md | 33 + docs/DiscussionmessageRequestCompound.md | 33 + docs/DiscussionmessageRequestPatch.md | 31 + docs/DiscussionmessageResponse.md | 38 + docs/DiscussionmessageResponseCompound.md | 38 + docs/EzsigndiscussionCreateObjectV1Request.md | 30 + .../EzsigndiscussionCreateObjectV1Response.md | 32 + ...iscussionCreateObjectV1ResponseMPayload.md | 30 + .../EzsigndiscussionDeleteObjectV1Response.md | 31 + docs/EzsigndiscussionGetObjectV2Response.md | 32 + ...gndiscussionGetObjectV2ResponseMPayload.md | 30 + docs/EzsigndiscussionRequest.md | 35 + docs/EzsigndiscussionRequestCompound.md | 35 + docs/EzsigndiscussionResponse.md | 36 + docs/EzsigndiscussionResponseCompound.md | 36 + ...gndocumentApplyEzsigntemplateV2Response.md | 1 + ...EzsignelementsPositionedByWordV1Request.md | 31 + ...zsignelementsPositionedByWordV1Response.md | 32 + ...mentsPositionedByWordV1ResponseMPayload.md | 31 + ...ndocumentGetEzsigndiscussionsV1Response.md | 32 + ...tGetEzsigndiscussionsV1ResponseMPayload.md | 30 + ...EzsignfolderGetObjectV1ResponseMPayload.md | 1 + docs/EzsignfolderListElement.md | 1 + docs/EzsignfolderResponse.md | 1 + docs/EzsignfolderResponseCompound.md | 1 + docs/EzsignfoldertypeRequest.md | 3 + docs/EzsignfoldertypeRequestCompound.md | 3 + docs/EzsignfoldertypeResponse.md | 3 + docs/EzsignfoldertypeResponseCompound.md | 3 + docs/EzsignformfieldRequest.md | 2 +- docs/EzsignformfieldRequestCompound.md | 2 +- docs/EzsignformfieldResponse.md | 2 +- docs/EzsignformfieldResponseCompound.md | 2 +- docs/EzsignsignatureResponse.md | 1 + docs/EzsignsignatureResponseCompound.md | 1 + docs/EzsigntemplateformfieldRequest.md | 9 +- .../EzsigntemplateformfieldRequestCompound.md | 9 +- docs/EzsigntemplateformfieldResponse.md | 9 +- ...EzsigntemplateformfieldResponseCompound.md | 9 +- docs/EzsigntemplatesignatureRequest.md | 9 +- .../EzsigntemplatesignatureRequestCompound.md | 9 +- docs/EzsigntemplatesignatureResponse.md | 9 +- ...EzsigntemplatesignatureResponseCompound.md | 9 +- ...zsigntemplatesignaturecustomdateRequest.md | 6 +- ...platesignaturecustomdateRequestCompound.md | 6 +- ...signtemplatesignaturecustomdateResponse.md | 6 +- ...latesignaturecustomdateResponseCompound.md | 6 +- docs/FieldEDiscussionmessageStatus.md | 12 + docs/FieldEEzsignfolderCompletion.md | 12 + docs/FieldEEzsignfoldertypeCompletion.md | 12 + ...ieldEEzsigntemplateformfieldPositioning.md | 12 + ...gntemplateformfieldPositioningoccurence.md | 12 + ...ieldEEzsigntemplatesignaturePositioning.md | 12 + ...gntemplatesignaturePositioningoccurence.md | 12 + docs/ObjectDiscussionApi.md | 429 +++++ docs/ObjectDiscussionmembershipApi.md | 174 ++ docs/ObjectDiscussionmessageApi.md | 262 +++ docs/ObjectEzsigndiscussionApi.md | 257 +++ docs/ObjectEzsigndocumentApi.md | 175 +- docs/UserListElement.md | 1 + docs/UserRequest.md | 1 + docs/UserRequestCompound.md | 1 + docs/UserResponse.md | 1 + docs/UserResponseCompound.md | 1 + docs/WebhookResponse.md | 1 + docs/WebhookResponseCompound.md | 1 + eZmaxApi/__init__.py | 64 + eZmaxApi/api/__init__.py | 4 + eZmaxApi/api/object_discussion_api.py | 1427 +++++++++++++++++ .../api/object_discussionmembership_api.py | 580 +++++++ eZmaxApi/api/object_discussionmessage_api.py | 877 ++++++++++ eZmaxApi/api/object_ezsigndiscussion_api.py | 842 ++++++++++ eZmaxApi/api/object_ezsigndocument_api.py | 571 ++++++- eZmaxApi/models/__init__.py | 60 + ...signelements_positioned_by_word_request.py | 111 ++ ...custom_discussionconfiguration_response.py | 98 ++ ..._ezmaxinvoicing_ezsigndocument_response.py | 6 +- ...om_ezmaxinvoicing_ezsignfolder_response.py | 6 +- .../custom_ezsignfoldertype_response.py | 8 +- .../models/custom_ezsignformfield_request.py | 2 +- ...signelements_positioned_by_word_request.py | 171 ++ ...signelements_positioned_by_word_request.py | 177 ++ eZmaxApi/models/custom_webhook_response.py | 8 +- .../discussion_create_object_v1_request.py | 99 ++ .../discussion_create_object_v1_response.py | 106 ++ ...ion_create_object_v1_response_m_payload.py | 91 ++ .../discussion_delete_object_v1_response.py | 100 ++ .../discussion_get_object_v2_response.py | 106 ++ ...ussion_get_object_v2_response_m_payload.py | 94 ++ .../discussion_patch_object_v1_request.py | 94 ++ .../discussion_patch_object_v1_response.py | 100 ++ eZmaxApi/models/discussion_request.py | 102 ++ .../models/discussion_request_compound.py | 102 ++ eZmaxApi/models/discussion_request_patch.py | 103 ++ eZmaxApi/models/discussion_response.py | 114 ++ .../models/discussion_response_compound.py | 134 ++ ..._update_discussionreadstatus_v1_request.py | 101 ++ ...update_discussionreadstatus_v1_response.py | 100 ++ ...sionmembership_create_object_v1_request.py | 99 ++ ...ionmembership_create_object_v1_response.py | 106 ++ ...hip_create_object_v1_response_m_payload.py | 91 ++ ...ionmembership_delete_object_v1_response.py | 100 ++ .../models/discussionmembership_request.py | 108 ++ .../discussionmembership_request_compound.py | 108 ++ .../models/discussionmembership_response.py | 117 ++ .../discussionmembership_response_compound.py | 117 ++ ...cussionmessage_create_object_v1_request.py | 99 ++ ...ussionmessage_create_object_v1_response.py | 106 ++ ...age_create_object_v1_response_m_payload.py | 91 ++ ...ussionmessage_delete_object_v1_response.py | 100 ++ ...scussionmessage_patch_object_v1_request.py | 94 ++ ...cussionmessage_patch_object_v1_response.py | 100 ++ eZmaxApi/models/discussionmessage_request.py | 104 ++ .../discussionmessage_request_compound.py | 104 ++ .../models/discussionmessage_request_patch.py | 103 ++ eZmaxApi/models/discussionmessage_response.py | 136 ++ .../discussionmessage_response_compound.py | 136 ++ ...signdiscussion_create_object_v1_request.py | 99 ++ ...igndiscussion_create_object_v1_response.py | 106 ++ ...ion_create_object_v1_response_m_payload.py | 91 ++ ...igndiscussion_delete_object_v1_response.py | 100 ++ ...ezsigndiscussion_get_object_v2_response.py | 106 ++ ...ussion_get_object_v2_response_m_payload.py | 94 ++ eZmaxApi/models/ezsigndiscussion_request.py | 105 ++ .../ezsigndiscussion_request_compound.py | 105 ++ eZmaxApi/models/ezsigndiscussion_response.py | 107 ++ .../ezsigndiscussion_response_compound.py | 107 ++ ...cument_apply_ezsigntemplate_v2_response.py | 14 +- ...nelements_positioned_by_word_v1_request.py | 108 ++ ...elements_positioned_by_word_v1_response.py | 106 ++ ...ositioned_by_word_v1_response_m_payload.py | 93 ++ ...ument_get_ezsigndiscussions_v1_response.py | 106 ++ ...ezsigndiscussions_v1_response_m_payload.py | 98 ++ ...folder_get_object_v1_response_m_payload.py | 5 +- eZmaxApi/models/ezsignfolder_list_element.py | 4 +- eZmaxApi/models/ezsignfolder_response.py | 5 +- .../models/ezsignfolder_response_compound.py | 5 +- eZmaxApi/models/ezsignfoldertype_request.py | 9 +- .../ezsignfoldertype_request_compound.py | 9 +- eZmaxApi/models/ezsignfoldertype_response.py | 9 +- .../ezsignfoldertype_response_compound.py | 9 +- eZmaxApi/models/ezsignformfield_request.py | 2 +- .../ezsignformfield_request_compound.py | 2 +- eZmaxApi/models/ezsignformfield_response.py | 2 +- .../ezsignformfield_response_compound.py | 2 +- eZmaxApi/models/ezsignsignature_response.py | 4 +- .../ezsignsignature_response_compound.py | 4 +- .../models/ezsigntemplateformfield_request.py | 32 +- ...zsigntemplateformfield_request_compound.py | 30 +- .../ezsigntemplateformfield_response.py | 32 +- ...signtemplateformfield_response_compound.py | 30 +- .../models/ezsigntemplatesignature_request.py | 30 +- ...zsigntemplatesignature_request_compound.py | 28 +- .../ezsigntemplatesignature_response.py | 30 +- ...signtemplatesignature_response_compound.py | 28 +- ...signtemplatesignaturecustomdate_request.py | 10 +- ...atesignaturecustomdate_request_compound.py | 10 +- ...igntemplatesignaturecustomdate_response.py | 12 +- ...tesignaturecustomdate_response_compound.py | 12 +- .../field_e_discussionmessage_status.py | 47 + .../models/field_e_ezsigndocument_step.py | 1 + .../models/field_e_ezsignfolder_completion.py | 46 + .../field_e_ezsignfoldertype_completion.py | 46 + .../models/field_e_ezsignsignature_type.py | 1 + ...d_e_ezsigntemplateformfield_positioning.py | 46 + ...ntemplateformfield_positioningoccurence.py | 47 + ...d_e_ezsigntemplatesignature_positioning.py | 46 + ...ntemplatesignature_positioningoccurence.py | 47 + .../field_e_ezsigntemplatesignature_type.py | 1 + eZmaxApi/models/user_list_element.py | 16 +- eZmaxApi/models/user_request.py | 14 +- eZmaxApi/models/user_request_compound.py | 14 +- eZmaxApi/models/user_response.py | 14 +- eZmaxApi/models/user_response_compound.py | 14 +- eZmaxApi/models/webhook_response.py | 10 +- eZmaxApi/models/webhook_response_compound.py | 8 +- ...signelements_positioned_by_word_request.py | 60 + ...custom_discussionconfiguration_response.py | 62 + ..._ezmaxinvoicing_ezsigndocument_response.py | 1 + ...om_ezmaxinvoicing_ezsignfolder_response.py | 1 + test/test_custom_ezsignfoldertype_response.py | 4 +- ...signelements_positioned_by_word_request.py | 101 ++ ...signelements_positioned_by_word_request.py | 98 ++ test/test_custom_webhook_response.py | 34 + ...est_discussion_create_object_v1_request.py | 58 + ...st_discussion_create_object_v1_response.py | 75 + ...ion_create_object_v1_response_m_payload.py | 58 + ...st_discussion_delete_object_v1_response.py | 67 + .../test_discussion_get_object_v2_response.py | 71 + ...ussion_get_object_v2_response_m_payload.py | 54 + ...test_discussion_patch_object_v1_request.py | 58 + ...est_discussion_patch_object_v1_response.py | 67 + test/test_discussion_request.py | 56 + test/test_discussion_request_compound.py | 56 + test/test_discussion_request_patch.py | 54 + test/test_discussion_response.py | 64 + test/test_discussion_response_compound.py | 76 + ..._update_discussionreadstatus_v1_request.py | 53 + ...update_discussionreadstatus_v1_response.py | 67 + ...sionmembership_create_object_v1_request.py | 58 + ...ionmembership_create_object_v1_response.py | 75 + ...hip_create_object_v1_response_m_payload.py | 58 + ...ionmembership_delete_object_v1_response.py | 67 + test/test_discussionmembership_request.py | 60 + ...t_discussionmembership_request_compound.py | 60 + test/test_discussionmembership_response.py | 63 + ..._discussionmembership_response_compound.py | 63 + ...cussionmessage_create_object_v1_request.py | 58 + ...ussionmessage_create_object_v1_response.py | 75 + ...age_create_object_v1_response_m_payload.py | 58 + ...ussionmessage_delete_object_v1_response.py | 67 + ...scussionmessage_patch_object_v1_request.py | 58 + ...cussionmessage_patch_object_v1_response.py | 67 + test/test_discussionmessage_request.py | 58 + ...test_discussionmessage_request_compound.py | 58 + test/test_discussionmessage_request_patch.py | 54 + test/test_discussionmessage_response.py | 99 ++ ...est_discussionmessage_response_compound.py | 99 ++ ...signdiscussion_create_object_v1_request.py | 58 + ...igndiscussion_create_object_v1_response.py | 75 + ...ion_create_object_v1_response_m_payload.py | 58 + ...igndiscussion_delete_object_v1_response.py | 67 + ...ezsigndiscussion_get_object_v2_response.py | 71 + ...ussion_get_object_v2_response_m_payload.py | 54 + test/test_ezsigndiscussion_request.py | 69 + .../test_ezsigndiscussion_request_compound.py | 69 + test/test_ezsigndiscussion_response.py | 66 + ...test_ezsigndiscussion_response_compound.py | 66 + ...cument_apply_ezsigntemplate_v2_response.py | 7 +- ...nelements_positioned_by_word_v1_request.py | 64 + ...elements_positioned_by_word_v1_response.py | 81 + ...ositioned_by_word_v1_response_m_payload.py | 64 + ...ument_get_ezsigndiscussions_v1_response.py | 89 + ...ezsigndiscussions_v1_response_m_payload.py | 72 + ...gnfolder_get_list_v1_response_m_payload.py | 2 + ...folder_get_object_v1_response_m_payload.py | 1 + test/test_ezsignfolder_list_element.py | 1 + test/test_ezsignfolder_response.py | 1 + test/test_ezsignfolder_response_compound.py | 1 + test/test_ezsignfoldertype_request.py | 3 + .../test_ezsignfoldertype_request_compound.py | 3 + test/test_ezsignfoldertype_response.py | 3 + ...test_ezsignfoldertype_response_compound.py | 3 + test/test_ezsignsignature_response.py | 1 + .../test_ezsignsignature_response_compound.py | 1 + test/test_ezsigntemplateformfield_request.py | 9 +- ...zsigntemplateformfield_request_compound.py | 7 +- test/test_ezsigntemplateformfield_response.py | 9 +- ...signtemplateformfield_response_compound.py | 7 +- test/test_ezsigntemplatesignature_request.py | 9 +- ...zsigntemplatesignature_request_compound.py | 7 +- test/test_ezsigntemplatesignature_response.py | 9 +- ...signtemplatesignature_response_compound.py | 7 +- ...signtemplatesignaturecustomdate_request.py | 4 +- ...atesignaturecustomdate_request_compound.py | 4 +- ...igntemplatesignaturecustomdate_response.py | 4 +- ...tesignaturecustomdate_response_compound.py | 4 +- test/test_field_e_discussionmessage_status.py | 35 + test/test_field_e_ezsignfolder_completion.py | 35 + ...est_field_e_ezsignfoldertype_completion.py | 35 + ...d_e_ezsigntemplateformfield_positioning.py | 35 + ...ntemplateformfield_positioningoccurence.py | 35 + ...d_e_ezsigntemplatesignature_positioning.py | 35 + ...ntemplatesignature_positioningoccurence.py | 35 + test/test_object_discussion_api.py | 67 + test/test_object_discussionmembership_api.py | 46 + test/test_object_discussionmessage_api.py | 53 + test/test_object_ezsigndiscussion_api.py | 53 + test/test_object_ezsigndocument_api.py | 14 + ...est_user_get_list_v1_response_m_payload.py | 6 +- test/test_user_list_element.py | 3 +- test/test_user_request.py | 1 + test/test_user_request_compound.py | 1 + test/test_user_response.py | 1 + test/test_user_response_compound.py | 1 + ...ebhook_ezsign_ezsignsigner_acceptclause.py | 1 + ...est_webhook_ezsign_ezsignsigner_connect.py | 1 + test/test_webhook_ezsign_folder_completed.py | 2 + test/test_webhook_response.py | 36 +- test/test_webhook_response_compound.py | 34 + 320 files changed, 18527 insertions(+), 150 deletions(-) create mode 100644 docs/CustomCreateEzsignelementsPositionedByWordRequest.md create mode 100644 docs/CustomDiscussionconfigurationResponse.md create mode 100644 docs/CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest.md create mode 100644 docs/CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest.md create mode 100644 docs/DiscussionCreateObjectV1Request.md create mode 100644 docs/DiscussionCreateObjectV1Response.md create mode 100644 docs/DiscussionCreateObjectV1ResponseMPayload.md create mode 100644 docs/DiscussionDeleteObjectV1Response.md create mode 100644 docs/DiscussionGetObjectV2Response.md create mode 100644 docs/DiscussionGetObjectV2ResponseMPayload.md create mode 100644 docs/DiscussionPatchObjectV1Request.md create mode 100644 docs/DiscussionPatchObjectV1Response.md create mode 100644 docs/DiscussionRequest.md create mode 100644 docs/DiscussionRequestCompound.md create mode 100644 docs/DiscussionRequestPatch.md create mode 100644 docs/DiscussionResponse.md create mode 100644 docs/DiscussionResponseCompound.md create mode 100644 docs/DiscussionUpdateDiscussionreadstatusV1Request.md create mode 100644 docs/DiscussionUpdateDiscussionreadstatusV1Response.md create mode 100644 docs/DiscussionmembershipCreateObjectV1Request.md create mode 100644 docs/DiscussionmembershipCreateObjectV1Response.md create mode 100644 docs/DiscussionmembershipCreateObjectV1ResponseMPayload.md create mode 100644 docs/DiscussionmembershipDeleteObjectV1Response.md create mode 100644 docs/DiscussionmembershipRequest.md create mode 100644 docs/DiscussionmembershipRequestCompound.md create mode 100644 docs/DiscussionmembershipResponse.md create mode 100644 docs/DiscussionmembershipResponseCompound.md create mode 100644 docs/DiscussionmessageCreateObjectV1Request.md create mode 100644 docs/DiscussionmessageCreateObjectV1Response.md create mode 100644 docs/DiscussionmessageCreateObjectV1ResponseMPayload.md create mode 100644 docs/DiscussionmessageDeleteObjectV1Response.md create mode 100644 docs/DiscussionmessagePatchObjectV1Request.md create mode 100644 docs/DiscussionmessagePatchObjectV1Response.md create mode 100644 docs/DiscussionmessageRequest.md create mode 100644 docs/DiscussionmessageRequestCompound.md create mode 100644 docs/DiscussionmessageRequestPatch.md create mode 100644 docs/DiscussionmessageResponse.md create mode 100644 docs/DiscussionmessageResponseCompound.md create mode 100644 docs/EzsigndiscussionCreateObjectV1Request.md create mode 100644 docs/EzsigndiscussionCreateObjectV1Response.md create mode 100644 docs/EzsigndiscussionCreateObjectV1ResponseMPayload.md create mode 100644 docs/EzsigndiscussionDeleteObjectV1Response.md create mode 100644 docs/EzsigndiscussionGetObjectV2Response.md create mode 100644 docs/EzsigndiscussionGetObjectV2ResponseMPayload.md create mode 100644 docs/EzsigndiscussionRequest.md create mode 100644 docs/EzsigndiscussionRequestCompound.md create mode 100644 docs/EzsigndiscussionResponse.md create mode 100644 docs/EzsigndiscussionResponseCompound.md create mode 100644 docs/EzsigndocumentCreateEzsignelementsPositionedByWordV1Request.md create mode 100644 docs/EzsigndocumentCreateEzsignelementsPositionedByWordV1Response.md create mode 100644 docs/EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload.md create mode 100644 docs/EzsigndocumentGetEzsigndiscussionsV1Response.md create mode 100644 docs/EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload.md create mode 100644 docs/FieldEDiscussionmessageStatus.md create mode 100644 docs/FieldEEzsignfolderCompletion.md create mode 100644 docs/FieldEEzsignfoldertypeCompletion.md create mode 100644 docs/FieldEEzsigntemplateformfieldPositioning.md create mode 100644 docs/FieldEEzsigntemplateformfieldPositioningoccurence.md create mode 100644 docs/FieldEEzsigntemplatesignaturePositioning.md create mode 100644 docs/FieldEEzsigntemplatesignaturePositioningoccurence.md create mode 100644 docs/ObjectDiscussionApi.md create mode 100644 docs/ObjectDiscussionmembershipApi.md create mode 100644 docs/ObjectDiscussionmessageApi.md create mode 100644 docs/ObjectEzsigndiscussionApi.md create mode 100644 eZmaxApi/api/object_discussion_api.py create mode 100644 eZmaxApi/api/object_discussionmembership_api.py create mode 100644 eZmaxApi/api/object_discussionmessage_api.py create mode 100644 eZmaxApi/api/object_ezsigndiscussion_api.py create mode 100644 eZmaxApi/models/custom_create_ezsignelements_positioned_by_word_request.py create mode 100644 eZmaxApi/models/custom_discussionconfiguration_response.py create mode 100644 eZmaxApi/models/custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request.py create mode 100644 eZmaxApi/models/custom_ezsignsignature_create_ezsignelements_positioned_by_word_request.py create mode 100644 eZmaxApi/models/discussion_create_object_v1_request.py create mode 100644 eZmaxApi/models/discussion_create_object_v1_response.py create mode 100644 eZmaxApi/models/discussion_create_object_v1_response_m_payload.py create mode 100644 eZmaxApi/models/discussion_delete_object_v1_response.py create mode 100644 eZmaxApi/models/discussion_get_object_v2_response.py create mode 100644 eZmaxApi/models/discussion_get_object_v2_response_m_payload.py create mode 100644 eZmaxApi/models/discussion_patch_object_v1_request.py create mode 100644 eZmaxApi/models/discussion_patch_object_v1_response.py create mode 100644 eZmaxApi/models/discussion_request.py create mode 100644 eZmaxApi/models/discussion_request_compound.py create mode 100644 eZmaxApi/models/discussion_request_patch.py create mode 100644 eZmaxApi/models/discussion_response.py create mode 100644 eZmaxApi/models/discussion_response_compound.py create mode 100644 eZmaxApi/models/discussion_update_discussionreadstatus_v1_request.py create mode 100644 eZmaxApi/models/discussion_update_discussionreadstatus_v1_response.py create mode 100644 eZmaxApi/models/discussionmembership_create_object_v1_request.py create mode 100644 eZmaxApi/models/discussionmembership_create_object_v1_response.py create mode 100644 eZmaxApi/models/discussionmembership_create_object_v1_response_m_payload.py create mode 100644 eZmaxApi/models/discussionmembership_delete_object_v1_response.py create mode 100644 eZmaxApi/models/discussionmembership_request.py create mode 100644 eZmaxApi/models/discussionmembership_request_compound.py create mode 100644 eZmaxApi/models/discussionmembership_response.py create mode 100644 eZmaxApi/models/discussionmembership_response_compound.py create mode 100644 eZmaxApi/models/discussionmessage_create_object_v1_request.py create mode 100644 eZmaxApi/models/discussionmessage_create_object_v1_response.py create mode 100644 eZmaxApi/models/discussionmessage_create_object_v1_response_m_payload.py create mode 100644 eZmaxApi/models/discussionmessage_delete_object_v1_response.py create mode 100644 eZmaxApi/models/discussionmessage_patch_object_v1_request.py create mode 100644 eZmaxApi/models/discussionmessage_patch_object_v1_response.py create mode 100644 eZmaxApi/models/discussionmessage_request.py create mode 100644 eZmaxApi/models/discussionmessage_request_compound.py create mode 100644 eZmaxApi/models/discussionmessage_request_patch.py create mode 100644 eZmaxApi/models/discussionmessage_response.py create mode 100644 eZmaxApi/models/discussionmessage_response_compound.py create mode 100644 eZmaxApi/models/ezsigndiscussion_create_object_v1_request.py create mode 100644 eZmaxApi/models/ezsigndiscussion_create_object_v1_response.py create mode 100644 eZmaxApi/models/ezsigndiscussion_create_object_v1_response_m_payload.py create mode 100644 eZmaxApi/models/ezsigndiscussion_delete_object_v1_response.py create mode 100644 eZmaxApi/models/ezsigndiscussion_get_object_v2_response.py create mode 100644 eZmaxApi/models/ezsigndiscussion_get_object_v2_response_m_payload.py create mode 100644 eZmaxApi/models/ezsigndiscussion_request.py create mode 100644 eZmaxApi/models/ezsigndiscussion_request_compound.py create mode 100644 eZmaxApi/models/ezsigndiscussion_response.py create mode 100644 eZmaxApi/models/ezsigndiscussion_response_compound.py create mode 100644 eZmaxApi/models/ezsigndocument_create_ezsignelements_positioned_by_word_v1_request.py create mode 100644 eZmaxApi/models/ezsigndocument_create_ezsignelements_positioned_by_word_v1_response.py create mode 100644 eZmaxApi/models/ezsigndocument_create_ezsignelements_positioned_by_word_v1_response_m_payload.py create mode 100644 eZmaxApi/models/ezsigndocument_get_ezsigndiscussions_v1_response.py create mode 100644 eZmaxApi/models/ezsigndocument_get_ezsigndiscussions_v1_response_m_payload.py create mode 100644 eZmaxApi/models/field_e_discussionmessage_status.py create mode 100644 eZmaxApi/models/field_e_ezsignfolder_completion.py create mode 100644 eZmaxApi/models/field_e_ezsignfoldertype_completion.py create mode 100644 eZmaxApi/models/field_e_ezsigntemplateformfield_positioning.py create mode 100644 eZmaxApi/models/field_e_ezsigntemplateformfield_positioningoccurence.py create mode 100644 eZmaxApi/models/field_e_ezsigntemplatesignature_positioning.py create mode 100644 eZmaxApi/models/field_e_ezsigntemplatesignature_positioningoccurence.py create mode 100644 test/test_custom_create_ezsignelements_positioned_by_word_request.py create mode 100644 test/test_custom_discussionconfiguration_response.py create mode 100644 test/test_custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request.py create mode 100644 test/test_custom_ezsignsignature_create_ezsignelements_positioned_by_word_request.py create mode 100644 test/test_discussion_create_object_v1_request.py create mode 100644 test/test_discussion_create_object_v1_response.py create mode 100644 test/test_discussion_create_object_v1_response_m_payload.py create mode 100644 test/test_discussion_delete_object_v1_response.py create mode 100644 test/test_discussion_get_object_v2_response.py create mode 100644 test/test_discussion_get_object_v2_response_m_payload.py create mode 100644 test/test_discussion_patch_object_v1_request.py create mode 100644 test/test_discussion_patch_object_v1_response.py create mode 100644 test/test_discussion_request.py create mode 100644 test/test_discussion_request_compound.py create mode 100644 test/test_discussion_request_patch.py create mode 100644 test/test_discussion_response.py create mode 100644 test/test_discussion_response_compound.py create mode 100644 test/test_discussion_update_discussionreadstatus_v1_request.py create mode 100644 test/test_discussion_update_discussionreadstatus_v1_response.py create mode 100644 test/test_discussionmembership_create_object_v1_request.py create mode 100644 test/test_discussionmembership_create_object_v1_response.py create mode 100644 test/test_discussionmembership_create_object_v1_response_m_payload.py create mode 100644 test/test_discussionmembership_delete_object_v1_response.py create mode 100644 test/test_discussionmembership_request.py create mode 100644 test/test_discussionmembership_request_compound.py create mode 100644 test/test_discussionmembership_response.py create mode 100644 test/test_discussionmembership_response_compound.py create mode 100644 test/test_discussionmessage_create_object_v1_request.py create mode 100644 test/test_discussionmessage_create_object_v1_response.py create mode 100644 test/test_discussionmessage_create_object_v1_response_m_payload.py create mode 100644 test/test_discussionmessage_delete_object_v1_response.py create mode 100644 test/test_discussionmessage_patch_object_v1_request.py create mode 100644 test/test_discussionmessage_patch_object_v1_response.py create mode 100644 test/test_discussionmessage_request.py create mode 100644 test/test_discussionmessage_request_compound.py create mode 100644 test/test_discussionmessage_request_patch.py create mode 100644 test/test_discussionmessage_response.py create mode 100644 test/test_discussionmessage_response_compound.py create mode 100644 test/test_ezsigndiscussion_create_object_v1_request.py create mode 100644 test/test_ezsigndiscussion_create_object_v1_response.py create mode 100644 test/test_ezsigndiscussion_create_object_v1_response_m_payload.py create mode 100644 test/test_ezsigndiscussion_delete_object_v1_response.py create mode 100644 test/test_ezsigndiscussion_get_object_v2_response.py create mode 100644 test/test_ezsigndiscussion_get_object_v2_response_m_payload.py create mode 100644 test/test_ezsigndiscussion_request.py create mode 100644 test/test_ezsigndiscussion_request_compound.py create mode 100644 test/test_ezsigndiscussion_response.py create mode 100644 test/test_ezsigndiscussion_response_compound.py create mode 100644 test/test_ezsigndocument_create_ezsignelements_positioned_by_word_v1_request.py create mode 100644 test/test_ezsigndocument_create_ezsignelements_positioned_by_word_v1_response.py create mode 100644 test/test_ezsigndocument_create_ezsignelements_positioned_by_word_v1_response_m_payload.py create mode 100644 test/test_ezsigndocument_get_ezsigndiscussions_v1_response.py create mode 100644 test/test_ezsigndocument_get_ezsigndiscussions_v1_response_m_payload.py create mode 100644 test/test_field_e_discussionmessage_status.py create mode 100644 test/test_field_e_ezsignfolder_completion.py create mode 100644 test/test_field_e_ezsignfoldertype_completion.py create mode 100644 test/test_field_e_ezsigntemplateformfield_positioning.py create mode 100644 test/test_field_e_ezsigntemplateformfield_positioningoccurence.py create mode 100644 test/test_field_e_ezsigntemplatesignature_positioning.py create mode 100644 test/test_field_e_ezsigntemplatesignature_positioningoccurence.py create mode 100644 test/test_object_discussion_api.py create mode 100644 test/test_object_discussionmembership_api.py create mode 100644 test/test_object_discussionmessage_api.py create mode 100644 test/test_object_ezsigndiscussion_api.py diff --git a/.openapi-generator/FILES b/.openapi-generator/FILES index f5de9060d..2c5eb94cf 100644 --- a/.openapi-generator/FILES +++ b/.openapi-generator/FILES @@ -171,7 +171,9 @@ docs/CustomCommunicationrecipientsrecipientResponse.md docs/CustomCommunicationsenderRequest.md docs/CustomCommunicationsenderResponse.md docs/CustomContactNameResponse.md +docs/CustomCreateEzsignelementsPositionedByWordRequest.md docs/CustomCreditcardtransactionResponse.md +docs/CustomDiscussionconfigurationResponse.md docs/CustomDropdownElementRequest.md docs/CustomDropdownElementRequestCompound.md docs/CustomDropdownElementResponse.md @@ -190,7 +192,9 @@ docs/CustomEzsignfoldertypeResponse.md docs/CustomEzsignformfieldRequest.md docs/CustomEzsignformfielderrorResponse.md docs/CustomEzsignformfielderrortestResponse.md +docs/CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest.md docs/CustomEzsignformfieldgroupRequest.md +docs/CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest.md docs/CustomEzsignsignatureEzsignsignaturesAutomaticResponse.md docs/CustomEzsignsignaturestatusResponse.md docs/CustomFormDataDocumentResponse.md @@ -209,6 +213,40 @@ docs/CustomWordPositionWordResponse.md docs/DepartmentAutocompleteElementResponse.md docs/DepartmentGetAutocompleteV2Response.md docs/DepartmentGetAutocompleteV2ResponseMPayload.md +docs/DiscussionCreateObjectV1Request.md +docs/DiscussionCreateObjectV1Response.md +docs/DiscussionCreateObjectV1ResponseMPayload.md +docs/DiscussionDeleteObjectV1Response.md +docs/DiscussionGetObjectV2Response.md +docs/DiscussionGetObjectV2ResponseMPayload.md +docs/DiscussionPatchObjectV1Request.md +docs/DiscussionPatchObjectV1Response.md +docs/DiscussionRequest.md +docs/DiscussionRequestCompound.md +docs/DiscussionRequestPatch.md +docs/DiscussionResponse.md +docs/DiscussionResponseCompound.md +docs/DiscussionUpdateDiscussionreadstatusV1Request.md +docs/DiscussionUpdateDiscussionreadstatusV1Response.md +docs/DiscussionmembershipCreateObjectV1Request.md +docs/DiscussionmembershipCreateObjectV1Response.md +docs/DiscussionmembershipCreateObjectV1ResponseMPayload.md +docs/DiscussionmembershipDeleteObjectV1Response.md +docs/DiscussionmembershipRequest.md +docs/DiscussionmembershipRequestCompound.md +docs/DiscussionmembershipResponse.md +docs/DiscussionmembershipResponseCompound.md +docs/DiscussionmessageCreateObjectV1Request.md +docs/DiscussionmessageCreateObjectV1Response.md +docs/DiscussionmessageCreateObjectV1ResponseMPayload.md +docs/DiscussionmessageDeleteObjectV1Response.md +docs/DiscussionmessagePatchObjectV1Request.md +docs/DiscussionmessagePatchObjectV1Response.md +docs/DiscussionmessageRequest.md +docs/DiscussionmessageRequestCompound.md +docs/DiscussionmessageRequestPatch.md +docs/DiscussionmessageResponse.md +docs/DiscussionmessageResponseCompound.md docs/ElectronicfundstransferGetCommunicationListV1Response.md docs/ElectronicfundstransferGetCommunicationListV1ResponseMPayload.md docs/EmailRequest.md @@ -313,10 +351,23 @@ docs/EzsignbulksendtransmissionGetObjectV2Response.md docs/EzsignbulksendtransmissionGetObjectV2ResponseMPayload.md docs/EzsignbulksendtransmissionResponse.md docs/EzsignbulksendtransmissionResponseCompound.md +docs/EzsigndiscussionCreateObjectV1Request.md +docs/EzsigndiscussionCreateObjectV1Response.md +docs/EzsigndiscussionCreateObjectV1ResponseMPayload.md +docs/EzsigndiscussionDeleteObjectV1Response.md +docs/EzsigndiscussionGetObjectV2Response.md +docs/EzsigndiscussionGetObjectV2ResponseMPayload.md +docs/EzsigndiscussionRequest.md +docs/EzsigndiscussionRequestCompound.md +docs/EzsigndiscussionResponse.md +docs/EzsigndiscussionResponseCompound.md docs/EzsigndocumentApplyEzsigntemplateV1Request.md docs/EzsigndocumentApplyEzsigntemplateV1Response.md docs/EzsigndocumentApplyEzsigntemplateV2Request.md docs/EzsigndocumentApplyEzsigntemplateV2Response.md +docs/EzsigndocumentCreateEzsignelementsPositionedByWordV1Request.md +docs/EzsigndocumentCreateEzsignelementsPositionedByWordV1Response.md +docs/EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload.md docs/EzsigndocumentCreateObjectV1Request.md docs/EzsigndocumentCreateObjectV1Response.md docs/EzsigndocumentCreateObjectV1ResponseMPayload.md @@ -344,6 +395,8 @@ docs/EzsigndocumentGetDownloadUrlV1Response.md docs/EzsigndocumentGetDownloadUrlV1ResponseMPayload.md docs/EzsigndocumentGetEzsignannotationsV1Response.md docs/EzsigndocumentGetEzsignannotationsV1ResponseMPayload.md +docs/EzsigndocumentGetEzsigndiscussionsV1Response.md +docs/EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload.md docs/EzsigndocumentGetEzsignformfieldgroupsV1Response.md docs/EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload.md docs/EzsigndocumentGetEzsignpagesV1Response.md @@ -758,6 +811,7 @@ docs/FieldECommunicationType.md docs/FieldECommunicationexternalrecipientType.md docs/FieldECommunicationrecipientType.md docs/FieldECreditcardtypeCodename.md +docs/FieldEDiscussionmessageStatus.md docs/FieldEErrorCode.md docs/FieldEEzmaxinvoicingPaymenttype.md docs/FieldEEzmaxinvoicingagentVariationezmax.md @@ -769,8 +823,10 @@ docs/FieldEEzsigndocumentStep.md docs/FieldEEzsigndocumentlogType.md docs/FieldEEzsignelementdependencyOperator.md docs/FieldEEzsignelementdependencyValidation.md +docs/FieldEEzsignfolderCompletion.md docs/FieldEEzsignfolderSendreminderfrequency.md docs/FieldEEzsignfolderStep.md +docs/FieldEEzsignfoldertypeCompletion.md docs/FieldEEzsignfoldertypeDisposal.md docs/FieldEEzsignfoldertypePrivacylevel.md docs/FieldEEzsignfoldertypeSendreminderfrequency.md @@ -786,12 +842,16 @@ docs/FieldEEzsignsignatureType.md docs/FieldEEzsigntemplateelementdependencyOperator.md docs/FieldEEzsigntemplateelementdependencyValidation.md docs/FieldEEzsigntemplateformfieldDependencyrequirement.md +docs/FieldEEzsigntemplateformfieldPositioning.md +docs/FieldEEzsigntemplateformfieldPositioningoccurence.md docs/FieldEEzsigntemplateformfieldgroupSignerrequirement.md docs/FieldEEzsigntemplateformfieldgroupTooltipposition.md docs/FieldEEzsigntemplateformfieldgroupType.md docs/FieldEEzsigntemplatesignatureAttachmentnamesource.md docs/FieldEEzsigntemplatesignatureDependencyrequirement.md docs/FieldEEzsigntemplatesignatureFont.md +docs/FieldEEzsigntemplatesignaturePositioning.md +docs/FieldEEzsigntemplatesignaturePositioningoccurence.md docs/FieldEEzsigntemplatesignatureTooltipposition.md docs/FieldEEzsigntemplatesignatureType.md docs/FieldENotificationpreferenceStatus.md @@ -899,6 +959,9 @@ docs/ObjectCommunicationApi.md docs/ObjectCompanyApi.md docs/ObjectCorsApi.md docs/ObjectDepartmentApi.md +docs/ObjectDiscussionApi.md +docs/ObjectDiscussionmembershipApi.md +docs/ObjectDiscussionmessageApi.md docs/ObjectElectronicfundstransferApi.md docs/ObjectEmailtypeApi.md docs/ObjectEzmaxinvoicingApi.md @@ -907,6 +970,7 @@ docs/ObjectEzsignbulksendApi.md docs/ObjectEzsignbulksenddocumentmappingApi.md docs/ObjectEzsignbulksendsignermappingApi.md docs/ObjectEzsignbulksendtransmissionApi.md +docs/ObjectEzsigndiscussionApi.md docs/ObjectEzsigndocumentApi.md docs/ObjectEzsignfolderApi.md docs/ObjectEzsignfoldersignerassociationApi.md @@ -1249,6 +1313,9 @@ eZmaxApi/api/object_communication_api.py eZmaxApi/api/object_company_api.py eZmaxApi/api/object_cors_api.py eZmaxApi/api/object_department_api.py +eZmaxApi/api/object_discussion_api.py +eZmaxApi/api/object_discussionmembership_api.py +eZmaxApi/api/object_discussionmessage_api.py eZmaxApi/api/object_electronicfundstransfer_api.py eZmaxApi/api/object_emailtype_api.py eZmaxApi/api/object_ezmaxinvoicing_api.py @@ -1257,6 +1324,7 @@ eZmaxApi/api/object_ezsignbulksend_api.py eZmaxApi/api/object_ezsignbulksenddocumentmapping_api.py eZmaxApi/api/object_ezsignbulksendsignermapping_api.py eZmaxApi/api/object_ezsignbulksendtransmission_api.py +eZmaxApi/api/object_ezsigndiscussion_api.py eZmaxApi/api/object_ezsigndocument_api.py eZmaxApi/api/object_ezsignfolder_api.py eZmaxApi/api/object_ezsignfoldersignerassociation_api.py @@ -1486,7 +1554,9 @@ eZmaxApi/models/custom_communicationrecipientsrecipient_response.py eZmaxApi/models/custom_communicationsender_request.py eZmaxApi/models/custom_communicationsender_response.py eZmaxApi/models/custom_contact_name_response.py +eZmaxApi/models/custom_create_ezsignelements_positioned_by_word_request.py eZmaxApi/models/custom_creditcardtransaction_response.py +eZmaxApi/models/custom_discussionconfiguration_response.py eZmaxApi/models/custom_dropdown_element_request.py eZmaxApi/models/custom_dropdown_element_request_compound.py eZmaxApi/models/custom_dropdown_element_response.py @@ -1505,7 +1575,9 @@ eZmaxApi/models/custom_ezsignfoldertype_response.py eZmaxApi/models/custom_ezsignformfield_request.py eZmaxApi/models/custom_ezsignformfielderror_response.py eZmaxApi/models/custom_ezsignformfielderrortest_response.py +eZmaxApi/models/custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request.py eZmaxApi/models/custom_ezsignformfieldgroup_request.py +eZmaxApi/models/custom_ezsignsignature_create_ezsignelements_positioned_by_word_request.py eZmaxApi/models/custom_ezsignsignature_ezsignsignatures_automatic_response.py eZmaxApi/models/custom_ezsignsignaturestatus_response.py eZmaxApi/models/custom_form_data_document_response.py @@ -1524,6 +1596,40 @@ eZmaxApi/models/custom_word_position_word_response.py eZmaxApi/models/department_autocomplete_element_response.py eZmaxApi/models/department_get_autocomplete_v2_response.py eZmaxApi/models/department_get_autocomplete_v2_response_m_payload.py +eZmaxApi/models/discussion_create_object_v1_request.py +eZmaxApi/models/discussion_create_object_v1_response.py +eZmaxApi/models/discussion_create_object_v1_response_m_payload.py +eZmaxApi/models/discussion_delete_object_v1_response.py +eZmaxApi/models/discussion_get_object_v2_response.py +eZmaxApi/models/discussion_get_object_v2_response_m_payload.py +eZmaxApi/models/discussion_patch_object_v1_request.py +eZmaxApi/models/discussion_patch_object_v1_response.py +eZmaxApi/models/discussion_request.py +eZmaxApi/models/discussion_request_compound.py +eZmaxApi/models/discussion_request_patch.py +eZmaxApi/models/discussion_response.py +eZmaxApi/models/discussion_response_compound.py +eZmaxApi/models/discussion_update_discussionreadstatus_v1_request.py +eZmaxApi/models/discussion_update_discussionreadstatus_v1_response.py +eZmaxApi/models/discussionmembership_create_object_v1_request.py +eZmaxApi/models/discussionmembership_create_object_v1_response.py +eZmaxApi/models/discussionmembership_create_object_v1_response_m_payload.py +eZmaxApi/models/discussionmembership_delete_object_v1_response.py +eZmaxApi/models/discussionmembership_request.py +eZmaxApi/models/discussionmembership_request_compound.py +eZmaxApi/models/discussionmembership_response.py +eZmaxApi/models/discussionmembership_response_compound.py +eZmaxApi/models/discussionmessage_create_object_v1_request.py +eZmaxApi/models/discussionmessage_create_object_v1_response.py +eZmaxApi/models/discussionmessage_create_object_v1_response_m_payload.py +eZmaxApi/models/discussionmessage_delete_object_v1_response.py +eZmaxApi/models/discussionmessage_patch_object_v1_request.py +eZmaxApi/models/discussionmessage_patch_object_v1_response.py +eZmaxApi/models/discussionmessage_request.py +eZmaxApi/models/discussionmessage_request_compound.py +eZmaxApi/models/discussionmessage_request_patch.py +eZmaxApi/models/discussionmessage_response.py +eZmaxApi/models/discussionmessage_response_compound.py eZmaxApi/models/electronicfundstransfer_get_communication_list_v1_response.py eZmaxApi/models/electronicfundstransfer_get_communication_list_v1_response_m_payload.py eZmaxApi/models/email_request.py @@ -1628,10 +1734,23 @@ eZmaxApi/models/ezsignbulksendtransmission_get_object_v2_response.py eZmaxApi/models/ezsignbulksendtransmission_get_object_v2_response_m_payload.py eZmaxApi/models/ezsignbulksendtransmission_response.py eZmaxApi/models/ezsignbulksendtransmission_response_compound.py +eZmaxApi/models/ezsigndiscussion_create_object_v1_request.py +eZmaxApi/models/ezsigndiscussion_create_object_v1_response.py +eZmaxApi/models/ezsigndiscussion_create_object_v1_response_m_payload.py +eZmaxApi/models/ezsigndiscussion_delete_object_v1_response.py +eZmaxApi/models/ezsigndiscussion_get_object_v2_response.py +eZmaxApi/models/ezsigndiscussion_get_object_v2_response_m_payload.py +eZmaxApi/models/ezsigndiscussion_request.py +eZmaxApi/models/ezsigndiscussion_request_compound.py +eZmaxApi/models/ezsigndiscussion_response.py +eZmaxApi/models/ezsigndiscussion_response_compound.py eZmaxApi/models/ezsigndocument_apply_ezsigntemplate_v1_request.py eZmaxApi/models/ezsigndocument_apply_ezsigntemplate_v1_response.py eZmaxApi/models/ezsigndocument_apply_ezsigntemplate_v2_request.py eZmaxApi/models/ezsigndocument_apply_ezsigntemplate_v2_response.py +eZmaxApi/models/ezsigndocument_create_ezsignelements_positioned_by_word_v1_request.py +eZmaxApi/models/ezsigndocument_create_ezsignelements_positioned_by_word_v1_response.py +eZmaxApi/models/ezsigndocument_create_ezsignelements_positioned_by_word_v1_response_m_payload.py eZmaxApi/models/ezsigndocument_create_object_v1_request.py eZmaxApi/models/ezsigndocument_create_object_v1_response.py eZmaxApi/models/ezsigndocument_create_object_v1_response_m_payload.py @@ -1659,6 +1778,8 @@ eZmaxApi/models/ezsigndocument_get_download_url_v1_response.py eZmaxApi/models/ezsigndocument_get_download_url_v1_response_m_payload.py eZmaxApi/models/ezsigndocument_get_ezsignannotations_v1_response.py eZmaxApi/models/ezsigndocument_get_ezsignannotations_v1_response_m_payload.py +eZmaxApi/models/ezsigndocument_get_ezsigndiscussions_v1_response.py +eZmaxApi/models/ezsigndocument_get_ezsigndiscussions_v1_response_m_payload.py eZmaxApi/models/ezsigndocument_get_ezsignformfieldgroups_v1_response.py eZmaxApi/models/ezsigndocument_get_ezsignformfieldgroups_v1_response_m_payload.py eZmaxApi/models/ezsigndocument_get_ezsignpages_v1_response.py @@ -2073,6 +2194,7 @@ eZmaxApi/models/field_e_communication_type.py eZmaxApi/models/field_e_communicationexternalrecipient_type.py eZmaxApi/models/field_e_communicationrecipient_type.py eZmaxApi/models/field_e_creditcardtype_codename.py +eZmaxApi/models/field_e_discussionmessage_status.py eZmaxApi/models/field_e_error_code.py eZmaxApi/models/field_e_ezmaxinvoicing_paymenttype.py eZmaxApi/models/field_e_ezmaxinvoicingagent_variationezmax.py @@ -2084,8 +2206,10 @@ eZmaxApi/models/field_e_ezsigndocument_step.py eZmaxApi/models/field_e_ezsigndocumentlog_type.py eZmaxApi/models/field_e_ezsignelementdependency_operator.py eZmaxApi/models/field_e_ezsignelementdependency_validation.py +eZmaxApi/models/field_e_ezsignfolder_completion.py eZmaxApi/models/field_e_ezsignfolder_sendreminderfrequency.py eZmaxApi/models/field_e_ezsignfolder_step.py +eZmaxApi/models/field_e_ezsignfoldertype_completion.py eZmaxApi/models/field_e_ezsignfoldertype_disposal.py eZmaxApi/models/field_e_ezsignfoldertype_privacylevel.py eZmaxApi/models/field_e_ezsignfoldertype_sendreminderfrequency.py @@ -2101,12 +2225,16 @@ eZmaxApi/models/field_e_ezsignsignature_type.py eZmaxApi/models/field_e_ezsigntemplateelementdependency_operator.py eZmaxApi/models/field_e_ezsigntemplateelementdependency_validation.py eZmaxApi/models/field_e_ezsigntemplateformfield_dependencyrequirement.py +eZmaxApi/models/field_e_ezsigntemplateformfield_positioning.py +eZmaxApi/models/field_e_ezsigntemplateformfield_positioningoccurence.py eZmaxApi/models/field_e_ezsigntemplateformfieldgroup_signerrequirement.py eZmaxApi/models/field_e_ezsigntemplateformfieldgroup_tooltipposition.py eZmaxApi/models/field_e_ezsigntemplateformfieldgroup_type.py eZmaxApi/models/field_e_ezsigntemplatesignature_attachmentnamesource.py eZmaxApi/models/field_e_ezsigntemplatesignature_dependencyrequirement.py eZmaxApi/models/field_e_ezsigntemplatesignature_font.py +eZmaxApi/models/field_e_ezsigntemplatesignature_positioning.py +eZmaxApi/models/field_e_ezsigntemplatesignature_positioningoccurence.py eZmaxApi/models/field_e_ezsigntemplatesignature_tooltipposition.py eZmaxApi/models/field_e_ezsigntemplatesignature_type.py eZmaxApi/models/field_e_notificationpreference_status.py @@ -2637,7 +2765,9 @@ test/test_custom_communicationrecipientsrecipient_response.py test/test_custom_communicationsender_request.py test/test_custom_communicationsender_response.py test/test_custom_contact_name_response.py +test/test_custom_create_ezsignelements_positioned_by_word_request.py test/test_custom_creditcardtransaction_response.py +test/test_custom_discussionconfiguration_response.py test/test_custom_dropdown_element_request.py test/test_custom_dropdown_element_request_compound.py test/test_custom_dropdown_element_response.py @@ -2656,7 +2786,9 @@ test/test_custom_ezsignfoldertype_response.py test/test_custom_ezsignformfield_request.py test/test_custom_ezsignformfielderror_response.py test/test_custom_ezsignformfielderrortest_response.py +test/test_custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request.py test/test_custom_ezsignformfieldgroup_request.py +test/test_custom_ezsignsignature_create_ezsignelements_positioned_by_word_request.py test/test_custom_ezsignsignature_ezsignsignatures_automatic_response.py test/test_custom_ezsignsignaturestatus_response.py test/test_custom_form_data_document_response.py @@ -2675,6 +2807,40 @@ test/test_custom_word_position_word_response.py test/test_department_autocomplete_element_response.py test/test_department_get_autocomplete_v2_response.py test/test_department_get_autocomplete_v2_response_m_payload.py +test/test_discussion_create_object_v1_request.py +test/test_discussion_create_object_v1_response.py +test/test_discussion_create_object_v1_response_m_payload.py +test/test_discussion_delete_object_v1_response.py +test/test_discussion_get_object_v2_response.py +test/test_discussion_get_object_v2_response_m_payload.py +test/test_discussion_patch_object_v1_request.py +test/test_discussion_patch_object_v1_response.py +test/test_discussion_request.py +test/test_discussion_request_compound.py +test/test_discussion_request_patch.py +test/test_discussion_response.py +test/test_discussion_response_compound.py +test/test_discussion_update_discussionreadstatus_v1_request.py +test/test_discussion_update_discussionreadstatus_v1_response.py +test/test_discussionmembership_create_object_v1_request.py +test/test_discussionmembership_create_object_v1_response.py +test/test_discussionmembership_create_object_v1_response_m_payload.py +test/test_discussionmembership_delete_object_v1_response.py +test/test_discussionmembership_request.py +test/test_discussionmembership_request_compound.py +test/test_discussionmembership_response.py +test/test_discussionmembership_response_compound.py +test/test_discussionmessage_create_object_v1_request.py +test/test_discussionmessage_create_object_v1_response.py +test/test_discussionmessage_create_object_v1_response_m_payload.py +test/test_discussionmessage_delete_object_v1_response.py +test/test_discussionmessage_patch_object_v1_request.py +test/test_discussionmessage_patch_object_v1_response.py +test/test_discussionmessage_request.py +test/test_discussionmessage_request_compound.py +test/test_discussionmessage_request_patch.py +test/test_discussionmessage_response.py +test/test_discussionmessage_response_compound.py test/test_electronicfundstransfer_get_communication_list_v1_response.py test/test_electronicfundstransfer_get_communication_list_v1_response_m_payload.py test/test_email_request.py @@ -2779,10 +2945,23 @@ test/test_ezsignbulksendtransmission_get_object_v2_response.py test/test_ezsignbulksendtransmission_get_object_v2_response_m_payload.py test/test_ezsignbulksendtransmission_response.py test/test_ezsignbulksendtransmission_response_compound.py +test/test_ezsigndiscussion_create_object_v1_request.py +test/test_ezsigndiscussion_create_object_v1_response.py +test/test_ezsigndiscussion_create_object_v1_response_m_payload.py +test/test_ezsigndiscussion_delete_object_v1_response.py +test/test_ezsigndiscussion_get_object_v2_response.py +test/test_ezsigndiscussion_get_object_v2_response_m_payload.py +test/test_ezsigndiscussion_request.py +test/test_ezsigndiscussion_request_compound.py +test/test_ezsigndiscussion_response.py +test/test_ezsigndiscussion_response_compound.py test/test_ezsigndocument_apply_ezsigntemplate_v1_request.py test/test_ezsigndocument_apply_ezsigntemplate_v1_response.py test/test_ezsigndocument_apply_ezsigntemplate_v2_request.py test/test_ezsigndocument_apply_ezsigntemplate_v2_response.py +test/test_ezsigndocument_create_ezsignelements_positioned_by_word_v1_request.py +test/test_ezsigndocument_create_ezsignelements_positioned_by_word_v1_response.py +test/test_ezsigndocument_create_ezsignelements_positioned_by_word_v1_response_m_payload.py test/test_ezsigndocument_create_object_v1_request.py test/test_ezsigndocument_create_object_v1_response.py test/test_ezsigndocument_create_object_v1_response_m_payload.py @@ -2810,6 +2989,8 @@ test/test_ezsigndocument_get_download_url_v1_response.py test/test_ezsigndocument_get_download_url_v1_response_m_payload.py test/test_ezsigndocument_get_ezsignannotations_v1_response.py test/test_ezsigndocument_get_ezsignannotations_v1_response_m_payload.py +test/test_ezsigndocument_get_ezsigndiscussions_v1_response.py +test/test_ezsigndocument_get_ezsigndiscussions_v1_response_m_payload.py test/test_ezsigndocument_get_ezsignformfieldgroups_v1_response.py test/test_ezsigndocument_get_ezsignformfieldgroups_v1_response_m_payload.py test/test_ezsigndocument_get_ezsignpages_v1_response.py @@ -3224,6 +3405,7 @@ test/test_field_e_communication_type.py test/test_field_e_communicationexternalrecipient_type.py test/test_field_e_communicationrecipient_type.py test/test_field_e_creditcardtype_codename.py +test/test_field_e_discussionmessage_status.py test/test_field_e_error_code.py test/test_field_e_ezmaxinvoicing_paymenttype.py test/test_field_e_ezmaxinvoicingagent_variationezmax.py @@ -3235,8 +3417,10 @@ test/test_field_e_ezsigndocument_step.py test/test_field_e_ezsigndocumentlog_type.py test/test_field_e_ezsignelementdependency_operator.py test/test_field_e_ezsignelementdependency_validation.py +test/test_field_e_ezsignfolder_completion.py test/test_field_e_ezsignfolder_sendreminderfrequency.py test/test_field_e_ezsignfolder_step.py +test/test_field_e_ezsignfoldertype_completion.py test/test_field_e_ezsignfoldertype_disposal.py test/test_field_e_ezsignfoldertype_privacylevel.py test/test_field_e_ezsignfoldertype_sendreminderfrequency.py @@ -3252,12 +3436,16 @@ test/test_field_e_ezsignsignature_type.py test/test_field_e_ezsigntemplateelementdependency_operator.py test/test_field_e_ezsigntemplateelementdependency_validation.py test/test_field_e_ezsigntemplateformfield_dependencyrequirement.py +test/test_field_e_ezsigntemplateformfield_positioning.py +test/test_field_e_ezsigntemplateformfield_positioningoccurence.py test/test_field_e_ezsigntemplateformfieldgroup_signerrequirement.py test/test_field_e_ezsigntemplateformfieldgroup_tooltipposition.py test/test_field_e_ezsigntemplateformfieldgroup_type.py test/test_field_e_ezsigntemplatesignature_attachmentnamesource.py test/test_field_e_ezsigntemplatesignature_dependencyrequirement.py test/test_field_e_ezsigntemplatesignature_font.py +test/test_field_e_ezsigntemplatesignature_positioning.py +test/test_field_e_ezsigntemplatesignature_positioningoccurence.py test/test_field_e_ezsigntemplatesignature_tooltipposition.py test/test_field_e_ezsigntemplatesignature_type.py test/test_field_e_notificationpreference_status.py @@ -3365,6 +3553,9 @@ test/test_object_communication_api.py test/test_object_company_api.py test/test_object_cors_api.py test/test_object_department_api.py +test/test_object_discussion_api.py +test/test_object_discussionmembership_api.py +test/test_object_discussionmessage_api.py test/test_object_electronicfundstransfer_api.py test/test_object_emailtype_api.py test/test_object_ezmaxinvoicing_api.py @@ -3373,6 +3564,7 @@ test/test_object_ezsignbulksend_api.py test/test_object_ezsignbulksenddocumentmapping_api.py test/test_object_ezsignbulksendsignermapping_api.py test/test_object_ezsignbulksendtransmission_api.py +test/test_object_ezsigndiscussion_api.py test/test_object_ezsigndocument_api.py test/test_object_ezsignfolder_api.py test/test_object_ezsignfoldersignerassociation_api.py diff --git a/README.md b/README.md index 8a850f353..1ed379ea3 100644 --- a/README.md +++ b/README.md @@ -128,6 +128,16 @@ 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 +*ObjectDiscussionApi* | [**discussion_create_object_v1**](docs/ObjectDiscussionApi.md#discussion_create_object_v1) | **POST** /1/object/discussion | Create a new Discussion +*ObjectDiscussionApi* | [**discussion_delete_object_v1**](docs/ObjectDiscussionApi.md#discussion_delete_object_v1) | **DELETE** /1/object/discussion/{pkiDiscussionID} | Delete an existing Discussion +*ObjectDiscussionApi* | [**discussion_get_object_v2**](docs/ObjectDiscussionApi.md#discussion_get_object_v2) | **GET** /2/object/discussion/{pkiDiscussionID} | Retrieve an existing Discussion +*ObjectDiscussionApi* | [**discussion_patch_object_v1**](docs/ObjectDiscussionApi.md#discussion_patch_object_v1) | **PATCH** /1/object/discussion/{pkiDiscussionID} | Patch an existing Discussion +*ObjectDiscussionApi* | [**discussion_update_discussionreadstatus_v1**](docs/ObjectDiscussionApi.md#discussion_update_discussionreadstatus_v1) | **POST** /1/object/discussion/{pkiDiscussionID}/updateDiscussionreadstatus | Update the read status of the discussion +*ObjectDiscussionmembershipApi* | [**discussionmembership_create_object_v1**](docs/ObjectDiscussionmembershipApi.md#discussionmembership_create_object_v1) | **POST** /1/object/discussionmembership | Create a new Discussionmembership +*ObjectDiscussionmembershipApi* | [**discussionmembership_delete_object_v1**](docs/ObjectDiscussionmembershipApi.md#discussionmembership_delete_object_v1) | **DELETE** /1/object/discussionmembership/{pkiDiscussionmembershipID} | Delete an existing Discussionmembership +*ObjectDiscussionmessageApi* | [**discussionmessage_create_object_v1**](docs/ObjectDiscussionmessageApi.md#discussionmessage_create_object_v1) | **POST** /1/object/discussionmessage | Create a new Discussionmessage +*ObjectDiscussionmessageApi* | [**discussionmessage_delete_object_v1**](docs/ObjectDiscussionmessageApi.md#discussionmessage_delete_object_v1) | **DELETE** /1/object/discussionmessage/{pkiDiscussionmessageID} | Delete an existing Discussionmessage +*ObjectDiscussionmessageApi* | [**discussionmessage_patch_object_v1**](docs/ObjectDiscussionmessageApi.md#discussionmessage_patch_object_v1) | **PATCH** /1/object/discussionmessage/{pkiDiscussionmessageID} | Patch an existing Discussionmessage *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 @@ -156,8 +166,12 @@ Class | Method | HTTP request | Description *ObjectEzsignbulksendtransmissionApi* | [**ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1**](docs/ObjectEzsignbulksendtransmissionApi.md#ezsignbulksendtransmission_get_ezsignsignatures_automatic_v1) | **GET** /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getEzsignsignaturesAutomatic | Retrieve an existing Ezsignbulksendtransmission's automatic Ezsignsignatures *ObjectEzsignbulksendtransmissionApi* | [**ezsignbulksendtransmission_get_forms_data_v1**](docs/ObjectEzsignbulksendtransmissionApi.md#ezsignbulksendtransmission_get_forms_data_v1) | **GET** /1/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID}/getFormsData | Retrieve an existing Ezsignbulksendtransmission's forms data *ObjectEzsignbulksendtransmissionApi* | [**ezsignbulksendtransmission_get_object_v2**](docs/ObjectEzsignbulksendtransmissionApi.md#ezsignbulksendtransmission_get_object_v2) | **GET** /2/object/ezsignbulksendtransmission/{pkiEzsignbulksendtransmissionID} | Retrieve an existing Ezsignbulksendtransmission +*ObjectEzsigndiscussionApi* | [**ezsigndiscussion_create_object_v1**](docs/ObjectEzsigndiscussionApi.md#ezsigndiscussion_create_object_v1) | **POST** /1/object/ezsigndiscussion | Create a new Ezsigndiscussion +*ObjectEzsigndiscussionApi* | [**ezsigndiscussion_delete_object_v1**](docs/ObjectEzsigndiscussionApi.md#ezsigndiscussion_delete_object_v1) | **DELETE** /1/object/ezsigndiscussion/{pkiEzsigndiscussionID} | Delete an existing Ezsigndiscussion +*ObjectEzsigndiscussionApi* | [**ezsigndiscussion_get_object_v2**](docs/ObjectEzsigndiscussionApi.md#ezsigndiscussion_get_object_v2) | **GET** /2/object/ezsigndiscussion/{pkiEzsigndiscussionID} | Retrieve an existing Ezsigndiscussion *ObjectEzsigndocumentApi* | [**ezsigndocument_apply_ezsigntemplate_v1**](docs/ObjectEzsigndocumentApi.md#ezsigndocument_apply_ezsigntemplate_v1) | **POST** /1/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate | Apply an Ezsigntemplate to the Ezsigndocument. *ObjectEzsigndocumentApi* | [**ezsigndocument_apply_ezsigntemplate_v2**](docs/ObjectEzsigndocumentApi.md#ezsigndocument_apply_ezsigntemplate_v2) | **POST** /2/object/ezsigndocument/{pkiEzsigndocumentID}/applyEzsigntemplate | Apply an Ezsigntemplate to the Ezsigndocument. +*ObjectEzsigndocumentApi* | [**ezsigndocument_create_ezsignelements_positioned_by_word_v1**](docs/ObjectEzsigndocumentApi.md#ezsigndocument_create_ezsignelements_positioned_by_word_v1) | **POST** /1/object/ezsigndocument/{pkiEzsigndocumentID}/createEzsignelementsPositionedByWord | Create multiple Ezsignsignatures/Ezsignformfieldgroups *ObjectEzsigndocumentApi* | [**ezsigndocument_create_object_v1**](docs/ObjectEzsigndocumentApi.md#ezsigndocument_create_object_v1) | **POST** /1/object/ezsigndocument | Create a new Ezsigndocument *ObjectEzsigndocumentApi* | [**ezsigndocument_create_object_v2**](docs/ObjectEzsigndocumentApi.md#ezsigndocument_create_object_v2) | **POST** /2/object/ezsigndocument | Create a new Ezsigndocument *ObjectEzsigndocumentApi* | [**ezsigndocument_decline_to_sign_v1**](docs/ObjectEzsigndocumentApi.md#ezsigndocument_decline_to_sign_v1) | **POST** /1/object/ezsigndocument/{pkiEzsigndocumentID}/declineToSign | Decline to sign @@ -171,6 +185,7 @@ Class | Method | HTTP request | Description *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 +*ObjectEzsigndocumentApi* | [**ezsigndocument_get_ezsigndiscussions_v1**](docs/ObjectEzsigndocumentApi.md#ezsigndocument_get_ezsigndiscussions_v1) | **GET** /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsigndiscussions | Retrieve an existing Ezsigndocument's Ezsigndiscussions *ObjectEzsigndocumentApi* | [**ezsigndocument_get_ezsignformfieldgroups_v1**](docs/ObjectEzsigndocumentApi.md#ezsigndocument_get_ezsignformfieldgroups_v1) | **GET** /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignformfieldgroups | Retrieve an existing Ezsigndocument's Ezsignformfieldgroups *ObjectEzsigndocumentApi* | [**ezsigndocument_get_ezsignpages_v1**](docs/ObjectEzsigndocumentApi.md#ezsigndocument_get_ezsignpages_v1) | **GET** /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignpages | Retrieve an existing Ezsigndocument's Ezsignpages *ObjectEzsigndocumentApi* | [**ezsigndocument_get_ezsignsignatures_automatic_v1**](docs/ObjectEzsigndocumentApi.md#ezsigndocument_get_ezsignsignatures_automatic_v1) | **GET** /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignaturesAutomatic | Retrieve an existing Ezsigndocument's automatic Ezsignsignatures @@ -581,7 +596,9 @@ Class | Method | HTTP request | Description - [CustomCommunicationsenderRequest](docs/CustomCommunicationsenderRequest.md) - [CustomCommunicationsenderResponse](docs/CustomCommunicationsenderResponse.md) - [CustomContactNameResponse](docs/CustomContactNameResponse.md) + - [CustomCreateEzsignelementsPositionedByWordRequest](docs/CustomCreateEzsignelementsPositionedByWordRequest.md) - [CustomCreditcardtransactionResponse](docs/CustomCreditcardtransactionResponse.md) + - [CustomDiscussionconfigurationResponse](docs/CustomDiscussionconfigurationResponse.md) - [CustomDropdownElementRequest](docs/CustomDropdownElementRequest.md) - [CustomDropdownElementRequestCompound](docs/CustomDropdownElementRequestCompound.md) - [CustomDropdownElementResponse](docs/CustomDropdownElementResponse.md) @@ -600,7 +617,9 @@ Class | Method | HTTP request | Description - [CustomEzsignformfieldRequest](docs/CustomEzsignformfieldRequest.md) - [CustomEzsignformfielderrorResponse](docs/CustomEzsignformfielderrorResponse.md) - [CustomEzsignformfielderrortestResponse](docs/CustomEzsignformfielderrortestResponse.md) + - [CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest](docs/CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest.md) - [CustomEzsignformfieldgroupRequest](docs/CustomEzsignformfieldgroupRequest.md) + - [CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest](docs/CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest.md) - [CustomEzsignsignatureEzsignsignaturesAutomaticResponse](docs/CustomEzsignsignatureEzsignsignaturesAutomaticResponse.md) - [CustomEzsignsignaturestatusResponse](docs/CustomEzsignsignaturestatusResponse.md) - [CustomFormDataDocumentResponse](docs/CustomFormDataDocumentResponse.md) @@ -619,6 +638,40 @@ Class | Method | HTTP request | Description - [DepartmentAutocompleteElementResponse](docs/DepartmentAutocompleteElementResponse.md) - [DepartmentGetAutocompleteV2Response](docs/DepartmentGetAutocompleteV2Response.md) - [DepartmentGetAutocompleteV2ResponseMPayload](docs/DepartmentGetAutocompleteV2ResponseMPayload.md) + - [DiscussionCreateObjectV1Request](docs/DiscussionCreateObjectV1Request.md) + - [DiscussionCreateObjectV1Response](docs/DiscussionCreateObjectV1Response.md) + - [DiscussionCreateObjectV1ResponseMPayload](docs/DiscussionCreateObjectV1ResponseMPayload.md) + - [DiscussionDeleteObjectV1Response](docs/DiscussionDeleteObjectV1Response.md) + - [DiscussionGetObjectV2Response](docs/DiscussionGetObjectV2Response.md) + - [DiscussionGetObjectV2ResponseMPayload](docs/DiscussionGetObjectV2ResponseMPayload.md) + - [DiscussionPatchObjectV1Request](docs/DiscussionPatchObjectV1Request.md) + - [DiscussionPatchObjectV1Response](docs/DiscussionPatchObjectV1Response.md) + - [DiscussionRequest](docs/DiscussionRequest.md) + - [DiscussionRequestCompound](docs/DiscussionRequestCompound.md) + - [DiscussionRequestPatch](docs/DiscussionRequestPatch.md) + - [DiscussionResponse](docs/DiscussionResponse.md) + - [DiscussionResponseCompound](docs/DiscussionResponseCompound.md) + - [DiscussionUpdateDiscussionreadstatusV1Request](docs/DiscussionUpdateDiscussionreadstatusV1Request.md) + - [DiscussionUpdateDiscussionreadstatusV1Response](docs/DiscussionUpdateDiscussionreadstatusV1Response.md) + - [DiscussionmembershipCreateObjectV1Request](docs/DiscussionmembershipCreateObjectV1Request.md) + - [DiscussionmembershipCreateObjectV1Response](docs/DiscussionmembershipCreateObjectV1Response.md) + - [DiscussionmembershipCreateObjectV1ResponseMPayload](docs/DiscussionmembershipCreateObjectV1ResponseMPayload.md) + - [DiscussionmembershipDeleteObjectV1Response](docs/DiscussionmembershipDeleteObjectV1Response.md) + - [DiscussionmembershipRequest](docs/DiscussionmembershipRequest.md) + - [DiscussionmembershipRequestCompound](docs/DiscussionmembershipRequestCompound.md) + - [DiscussionmembershipResponse](docs/DiscussionmembershipResponse.md) + - [DiscussionmembershipResponseCompound](docs/DiscussionmembershipResponseCompound.md) + - [DiscussionmessageCreateObjectV1Request](docs/DiscussionmessageCreateObjectV1Request.md) + - [DiscussionmessageCreateObjectV1Response](docs/DiscussionmessageCreateObjectV1Response.md) + - [DiscussionmessageCreateObjectV1ResponseMPayload](docs/DiscussionmessageCreateObjectV1ResponseMPayload.md) + - [DiscussionmessageDeleteObjectV1Response](docs/DiscussionmessageDeleteObjectV1Response.md) + - [DiscussionmessagePatchObjectV1Request](docs/DiscussionmessagePatchObjectV1Request.md) + - [DiscussionmessagePatchObjectV1Response](docs/DiscussionmessagePatchObjectV1Response.md) + - [DiscussionmessageRequest](docs/DiscussionmessageRequest.md) + - [DiscussionmessageRequestCompound](docs/DiscussionmessageRequestCompound.md) + - [DiscussionmessageRequestPatch](docs/DiscussionmessageRequestPatch.md) + - [DiscussionmessageResponse](docs/DiscussionmessageResponse.md) + - [DiscussionmessageResponseCompound](docs/DiscussionmessageResponseCompound.md) - [ElectronicfundstransferGetCommunicationListV1Response](docs/ElectronicfundstransferGetCommunicationListV1Response.md) - [ElectronicfundstransferGetCommunicationListV1ResponseMPayload](docs/ElectronicfundstransferGetCommunicationListV1ResponseMPayload.md) - [EmailRequest](docs/EmailRequest.md) @@ -723,10 +776,23 @@ Class | Method | HTTP request | Description - [EzsignbulksendtransmissionGetObjectV2ResponseMPayload](docs/EzsignbulksendtransmissionGetObjectV2ResponseMPayload.md) - [EzsignbulksendtransmissionResponse](docs/EzsignbulksendtransmissionResponse.md) - [EzsignbulksendtransmissionResponseCompound](docs/EzsignbulksendtransmissionResponseCompound.md) + - [EzsigndiscussionCreateObjectV1Request](docs/EzsigndiscussionCreateObjectV1Request.md) + - [EzsigndiscussionCreateObjectV1Response](docs/EzsigndiscussionCreateObjectV1Response.md) + - [EzsigndiscussionCreateObjectV1ResponseMPayload](docs/EzsigndiscussionCreateObjectV1ResponseMPayload.md) + - [EzsigndiscussionDeleteObjectV1Response](docs/EzsigndiscussionDeleteObjectV1Response.md) + - [EzsigndiscussionGetObjectV2Response](docs/EzsigndiscussionGetObjectV2Response.md) + - [EzsigndiscussionGetObjectV2ResponseMPayload](docs/EzsigndiscussionGetObjectV2ResponseMPayload.md) + - [EzsigndiscussionRequest](docs/EzsigndiscussionRequest.md) + - [EzsigndiscussionRequestCompound](docs/EzsigndiscussionRequestCompound.md) + - [EzsigndiscussionResponse](docs/EzsigndiscussionResponse.md) + - [EzsigndiscussionResponseCompound](docs/EzsigndiscussionResponseCompound.md) - [EzsigndocumentApplyEzsigntemplateV1Request](docs/EzsigndocumentApplyEzsigntemplateV1Request.md) - [EzsigndocumentApplyEzsigntemplateV1Response](docs/EzsigndocumentApplyEzsigntemplateV1Response.md) - [EzsigndocumentApplyEzsigntemplateV2Request](docs/EzsigndocumentApplyEzsigntemplateV2Request.md) - [EzsigndocumentApplyEzsigntemplateV2Response](docs/EzsigndocumentApplyEzsigntemplateV2Response.md) + - [EzsigndocumentCreateEzsignelementsPositionedByWordV1Request](docs/EzsigndocumentCreateEzsignelementsPositionedByWordV1Request.md) + - [EzsigndocumentCreateEzsignelementsPositionedByWordV1Response](docs/EzsigndocumentCreateEzsignelementsPositionedByWordV1Response.md) + - [EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload](docs/EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload.md) - [EzsigndocumentCreateObjectV1Request](docs/EzsigndocumentCreateObjectV1Request.md) - [EzsigndocumentCreateObjectV1Response](docs/EzsigndocumentCreateObjectV1Response.md) - [EzsigndocumentCreateObjectV1ResponseMPayload](docs/EzsigndocumentCreateObjectV1ResponseMPayload.md) @@ -754,6 +820,8 @@ Class | Method | HTTP request | Description - [EzsigndocumentGetDownloadUrlV1ResponseMPayload](docs/EzsigndocumentGetDownloadUrlV1ResponseMPayload.md) - [EzsigndocumentGetEzsignannotationsV1Response](docs/EzsigndocumentGetEzsignannotationsV1Response.md) - [EzsigndocumentGetEzsignannotationsV1ResponseMPayload](docs/EzsigndocumentGetEzsignannotationsV1ResponseMPayload.md) + - [EzsigndocumentGetEzsigndiscussionsV1Response](docs/EzsigndocumentGetEzsigndiscussionsV1Response.md) + - [EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload](docs/EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload.md) - [EzsigndocumentGetEzsignformfieldgroupsV1Response](docs/EzsigndocumentGetEzsignformfieldgroupsV1Response.md) - [EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload](docs/EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload.md) - [EzsigndocumentGetEzsignpagesV1Response](docs/EzsigndocumentGetEzsignpagesV1Response.md) @@ -1168,6 +1236,7 @@ Class | Method | HTTP request | Description - [FieldECommunicationexternalrecipientType](docs/FieldECommunicationexternalrecipientType.md) - [FieldECommunicationrecipientType](docs/FieldECommunicationrecipientType.md) - [FieldECreditcardtypeCodename](docs/FieldECreditcardtypeCodename.md) + - [FieldEDiscussionmessageStatus](docs/FieldEDiscussionmessageStatus.md) - [FieldEErrorCode](docs/FieldEErrorCode.md) - [FieldEEzmaxinvoicingPaymenttype](docs/FieldEEzmaxinvoicingPaymenttype.md) - [FieldEEzmaxinvoicingagentVariationezmax](docs/FieldEEzmaxinvoicingagentVariationezmax.md) @@ -1179,8 +1248,10 @@ Class | Method | HTTP request | Description - [FieldEEzsigndocumentlogType](docs/FieldEEzsigndocumentlogType.md) - [FieldEEzsignelementdependencyOperator](docs/FieldEEzsignelementdependencyOperator.md) - [FieldEEzsignelementdependencyValidation](docs/FieldEEzsignelementdependencyValidation.md) + - [FieldEEzsignfolderCompletion](docs/FieldEEzsignfolderCompletion.md) - [FieldEEzsignfolderSendreminderfrequency](docs/FieldEEzsignfolderSendreminderfrequency.md) - [FieldEEzsignfolderStep](docs/FieldEEzsignfolderStep.md) + - [FieldEEzsignfoldertypeCompletion](docs/FieldEEzsignfoldertypeCompletion.md) - [FieldEEzsignfoldertypeDisposal](docs/FieldEEzsignfoldertypeDisposal.md) - [FieldEEzsignfoldertypePrivacylevel](docs/FieldEEzsignfoldertypePrivacylevel.md) - [FieldEEzsignfoldertypeSendreminderfrequency](docs/FieldEEzsignfoldertypeSendreminderfrequency.md) @@ -1196,12 +1267,16 @@ Class | Method | HTTP request | Description - [FieldEEzsigntemplateelementdependencyOperator](docs/FieldEEzsigntemplateelementdependencyOperator.md) - [FieldEEzsigntemplateelementdependencyValidation](docs/FieldEEzsigntemplateelementdependencyValidation.md) - [FieldEEzsigntemplateformfieldDependencyrequirement](docs/FieldEEzsigntemplateformfieldDependencyrequirement.md) + - [FieldEEzsigntemplateformfieldPositioning](docs/FieldEEzsigntemplateformfieldPositioning.md) + - [FieldEEzsigntemplateformfieldPositioningoccurence](docs/FieldEEzsigntemplateformfieldPositioningoccurence.md) - [FieldEEzsigntemplateformfieldgroupSignerrequirement](docs/FieldEEzsigntemplateformfieldgroupSignerrequirement.md) - [FieldEEzsigntemplateformfieldgroupTooltipposition](docs/FieldEEzsigntemplateformfieldgroupTooltipposition.md) - [FieldEEzsigntemplateformfieldgroupType](docs/FieldEEzsigntemplateformfieldgroupType.md) - [FieldEEzsigntemplatesignatureAttachmentnamesource](docs/FieldEEzsigntemplatesignatureAttachmentnamesource.md) - [FieldEEzsigntemplatesignatureDependencyrequirement](docs/FieldEEzsigntemplatesignatureDependencyrequirement.md) - [FieldEEzsigntemplatesignatureFont](docs/FieldEEzsigntemplatesignatureFont.md) + - [FieldEEzsigntemplatesignaturePositioning](docs/FieldEEzsigntemplatesignaturePositioning.md) + - [FieldEEzsigntemplatesignaturePositioningoccurence](docs/FieldEEzsigntemplatesignaturePositioningoccurence.md) - [FieldEEzsigntemplatesignatureTooltipposition](docs/FieldEEzsigntemplatesignatureTooltipposition.md) - [FieldEEzsigntemplatesignatureType](docs/FieldEEzsigntemplatesignatureType.md) - [FieldENotificationpreferenceStatus](docs/FieldENotificationpreferenceStatus.md) diff --git a/docs/CustomCreateEzsignelementsPositionedByWordRequest.md b/docs/CustomCreateEzsignelementsPositionedByWordRequest.md new file mode 100644 index 000000000..a7f46c1ff --- /dev/null +++ b/docs/CustomCreateEzsignelementsPositionedByWordRequest.md @@ -0,0 +1,33 @@ +# CustomCreateEzsignelementsPositionedByWordRequest + +A CreateEzsignelementsPositionedByWord object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**s_createezsignelementspositionedbyword_pattern** | **str** | The word to search | +**i_createezsignelementspositionedbyword_offsetx** | **int** | The X offset | +**i_createezsignelementspositionedbyword_offsety** | **int** | The Y offset | +**e_createezsignelementspositionedbyword_occurance** | **str** | The occurance in the search to add the ezsign element | + +## Example + +```python +from eZmaxApi.models.custom_create_ezsignelements_positioned_by_word_request import CustomCreateEzsignelementsPositionedByWordRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of CustomCreateEzsignelementsPositionedByWordRequest from a JSON string +custom_create_ezsignelements_positioned_by_word_request_instance = CustomCreateEzsignelementsPositionedByWordRequest.from_json(json) +# print the JSON string representation of the object +print CustomCreateEzsignelementsPositionedByWordRequest.to_json() + +# convert the object into a dict +custom_create_ezsignelements_positioned_by_word_request_dict = custom_create_ezsignelements_positioned_by_word_request_instance.to_dict() +# create an instance of CustomCreateEzsignelementsPositionedByWordRequest from a dict +custom_create_ezsignelements_positioned_by_word_request_form_dict = custom_create_ezsignelements_positioned_by_word_request.from_dict(custom_create_ezsignelements_positioned_by_word_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/CustomDiscussionconfigurationResponse.md b/docs/CustomDiscussionconfigurationResponse.md new file mode 100644 index 000000000..7cee35320 --- /dev/null +++ b/docs/CustomDiscussionconfigurationResponse.md @@ -0,0 +1,34 @@ +# CustomDiscussionconfigurationResponse + +A Custom Discussionconfiguration Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**b_discussionconfiguration_completehistorywhenadded** | **bool** | If the added Discussionmembership will have access to the entire history or not | +**b_discussionconfiguration_createallowed** | **bool** | If the the creation of the Discussion is allowed or not | +**b_discussionconfiguration_deleteallowed** | **bool** | If the the destruction of the Discussion is allowed or not | +**b_discussionconfiguration_deletediscussionmessageallowed** | **bool** | If the the destruction of the Discussionmessage is allowed or not | +**b_discussionconfiguration_editdiscussionmessageallowed** | **bool** | If the the creation of the Discussionmessage is allowed or not | + +## Example + +```python +from eZmaxApi.models.custom_discussionconfiguration_response import CustomDiscussionconfigurationResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of CustomDiscussionconfigurationResponse from a JSON string +custom_discussionconfiguration_response_instance = CustomDiscussionconfigurationResponse.from_json(json) +# print the JSON string representation of the object +print CustomDiscussionconfigurationResponse.to_json() + +# convert the object into a dict +custom_discussionconfiguration_response_dict = custom_discussionconfiguration_response_instance.to_dict() +# create an instance of CustomDiscussionconfigurationResponse from a dict +custom_discussionconfiguration_response_form_dict = custom_discussionconfiguration_response.from_dict(custom_discussionconfiguration_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/CustomEzmaxinvoicingEzsigndocumentResponse.md b/docs/CustomEzmaxinvoicingEzsigndocumentResponse.md index b90c22b2c..2ceb1ed90 100644 --- a/docs/CustomEzmaxinvoicingEzsigndocumentResponse.md +++ b/docs/CustomEzmaxinvoicingEzsigndocumentResponse.md @@ -7,6 +7,7 @@ An EzmaxinvoicingEzsigndocument object containing information about the Ezmaxinv Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_ezsignfolder_id** | **int** | The unique ID of the Ezsignfolder | +**fki_billingentityinternal_id** | **int** | The unique ID of the Billingentityinternal. | [optional] **s_name** | **str** | | **s_ezsignfolder_description** | **str** | The description of the Ezsignfolder | **s_ezsigndocument_name** | **str** | The name of the document that will be presented to Ezsignfoldersignerassociations | diff --git a/docs/CustomEzmaxinvoicingEzsignfolderResponse.md b/docs/CustomEzmaxinvoicingEzsignfolderResponse.md index c24204760..76a535942 100644 --- a/docs/CustomEzmaxinvoicingEzsignfolderResponse.md +++ b/docs/CustomEzmaxinvoicingEzsignfolderResponse.md @@ -7,6 +7,7 @@ An EzmaxinvoicingEzsignfolder object containing information about the Ezmaxinvoi Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **fki_ezsignfolder_id** | **int** | The unique ID of the Ezsignfolder | +**fki_billingentityinternal_id** | **int** | The unique ID of the Billingentityinternal. | [optional] **s_ezsignfolder_description** | **str** | The description of the Ezsignfolder | **b_ezsigntsarequirement_billable** | **bool** | Whether the TSA requirement is billable or not | **b_ezsignfolder_mfaused** | **bool** | Whether the MFA was used or not for the Ezsignfolder | diff --git a/docs/CustomEzsignfoldertypeResponse.md b/docs/CustomEzsignfoldertypeResponse.md index 732b33847..d6270907d 100644 --- a/docs/CustomEzsignfoldertypeResponse.md +++ b/docs/CustomEzsignfoldertypeResponse.md @@ -15,6 +15,8 @@ Name | Type | Description | Notes **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] +**b_ezsignfoldertype_reassignezsignsigner** | **bool** | Wheter if Reassignment of signature is allowed by a signatory to another signatory or not | [optional] +**b_ezsignfoldertype_reassignuser** | **bool** | Wheter if Reassignment of signature is allowed by a user to a signatory or another user or not | [optional] ## Example diff --git a/docs/CustomEzsignformfieldRequest.md b/docs/CustomEzsignformfieldRequest.md index a1cbb69c3..835688c94 100644 --- a/docs/CustomEzsignformfieldRequest.md +++ b/docs/CustomEzsignformfieldRequest.md @@ -9,7 +9,7 @@ Name | Type | Description | Notes **pki_ezsignformfield_id** | **int** | The unique ID of the Ezsignformfield | [optional] **s_ezsignformfield_label** | **str** | The Label for the Ezsignformfield | [optional] **b_ezsignformfield_selected** | **bool** | Whether the Ezsignformfield is selected or not by default. This can only be set if eEzsignformfieldgroupType is **Checkbox** or **Radio** | [optional] -**s_ezsignformfield_enteredvalue** | **str** | This is the value enterred for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is **Dropdown**, **Text** or **Textarea** | [optional] +**s_ezsignformfield_enteredvalue** | **str** | This is the value enterred for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is **Dropdown**, **Text** or **Textarea** You can use the codes below and they will be replaced at signature time. | Code | Description | Example | | ------------------------- | ------------ | ------------ | | {sUserFirstname} | The first name of the contact | John | | {sUserLastname} | The last name of the contact | Doe | | {sUserJobtitle} | The job title | Sales Representative | | {sEmailAddress} | The email address | email@example.com | | {sPhoneE164} | A phone number in E.164 Format | +15149901516 | | {sPhoneE164Cell} | A phone number in E.164 Format | +15149901516 | | [optional] ## Example diff --git a/docs/CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest.md b/docs/CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest.md new file mode 100644 index 000000000..72876bb85 --- /dev/null +++ b/docs/CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest.md @@ -0,0 +1,49 @@ +# CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest + +An Ezsignformfieldgroup Object in the context of a createEzsignelementsPositionedByWord path + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pki_ezsignformfieldgroup_id** | **int** | The unique ID of the Ezsignformfieldgroup | [optional] +**fki_ezsigndocument_id** | **int** | The unique ID of the Ezsigndocument | +**e_ezsignformfieldgroup_type** | [**FieldEEzsignformfieldgroupType**](FieldEEzsignformfieldgroupType.md) | | +**e_ezsignformfieldgroup_signerrequirement** | [**FieldEEzsignformfieldgroupSignerrequirement**](FieldEEzsignformfieldgroupSignerrequirement.md) | | +**s_ezsignformfieldgroup_label** | **str** | The Label for the Ezsignformfieldgroup | +**i_ezsignformfieldgroup_step** | **int** | The step when the Ezsignsigner will be invited to fill the form fields | +**s_ezsignformfieldgroup_defaultvalue** | **str** | The default value for the Ezsignformfieldgroup | [optional] +**i_ezsignformfieldgroup_filledmin** | **int** | The minimum number of Ezsignformfield that must be filled in the Ezsignformfieldgroup | +**i_ezsignformfieldgroup_filledmax** | **int** | The maximum number of Ezsignformfield that must be filled in the Ezsignformfieldgroup | +**b_ezsignformfieldgroup_readonly** | **bool** | Whether the Ezsignformfieldgroup is read only or not. | +**i_ezsignformfieldgroup_maxlength** | **int** | The maximum length for the value in the Ezsignformfieldgroup This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea** | [optional] +**b_ezsignformfieldgroup_encrypted** | **bool** | 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** | [optional] +**s_ezsignformfieldgroup_regexp** | **str** | A regular expression to indicate what values are acceptable for the Ezsignformfieldgroup. This can only be set if eEzsignformfieldgroupType is **Text** or **Textarea** | [optional] +**t_ezsignformfieldgroup_tooltip** | **str** | A tooltip that will be presented to Ezsignsigner about the Ezsignformfieldgroup | [optional] +**e_ezsignformfieldgroup_tooltipposition** | [**FieldEEzsignformfieldgroupTooltipposition**](FieldEEzsignformfieldgroupTooltipposition.md) | | [optional] +**e_ezsignformfieldgroup_textvalidation** | [**EnumTextvalidation**](EnumTextvalidation.md) | | [optional] +**a_obj_ezsignformfieldgroupsigner** | [**List[EzsignformfieldgroupsignerRequestCompound]**](EzsignformfieldgroupsignerRequestCompound.md) | | +**a_obj_dropdown_element** | [**List[CustomDropdownElementRequestCompound]**](CustomDropdownElementRequestCompound.md) | | [optional] +**a_obj_ezsignformfield** | [**List[EzsignformfieldRequestCompound]**](EzsignformfieldRequestCompound.md) | | +**obj_createezsignelementspositionedbyword** | [**CustomCreateEzsignelementsPositionedByWordRequest**](CustomCreateEzsignelementsPositionedByWordRequest.md) | | + +## Example + +```python +from eZmaxApi.models.custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request import CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest from a JSON string +custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request_instance = CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest.from_json(json) +# print the JSON string representation of the object +print CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest.to_json() + +# convert the object into a dict +custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request_dict = custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request_instance.to_dict() +# create an instance of CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest from a dict +custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request_form_dict = custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request.from_dict(custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_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/CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest.md b/docs/CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest.md new file mode 100644 index 000000000..948b627f6 --- /dev/null +++ b/docs/CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest.md @@ -0,0 +1,55 @@ +# CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest + +An Ezsignsignature Object in the context of an CreateEzsignelementsPositionedByWord path + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pki_ezsignsignature_id** | **int** | The unique ID of the Ezsignsignature | [optional] +**fki_ezsignfoldersignerassociation_id** | **int** | The unique ID of the Ezsignfoldersignerassociation | +**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. | +**i_ezsignsignature_width** | **int** | 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. | [optional] +**i_ezsignsignature_height** | **int** | 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. | [optional] +**i_ezsignsignature_step** | **int** | The step when the Ezsignsigner will be invited to sign | +**e_ezsignsignature_type** | [**FieldEEzsignsignatureType**](FieldEEzsignsignatureType.md) | | +**fki_ezsigndocument_id** | **int** | The unique ID of the Ezsigndocument | +**t_ezsignsignature_tooltip** | **str** | A tooltip that will be presented to Ezsignsigner about the Ezsignsignature | [optional] +**e_ezsignsignature_tooltipposition** | [**FieldEEzsignsignatureTooltipposition**](FieldEEzsignsignatureTooltipposition.md) | | [optional] +**e_ezsignsignature_font** | [**FieldEEzsignsignatureFont**](FieldEEzsignsignatureFont.md) | | [optional] +**fki_ezsignfoldersignerassociation_id_validation** | **int** | The unique ID of the Ezsignfoldersignerassociation | [optional] +**b_ezsignsignature_required** | **bool** | Whether the Ezsignsignature is required or not. This field is relevant only with Ezsignsignature with eEzsignsignatureType = Attachments. | [optional] +**e_ezsignsignature_attachmentnamesource** | [**FieldEEzsignsignatureAttachmentnamesource**](FieldEEzsignsignatureAttachmentnamesource.md) | | [optional] +**s_ezsignsignature_attachmentdescription** | **str** | The description attached to the attachment name added in Ezsignsignature of eEzsignsignatureType Attachments | [optional] +**i_ezsignsignature_validationstep** | **int** | The step when the Ezsignsigner will be invited to validate the Ezsignsignature of eEzsignsignatureType Attachments | [optional] +**i_ezsignsignature_maxlength** | **int** | The maximum length for the value in the Ezsignsignature This can only be set if eEzsignsignatureType is **FieldText** or **FieldTextarea** | [optional] +**e_ezsignsignature_textvalidation** | [**EnumTextvalidation**](EnumTextvalidation.md) | | [optional] +**s_ezsignsignature_regexp** | **str** | 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** | [optional] +**e_ezsignsignature_dependencyrequirement** | [**FieldEEzsignsignatureDependencyrequirement**](FieldEEzsignsignatureDependencyrequirement.md) | | [optional] +**b_ezsignsignature_customdate** | **bool** | Whether the Ezsignsignature has a custom date format or not. (Only possible when eEzsignsignatureType is **Name** or **Handwritten**) | [optional] +**a_obj_ezsignsignaturecustomdate** | [**List[EzsignsignaturecustomdateRequestCompound]**](EzsignsignaturecustomdateRequestCompound.md) | 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. | [optional] +**a_obj_ezsignelementdependency** | [**List[EzsignelementdependencyRequestCompound]**](EzsignelementdependencyRequestCompound.md) | | [optional] +**obj_createezsignelementspositionedbyword** | [**CustomCreateEzsignelementsPositionedByWordRequest**](CustomCreateEzsignelementsPositionedByWordRequest.md) | | + +## Example + +```python +from eZmaxApi.models.custom_ezsignsignature_create_ezsignelements_positioned_by_word_request import CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest from a JSON string +custom_ezsignsignature_create_ezsignelements_positioned_by_word_request_instance = CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest.from_json(json) +# print the JSON string representation of the object +print CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest.to_json() + +# convert the object into a dict +custom_ezsignsignature_create_ezsignelements_positioned_by_word_request_dict = custom_ezsignsignature_create_ezsignelements_positioned_by_word_request_instance.to_dict() +# create an instance of CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest from a dict +custom_ezsignsignature_create_ezsignelements_positioned_by_word_request_form_dict = custom_ezsignsignature_create_ezsignelements_positioned_by_word_request.from_dict(custom_ezsignsignature_create_ezsignelements_positioned_by_word_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/CustomWebhookResponse.md b/docs/CustomWebhookResponse.md index e6a1e321c..b9913a7aa 100644 --- a/docs/CustomWebhookResponse.md +++ b/docs/CustomWebhookResponse.md @@ -20,6 +20,7 @@ Name | Type | Description | Notes **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 | +**obj_audit** | [**CommonAudit**](CommonAudit.md) | | **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/DiscussionCreateObjectV1Request.md b/docs/DiscussionCreateObjectV1Request.md new file mode 100644 index 000000000..415f4afc0 --- /dev/null +++ b/docs/DiscussionCreateObjectV1Request.md @@ -0,0 +1,30 @@ +# DiscussionCreateObjectV1Request + +Request for POST /1/object/discussion + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**a_obj_discussion** | [**List[DiscussionRequestCompound]**](DiscussionRequestCompound.md) | | + +## Example + +```python +from eZmaxApi.models.discussion_create_object_v1_request import DiscussionCreateObjectV1Request + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionCreateObjectV1Request from a JSON string +discussion_create_object_v1_request_instance = DiscussionCreateObjectV1Request.from_json(json) +# print the JSON string representation of the object +print DiscussionCreateObjectV1Request.to_json() + +# convert the object into a dict +discussion_create_object_v1_request_dict = discussion_create_object_v1_request_instance.to_dict() +# create an instance of DiscussionCreateObjectV1Request from a dict +discussion_create_object_v1_request_form_dict = discussion_create_object_v1_request.from_dict(discussion_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/DiscussionCreateObjectV1Response.md b/docs/DiscussionCreateObjectV1Response.md new file mode 100644 index 000000000..9fec1184e --- /dev/null +++ b/docs/DiscussionCreateObjectV1Response.md @@ -0,0 +1,32 @@ +# DiscussionCreateObjectV1Response + +Response for POST /1/object/discussion + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] +**m_payload** | [**DiscussionCreateObjectV1ResponseMPayload**](DiscussionCreateObjectV1ResponseMPayload.md) | | + +## Example + +```python +from eZmaxApi.models.discussion_create_object_v1_response import DiscussionCreateObjectV1Response + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionCreateObjectV1Response from a JSON string +discussion_create_object_v1_response_instance = DiscussionCreateObjectV1Response.from_json(json) +# print the JSON string representation of the object +print DiscussionCreateObjectV1Response.to_json() + +# convert the object into a dict +discussion_create_object_v1_response_dict = discussion_create_object_v1_response_instance.to_dict() +# create an instance of DiscussionCreateObjectV1Response from a dict +discussion_create_object_v1_response_form_dict = discussion_create_object_v1_response.from_dict(discussion_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/DiscussionCreateObjectV1ResponseMPayload.md b/docs/DiscussionCreateObjectV1ResponseMPayload.md new file mode 100644 index 000000000..1d64f951d --- /dev/null +++ b/docs/DiscussionCreateObjectV1ResponseMPayload.md @@ -0,0 +1,30 @@ +# DiscussionCreateObjectV1ResponseMPayload + +Payload for POST /1/object/discussion + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**a_pki_discussion_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.discussion_create_object_v1_response_m_payload import DiscussionCreateObjectV1ResponseMPayload + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionCreateObjectV1ResponseMPayload from a JSON string +discussion_create_object_v1_response_m_payload_instance = DiscussionCreateObjectV1ResponseMPayload.from_json(json) +# print the JSON string representation of the object +print DiscussionCreateObjectV1ResponseMPayload.to_json() + +# convert the object into a dict +discussion_create_object_v1_response_m_payload_dict = discussion_create_object_v1_response_m_payload_instance.to_dict() +# create an instance of DiscussionCreateObjectV1ResponseMPayload from a dict +discussion_create_object_v1_response_m_payload_form_dict = discussion_create_object_v1_response_m_payload.from_dict(discussion_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/DiscussionDeleteObjectV1Response.md b/docs/DiscussionDeleteObjectV1Response.md new file mode 100644 index 000000000..e6e364987 --- /dev/null +++ b/docs/DiscussionDeleteObjectV1Response.md @@ -0,0 +1,31 @@ +# DiscussionDeleteObjectV1Response + +Response for DELETE /1/object/discussion/{pkiDiscussionID} + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] + +## Example + +```python +from eZmaxApi.models.discussion_delete_object_v1_response import DiscussionDeleteObjectV1Response + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionDeleteObjectV1Response from a JSON string +discussion_delete_object_v1_response_instance = DiscussionDeleteObjectV1Response.from_json(json) +# print the JSON string representation of the object +print DiscussionDeleteObjectV1Response.to_json() + +# convert the object into a dict +discussion_delete_object_v1_response_dict = discussion_delete_object_v1_response_instance.to_dict() +# create an instance of DiscussionDeleteObjectV1Response from a dict +discussion_delete_object_v1_response_form_dict = discussion_delete_object_v1_response.from_dict(discussion_delete_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/DiscussionGetObjectV2Response.md b/docs/DiscussionGetObjectV2Response.md new file mode 100644 index 000000000..d4c59be3c --- /dev/null +++ b/docs/DiscussionGetObjectV2Response.md @@ -0,0 +1,32 @@ +# DiscussionGetObjectV2Response + +Response for GET /2/object/discussion/{pkiDiscussionID} + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] +**m_payload** | [**DiscussionGetObjectV2ResponseMPayload**](DiscussionGetObjectV2ResponseMPayload.md) | | + +## Example + +```python +from eZmaxApi.models.discussion_get_object_v2_response import DiscussionGetObjectV2Response + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionGetObjectV2Response from a JSON string +discussion_get_object_v2_response_instance = DiscussionGetObjectV2Response.from_json(json) +# print the JSON string representation of the object +print DiscussionGetObjectV2Response.to_json() + +# convert the object into a dict +discussion_get_object_v2_response_dict = discussion_get_object_v2_response_instance.to_dict() +# create an instance of DiscussionGetObjectV2Response from a dict +discussion_get_object_v2_response_form_dict = discussion_get_object_v2_response.from_dict(discussion_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/DiscussionGetObjectV2ResponseMPayload.md b/docs/DiscussionGetObjectV2ResponseMPayload.md new file mode 100644 index 000000000..0c8da3fdf --- /dev/null +++ b/docs/DiscussionGetObjectV2ResponseMPayload.md @@ -0,0 +1,30 @@ +# DiscussionGetObjectV2ResponseMPayload + +Payload for GET /2/object/discussion/{pkiDiscussionID} + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_discussion** | [**DiscussionResponseCompound**](DiscussionResponseCompound.md) | | + +## Example + +```python +from eZmaxApi.models.discussion_get_object_v2_response_m_payload import DiscussionGetObjectV2ResponseMPayload + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionGetObjectV2ResponseMPayload from a JSON string +discussion_get_object_v2_response_m_payload_instance = DiscussionGetObjectV2ResponseMPayload.from_json(json) +# print the JSON string representation of the object +print DiscussionGetObjectV2ResponseMPayload.to_json() + +# convert the object into a dict +discussion_get_object_v2_response_m_payload_dict = discussion_get_object_v2_response_m_payload_instance.to_dict() +# create an instance of DiscussionGetObjectV2ResponseMPayload from a dict +discussion_get_object_v2_response_m_payload_form_dict = discussion_get_object_v2_response_m_payload.from_dict(discussion_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/DiscussionPatchObjectV1Request.md b/docs/DiscussionPatchObjectV1Request.md new file mode 100644 index 000000000..c8cabf2cd --- /dev/null +++ b/docs/DiscussionPatchObjectV1Request.md @@ -0,0 +1,30 @@ +# DiscussionPatchObjectV1Request + +Request for PATCH /1/object/discussion/{pkiDiscussionID} + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_discussion** | [**DiscussionRequestPatch**](DiscussionRequestPatch.md) | | + +## Example + +```python +from eZmaxApi.models.discussion_patch_object_v1_request import DiscussionPatchObjectV1Request + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionPatchObjectV1Request from a JSON string +discussion_patch_object_v1_request_instance = DiscussionPatchObjectV1Request.from_json(json) +# print the JSON string representation of the object +print DiscussionPatchObjectV1Request.to_json() + +# convert the object into a dict +discussion_patch_object_v1_request_dict = discussion_patch_object_v1_request_instance.to_dict() +# create an instance of DiscussionPatchObjectV1Request from a dict +discussion_patch_object_v1_request_form_dict = discussion_patch_object_v1_request.from_dict(discussion_patch_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/DiscussionPatchObjectV1Response.md b/docs/DiscussionPatchObjectV1Response.md new file mode 100644 index 000000000..a84c153c7 --- /dev/null +++ b/docs/DiscussionPatchObjectV1Response.md @@ -0,0 +1,31 @@ +# DiscussionPatchObjectV1Response + +Response for PATCH /1/object/discussion/{pkiDiscussionID} + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] + +## Example + +```python +from eZmaxApi.models.discussion_patch_object_v1_response import DiscussionPatchObjectV1Response + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionPatchObjectV1Response from a JSON string +discussion_patch_object_v1_response_instance = DiscussionPatchObjectV1Response.from_json(json) +# print the JSON string representation of the object +print DiscussionPatchObjectV1Response.to_json() + +# convert the object into a dict +discussion_patch_object_v1_response_dict = discussion_patch_object_v1_response_instance.to_dict() +# create an instance of DiscussionPatchObjectV1Response from a dict +discussion_patch_object_v1_response_form_dict = discussion_patch_object_v1_response.from_dict(discussion_patch_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/DiscussionRequest.md b/docs/DiscussionRequest.md new file mode 100644 index 000000000..6e52efac9 --- /dev/null +++ b/docs/DiscussionRequest.md @@ -0,0 +1,32 @@ +# DiscussionRequest + +A Discussion Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pki_discussion_id** | **int** | The unique ID of the Discussion | [optional] +**s_discussion_description** | **str** | The description of the Discussion | +**b_discussion_closed** | **bool** | Whether if it's an closed | [optional] + +## Example + +```python +from eZmaxApi.models.discussion_request import DiscussionRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionRequest from a JSON string +discussion_request_instance = DiscussionRequest.from_json(json) +# print the JSON string representation of the object +print DiscussionRequest.to_json() + +# convert the object into a dict +discussion_request_dict = discussion_request_instance.to_dict() +# create an instance of DiscussionRequest from a dict +discussion_request_form_dict = discussion_request.from_dict(discussion_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/DiscussionRequestCompound.md b/docs/DiscussionRequestCompound.md new file mode 100644 index 000000000..d63d10279 --- /dev/null +++ b/docs/DiscussionRequestCompound.md @@ -0,0 +1,32 @@ +# DiscussionRequestCompound + +A Discussion Object and children + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pki_discussion_id** | **int** | The unique ID of the Discussion | [optional] +**s_discussion_description** | **str** | The description of the Discussion | +**b_discussion_closed** | **bool** | Whether if it's an closed | [optional] + +## Example + +```python +from eZmaxApi.models.discussion_request_compound import DiscussionRequestCompound + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionRequestCompound from a JSON string +discussion_request_compound_instance = DiscussionRequestCompound.from_json(json) +# print the JSON string representation of the object +print DiscussionRequestCompound.to_json() + +# convert the object into a dict +discussion_request_compound_dict = discussion_request_compound_instance.to_dict() +# create an instance of DiscussionRequestCompound from a dict +discussion_request_compound_form_dict = discussion_request_compound.from_dict(discussion_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/DiscussionRequestPatch.md b/docs/DiscussionRequestPatch.md new file mode 100644 index 000000000..c7f63875f --- /dev/null +++ b/docs/DiscussionRequestPatch.md @@ -0,0 +1,31 @@ +# DiscussionRequestPatch + +A Discussion Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**s_discussion_description** | **str** | The description of the Discussion | [optional] +**b_discussion_closed** | **bool** | Whether if it's an closed | [optional] + +## Example + +```python +from eZmaxApi.models.discussion_request_patch import DiscussionRequestPatch + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionRequestPatch from a JSON string +discussion_request_patch_instance = DiscussionRequestPatch.from_json(json) +# print the JSON string representation of the object +print DiscussionRequestPatch.to_json() + +# convert the object into a dict +discussion_request_patch_dict = discussion_request_patch_instance.to_dict() +# create an instance of DiscussionRequestPatch from a dict +discussion_request_patch_form_dict = discussion_request_patch.from_dict(discussion_request_patch_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/DiscussionResponse.md b/docs/DiscussionResponse.md new file mode 100644 index 000000000..c466c422d --- /dev/null +++ b/docs/DiscussionResponse.md @@ -0,0 +1,36 @@ +# DiscussionResponse + +A Discussion Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pki_discussion_id** | **int** | The unique ID of the Discussion | +**s_discussion_description** | **str** | The description of the Discussion | +**b_discussion_closed** | **bool** | Whether if it's an closed | +**dt_discussion_lastread** | **str** | The date the Discussion was last read | [optional] +**i_discussionmessage_count** | **int** | The count of Attachment. | +**i_discussionmessage_countunread** | **int** | The count of Attachment. | +**obj_discussionconfiguration** | [**CustomDiscussionconfigurationResponse**](CustomDiscussionconfigurationResponse.md) | | [optional] + +## Example + +```python +from eZmaxApi.models.discussion_response import DiscussionResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionResponse from a JSON string +discussion_response_instance = DiscussionResponse.from_json(json) +# print the JSON string representation of the object +print DiscussionResponse.to_json() + +# convert the object into a dict +discussion_response_dict = discussion_response_instance.to_dict() +# create an instance of DiscussionResponse from a dict +discussion_response_form_dict = discussion_response.from_dict(discussion_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/DiscussionResponseCompound.md b/docs/DiscussionResponseCompound.md new file mode 100644 index 000000000..5feb3978a --- /dev/null +++ b/docs/DiscussionResponseCompound.md @@ -0,0 +1,38 @@ +# DiscussionResponseCompound + +A Discussion Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pki_discussion_id** | **int** | The unique ID of the Discussion | +**s_discussion_description** | **str** | The description of the Discussion | +**b_discussion_closed** | **bool** | Whether if it's an closed | +**dt_discussion_lastread** | **str** | The date the Discussion was last read | [optional] +**i_discussionmessage_count** | **int** | The count of Attachment. | +**i_discussionmessage_countunread** | **int** | The count of Attachment. | +**obj_discussionconfiguration** | [**CustomDiscussionconfigurationResponse**](CustomDiscussionconfigurationResponse.md) | | [optional] +**a_obj_discussionmembership** | [**List[DiscussionmembershipResponseCompound]**](DiscussionmembershipResponseCompound.md) | | +**a_obj_discussionmessage** | [**List[DiscussionmessageResponseCompound]**](DiscussionmessageResponseCompound.md) | | + +## Example + +```python +from eZmaxApi.models.discussion_response_compound import DiscussionResponseCompound + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionResponseCompound from a JSON string +discussion_response_compound_instance = DiscussionResponseCompound.from_json(json) +# print the JSON string representation of the object +print DiscussionResponseCompound.to_json() + +# convert the object into a dict +discussion_response_compound_dict = discussion_response_compound_instance.to_dict() +# create an instance of DiscussionResponseCompound from a dict +discussion_response_compound_form_dict = discussion_response_compound.from_dict(discussion_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/DiscussionUpdateDiscussionreadstatusV1Request.md b/docs/DiscussionUpdateDiscussionreadstatusV1Request.md new file mode 100644 index 000000000..faaadd000 --- /dev/null +++ b/docs/DiscussionUpdateDiscussionreadstatusV1Request.md @@ -0,0 +1,30 @@ +# DiscussionUpdateDiscussionreadstatusV1Request + +Request for POST /1/object/discussion/{pkiDiscussionID}/updateDiscussionreadstatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**dt_discussionreadstatus_date** | **str** | The date of the last discussion message read | [optional] + +## Example + +```python +from eZmaxApi.models.discussion_update_discussionreadstatus_v1_request import DiscussionUpdateDiscussionreadstatusV1Request + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionUpdateDiscussionreadstatusV1Request from a JSON string +discussion_update_discussionreadstatus_v1_request_instance = DiscussionUpdateDiscussionreadstatusV1Request.from_json(json) +# print the JSON string representation of the object +print DiscussionUpdateDiscussionreadstatusV1Request.to_json() + +# convert the object into a dict +discussion_update_discussionreadstatus_v1_request_dict = discussion_update_discussionreadstatus_v1_request_instance.to_dict() +# create an instance of DiscussionUpdateDiscussionreadstatusV1Request from a dict +discussion_update_discussionreadstatus_v1_request_form_dict = discussion_update_discussionreadstatus_v1_request.from_dict(discussion_update_discussionreadstatus_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/DiscussionUpdateDiscussionreadstatusV1Response.md b/docs/DiscussionUpdateDiscussionreadstatusV1Response.md new file mode 100644 index 000000000..b91a513f4 --- /dev/null +++ b/docs/DiscussionUpdateDiscussionreadstatusV1Response.md @@ -0,0 +1,31 @@ +# DiscussionUpdateDiscussionreadstatusV1Response + +Response for GET /1/object/discussion/{pkiDiscussionID}/updateDiscussionreadstatus + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] + +## Example + +```python +from eZmaxApi.models.discussion_update_discussionreadstatus_v1_response import DiscussionUpdateDiscussionreadstatusV1Response + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionUpdateDiscussionreadstatusV1Response from a JSON string +discussion_update_discussionreadstatus_v1_response_instance = DiscussionUpdateDiscussionreadstatusV1Response.from_json(json) +# print the JSON string representation of the object +print DiscussionUpdateDiscussionreadstatusV1Response.to_json() + +# convert the object into a dict +discussion_update_discussionreadstatus_v1_response_dict = discussion_update_discussionreadstatus_v1_response_instance.to_dict() +# create an instance of DiscussionUpdateDiscussionreadstatusV1Response from a dict +discussion_update_discussionreadstatus_v1_response_form_dict = discussion_update_discussionreadstatus_v1_response.from_dict(discussion_update_discussionreadstatus_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/DiscussionmembershipCreateObjectV1Request.md b/docs/DiscussionmembershipCreateObjectV1Request.md new file mode 100644 index 000000000..e99b883dd --- /dev/null +++ b/docs/DiscussionmembershipCreateObjectV1Request.md @@ -0,0 +1,30 @@ +# DiscussionmembershipCreateObjectV1Request + +Request for POST /1/object/discussionmembership + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**a_obj_discussionmembership** | [**List[DiscussionmembershipRequestCompound]**](DiscussionmembershipRequestCompound.md) | | + +## Example + +```python +from eZmaxApi.models.discussionmembership_create_object_v1_request import DiscussionmembershipCreateObjectV1Request + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionmembershipCreateObjectV1Request from a JSON string +discussionmembership_create_object_v1_request_instance = DiscussionmembershipCreateObjectV1Request.from_json(json) +# print the JSON string representation of the object +print DiscussionmembershipCreateObjectV1Request.to_json() + +# convert the object into a dict +discussionmembership_create_object_v1_request_dict = discussionmembership_create_object_v1_request_instance.to_dict() +# create an instance of DiscussionmembershipCreateObjectV1Request from a dict +discussionmembership_create_object_v1_request_form_dict = discussionmembership_create_object_v1_request.from_dict(discussionmembership_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/DiscussionmembershipCreateObjectV1Response.md b/docs/DiscussionmembershipCreateObjectV1Response.md new file mode 100644 index 000000000..fdea8cbc4 --- /dev/null +++ b/docs/DiscussionmembershipCreateObjectV1Response.md @@ -0,0 +1,32 @@ +# DiscussionmembershipCreateObjectV1Response + +Response for POST /1/object/discussionmembership + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] +**m_payload** | [**DiscussionmembershipCreateObjectV1ResponseMPayload**](DiscussionmembershipCreateObjectV1ResponseMPayload.md) | | + +## Example + +```python +from eZmaxApi.models.discussionmembership_create_object_v1_response import DiscussionmembershipCreateObjectV1Response + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionmembershipCreateObjectV1Response from a JSON string +discussionmembership_create_object_v1_response_instance = DiscussionmembershipCreateObjectV1Response.from_json(json) +# print the JSON string representation of the object +print DiscussionmembershipCreateObjectV1Response.to_json() + +# convert the object into a dict +discussionmembership_create_object_v1_response_dict = discussionmembership_create_object_v1_response_instance.to_dict() +# create an instance of DiscussionmembershipCreateObjectV1Response from a dict +discussionmembership_create_object_v1_response_form_dict = discussionmembership_create_object_v1_response.from_dict(discussionmembership_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/DiscussionmembershipCreateObjectV1ResponseMPayload.md b/docs/DiscussionmembershipCreateObjectV1ResponseMPayload.md new file mode 100644 index 000000000..dffa3eec2 --- /dev/null +++ b/docs/DiscussionmembershipCreateObjectV1ResponseMPayload.md @@ -0,0 +1,30 @@ +# DiscussionmembershipCreateObjectV1ResponseMPayload + +Payload for POST /1/object/discussionmembership + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**a_pki_discussionmembership_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.discussionmembership_create_object_v1_response_m_payload import DiscussionmembershipCreateObjectV1ResponseMPayload + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionmembershipCreateObjectV1ResponseMPayload from a JSON string +discussionmembership_create_object_v1_response_m_payload_instance = DiscussionmembershipCreateObjectV1ResponseMPayload.from_json(json) +# print the JSON string representation of the object +print DiscussionmembershipCreateObjectV1ResponseMPayload.to_json() + +# convert the object into a dict +discussionmembership_create_object_v1_response_m_payload_dict = discussionmembership_create_object_v1_response_m_payload_instance.to_dict() +# create an instance of DiscussionmembershipCreateObjectV1ResponseMPayload from a dict +discussionmembership_create_object_v1_response_m_payload_form_dict = discussionmembership_create_object_v1_response_m_payload.from_dict(discussionmembership_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/DiscussionmembershipDeleteObjectV1Response.md b/docs/DiscussionmembershipDeleteObjectV1Response.md new file mode 100644 index 000000000..eac21660e --- /dev/null +++ b/docs/DiscussionmembershipDeleteObjectV1Response.md @@ -0,0 +1,31 @@ +# DiscussionmembershipDeleteObjectV1Response + +Response for DELETE /1/object/discussionmembership/{pkiDiscussionmembershipID} + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] + +## Example + +```python +from eZmaxApi.models.discussionmembership_delete_object_v1_response import DiscussionmembershipDeleteObjectV1Response + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionmembershipDeleteObjectV1Response from a JSON string +discussionmembership_delete_object_v1_response_instance = DiscussionmembershipDeleteObjectV1Response.from_json(json) +# print the JSON string representation of the object +print DiscussionmembershipDeleteObjectV1Response.to_json() + +# convert the object into a dict +discussionmembership_delete_object_v1_response_dict = discussionmembership_delete_object_v1_response_instance.to_dict() +# create an instance of DiscussionmembershipDeleteObjectV1Response from a dict +discussionmembership_delete_object_v1_response_form_dict = discussionmembership_delete_object_v1_response.from_dict(discussionmembership_delete_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/DiscussionmembershipRequest.md b/docs/DiscussionmembershipRequest.md new file mode 100644 index 000000000..f11e22a5b --- /dev/null +++ b/docs/DiscussionmembershipRequest.md @@ -0,0 +1,35 @@ +# DiscussionmembershipRequest + +A Discussionmembership Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pki_discussionmembership_id** | **int** | The unique ID of the Discussionmembership | [optional] +**fki_discussion_id** | **int** | The unique ID of the Discussion | +**fki_user_id** | **int** | The unique ID of the User | [optional] +**fki_usergroup_id** | **int** | The unique ID of the Usergroup | [optional] +**fki_modulesection_id** | **int** | The unique ID of the Modulesection | [optional] +**dt_discussionmembership_joined** | **str** | The joined date of the Discussionmembership | + +## Example + +```python +from eZmaxApi.models.discussionmembership_request import DiscussionmembershipRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionmembershipRequest from a JSON string +discussionmembership_request_instance = DiscussionmembershipRequest.from_json(json) +# print the JSON string representation of the object +print DiscussionmembershipRequest.to_json() + +# convert the object into a dict +discussionmembership_request_dict = discussionmembership_request_instance.to_dict() +# create an instance of DiscussionmembershipRequest from a dict +discussionmembership_request_form_dict = discussionmembership_request.from_dict(discussionmembership_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/DiscussionmembershipRequestCompound.md b/docs/DiscussionmembershipRequestCompound.md new file mode 100644 index 000000000..0ade03957 --- /dev/null +++ b/docs/DiscussionmembershipRequestCompound.md @@ -0,0 +1,35 @@ +# DiscussionmembershipRequestCompound + +A Discussionmembership Object and children + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pki_discussionmembership_id** | **int** | The unique ID of the Discussionmembership | [optional] +**fki_discussion_id** | **int** | The unique ID of the Discussion | +**fki_user_id** | **int** | The unique ID of the User | [optional] +**fki_usergroup_id** | **int** | The unique ID of the Usergroup | [optional] +**fki_modulesection_id** | **int** | The unique ID of the Modulesection | [optional] +**dt_discussionmembership_joined** | **str** | The joined date of the Discussionmembership | + +## Example + +```python +from eZmaxApi.models.discussionmembership_request_compound import DiscussionmembershipRequestCompound + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionmembershipRequestCompound from a JSON string +discussionmembership_request_compound_instance = DiscussionmembershipRequestCompound.from_json(json) +# print the JSON string representation of the object +print DiscussionmembershipRequestCompound.to_json() + +# convert the object into a dict +discussionmembership_request_compound_dict = discussionmembership_request_compound_instance.to_dict() +# create an instance of DiscussionmembershipRequestCompound from a dict +discussionmembership_request_compound_form_dict = discussionmembership_request_compound.from_dict(discussionmembership_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/DiscussionmembershipResponse.md b/docs/DiscussionmembershipResponse.md new file mode 100644 index 000000000..5ab9f448d --- /dev/null +++ b/docs/DiscussionmembershipResponse.md @@ -0,0 +1,36 @@ +# DiscussionmembershipResponse + +A Discussionmembership Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pki_discussionmembership_id** | **int** | The unique ID of the Discussionmembership | +**fki_discussion_id** | **int** | The unique ID of the Discussion | +**fki_user_id** | **int** | The unique ID of the User | [optional] +**fki_usergroup_id** | **int** | The unique ID of the Usergroup | [optional] +**fki_modulesection_id** | **int** | The unique ID of the Modulesection | [optional] +**s_discussionmembership_description** | **str** | The Description containing the detail of who the Discussionmembership refers to | +**dt_discussionmembership_joined** | **str** | The joined date of the Discussionmembership | + +## Example + +```python +from eZmaxApi.models.discussionmembership_response import DiscussionmembershipResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionmembershipResponse from a JSON string +discussionmembership_response_instance = DiscussionmembershipResponse.from_json(json) +# print the JSON string representation of the object +print DiscussionmembershipResponse.to_json() + +# convert the object into a dict +discussionmembership_response_dict = discussionmembership_response_instance.to_dict() +# create an instance of DiscussionmembershipResponse from a dict +discussionmembership_response_form_dict = discussionmembership_response.from_dict(discussionmembership_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/DiscussionmembershipResponseCompound.md b/docs/DiscussionmembershipResponseCompound.md new file mode 100644 index 000000000..aedf3d896 --- /dev/null +++ b/docs/DiscussionmembershipResponseCompound.md @@ -0,0 +1,36 @@ +# DiscussionmembershipResponseCompound + +A Discussionmembership Object and children + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pki_discussionmembership_id** | **int** | The unique ID of the Discussionmembership | +**fki_discussion_id** | **int** | The unique ID of the Discussion | +**fki_user_id** | **int** | The unique ID of the User | [optional] +**fki_usergroup_id** | **int** | The unique ID of the Usergroup | [optional] +**fki_modulesection_id** | **int** | The unique ID of the Modulesection | [optional] +**s_discussionmembership_description** | **str** | The Description containing the detail of who the Discussionmembership refers to | +**dt_discussionmembership_joined** | **str** | The joined date of the Discussionmembership | + +## Example + +```python +from eZmaxApi.models.discussionmembership_response_compound import DiscussionmembershipResponseCompound + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionmembershipResponseCompound from a JSON string +discussionmembership_response_compound_instance = DiscussionmembershipResponseCompound.from_json(json) +# print the JSON string representation of the object +print DiscussionmembershipResponseCompound.to_json() + +# convert the object into a dict +discussionmembership_response_compound_dict = discussionmembership_response_compound_instance.to_dict() +# create an instance of DiscussionmembershipResponseCompound from a dict +discussionmembership_response_compound_form_dict = discussionmembership_response_compound.from_dict(discussionmembership_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/DiscussionmessageCreateObjectV1Request.md b/docs/DiscussionmessageCreateObjectV1Request.md new file mode 100644 index 000000000..aa6d9358c --- /dev/null +++ b/docs/DiscussionmessageCreateObjectV1Request.md @@ -0,0 +1,30 @@ +# DiscussionmessageCreateObjectV1Request + +Request for POST /1/object/discussionmessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**a_obj_discussionmessage** | [**List[DiscussionmessageRequestCompound]**](DiscussionmessageRequestCompound.md) | | + +## Example + +```python +from eZmaxApi.models.discussionmessage_create_object_v1_request import DiscussionmessageCreateObjectV1Request + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionmessageCreateObjectV1Request from a JSON string +discussionmessage_create_object_v1_request_instance = DiscussionmessageCreateObjectV1Request.from_json(json) +# print the JSON string representation of the object +print DiscussionmessageCreateObjectV1Request.to_json() + +# convert the object into a dict +discussionmessage_create_object_v1_request_dict = discussionmessage_create_object_v1_request_instance.to_dict() +# create an instance of DiscussionmessageCreateObjectV1Request from a dict +discussionmessage_create_object_v1_request_form_dict = discussionmessage_create_object_v1_request.from_dict(discussionmessage_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/DiscussionmessageCreateObjectV1Response.md b/docs/DiscussionmessageCreateObjectV1Response.md new file mode 100644 index 000000000..ba4e92b87 --- /dev/null +++ b/docs/DiscussionmessageCreateObjectV1Response.md @@ -0,0 +1,32 @@ +# DiscussionmessageCreateObjectV1Response + +Response for POST /1/object/discussionmessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] +**m_payload** | [**DiscussionmessageCreateObjectV1ResponseMPayload**](DiscussionmessageCreateObjectV1ResponseMPayload.md) | | + +## Example + +```python +from eZmaxApi.models.discussionmessage_create_object_v1_response import DiscussionmessageCreateObjectV1Response + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionmessageCreateObjectV1Response from a JSON string +discussionmessage_create_object_v1_response_instance = DiscussionmessageCreateObjectV1Response.from_json(json) +# print the JSON string representation of the object +print DiscussionmessageCreateObjectV1Response.to_json() + +# convert the object into a dict +discussionmessage_create_object_v1_response_dict = discussionmessage_create_object_v1_response_instance.to_dict() +# create an instance of DiscussionmessageCreateObjectV1Response from a dict +discussionmessage_create_object_v1_response_form_dict = discussionmessage_create_object_v1_response.from_dict(discussionmessage_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/DiscussionmessageCreateObjectV1ResponseMPayload.md b/docs/DiscussionmessageCreateObjectV1ResponseMPayload.md new file mode 100644 index 000000000..92cdcdfd4 --- /dev/null +++ b/docs/DiscussionmessageCreateObjectV1ResponseMPayload.md @@ -0,0 +1,30 @@ +# DiscussionmessageCreateObjectV1ResponseMPayload + +Payload for POST /1/object/discussionmessage + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**a_pki_discussionmessage_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.discussionmessage_create_object_v1_response_m_payload import DiscussionmessageCreateObjectV1ResponseMPayload + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionmessageCreateObjectV1ResponseMPayload from a JSON string +discussionmessage_create_object_v1_response_m_payload_instance = DiscussionmessageCreateObjectV1ResponseMPayload.from_json(json) +# print the JSON string representation of the object +print DiscussionmessageCreateObjectV1ResponseMPayload.to_json() + +# convert the object into a dict +discussionmessage_create_object_v1_response_m_payload_dict = discussionmessage_create_object_v1_response_m_payload_instance.to_dict() +# create an instance of DiscussionmessageCreateObjectV1ResponseMPayload from a dict +discussionmessage_create_object_v1_response_m_payload_form_dict = discussionmessage_create_object_v1_response_m_payload.from_dict(discussionmessage_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/DiscussionmessageDeleteObjectV1Response.md b/docs/DiscussionmessageDeleteObjectV1Response.md new file mode 100644 index 000000000..2b0d537ab --- /dev/null +++ b/docs/DiscussionmessageDeleteObjectV1Response.md @@ -0,0 +1,31 @@ +# DiscussionmessageDeleteObjectV1Response + +Response for DELETE /1/object/discussionmessage/{pkiDiscussionmessageID} + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] + +## Example + +```python +from eZmaxApi.models.discussionmessage_delete_object_v1_response import DiscussionmessageDeleteObjectV1Response + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionmessageDeleteObjectV1Response from a JSON string +discussionmessage_delete_object_v1_response_instance = DiscussionmessageDeleteObjectV1Response.from_json(json) +# print the JSON string representation of the object +print DiscussionmessageDeleteObjectV1Response.to_json() + +# convert the object into a dict +discussionmessage_delete_object_v1_response_dict = discussionmessage_delete_object_v1_response_instance.to_dict() +# create an instance of DiscussionmessageDeleteObjectV1Response from a dict +discussionmessage_delete_object_v1_response_form_dict = discussionmessage_delete_object_v1_response.from_dict(discussionmessage_delete_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/DiscussionmessagePatchObjectV1Request.md b/docs/DiscussionmessagePatchObjectV1Request.md new file mode 100644 index 000000000..9e55a2033 --- /dev/null +++ b/docs/DiscussionmessagePatchObjectV1Request.md @@ -0,0 +1,30 @@ +# DiscussionmessagePatchObjectV1Request + +Request for PATCH /1/object/discussionmessage/{pkiDiscussionmessageID} + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_discussionmessage** | [**DiscussionmessageRequestPatch**](DiscussionmessageRequestPatch.md) | | + +## Example + +```python +from eZmaxApi.models.discussionmessage_patch_object_v1_request import DiscussionmessagePatchObjectV1Request + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionmessagePatchObjectV1Request from a JSON string +discussionmessage_patch_object_v1_request_instance = DiscussionmessagePatchObjectV1Request.from_json(json) +# print the JSON string representation of the object +print DiscussionmessagePatchObjectV1Request.to_json() + +# convert the object into a dict +discussionmessage_patch_object_v1_request_dict = discussionmessage_patch_object_v1_request_instance.to_dict() +# create an instance of DiscussionmessagePatchObjectV1Request from a dict +discussionmessage_patch_object_v1_request_form_dict = discussionmessage_patch_object_v1_request.from_dict(discussionmessage_patch_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/DiscussionmessagePatchObjectV1Response.md b/docs/DiscussionmessagePatchObjectV1Response.md new file mode 100644 index 000000000..374acbf5c --- /dev/null +++ b/docs/DiscussionmessagePatchObjectV1Response.md @@ -0,0 +1,31 @@ +# DiscussionmessagePatchObjectV1Response + +Response for PATCH /1/object/discussionmessage/{pkiDiscussionmessageID} + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] + +## Example + +```python +from eZmaxApi.models.discussionmessage_patch_object_v1_response import DiscussionmessagePatchObjectV1Response + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionmessagePatchObjectV1Response from a JSON string +discussionmessage_patch_object_v1_response_instance = DiscussionmessagePatchObjectV1Response.from_json(json) +# print the JSON string representation of the object +print DiscussionmessagePatchObjectV1Response.to_json() + +# convert the object into a dict +discussionmessage_patch_object_v1_response_dict = discussionmessage_patch_object_v1_response_instance.to_dict() +# create an instance of DiscussionmessagePatchObjectV1Response from a dict +discussionmessage_patch_object_v1_response_form_dict = discussionmessage_patch_object_v1_response.from_dict(discussionmessage_patch_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/DiscussionmessageRequest.md b/docs/DiscussionmessageRequest.md new file mode 100644 index 000000000..ab03cfc2d --- /dev/null +++ b/docs/DiscussionmessageRequest.md @@ -0,0 +1,33 @@ +# DiscussionmessageRequest + +A Discussionmessage Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pki_discussionmessage_id** | **int** | The unique ID of the Discussionmessage | [optional] +**fki_discussion_id** | **int** | The unique ID of the Discussion | +**fki_discussionmembership_id_actionrequired** | **int** | The unique ID of the Discussionmembership | [optional] +**t_discussionmessage_content** | **str** | The content of the Discussionmessage | + +## Example + +```python +from eZmaxApi.models.discussionmessage_request import DiscussionmessageRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionmessageRequest from a JSON string +discussionmessage_request_instance = DiscussionmessageRequest.from_json(json) +# print the JSON string representation of the object +print DiscussionmessageRequest.to_json() + +# convert the object into a dict +discussionmessage_request_dict = discussionmessage_request_instance.to_dict() +# create an instance of DiscussionmessageRequest from a dict +discussionmessage_request_form_dict = discussionmessage_request.from_dict(discussionmessage_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/DiscussionmessageRequestCompound.md b/docs/DiscussionmessageRequestCompound.md new file mode 100644 index 000000000..b06258c0e --- /dev/null +++ b/docs/DiscussionmessageRequestCompound.md @@ -0,0 +1,33 @@ +# DiscussionmessageRequestCompound + +A Discussionmessage Object and children + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pki_discussionmessage_id** | **int** | The unique ID of the Discussionmessage | [optional] +**fki_discussion_id** | **int** | The unique ID of the Discussion | +**fki_discussionmembership_id_actionrequired** | **int** | The unique ID of the Discussionmembership | [optional] +**t_discussionmessage_content** | **str** | The content of the Discussionmessage | + +## Example + +```python +from eZmaxApi.models.discussionmessage_request_compound import DiscussionmessageRequestCompound + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionmessageRequestCompound from a JSON string +discussionmessage_request_compound_instance = DiscussionmessageRequestCompound.from_json(json) +# print the JSON string representation of the object +print DiscussionmessageRequestCompound.to_json() + +# convert the object into a dict +discussionmessage_request_compound_dict = discussionmessage_request_compound_instance.to_dict() +# create an instance of DiscussionmessageRequestCompound from a dict +discussionmessage_request_compound_form_dict = discussionmessage_request_compound.from_dict(discussionmessage_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/DiscussionmessageRequestPatch.md b/docs/DiscussionmessageRequestPatch.md new file mode 100644 index 000000000..b7c641912 --- /dev/null +++ b/docs/DiscussionmessageRequestPatch.md @@ -0,0 +1,31 @@ +# DiscussionmessageRequestPatch + +A Discussionmessage Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**fki_discussionmembership_id_actionrequired** | **int** | The unique ID of the Discussionmembership | [optional] +**t_discussionmessage_content** | **str** | The content of the Discussionmessage | [optional] + +## Example + +```python +from eZmaxApi.models.discussionmessage_request_patch import DiscussionmessageRequestPatch + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionmessageRequestPatch from a JSON string +discussionmessage_request_patch_instance = DiscussionmessageRequestPatch.from_json(json) +# print the JSON string representation of the object +print DiscussionmessageRequestPatch.to_json() + +# convert the object into a dict +discussionmessage_request_patch_dict = discussionmessage_request_patch_instance.to_dict() +# create an instance of DiscussionmessageRequestPatch from a dict +discussionmessage_request_patch_form_dict = discussionmessage_request_patch.from_dict(discussionmessage_request_patch_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/DiscussionmessageResponse.md b/docs/DiscussionmessageResponse.md new file mode 100644 index 000000000..d58529728 --- /dev/null +++ b/docs/DiscussionmessageResponse.md @@ -0,0 +1,38 @@ +# DiscussionmessageResponse + +A Discussionmessage Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pki_discussionmessage_id** | **int** | The unique ID of the Discussionmessage | +**fki_discussion_id** | **int** | The unique ID of the Discussion | +**fki_discussionmembership_id** | **int** | The unique ID of the Discussionmembership | [optional] +**fki_discussionmembership_id_actionrequired** | **int** | The unique ID of the Discussionmembership | [optional] +**e_discussionmessage_status** | [**FieldEDiscussionmessageStatus**](FieldEDiscussionmessageStatus.md) | | +**t_discussionmessage_content** | **str** | The content of the Discussionmessage | +**s_discussionmessage_creatorname** | **str** | The name the creator of the Discussionmessage. | +**s_discussionmessage_actionrequiredname** | **str** | The name the Actionrequired of the Discussionmessage. | [optional] +**obj_audit** | [**CommonAudit**](CommonAudit.md) | | + +## Example + +```python +from eZmaxApi.models.discussionmessage_response import DiscussionmessageResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionmessageResponse from a JSON string +discussionmessage_response_instance = DiscussionmessageResponse.from_json(json) +# print the JSON string representation of the object +print DiscussionmessageResponse.to_json() + +# convert the object into a dict +discussionmessage_response_dict = discussionmessage_response_instance.to_dict() +# create an instance of DiscussionmessageResponse from a dict +discussionmessage_response_form_dict = discussionmessage_response.from_dict(discussionmessage_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/DiscussionmessageResponseCompound.md b/docs/DiscussionmessageResponseCompound.md new file mode 100644 index 000000000..30eac3525 --- /dev/null +++ b/docs/DiscussionmessageResponseCompound.md @@ -0,0 +1,38 @@ +# DiscussionmessageResponseCompound + +A Discussionmessage Object and children + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pki_discussionmessage_id** | **int** | The unique ID of the Discussionmessage | +**fki_discussion_id** | **int** | The unique ID of the Discussion | +**fki_discussionmembership_id** | **int** | The unique ID of the Discussionmembership | [optional] +**fki_discussionmembership_id_actionrequired** | **int** | The unique ID of the Discussionmembership | [optional] +**e_discussionmessage_status** | [**FieldEDiscussionmessageStatus**](FieldEDiscussionmessageStatus.md) | | +**t_discussionmessage_content** | **str** | The content of the Discussionmessage | +**s_discussionmessage_creatorname** | **str** | The name the creator of the Discussionmessage. | +**s_discussionmessage_actionrequiredname** | **str** | The name the Actionrequired of the Discussionmessage. | [optional] +**obj_audit** | [**CommonAudit**](CommonAudit.md) | | + +## Example + +```python +from eZmaxApi.models.discussionmessage_response_compound import DiscussionmessageResponseCompound + +# TODO update the JSON string below +json = "{}" +# create an instance of DiscussionmessageResponseCompound from a JSON string +discussionmessage_response_compound_instance = DiscussionmessageResponseCompound.from_json(json) +# print the JSON string representation of the object +print DiscussionmessageResponseCompound.to_json() + +# convert the object into a dict +discussionmessage_response_compound_dict = discussionmessage_response_compound_instance.to_dict() +# create an instance of DiscussionmessageResponseCompound from a dict +discussionmessage_response_compound_form_dict = discussionmessage_response_compound.from_dict(discussionmessage_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/EzsigndiscussionCreateObjectV1Request.md b/docs/EzsigndiscussionCreateObjectV1Request.md new file mode 100644 index 000000000..cf1e5e716 --- /dev/null +++ b/docs/EzsigndiscussionCreateObjectV1Request.md @@ -0,0 +1,30 @@ +# EzsigndiscussionCreateObjectV1Request + +Request for POST /1/object/ezsigndiscussion + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**a_obj_ezsigndiscussion** | [**List[EzsigndiscussionRequestCompound]**](EzsigndiscussionRequestCompound.md) | | + +## Example + +```python +from eZmaxApi.models.ezsigndiscussion_create_object_v1_request import EzsigndiscussionCreateObjectV1Request + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsigndiscussionCreateObjectV1Request from a JSON string +ezsigndiscussion_create_object_v1_request_instance = EzsigndiscussionCreateObjectV1Request.from_json(json) +# print the JSON string representation of the object +print EzsigndiscussionCreateObjectV1Request.to_json() + +# convert the object into a dict +ezsigndiscussion_create_object_v1_request_dict = ezsigndiscussion_create_object_v1_request_instance.to_dict() +# create an instance of EzsigndiscussionCreateObjectV1Request from a dict +ezsigndiscussion_create_object_v1_request_form_dict = ezsigndiscussion_create_object_v1_request.from_dict(ezsigndiscussion_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/EzsigndiscussionCreateObjectV1Response.md b/docs/EzsigndiscussionCreateObjectV1Response.md new file mode 100644 index 000000000..c5c2d36af --- /dev/null +++ b/docs/EzsigndiscussionCreateObjectV1Response.md @@ -0,0 +1,32 @@ +# EzsigndiscussionCreateObjectV1Response + +Response for POST /1/object/ezsigndiscussion + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] +**m_payload** | [**EzsigndiscussionCreateObjectV1ResponseMPayload**](EzsigndiscussionCreateObjectV1ResponseMPayload.md) | | + +## Example + +```python +from eZmaxApi.models.ezsigndiscussion_create_object_v1_response import EzsigndiscussionCreateObjectV1Response + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsigndiscussionCreateObjectV1Response from a JSON string +ezsigndiscussion_create_object_v1_response_instance = EzsigndiscussionCreateObjectV1Response.from_json(json) +# print the JSON string representation of the object +print EzsigndiscussionCreateObjectV1Response.to_json() + +# convert the object into a dict +ezsigndiscussion_create_object_v1_response_dict = ezsigndiscussion_create_object_v1_response_instance.to_dict() +# create an instance of EzsigndiscussionCreateObjectV1Response from a dict +ezsigndiscussion_create_object_v1_response_form_dict = ezsigndiscussion_create_object_v1_response.from_dict(ezsigndiscussion_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/EzsigndiscussionCreateObjectV1ResponseMPayload.md b/docs/EzsigndiscussionCreateObjectV1ResponseMPayload.md new file mode 100644 index 000000000..9772de893 --- /dev/null +++ b/docs/EzsigndiscussionCreateObjectV1ResponseMPayload.md @@ -0,0 +1,30 @@ +# EzsigndiscussionCreateObjectV1ResponseMPayload + +Payload for POST /1/object/ezsigndiscussion + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**a_pki_ezsigndiscussion_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.ezsigndiscussion_create_object_v1_response_m_payload import EzsigndiscussionCreateObjectV1ResponseMPayload + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsigndiscussionCreateObjectV1ResponseMPayload from a JSON string +ezsigndiscussion_create_object_v1_response_m_payload_instance = EzsigndiscussionCreateObjectV1ResponseMPayload.from_json(json) +# print the JSON string representation of the object +print EzsigndiscussionCreateObjectV1ResponseMPayload.to_json() + +# convert the object into a dict +ezsigndiscussion_create_object_v1_response_m_payload_dict = ezsigndiscussion_create_object_v1_response_m_payload_instance.to_dict() +# create an instance of EzsigndiscussionCreateObjectV1ResponseMPayload from a dict +ezsigndiscussion_create_object_v1_response_m_payload_form_dict = ezsigndiscussion_create_object_v1_response_m_payload.from_dict(ezsigndiscussion_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/EzsigndiscussionDeleteObjectV1Response.md b/docs/EzsigndiscussionDeleteObjectV1Response.md new file mode 100644 index 000000000..3f8ac775f --- /dev/null +++ b/docs/EzsigndiscussionDeleteObjectV1Response.md @@ -0,0 +1,31 @@ +# EzsigndiscussionDeleteObjectV1Response + +Response for DELETE /1/object/ezsigndiscussion/{pkiEzsigndiscussionID} + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] + +## Example + +```python +from eZmaxApi.models.ezsigndiscussion_delete_object_v1_response import EzsigndiscussionDeleteObjectV1Response + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsigndiscussionDeleteObjectV1Response from a JSON string +ezsigndiscussion_delete_object_v1_response_instance = EzsigndiscussionDeleteObjectV1Response.from_json(json) +# print the JSON string representation of the object +print EzsigndiscussionDeleteObjectV1Response.to_json() + +# convert the object into a dict +ezsigndiscussion_delete_object_v1_response_dict = ezsigndiscussion_delete_object_v1_response_instance.to_dict() +# create an instance of EzsigndiscussionDeleteObjectV1Response from a dict +ezsigndiscussion_delete_object_v1_response_form_dict = ezsigndiscussion_delete_object_v1_response.from_dict(ezsigndiscussion_delete_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/EzsigndiscussionGetObjectV2Response.md b/docs/EzsigndiscussionGetObjectV2Response.md new file mode 100644 index 000000000..7d3db05bf --- /dev/null +++ b/docs/EzsigndiscussionGetObjectV2Response.md @@ -0,0 +1,32 @@ +# EzsigndiscussionGetObjectV2Response + +Response for GET /2/object/ezsigndiscussion/{pkiEzsigndiscussionID} + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] +**m_payload** | [**EzsigndiscussionGetObjectV2ResponseMPayload**](EzsigndiscussionGetObjectV2ResponseMPayload.md) | | + +## Example + +```python +from eZmaxApi.models.ezsigndiscussion_get_object_v2_response import EzsigndiscussionGetObjectV2Response + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsigndiscussionGetObjectV2Response from a JSON string +ezsigndiscussion_get_object_v2_response_instance = EzsigndiscussionGetObjectV2Response.from_json(json) +# print the JSON string representation of the object +print EzsigndiscussionGetObjectV2Response.to_json() + +# convert the object into a dict +ezsigndiscussion_get_object_v2_response_dict = ezsigndiscussion_get_object_v2_response_instance.to_dict() +# create an instance of EzsigndiscussionGetObjectV2Response from a dict +ezsigndiscussion_get_object_v2_response_form_dict = ezsigndiscussion_get_object_v2_response.from_dict(ezsigndiscussion_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/EzsigndiscussionGetObjectV2ResponseMPayload.md b/docs/EzsigndiscussionGetObjectV2ResponseMPayload.md new file mode 100644 index 000000000..500c54878 --- /dev/null +++ b/docs/EzsigndiscussionGetObjectV2ResponseMPayload.md @@ -0,0 +1,30 @@ +# EzsigndiscussionGetObjectV2ResponseMPayload + +Payload for GET /2/object/ezsigndiscussion/{pkiEzsigndiscussionID} + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_ezsigndiscussion** | [**EzsigndiscussionResponseCompound**](EzsigndiscussionResponseCompound.md) | | + +## Example + +```python +from eZmaxApi.models.ezsigndiscussion_get_object_v2_response_m_payload import EzsigndiscussionGetObjectV2ResponseMPayload + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsigndiscussionGetObjectV2ResponseMPayload from a JSON string +ezsigndiscussion_get_object_v2_response_m_payload_instance = EzsigndiscussionGetObjectV2ResponseMPayload.from_json(json) +# print the JSON string representation of the object +print EzsigndiscussionGetObjectV2ResponseMPayload.to_json() + +# convert the object into a dict +ezsigndiscussion_get_object_v2_response_m_payload_dict = ezsigndiscussion_get_object_v2_response_m_payload_instance.to_dict() +# create an instance of EzsigndiscussionGetObjectV2ResponseMPayload from a dict +ezsigndiscussion_get_object_v2_response_m_payload_form_dict = ezsigndiscussion_get_object_v2_response_m_payload.from_dict(ezsigndiscussion_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/EzsigndiscussionRequest.md b/docs/EzsigndiscussionRequest.md new file mode 100644 index 000000000..e955aed05 --- /dev/null +++ b/docs/EzsigndiscussionRequest.md @@ -0,0 +1,35 @@ +# EzsigndiscussionRequest + +An Ezsigndiscussion Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pki_ezsigndiscussion_id** | **int** | The unique ID of the Ezsigndiscussion | [optional] +**fki_ezsigndocument_id** | **int** | The unique ID of the Ezsigndocument | +**i_ezsigndiscussion_pagenumber** | **int** | The page number in the Ezsigndocument for the Ezsigndiscussion | +**i_ezsigndiscussion_x** | **int** | The x of the Ezsigndiscussion | +**i_ezsigndiscussion_y** | **int** | The y of the Ezsigndiscussion | +**obj_discussion** | [**DiscussionRequest**](DiscussionRequest.md) | | + +## Example + +```python +from eZmaxApi.models.ezsigndiscussion_request import EzsigndiscussionRequest + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsigndiscussionRequest from a JSON string +ezsigndiscussion_request_instance = EzsigndiscussionRequest.from_json(json) +# print the JSON string representation of the object +print EzsigndiscussionRequest.to_json() + +# convert the object into a dict +ezsigndiscussion_request_dict = ezsigndiscussion_request_instance.to_dict() +# create an instance of EzsigndiscussionRequest from a dict +ezsigndiscussion_request_form_dict = ezsigndiscussion_request.from_dict(ezsigndiscussion_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/EzsigndiscussionRequestCompound.md b/docs/EzsigndiscussionRequestCompound.md new file mode 100644 index 000000000..fcef37de1 --- /dev/null +++ b/docs/EzsigndiscussionRequestCompound.md @@ -0,0 +1,35 @@ +# EzsigndiscussionRequestCompound + +A Ezsigndiscussion Object and children + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pki_ezsigndiscussion_id** | **int** | The unique ID of the Ezsigndiscussion | [optional] +**fki_ezsigndocument_id** | **int** | The unique ID of the Ezsigndocument | +**i_ezsigndiscussion_pagenumber** | **int** | The page number in the Ezsigndocument for the Ezsigndiscussion | +**i_ezsigndiscussion_x** | **int** | The x of the Ezsigndiscussion | +**i_ezsigndiscussion_y** | **int** | The y of the Ezsigndiscussion | +**obj_discussion** | [**DiscussionRequest**](DiscussionRequest.md) | | + +## Example + +```python +from eZmaxApi.models.ezsigndiscussion_request_compound import EzsigndiscussionRequestCompound + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsigndiscussionRequestCompound from a JSON string +ezsigndiscussion_request_compound_instance = EzsigndiscussionRequestCompound.from_json(json) +# print the JSON string representation of the object +print EzsigndiscussionRequestCompound.to_json() + +# convert the object into a dict +ezsigndiscussion_request_compound_dict = ezsigndiscussion_request_compound_instance.to_dict() +# create an instance of EzsigndiscussionRequestCompound from a dict +ezsigndiscussion_request_compound_form_dict = ezsigndiscussion_request_compound.from_dict(ezsigndiscussion_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/EzsigndiscussionResponse.md b/docs/EzsigndiscussionResponse.md new file mode 100644 index 000000000..b2085518a --- /dev/null +++ b/docs/EzsigndiscussionResponse.md @@ -0,0 +1,36 @@ +# EzsigndiscussionResponse + +A Ezsigndiscussion Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pki_ezsigndiscussion_id** | **int** | The unique ID of the Ezsigndiscussion | +**fki_ezsignpage_id** | **int** | The unique ID of the Ezsignpage | +**fki_discussion_id** | **int** | The unique ID of the Discussion | +**i_ezsigndiscussion_x** | **int** | The x of the Ezsigndiscussion | +**i_ezsigndiscussion_y** | **int** | The y of the Ezsigndiscussion | +**i_ezsigndiscussion_pagenumber** | **int** | The page number in the Ezsigndocument for the Ezsigndiscussion | +**obj_discussion** | [**DiscussionResponseCompound**](DiscussionResponseCompound.md) | | + +## Example + +```python +from eZmaxApi.models.ezsigndiscussion_response import EzsigndiscussionResponse + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsigndiscussionResponse from a JSON string +ezsigndiscussion_response_instance = EzsigndiscussionResponse.from_json(json) +# print the JSON string representation of the object +print EzsigndiscussionResponse.to_json() + +# convert the object into a dict +ezsigndiscussion_response_dict = ezsigndiscussion_response_instance.to_dict() +# create an instance of EzsigndiscussionResponse from a dict +ezsigndiscussion_response_form_dict = ezsigndiscussion_response.from_dict(ezsigndiscussion_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/EzsigndiscussionResponseCompound.md b/docs/EzsigndiscussionResponseCompound.md new file mode 100644 index 000000000..301b94466 --- /dev/null +++ b/docs/EzsigndiscussionResponseCompound.md @@ -0,0 +1,36 @@ +# EzsigndiscussionResponseCompound + +A Ezsigndiscussion Object + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pki_ezsigndiscussion_id** | **int** | The unique ID of the Ezsigndiscussion | +**fki_ezsignpage_id** | **int** | The unique ID of the Ezsignpage | +**fki_discussion_id** | **int** | The unique ID of the Discussion | +**i_ezsigndiscussion_x** | **int** | The x of the Ezsigndiscussion | +**i_ezsigndiscussion_y** | **int** | The y of the Ezsigndiscussion | +**i_ezsigndiscussion_pagenumber** | **int** | The page number in the Ezsigndocument for the Ezsigndiscussion | +**obj_discussion** | [**DiscussionResponseCompound**](DiscussionResponseCompound.md) | | + +## Example + +```python +from eZmaxApi.models.ezsigndiscussion_response_compound import EzsigndiscussionResponseCompound + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsigndiscussionResponseCompound from a JSON string +ezsigndiscussion_response_compound_instance = EzsigndiscussionResponseCompound.from_json(json) +# print the JSON string representation of the object +print EzsigndiscussionResponseCompound.to_json() + +# convert the object into a dict +ezsigndiscussion_response_compound_dict = ezsigndiscussion_response_compound_instance.to_dict() +# create an instance of EzsigndiscussionResponseCompound from a dict +ezsigndiscussion_response_compound_form_dict = ezsigndiscussion_response_compound.from_dict(ezsigndiscussion_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/EzsigndocumentApplyEzsigntemplateV2Response.md b/docs/EzsigndocumentApplyEzsigntemplateV2Response.md index 94085b751..e3a7f41a6 100644 --- a/docs/EzsigndocumentApplyEzsigntemplateV2Response.md +++ b/docs/EzsigndocumentApplyEzsigntemplateV2Response.md @@ -8,6 +8,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | **obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] +**a_obj_warning** | [**List[CommonResponseWarning]**](CommonResponseWarning.md) | | [optional] ## Example diff --git a/docs/EzsigndocumentCreateEzsignelementsPositionedByWordV1Request.md b/docs/EzsigndocumentCreateEzsignelementsPositionedByWordV1Request.md new file mode 100644 index 000000000..e3e4ff2cb --- /dev/null +++ b/docs/EzsigndocumentCreateEzsignelementsPositionedByWordV1Request.md @@ -0,0 +1,31 @@ +# EzsigndocumentCreateEzsignelementsPositionedByWordV1Request + +Request for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/createEzsignelementsPositionedByWord + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**a_obj_ezsignformfieldgroup** | [**List[CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest]**](CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest.md) | | +**a_obj_ezsignsignature** | [**List[CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest]**](CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest.md) | | + +## Example + +```python +from eZmaxApi.models.ezsigndocument_create_ezsignelements_positioned_by_word_v1_request import EzsigndocumentCreateEzsignelementsPositionedByWordV1Request + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsigndocumentCreateEzsignelementsPositionedByWordV1Request from a JSON string +ezsigndocument_create_ezsignelements_positioned_by_word_v1_request_instance = EzsigndocumentCreateEzsignelementsPositionedByWordV1Request.from_json(json) +# print the JSON string representation of the object +print EzsigndocumentCreateEzsignelementsPositionedByWordV1Request.to_json() + +# convert the object into a dict +ezsigndocument_create_ezsignelements_positioned_by_word_v1_request_dict = ezsigndocument_create_ezsignelements_positioned_by_word_v1_request_instance.to_dict() +# create an instance of EzsigndocumentCreateEzsignelementsPositionedByWordV1Request from a dict +ezsigndocument_create_ezsignelements_positioned_by_word_v1_request_form_dict = ezsigndocument_create_ezsignelements_positioned_by_word_v1_request.from_dict(ezsigndocument_create_ezsignelements_positioned_by_word_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/EzsigndocumentCreateEzsignelementsPositionedByWordV1Response.md b/docs/EzsigndocumentCreateEzsignelementsPositionedByWordV1Response.md new file mode 100644 index 000000000..1df2c03fc --- /dev/null +++ b/docs/EzsigndocumentCreateEzsignelementsPositionedByWordV1Response.md @@ -0,0 +1,32 @@ +# EzsigndocumentCreateEzsignelementsPositionedByWordV1Response + +Response for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/createEzsignelementsPositionedByWord + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] +**m_payload** | [**EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload**](EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload.md) | | + +## Example + +```python +from eZmaxApi.models.ezsigndocument_create_ezsignelements_positioned_by_word_v1_response import EzsigndocumentCreateEzsignelementsPositionedByWordV1Response + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsigndocumentCreateEzsignelementsPositionedByWordV1Response from a JSON string +ezsigndocument_create_ezsignelements_positioned_by_word_v1_response_instance = EzsigndocumentCreateEzsignelementsPositionedByWordV1Response.from_json(json) +# print the JSON string representation of the object +print EzsigndocumentCreateEzsignelementsPositionedByWordV1Response.to_json() + +# convert the object into a dict +ezsigndocument_create_ezsignelements_positioned_by_word_v1_response_dict = ezsigndocument_create_ezsignelements_positioned_by_word_v1_response_instance.to_dict() +# create an instance of EzsigndocumentCreateEzsignelementsPositionedByWordV1Response from a dict +ezsigndocument_create_ezsignelements_positioned_by_word_v1_response_form_dict = ezsigndocument_create_ezsignelements_positioned_by_word_v1_response.from_dict(ezsigndocument_create_ezsignelements_positioned_by_word_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/EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload.md b/docs/EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload.md new file mode 100644 index 000000000..cb370b910 --- /dev/null +++ b/docs/EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload.md @@ -0,0 +1,31 @@ +# EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload + +Payload for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/createEzsignelementsPositionedByWord + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**a_pki_ezsignsignature_id** | **List[int]** | | +**a_pki_ezsignformfieldgroup_id** | **List[int]** | | + +## Example + +```python +from eZmaxApi.models.ezsigndocument_create_ezsignelements_positioned_by_word_v1_response_m_payload import EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload from a JSON string +ezsigndocument_create_ezsignelements_positioned_by_word_v1_response_m_payload_instance = EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload.from_json(json) +# print the JSON string representation of the object +print EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload.to_json() + +# convert the object into a dict +ezsigndocument_create_ezsignelements_positioned_by_word_v1_response_m_payload_dict = ezsigndocument_create_ezsignelements_positioned_by_word_v1_response_m_payload_instance.to_dict() +# create an instance of EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload from a dict +ezsigndocument_create_ezsignelements_positioned_by_word_v1_response_m_payload_form_dict = ezsigndocument_create_ezsignelements_positioned_by_word_v1_response_m_payload.from_dict(ezsigndocument_create_ezsignelements_positioned_by_word_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/EzsigndocumentGetEzsigndiscussionsV1Response.md b/docs/EzsigndocumentGetEzsigndiscussionsV1Response.md new file mode 100644 index 000000000..0d5c1e1eb --- /dev/null +++ b/docs/EzsigndocumentGetEzsigndiscussionsV1Response.md @@ -0,0 +1,32 @@ +# EzsigndocumentGetEzsigndiscussionsV1Response + +Response for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsigndiscussions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**obj_debug_payload** | [**CommonResponseObjDebugPayload**](CommonResponseObjDebugPayload.md) | | +**obj_debug** | [**CommonResponseObjDebug**](CommonResponseObjDebug.md) | | [optional] +**m_payload** | [**EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload**](EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload.md) | | + +## Example + +```python +from eZmaxApi.models.ezsigndocument_get_ezsigndiscussions_v1_response import EzsigndocumentGetEzsigndiscussionsV1Response + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsigndocumentGetEzsigndiscussionsV1Response from a JSON string +ezsigndocument_get_ezsigndiscussions_v1_response_instance = EzsigndocumentGetEzsigndiscussionsV1Response.from_json(json) +# print the JSON string representation of the object +print EzsigndocumentGetEzsigndiscussionsV1Response.to_json() + +# convert the object into a dict +ezsigndocument_get_ezsigndiscussions_v1_response_dict = ezsigndocument_get_ezsigndiscussions_v1_response_instance.to_dict() +# create an instance of EzsigndocumentGetEzsigndiscussionsV1Response from a dict +ezsigndocument_get_ezsigndiscussions_v1_response_form_dict = ezsigndocument_get_ezsigndiscussions_v1_response.from_dict(ezsigndocument_get_ezsigndiscussions_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/EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload.md b/docs/EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload.md new file mode 100644 index 000000000..3c28fc827 --- /dev/null +++ b/docs/EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload.md @@ -0,0 +1,30 @@ +# EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload + +Payload for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsigndiscussions + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**a_obj_ezsigndiscussion** | [**List[EzsigndiscussionResponse]**](EzsigndiscussionResponse.md) | | + +## Example + +```python +from eZmaxApi.models.ezsigndocument_get_ezsigndiscussions_v1_response_m_payload import EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload + +# TODO update the JSON string below +json = "{}" +# create an instance of EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload from a JSON string +ezsigndocument_get_ezsigndiscussions_v1_response_m_payload_instance = EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload.from_json(json) +# print the JSON string representation of the object +print EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload.to_json() + +# convert the object into a dict +ezsigndocument_get_ezsigndiscussions_v1_response_m_payload_dict = ezsigndocument_get_ezsigndiscussions_v1_response_m_payload_instance.to_dict() +# create an instance of EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload from a dict +ezsigndocument_get_ezsigndiscussions_v1_response_m_payload_form_dict = ezsigndocument_get_ezsigndiscussions_v1_response_m_payload.from_dict(ezsigndocument_get_ezsigndiscussions_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/EzsignfolderGetObjectV1ResponseMPayload.md b/docs/EzsignfolderGetObjectV1ResponseMPayload.md index 3aa943f1e..5a62bede2 100644 --- a/docs/EzsignfolderGetObjectV1ResponseMPayload.md +++ b/docs/EzsignfolderGetObjectV1ResponseMPayload.md @@ -9,6 +9,7 @@ Name | Type | Description | Notes **pki_ezsignfolder_id** | **int** | The unique ID of the Ezsignfolder | **fki_ezsignfoldertype_id** | **int** | The unique ID of the Ezsignfoldertype. | [optional] **obj_ezsignfoldertype** | [**CustomEzsignfoldertypeResponse**](CustomEzsignfoldertypeResponse.md) | | [optional] +**e_ezsignfolder_completion** | [**FieldEEzsignfolderCompletion**](FieldEEzsignfolderCompletion.md) | | [optional] **s_ezsignfoldertype_name_x** | **str** | | [optional] **fki_billingentityinternal_id** | **int** | The unique ID of the Billingentityinternal. | [optional] **s_billingentityinternal_description_x** | **str** | The description of the Billingentityinternal in the language of the requester | [optional] diff --git a/docs/EzsignfolderListElement.md b/docs/EzsignfolderListElement.md index d71bdf404..d9752437a 100644 --- a/docs/EzsignfolderListElement.md +++ b/docs/EzsignfolderListElement.md @@ -13,6 +13,7 @@ Name | Type | Description | Notes **s_ezsignfolder_description** | **str** | The description of the Ezsignfolder | **e_ezsignfolder_step** | [**FieldEEzsignfolderStep**](FieldEEzsignfolderStep.md) | | **dt_created_date** | **str** | The date and time at which the object was created | +**dt_ezsignfolder_delayedsenddate** | **str** | The date and time at which the Ezsignfolder will be sent in the future. | [optional] **dt_ezsignfolder_sentdate** | **str** | The date and time at which the Ezsignfolder was sent the last time. | [optional] **dt_ezsignfolder_duedate** | **str** | The maximum date and time at which the Ezsignfolder can be signed. | [optional] **i_ezsigndocument** | **int** | The total number of Ezsigndocument in the folder | diff --git a/docs/EzsignfolderResponse.md b/docs/EzsignfolderResponse.md index 14be4a57f..465f36626 100644 --- a/docs/EzsignfolderResponse.md +++ b/docs/EzsignfolderResponse.md @@ -9,6 +9,7 @@ Name | Type | Description | Notes **pki_ezsignfolder_id** | **int** | The unique ID of the Ezsignfolder | **fki_ezsignfoldertype_id** | **int** | The unique ID of the Ezsignfoldertype. | [optional] **obj_ezsignfoldertype** | [**CustomEzsignfoldertypeResponse**](CustomEzsignfoldertypeResponse.md) | | [optional] +**e_ezsignfolder_completion** | [**FieldEEzsignfolderCompletion**](FieldEEzsignfolderCompletion.md) | | [optional] **s_ezsignfoldertype_name_x** | **str** | | [optional] **fki_billingentityinternal_id** | **int** | The unique ID of the Billingentityinternal. | [optional] **s_billingentityinternal_description_x** | **str** | The description of the Billingentityinternal in the language of the requester | [optional] diff --git a/docs/EzsignfolderResponseCompound.md b/docs/EzsignfolderResponseCompound.md index f3a174ee7..4c80b3c47 100644 --- a/docs/EzsignfolderResponseCompound.md +++ b/docs/EzsignfolderResponseCompound.md @@ -9,6 +9,7 @@ Name | Type | Description | Notes **pki_ezsignfolder_id** | **int** | The unique ID of the Ezsignfolder | **fki_ezsignfoldertype_id** | **int** | The unique ID of the Ezsignfoldertype. | [optional] **obj_ezsignfoldertype** | [**CustomEzsignfoldertypeResponse**](CustomEzsignfoldertypeResponse.md) | | [optional] +**e_ezsignfolder_completion** | [**FieldEEzsignfolderCompletion**](FieldEEzsignfolderCompletion.md) | | [optional] **s_ezsignfoldertype_name_x** | **str** | | [optional] **fki_billingentityinternal_id** | **int** | The unique ID of the Billingentityinternal. | [optional] **s_billingentityinternal_description_x** | **str** | The description of the Billingentityinternal in the language of the requester | [optional] diff --git a/docs/EzsignfoldertypeRequest.md b/docs/EzsignfoldertypeRequest.md index 00735e20a..668774ddc 100644 --- a/docs/EzsignfoldertypeRequest.md +++ b/docs/EzsignfoldertypeRequest.md @@ -19,10 +19,13 @@ Name | Type | Description | Notes **e_ezsignfoldertype_sendreminderfrequency** | [**FieldEEzsignfoldertypeSendreminderfrequency**](FieldEEzsignfoldertypeSendreminderfrequency.md) | | [optional] **i_ezsignfoldertype_archivaldays** | **int** | The number of days before the archival of Ezsignfolders created using this Ezsignfoldertype | **e_ezsignfoldertype_disposal** | [**FieldEEzsignfoldertypeDisposal**](FieldEEzsignfoldertypeDisposal.md) | | +**e_ezsignfoldertype_completion** | [**FieldEEzsignfoldertypeCompletion**](FieldEEzsignfoldertypeCompletion.md) | | [optional] **i_ezsignfoldertype_disposaldays** | **int** | The number of days after the archival before the disposal of the Ezsignfolder | [optional] **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_reassignezsignsigner** | **bool** | Wheter if Reassignment of signature is allowed by a signatory to another signatory or not | [optional] +**b_ezsignfoldertype_reassignuser** | **bool** | Wheter if Reassignment of signature is allowed by a user to a signatory or another user or not | [optional] **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] diff --git a/docs/EzsignfoldertypeRequestCompound.md b/docs/EzsignfoldertypeRequestCompound.md index d637bdec2..fcaffe386 100644 --- a/docs/EzsignfoldertypeRequestCompound.md +++ b/docs/EzsignfoldertypeRequestCompound.md @@ -19,10 +19,13 @@ Name | Type | Description | Notes **e_ezsignfoldertype_sendreminderfrequency** | [**FieldEEzsignfoldertypeSendreminderfrequency**](FieldEEzsignfoldertypeSendreminderfrequency.md) | | [optional] **i_ezsignfoldertype_archivaldays** | **int** | The number of days before the archival of Ezsignfolders created using this Ezsignfoldertype | **e_ezsignfoldertype_disposal** | [**FieldEEzsignfoldertypeDisposal**](FieldEEzsignfoldertypeDisposal.md) | | +**e_ezsignfoldertype_completion** | [**FieldEEzsignfoldertypeCompletion**](FieldEEzsignfoldertypeCompletion.md) | | [optional] **i_ezsignfoldertype_disposaldays** | **int** | The number of days after the archival before the disposal of the Ezsignfolder | [optional] **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_reassignezsignsigner** | **bool** | Wheter if Reassignment of signature is allowed by a signatory to another signatory or not | [optional] +**b_ezsignfoldertype_reassignuser** | **bool** | Wheter if Reassignment of signature is allowed by a user to a signatory or another user or not | [optional] **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] diff --git a/docs/EzsignfoldertypeResponse.md b/docs/EzsignfoldertypeResponse.md index a00164e42..a921ec86b 100644 --- a/docs/EzsignfoldertypeResponse.md +++ b/docs/EzsignfoldertypeResponse.md @@ -24,10 +24,13 @@ Name | Type | Description | Notes **e_ezsignfoldertype_sendreminderfrequency** | [**FieldEEzsignfoldertypeSendreminderfrequency**](FieldEEzsignfoldertypeSendreminderfrequency.md) | | [optional] **i_ezsignfoldertype_archivaldays** | **int** | The number of days before the archival of Ezsignfolders created using this Ezsignfoldertype | **e_ezsignfoldertype_disposal** | [**FieldEEzsignfoldertypeDisposal**](FieldEEzsignfoldertypeDisposal.md) | | +**e_ezsignfoldertype_completion** | [**FieldEEzsignfoldertypeCompletion**](FieldEEzsignfoldertypeCompletion.md) | | [optional] **i_ezsignfoldertype_disposaldays** | **int** | The number of days after the archival before the disposal of the Ezsignfolder | [optional] **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_reassignezsignsigner** | **bool** | Wheter if Reassignment of signature is allowed by a signatory to another signatory or not | [optional] +**b_ezsignfoldertype_reassignuser** | **bool** | Wheter if Reassignment of signature is allowed by a user to a signatory or another user or not | [optional] **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] diff --git a/docs/EzsignfoldertypeResponseCompound.md b/docs/EzsignfoldertypeResponseCompound.md index 27f4b029b..590777ddc 100644 --- a/docs/EzsignfoldertypeResponseCompound.md +++ b/docs/EzsignfoldertypeResponseCompound.md @@ -24,10 +24,13 @@ Name | Type | Description | Notes **e_ezsignfoldertype_sendreminderfrequency** | [**FieldEEzsignfoldertypeSendreminderfrequency**](FieldEEzsignfoldertypeSendreminderfrequency.md) | | [optional] **i_ezsignfoldertype_archivaldays** | **int** | The number of days before the archival of Ezsignfolders created using this Ezsignfoldertype | **e_ezsignfoldertype_disposal** | [**FieldEEzsignfoldertypeDisposal**](FieldEEzsignfoldertypeDisposal.md) | | +**e_ezsignfoldertype_completion** | [**FieldEEzsignfoldertypeCompletion**](FieldEEzsignfoldertypeCompletion.md) | | [optional] **i_ezsignfoldertype_disposaldays** | **int** | The number of days after the archival before the disposal of the Ezsignfolder | [optional] **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_reassignezsignsigner** | **bool** | Wheter if Reassignment of signature is allowed by a signatory to another signatory or not | [optional] +**b_ezsignfoldertype_reassignuser** | **bool** | Wheter if Reassignment of signature is allowed by a user to a signatory or another user or not | [optional] **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] diff --git a/docs/EzsignformfieldRequest.md b/docs/EzsignformfieldRequest.md index d8e78b9fe..5784940e6 100644 --- a/docs/EzsignformfieldRequest.md +++ b/docs/EzsignformfieldRequest.md @@ -16,7 +16,7 @@ Name | Type | Description | Notes **i_ezsignformfield_height** | **int** | 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** | **bool** | Whether the Ezsignformfield allows the use of the autocomplete of the browser. This can only be set if eEzsignformfieldgroupType is **Text** | [optional] **b_ezsignformfield_selected** | **bool** | Whether the Ezsignformfield is selected or not by default. This can only be set if eEzsignformfieldgroupType is **Checkbox** or **Radio** | [optional] -**s_ezsignformfield_enteredvalue** | **str** | This is the value enterred for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is **Dropdown**, **Text** or **Textarea** | [optional] +**s_ezsignformfield_enteredvalue** | **str** | This is the value enterred for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is **Dropdown**, **Text** or **Textarea** You can use the codes below and they will be replaced at signature time. | Code | Description | Example | | ------------------------- | ------------ | ------------ | | {sUserFirstname} | The first name of the contact | John | | {sUserLastname} | The last name of the contact | Doe | | {sUserJobtitle} | The job title | Sales Representative | | {sEmailAddress} | The email address | email@example.com | | {sPhoneE164} | A phone number in E.164 Format | +15149901516 | | {sPhoneE164Cell} | A phone number in E.164 Format | +15149901516 | | [optional] **e_ezsignformfield_dependencyrequirement** | [**FieldEEzsignformfieldDependencyrequirement**](FieldEEzsignformfieldDependencyrequirement.md) | | [optional] ## Example diff --git a/docs/EzsignformfieldRequestCompound.md b/docs/EzsignformfieldRequestCompound.md index 84d75444d..0632a0574 100644 --- a/docs/EzsignformfieldRequestCompound.md +++ b/docs/EzsignformfieldRequestCompound.md @@ -16,7 +16,7 @@ Name | Type | Description | Notes **i_ezsignformfield_height** | **int** | 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** | **bool** | Whether the Ezsignformfield allows the use of the autocomplete of the browser. This can only be set if eEzsignformfieldgroupType is **Text** | [optional] **b_ezsignformfield_selected** | **bool** | Whether the Ezsignformfield is selected or not by default. This can only be set if eEzsignformfieldgroupType is **Checkbox** or **Radio** | [optional] -**s_ezsignformfield_enteredvalue** | **str** | This is the value enterred for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is **Dropdown**, **Text** or **Textarea** | [optional] +**s_ezsignformfield_enteredvalue** | **str** | This is the value enterred for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is **Dropdown**, **Text** or **Textarea** You can use the codes below and they will be replaced at signature time. | Code | Description | Example | | ------------------------- | ------------ | ------------ | | {sUserFirstname} | The first name of the contact | John | | {sUserLastname} | The last name of the contact | Doe | | {sUserJobtitle} | The job title | Sales Representative | | {sEmailAddress} | The email address | email@example.com | | {sPhoneE164} | A phone number in E.164 Format | +15149901516 | | {sPhoneE164Cell} | A phone number in E.164 Format | +15149901516 | | [optional] **e_ezsignformfield_dependencyrequirement** | [**FieldEEzsignformfieldDependencyrequirement**](FieldEEzsignformfieldDependencyrequirement.md) | | [optional] **a_obj_ezsignelementdependency** | [**List[EzsignelementdependencyRequestCompound]**](EzsignelementdependencyRequestCompound.md) | | [optional] diff --git a/docs/EzsignformfieldResponse.md b/docs/EzsignformfieldResponse.md index cacf50465..1c4a6319a 100644 --- a/docs/EzsignformfieldResponse.md +++ b/docs/EzsignformfieldResponse.md @@ -16,7 +16,7 @@ Name | Type | Description | Notes **i_ezsignformfield_height** | **int** | 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** | **bool** | Whether the Ezsignformfield allows the use of the autocomplete of the browser. This can only be set if eEzsignformfieldgroupType is **Text** | [optional] **b_ezsignformfield_selected** | **bool** | Whether the Ezsignformfield is selected or not by default. This can only be set if eEzsignformfieldgroupType is **Checkbox** or **Radio** | [optional] -**s_ezsignformfield_enteredvalue** | **str** | This is the value enterred for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is **Dropdown**, **Text** or **Textarea** | [optional] +**s_ezsignformfield_enteredvalue** | **str** | This is the value enterred for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is **Dropdown**, **Text** or **Textarea** You can use the codes below and they will be replaced at signature time. | Code | Description | Example | | ------------------------- | ------------ | ------------ | | {sUserFirstname} | The first name of the contact | John | | {sUserLastname} | The last name of the contact | Doe | | {sUserJobtitle} | The job title | Sales Representative | | {sEmailAddress} | The email address | email@example.com | | {sPhoneE164} | A phone number in E.164 Format | +15149901516 | | {sPhoneE164Cell} | A phone number in E.164 Format | +15149901516 | | [optional] **e_ezsignformfield_dependencyrequirement** | [**FieldEEzsignformfieldDependencyrequirement**](FieldEEzsignformfieldDependencyrequirement.md) | | [optional] ## Example diff --git a/docs/EzsignformfieldResponseCompound.md b/docs/EzsignformfieldResponseCompound.md index 3eb987776..b12ecd806 100644 --- a/docs/EzsignformfieldResponseCompound.md +++ b/docs/EzsignformfieldResponseCompound.md @@ -16,7 +16,7 @@ Name | Type | Description | Notes **i_ezsignformfield_height** | **int** | 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** | **bool** | Whether the Ezsignformfield allows the use of the autocomplete of the browser. This can only be set if eEzsignformfieldgroupType is **Text** | [optional] **b_ezsignformfield_selected** | **bool** | Whether the Ezsignformfield is selected or not by default. This can only be set if eEzsignformfieldgroupType is **Checkbox** or **Radio** | [optional] -**s_ezsignformfield_enteredvalue** | **str** | This is the value enterred for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is **Dropdown**, **Text** or **Textarea** | [optional] +**s_ezsignformfield_enteredvalue** | **str** | This is the value enterred for the Ezsignformfield This can only be set if eEzsignformfieldgroupType is **Dropdown**, **Text** or **Textarea** You can use the codes below and they will be replaced at signature time. | Code | Description | Example | | ------------------------- | ------------ | ------------ | | {sUserFirstname} | The first name of the contact | John | | {sUserLastname} | The last name of the contact | Doe | | {sUserJobtitle} | The job title | Sales Representative | | {sEmailAddress} | The email address | email@example.com | | {sPhoneE164} | A phone number in E.164 Format | +15149901516 | | {sPhoneE164Cell} | A phone number in E.164 Format | +15149901516 | | [optional] **e_ezsignformfield_dependencyrequirement** | [**FieldEEzsignformfieldDependencyrequirement**](FieldEEzsignformfieldDependencyrequirement.md) | | [optional] **a_obj_ezsignelementdependency** | [**List[EzsignelementdependencyResponseCompound]**](EzsignelementdependencyResponseCompound.md) | | [optional] diff --git a/docs/EzsignsignatureResponse.md b/docs/EzsignsignatureResponse.md index c49ddcf41..cf5d48b48 100644 --- a/docs/EzsignsignatureResponse.md +++ b/docs/EzsignsignatureResponse.md @@ -17,6 +17,7 @@ Name | Type | Description | Notes **i_ezsignsignature_height** | **int** | 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. | [optional] **i_ezsignsignature_width** | **int** | 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. | [optional] **i_ezsignsignature_step** | **int** | The step when the Ezsignsigner will be invited to sign | +**i_ezsignsignature_stepadjusted** | **int** | The step when the Ezsignsigner will be invited to sign | [optional] **e_ezsignsignature_type** | [**FieldEEzsignsignatureType**](FieldEEzsignsignatureType.md) | | **t_ezsignsignature_tooltip** | **str** | A tooltip that will be presented to Ezsignsigner about the Ezsignsignature | [optional] **e_ezsignsignature_tooltipposition** | [**FieldEEzsignsignatureTooltipposition**](FieldEEzsignsignatureTooltipposition.md) | | [optional] diff --git a/docs/EzsignsignatureResponseCompound.md b/docs/EzsignsignatureResponseCompound.md index 4a0823f61..18d491928 100644 --- a/docs/EzsignsignatureResponseCompound.md +++ b/docs/EzsignsignatureResponseCompound.md @@ -17,6 +17,7 @@ Name | Type | Description | Notes **i_ezsignsignature_height** | **int** | 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. | [optional] **i_ezsignsignature_width** | **int** | 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. | [optional] **i_ezsignsignature_step** | **int** | The step when the Ezsignsigner will be invited to sign | +**i_ezsignsignature_stepadjusted** | **int** | The step when the Ezsignsigner will be invited to sign | [optional] **e_ezsignsignature_type** | [**FieldEEzsignsignatureType**](FieldEEzsignsignatureType.md) | | **t_ezsignsignature_tooltip** | **str** | A tooltip that will be presented to Ezsignsigner about the Ezsignsignature | [optional] **e_ezsignsignature_tooltipposition** | [**FieldEEzsignsignatureTooltipposition**](FieldEEzsignsignatureTooltipposition.md) | | [optional] diff --git a/docs/EzsigntemplateformfieldRequest.md b/docs/EzsigntemplateformfieldRequest.md index 01a526c4f..074c71d22 100644 --- a/docs/EzsigntemplateformfieldRequest.md +++ b/docs/EzsigntemplateformfieldRequest.md @@ -7,16 +7,21 @@ A Ezsigntemplateformfield Object Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplateformfield_id** | **int** | The unique ID of the Ezsigntemplateformfield | [optional] +**e_ezsigntemplateformfield_positioning** | [**FieldEEzsigntemplateformfieldPositioning**](FieldEEzsigntemplateformfieldPositioning.md) | | [optional] **i_ezsigntemplatedocumentpage_pagenumber** | **int** | The page number in the Ezsigntemplatedocument | **s_ezsigntemplateformfield_label** | **str** | The Label for the Ezsigntemplateformfield | **s_ezsigntemplateformfield_value** | **str** | The value for the Ezsigntemplateformfield | [optional] -**i_ezsigntemplateformfield_x** | **int** | 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** | **int** | 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_x** | **int** | 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. | [optional] +**i_ezsigntemplateformfield_y** | **int** | 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. | [optional] **i_ezsigntemplateformfield_width** | **int** | 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** | **int** | 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** | **bool** | Whether the Ezsigntemplateformfield allows the use of the autocomplete of the browser. This can only be set if eEzsigntemplateformfieldgroupType is **Text** | [optional] **b_ezsigntemplateformfield_selected** | **bool** | Whether the Ezsigntemplateformfield is selected or not by default. This can only be set if eEzsigntemplateformfieldgroupType is **Checkbox** or **Radio** | [optional] **e_ezsigntemplateformfield_dependencyrequirement** | [**FieldEEzsigntemplateformfieldDependencyrequirement**](FieldEEzsigntemplateformfieldDependencyrequirement.md) | | [optional] +**s_ezsigntemplateformfield_positioningpattern** | **str** | The string pattern to search for the positioning. **This is not a regexp** This will be required if **eEzsigntemplateformfieldPositioning** is set to **PerCoordinates** | [optional] +**i_ezsigntemplateformfield_positioningoffsetx** | **int** | The offset X This will be required if **eEzsigntemplateformfieldPositioning** is set to **PerCoordinates** | [optional] +**i_ezsigntemplateformfield_positioningoffsety** | **int** | The offset Y This will be required if **eEzsigntemplateformfieldPositioning** is set to **PerCoordinates** | [optional] +**e_ezsigntemplateformfield_positioningoccurence** | [**FieldEEzsigntemplateformfieldPositioningoccurence**](FieldEEzsigntemplateformfieldPositioningoccurence.md) | | [optional] ## Example diff --git a/docs/EzsigntemplateformfieldRequestCompound.md b/docs/EzsigntemplateformfieldRequestCompound.md index 7804f231b..d6137d208 100644 --- a/docs/EzsigntemplateformfieldRequestCompound.md +++ b/docs/EzsigntemplateformfieldRequestCompound.md @@ -7,16 +7,21 @@ An Ezsigntemplateformfield Object and children to create a complete structure Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplateformfield_id** | **int** | The unique ID of the Ezsigntemplateformfield | [optional] +**e_ezsigntemplateformfield_positioning** | [**FieldEEzsigntemplateformfieldPositioning**](FieldEEzsigntemplateformfieldPositioning.md) | | [optional] **i_ezsigntemplatedocumentpage_pagenumber** | **int** | The page number in the Ezsigntemplatedocument | **s_ezsigntemplateformfield_label** | **str** | The Label for the Ezsigntemplateformfield | **s_ezsigntemplateformfield_value** | **str** | The value for the Ezsigntemplateformfield | [optional] -**i_ezsigntemplateformfield_x** | **int** | 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** | **int** | 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_x** | **int** | 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. | [optional] +**i_ezsigntemplateformfield_y** | **int** | 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. | [optional] **i_ezsigntemplateformfield_width** | **int** | 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** | **int** | 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** | **bool** | Whether the Ezsigntemplateformfield allows the use of the autocomplete of the browser. This can only be set if eEzsigntemplateformfieldgroupType is **Text** | [optional] **b_ezsigntemplateformfield_selected** | **bool** | Whether the Ezsigntemplateformfield is selected or not by default. This can only be set if eEzsigntemplateformfieldgroupType is **Checkbox** or **Radio** | [optional] **e_ezsigntemplateformfield_dependencyrequirement** | [**FieldEEzsigntemplateformfieldDependencyrequirement**](FieldEEzsigntemplateformfieldDependencyrequirement.md) | | [optional] +**s_ezsigntemplateformfield_positioningpattern** | **str** | The string pattern to search for the positioning. **This is not a regexp** This will be required if **eEzsigntemplateformfieldPositioning** is set to **PerCoordinates** | [optional] +**i_ezsigntemplateformfield_positioningoffsetx** | **int** | The offset X This will be required if **eEzsigntemplateformfieldPositioning** is set to **PerCoordinates** | [optional] +**i_ezsigntemplateformfield_positioningoffsety** | **int** | The offset Y This will be required if **eEzsigntemplateformfieldPositioning** is set to **PerCoordinates** | [optional] +**e_ezsigntemplateformfield_positioningoccurence** | [**FieldEEzsigntemplateformfieldPositioningoccurence**](FieldEEzsigntemplateformfieldPositioningoccurence.md) | | [optional] **a_obj_ezsigntemplateelementdependency** | [**List[EzsigntemplateelementdependencyRequestCompound]**](EzsigntemplateelementdependencyRequestCompound.md) | | [optional] ## Example diff --git a/docs/EzsigntemplateformfieldResponse.md b/docs/EzsigntemplateformfieldResponse.md index 3852207f4..360a8ae30 100644 --- a/docs/EzsigntemplateformfieldResponse.md +++ b/docs/EzsigntemplateformfieldResponse.md @@ -7,16 +7,21 @@ An Ezsigntemplateformfield Object Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplateformfield_id** | **int** | The unique ID of the Ezsigntemplateformfield | +**e_ezsigntemplateformfield_positioning** | [**FieldEEzsigntemplateformfieldPositioning**](FieldEEzsigntemplateformfieldPositioning.md) | | [optional] **i_ezsigntemplatedocumentpage_pagenumber** | **int** | The page number in the Ezsigntemplatedocument | **s_ezsigntemplateformfield_label** | **str** | The Label for the Ezsigntemplateformfield | **s_ezsigntemplateformfield_value** | **str** | The value for the Ezsigntemplateformfield | [optional] -**i_ezsigntemplateformfield_x** | **int** | 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** | **int** | 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_x** | **int** | 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. | [optional] +**i_ezsigntemplateformfield_y** | **int** | 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. | [optional] **i_ezsigntemplateformfield_width** | **int** | 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** | **int** | 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** | **bool** | Whether the Ezsigntemplateformfield allows the use of the autocomplete of the browser. This can only be set if eEzsigntemplateformfieldgroupType is **Text** | [optional] **b_ezsigntemplateformfield_selected** | **bool** | Whether the Ezsigntemplateformfield is selected or not by default. This can only be set if eEzsigntemplateformfieldgroupType is **Checkbox** or **Radio** | [optional] **e_ezsigntemplateformfield_dependencyrequirement** | [**FieldEEzsigntemplateformfieldDependencyrequirement**](FieldEEzsigntemplateformfieldDependencyrequirement.md) | | [optional] +**s_ezsigntemplateformfield_positioningpattern** | **str** | The string pattern to search for the positioning. **This is not a regexp** This will be required if **eEzsigntemplateformfieldPositioning** is set to **PerCoordinates** | [optional] +**i_ezsigntemplateformfield_positioningoffsetx** | **int** | The offset X This will be required if **eEzsigntemplateformfieldPositioning** is set to **PerCoordinates** | [optional] +**i_ezsigntemplateformfield_positioningoffsety** | **int** | The offset Y This will be required if **eEzsigntemplateformfieldPositioning** is set to **PerCoordinates** | [optional] +**e_ezsigntemplateformfield_positioningoccurence** | [**FieldEEzsigntemplateformfieldPositioningoccurence**](FieldEEzsigntemplateformfieldPositioningoccurence.md) | | [optional] ## Example diff --git a/docs/EzsigntemplateformfieldResponseCompound.md b/docs/EzsigntemplateformfieldResponseCompound.md index 329b36ac5..a7fc84bd6 100644 --- a/docs/EzsigntemplateformfieldResponseCompound.md +++ b/docs/EzsigntemplateformfieldResponseCompound.md @@ -7,16 +7,21 @@ An Ezsigntemplateformfield Object and children Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplateformfield_id** | **int** | The unique ID of the Ezsigntemplateformfield | +**e_ezsigntemplateformfield_positioning** | [**FieldEEzsigntemplateformfieldPositioning**](FieldEEzsigntemplateformfieldPositioning.md) | | [optional] **i_ezsigntemplatedocumentpage_pagenumber** | **int** | The page number in the Ezsigntemplatedocument | **s_ezsigntemplateformfield_label** | **str** | The Label for the Ezsigntemplateformfield | **s_ezsigntemplateformfield_value** | **str** | The value for the Ezsigntemplateformfield | [optional] -**i_ezsigntemplateformfield_x** | **int** | 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** | **int** | 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_x** | **int** | 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. | [optional] +**i_ezsigntemplateformfield_y** | **int** | 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. | [optional] **i_ezsigntemplateformfield_width** | **int** | 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** | **int** | 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** | **bool** | Whether the Ezsigntemplateformfield allows the use of the autocomplete of the browser. This can only be set if eEzsigntemplateformfieldgroupType is **Text** | [optional] **b_ezsigntemplateformfield_selected** | **bool** | Whether the Ezsigntemplateformfield is selected or not by default. This can only be set if eEzsigntemplateformfieldgroupType is **Checkbox** or **Radio** | [optional] **e_ezsigntemplateformfield_dependencyrequirement** | [**FieldEEzsigntemplateformfieldDependencyrequirement**](FieldEEzsigntemplateformfieldDependencyrequirement.md) | | [optional] +**s_ezsigntemplateformfield_positioningpattern** | **str** | The string pattern to search for the positioning. **This is not a regexp** This will be required if **eEzsigntemplateformfieldPositioning** is set to **PerCoordinates** | [optional] +**i_ezsigntemplateformfield_positioningoffsetx** | **int** | The offset X This will be required if **eEzsigntemplateformfieldPositioning** is set to **PerCoordinates** | [optional] +**i_ezsigntemplateformfield_positioningoffsety** | **int** | The offset Y This will be required if **eEzsigntemplateformfieldPositioning** is set to **PerCoordinates** | [optional] +**e_ezsigntemplateformfield_positioningoccurence** | [**FieldEEzsigntemplateformfieldPositioningoccurence**](FieldEEzsigntemplateformfieldPositioningoccurence.md) | | [optional] **a_obj_ezsigntemplateelementdependency** | [**List[EzsigntemplateelementdependencyResponseCompound]**](EzsigntemplateelementdependencyResponseCompound.md) | | [optional] ## Example diff --git a/docs/EzsigntemplatesignatureRequest.md b/docs/EzsigntemplatesignatureRequest.md index fbd8214aa..02f1b387c 100644 --- a/docs/EzsigntemplatesignatureRequest.md +++ b/docs/EzsigntemplatesignatureRequest.md @@ -10,9 +10,10 @@ Name | Type | Description | Notes **fki_ezsigntemplatedocument_id** | **int** | The unique ID of the Ezsigntemplatedocument | **fki_ezsigntemplatesigner_id** | **int** | The unique ID of the Ezsigntemplatesigner | **fki_ezsigntemplatesigner_id_validation** | **int** | The unique ID of the Ezsigntemplatesigner | [optional] +**e_ezsigntemplatesignature_positioning** | [**FieldEEzsigntemplatesignaturePositioning**](FieldEEzsigntemplatesignaturePositioning.md) | | [optional] **i_ezsigntemplatedocumentpage_pagenumber** | **int** | The page number in the Ezsigntemplatedocument | -**i_ezsigntemplatesignature_x** | **int** | 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** | **int** | 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_x** | **int** | 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. | [optional] +**i_ezsigntemplatesignature_y** | **int** | 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. | [optional] **i_ezsigntemplatesignature_width** | **int** | 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. | [optional] **i_ezsigntemplatesignature_height** | **int** | 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. | [optional] **i_ezsigntemplatesignature_step** | **int** | The step when the Ezsigntemplatesigner will be invited to sign | @@ -28,6 +29,10 @@ Name | Type | Description | Notes **s_ezsigntemplatesignature_regexp** | **str** | A regular expression to indicate what values are acceptable for the Ezsigntemplatesignature. This can only be set if eEzsigntemplatesignatureType is **Text** or **Textarea** | [optional] **e_ezsigntemplatesignature_textvalidation** | [**EnumTextvalidation**](EnumTextvalidation.md) | | [optional] **e_ezsigntemplatesignature_dependencyrequirement** | [**FieldEEzsigntemplatesignatureDependencyrequirement**](FieldEEzsigntemplatesignatureDependencyrequirement.md) | | [optional] +**s_ezsigntemplatesignature_positioningpattern** | **str** | The string pattern to search for the positioning. **This is not a regexp** This will be required if **eEzsigntemplatesignaturePositioning** is set to **PerCoordinates** | [optional] +**i_ezsigntemplatesignature_positioningoffsetx** | **int** | The offset X This will be required if **eEzsigntemplatesignaturePositioning** is set to **PerCoordinates** | [optional] +**i_ezsigntemplatesignature_positioningoffsety** | **int** | The offset Y This will be required if **eEzsigntemplatesignaturePositioning** is set to **PerCoordinates** | [optional] +**e_ezsigntemplatesignature_positioningoccurence** | [**FieldEEzsigntemplatesignaturePositioningoccurence**](FieldEEzsigntemplatesignaturePositioningoccurence.md) | | [optional] ## Example diff --git a/docs/EzsigntemplatesignatureRequestCompound.md b/docs/EzsigntemplatesignatureRequestCompound.md index c7d22d6a5..d86189b3b 100644 --- a/docs/EzsigntemplatesignatureRequestCompound.md +++ b/docs/EzsigntemplatesignatureRequestCompound.md @@ -10,9 +10,10 @@ Name | Type | Description | Notes **fki_ezsigntemplatedocument_id** | **int** | The unique ID of the Ezsigntemplatedocument | **fki_ezsigntemplatesigner_id** | **int** | The unique ID of the Ezsigntemplatesigner | **fki_ezsigntemplatesigner_id_validation** | **int** | The unique ID of the Ezsigntemplatesigner | [optional] +**e_ezsigntemplatesignature_positioning** | [**FieldEEzsigntemplatesignaturePositioning**](FieldEEzsigntemplatesignaturePositioning.md) | | [optional] **i_ezsigntemplatedocumentpage_pagenumber** | **int** | The page number in the Ezsigntemplatedocument | -**i_ezsigntemplatesignature_x** | **int** | 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** | **int** | 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_x** | **int** | 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. | [optional] +**i_ezsigntemplatesignature_y** | **int** | 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. | [optional] **i_ezsigntemplatesignature_width** | **int** | 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. | [optional] **i_ezsigntemplatesignature_height** | **int** | 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. | [optional] **i_ezsigntemplatesignature_step** | **int** | The step when the Ezsigntemplatesigner will be invited to sign | @@ -28,6 +29,10 @@ Name | Type | Description | Notes **s_ezsigntemplatesignature_regexp** | **str** | A regular expression to indicate what values are acceptable for the Ezsigntemplatesignature. This can only be set if eEzsigntemplatesignatureType is **Text** or **Textarea** | [optional] **e_ezsigntemplatesignature_textvalidation** | [**EnumTextvalidation**](EnumTextvalidation.md) | | [optional] **e_ezsigntemplatesignature_dependencyrequirement** | [**FieldEEzsigntemplatesignatureDependencyrequirement**](FieldEEzsigntemplatesignatureDependencyrequirement.md) | | [optional] +**s_ezsigntemplatesignature_positioningpattern** | **str** | The string pattern to search for the positioning. **This is not a regexp** This will be required if **eEzsigntemplatesignaturePositioning** is set to **PerCoordinates** | [optional] +**i_ezsigntemplatesignature_positioningoffsetx** | **int** | The offset X This will be required if **eEzsigntemplatesignaturePositioning** is set to **PerCoordinates** | [optional] +**i_ezsigntemplatesignature_positioningoffsety** | **int** | The offset Y This will be required if **eEzsigntemplatesignaturePositioning** is set to **PerCoordinates** | [optional] +**e_ezsigntemplatesignature_positioningoccurence** | [**FieldEEzsigntemplatesignaturePositioningoccurence**](FieldEEzsigntemplatesignaturePositioningoccurence.md) | | [optional] **b_ezsigntemplatesignature_customdate** | **bool** | Whether the Ezsigntemplatesignature has a custom date format or not. (Only possible when eEzsigntemplatesignatureType is **Name** or **Handwritten**) | [optional] **a_obj_ezsigntemplatesignaturecustomdate** | [**List[EzsigntemplatesignaturecustomdateRequestCompound]**](EzsigntemplatesignaturecustomdateRequestCompound.md) | 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. | [optional] **a_obj_ezsigntemplateelementdependency** | [**List[EzsigntemplateelementdependencyRequestCompound]**](EzsigntemplateelementdependencyRequestCompound.md) | | [optional] diff --git a/docs/EzsigntemplatesignatureResponse.md b/docs/EzsigntemplatesignatureResponse.md index 283a8efe5..6d1eaf136 100644 --- a/docs/EzsigntemplatesignatureResponse.md +++ b/docs/EzsigntemplatesignatureResponse.md @@ -10,9 +10,10 @@ Name | Type | Description | Notes **fki_ezsigntemplatedocument_id** | **int** | The unique ID of the Ezsigntemplatedocument | **fki_ezsigntemplatesigner_id** | **int** | The unique ID of the Ezsigntemplatesigner | **fki_ezsigntemplatesigner_id_validation** | **int** | The unique ID of the Ezsigntemplatesigner | [optional] +**e_ezsigntemplatesignature_positioning** | [**FieldEEzsigntemplatesignaturePositioning**](FieldEEzsigntemplatesignaturePositioning.md) | | [optional] **i_ezsigntemplatedocumentpage_pagenumber** | **int** | The page number in the Ezsigntemplatedocument | -**i_ezsigntemplatesignature_x** | **int** | 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** | **int** | 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_x** | **int** | 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. | [optional] +**i_ezsigntemplatesignature_y** | **int** | 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. | [optional] **i_ezsigntemplatesignature_width** | **int** | 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. | [optional] **i_ezsigntemplatesignature_height** | **int** | 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. | [optional] **i_ezsigntemplatesignature_step** | **int** | The step when the Ezsigntemplatesigner will be invited to sign | @@ -28,6 +29,10 @@ Name | Type | Description | Notes **s_ezsigntemplatesignature_regexp** | **str** | A regular expression to indicate what values are acceptable for the Ezsigntemplatesignature. This can only be set if eEzsigntemplatesignatureType is **Text** or **Textarea** | [optional] **e_ezsigntemplatesignature_textvalidation** | [**EnumTextvalidation**](EnumTextvalidation.md) | | [optional] **e_ezsigntemplatesignature_dependencyrequirement** | [**FieldEEzsigntemplatesignatureDependencyrequirement**](FieldEEzsigntemplatesignatureDependencyrequirement.md) | | [optional] +**s_ezsigntemplatesignature_positioningpattern** | **str** | The string pattern to search for the positioning. **This is not a regexp** This will be required if **eEzsigntemplatesignaturePositioning** is set to **PerCoordinates** | [optional] +**i_ezsigntemplatesignature_positioningoffsetx** | **int** | The offset X This will be required if **eEzsigntemplatesignaturePositioning** is set to **PerCoordinates** | [optional] +**i_ezsigntemplatesignature_positioningoffsety** | **int** | The offset Y This will be required if **eEzsigntemplatesignaturePositioning** is set to **PerCoordinates** | [optional] +**e_ezsigntemplatesignature_positioningoccurence** | [**FieldEEzsigntemplatesignaturePositioningoccurence**](FieldEEzsigntemplatesignaturePositioningoccurence.md) | | [optional] ## Example diff --git a/docs/EzsigntemplatesignatureResponseCompound.md b/docs/EzsigntemplatesignatureResponseCompound.md index 34bf4b012..3e42d7d83 100644 --- a/docs/EzsigntemplatesignatureResponseCompound.md +++ b/docs/EzsigntemplatesignatureResponseCompound.md @@ -10,9 +10,10 @@ Name | Type | Description | Notes **fki_ezsigntemplatedocument_id** | **int** | The unique ID of the Ezsigntemplatedocument | **fki_ezsigntemplatesigner_id** | **int** | The unique ID of the Ezsigntemplatesigner | **fki_ezsigntemplatesigner_id_validation** | **int** | The unique ID of the Ezsigntemplatesigner | [optional] +**e_ezsigntemplatesignature_positioning** | [**FieldEEzsigntemplatesignaturePositioning**](FieldEEzsigntemplatesignaturePositioning.md) | | [optional] **i_ezsigntemplatedocumentpage_pagenumber** | **int** | The page number in the Ezsigntemplatedocument | -**i_ezsigntemplatesignature_x** | **int** | 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** | **int** | 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_x** | **int** | 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. | [optional] +**i_ezsigntemplatesignature_y** | **int** | 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. | [optional] **i_ezsigntemplatesignature_width** | **int** | 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. | [optional] **i_ezsigntemplatesignature_height** | **int** | 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. | [optional] **i_ezsigntemplatesignature_step** | **int** | The step when the Ezsigntemplatesigner will be invited to sign | @@ -28,6 +29,10 @@ Name | Type | Description | Notes **s_ezsigntemplatesignature_regexp** | **str** | A regular expression to indicate what values are acceptable for the Ezsigntemplatesignature. This can only be set if eEzsigntemplatesignatureType is **Text** or **Textarea** | [optional] **e_ezsigntemplatesignature_textvalidation** | [**EnumTextvalidation**](EnumTextvalidation.md) | | [optional] **e_ezsigntemplatesignature_dependencyrequirement** | [**FieldEEzsigntemplatesignatureDependencyrequirement**](FieldEEzsigntemplatesignatureDependencyrequirement.md) | | [optional] +**s_ezsigntemplatesignature_positioningpattern** | **str** | The string pattern to search for the positioning. **This is not a regexp** This will be required if **eEzsigntemplatesignaturePositioning** is set to **PerCoordinates** | [optional] +**i_ezsigntemplatesignature_positioningoffsetx** | **int** | The offset X This will be required if **eEzsigntemplatesignaturePositioning** is set to **PerCoordinates** | [optional] +**i_ezsigntemplatesignature_positioningoffsety** | **int** | The offset Y This will be required if **eEzsigntemplatesignaturePositioning** is set to **PerCoordinates** | [optional] +**e_ezsigntemplatesignature_positioningoccurence** | [**FieldEEzsigntemplatesignaturePositioningoccurence**](FieldEEzsigntemplatesignaturePositioningoccurence.md) | | [optional] **b_ezsigntemplatesignature_customdate** | **bool** | Whether the Ezsigntemplatesignature has a custom date format or not. (Only possible when eEzsigntemplatesignatureType is **Name** or **Handwritten**) | [optional] **a_obj_ezsigntemplatesignaturecustomdate** | [**List[EzsigntemplatesignaturecustomdateResponseCompound]**](EzsigntemplatesignaturecustomdateResponseCompound.md) | 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. | [optional] **a_obj_ezsigntemplateelementdependency** | [**List[EzsigntemplateelementdependencyResponseCompound]**](EzsigntemplateelementdependencyResponseCompound.md) | | [optional] diff --git a/docs/EzsigntemplatesignaturecustomdateRequest.md b/docs/EzsigntemplatesignaturecustomdateRequest.md index 6b9810f30..085e010d4 100644 --- a/docs/EzsigntemplatesignaturecustomdateRequest.md +++ b/docs/EzsigntemplatesignaturecustomdateRequest.md @@ -7,8 +7,10 @@ An Ezsigntemplatesignaturecustomdate Object Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatesignaturecustomdate_id** | **int** | The unique ID of the Ezsigntemplatesignaturecustomdate | [optional] -**i_ezsigntemplatesignaturecustomdate_x** | **int** | 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** | **int** | 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. | +**i_ezsigntemplatesignaturecustomdate_x** | **int** | 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. | [optional] +**i_ezsigntemplatesignaturecustomdate_y** | **int** | 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. | [optional] +**i_ezsigntemplatesignaturecustomdate_offsetx** | **int** | 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 of the signature, you would use \"200\" for the X coordinate. | [optional] +**i_ezsigntemplatesignaturecustomdate_offsety** | **int** | 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 top of the signature, you would use \"200\" for the Y coordinate. | [optional] **s_ezsigntemplatesignaturecustomdate_format** | **str** | 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 | | ## Example diff --git a/docs/EzsigntemplatesignaturecustomdateRequestCompound.md b/docs/EzsigntemplatesignaturecustomdateRequestCompound.md index cb3bd9cde..3a7f54892 100644 --- a/docs/EzsigntemplatesignaturecustomdateRequestCompound.md +++ b/docs/EzsigntemplatesignaturecustomdateRequestCompound.md @@ -7,8 +7,10 @@ An Ezsigntemplatesignaturecustomdate Object and children to create a complete st Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatesignaturecustomdate_id** | **int** | The unique ID of the Ezsigntemplatesignaturecustomdate | [optional] -**i_ezsigntemplatesignaturecustomdate_x** | **int** | 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** | **int** | 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. | +**i_ezsigntemplatesignaturecustomdate_x** | **int** | 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. | [optional] +**i_ezsigntemplatesignaturecustomdate_y** | **int** | 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. | [optional] +**i_ezsigntemplatesignaturecustomdate_offsetx** | **int** | 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 of the signature, you would use \"200\" for the X coordinate. | [optional] +**i_ezsigntemplatesignaturecustomdate_offsety** | **int** | 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 top of the signature, you would use \"200\" for the Y coordinate. | [optional] **s_ezsigntemplatesignaturecustomdate_format** | **str** | 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 | | ## Example diff --git a/docs/EzsigntemplatesignaturecustomdateResponse.md b/docs/EzsigntemplatesignaturecustomdateResponse.md index 6ec1c4b87..c38e5bf7e 100644 --- a/docs/EzsigntemplatesignaturecustomdateResponse.md +++ b/docs/EzsigntemplatesignaturecustomdateResponse.md @@ -7,8 +7,10 @@ An Ezsigntemplatesignaturecustomdate Object Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatesignaturecustomdate_id** | **int** | The unique ID of the Ezsigntemplatesignaturecustomdate | -**i_ezsigntemplatesignaturecustomdate_x** | **int** | 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** | **int** | 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. | +**i_ezsigntemplatesignaturecustomdate_x** | **int** | 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. | [optional] +**i_ezsigntemplatesignaturecustomdate_y** | **int** | 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. | [optional] +**i_ezsigntemplatesignaturecustomdate_offsetx** | **int** | 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 of the signature, you would use \"200\" for the X coordinate. | [optional] +**i_ezsigntemplatesignaturecustomdate_offsety** | **int** | 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 top of the signature, you would use \"200\" for the Y coordinate. | [optional] **s_ezsigntemplatesignaturecustomdate_format** | **str** | 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 | | ## Example diff --git a/docs/EzsigntemplatesignaturecustomdateResponseCompound.md b/docs/EzsigntemplatesignaturecustomdateResponseCompound.md index fa624be6c..230c871cd 100644 --- a/docs/EzsigntemplatesignaturecustomdateResponseCompound.md +++ b/docs/EzsigntemplatesignaturecustomdateResponseCompound.md @@ -7,8 +7,10 @@ An Ezsigntemplatesignaturecustomdate Object and children to create a complete st Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **pki_ezsigntemplatesignaturecustomdate_id** | **int** | The unique ID of the Ezsigntemplatesignaturecustomdate | -**i_ezsigntemplatesignaturecustomdate_x** | **int** | 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** | **int** | 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. | +**i_ezsigntemplatesignaturecustomdate_x** | **int** | 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. | [optional] +**i_ezsigntemplatesignaturecustomdate_y** | **int** | 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. | [optional] +**i_ezsigntemplatesignaturecustomdate_offsetx** | **int** | 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 of the signature, you would use \"200\" for the X coordinate. | [optional] +**i_ezsigntemplatesignaturecustomdate_offsety** | **int** | 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 top of the signature, you would use \"200\" for the Y coordinate. | [optional] **s_ezsigntemplatesignaturecustomdate_format** | **str** | 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 | | ## Example diff --git a/docs/FieldEDiscussionmessageStatus.md b/docs/FieldEDiscussionmessageStatus.md new file mode 100644 index 000000000..bf3f48155 --- /dev/null +++ b/docs/FieldEDiscussionmessageStatus.md @@ -0,0 +1,12 @@ +# FieldEDiscussionmessageStatus + +The status of the Discussionmessage + +## 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/FieldEEzsignfolderCompletion.md b/docs/FieldEEzsignfolderCompletion.md new file mode 100644 index 000000000..21e9ae398 --- /dev/null +++ b/docs/FieldEEzsignfolderCompletion.md @@ -0,0 +1,12 @@ +# FieldEEzsignfolderCompletion + +Indicates if the Ezsigndocument is completed when all signatures of this Ezsigndocument were applied or when all signatures of all Ezsigndocument were applied + +## 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/FieldEEzsignfoldertypeCompletion.md b/docs/FieldEEzsignfoldertypeCompletion.md new file mode 100644 index 000000000..675a04f31 --- /dev/null +++ b/docs/FieldEEzsignfoldertypeCompletion.md @@ -0,0 +1,12 @@ +# FieldEEzsignfoldertypeCompletion + +Indicates if the Ezsigndocument is completed when all signatures of this Ezsigndocument were applied or when all signatures of all Ezsigndocument were applied + +## 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/FieldEEzsigntemplateformfieldPositioning.md b/docs/FieldEEzsigntemplateformfieldPositioning.md new file mode 100644 index 000000000..745751016 --- /dev/null +++ b/docs/FieldEEzsigntemplateformfieldPositioning.md @@ -0,0 +1,12 @@ +# FieldEEzsigntemplateformfieldPositioning + +How the positioning of the Ezsigntemplateformfield will be done + +## 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/FieldEEzsigntemplateformfieldPositioningoccurence.md b/docs/FieldEEzsigntemplateformfieldPositioningoccurence.md new file mode 100644 index 000000000..e47f48260 --- /dev/null +++ b/docs/FieldEEzsigntemplateformfieldPositioningoccurence.md @@ -0,0 +1,12 @@ +# FieldEEzsigntemplateformfieldPositioningoccurence + +The occurence of the pattern to add the Ezsigntemplateformfield This will be required if **eEzsigntemplateformfieldPositioning** is set to **PerCoordinates** + +## 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/FieldEEzsigntemplatesignaturePositioning.md b/docs/FieldEEzsigntemplatesignaturePositioning.md new file mode 100644 index 000000000..b3fd8556b --- /dev/null +++ b/docs/FieldEEzsigntemplatesignaturePositioning.md @@ -0,0 +1,12 @@ +# FieldEEzsigntemplatesignaturePositioning + +How the positioning of the Ezsigntemplatesignature will be done + +## 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/FieldEEzsigntemplatesignaturePositioningoccurence.md b/docs/FieldEEzsigntemplatesignaturePositioningoccurence.md new file mode 100644 index 000000000..3616fc5af --- /dev/null +++ b/docs/FieldEEzsigntemplatesignaturePositioningoccurence.md @@ -0,0 +1,12 @@ +# FieldEEzsigntemplatesignaturePositioningoccurence + +The occurence of the pattern to add the Ezsigntemplatesignature This will be required if **eEzsigntemplatesignaturePositioning** is set to **PerCoordinates** + +## 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/ObjectDiscussionApi.md b/docs/ObjectDiscussionApi.md new file mode 100644 index 000000000..2feb7e270 --- /dev/null +++ b/docs/ObjectDiscussionApi.md @@ -0,0 +1,429 @@ +# eZmaxApi.ObjectDiscussionApi + +All URIs are relative to *https://prod.api.appcluster01.ca-central-1.ezmax.com/rest* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**discussion_create_object_v1**](ObjectDiscussionApi.md#discussion_create_object_v1) | **POST** /1/object/discussion | Create a new Discussion +[**discussion_delete_object_v1**](ObjectDiscussionApi.md#discussion_delete_object_v1) | **DELETE** /1/object/discussion/{pkiDiscussionID} | Delete an existing Discussion +[**discussion_get_object_v2**](ObjectDiscussionApi.md#discussion_get_object_v2) | **GET** /2/object/discussion/{pkiDiscussionID} | Retrieve an existing Discussion +[**discussion_patch_object_v1**](ObjectDiscussionApi.md#discussion_patch_object_v1) | **PATCH** /1/object/discussion/{pkiDiscussionID} | Patch an existing Discussion +[**discussion_update_discussionreadstatus_v1**](ObjectDiscussionApi.md#discussion_update_discussionreadstatus_v1) | **POST** /1/object/discussion/{pkiDiscussionID}/updateDiscussionreadstatus | Update the read status of the discussion + + +# **discussion_create_object_v1** +> DiscussionCreateObjectV1Response discussion_create_object_v1(discussion_create_object_v1_request) + +Create a new Discussion + +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.discussion_create_object_v1_request import DiscussionCreateObjectV1Request +from eZmaxApi.models.discussion_create_object_v1_response import DiscussionCreateObjectV1Response +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.ObjectDiscussionApi(api_client) + discussion_create_object_v1_request = eZmaxApi.DiscussionCreateObjectV1Request() # DiscussionCreateObjectV1Request | + + try: + # Create a new Discussion + api_response = api_instance.discussion_create_object_v1(discussion_create_object_v1_request) + print("The response of ObjectDiscussionApi->discussion_create_object_v1:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectDiscussionApi->discussion_create_object_v1: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **discussion_create_object_v1_request** | [**DiscussionCreateObjectV1Request**](DiscussionCreateObjectV1Request.md)| | + +### Return type + +[**DiscussionCreateObjectV1Response**](DiscussionCreateObjectV1Response.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) + +# **discussion_delete_object_v1** +> DiscussionDeleteObjectV1Response discussion_delete_object_v1(pki_discussion_id) + +Delete an existing Discussion + + + +### Example + +* Api Key Authentication (Authorization): + +```python +import time +import os +import eZmaxApi +from eZmaxApi.models.discussion_delete_object_v1_response import DiscussionDeleteObjectV1Response +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.ObjectDiscussionApi(api_client) + pki_discussion_id = 56 # int | The unique ID of the Discussion + + try: + # Delete an existing Discussion + api_response = api_instance.discussion_delete_object_v1(pki_discussion_id) + print("The response of ObjectDiscussionApi->discussion_delete_object_v1:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectDiscussionApi->discussion_delete_object_v1: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pki_discussion_id** | **int**| The unique ID of the Discussion | + +### Return type + +[**DiscussionDeleteObjectV1Response**](DiscussionDeleteObjectV1Response.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) + +# **discussion_get_object_v2** +> DiscussionGetObjectV2Response discussion_get_object_v2(pki_discussion_id) + +Retrieve an existing Discussion + + + +### Example + +* Api Key Authentication (Authorization): + +```python +import time +import os +import eZmaxApi +from eZmaxApi.models.discussion_get_object_v2_response import DiscussionGetObjectV2Response +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.ObjectDiscussionApi(api_client) + pki_discussion_id = 56 # int | The unique ID of the Discussion + + try: + # Retrieve an existing Discussion + api_response = api_instance.discussion_get_object_v2(pki_discussion_id) + print("The response of ObjectDiscussionApi->discussion_get_object_v2:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectDiscussionApi->discussion_get_object_v2: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pki_discussion_id** | **int**| The unique ID of the Discussion | + +### Return type + +[**DiscussionGetObjectV2Response**](DiscussionGetObjectV2Response.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) + +# **discussion_patch_object_v1** +> DiscussionPatchObjectV1Response discussion_patch_object_v1(pki_discussion_id, discussion_patch_object_v1_request) + +Patch an existing Discussion + + + +### Example + +* Api Key Authentication (Authorization): + +```python +import time +import os +import eZmaxApi +from eZmaxApi.models.discussion_patch_object_v1_request import DiscussionPatchObjectV1Request +from eZmaxApi.models.discussion_patch_object_v1_response import DiscussionPatchObjectV1Response +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.ObjectDiscussionApi(api_client) + pki_discussion_id = 56 # int | The unique ID of the Discussion + discussion_patch_object_v1_request = eZmaxApi.DiscussionPatchObjectV1Request() # DiscussionPatchObjectV1Request | + + try: + # Patch an existing Discussion + api_response = api_instance.discussion_patch_object_v1(pki_discussion_id, discussion_patch_object_v1_request) + print("The response of ObjectDiscussionApi->discussion_patch_object_v1:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectDiscussionApi->discussion_patch_object_v1: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pki_discussion_id** | **int**| The unique ID of the Discussion | + **discussion_patch_object_v1_request** | [**DiscussionPatchObjectV1Request**](DiscussionPatchObjectV1Request.md)| | + +### Return type + +[**DiscussionPatchObjectV1Response**](DiscussionPatchObjectV1Response.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) + +# **discussion_update_discussionreadstatus_v1** +> DiscussionUpdateDiscussionreadstatusV1Response discussion_update_discussionreadstatus_v1(pki_discussion_id, discussion_update_discussionreadstatus_v1_request) + +Update the read status of the discussion + +### Example + +* Api Key Authentication (Authorization): + +```python +import time +import os +import eZmaxApi +from eZmaxApi.models.discussion_update_discussionreadstatus_v1_request import DiscussionUpdateDiscussionreadstatusV1Request +from eZmaxApi.models.discussion_update_discussionreadstatus_v1_response import DiscussionUpdateDiscussionreadstatusV1Response +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.ObjectDiscussionApi(api_client) + pki_discussion_id = 56 # int | + discussion_update_discussionreadstatus_v1_request = eZmaxApi.DiscussionUpdateDiscussionreadstatusV1Request() # DiscussionUpdateDiscussionreadstatusV1Request | + + try: + # Update the read status of the discussion + api_response = api_instance.discussion_update_discussionreadstatus_v1(pki_discussion_id, discussion_update_discussionreadstatus_v1_request) + print("The response of ObjectDiscussionApi->discussion_update_discussionreadstatus_v1:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectDiscussionApi->discussion_update_discussionreadstatus_v1: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pki_discussion_id** | **int**| | + **discussion_update_discussionreadstatus_v1_request** | [**DiscussionUpdateDiscussionreadstatusV1Request**](DiscussionUpdateDiscussionreadstatusV1Request.md)| | + +### Return type + +[**DiscussionUpdateDiscussionreadstatusV1Response**](DiscussionUpdateDiscussionreadstatusV1Response.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) + diff --git a/docs/ObjectDiscussionmembershipApi.md b/docs/ObjectDiscussionmembershipApi.md new file mode 100644 index 000000000..77c633cc1 --- /dev/null +++ b/docs/ObjectDiscussionmembershipApi.md @@ -0,0 +1,174 @@ +# eZmaxApi.ObjectDiscussionmembershipApi + +All URIs are relative to *https://prod.api.appcluster01.ca-central-1.ezmax.com/rest* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**discussionmembership_create_object_v1**](ObjectDiscussionmembershipApi.md#discussionmembership_create_object_v1) | **POST** /1/object/discussionmembership | Create a new Discussionmembership +[**discussionmembership_delete_object_v1**](ObjectDiscussionmembershipApi.md#discussionmembership_delete_object_v1) | **DELETE** /1/object/discussionmembership/{pkiDiscussionmembershipID} | Delete an existing Discussionmembership + + +# **discussionmembership_create_object_v1** +> DiscussionmembershipCreateObjectV1Response discussionmembership_create_object_v1(discussionmembership_create_object_v1_request) + +Create a new Discussionmembership + +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.discussionmembership_create_object_v1_request import DiscussionmembershipCreateObjectV1Request +from eZmaxApi.models.discussionmembership_create_object_v1_response import DiscussionmembershipCreateObjectV1Response +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.ObjectDiscussionmembershipApi(api_client) + discussionmembership_create_object_v1_request = eZmaxApi.DiscussionmembershipCreateObjectV1Request() # DiscussionmembershipCreateObjectV1Request | + + try: + # Create a new Discussionmembership + api_response = api_instance.discussionmembership_create_object_v1(discussionmembership_create_object_v1_request) + print("The response of ObjectDiscussionmembershipApi->discussionmembership_create_object_v1:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectDiscussionmembershipApi->discussionmembership_create_object_v1: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **discussionmembership_create_object_v1_request** | [**DiscussionmembershipCreateObjectV1Request**](DiscussionmembershipCreateObjectV1Request.md)| | + +### Return type + +[**DiscussionmembershipCreateObjectV1Response**](DiscussionmembershipCreateObjectV1Response.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) + +# **discussionmembership_delete_object_v1** +> DiscussionmembershipDeleteObjectV1Response discussionmembership_delete_object_v1(pki_discussionmembership_id) + +Delete an existing Discussionmembership + + + +### Example + +* Api Key Authentication (Authorization): + +```python +import time +import os +import eZmaxApi +from eZmaxApi.models.discussionmembership_delete_object_v1_response import DiscussionmembershipDeleteObjectV1Response +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.ObjectDiscussionmembershipApi(api_client) + pki_discussionmembership_id = 56 # int | The unique ID of the Discussionmembership + + try: + # Delete an existing Discussionmembership + api_response = api_instance.discussionmembership_delete_object_v1(pki_discussionmembership_id) + print("The response of ObjectDiscussionmembershipApi->discussionmembership_delete_object_v1:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectDiscussionmembershipApi->discussionmembership_delete_object_v1: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pki_discussionmembership_id** | **int**| The unique ID of the Discussionmembership | + +### Return type + +[**DiscussionmembershipDeleteObjectV1Response**](DiscussionmembershipDeleteObjectV1Response.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/ObjectDiscussionmessageApi.md b/docs/ObjectDiscussionmessageApi.md new file mode 100644 index 000000000..91e7ed9d7 --- /dev/null +++ b/docs/ObjectDiscussionmessageApi.md @@ -0,0 +1,262 @@ +# eZmaxApi.ObjectDiscussionmessageApi + +All URIs are relative to *https://prod.api.appcluster01.ca-central-1.ezmax.com/rest* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**discussionmessage_create_object_v1**](ObjectDiscussionmessageApi.md#discussionmessage_create_object_v1) | **POST** /1/object/discussionmessage | Create a new Discussionmessage +[**discussionmessage_delete_object_v1**](ObjectDiscussionmessageApi.md#discussionmessage_delete_object_v1) | **DELETE** /1/object/discussionmessage/{pkiDiscussionmessageID} | Delete an existing Discussionmessage +[**discussionmessage_patch_object_v1**](ObjectDiscussionmessageApi.md#discussionmessage_patch_object_v1) | **PATCH** /1/object/discussionmessage/{pkiDiscussionmessageID} | Patch an existing Discussionmessage + + +# **discussionmessage_create_object_v1** +> DiscussionmessageCreateObjectV1Response discussionmessage_create_object_v1(discussionmessage_create_object_v1_request) + +Create a new Discussionmessage + +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.discussionmessage_create_object_v1_request import DiscussionmessageCreateObjectV1Request +from eZmaxApi.models.discussionmessage_create_object_v1_response import DiscussionmessageCreateObjectV1Response +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.ObjectDiscussionmessageApi(api_client) + discussionmessage_create_object_v1_request = eZmaxApi.DiscussionmessageCreateObjectV1Request() # DiscussionmessageCreateObjectV1Request | + + try: + # Create a new Discussionmessage + api_response = api_instance.discussionmessage_create_object_v1(discussionmessage_create_object_v1_request) + print("The response of ObjectDiscussionmessageApi->discussionmessage_create_object_v1:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectDiscussionmessageApi->discussionmessage_create_object_v1: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **discussionmessage_create_object_v1_request** | [**DiscussionmessageCreateObjectV1Request**](DiscussionmessageCreateObjectV1Request.md)| | + +### Return type + +[**DiscussionmessageCreateObjectV1Response**](DiscussionmessageCreateObjectV1Response.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) + +# **discussionmessage_delete_object_v1** +> DiscussionmessageDeleteObjectV1Response discussionmessage_delete_object_v1(pki_discussionmessage_id) + +Delete an existing Discussionmessage + + + +### Example + +* Api Key Authentication (Authorization): + +```python +import time +import os +import eZmaxApi +from eZmaxApi.models.discussionmessage_delete_object_v1_response import DiscussionmessageDeleteObjectV1Response +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.ObjectDiscussionmessageApi(api_client) + pki_discussionmessage_id = 56 # int | The unique ID of the Discussionmessage + + try: + # Delete an existing Discussionmessage + api_response = api_instance.discussionmessage_delete_object_v1(pki_discussionmessage_id) + print("The response of ObjectDiscussionmessageApi->discussionmessage_delete_object_v1:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectDiscussionmessageApi->discussionmessage_delete_object_v1: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pki_discussionmessage_id** | **int**| The unique ID of the Discussionmessage | + +### Return type + +[**DiscussionmessageDeleteObjectV1Response**](DiscussionmessageDeleteObjectV1Response.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 | - | +**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) + +# **discussionmessage_patch_object_v1** +> DiscussionmessagePatchObjectV1Response discussionmessage_patch_object_v1(pki_discussionmessage_id, discussionmessage_patch_object_v1_request) + +Patch an existing Discussionmessage + + + +### Example + +* Api Key Authentication (Authorization): + +```python +import time +import os +import eZmaxApi +from eZmaxApi.models.discussionmessage_patch_object_v1_request import DiscussionmessagePatchObjectV1Request +from eZmaxApi.models.discussionmessage_patch_object_v1_response import DiscussionmessagePatchObjectV1Response +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.ObjectDiscussionmessageApi(api_client) + pki_discussionmessage_id = 56 # int | The unique ID of the Discussionmessage + discussionmessage_patch_object_v1_request = eZmaxApi.DiscussionmessagePatchObjectV1Request() # DiscussionmessagePatchObjectV1Request | + + try: + # Patch an existing Discussionmessage + api_response = api_instance.discussionmessage_patch_object_v1(pki_discussionmessage_id, discussionmessage_patch_object_v1_request) + print("The response of ObjectDiscussionmessageApi->discussionmessage_patch_object_v1:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectDiscussionmessageApi->discussionmessage_patch_object_v1: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pki_discussionmessage_id** | **int**| The unique ID of the Discussionmessage | + **discussionmessage_patch_object_v1_request** | [**DiscussionmessagePatchObjectV1Request**](DiscussionmessagePatchObjectV1Request.md)| | + +### Return type + +[**DiscussionmessagePatchObjectV1Response**](DiscussionmessagePatchObjectV1Response.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) + diff --git a/docs/ObjectEzsigndiscussionApi.md b/docs/ObjectEzsigndiscussionApi.md new file mode 100644 index 000000000..f4652a97b --- /dev/null +++ b/docs/ObjectEzsigndiscussionApi.md @@ -0,0 +1,257 @@ +# eZmaxApi.ObjectEzsigndiscussionApi + +All URIs are relative to *https://prod.api.appcluster01.ca-central-1.ezmax.com/rest* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**ezsigndiscussion_create_object_v1**](ObjectEzsigndiscussionApi.md#ezsigndiscussion_create_object_v1) | **POST** /1/object/ezsigndiscussion | Create a new Ezsigndiscussion +[**ezsigndiscussion_delete_object_v1**](ObjectEzsigndiscussionApi.md#ezsigndiscussion_delete_object_v1) | **DELETE** /1/object/ezsigndiscussion/{pkiEzsigndiscussionID} | Delete an existing Ezsigndiscussion +[**ezsigndiscussion_get_object_v2**](ObjectEzsigndiscussionApi.md#ezsigndiscussion_get_object_v2) | **GET** /2/object/ezsigndiscussion/{pkiEzsigndiscussionID} | Retrieve an existing Ezsigndiscussion + + +# **ezsigndiscussion_create_object_v1** +> EzsigndiscussionCreateObjectV1Response ezsigndiscussion_create_object_v1(ezsigndiscussion_create_object_v1_request) + +Create a new Ezsigndiscussion + +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.ezsigndiscussion_create_object_v1_request import EzsigndiscussionCreateObjectV1Request +from eZmaxApi.models.ezsigndiscussion_create_object_v1_response import EzsigndiscussionCreateObjectV1Response +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.ObjectEzsigndiscussionApi(api_client) + ezsigndiscussion_create_object_v1_request = eZmaxApi.EzsigndiscussionCreateObjectV1Request() # EzsigndiscussionCreateObjectV1Request | + + try: + # Create a new Ezsigndiscussion + api_response = api_instance.ezsigndiscussion_create_object_v1(ezsigndiscussion_create_object_v1_request) + print("The response of ObjectEzsigndiscussionApi->ezsigndiscussion_create_object_v1:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectEzsigndiscussionApi->ezsigndiscussion_create_object_v1: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **ezsigndiscussion_create_object_v1_request** | [**EzsigndiscussionCreateObjectV1Request**](EzsigndiscussionCreateObjectV1Request.md)| | + +### Return type + +[**EzsigndiscussionCreateObjectV1Response**](EzsigndiscussionCreateObjectV1Response.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) + +# **ezsigndiscussion_delete_object_v1** +> EzsigndiscussionDeleteObjectV1Response ezsigndiscussion_delete_object_v1(pki_ezsigndiscussion_id) + +Delete an existing Ezsigndiscussion + + + +### Example + +* Api Key Authentication (Authorization): + +```python +import time +import os +import eZmaxApi +from eZmaxApi.models.ezsigndiscussion_delete_object_v1_response import EzsigndiscussionDeleteObjectV1Response +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.ObjectEzsigndiscussionApi(api_client) + pki_ezsigndiscussion_id = 56 # int | The unique ID of the Ezsigndiscussion + + try: + # Delete an existing Ezsigndiscussion + api_response = api_instance.ezsigndiscussion_delete_object_v1(pki_ezsigndiscussion_id) + print("The response of ObjectEzsigndiscussionApi->ezsigndiscussion_delete_object_v1:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectEzsigndiscussionApi->ezsigndiscussion_delete_object_v1: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pki_ezsigndiscussion_id** | **int**| The unique ID of the Ezsigndiscussion | + +### Return type + +[**EzsigndiscussionDeleteObjectV1Response**](EzsigndiscussionDeleteObjectV1Response.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) + +# **ezsigndiscussion_get_object_v2** +> EzsigndiscussionGetObjectV2Response ezsigndiscussion_get_object_v2(pki_ezsigndiscussion_id) + +Retrieve an existing Ezsigndiscussion + + + +### Example + +* Api Key Authentication (Authorization): + +```python +import time +import os +import eZmaxApi +from eZmaxApi.models.ezsigndiscussion_get_object_v2_response import EzsigndiscussionGetObjectV2Response +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.ObjectEzsigndiscussionApi(api_client) + pki_ezsigndiscussion_id = 56 # int | The unique ID of the Ezsigndiscussion + + try: + # Retrieve an existing Ezsigndiscussion + api_response = api_instance.ezsigndiscussion_get_object_v2(pki_ezsigndiscussion_id) + print("The response of ObjectEzsigndiscussionApi->ezsigndiscussion_get_object_v2:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectEzsigndiscussionApi->ezsigndiscussion_get_object_v2: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pki_ezsigndiscussion_id** | **int**| The unique ID of the Ezsigndiscussion | + +### Return type + +[**EzsigndiscussionGetObjectV2Response**](EzsigndiscussionGetObjectV2Response.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/ObjectEzsigndocumentApi.md b/docs/ObjectEzsigndocumentApi.md index f164c5d05..33b157c92 100644 --- a/docs/ObjectEzsigndocumentApi.md +++ b/docs/ObjectEzsigndocumentApi.md @@ -6,6 +6,7 @@ Method | HTTP request | Description ------------- | ------------- | ------------- [**ezsigndocument_apply_ezsigntemplate_v1**](ObjectEzsigndocumentApi.md#ezsigndocument_apply_ezsigntemplate_v1) | **POST** /1/object/ezsigndocument/{pkiEzsigndocumentID}/applyezsigntemplate | Apply an Ezsigntemplate to the Ezsigndocument. [**ezsigndocument_apply_ezsigntemplate_v2**](ObjectEzsigndocumentApi.md#ezsigndocument_apply_ezsigntemplate_v2) | **POST** /2/object/ezsigndocument/{pkiEzsigndocumentID}/applyEzsigntemplate | Apply an Ezsigntemplate to the Ezsigndocument. +[**ezsigndocument_create_ezsignelements_positioned_by_word_v1**](ObjectEzsigndocumentApi.md#ezsigndocument_create_ezsignelements_positioned_by_word_v1) | **POST** /1/object/ezsigndocument/{pkiEzsigndocumentID}/createEzsignelementsPositionedByWord | Create multiple Ezsignsignatures/Ezsignformfieldgroups [**ezsigndocument_create_object_v1**](ObjectEzsigndocumentApi.md#ezsigndocument_create_object_v1) | **POST** /1/object/ezsigndocument | Create a new Ezsigndocument [**ezsigndocument_create_object_v2**](ObjectEzsigndocumentApi.md#ezsigndocument_create_object_v2) | **POST** /2/object/ezsigndocument | Create a new Ezsigndocument [**ezsigndocument_decline_to_sign_v1**](ObjectEzsigndocumentApi.md#ezsigndocument_decline_to_sign_v1) | **POST** /1/object/ezsigndocument/{pkiEzsigndocumentID}/declineToSign | Decline to sign @@ -19,6 +20,7 @@ Method | HTTP request | Description [**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 +[**ezsigndocument_get_ezsigndiscussions_v1**](ObjectEzsigndocumentApi.md#ezsigndocument_get_ezsigndiscussions_v1) | **GET** /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsigndiscussions | Retrieve an existing Ezsigndocument's Ezsigndiscussions [**ezsigndocument_get_ezsignformfieldgroups_v1**](ObjectEzsigndocumentApi.md#ezsigndocument_get_ezsignformfieldgroups_v1) | **GET** /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignformfieldgroups | Retrieve an existing Ezsigndocument's Ezsignformfieldgroups [**ezsigndocument_get_ezsignpages_v1**](ObjectEzsigndocumentApi.md#ezsigndocument_get_ezsignpages_v1) | **GET** /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignpages | Retrieve an existing Ezsigndocument's Ezsignpages [**ezsigndocument_get_ezsignsignatures_automatic_v1**](ObjectEzsigndocumentApi.md#ezsigndocument_get_ezsignsignatures_automatic_v1) | **GET** /1/object/ezsigndocument/{pkiEzsigndocumentID}/getEzsignsignaturesAutomatic | Retrieve an existing Ezsigndocument's automatic Ezsignsignatures @@ -205,6 +207,92 @@ 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_create_ezsignelements_positioned_by_word_v1** +> EzsigndocumentCreateEzsignelementsPositionedByWordV1Response ezsigndocument_create_ezsignelements_positioned_by_word_v1(pki_ezsigndocument_id, ezsigndocument_create_ezsignelements_positioned_by_word_v1_request) + +Create multiple Ezsignsignatures/Ezsignformfieldgroups + +Using this endpoint, you can create multiple Ezsignsignatures/Ezsignformfieldgroups positioned by word at the same time. + +### Example + +* Api Key Authentication (Authorization): + +```python +import time +import os +import eZmaxApi +from eZmaxApi.models.ezsigndocument_create_ezsignelements_positioned_by_word_v1_request import EzsigndocumentCreateEzsignelementsPositionedByWordV1Request +from eZmaxApi.models.ezsigndocument_create_ezsignelements_positioned_by_word_v1_response import EzsigndocumentCreateEzsignelementsPositionedByWordV1Response +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 | + ezsigndocument_create_ezsignelements_positioned_by_word_v1_request = eZmaxApi.EzsigndocumentCreateEzsignelementsPositionedByWordV1Request() # EzsigndocumentCreateEzsignelementsPositionedByWordV1Request | + + try: + # Create multiple Ezsignsignatures/Ezsignformfieldgroups + api_response = api_instance.ezsigndocument_create_ezsignelements_positioned_by_word_v1(pki_ezsigndocument_id, ezsigndocument_create_ezsignelements_positioned_by_word_v1_request) + print("The response of ObjectEzsigndocumentApi->ezsigndocument_create_ezsignelements_positioned_by_word_v1:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectEzsigndocumentApi->ezsigndocument_create_ezsignelements_positioned_by_word_v1: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pki_ezsigndocument_id** | **int**| | + **ezsigndocument_create_ezsignelements_positioned_by_word_v1_request** | [**EzsigndocumentCreateEzsignelementsPositionedByWordV1Request**](EzsigndocumentCreateEzsignelementsPositionedByWordV1Request.md)| | + +### Return type + +[**EzsigndocumentCreateEzsignelementsPositionedByWordV1Response**](EzsigndocumentCreateEzsignelementsPositionedByWordV1Response.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) + # **ezsigndocument_create_object_v1** > EzsigndocumentCreateObjectV1Response ezsigndocument_create_object_v1(ezsigndocument_create_object_v1_request) @@ -1171,7 +1259,7 @@ 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 | - e_document_type = 'e_document_type_example' # str | 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. + e_document_type = 'e_document_type_example' # str | 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 in current document if eEzsignfolderCompletion is PerEzsigndocument.
Is the final document once all signatures were applied in all documents if eEzsignfolderCompletion is PerEzsignfolder. 4. **Proofdocument** Is the evidence report. 5. **Proof** Is the complete evidence archive including all of the above and more. try: # Retrieve a URL to download documents. @@ -1190,7 +1278,7 @@ with eZmaxApi.ApiClient(configuration) as api_client: Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pki_ezsigndocument_id** | **int**| | - **e_document_type** | **str**| 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. | + **e_document_type** | **str**| 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 in current document if eEzsignfolderCompletion is PerEzsigndocument.<br> Is the final document once all signatures were applied in all documents if eEzsignfolderCompletion is PerEzsignfolder. 4. **Proofdocument** Is the evidence report. 5. **Proof** Is the complete evidence archive including all of the above and more. | ### Return type @@ -1298,6 +1386,89 @@ 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_ezsigndiscussions_v1** +> EzsigndocumentGetEzsigndiscussionsV1Response ezsigndocument_get_ezsigndiscussions_v1(pki_ezsigndocument_id) + +Retrieve an existing Ezsigndocument's Ezsigndiscussions + + + +### Example + +* Api Key Authentication (Authorization): + +```python +import time +import os +import eZmaxApi +from eZmaxApi.models.ezsigndocument_get_ezsigndiscussions_v1_response import EzsigndocumentGetEzsigndiscussionsV1Response +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 an existing Ezsigndocument's Ezsigndiscussions + api_response = api_instance.ezsigndocument_get_ezsigndiscussions_v1(pki_ezsigndocument_id) + print("The response of ObjectEzsigndocumentApi->ezsigndocument_get_ezsigndiscussions_v1:\n") + pprint(api_response) + except Exception as e: + print("Exception when calling ObjectEzsigndocumentApi->ezsigndocument_get_ezsigndiscussions_v1: %s\n" % e) +``` + + + +### Parameters + + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pki_ezsigndocument_id** | **int**| | + +### Return type + +[**EzsigndocumentGetEzsigndiscussionsV1Response**](EzsigndocumentGetEzsigndiscussionsV1Response.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 | - | +**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) + # **ezsigndocument_get_ezsignformfieldgroups_v1** > EzsigndocumentGetEzsignformfieldgroupsV1Response ezsigndocument_get_ezsignformfieldgroups_v1(pki_ezsigndocument_id) diff --git a/docs/UserListElement.md b/docs/UserListElement.md index 50b501ce1..4bcd46de9 100644 --- a/docs/UserListElement.md +++ b/docs/UserListElement.md @@ -16,6 +16,7 @@ Name | Type | Description | Notes **e_user_ezsignaccess** | [**FieldEUserEzsignaccess**](FieldEUserEzsignaccess.md) | | **dt_user_ezsignprepaidexpiration** | **str** | The eZsign prepaid expiration date | [optional] **s_email_address** | **str** | The email address. | +**s_user_jobtitle** | **str** | The job title of the user | [optional] ## Example diff --git a/docs/UserRequest.md b/docs/UserRequest.md index 408e63136..ca348a8ed 100644 --- a/docs/UserRequest.md +++ b/docs/UserRequest.md @@ -27,6 +27,7 @@ Name | Type | Description | Notes **s_user_firstname** | **str** | The first name of the user | **s_user_lastname** | **str** | The last name of the user | **s_user_loginname** | **str** | The login name of the User. | +**s_user_jobtitle** | **str** | The job title of the user | [optional] **e_user_ezsignaccess** | [**FieldEUserEzsignaccess**](FieldEUserEzsignaccess.md) | | **b_user_isactive** | **bool** | Whether the User is active or not | **b_user_validatebyadministration** | **bool** | Whether if the transactions in which the User is implicated must be validated by administrative personnel or not | [optional] diff --git a/docs/UserRequestCompound.md b/docs/UserRequestCompound.md index 5ce982888..c1d20e148 100644 --- a/docs/UserRequestCompound.md +++ b/docs/UserRequestCompound.md @@ -27,6 +27,7 @@ Name | Type | Description | Notes **s_user_firstname** | **str** | The first name of the user | **s_user_lastname** | **str** | The last name of the user | **s_user_loginname** | **str** | The login name of the User. | +**s_user_jobtitle** | **str** | The job title of the user | [optional] **e_user_ezsignaccess** | [**FieldEUserEzsignaccess**](FieldEUserEzsignaccess.md) | | **b_user_isactive** | **bool** | Whether the User is active or not | **b_user_validatebyadministration** | **bool** | Whether if the transactions in which the User is implicated must be validated by administrative personnel or not | [optional] diff --git a/docs/UserResponse.md b/docs/UserResponse.md index 3ba3364de..cf0c28caa 100644 --- a/docs/UserResponse.md +++ b/docs/UserResponse.md @@ -33,6 +33,7 @@ Name | Type | Description | Notes **s_user_firstname** | **str** | The first name of the user | **s_user_lastname** | **str** | The last name of the user | **s_user_loginname** | **str** | The login name of the User. | +**s_user_jobtitle** | **str** | The job title of the user | [optional] **e_user_ezsignaccess** | [**FieldEUserEzsignaccess**](FieldEUserEzsignaccess.md) | | **dt_user_lastlogondate** | **str** | The last logon date of the User | [optional] **dt_user_passwordchanged** | **str** | The date at which the User's password was last changed | [optional] diff --git a/docs/UserResponseCompound.md b/docs/UserResponseCompound.md index f28818514..4636160c2 100644 --- a/docs/UserResponseCompound.md +++ b/docs/UserResponseCompound.md @@ -33,6 +33,7 @@ Name | Type | Description | Notes **s_user_firstname** | **str** | The first name of the user | **s_user_lastname** | **str** | The last name of the user | **s_user_loginname** | **str** | The login name of the User. | +**s_user_jobtitle** | **str** | The job title of the user | [optional] **e_user_ezsignaccess** | [**FieldEUserEzsignaccess**](FieldEUserEzsignaccess.md) | | **dt_user_lastlogondate** | **str** | The last logon date of the User | [optional] **dt_user_passwordchanged** | **str** | The date at which the User's password was last changed | [optional] diff --git a/docs/WebhookResponse.md b/docs/WebhookResponse.md index 7a2b11279..8f0ebe555 100644 --- a/docs/WebhookResponse.md +++ b/docs/WebhookResponse.md @@ -20,6 +20,7 @@ Name | Type | Description | Notes **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 | +**obj_audit** | [**CommonAudit**](CommonAudit.md) | | ## Example diff --git a/docs/WebhookResponseCompound.md b/docs/WebhookResponseCompound.md index b8780118b..339ea2f61 100644 --- a/docs/WebhookResponseCompound.md +++ b/docs/WebhookResponseCompound.md @@ -20,6 +20,7 @@ Name | Type | Description | Notes **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 | +**obj_audit** | [**CommonAudit**](CommonAudit.md) | | **s_webhook_event** | **str** | The concatenated string to describe the Webhook event | [optional] ## Example diff --git a/eZmaxApi/__init__.py b/eZmaxApi/__init__.py index 0a7195c47..53171a703 100644 --- a/eZmaxApi/__init__.py +++ b/eZmaxApi/__init__.py @@ -36,6 +36,9 @@ from eZmaxApi.api.object_company_api import ObjectCompanyApi from eZmaxApi.api.object_cors_api import ObjectCorsApi from eZmaxApi.api.object_department_api import ObjectDepartmentApi +from eZmaxApi.api.object_discussion_api import ObjectDiscussionApi +from eZmaxApi.api.object_discussionmembership_api import ObjectDiscussionmembershipApi +from eZmaxApi.api.object_discussionmessage_api import ObjectDiscussionmessageApi from eZmaxApi.api.object_electronicfundstransfer_api import ObjectElectronicfundstransferApi from eZmaxApi.api.object_emailtype_api import ObjectEmailtypeApi from eZmaxApi.api.object_ezmaxinvoicing_api import ObjectEzmaxinvoicingApi @@ -44,6 +47,7 @@ from eZmaxApi.api.object_ezsignbulksenddocumentmapping_api import ObjectEzsignbulksenddocumentmappingApi from eZmaxApi.api.object_ezsignbulksendsignermapping_api import ObjectEzsignbulksendsignermappingApi from eZmaxApi.api.object_ezsignbulksendtransmission_api import ObjectEzsignbulksendtransmissionApi +from eZmaxApi.api.object_ezsigndiscussion_api import ObjectEzsigndiscussionApi from eZmaxApi.api.object_ezsigndocument_api import ObjectEzsigndocumentApi from eZmaxApi.api.object_ezsignfolder_api import ObjectEzsignfolderApi from eZmaxApi.api.object_ezsignfoldersignerassociation_api import ObjectEzsignfoldersignerassociationApi @@ -281,7 +285,9 @@ from eZmaxApi.models.custom_communicationsender_request import CustomCommunicationsenderRequest from eZmaxApi.models.custom_communicationsender_response import CustomCommunicationsenderResponse from eZmaxApi.models.custom_contact_name_response import CustomContactNameResponse +from eZmaxApi.models.custom_create_ezsignelements_positioned_by_word_request import CustomCreateEzsignelementsPositionedByWordRequest from eZmaxApi.models.custom_creditcardtransaction_response import CustomCreditcardtransactionResponse +from eZmaxApi.models.custom_discussionconfiguration_response import CustomDiscussionconfigurationResponse from eZmaxApi.models.custom_dropdown_element_request import CustomDropdownElementRequest from eZmaxApi.models.custom_dropdown_element_request_compound import CustomDropdownElementRequestCompound from eZmaxApi.models.custom_dropdown_element_response import CustomDropdownElementResponse @@ -300,7 +306,9 @@ from eZmaxApi.models.custom_ezsignformfield_request import CustomEzsignformfieldRequest from eZmaxApi.models.custom_ezsignformfielderror_response import CustomEzsignformfielderrorResponse from eZmaxApi.models.custom_ezsignformfielderrortest_response import CustomEzsignformfielderrortestResponse +from eZmaxApi.models.custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request import CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest from eZmaxApi.models.custom_ezsignformfieldgroup_request import CustomEzsignformfieldgroupRequest +from eZmaxApi.models.custom_ezsignsignature_create_ezsignelements_positioned_by_word_request import CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest from eZmaxApi.models.custom_ezsignsignature_ezsignsignatures_automatic_response import CustomEzsignsignatureEzsignsignaturesAutomaticResponse from eZmaxApi.models.custom_ezsignsignaturestatus_response import CustomEzsignsignaturestatusResponse from eZmaxApi.models.custom_form_data_document_response import CustomFormDataDocumentResponse @@ -319,6 +327,40 @@ from eZmaxApi.models.department_autocomplete_element_response import DepartmentAutocompleteElementResponse from eZmaxApi.models.department_get_autocomplete_v2_response import DepartmentGetAutocompleteV2Response from eZmaxApi.models.department_get_autocomplete_v2_response_m_payload import DepartmentGetAutocompleteV2ResponseMPayload +from eZmaxApi.models.discussion_create_object_v1_request import DiscussionCreateObjectV1Request +from eZmaxApi.models.discussion_create_object_v1_response import DiscussionCreateObjectV1Response +from eZmaxApi.models.discussion_create_object_v1_response_m_payload import DiscussionCreateObjectV1ResponseMPayload +from eZmaxApi.models.discussion_delete_object_v1_response import DiscussionDeleteObjectV1Response +from eZmaxApi.models.discussion_get_object_v2_response import DiscussionGetObjectV2Response +from eZmaxApi.models.discussion_get_object_v2_response_m_payload import DiscussionGetObjectV2ResponseMPayload +from eZmaxApi.models.discussion_patch_object_v1_request import DiscussionPatchObjectV1Request +from eZmaxApi.models.discussion_patch_object_v1_response import DiscussionPatchObjectV1Response +from eZmaxApi.models.discussion_request import DiscussionRequest +from eZmaxApi.models.discussion_request_compound import DiscussionRequestCompound +from eZmaxApi.models.discussion_request_patch import DiscussionRequestPatch +from eZmaxApi.models.discussion_response import DiscussionResponse +from eZmaxApi.models.discussion_response_compound import DiscussionResponseCompound +from eZmaxApi.models.discussion_update_discussionreadstatus_v1_request import DiscussionUpdateDiscussionreadstatusV1Request +from eZmaxApi.models.discussion_update_discussionreadstatus_v1_response import DiscussionUpdateDiscussionreadstatusV1Response +from eZmaxApi.models.discussionmembership_create_object_v1_request import DiscussionmembershipCreateObjectV1Request +from eZmaxApi.models.discussionmembership_create_object_v1_response import DiscussionmembershipCreateObjectV1Response +from eZmaxApi.models.discussionmembership_create_object_v1_response_m_payload import DiscussionmembershipCreateObjectV1ResponseMPayload +from eZmaxApi.models.discussionmembership_delete_object_v1_response import DiscussionmembershipDeleteObjectV1Response +from eZmaxApi.models.discussionmembership_request import DiscussionmembershipRequest +from eZmaxApi.models.discussionmembership_request_compound import DiscussionmembershipRequestCompound +from eZmaxApi.models.discussionmembership_response import DiscussionmembershipResponse +from eZmaxApi.models.discussionmembership_response_compound import DiscussionmembershipResponseCompound +from eZmaxApi.models.discussionmessage_create_object_v1_request import DiscussionmessageCreateObjectV1Request +from eZmaxApi.models.discussionmessage_create_object_v1_response import DiscussionmessageCreateObjectV1Response +from eZmaxApi.models.discussionmessage_create_object_v1_response_m_payload import DiscussionmessageCreateObjectV1ResponseMPayload +from eZmaxApi.models.discussionmessage_delete_object_v1_response import DiscussionmessageDeleteObjectV1Response +from eZmaxApi.models.discussionmessage_patch_object_v1_request import DiscussionmessagePatchObjectV1Request +from eZmaxApi.models.discussionmessage_patch_object_v1_response import DiscussionmessagePatchObjectV1Response +from eZmaxApi.models.discussionmessage_request import DiscussionmessageRequest +from eZmaxApi.models.discussionmessage_request_compound import DiscussionmessageRequestCompound +from eZmaxApi.models.discussionmessage_request_patch import DiscussionmessageRequestPatch +from eZmaxApi.models.discussionmessage_response import DiscussionmessageResponse +from eZmaxApi.models.discussionmessage_response_compound import DiscussionmessageResponseCompound from eZmaxApi.models.electronicfundstransfer_get_communication_list_v1_response import ElectronicfundstransferGetCommunicationListV1Response from eZmaxApi.models.electronicfundstransfer_get_communication_list_v1_response_m_payload import ElectronicfundstransferGetCommunicationListV1ResponseMPayload from eZmaxApi.models.email_request import EmailRequest @@ -423,10 +465,23 @@ from eZmaxApi.models.ezsignbulksendtransmission_get_object_v2_response_m_payload import EzsignbulksendtransmissionGetObjectV2ResponseMPayload from eZmaxApi.models.ezsignbulksendtransmission_response import EzsignbulksendtransmissionResponse from eZmaxApi.models.ezsignbulksendtransmission_response_compound import EzsignbulksendtransmissionResponseCompound +from eZmaxApi.models.ezsigndiscussion_create_object_v1_request import EzsigndiscussionCreateObjectV1Request +from eZmaxApi.models.ezsigndiscussion_create_object_v1_response import EzsigndiscussionCreateObjectV1Response +from eZmaxApi.models.ezsigndiscussion_create_object_v1_response_m_payload import EzsigndiscussionCreateObjectV1ResponseMPayload +from eZmaxApi.models.ezsigndiscussion_delete_object_v1_response import EzsigndiscussionDeleteObjectV1Response +from eZmaxApi.models.ezsigndiscussion_get_object_v2_response import EzsigndiscussionGetObjectV2Response +from eZmaxApi.models.ezsigndiscussion_get_object_v2_response_m_payload import EzsigndiscussionGetObjectV2ResponseMPayload +from eZmaxApi.models.ezsigndiscussion_request import EzsigndiscussionRequest +from eZmaxApi.models.ezsigndiscussion_request_compound import EzsigndiscussionRequestCompound +from eZmaxApi.models.ezsigndiscussion_response import EzsigndiscussionResponse +from eZmaxApi.models.ezsigndiscussion_response_compound import EzsigndiscussionResponseCompound from eZmaxApi.models.ezsigndocument_apply_ezsigntemplate_v1_request import EzsigndocumentApplyEzsigntemplateV1Request from eZmaxApi.models.ezsigndocument_apply_ezsigntemplate_v1_response import EzsigndocumentApplyEzsigntemplateV1Response from eZmaxApi.models.ezsigndocument_apply_ezsigntemplate_v2_request import EzsigndocumentApplyEzsigntemplateV2Request from eZmaxApi.models.ezsigndocument_apply_ezsigntemplate_v2_response import EzsigndocumentApplyEzsigntemplateV2Response +from eZmaxApi.models.ezsigndocument_create_ezsignelements_positioned_by_word_v1_request import EzsigndocumentCreateEzsignelementsPositionedByWordV1Request +from eZmaxApi.models.ezsigndocument_create_ezsignelements_positioned_by_word_v1_response import EzsigndocumentCreateEzsignelementsPositionedByWordV1Response +from eZmaxApi.models.ezsigndocument_create_ezsignelements_positioned_by_word_v1_response_m_payload import EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload from eZmaxApi.models.ezsigndocument_create_object_v1_request import EzsigndocumentCreateObjectV1Request from eZmaxApi.models.ezsigndocument_create_object_v1_response import EzsigndocumentCreateObjectV1Response from eZmaxApi.models.ezsigndocument_create_object_v1_response_m_payload import EzsigndocumentCreateObjectV1ResponseMPayload @@ -454,6 +509,8 @@ from eZmaxApi.models.ezsigndocument_get_download_url_v1_response_m_payload import EzsigndocumentGetDownloadUrlV1ResponseMPayload from eZmaxApi.models.ezsigndocument_get_ezsignannotations_v1_response import EzsigndocumentGetEzsignannotationsV1Response from eZmaxApi.models.ezsigndocument_get_ezsignannotations_v1_response_m_payload import EzsigndocumentGetEzsignannotationsV1ResponseMPayload +from eZmaxApi.models.ezsigndocument_get_ezsigndiscussions_v1_response import EzsigndocumentGetEzsigndiscussionsV1Response +from eZmaxApi.models.ezsigndocument_get_ezsigndiscussions_v1_response_m_payload import EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload from eZmaxApi.models.ezsigndocument_get_ezsignformfieldgroups_v1_response import EzsigndocumentGetEzsignformfieldgroupsV1Response from eZmaxApi.models.ezsigndocument_get_ezsignformfieldgroups_v1_response_m_payload import EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload from eZmaxApi.models.ezsigndocument_get_ezsignpages_v1_response import EzsigndocumentGetEzsignpagesV1Response @@ -868,6 +925,7 @@ from eZmaxApi.models.field_e_communicationexternalrecipient_type import FieldECommunicationexternalrecipientType from eZmaxApi.models.field_e_communicationrecipient_type import FieldECommunicationrecipientType from eZmaxApi.models.field_e_creditcardtype_codename import FieldECreditcardtypeCodename +from eZmaxApi.models.field_e_discussionmessage_status import FieldEDiscussionmessageStatus from eZmaxApi.models.field_e_error_code import FieldEErrorCode from eZmaxApi.models.field_e_ezmaxinvoicing_paymenttype import FieldEEzmaxinvoicingPaymenttype from eZmaxApi.models.field_e_ezmaxinvoicingagent_variationezmax import FieldEEzmaxinvoicingagentVariationezmax @@ -879,8 +937,10 @@ from eZmaxApi.models.field_e_ezsigndocumentlog_type import FieldEEzsigndocumentlogType from eZmaxApi.models.field_e_ezsignelementdependency_operator import FieldEEzsignelementdependencyOperator from eZmaxApi.models.field_e_ezsignelementdependency_validation import FieldEEzsignelementdependencyValidation +from eZmaxApi.models.field_e_ezsignfolder_completion import FieldEEzsignfolderCompletion from eZmaxApi.models.field_e_ezsignfolder_sendreminderfrequency import FieldEEzsignfolderSendreminderfrequency from eZmaxApi.models.field_e_ezsignfolder_step import FieldEEzsignfolderStep +from eZmaxApi.models.field_e_ezsignfoldertype_completion import FieldEEzsignfoldertypeCompletion 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 @@ -896,12 +956,16 @@ from eZmaxApi.models.field_e_ezsigntemplateelementdependency_operator import FieldEEzsigntemplateelementdependencyOperator from eZmaxApi.models.field_e_ezsigntemplateelementdependency_validation import FieldEEzsigntemplateelementdependencyValidation from eZmaxApi.models.field_e_ezsigntemplateformfield_dependencyrequirement import FieldEEzsigntemplateformfieldDependencyrequirement +from eZmaxApi.models.field_e_ezsigntemplateformfield_positioning import FieldEEzsigntemplateformfieldPositioning +from eZmaxApi.models.field_e_ezsigntemplateformfield_positioningoccurence import FieldEEzsigntemplateformfieldPositioningoccurence 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 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_positioning import FieldEEzsigntemplatesignaturePositioning +from eZmaxApi.models.field_e_ezsigntemplatesignature_positioningoccurence import FieldEEzsigntemplatesignaturePositioningoccurence from eZmaxApi.models.field_e_ezsigntemplatesignature_tooltipposition import FieldEEzsigntemplatesignatureTooltipposition from eZmaxApi.models.field_e_ezsigntemplatesignature_type import FieldEEzsigntemplatesignatureType from eZmaxApi.models.field_e_notificationpreference_status import FieldENotificationpreferenceStatus diff --git a/eZmaxApi/api/__init__.py b/eZmaxApi/api/__init__.py index 35d4ebdc7..cd989a66f 100644 --- a/eZmaxApi/api/__init__.py +++ b/eZmaxApi/api/__init__.py @@ -19,6 +19,9 @@ from eZmaxApi.api.object_company_api import ObjectCompanyApi from eZmaxApi.api.object_cors_api import ObjectCorsApi from eZmaxApi.api.object_department_api import ObjectDepartmentApi +from eZmaxApi.api.object_discussion_api import ObjectDiscussionApi +from eZmaxApi.api.object_discussionmembership_api import ObjectDiscussionmembershipApi +from eZmaxApi.api.object_discussionmessage_api import ObjectDiscussionmessageApi from eZmaxApi.api.object_electronicfundstransfer_api import ObjectElectronicfundstransferApi from eZmaxApi.api.object_emailtype_api import ObjectEmailtypeApi from eZmaxApi.api.object_ezmaxinvoicing_api import ObjectEzmaxinvoicingApi @@ -27,6 +30,7 @@ from eZmaxApi.api.object_ezsignbulksenddocumentmapping_api import ObjectEzsignbulksenddocumentmappingApi from eZmaxApi.api.object_ezsignbulksendsignermapping_api import ObjectEzsignbulksendsignermappingApi from eZmaxApi.api.object_ezsignbulksendtransmission_api import ObjectEzsignbulksendtransmissionApi +from eZmaxApi.api.object_ezsigndiscussion_api import ObjectEzsigndiscussionApi from eZmaxApi.api.object_ezsigndocument_api import ObjectEzsigndocumentApi from eZmaxApi.api.object_ezsignfolder_api import ObjectEzsignfolderApi from eZmaxApi.api.object_ezsignfoldersignerassociation_api import ObjectEzsignfoldersignerassociationApi diff --git a/eZmaxApi/api/object_discussion_api.py b/eZmaxApi/api/object_discussion_api.py new file mode 100644 index 000000000..c55991d12 --- /dev/null +++ b/eZmaxApi/api/object_discussion_api.py @@ -0,0 +1,1427 @@ +# 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 eZmaxApi.models.discussion_create_object_v1_request import DiscussionCreateObjectV1Request +from eZmaxApi.models.discussion_create_object_v1_response import DiscussionCreateObjectV1Response +from eZmaxApi.models.discussion_delete_object_v1_response import DiscussionDeleteObjectV1Response +from eZmaxApi.models.discussion_get_object_v2_response import DiscussionGetObjectV2Response +from eZmaxApi.models.discussion_patch_object_v1_request import DiscussionPatchObjectV1Request +from eZmaxApi.models.discussion_patch_object_v1_response import DiscussionPatchObjectV1Response +from eZmaxApi.models.discussion_update_discussionreadstatus_v1_request import DiscussionUpdateDiscussionreadstatusV1Request +from eZmaxApi.models.discussion_update_discussionreadstatus_v1_response import DiscussionUpdateDiscussionreadstatusV1Response + +from eZmaxApi.api_client import ApiClient +from eZmaxApi.api_response import ApiResponse +from eZmaxApi.rest import RESTResponseType + + +class ObjectDiscussionApi: + """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 discussion_create_object_v1( + self, + discussion_create_object_v1_request: DiscussionCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DiscussionCreateObjectV1Response: + """Create a new Discussion + + The endpoint allows to create one or many elements at once. + + :param discussion_create_object_v1_request: (required) + :type discussion_create_object_v1_request: DiscussionCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._discussion_create_object_v1_serialize( + discussion_create_object_v1_request=discussion_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': "DiscussionCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def discussion_create_object_v1_with_http_info( + self, + discussion_create_object_v1_request: DiscussionCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DiscussionCreateObjectV1Response]: + """Create a new Discussion + + The endpoint allows to create one or many elements at once. + + :param discussion_create_object_v1_request: (required) + :type discussion_create_object_v1_request: DiscussionCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._discussion_create_object_v1_serialize( + discussion_create_object_v1_request=discussion_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': "DiscussionCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_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 discussion_create_object_v1_without_preload_content( + self, + discussion_create_object_v1_request: DiscussionCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, 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 Discussion + + The endpoint allows to create one or many elements at once. + + :param discussion_create_object_v1_request: (required) + :type discussion_create_object_v1_request: DiscussionCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._discussion_create_object_v1_serialize( + discussion_create_object_v1_request=discussion_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': "DiscussionCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _discussion_create_object_v1_serialize( + self, + discussion_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 discussion_create_object_v1_request is not None: + _body_params = discussion_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/discussion', + 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 discussion_delete_object_v1( + self, + pki_discussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Discussion")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DiscussionDeleteObjectV1Response: + """Delete an existing Discussion + + + + :param pki_discussion_id: The unique ID of the Discussion (required) + :type pki_discussion_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._discussion_delete_object_v1_serialize( + pki_discussion_id=pki_discussion_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DiscussionDeleteObjectV1Response", + '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 discussion_delete_object_v1_with_http_info( + self, + pki_discussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Discussion")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DiscussionDeleteObjectV1Response]: + """Delete an existing Discussion + + + + :param pki_discussion_id: The unique ID of the Discussion (required) + :type pki_discussion_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._discussion_delete_object_v1_serialize( + pki_discussion_id=pki_discussion_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DiscussionDeleteObjectV1Response", + '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 discussion_delete_object_v1_without_preload_content( + self, + pki_discussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Discussion")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, 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 Discussion + + + + :param pki_discussion_id: The unique ID of the Discussion (required) + :type pki_discussion_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._discussion_delete_object_v1_serialize( + pki_discussion_id=pki_discussion_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DiscussionDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _discussion_delete_object_v1_serialize( + self, + pki_discussion_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_discussion_id is not None: + _path_params['pkiDiscussionID'] = pki_discussion_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/discussion/{pkiDiscussionID}', + 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 discussion_get_object_v2( + self, + pki_discussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Discussion")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DiscussionGetObjectV2Response: + """Retrieve an existing Discussion + + + + :param pki_discussion_id: The unique ID of the Discussion (required) + :type pki_discussion_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._discussion_get_object_v2_serialize( + pki_discussion_id=pki_discussion_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DiscussionGetObjectV2Response", + '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 discussion_get_object_v2_with_http_info( + self, + pki_discussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Discussion")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DiscussionGetObjectV2Response]: + """Retrieve an existing Discussion + + + + :param pki_discussion_id: The unique ID of the Discussion (required) + :type pki_discussion_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._discussion_get_object_v2_serialize( + pki_discussion_id=pki_discussion_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DiscussionGetObjectV2Response", + '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 discussion_get_object_v2_without_preload_content( + self, + pki_discussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Discussion")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, 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 Discussion + + + + :param pki_discussion_id: The unique ID of the Discussion (required) + :type pki_discussion_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._discussion_get_object_v2_serialize( + pki_discussion_id=pki_discussion_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DiscussionGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _discussion_get_object_v2_serialize( + self, + pki_discussion_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_discussion_id is not None: + _path_params['pkiDiscussionID'] = pki_discussion_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/discussion/{pkiDiscussionID}', + 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 discussion_patch_object_v1( + self, + pki_discussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Discussion")], + discussion_patch_object_v1_request: DiscussionPatchObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DiscussionPatchObjectV1Response: + """Patch an existing Discussion + + + + :param pki_discussion_id: The unique ID of the Discussion (required) + :type pki_discussion_id: int + :param discussion_patch_object_v1_request: (required) + :type discussion_patch_object_v1_request: DiscussionPatchObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._discussion_patch_object_v1_serialize( + pki_discussion_id=pki_discussion_id, + discussion_patch_object_v1_request=discussion_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': "DiscussionPatchObjectV1Response", + '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 discussion_patch_object_v1_with_http_info( + self, + pki_discussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Discussion")], + discussion_patch_object_v1_request: DiscussionPatchObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DiscussionPatchObjectV1Response]: + """Patch an existing Discussion + + + + :param pki_discussion_id: The unique ID of the Discussion (required) + :type pki_discussion_id: int + :param discussion_patch_object_v1_request: (required) + :type discussion_patch_object_v1_request: DiscussionPatchObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._discussion_patch_object_v1_serialize( + pki_discussion_id=pki_discussion_id, + discussion_patch_object_v1_request=discussion_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': "DiscussionPatchObjectV1Response", + '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 discussion_patch_object_v1_without_preload_content( + self, + pki_discussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Discussion")], + discussion_patch_object_v1_request: DiscussionPatchObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, 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 Discussion + + + + :param pki_discussion_id: The unique ID of the Discussion (required) + :type pki_discussion_id: int + :param discussion_patch_object_v1_request: (required) + :type discussion_patch_object_v1_request: DiscussionPatchObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._discussion_patch_object_v1_serialize( + pki_discussion_id=pki_discussion_id, + discussion_patch_object_v1_request=discussion_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': "DiscussionPatchObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _discussion_patch_object_v1_serialize( + self, + pki_discussion_id, + discussion_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_discussion_id is not None: + _path_params['pkiDiscussionID'] = pki_discussion_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if discussion_patch_object_v1_request is not None: + _body_params = discussion_patch_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='PATCH', + resource_path='/1/object/discussion/{pkiDiscussionID}', + 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 discussion_update_discussionreadstatus_v1( + self, + pki_discussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0)], + discussion_update_discussionreadstatus_v1_request: DiscussionUpdateDiscussionreadstatusV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DiscussionUpdateDiscussionreadstatusV1Response: + """Update the read status of the discussion + + + :param pki_discussion_id: (required) + :type pki_discussion_id: int + :param discussion_update_discussionreadstatus_v1_request: (required) + :type discussion_update_discussionreadstatus_v1_request: DiscussionUpdateDiscussionreadstatusV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._discussion_update_discussionreadstatus_v1_serialize( + pki_discussion_id=pki_discussion_id, + discussion_update_discussionreadstatus_v1_request=discussion_update_discussionreadstatus_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DiscussionUpdateDiscussionreadstatusV1Response", + '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 discussion_update_discussionreadstatus_v1_with_http_info( + self, + pki_discussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0)], + discussion_update_discussionreadstatus_v1_request: DiscussionUpdateDiscussionreadstatusV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DiscussionUpdateDiscussionreadstatusV1Response]: + """Update the read status of the discussion + + + :param pki_discussion_id: (required) + :type pki_discussion_id: int + :param discussion_update_discussionreadstatus_v1_request: (required) + :type discussion_update_discussionreadstatus_v1_request: DiscussionUpdateDiscussionreadstatusV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._discussion_update_discussionreadstatus_v1_serialize( + pki_discussion_id=pki_discussion_id, + discussion_update_discussionreadstatus_v1_request=discussion_update_discussionreadstatus_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DiscussionUpdateDiscussionreadstatusV1Response", + '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 discussion_update_discussionreadstatus_v1_without_preload_content( + self, + pki_discussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0)], + discussion_update_discussionreadstatus_v1_request: DiscussionUpdateDiscussionreadstatusV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> RESTResponseType: + """Update the read status of the discussion + + + :param pki_discussion_id: (required) + :type pki_discussion_id: int + :param discussion_update_discussionreadstatus_v1_request: (required) + :type discussion_update_discussionreadstatus_v1_request: DiscussionUpdateDiscussionreadstatusV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._discussion_update_discussionreadstatus_v1_serialize( + pki_discussion_id=pki_discussion_id, + discussion_update_discussionreadstatus_v1_request=discussion_update_discussionreadstatus_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DiscussionUpdateDiscussionreadstatusV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _discussion_update_discussionreadstatus_v1_serialize( + self, + pki_discussion_id, + discussion_update_discussionreadstatus_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_discussion_id is not None: + _path_params['pkiDiscussionID'] = pki_discussion_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if discussion_update_discussionreadstatus_v1_request is not None: + _body_params = discussion_update_discussionreadstatus_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/discussion/{pkiDiscussionID}/updateDiscussionreadstatus', + 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_discussionmembership_api.py b/eZmaxApi/api/object_discussionmembership_api.py new file mode 100644 index 000000000..c7afa1265 --- /dev/null +++ b/eZmaxApi/api/object_discussionmembership_api.py @@ -0,0 +1,580 @@ +# 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 eZmaxApi.models.discussionmembership_create_object_v1_request import DiscussionmembershipCreateObjectV1Request +from eZmaxApi.models.discussionmembership_create_object_v1_response import DiscussionmembershipCreateObjectV1Response +from eZmaxApi.models.discussionmembership_delete_object_v1_response import DiscussionmembershipDeleteObjectV1Response + +from eZmaxApi.api_client import ApiClient +from eZmaxApi.api_response import ApiResponse +from eZmaxApi.rest import RESTResponseType + + +class ObjectDiscussionmembershipApi: + """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 discussionmembership_create_object_v1( + self, + discussionmembership_create_object_v1_request: DiscussionmembershipCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DiscussionmembershipCreateObjectV1Response: + """Create a new Discussionmembership + + The endpoint allows to create one or many elements at once. + + :param discussionmembership_create_object_v1_request: (required) + :type discussionmembership_create_object_v1_request: DiscussionmembershipCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._discussionmembership_create_object_v1_serialize( + discussionmembership_create_object_v1_request=discussionmembership_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': "DiscussionmembershipCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def discussionmembership_create_object_v1_with_http_info( + self, + discussionmembership_create_object_v1_request: DiscussionmembershipCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DiscussionmembershipCreateObjectV1Response]: + """Create a new Discussionmembership + + The endpoint allows to create one or many elements at once. + + :param discussionmembership_create_object_v1_request: (required) + :type discussionmembership_create_object_v1_request: DiscussionmembershipCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._discussionmembership_create_object_v1_serialize( + discussionmembership_create_object_v1_request=discussionmembership_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': "DiscussionmembershipCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_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 discussionmembership_create_object_v1_without_preload_content( + self, + discussionmembership_create_object_v1_request: DiscussionmembershipCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, 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 Discussionmembership + + The endpoint allows to create one or many elements at once. + + :param discussionmembership_create_object_v1_request: (required) + :type discussionmembership_create_object_v1_request: DiscussionmembershipCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._discussionmembership_create_object_v1_serialize( + discussionmembership_create_object_v1_request=discussionmembership_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': "DiscussionmembershipCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _discussionmembership_create_object_v1_serialize( + self, + discussionmembership_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 discussionmembership_create_object_v1_request is not None: + _body_params = discussionmembership_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/discussionmembership', + 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 discussionmembership_delete_object_v1( + self, + pki_discussionmembership_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Discussionmembership")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DiscussionmembershipDeleteObjectV1Response: + """Delete an existing Discussionmembership + + + + :param pki_discussionmembership_id: The unique ID of the Discussionmembership (required) + :type pki_discussionmembership_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._discussionmembership_delete_object_v1_serialize( + pki_discussionmembership_id=pki_discussionmembership_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DiscussionmembershipDeleteObjectV1Response", + '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 discussionmembership_delete_object_v1_with_http_info( + self, + pki_discussionmembership_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Discussionmembership")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DiscussionmembershipDeleteObjectV1Response]: + """Delete an existing Discussionmembership + + + + :param pki_discussionmembership_id: The unique ID of the Discussionmembership (required) + :type pki_discussionmembership_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._discussionmembership_delete_object_v1_serialize( + pki_discussionmembership_id=pki_discussionmembership_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DiscussionmembershipDeleteObjectV1Response", + '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 discussionmembership_delete_object_v1_without_preload_content( + self, + pki_discussionmembership_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Discussionmembership")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, 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 Discussionmembership + + + + :param pki_discussionmembership_id: The unique ID of the Discussionmembership (required) + :type pki_discussionmembership_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._discussionmembership_delete_object_v1_serialize( + pki_discussionmembership_id=pki_discussionmembership_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DiscussionmembershipDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _discussionmembership_delete_object_v1_serialize( + self, + pki_discussionmembership_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_discussionmembership_id is not None: + _path_params['pkiDiscussionmembershipID'] = pki_discussionmembership_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/discussionmembership/{pkiDiscussionmembershipID}', + 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_discussionmessage_api.py b/eZmaxApi/api/object_discussionmessage_api.py new file mode 100644 index 000000000..9afc81c00 --- /dev/null +++ b/eZmaxApi/api/object_discussionmessage_api.py @@ -0,0 +1,877 @@ +# 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 eZmaxApi.models.discussionmessage_create_object_v1_request import DiscussionmessageCreateObjectV1Request +from eZmaxApi.models.discussionmessage_create_object_v1_response import DiscussionmessageCreateObjectV1Response +from eZmaxApi.models.discussionmessage_delete_object_v1_response import DiscussionmessageDeleteObjectV1Response +from eZmaxApi.models.discussionmessage_patch_object_v1_request import DiscussionmessagePatchObjectV1Request +from eZmaxApi.models.discussionmessage_patch_object_v1_response import DiscussionmessagePatchObjectV1Response + +from eZmaxApi.api_client import ApiClient +from eZmaxApi.api_response import ApiResponse +from eZmaxApi.rest import RESTResponseType + + +class ObjectDiscussionmessageApi: + """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 discussionmessage_create_object_v1( + self, + discussionmessage_create_object_v1_request: DiscussionmessageCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DiscussionmessageCreateObjectV1Response: + """Create a new Discussionmessage + + The endpoint allows to create one or many elements at once. + + :param discussionmessage_create_object_v1_request: (required) + :type discussionmessage_create_object_v1_request: DiscussionmessageCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._discussionmessage_create_object_v1_serialize( + discussionmessage_create_object_v1_request=discussionmessage_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': "DiscussionmessageCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def discussionmessage_create_object_v1_with_http_info( + self, + discussionmessage_create_object_v1_request: DiscussionmessageCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DiscussionmessageCreateObjectV1Response]: + """Create a new Discussionmessage + + The endpoint allows to create one or many elements at once. + + :param discussionmessage_create_object_v1_request: (required) + :type discussionmessage_create_object_v1_request: DiscussionmessageCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._discussionmessage_create_object_v1_serialize( + discussionmessage_create_object_v1_request=discussionmessage_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': "DiscussionmessageCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_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 discussionmessage_create_object_v1_without_preload_content( + self, + discussionmessage_create_object_v1_request: DiscussionmessageCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, 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 Discussionmessage + + The endpoint allows to create one or many elements at once. + + :param discussionmessage_create_object_v1_request: (required) + :type discussionmessage_create_object_v1_request: DiscussionmessageCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._discussionmessage_create_object_v1_serialize( + discussionmessage_create_object_v1_request=discussionmessage_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': "DiscussionmessageCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _discussionmessage_create_object_v1_serialize( + self, + discussionmessage_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 discussionmessage_create_object_v1_request is not None: + _body_params = discussionmessage_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/discussionmessage', + 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 discussionmessage_delete_object_v1( + self, + pki_discussionmessage_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Discussionmessage")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DiscussionmessageDeleteObjectV1Response: + """Delete an existing Discussionmessage + + + + :param pki_discussionmessage_id: The unique ID of the Discussionmessage (required) + :type pki_discussionmessage_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._discussionmessage_delete_object_v1_serialize( + pki_discussionmessage_id=pki_discussionmessage_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DiscussionmessageDeleteObjectV1Response", + '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 discussionmessage_delete_object_v1_with_http_info( + self, + pki_discussionmessage_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Discussionmessage")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DiscussionmessageDeleteObjectV1Response]: + """Delete an existing Discussionmessage + + + + :param pki_discussionmessage_id: The unique ID of the Discussionmessage (required) + :type pki_discussionmessage_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._discussionmessage_delete_object_v1_serialize( + pki_discussionmessage_id=pki_discussionmessage_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DiscussionmessageDeleteObjectV1Response", + '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 discussionmessage_delete_object_v1_without_preload_content( + self, + pki_discussionmessage_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Discussionmessage")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, 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 Discussionmessage + + + + :param pki_discussionmessage_id: The unique ID of the Discussionmessage (required) + :type pki_discussionmessage_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._discussionmessage_delete_object_v1_serialize( + pki_discussionmessage_id=pki_discussionmessage_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "DiscussionmessageDeleteObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _discussionmessage_delete_object_v1_serialize( + self, + pki_discussionmessage_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_discussionmessage_id is not None: + _path_params['pkiDiscussionmessageID'] = pki_discussionmessage_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/discussionmessage/{pkiDiscussionmessageID}', + 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 discussionmessage_patch_object_v1( + self, + pki_discussionmessage_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Discussionmessage")], + discussionmessage_patch_object_v1_request: DiscussionmessagePatchObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> DiscussionmessagePatchObjectV1Response: + """Patch an existing Discussionmessage + + + + :param pki_discussionmessage_id: The unique ID of the Discussionmessage (required) + :type pki_discussionmessage_id: int + :param discussionmessage_patch_object_v1_request: (required) + :type discussionmessage_patch_object_v1_request: DiscussionmessagePatchObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._discussionmessage_patch_object_v1_serialize( + pki_discussionmessage_id=pki_discussionmessage_id, + discussionmessage_patch_object_v1_request=discussionmessage_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': "DiscussionmessagePatchObjectV1Response", + '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 discussionmessage_patch_object_v1_with_http_info( + self, + pki_discussionmessage_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Discussionmessage")], + discussionmessage_patch_object_v1_request: DiscussionmessagePatchObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[DiscussionmessagePatchObjectV1Response]: + """Patch an existing Discussionmessage + + + + :param pki_discussionmessage_id: The unique ID of the Discussionmessage (required) + :type pki_discussionmessage_id: int + :param discussionmessage_patch_object_v1_request: (required) + :type discussionmessage_patch_object_v1_request: DiscussionmessagePatchObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._discussionmessage_patch_object_v1_serialize( + pki_discussionmessage_id=pki_discussionmessage_id, + discussionmessage_patch_object_v1_request=discussionmessage_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': "DiscussionmessagePatchObjectV1Response", + '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 discussionmessage_patch_object_v1_without_preload_content( + self, + pki_discussionmessage_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Discussionmessage")], + discussionmessage_patch_object_v1_request: DiscussionmessagePatchObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, 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 Discussionmessage + + + + :param pki_discussionmessage_id: The unique ID of the Discussionmessage (required) + :type pki_discussionmessage_id: int + :param discussionmessage_patch_object_v1_request: (required) + :type discussionmessage_patch_object_v1_request: DiscussionmessagePatchObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._discussionmessage_patch_object_v1_serialize( + pki_discussionmessage_id=pki_discussionmessage_id, + discussionmessage_patch_object_v1_request=discussionmessage_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': "DiscussionmessagePatchObjectV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _discussionmessage_patch_object_v1_serialize( + self, + pki_discussionmessage_id, + discussionmessage_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_discussionmessage_id is not None: + _path_params['pkiDiscussionmessageID'] = pki_discussionmessage_id + # process the query parameters + # process the header parameters + # process the form parameters + # process the body parameter + if discussionmessage_patch_object_v1_request is not None: + _body_params = discussionmessage_patch_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='PATCH', + resource_path='/1/object/discussionmessage/{pkiDiscussionmessageID}', + 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_ezsigndiscussion_api.py b/eZmaxApi/api/object_ezsigndiscussion_api.py new file mode 100644 index 000000000..e09ce2261 --- /dev/null +++ b/eZmaxApi/api/object_ezsigndiscussion_api.py @@ -0,0 +1,842 @@ +# 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 eZmaxApi.models.ezsigndiscussion_create_object_v1_request import EzsigndiscussionCreateObjectV1Request +from eZmaxApi.models.ezsigndiscussion_create_object_v1_response import EzsigndiscussionCreateObjectV1Response +from eZmaxApi.models.ezsigndiscussion_delete_object_v1_response import EzsigndiscussionDeleteObjectV1Response +from eZmaxApi.models.ezsigndiscussion_get_object_v2_response import EzsigndiscussionGetObjectV2Response + +from eZmaxApi.api_client import ApiClient +from eZmaxApi.api_response import ApiResponse +from eZmaxApi.rest import RESTResponseType + + +class ObjectEzsigndiscussionApi: + """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 ezsigndiscussion_create_object_v1( + self, + ezsigndiscussion_create_object_v1_request: EzsigndiscussionCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndiscussionCreateObjectV1Response: + """Create a new Ezsigndiscussion + + The endpoint allows to create one or many elements at once. + + :param ezsigndiscussion_create_object_v1_request: (required) + :type ezsigndiscussion_create_object_v1_request: EzsigndiscussionCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndiscussion_create_object_v1_serialize( + ezsigndiscussion_create_object_v1_request=ezsigndiscussion_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': "EzsigndiscussionCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + response_data.read() + return self.api_client.response_deserialize( + response_data=response_data, + response_types_map=_response_types_map, + ).data + + + @validate_call + def ezsigndiscussion_create_object_v1_with_http_info( + self, + ezsigndiscussion_create_object_v1_request: EzsigndiscussionCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndiscussionCreateObjectV1Response]: + """Create a new Ezsigndiscussion + + The endpoint allows to create one or many elements at once. + + :param ezsigndiscussion_create_object_v1_request: (required) + :type ezsigndiscussion_create_object_v1_request: EzsigndiscussionCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndiscussion_create_object_v1_serialize( + ezsigndiscussion_create_object_v1_request=ezsigndiscussion_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': "EzsigndiscussionCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_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 ezsigndiscussion_create_object_v1_without_preload_content( + self, + ezsigndiscussion_create_object_v1_request: EzsigndiscussionCreateObjectV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, 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 Ezsigndiscussion + + The endpoint allows to create one or many elements at once. + + :param ezsigndiscussion_create_object_v1_request: (required) + :type ezsigndiscussion_create_object_v1_request: EzsigndiscussionCreateObjectV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores the host_index + in the spec for a single request. + :type _host_index: int, optional + :return: Returns the result object. + """ # noqa: E501 + + _param = self._ezsigndiscussion_create_object_v1_serialize( + ezsigndiscussion_create_object_v1_request=ezsigndiscussion_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': "EzsigndiscussionCreateObjectV1Response", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsigndiscussion_create_object_v1_serialize( + self, + ezsigndiscussion_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 ezsigndiscussion_create_object_v1_request is not None: + _body_params = ezsigndiscussion_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/ezsigndiscussion', + 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 ezsigndiscussion_delete_object_v1( + self, + pki_ezsigndiscussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Ezsigndiscussion")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndiscussionDeleteObjectV1Response: + """Delete an existing Ezsigndiscussion + + + + :param pki_ezsigndiscussion_id: The unique ID of the Ezsigndiscussion (required) + :type pki_ezsigndiscussion_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._ezsigndiscussion_delete_object_v1_serialize( + pki_ezsigndiscussion_id=pki_ezsigndiscussion_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndiscussionDeleteObjectV1Response", + '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 ezsigndiscussion_delete_object_v1_with_http_info( + self, + pki_ezsigndiscussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Ezsigndiscussion")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndiscussionDeleteObjectV1Response]: + """Delete an existing Ezsigndiscussion + + + + :param pki_ezsigndiscussion_id: The unique ID of the Ezsigndiscussion (required) + :type pki_ezsigndiscussion_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._ezsigndiscussion_delete_object_v1_serialize( + pki_ezsigndiscussion_id=pki_ezsigndiscussion_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndiscussionDeleteObjectV1Response", + '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 ezsigndiscussion_delete_object_v1_without_preload_content( + self, + pki_ezsigndiscussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Ezsigndiscussion")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, 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 Ezsigndiscussion + + + + :param pki_ezsigndiscussion_id: The unique ID of the Ezsigndiscussion (required) + :type pki_ezsigndiscussion_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._ezsigndiscussion_delete_object_v1_serialize( + pki_ezsigndiscussion_id=pki_ezsigndiscussion_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndiscussionDeleteObjectV1Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsigndiscussion_delete_object_v1_serialize( + self, + pki_ezsigndiscussion_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_ezsigndiscussion_id is not None: + _path_params['pkiEzsigndiscussionID'] = pki_ezsigndiscussion_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/ezsigndiscussion/{pkiEzsigndiscussionID}', + 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 ezsigndiscussion_get_object_v2( + self, + pki_ezsigndiscussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Ezsigndiscussion")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndiscussionGetObjectV2Response: + """Retrieve an existing Ezsigndiscussion + + + + :param pki_ezsigndiscussion_id: The unique ID of the Ezsigndiscussion (required) + :type pki_ezsigndiscussion_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._ezsigndiscussion_get_object_v2_serialize( + pki_ezsigndiscussion_id=pki_ezsigndiscussion_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndiscussionGetObjectV2Response", + '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 ezsigndiscussion_get_object_v2_with_http_info( + self, + pki_ezsigndiscussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Ezsigndiscussion")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndiscussionGetObjectV2Response]: + """Retrieve an existing Ezsigndiscussion + + + + :param pki_ezsigndiscussion_id: The unique ID of the Ezsigndiscussion (required) + :type pki_ezsigndiscussion_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._ezsigndiscussion_get_object_v2_serialize( + pki_ezsigndiscussion_id=pki_ezsigndiscussion_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndiscussionGetObjectV2Response", + '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 ezsigndiscussion_get_object_v2_without_preload_content( + self, + pki_ezsigndiscussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0, description="The unique ID of the Ezsigndiscussion")], + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, 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 Ezsigndiscussion + + + + :param pki_ezsigndiscussion_id: The unique ID of the Ezsigndiscussion (required) + :type pki_ezsigndiscussion_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._ezsigndiscussion_get_object_v2_serialize( + pki_ezsigndiscussion_id=pki_ezsigndiscussion_id, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndiscussionGetObjectV2Response", + '404': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsigndiscussion_get_object_v2_serialize( + self, + pki_ezsigndiscussion_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_ezsigndiscussion_id is not None: + _path_params['pkiEzsigndiscussionID'] = pki_ezsigndiscussion_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/ezsigndiscussion/{pkiEzsigndiscussionID}', + 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_ezsigndocument_api.py b/eZmaxApi/api/object_ezsigndocument_api.py index 8f837b786..b5aa549fc 100644 --- a/eZmaxApi/api/object_ezsigndocument_api.py +++ b/eZmaxApi/api/object_ezsigndocument_api.py @@ -34,6 +34,8 @@ from eZmaxApi.models.ezsigndocument_apply_ezsigntemplate_v1_response import EzsigndocumentApplyEzsigntemplateV1Response from eZmaxApi.models.ezsigndocument_apply_ezsigntemplate_v2_request import EzsigndocumentApplyEzsigntemplateV2Request from eZmaxApi.models.ezsigndocument_apply_ezsigntemplate_v2_response import EzsigndocumentApplyEzsigntemplateV2Response +from eZmaxApi.models.ezsigndocument_create_ezsignelements_positioned_by_word_v1_request import EzsigndocumentCreateEzsignelementsPositionedByWordV1Request +from eZmaxApi.models.ezsigndocument_create_ezsignelements_positioned_by_word_v1_response import EzsigndocumentCreateEzsignelementsPositionedByWordV1Response from eZmaxApi.models.ezsigndocument_create_object_v1_request import EzsigndocumentCreateObjectV1Request from eZmaxApi.models.ezsigndocument_create_object_v1_response import EzsigndocumentCreateObjectV1Response from eZmaxApi.models.ezsigndocument_create_object_v2_request import EzsigndocumentCreateObjectV2Request @@ -52,6 +54,7 @@ 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 +from eZmaxApi.models.ezsigndocument_get_ezsigndiscussions_v1_response import EzsigndocumentGetEzsigndiscussionsV1Response from eZmaxApi.models.ezsigndocument_get_ezsignformfieldgroups_v1_response import EzsigndocumentGetEzsignformfieldgroupsV1Response from eZmaxApi.models.ezsigndocument_get_ezsignpages_v1_response import EzsigndocumentGetEzsignpagesV1Response from eZmaxApi.models.ezsigndocument_get_ezsignsignatures_automatic_v1_response import EzsigndocumentGetEzsignsignaturesAutomaticV1Response @@ -673,6 +676,298 @@ def _ezsigndocument_apply_ezsigntemplate_v2_serialize( + @validate_call + def ezsigndocument_create_ezsignelements_positioned_by_word_v1( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigndocument_create_ezsignelements_positioned_by_word_v1_request: EzsigndocumentCreateEzsignelementsPositionedByWordV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> EzsigndocumentCreateEzsignelementsPositionedByWordV1Response: + """Create multiple Ezsignsignatures/Ezsignformfieldgroups + + Using this endpoint, you can create multiple Ezsignsignatures/Ezsignformfieldgroups positioned by word at the same time. + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param ezsigndocument_create_ezsignelements_positioned_by_word_v1_request: (required) + :type ezsigndocument_create_ezsignelements_positioned_by_word_v1_request: EzsigndocumentCreateEzsignelementsPositionedByWordV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores 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_ezsignelements_positioned_by_word_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + ezsigndocument_create_ezsignelements_positioned_by_word_v1_request=ezsigndocument_create_ezsignelements_positioned_by_word_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentCreateEzsignelementsPositionedByWordV1Response", + '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_create_ezsignelements_positioned_by_word_v1_with_http_info( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigndocument_create_ezsignelements_positioned_by_word_v1_request: EzsigndocumentCreateEzsignelementsPositionedByWordV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, Any]] = None, + _content_type: Optional[StrictStr] = None, + _headers: Optional[Dict[StrictStr, Any]] = None, + _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0, + ) -> ApiResponse[EzsigndocumentCreateEzsignelementsPositionedByWordV1Response]: + """Create multiple Ezsignsignatures/Ezsignformfieldgroups + + Using this endpoint, you can create multiple Ezsignsignatures/Ezsignformfieldgroups positioned by word at the same time. + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param ezsigndocument_create_ezsignelements_positioned_by_word_v1_request: (required) + :type ezsigndocument_create_ezsignelements_positioned_by_word_v1_request: EzsigndocumentCreateEzsignelementsPositionedByWordV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores 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_ezsignelements_positioned_by_word_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + ezsigndocument_create_ezsignelements_positioned_by_word_v1_request=ezsigndocument_create_ezsignelements_positioned_by_word_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentCreateEzsignelementsPositionedByWordV1Response", + '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_create_ezsignelements_positioned_by_word_v1_without_preload_content( + self, + pki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)], + ezsigndocument_create_ezsignelements_positioned_by_word_v1_request: EzsigndocumentCreateEzsignelementsPositionedByWordV1Request, + _request_timeout: Union[ + None, + Annotated[StrictFloat, Field(gt=0)], + Tuple[ + Annotated[StrictFloat, Field(gt=0)], + Annotated[StrictFloat, Field(gt=0)] + ] + ] = None, + _request_auth: Optional[Dict[StrictStr, 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 multiple Ezsignsignatures/Ezsignformfieldgroups + + Using this endpoint, you can create multiple Ezsignsignatures/Ezsignformfieldgroups positioned by word at the same time. + + :param pki_ezsigndocument_id: (required) + :type pki_ezsigndocument_id: int + :param ezsigndocument_create_ezsignelements_positioned_by_word_v1_request: (required) + :type ezsigndocument_create_ezsignelements_positioned_by_word_v1_request: EzsigndocumentCreateEzsignelementsPositionedByWordV1Request + :param _request_timeout: timeout setting for this request. If one + number provided, it will be total request + timeout. It can also be a pair (tuple) of + (connection, read) timeouts. + :type _request_timeout: int, tuple(int, int), optional + :param _request_auth: set to override the auth_settings for an a single + request; this effectively ignores the + authentication in the spec for a single request. + :type _request_auth: dict, optional + :param _content_type: force content-type for the request. + :type _content_type: str, Optional + :param _headers: set to override the headers for a single + request; this effectively ignores the headers + in the spec for a single request. + :type _headers: dict, optional + :param _host_index: set to override the host_index for a single + request; this effectively ignores 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_ezsignelements_positioned_by_word_v1_serialize( + pki_ezsigndocument_id=pki_ezsigndocument_id, + ezsigndocument_create_ezsignelements_positioned_by_word_v1_request=ezsigndocument_create_ezsignelements_positioned_by_word_v1_request, + _request_auth=_request_auth, + _content_type=_content_type, + _headers=_headers, + _host_index=_host_index + ) + + _response_types_map: Dict[str, Optional[str]] = { + '200': "EzsigndocumentCreateEzsignelementsPositionedByWordV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsigndocument_create_ezsignelements_positioned_by_word_v1_serialize( + self, + pki_ezsigndocument_id, + ezsigndocument_create_ezsignelements_positioned_by_word_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_create_ezsignelements_positioned_by_word_v1_request is not None: + _body_params = ezsigndocument_create_ezsignelements_positioned_by_word_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}/createEzsignelementsPositionedByWord', + 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_create_object_v1( self, @@ -3742,7 +4037,7 @@ def _ezsigndocument_get_completed_elements_v1_serialize( 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. ")], + 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 in current document if eEzsignfolderCompletion is PerEzsigndocument.
Is the final document once all signatures were applied in all documents if eEzsignfolderCompletion is PerEzsignfolder. 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)], @@ -3762,7 +4057,7 @@ def ezsigndocument_get_download_url_v1( :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) + :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 in current document if eEzsignfolderCompletion is PerEzsigndocument.
Is the final document once all signatures were applied in all documents if eEzsignfolderCompletion is PerEzsignfolder. 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 @@ -3815,7 +4110,7 @@ def ezsigndocument_get_download_url_v1( 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. ")], + 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 in current document if eEzsignfolderCompletion is PerEzsigndocument.
Is the final document once all signatures were applied in all documents if eEzsignfolderCompletion is PerEzsignfolder. 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)], @@ -3835,7 +4130,7 @@ def ezsigndocument_get_download_url_v1_with_http_info( :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) + :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 in current document if eEzsignfolderCompletion is PerEzsigndocument.
Is the final document once all signatures were applied in all documents if eEzsignfolderCompletion is PerEzsignfolder. 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 @@ -3888,7 +4183,7 @@ def ezsigndocument_get_download_url_v1_with_http_info( 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. ")], + 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 in current document if eEzsignfolderCompletion is PerEzsigndocument.
Is the final document once all signatures were applied in all documents if eEzsignfolderCompletion is PerEzsignfolder. 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)], @@ -3908,7 +4203,7 @@ def ezsigndocument_get_download_url_v1_without_preload_content( :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) + :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 in current document if eEzsignfolderCompletion is PerEzsigndocument.
Is the final document once all signatures were applied in all documents if eEzsignfolderCompletion is PerEzsignfolder. 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 @@ -4281,6 +4576,270 @@ def _ezsigndocument_get_ezsignannotations_v1_serialize( + @validate_call + def ezsigndocument_get_ezsigndiscussions_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, + ) -> EzsigndocumentGetEzsigndiscussionsV1Response: + """Retrieve an existing Ezsigndocument's Ezsigndiscussions + + + + :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_ezsigndiscussions_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': "EzsigndocumentGetEzsigndiscussionsV1Response", + '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_ezsigndiscussions_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[EzsigndocumentGetEzsigndiscussionsV1Response]: + """Retrieve an existing Ezsigndocument's Ezsigndiscussions + + + + :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_ezsigndiscussions_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': "EzsigndocumentGetEzsigndiscussionsV1Response", + '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_ezsigndiscussions_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 Ezsigndiscussions + + + + :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_ezsigndiscussions_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': "EzsigndocumentGetEzsigndiscussionsV1Response", + '404': "CommonResponseError", + '422': "CommonResponseError", + } + response_data = self.api_client.call_api( + *_param, + _request_timeout=_request_timeout + ) + return response_data.response + + + def _ezsigndocument_get_ezsigndiscussions_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}/getEzsigndiscussions', + 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_ezsignformfieldgroups_v1( self, diff --git a/eZmaxApi/models/__init__.py b/eZmaxApi/models/__init__.py index 8b03cd9a8..8672c20fb 100644 --- a/eZmaxApi/models/__init__.py +++ b/eZmaxApi/models/__init__.py @@ -182,7 +182,9 @@ from eZmaxApi.models.custom_communicationsender_request import CustomCommunicationsenderRequest from eZmaxApi.models.custom_communicationsender_response import CustomCommunicationsenderResponse from eZmaxApi.models.custom_contact_name_response import CustomContactNameResponse +from eZmaxApi.models.custom_create_ezsignelements_positioned_by_word_request import CustomCreateEzsignelementsPositionedByWordRequest from eZmaxApi.models.custom_creditcardtransaction_response import CustomCreditcardtransactionResponse +from eZmaxApi.models.custom_discussionconfiguration_response import CustomDiscussionconfigurationResponse from eZmaxApi.models.custom_dropdown_element_request import CustomDropdownElementRequest from eZmaxApi.models.custom_dropdown_element_request_compound import CustomDropdownElementRequestCompound from eZmaxApi.models.custom_dropdown_element_response import CustomDropdownElementResponse @@ -201,7 +203,9 @@ from eZmaxApi.models.custom_ezsignformfield_request import CustomEzsignformfieldRequest from eZmaxApi.models.custom_ezsignformfielderror_response import CustomEzsignformfielderrorResponse from eZmaxApi.models.custom_ezsignformfielderrortest_response import CustomEzsignformfielderrortestResponse +from eZmaxApi.models.custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request import CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest from eZmaxApi.models.custom_ezsignformfieldgroup_request import CustomEzsignformfieldgroupRequest +from eZmaxApi.models.custom_ezsignsignature_create_ezsignelements_positioned_by_word_request import CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest from eZmaxApi.models.custom_ezsignsignature_ezsignsignatures_automatic_response import CustomEzsignsignatureEzsignsignaturesAutomaticResponse from eZmaxApi.models.custom_ezsignsignaturestatus_response import CustomEzsignsignaturestatusResponse from eZmaxApi.models.custom_form_data_document_response import CustomFormDataDocumentResponse @@ -220,6 +224,40 @@ from eZmaxApi.models.department_autocomplete_element_response import DepartmentAutocompleteElementResponse from eZmaxApi.models.department_get_autocomplete_v2_response import DepartmentGetAutocompleteV2Response from eZmaxApi.models.department_get_autocomplete_v2_response_m_payload import DepartmentGetAutocompleteV2ResponseMPayload +from eZmaxApi.models.discussion_create_object_v1_request import DiscussionCreateObjectV1Request +from eZmaxApi.models.discussion_create_object_v1_response import DiscussionCreateObjectV1Response +from eZmaxApi.models.discussion_create_object_v1_response_m_payload import DiscussionCreateObjectV1ResponseMPayload +from eZmaxApi.models.discussion_delete_object_v1_response import DiscussionDeleteObjectV1Response +from eZmaxApi.models.discussion_get_object_v2_response import DiscussionGetObjectV2Response +from eZmaxApi.models.discussion_get_object_v2_response_m_payload import DiscussionGetObjectV2ResponseMPayload +from eZmaxApi.models.discussion_patch_object_v1_request import DiscussionPatchObjectV1Request +from eZmaxApi.models.discussion_patch_object_v1_response import DiscussionPatchObjectV1Response +from eZmaxApi.models.discussion_request import DiscussionRequest +from eZmaxApi.models.discussion_request_compound import DiscussionRequestCompound +from eZmaxApi.models.discussion_request_patch import DiscussionRequestPatch +from eZmaxApi.models.discussion_response import DiscussionResponse +from eZmaxApi.models.discussion_response_compound import DiscussionResponseCompound +from eZmaxApi.models.discussion_update_discussionreadstatus_v1_request import DiscussionUpdateDiscussionreadstatusV1Request +from eZmaxApi.models.discussion_update_discussionreadstatus_v1_response import DiscussionUpdateDiscussionreadstatusV1Response +from eZmaxApi.models.discussionmembership_create_object_v1_request import DiscussionmembershipCreateObjectV1Request +from eZmaxApi.models.discussionmembership_create_object_v1_response import DiscussionmembershipCreateObjectV1Response +from eZmaxApi.models.discussionmembership_create_object_v1_response_m_payload import DiscussionmembershipCreateObjectV1ResponseMPayload +from eZmaxApi.models.discussionmembership_delete_object_v1_response import DiscussionmembershipDeleteObjectV1Response +from eZmaxApi.models.discussionmembership_request import DiscussionmembershipRequest +from eZmaxApi.models.discussionmembership_request_compound import DiscussionmembershipRequestCompound +from eZmaxApi.models.discussionmembership_response import DiscussionmembershipResponse +from eZmaxApi.models.discussionmembership_response_compound import DiscussionmembershipResponseCompound +from eZmaxApi.models.discussionmessage_create_object_v1_request import DiscussionmessageCreateObjectV1Request +from eZmaxApi.models.discussionmessage_create_object_v1_response import DiscussionmessageCreateObjectV1Response +from eZmaxApi.models.discussionmessage_create_object_v1_response_m_payload import DiscussionmessageCreateObjectV1ResponseMPayload +from eZmaxApi.models.discussionmessage_delete_object_v1_response import DiscussionmessageDeleteObjectV1Response +from eZmaxApi.models.discussionmessage_patch_object_v1_request import DiscussionmessagePatchObjectV1Request +from eZmaxApi.models.discussionmessage_patch_object_v1_response import DiscussionmessagePatchObjectV1Response +from eZmaxApi.models.discussionmessage_request import DiscussionmessageRequest +from eZmaxApi.models.discussionmessage_request_compound import DiscussionmessageRequestCompound +from eZmaxApi.models.discussionmessage_request_patch import DiscussionmessageRequestPatch +from eZmaxApi.models.discussionmessage_response import DiscussionmessageResponse +from eZmaxApi.models.discussionmessage_response_compound import DiscussionmessageResponseCompound from eZmaxApi.models.electronicfundstransfer_get_communication_list_v1_response import ElectronicfundstransferGetCommunicationListV1Response from eZmaxApi.models.electronicfundstransfer_get_communication_list_v1_response_m_payload import ElectronicfundstransferGetCommunicationListV1ResponseMPayload from eZmaxApi.models.email_request import EmailRequest @@ -324,10 +362,23 @@ from eZmaxApi.models.ezsignbulksendtransmission_get_object_v2_response_m_payload import EzsignbulksendtransmissionGetObjectV2ResponseMPayload from eZmaxApi.models.ezsignbulksendtransmission_response import EzsignbulksendtransmissionResponse from eZmaxApi.models.ezsignbulksendtransmission_response_compound import EzsignbulksendtransmissionResponseCompound +from eZmaxApi.models.ezsigndiscussion_create_object_v1_request import EzsigndiscussionCreateObjectV1Request +from eZmaxApi.models.ezsigndiscussion_create_object_v1_response import EzsigndiscussionCreateObjectV1Response +from eZmaxApi.models.ezsigndiscussion_create_object_v1_response_m_payload import EzsigndiscussionCreateObjectV1ResponseMPayload +from eZmaxApi.models.ezsigndiscussion_delete_object_v1_response import EzsigndiscussionDeleteObjectV1Response +from eZmaxApi.models.ezsigndiscussion_get_object_v2_response import EzsigndiscussionGetObjectV2Response +from eZmaxApi.models.ezsigndiscussion_get_object_v2_response_m_payload import EzsigndiscussionGetObjectV2ResponseMPayload +from eZmaxApi.models.ezsigndiscussion_request import EzsigndiscussionRequest +from eZmaxApi.models.ezsigndiscussion_request_compound import EzsigndiscussionRequestCompound +from eZmaxApi.models.ezsigndiscussion_response import EzsigndiscussionResponse +from eZmaxApi.models.ezsigndiscussion_response_compound import EzsigndiscussionResponseCompound from eZmaxApi.models.ezsigndocument_apply_ezsigntemplate_v1_request import EzsigndocumentApplyEzsigntemplateV1Request from eZmaxApi.models.ezsigndocument_apply_ezsigntemplate_v1_response import EzsigndocumentApplyEzsigntemplateV1Response from eZmaxApi.models.ezsigndocument_apply_ezsigntemplate_v2_request import EzsigndocumentApplyEzsigntemplateV2Request from eZmaxApi.models.ezsigndocument_apply_ezsigntemplate_v2_response import EzsigndocumentApplyEzsigntemplateV2Response +from eZmaxApi.models.ezsigndocument_create_ezsignelements_positioned_by_word_v1_request import EzsigndocumentCreateEzsignelementsPositionedByWordV1Request +from eZmaxApi.models.ezsigndocument_create_ezsignelements_positioned_by_word_v1_response import EzsigndocumentCreateEzsignelementsPositionedByWordV1Response +from eZmaxApi.models.ezsigndocument_create_ezsignelements_positioned_by_word_v1_response_m_payload import EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload from eZmaxApi.models.ezsigndocument_create_object_v1_request import EzsigndocumentCreateObjectV1Request from eZmaxApi.models.ezsigndocument_create_object_v1_response import EzsigndocumentCreateObjectV1Response from eZmaxApi.models.ezsigndocument_create_object_v1_response_m_payload import EzsigndocumentCreateObjectV1ResponseMPayload @@ -355,6 +406,8 @@ from eZmaxApi.models.ezsigndocument_get_download_url_v1_response_m_payload import EzsigndocumentGetDownloadUrlV1ResponseMPayload from eZmaxApi.models.ezsigndocument_get_ezsignannotations_v1_response import EzsigndocumentGetEzsignannotationsV1Response from eZmaxApi.models.ezsigndocument_get_ezsignannotations_v1_response_m_payload import EzsigndocumentGetEzsignannotationsV1ResponseMPayload +from eZmaxApi.models.ezsigndocument_get_ezsigndiscussions_v1_response import EzsigndocumentGetEzsigndiscussionsV1Response +from eZmaxApi.models.ezsigndocument_get_ezsigndiscussions_v1_response_m_payload import EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload from eZmaxApi.models.ezsigndocument_get_ezsignformfieldgroups_v1_response import EzsigndocumentGetEzsignformfieldgroupsV1Response from eZmaxApi.models.ezsigndocument_get_ezsignformfieldgroups_v1_response_m_payload import EzsigndocumentGetEzsignformfieldgroupsV1ResponseMPayload from eZmaxApi.models.ezsigndocument_get_ezsignpages_v1_response import EzsigndocumentGetEzsignpagesV1Response @@ -769,6 +822,7 @@ from eZmaxApi.models.field_e_communicationexternalrecipient_type import FieldECommunicationexternalrecipientType from eZmaxApi.models.field_e_communicationrecipient_type import FieldECommunicationrecipientType from eZmaxApi.models.field_e_creditcardtype_codename import FieldECreditcardtypeCodename +from eZmaxApi.models.field_e_discussionmessage_status import FieldEDiscussionmessageStatus from eZmaxApi.models.field_e_error_code import FieldEErrorCode from eZmaxApi.models.field_e_ezmaxinvoicing_paymenttype import FieldEEzmaxinvoicingPaymenttype from eZmaxApi.models.field_e_ezmaxinvoicingagent_variationezmax import FieldEEzmaxinvoicingagentVariationezmax @@ -780,8 +834,10 @@ from eZmaxApi.models.field_e_ezsigndocumentlog_type import FieldEEzsigndocumentlogType from eZmaxApi.models.field_e_ezsignelementdependency_operator import FieldEEzsignelementdependencyOperator from eZmaxApi.models.field_e_ezsignelementdependency_validation import FieldEEzsignelementdependencyValidation +from eZmaxApi.models.field_e_ezsignfolder_completion import FieldEEzsignfolderCompletion from eZmaxApi.models.field_e_ezsignfolder_sendreminderfrequency import FieldEEzsignfolderSendreminderfrequency from eZmaxApi.models.field_e_ezsignfolder_step import FieldEEzsignfolderStep +from eZmaxApi.models.field_e_ezsignfoldertype_completion import FieldEEzsignfoldertypeCompletion 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 @@ -797,12 +853,16 @@ from eZmaxApi.models.field_e_ezsigntemplateelementdependency_operator import FieldEEzsigntemplateelementdependencyOperator from eZmaxApi.models.field_e_ezsigntemplateelementdependency_validation import FieldEEzsigntemplateelementdependencyValidation from eZmaxApi.models.field_e_ezsigntemplateformfield_dependencyrequirement import FieldEEzsigntemplateformfieldDependencyrequirement +from eZmaxApi.models.field_e_ezsigntemplateformfield_positioning import FieldEEzsigntemplateformfieldPositioning +from eZmaxApi.models.field_e_ezsigntemplateformfield_positioningoccurence import FieldEEzsigntemplateformfieldPositioningoccurence 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 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_positioning import FieldEEzsigntemplatesignaturePositioning +from eZmaxApi.models.field_e_ezsigntemplatesignature_positioningoccurence import FieldEEzsigntemplatesignaturePositioningoccurence from eZmaxApi.models.field_e_ezsigntemplatesignature_tooltipposition import FieldEEzsigntemplatesignatureTooltipposition from eZmaxApi.models.field_e_ezsigntemplatesignature_type import FieldEEzsigntemplatesignatureType from eZmaxApi.models.field_e_notificationpreference_status import FieldENotificationpreferenceStatus diff --git a/eZmaxApi/models/custom_create_ezsignelements_positioned_by_word_request.py b/eZmaxApi/models/custom_create_ezsignelements_positioned_by_word_request.py new file mode 100644 index 000000000..6ae068935 --- /dev/null +++ b/eZmaxApi/models/custom_create_ezsignelements_positioned_by_word_request.py @@ -0,0 +1,111 @@ +# 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, 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 CustomCreateEzsignelementsPositionedByWordRequest(BaseModel): + """ + A CreateEzsignelementsPositionedByWord object + """ # noqa: E501 + s_createezsignelementspositionedbyword_pattern: Annotated[str, Field(strict=True)] = Field(description="The word to search", alias="sCreateezsignelementspositionedbywordPattern") + i_createezsignelementspositionedbyword_offsetx: StrictInt = Field(description="The X offset", alias="iCreateezsignelementspositionedbywordOffsetx") + i_createezsignelementspositionedbyword_offsety: StrictInt = Field(description="The Y offset", alias="iCreateezsignelementspositionedbywordOffsety") + e_createezsignelementspositionedbyword_occurance: StrictStr = Field(description="The occurance in the search to add the ezsign element", alias="eCreateezsignelementspositionedbywordOccurance") + __properties: ClassVar[List[str]] = ["sCreateezsignelementspositionedbywordPattern", "iCreateezsignelementspositionedbywordOffsetx", "iCreateezsignelementspositionedbywordOffsety", "eCreateezsignelementspositionedbywordOccurance"] + + @field_validator('s_createezsignelementspositionedbyword_pattern') + def s_createezsignelementspositionedbyword_pattern_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^.{1,35}$", value): + raise ValueError(r"must validate the regular expression /^.{1,35}$/") + return value + + @field_validator('e_createezsignelementspositionedbyword_occurance') + def e_createezsignelementspositionedbyword_occurance_validate_enum(cls, value): + """Validates the enum""" + if value not in ('All', 'First', 'Last'): + raise ValueError("must be one of enum values ('All', 'First', 'Last')") + 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 CustomCreateEzsignelementsPositionedByWordRequest 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 CustomCreateEzsignelementsPositionedByWordRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "sCreateezsignelementspositionedbywordPattern": obj.get("sCreateezsignelementspositionedbywordPattern"), + "iCreateezsignelementspositionedbywordOffsetx": obj.get("iCreateezsignelementspositionedbywordOffsetx"), + "iCreateezsignelementspositionedbywordOffsety": obj.get("iCreateezsignelementspositionedbywordOffsety"), + "eCreateezsignelementspositionedbywordOccurance": obj.get("eCreateezsignelementspositionedbywordOccurance") + }) + return _obj + + diff --git a/eZmaxApi/models/custom_discussionconfiguration_response.py b/eZmaxApi/models/custom_discussionconfiguration_response.py new file mode 100644 index 000000000..94f23f8b1 --- /dev/null +++ b/eZmaxApi/models/custom_discussionconfiguration_response.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, StrictBool +from pydantic import Field +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class CustomDiscussionconfigurationResponse(BaseModel): + """ + A Custom Discussionconfiguration Object + """ # noqa: E501 + b_discussionconfiguration_completehistorywhenadded: StrictBool = Field(description="If the added Discussionmembership will have access to the entire history or not", alias="bDiscussionconfigurationCompletehistorywhenadded") + b_discussionconfiguration_createallowed: StrictBool = Field(description="If the the creation of the Discussion is allowed or not", alias="bDiscussionconfigurationCreateallowed") + b_discussionconfiguration_deleteallowed: StrictBool = Field(description="If the the destruction of the Discussion is allowed or not", alias="bDiscussionconfigurationDeleteallowed") + b_discussionconfiguration_deletediscussionmessageallowed: StrictBool = Field(description="If the the destruction of the Discussionmessage is allowed or not", alias="bDiscussionconfigurationDeletediscussionmessageallowed") + b_discussionconfiguration_editdiscussionmessageallowed: StrictBool = Field(description="If the the creation of the Discussionmessage is allowed or not", alias="bDiscussionconfigurationEditdiscussionmessageallowed") + __properties: ClassVar[List[str]] = ["bDiscussionconfigurationCompletehistorywhenadded", "bDiscussionconfigurationCreateallowed", "bDiscussionconfigurationDeleteallowed", "bDiscussionconfigurationDeletediscussionmessageallowed", "bDiscussionconfigurationEditdiscussionmessageallowed"] + + model_config = { + "populate_by_name": 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 CustomDiscussionconfigurationResponse 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 CustomDiscussionconfigurationResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "bDiscussionconfigurationCompletehistorywhenadded": obj.get("bDiscussionconfigurationCompletehistorywhenadded"), + "bDiscussionconfigurationCreateallowed": obj.get("bDiscussionconfigurationCreateallowed"), + "bDiscussionconfigurationDeleteallowed": obj.get("bDiscussionconfigurationDeleteallowed"), + "bDiscussionconfigurationDeletediscussionmessageallowed": obj.get("bDiscussionconfigurationDeletediscussionmessageallowed"), + "bDiscussionconfigurationEditdiscussionmessageallowed": obj.get("bDiscussionconfigurationEditdiscussionmessageallowed") + }) + return _obj + + diff --git a/eZmaxApi/models/custom_ezmaxinvoicing_ezsigndocument_response.py b/eZmaxApi/models/custom_ezmaxinvoicing_ezsigndocument_response.py index 8cfa27d99..d6a3566db 100644 --- a/eZmaxApi/models/custom_ezmaxinvoicing_ezsigndocument_response.py +++ b/eZmaxApi/models/custom_ezmaxinvoicing_ezsigndocument_response.py @@ -19,7 +19,7 @@ import json -from typing import Any, ClassVar, Dict, List +from typing import Any, ClassVar, Dict, List, Optional from pydantic import BaseModel, StrictBool, StrictStr from pydantic import Field from typing_extensions import Annotated @@ -33,11 +33,12 @@ class CustomEzmaxinvoicingEzsigndocumentResponse(BaseModel): 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") + fki_billingentityinternal_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Billingentityinternal.", alias="fkiBillingentityinternalID") 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"] + __properties: ClassVar[List[str]] = ["fkiEzsignfolderID", "fkiBillingentityinternalID", "sName", "sEzsignfolderDescription", "sEzsigndocumentName", "bEzsignfolderAllowed"] model_config = { "populate_by_name": True, @@ -89,6 +90,7 @@ def from_dict(cls, obj: Dict) -> Self: _obj = cls.model_validate({ "fkiEzsignfolderID": obj.get("fkiEzsignfolderID"), + "fkiBillingentityinternalID": obj.get("fkiBillingentityinternalID"), "sName": obj.get("sName"), "sEzsignfolderDescription": obj.get("sEzsignfolderDescription"), "sEzsigndocumentName": obj.get("sEzsigndocumentName"), diff --git a/eZmaxApi/models/custom_ezmaxinvoicing_ezsignfolder_response.py b/eZmaxApi/models/custom_ezmaxinvoicing_ezsignfolder_response.py index 70a6f1117..d7f9f30f8 100644 --- a/eZmaxApi/models/custom_ezmaxinvoicing_ezsignfolder_response.py +++ b/eZmaxApi/models/custom_ezmaxinvoicing_ezsignfolder_response.py @@ -19,7 +19,7 @@ import json -from typing import Any, ClassVar, Dict, List +from typing import Any, ClassVar, Dict, List, Optional from pydantic import BaseModel, StrictBool, StrictStr from pydantic import Field from typing_extensions import Annotated @@ -33,12 +33,13 @@ class CustomEzmaxinvoicingEzsignfolderResponse(BaseModel): 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") + fki_billingentityinternal_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Billingentityinternal.", alias="fkiBillingentityinternalID") 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"] + __properties: ClassVar[List[str]] = ["fkiEzsignfolderID", "fkiBillingentityinternalID", "sEzsignfolderDescription", "bEzsigntsarequirementBillable", "bEzsignfolderMfaused", "bEzsignfolderPaymentused", "bEzsignfolderAllowed"] model_config = { "populate_by_name": True, @@ -90,6 +91,7 @@ def from_dict(cls, obj: Dict) -> Self: _obj = cls.model_validate({ "fkiEzsignfolderID": obj.get("fkiEzsignfolderID"), + "fkiBillingentityinternalID": obj.get("fkiBillingentityinternalID"), "sEzsignfolderDescription": obj.get("sEzsignfolderDescription"), "bEzsigntsarequirementBillable": obj.get("bEzsigntsarequirementBillable"), "bEzsignfolderMfaused": obj.get("bEzsignfolderMfaused"), diff --git a/eZmaxApi/models/custom_ezsignfoldertype_response.py b/eZmaxApi/models/custom_ezsignfoldertype_response.py index d82dcb23e..800ae1974 100644 --- a/eZmaxApi/models/custom_ezsignfoldertype_response.py +++ b/eZmaxApi/models/custom_ezsignfoldertype_response.py @@ -41,7 +41,9 @@ class CustomEzsignfoldertypeResponse(BaseModel): 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"] + b_ezsignfoldertype_reassignezsignsigner: Optional[StrictBool] = Field(default=None, description="Wheter if Reassignment of signature is allowed by a signatory to another signatory or not", alias="bEzsignfoldertypeReassignezsignsigner") + b_ezsignfoldertype_reassignuser: Optional[StrictBool] = Field(default=None, description="Wheter if Reassignment of signature is allowed by a user to a signatory or another user or not", alias="bEzsignfoldertypeReassignuser") + __properties: ClassVar[List[str]] = ["pkiEzsignfoldertypeID", "sEzsignfoldertypeNameX", "bEzsignfoldertypeSendproofezsignsigner", "bEzsignfoldertypeIncludeproofsigner", "bEzsignfoldertypeIncludeproofuser", "bEzsignfoldertypeAllowdownloadattachmentezsignsigner", "bEzsignfoldertypeAllowdownloadproofezsignsigner", "bEzsignfoldertypeDelegate", "bEzsignfoldertypeReassign", "bEzsignfoldertypeReassignezsignsigner", "bEzsignfoldertypeReassignuser"] model_config = { "populate_by_name": True, @@ -100,7 +102,9 @@ def from_dict(cls, obj: Dict) -> Self: "bEzsignfoldertypeAllowdownloadattachmentezsignsigner": obj.get("bEzsignfoldertypeAllowdownloadattachmentezsignsigner"), "bEzsignfoldertypeAllowdownloadproofezsignsigner": obj.get("bEzsignfoldertypeAllowdownloadproofezsignsigner"), "bEzsignfoldertypeDelegate": obj.get("bEzsignfoldertypeDelegate"), - "bEzsignfoldertypeReassign": obj.get("bEzsignfoldertypeReassign") + "bEzsignfoldertypeReassign": obj.get("bEzsignfoldertypeReassign"), + "bEzsignfoldertypeReassignezsignsigner": obj.get("bEzsignfoldertypeReassignezsignsigner"), + "bEzsignfoldertypeReassignuser": obj.get("bEzsignfoldertypeReassignuser") }) return _obj diff --git a/eZmaxApi/models/custom_ezsignformfield_request.py b/eZmaxApi/models/custom_ezsignformfield_request.py index b8760bb25..9bb082f8a 100644 --- a/eZmaxApi/models/custom_ezsignformfield_request.py +++ b/eZmaxApi/models/custom_ezsignformfield_request.py @@ -35,7 +35,7 @@ class CustomEzsignformfieldRequest(BaseModel): 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") + 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** You can use the codes below and they will be replaced at signature time. | Code | Description | Example | | ------------------------- | ------------ | ------------ | | {sUserFirstname} | The first name of the contact | John | | {sUserLastname} | The last name of the contact | Doe | | {sUserJobtitle} | The job title | Sales Representative | | {sEmailAddress} | The email address | email@example.com | | {sPhoneE164} | A phone number in E.164 Format | +15149901516 | | {sPhoneE164Cell} | A phone number in E.164 Format | +15149901516 |", alias="sEzsignformfieldEnteredvalue") __properties: ClassVar[List[str]] = ["pkiEzsignformfieldID", "sEzsignformfieldLabel", "bEzsignformfieldSelected", "sEzsignformfieldEnteredvalue"] model_config = { diff --git a/eZmaxApi/models/custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request.py b/eZmaxApi/models/custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request.py new file mode 100644 index 000000000..d3fdd890c --- /dev/null +++ b/eZmaxApi/models/custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request.py @@ -0,0 +1,171 @@ +# 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, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +from eZmaxApi.models.custom_create_ezsignelements_positioned_by_word_request import CustomCreateEzsignelementsPositionedByWordRequest +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 +from eZmaxApi.models.ezsignformfieldgroupsigner_request_compound import EzsignformfieldgroupsignerRequestCompound +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 CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest(BaseModel): + """ + An Ezsignformfieldgroup Object in the context of a createEzsignelementsPositionedByWord path + """ # 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") + obj_createezsignelementspositionedbyword: CustomCreateEzsignelementsPositionedByWordRequest = Field(alias="objCreateezsignelementspositionedbyword") + __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", "objCreateezsignelementspositionedbyword"] + + @field_validator('s_ezsignformfieldgroup_regexp') + def s_ezsignformfieldgroup_regexp_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^\^.*\$$|^$", value): + raise ValueError(r"must validate the regular expression /^\^.*\$$|^$/") + 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 CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest 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_ezsignformfieldgroupsigner (list) + _items = [] + if self.a_obj_ezsignformfieldgroupsigner: + for _item in self.a_obj_ezsignformfieldgroupsigner: + if _item: + _items.append(_item.to_dict()) + _dict['a_objEzsignformfieldgroupsigner'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in a_obj_dropdown_element (list) + _items = [] + if self.a_obj_dropdown_element: + for _item in self.a_obj_dropdown_element: + if _item: + _items.append(_item.to_dict()) + _dict['a_objDropdownElement'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignformfield (list) + _items = [] + if self.a_obj_ezsignformfield: + for _item in self.a_obj_ezsignformfield: + if _item: + _items.append(_item.to_dict()) + _dict['a_objEzsignformfield'] = _items + # override the default output from pydantic by calling `to_dict()` of obj_createezsignelementspositionedbyword + if self.obj_createezsignelementspositionedbyword: + _dict['objCreateezsignelementspositionedbyword'] = self.obj_createezsignelementspositionedbyword.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + 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, + "objCreateezsignelementspositionedbyword": CustomCreateEzsignelementsPositionedByWordRequest.from_dict(obj.get("objCreateezsignelementspositionedbyword")) if obj.get("objCreateezsignelementspositionedbyword") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/custom_ezsignsignature_create_ezsignelements_positioned_by_word_request.py b/eZmaxApi/models/custom_ezsignsignature_create_ezsignelements_positioned_by_word_request.py new file mode 100644 index 000000000..9bae5ba5d --- /dev/null +++ b/eZmaxApi/models/custom_ezsignsignature_create_ezsignelements_positioned_by_word_request.py @@ -0,0 +1,177 @@ +# 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, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +from eZmaxApi.models.custom_create_ezsignelements_positioned_by_word_request import CustomCreateEzsignelementsPositionedByWordRequest +from eZmaxApi.models.enum_textvalidation import EnumTextvalidation +from eZmaxApi.models.ezsignelementdependency_request_compound import EzsignelementdependencyRequestCompound +from eZmaxApi.models.ezsignsignaturecustomdate_request_compound import EzsignsignaturecustomdateRequestCompound +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 CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest(BaseModel): + """ + An Ezsignsignature Object in the context of an CreateEzsignelementsPositionedByWord path + """ # 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") + obj_createezsignelementspositionedbyword: CustomCreateEzsignelementsPositionedByWordRequest = Field(alias="objCreateezsignelementspositionedbyword") + __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", "objCreateezsignelementspositionedbyword"] + + @field_validator('s_ezsignsignature_regexp') + def s_ezsignsignature_regexp_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^\^.*\$$|^$", value): + raise ValueError(r"must validate the regular expression /^\^.*\$$|^$/") + 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 CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest 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_ezsignsignaturecustomdate (list) + _items = [] + if self.a_obj_ezsignsignaturecustomdate: + for _item in self.a_obj_ezsignsignaturecustomdate: + if _item: + _items.append(_item.to_dict()) + _dict['a_objEzsignsignaturecustomdate'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignelementdependency (list) + _items = [] + if self.a_obj_ezsignelementdependency: + for _item in self.a_obj_ezsignelementdependency: + if _item: + _items.append(_item.to_dict()) + _dict['a_objEzsignelementdependency'] = _items + # override the default output from pydantic by calling `to_dict()` of obj_createezsignelementspositionedbyword + if self.obj_createezsignelementspositionedbyword: + _dict['objCreateezsignelementspositionedbyword'] = self.obj_createezsignelementspositionedbyword.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + 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, + "objCreateezsignelementspositionedbyword": CustomCreateEzsignelementsPositionedByWordRequest.from_dict(obj.get("objCreateezsignelementspositionedbyword")) if obj.get("objCreateezsignelementspositionedbyword") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/custom_webhook_response.py b/eZmaxApi/models/custom_webhook_response.py index 5b444bb52..e3c23cc6a 100644 --- a/eZmaxApi/models/custom_webhook_response.py +++ b/eZmaxApi/models/custom_webhook_response.py @@ -23,6 +23,7 @@ from pydantic import BaseModel, StrictBool, StrictInt, StrictStr from pydantic import Field from typing_extensions import Annotated +from eZmaxApi.models.common_audit import CommonAudit 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 @@ -49,9 +50,10 @@ class CustomWebhookResponse(BaseModel): 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") + obj_audit: CommonAudit = Field(alias="objAudit") 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"] + __properties: ClassVar[List[str]] = ["pkiWebhookID", "sWebhookDescription", "fkiEzsignfoldertypeID", "sEzsignfoldertypeNameX", "eWebhookModule", "eWebhookEzsignevent", "eWebhookManagementevent", "sWebhookUrl", "sWebhookEmailfailed", "sWebhookApikey", "sWebhookSecret", "bWebhookIsactive", "bWebhookIssigned", "bWebhookSkipsslvalidation", "objAudit", "pksCustomerCode", "bWebhookTest"] model_config = { "populate_by_name": True, @@ -90,6 +92,9 @@ def to_dict(self) -> Dict[str, Any]: }, 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 @@ -116,6 +121,7 @@ def from_dict(cls, obj: Dict) -> Self: "bWebhookIsactive": obj.get("bWebhookIsactive"), "bWebhookIssigned": obj.get("bWebhookIssigned"), "bWebhookSkipsslvalidation": obj.get("bWebhookSkipsslvalidation"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None, "pksCustomerCode": obj.get("pksCustomerCode"), "bWebhookTest": obj.get("bWebhookTest") }) diff --git a/eZmaxApi/models/discussion_create_object_v1_request.py b/eZmaxApi/models/discussion_create_object_v1_request.py new file mode 100644 index 000000000..11db3666a --- /dev/null +++ b/eZmaxApi/models/discussion_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.discussion_request_compound import DiscussionRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class DiscussionCreateObjectV1Request(BaseModel): + """ + Request for POST /1/object/discussion + """ # noqa: E501 + a_obj_discussion: Annotated[List[DiscussionRequestCompound], Field(min_length=1)] = Field(alias="a_objDiscussion") + __properties: ClassVar[List[str]] = ["a_objDiscussion"] + + model_config = { + "populate_by_name": 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 DiscussionCreateObjectV1Request 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_discussion (list) + _items = [] + if self.a_obj_discussion: + for _item in self.a_obj_discussion: + if _item: + _items.append(_item.to_dict()) + _dict['a_objDiscussion'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of DiscussionCreateObjectV1Request from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "a_objDiscussion": [DiscussionRequestCompound.from_dict(_item) for _item in obj.get("a_objDiscussion")] if obj.get("a_objDiscussion") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/discussion_create_object_v1_response.py b/eZmaxApi/models/discussion_create_object_v1_response.py new file mode 100644 index 000000000..d30460fec --- /dev/null +++ b/eZmaxApi/models/discussion_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.discussion_create_object_v1_response_m_payload import DiscussionCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class DiscussionCreateObjectV1Response(BaseModel): + """ + Response for POST /1/object/discussion + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: DiscussionCreateObjectV1ResponseMPayload = 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 DiscussionCreateObjectV1Response 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 DiscussionCreateObjectV1Response 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": DiscussionCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/discussion_create_object_v1_response_m_payload.py b/eZmaxApi/models/discussion_create_object_v1_response_m_payload.py new file mode 100644 index 000000000..863d426b0 --- /dev/null +++ b/eZmaxApi/models/discussion_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 DiscussionCreateObjectV1ResponseMPayload(BaseModel): + """ + Payload for POST /1/object/discussion + """ # noqa: E501 + a_pki_discussion_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_pkiDiscussionID") + __properties: ClassVar[List[str]] = ["a_pkiDiscussionID"] + + model_config = { + "populate_by_name": 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 DiscussionCreateObjectV1ResponseMPayload 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 DiscussionCreateObjectV1ResponseMPayload from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "a_pkiDiscussionID": obj.get("a_pkiDiscussionID") + }) + return _obj + + diff --git a/eZmaxApi/models/discussion_delete_object_v1_response.py b/eZmaxApi/models/discussion_delete_object_v1_response.py new file mode 100644 index 000000000..d973e1844 --- /dev/null +++ b/eZmaxApi/models/discussion_delete_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 DiscussionDeleteObjectV1Response(BaseModel): + """ + Response for DELETE /1/object/discussion/{pkiDiscussionID} + """ # 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 DiscussionDeleteObjectV1Response 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 DiscussionDeleteObjectV1Response 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/discussion_get_object_v2_response.py b/eZmaxApi/models/discussion_get_object_v2_response.py new file mode 100644 index 000000000..753bc0cd5 --- /dev/null +++ b/eZmaxApi/models/discussion_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.discussion_get_object_v2_response_m_payload import DiscussionGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class DiscussionGetObjectV2Response(BaseModel): + """ + Response for GET /2/object/discussion/{pkiDiscussionID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: DiscussionGetObjectV2ResponseMPayload = 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 DiscussionGetObjectV2Response 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 DiscussionGetObjectV2Response 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": DiscussionGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/discussion_get_object_v2_response_m_payload.py b/eZmaxApi/models/discussion_get_object_v2_response_m_payload.py new file mode 100644 index 000000000..56af43b0b --- /dev/null +++ b/eZmaxApi/models/discussion_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.discussion_response_compound import DiscussionResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class DiscussionGetObjectV2ResponseMPayload(BaseModel): + """ + Payload for GET /2/object/discussion/{pkiDiscussionID} + """ # noqa: E501 + obj_discussion: DiscussionResponseCompound = Field(alias="objDiscussion") + __properties: ClassVar[List[str]] = ["objDiscussion"] + + model_config = { + "populate_by_name": 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 DiscussionGetObjectV2ResponseMPayload 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_discussion + if self.obj_discussion: + _dict['objDiscussion'] = self.obj_discussion.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of DiscussionGetObjectV2ResponseMPayload from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "objDiscussion": DiscussionResponseCompound.from_dict(obj.get("objDiscussion")) if obj.get("objDiscussion") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/discussion_patch_object_v1_request.py b/eZmaxApi/models/discussion_patch_object_v1_request.py new file mode 100644 index 000000000..49a7e52f7 --- /dev/null +++ b/eZmaxApi/models/discussion_patch_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.discussion_request_patch import DiscussionRequestPatch +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class DiscussionPatchObjectV1Request(BaseModel): + """ + Request for PATCH /1/object/discussion/{pkiDiscussionID} + """ # noqa: E501 + obj_discussion: DiscussionRequestPatch = Field(alias="objDiscussion") + __properties: ClassVar[List[str]] = ["objDiscussion"] + + model_config = { + "populate_by_name": 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 DiscussionPatchObjectV1Request 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_discussion + if self.obj_discussion: + _dict['objDiscussion'] = self.obj_discussion.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of DiscussionPatchObjectV1Request from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "objDiscussion": DiscussionRequestPatch.from_dict(obj.get("objDiscussion")) if obj.get("objDiscussion") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/discussion_patch_object_v1_response.py b/eZmaxApi/models/discussion_patch_object_v1_response.py new file mode 100644 index 000000000..6276e0f2a --- /dev/null +++ b/eZmaxApi/models/discussion_patch_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 DiscussionPatchObjectV1Response(BaseModel): + """ + Response for PATCH /1/object/discussion/{pkiDiscussionID} + """ # 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 DiscussionPatchObjectV1Response 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 DiscussionPatchObjectV1Response 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/discussion_request.py b/eZmaxApi/models/discussion_request.py new file mode 100644 index 000000000..5e43b5d82 --- /dev/null +++ b/eZmaxApi/models/discussion_request.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, Optional +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 DiscussionRequest(BaseModel): + """ + A Discussion Object + """ # noqa: E501 + pki_discussion_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Discussion", alias="pkiDiscussionID") + s_discussion_description: Annotated[str, Field(strict=True)] = Field(description="The description of the Discussion", alias="sDiscussionDescription") + b_discussion_closed: Optional[StrictBool] = Field(default=None, description="Whether if it's an closed", alias="bDiscussionClosed") + __properties: ClassVar[List[str]] = ["pkiDiscussionID", "sDiscussionDescription", "bDiscussionClosed"] + + @field_validator('s_discussion_description') + def s_discussion_description_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 + + model_config = { + "populate_by_name": 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 DiscussionRequest 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 DiscussionRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiDiscussionID": obj.get("pkiDiscussionID"), + "sDiscussionDescription": obj.get("sDiscussionDescription"), + "bDiscussionClosed": obj.get("bDiscussionClosed") + }) + return _obj + + diff --git a/eZmaxApi/models/discussion_request_compound.py b/eZmaxApi/models/discussion_request_compound.py new file mode 100644 index 000000000..dc667b7e3 --- /dev/null +++ b/eZmaxApi/models/discussion_request_compound.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, Optional +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 DiscussionRequestCompound(BaseModel): + """ + A Discussion Object and children + """ # noqa: E501 + pki_discussion_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Discussion", alias="pkiDiscussionID") + s_discussion_description: Annotated[str, Field(strict=True)] = Field(description="The description of the Discussion", alias="sDiscussionDescription") + b_discussion_closed: Optional[StrictBool] = Field(default=None, description="Whether if it's an closed", alias="bDiscussionClosed") + __properties: ClassVar[List[str]] = ["pkiDiscussionID", "sDiscussionDescription", "bDiscussionClosed"] + + @field_validator('s_discussion_description') + def s_discussion_description_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 + + model_config = { + "populate_by_name": 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 DiscussionRequestCompound 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 DiscussionRequestCompound from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiDiscussionID": obj.get("pkiDiscussionID"), + "sDiscussionDescription": obj.get("sDiscussionDescription"), + "bDiscussionClosed": obj.get("bDiscussionClosed") + }) + return _obj + + diff --git a/eZmaxApi/models/discussion_request_patch.py b/eZmaxApi/models/discussion_request_patch.py new file mode 100644 index 000000000..643aebe4d --- /dev/null +++ b/eZmaxApi/models/discussion_request_patch.py @@ -0,0 +1,103 @@ +# 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, field_validator +from pydantic import Field +from typing_extensions import Annotated +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class DiscussionRequestPatch(BaseModel): + """ + A Discussion Object + """ # noqa: E501 + s_discussion_description: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The description of the Discussion", alias="sDiscussionDescription") + b_discussion_closed: Optional[StrictBool] = Field(default=None, description="Whether if it's an closed", alias="bDiscussionClosed") + __properties: ClassVar[List[str]] = ["sDiscussionDescription", "bDiscussionClosed"] + + @field_validator('s_discussion_description') + def s_discussion_description_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 DiscussionRequestPatch 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 DiscussionRequestPatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "sDiscussionDescription": obj.get("sDiscussionDescription"), + "bDiscussionClosed": obj.get("bDiscussionClosed") + }) + return _obj + + diff --git a/eZmaxApi/models/discussion_response.py b/eZmaxApi/models/discussion_response.py new file mode 100644 index 000000000..0575abcae --- /dev/null +++ b/eZmaxApi/models/discussion_response.py @@ -0,0 +1,114 @@ +# 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, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +from eZmaxApi.models.custom_discussionconfiguration_response import CustomDiscussionconfigurationResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class DiscussionResponse(BaseModel): + """ + A Discussion Object + """ # noqa: E501 + pki_discussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The unique ID of the Discussion", alias="pkiDiscussionID") + s_discussion_description: Annotated[str, Field(strict=True)] = Field(description="The description of the Discussion", alias="sDiscussionDescription") + b_discussion_closed: StrictBool = Field(description="Whether if it's an closed", alias="bDiscussionClosed") + dt_discussion_lastread: Optional[StrictStr] = Field(default=None, description="The date the Discussion was last read", alias="dtDiscussionLastread") + i_discussionmessage_count: StrictInt = Field(description="The count of Attachment.", alias="iDiscussionmessageCount") + i_discussionmessage_countunread: StrictInt = Field(description="The count of Attachment.", alias="iDiscussionmessageCountunread") + obj_discussionconfiguration: Optional[CustomDiscussionconfigurationResponse] = Field(default=None, alias="objDiscussionconfiguration") + __properties: ClassVar[List[str]] = ["pkiDiscussionID", "sDiscussionDescription", "bDiscussionClosed", "dtDiscussionLastread", "iDiscussionmessageCount", "iDiscussionmessageCountunread", "objDiscussionconfiguration"] + + @field_validator('s_discussion_description') + def s_discussion_description_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 + + model_config = { + "populate_by_name": 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 DiscussionResponse 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_discussionconfiguration + if self.obj_discussionconfiguration: + _dict['objDiscussionconfiguration'] = self.obj_discussionconfiguration.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of DiscussionResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiDiscussionID": obj.get("pkiDiscussionID"), + "sDiscussionDescription": obj.get("sDiscussionDescription"), + "bDiscussionClosed": obj.get("bDiscussionClosed"), + "dtDiscussionLastread": obj.get("dtDiscussionLastread"), + "iDiscussionmessageCount": obj.get("iDiscussionmessageCount"), + "iDiscussionmessageCountunread": obj.get("iDiscussionmessageCountunread"), + "objDiscussionconfiguration": CustomDiscussionconfigurationResponse.from_dict(obj.get("objDiscussionconfiguration")) if obj.get("objDiscussionconfiguration") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/discussion_response_compound.py b/eZmaxApi/models/discussion_response_compound.py new file mode 100644 index 000000000..5839268b2 --- /dev/null +++ b/eZmaxApi/models/discussion_response_compound.py @@ -0,0 +1,134 @@ +# 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, StrictStr, field_validator +from pydantic import Field +from typing_extensions import Annotated +from eZmaxApi.models.custom_discussionconfiguration_response import CustomDiscussionconfigurationResponse +from eZmaxApi.models.discussionmembership_response_compound import DiscussionmembershipResponseCompound +from eZmaxApi.models.discussionmessage_response_compound import DiscussionmessageResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class DiscussionResponseCompound(BaseModel): + """ + A Discussion Object + """ # noqa: E501 + pki_discussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The unique ID of the Discussion", alias="pkiDiscussionID") + s_discussion_description: Annotated[str, Field(strict=True)] = Field(description="The description of the Discussion", alias="sDiscussionDescription") + b_discussion_closed: StrictBool = Field(description="Whether if it's an closed", alias="bDiscussionClosed") + dt_discussion_lastread: Optional[StrictStr] = Field(default=None, description="The date the Discussion was last read", alias="dtDiscussionLastread") + i_discussionmessage_count: StrictInt = Field(description="The count of Attachment.", alias="iDiscussionmessageCount") + i_discussionmessage_countunread: StrictInt = Field(description="The count of Attachment.", alias="iDiscussionmessageCountunread") + obj_discussionconfiguration: Optional[CustomDiscussionconfigurationResponse] = Field(default=None, alias="objDiscussionconfiguration") + a_obj_discussionmembership: List[DiscussionmembershipResponseCompound] = Field(alias="a_objDiscussionmembership") + a_obj_discussionmessage: List[DiscussionmessageResponseCompound] = Field(alias="a_objDiscussionmessage") + __properties: ClassVar[List[str]] = ["pkiDiscussionID", "sDiscussionDescription", "bDiscussionClosed", "dtDiscussionLastread", "iDiscussionmessageCount", "iDiscussionmessageCountunread", "objDiscussionconfiguration", "a_objDiscussionmembership", "a_objDiscussionmessage"] + + @field_validator('s_discussion_description') + def s_discussion_description_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 + + model_config = { + "populate_by_name": 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 DiscussionResponseCompound 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_discussionconfiguration + if self.obj_discussionconfiguration: + _dict['objDiscussionconfiguration'] = self.obj_discussionconfiguration.to_dict() + # override the default output from pydantic by calling `to_dict()` of each item in a_obj_discussionmembership (list) + _items = [] + if self.a_obj_discussionmembership: + for _item in self.a_obj_discussionmembership: + if _item: + _items.append(_item.to_dict()) + _dict['a_objDiscussionmembership'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in a_obj_discussionmessage (list) + _items = [] + if self.a_obj_discussionmessage: + for _item in self.a_obj_discussionmessage: + if _item: + _items.append(_item.to_dict()) + _dict['a_objDiscussionmessage'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of DiscussionResponseCompound from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiDiscussionID": obj.get("pkiDiscussionID"), + "sDiscussionDescription": obj.get("sDiscussionDescription"), + "bDiscussionClosed": obj.get("bDiscussionClosed"), + "dtDiscussionLastread": obj.get("dtDiscussionLastread"), + "iDiscussionmessageCount": obj.get("iDiscussionmessageCount"), + "iDiscussionmessageCountunread": obj.get("iDiscussionmessageCountunread"), + "objDiscussionconfiguration": CustomDiscussionconfigurationResponse.from_dict(obj.get("objDiscussionconfiguration")) if obj.get("objDiscussionconfiguration") is not None else None, + "a_objDiscussionmembership": [DiscussionmembershipResponseCompound.from_dict(_item) for _item in obj.get("a_objDiscussionmembership")] if obj.get("a_objDiscussionmembership") is not None else None, + "a_objDiscussionmessage": [DiscussionmessageResponseCompound.from_dict(_item) for _item in obj.get("a_objDiscussionmessage")] if obj.get("a_objDiscussionmessage") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/discussion_update_discussionreadstatus_v1_request.py b/eZmaxApi/models/discussion_update_discussionreadstatus_v1_request.py new file mode 100644 index 000000000..823b2b91c --- /dev/null +++ b/eZmaxApi/models/discussion_update_discussionreadstatus_v1_request.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, 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 DiscussionUpdateDiscussionreadstatusV1Request(BaseModel): + """ + Request for POST /1/object/discussion/{pkiDiscussionID}/updateDiscussionreadstatus + """ # noqa: E501 + dt_discussionreadstatus_date: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The date of the last discussion message read", alias="dtDiscussionreadstatusDate") + __properties: ClassVar[List[str]] = ["dtDiscussionreadstatusDate"] + + @field_validator('dt_discussionreadstatus_date') + def dt_discussionreadstatus_date_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]) ([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 + + model_config = { + "populate_by_name": 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 DiscussionUpdateDiscussionreadstatusV1Request 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 DiscussionUpdateDiscussionreadstatusV1Request from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "dtDiscussionreadstatusDate": obj.get("dtDiscussionreadstatusDate") + }) + return _obj + + diff --git a/eZmaxApi/models/discussion_update_discussionreadstatus_v1_response.py b/eZmaxApi/models/discussion_update_discussionreadstatus_v1_response.py new file mode 100644 index 000000000..d5361613d --- /dev/null +++ b/eZmaxApi/models/discussion_update_discussionreadstatus_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 DiscussionUpdateDiscussionreadstatusV1Response(BaseModel): + """ + Response for GET /1/object/discussion/{pkiDiscussionID}/updateDiscussionreadstatus + """ # 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 DiscussionUpdateDiscussionreadstatusV1Response 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 DiscussionUpdateDiscussionreadstatusV1Response 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/discussionmembership_create_object_v1_request.py b/eZmaxApi/models/discussionmembership_create_object_v1_request.py new file mode 100644 index 000000000..ac2ea26da --- /dev/null +++ b/eZmaxApi/models/discussionmembership_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.discussionmembership_request_compound import DiscussionmembershipRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class DiscussionmembershipCreateObjectV1Request(BaseModel): + """ + Request for POST /1/object/discussionmembership + """ # noqa: E501 + a_obj_discussionmembership: Annotated[List[DiscussionmembershipRequestCompound], Field(min_length=1)] = Field(alias="a_objDiscussionmembership") + __properties: ClassVar[List[str]] = ["a_objDiscussionmembership"] + + model_config = { + "populate_by_name": 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 DiscussionmembershipCreateObjectV1Request 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_discussionmembership (list) + _items = [] + if self.a_obj_discussionmembership: + for _item in self.a_obj_discussionmembership: + if _item: + _items.append(_item.to_dict()) + _dict['a_objDiscussionmembership'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of DiscussionmembershipCreateObjectV1Request from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "a_objDiscussionmembership": [DiscussionmembershipRequestCompound.from_dict(_item) for _item in obj.get("a_objDiscussionmembership")] if obj.get("a_objDiscussionmembership") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/discussionmembership_create_object_v1_response.py b/eZmaxApi/models/discussionmembership_create_object_v1_response.py new file mode 100644 index 000000000..18bb49115 --- /dev/null +++ b/eZmaxApi/models/discussionmembership_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.discussionmembership_create_object_v1_response_m_payload import DiscussionmembershipCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class DiscussionmembershipCreateObjectV1Response(BaseModel): + """ + Response for POST /1/object/discussionmembership + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: DiscussionmembershipCreateObjectV1ResponseMPayload = 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 DiscussionmembershipCreateObjectV1Response 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 DiscussionmembershipCreateObjectV1Response 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": DiscussionmembershipCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/discussionmembership_create_object_v1_response_m_payload.py b/eZmaxApi/models/discussionmembership_create_object_v1_response_m_payload.py new file mode 100644 index 000000000..c3b7f77ee --- /dev/null +++ b/eZmaxApi/models/discussionmembership_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 DiscussionmembershipCreateObjectV1ResponseMPayload(BaseModel): + """ + Payload for POST /1/object/discussionmembership + """ # noqa: E501 + a_pki_discussionmembership_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_pkiDiscussionmembershipID") + __properties: ClassVar[List[str]] = ["a_pkiDiscussionmembershipID"] + + model_config = { + "populate_by_name": 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 DiscussionmembershipCreateObjectV1ResponseMPayload 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 DiscussionmembershipCreateObjectV1ResponseMPayload from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "a_pkiDiscussionmembershipID": obj.get("a_pkiDiscussionmembershipID") + }) + return _obj + + diff --git a/eZmaxApi/models/discussionmembership_delete_object_v1_response.py b/eZmaxApi/models/discussionmembership_delete_object_v1_response.py new file mode 100644 index 000000000..79abf9866 --- /dev/null +++ b/eZmaxApi/models/discussionmembership_delete_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 DiscussionmembershipDeleteObjectV1Response(BaseModel): + """ + Response for DELETE /1/object/discussionmembership/{pkiDiscussionmembershipID} + """ # 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 DiscussionmembershipDeleteObjectV1Response 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 DiscussionmembershipDeleteObjectV1Response 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/discussionmembership_request.py b/eZmaxApi/models/discussionmembership_request.py new file mode 100644 index 000000000..38e1441d6 --- /dev/null +++ b/eZmaxApi/models/discussionmembership_request.py @@ -0,0 +1,108 @@ +# 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 DiscussionmembershipRequest(BaseModel): + """ + A Discussionmembership Object + """ # noqa: E501 + pki_discussionmembership_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Discussionmembership", alias="pkiDiscussionmembershipID") + fki_discussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The unique ID of the Discussion", alias="fkiDiscussionID") + 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") + fki_modulesection_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Modulesection", alias="fkiModulesectionID") + dt_discussionmembership_joined: Annotated[str, Field(strict=True)] = Field(description="The joined date of the Discussionmembership", alias="dtDiscussionmembershipJoined") + __properties: ClassVar[List[str]] = ["pkiDiscussionmembershipID", "fkiDiscussionID", "fkiUserID", "fkiUsergroupID", "fkiModulesectionID", "dtDiscussionmembershipJoined"] + + @field_validator('dt_discussionmembership_joined') + def dt_discussionmembership_joined_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 + + model_config = { + "populate_by_name": 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 DiscussionmembershipRequest 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 DiscussionmembershipRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiDiscussionmembershipID": obj.get("pkiDiscussionmembershipID"), + "fkiDiscussionID": obj.get("fkiDiscussionID"), + "fkiUserID": obj.get("fkiUserID"), + "fkiUsergroupID": obj.get("fkiUsergroupID"), + "fkiModulesectionID": obj.get("fkiModulesectionID"), + "dtDiscussionmembershipJoined": obj.get("dtDiscussionmembershipJoined") + }) + return _obj + + diff --git a/eZmaxApi/models/discussionmembership_request_compound.py b/eZmaxApi/models/discussionmembership_request_compound.py new file mode 100644 index 000000000..a6bb4dded --- /dev/null +++ b/eZmaxApi/models/discussionmembership_request_compound.py @@ -0,0 +1,108 @@ +# 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 DiscussionmembershipRequestCompound(BaseModel): + """ + A Discussionmembership Object and children + """ # noqa: E501 + pki_discussionmembership_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Discussionmembership", alias="pkiDiscussionmembershipID") + fki_discussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The unique ID of the Discussion", alias="fkiDiscussionID") + 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") + fki_modulesection_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Modulesection", alias="fkiModulesectionID") + dt_discussionmembership_joined: Annotated[str, Field(strict=True)] = Field(description="The joined date of the Discussionmembership", alias="dtDiscussionmembershipJoined") + __properties: ClassVar[List[str]] = ["pkiDiscussionmembershipID", "fkiDiscussionID", "fkiUserID", "fkiUsergroupID", "fkiModulesectionID", "dtDiscussionmembershipJoined"] + + @field_validator('dt_discussionmembership_joined') + def dt_discussionmembership_joined_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 + + model_config = { + "populate_by_name": 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 DiscussionmembershipRequestCompound 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 DiscussionmembershipRequestCompound from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiDiscussionmembershipID": obj.get("pkiDiscussionmembershipID"), + "fkiDiscussionID": obj.get("fkiDiscussionID"), + "fkiUserID": obj.get("fkiUserID"), + "fkiUsergroupID": obj.get("fkiUsergroupID"), + "fkiModulesectionID": obj.get("fkiModulesectionID"), + "dtDiscussionmembershipJoined": obj.get("dtDiscussionmembershipJoined") + }) + return _obj + + diff --git a/eZmaxApi/models/discussionmembership_response.py b/eZmaxApi/models/discussionmembership_response.py new file mode 100644 index 000000000..7a90120cd --- /dev/null +++ b/eZmaxApi/models/discussionmembership_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 +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class DiscussionmembershipResponse(BaseModel): + """ + A Discussionmembership Object + """ # noqa: E501 + pki_discussionmembership_id: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The unique ID of the Discussionmembership", alias="pkiDiscussionmembershipID") + fki_discussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The unique ID of the Discussion", alias="fkiDiscussionID") + 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") + fki_modulesection_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Modulesection", alias="fkiModulesectionID") + s_discussionmembership_description: Annotated[str, Field(strict=True)] = Field(description="The Description containing the detail of who the Discussionmembership refers to", alias="sDiscussionmembershipDescription") + dt_discussionmembership_joined: Annotated[str, Field(strict=True)] = Field(description="The joined date of the Discussionmembership", alias="dtDiscussionmembershipJoined") + __properties: ClassVar[List[str]] = ["pkiDiscussionmembershipID", "fkiDiscussionID", "fkiUserID", "fkiUsergroupID", "fkiModulesectionID", "sDiscussionmembershipDescription", "dtDiscussionmembershipJoined"] + + @field_validator('s_discussionmembership_description') + def s_discussionmembership_description_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^.{0,100}$", value): + raise ValueError(r"must validate the regular expression /^.{0,100}$/") + return value + + @field_validator('dt_discussionmembership_joined') + def dt_discussionmembership_joined_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 + + model_config = { + "populate_by_name": 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 DiscussionmembershipResponse 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 DiscussionmembershipResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiDiscussionmembershipID": obj.get("pkiDiscussionmembershipID"), + "fkiDiscussionID": obj.get("fkiDiscussionID"), + "fkiUserID": obj.get("fkiUserID"), + "fkiUsergroupID": obj.get("fkiUsergroupID"), + "fkiModulesectionID": obj.get("fkiModulesectionID"), + "sDiscussionmembershipDescription": obj.get("sDiscussionmembershipDescription"), + "dtDiscussionmembershipJoined": obj.get("dtDiscussionmembershipJoined") + }) + return _obj + + diff --git a/eZmaxApi/models/discussionmembership_response_compound.py b/eZmaxApi/models/discussionmembership_response_compound.py new file mode 100644 index 000000000..7aec47c17 --- /dev/null +++ b/eZmaxApi/models/discussionmembership_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 +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class DiscussionmembershipResponseCompound(BaseModel): + """ + A Discussionmembership Object and children + """ # noqa: E501 + pki_discussionmembership_id: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The unique ID of the Discussionmembership", alias="pkiDiscussionmembershipID") + fki_discussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The unique ID of the Discussion", alias="fkiDiscussionID") + 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") + fki_modulesection_id: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Modulesection", alias="fkiModulesectionID") + s_discussionmembership_description: Annotated[str, Field(strict=True)] = Field(description="The Description containing the detail of who the Discussionmembership refers to", alias="sDiscussionmembershipDescription") + dt_discussionmembership_joined: Annotated[str, Field(strict=True)] = Field(description="The joined date of the Discussionmembership", alias="dtDiscussionmembershipJoined") + __properties: ClassVar[List[str]] = ["pkiDiscussionmembershipID", "fkiDiscussionID", "fkiUserID", "fkiUsergroupID", "fkiModulesectionID", "sDiscussionmembershipDescription", "dtDiscussionmembershipJoined"] + + @field_validator('s_discussionmembership_description') + def s_discussionmembership_description_validate_regular_expression(cls, value): + """Validates the regular expression""" + if not re.match(r"^.{0,100}$", value): + raise ValueError(r"must validate the regular expression /^.{0,100}$/") + return value + + @field_validator('dt_discussionmembership_joined') + def dt_discussionmembership_joined_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 + + model_config = { + "populate_by_name": 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 DiscussionmembershipResponseCompound 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 DiscussionmembershipResponseCompound from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiDiscussionmembershipID": obj.get("pkiDiscussionmembershipID"), + "fkiDiscussionID": obj.get("fkiDiscussionID"), + "fkiUserID": obj.get("fkiUserID"), + "fkiUsergroupID": obj.get("fkiUsergroupID"), + "fkiModulesectionID": obj.get("fkiModulesectionID"), + "sDiscussionmembershipDescription": obj.get("sDiscussionmembershipDescription"), + "dtDiscussionmembershipJoined": obj.get("dtDiscussionmembershipJoined") + }) + return _obj + + diff --git a/eZmaxApi/models/discussionmessage_create_object_v1_request.py b/eZmaxApi/models/discussionmessage_create_object_v1_request.py new file mode 100644 index 000000000..d16747aee --- /dev/null +++ b/eZmaxApi/models/discussionmessage_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.discussionmessage_request_compound import DiscussionmessageRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class DiscussionmessageCreateObjectV1Request(BaseModel): + """ + Request for POST /1/object/discussionmessage + """ # noqa: E501 + a_obj_discussionmessage: Annotated[List[DiscussionmessageRequestCompound], Field(min_length=1)] = Field(alias="a_objDiscussionmessage") + __properties: ClassVar[List[str]] = ["a_objDiscussionmessage"] + + model_config = { + "populate_by_name": 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 DiscussionmessageCreateObjectV1Request 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_discussionmessage (list) + _items = [] + if self.a_obj_discussionmessage: + for _item in self.a_obj_discussionmessage: + if _item: + _items.append(_item.to_dict()) + _dict['a_objDiscussionmessage'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of DiscussionmessageCreateObjectV1Request from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "a_objDiscussionmessage": [DiscussionmessageRequestCompound.from_dict(_item) for _item in obj.get("a_objDiscussionmessage")] if obj.get("a_objDiscussionmessage") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/discussionmessage_create_object_v1_response.py b/eZmaxApi/models/discussionmessage_create_object_v1_response.py new file mode 100644 index 000000000..51705d7e6 --- /dev/null +++ b/eZmaxApi/models/discussionmessage_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.discussionmessage_create_object_v1_response_m_payload import DiscussionmessageCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class DiscussionmessageCreateObjectV1Response(BaseModel): + """ + Response for POST /1/object/discussionmessage + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: DiscussionmessageCreateObjectV1ResponseMPayload = 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 DiscussionmessageCreateObjectV1Response 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 DiscussionmessageCreateObjectV1Response 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": DiscussionmessageCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/discussionmessage_create_object_v1_response_m_payload.py b/eZmaxApi/models/discussionmessage_create_object_v1_response_m_payload.py new file mode 100644 index 000000000..c89eb076f --- /dev/null +++ b/eZmaxApi/models/discussionmessage_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 DiscussionmessageCreateObjectV1ResponseMPayload(BaseModel): + """ + Payload for POST /1/object/discussionmessage + """ # noqa: E501 + a_pki_discussionmessage_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_pkiDiscussionmessageID") + __properties: ClassVar[List[str]] = ["a_pkiDiscussionmessageID"] + + model_config = { + "populate_by_name": 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 DiscussionmessageCreateObjectV1ResponseMPayload 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 DiscussionmessageCreateObjectV1ResponseMPayload from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "a_pkiDiscussionmessageID": obj.get("a_pkiDiscussionmessageID") + }) + return _obj + + diff --git a/eZmaxApi/models/discussionmessage_delete_object_v1_response.py b/eZmaxApi/models/discussionmessage_delete_object_v1_response.py new file mode 100644 index 000000000..e47a6a4af --- /dev/null +++ b/eZmaxApi/models/discussionmessage_delete_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 DiscussionmessageDeleteObjectV1Response(BaseModel): + """ + Response for DELETE /1/object/discussionmessage/{pkiDiscussionmessageID} + """ # 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 DiscussionmessageDeleteObjectV1Response 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 DiscussionmessageDeleteObjectV1Response 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/discussionmessage_patch_object_v1_request.py b/eZmaxApi/models/discussionmessage_patch_object_v1_request.py new file mode 100644 index 000000000..aa6f4fb34 --- /dev/null +++ b/eZmaxApi/models/discussionmessage_patch_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.discussionmessage_request_patch import DiscussionmessageRequestPatch +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class DiscussionmessagePatchObjectV1Request(BaseModel): + """ + Request for PATCH /1/object/discussionmessage/{pkiDiscussionmessageID} + """ # noqa: E501 + obj_discussionmessage: DiscussionmessageRequestPatch = Field(alias="objDiscussionmessage") + __properties: ClassVar[List[str]] = ["objDiscussionmessage"] + + model_config = { + "populate_by_name": 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 DiscussionmessagePatchObjectV1Request 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_discussionmessage + if self.obj_discussionmessage: + _dict['objDiscussionmessage'] = self.obj_discussionmessage.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of DiscussionmessagePatchObjectV1Request from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "objDiscussionmessage": DiscussionmessageRequestPatch.from_dict(obj.get("objDiscussionmessage")) if obj.get("objDiscussionmessage") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/discussionmessage_patch_object_v1_response.py b/eZmaxApi/models/discussionmessage_patch_object_v1_response.py new file mode 100644 index 000000000..aec3fb552 --- /dev/null +++ b/eZmaxApi/models/discussionmessage_patch_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 DiscussionmessagePatchObjectV1Response(BaseModel): + """ + Response for PATCH /1/object/discussionmessage/{pkiDiscussionmessageID} + """ # 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 DiscussionmessagePatchObjectV1Response 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 DiscussionmessagePatchObjectV1Response 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/discussionmessage_request.py b/eZmaxApi/models/discussionmessage_request.py new file mode 100644 index 000000000..8db7b0d65 --- /dev/null +++ b/eZmaxApi/models/discussionmessage_request.py @@ -0,0 +1,104 @@ +# 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 DiscussionmessageRequest(BaseModel): + """ + A Discussionmessage Object + """ # noqa: E501 + pki_discussionmessage_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Discussionmessage", alias="pkiDiscussionmessageID") + fki_discussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The unique ID of the Discussion", alias="fkiDiscussionID") + fki_discussionmembership_id_actionrequired: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Discussionmembership", alias="fkiDiscussionmembershipIDActionrequired") + t_discussionmessage_content: Annotated[str, Field(strict=True)] = Field(description="The content of the Discussionmessage", alias="tDiscussionmessageContent") + __properties: ClassVar[List[str]] = ["pkiDiscussionmessageID", "fkiDiscussionID", "fkiDiscussionmembershipIDActionrequired", "tDiscussionmessageContent"] + + @field_validator('t_discussionmessage_content') + def t_discussionmessage_content_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 + + model_config = { + "populate_by_name": 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 DiscussionmessageRequest 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 DiscussionmessageRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiDiscussionmessageID": obj.get("pkiDiscussionmessageID"), + "fkiDiscussionID": obj.get("fkiDiscussionID"), + "fkiDiscussionmembershipIDActionrequired": obj.get("fkiDiscussionmembershipIDActionrequired"), + "tDiscussionmessageContent": obj.get("tDiscussionmessageContent") + }) + return _obj + + diff --git a/eZmaxApi/models/discussionmessage_request_compound.py b/eZmaxApi/models/discussionmessage_request_compound.py new file mode 100644 index 000000000..656107184 --- /dev/null +++ b/eZmaxApi/models/discussionmessage_request_compound.py @@ -0,0 +1,104 @@ +# 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 DiscussionmessageRequestCompound(BaseModel): + """ + A Discussionmessage Object and children + """ # noqa: E501 + pki_discussionmessage_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Discussionmessage", alias="pkiDiscussionmessageID") + fki_discussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The unique ID of the Discussion", alias="fkiDiscussionID") + fki_discussionmembership_id_actionrequired: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Discussionmembership", alias="fkiDiscussionmembershipIDActionrequired") + t_discussionmessage_content: Annotated[str, Field(strict=True)] = Field(description="The content of the Discussionmessage", alias="tDiscussionmessageContent") + __properties: ClassVar[List[str]] = ["pkiDiscussionmessageID", "fkiDiscussionID", "fkiDiscussionmembershipIDActionrequired", "tDiscussionmessageContent"] + + @field_validator('t_discussionmessage_content') + def t_discussionmessage_content_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 + + model_config = { + "populate_by_name": 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 DiscussionmessageRequestCompound 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 DiscussionmessageRequestCompound from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiDiscussionmessageID": obj.get("pkiDiscussionmessageID"), + "fkiDiscussionID": obj.get("fkiDiscussionID"), + "fkiDiscussionmembershipIDActionrequired": obj.get("fkiDiscussionmembershipIDActionrequired"), + "tDiscussionmessageContent": obj.get("tDiscussionmessageContent") + }) + return _obj + + diff --git a/eZmaxApi/models/discussionmessage_request_patch.py b/eZmaxApi/models/discussionmessage_request_patch.py new file mode 100644 index 000000000..5daf76326 --- /dev/null +++ b/eZmaxApi/models/discussionmessage_request_patch.py @@ -0,0 +1,103 @@ +# 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 DiscussionmessageRequestPatch(BaseModel): + """ + A Discussionmessage Object + """ # noqa: E501 + fki_discussionmembership_id_actionrequired: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Discussionmembership", alias="fkiDiscussionmembershipIDActionrequired") + t_discussionmessage_content: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The content of the Discussionmessage", alias="tDiscussionmessageContent") + __properties: ClassVar[List[str]] = ["fkiDiscussionmembershipIDActionrequired", "tDiscussionmessageContent"] + + @field_validator('t_discussionmessage_content') + def t_discussionmessage_content_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 DiscussionmessageRequestPatch 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 DiscussionmessageRequestPatch from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "fkiDiscussionmembershipIDActionrequired": obj.get("fkiDiscussionmembershipIDActionrequired"), + "tDiscussionmessageContent": obj.get("tDiscussionmessageContent") + }) + return _obj + + diff --git a/eZmaxApi/models/discussionmessage_response.py b/eZmaxApi/models/discussionmessage_response.py new file mode 100644 index 000000000..23a50e5ef --- /dev/null +++ b/eZmaxApi/models/discussionmessage_response.py @@ -0,0 +1,136 @@ +# 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.common_audit import CommonAudit +from eZmaxApi.models.field_e_discussionmessage_status import FieldEDiscussionmessageStatus +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class DiscussionmessageResponse(BaseModel): + """ + A Discussionmessage Object + """ # noqa: E501 + pki_discussionmessage_id: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The unique ID of the Discussionmessage", alias="pkiDiscussionmessageID") + fki_discussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The unique ID of the Discussion", alias="fkiDiscussionID") + fki_discussionmembership_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Discussionmembership", alias="fkiDiscussionmembershipID") + fki_discussionmembership_id_actionrequired: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Discussionmembership", alias="fkiDiscussionmembershipIDActionrequired") + e_discussionmessage_status: FieldEDiscussionmessageStatus = Field(alias="eDiscussionmessageStatus") + t_discussionmessage_content: Annotated[str, Field(strict=True)] = Field(description="The content of the Discussionmessage", alias="tDiscussionmessageContent") + s_discussionmessage_creatorname: Annotated[str, Field(strict=True)] = Field(description="The name the creator of the Discussionmessage.", alias="sDiscussionmessageCreatorname") + s_discussionmessage_actionrequiredname: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The name the Actionrequired of the Discussionmessage.", alias="sDiscussionmessageActionrequiredname") + obj_audit: CommonAudit = Field(alias="objAudit") + __properties: ClassVar[List[str]] = ["pkiDiscussionmessageID", "fkiDiscussionID", "fkiDiscussionmembershipID", "fkiDiscussionmembershipIDActionrequired", "eDiscussionmessageStatus", "tDiscussionmessageContent", "sDiscussionmessageCreatorname", "sDiscussionmessageActionrequiredname", "objAudit"] + + @field_validator('t_discussionmessage_content') + def t_discussionmessage_content_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 + + @field_validator('s_discussionmessage_creatorname') + def s_discussionmessage_creatorname_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_discussionmessage_actionrequiredname') + def s_discussionmessage_actionrequiredname_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 DiscussionmessageResponse 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 DiscussionmessageResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiDiscussionmessageID": obj.get("pkiDiscussionmessageID"), + "fkiDiscussionID": obj.get("fkiDiscussionID"), + "fkiDiscussionmembershipID": obj.get("fkiDiscussionmembershipID"), + "fkiDiscussionmembershipIDActionrequired": obj.get("fkiDiscussionmembershipIDActionrequired"), + "eDiscussionmessageStatus": obj.get("eDiscussionmessageStatus"), + "tDiscussionmessageContent": obj.get("tDiscussionmessageContent"), + "sDiscussionmessageCreatorname": obj.get("sDiscussionmessageCreatorname"), + "sDiscussionmessageActionrequiredname": obj.get("sDiscussionmessageActionrequiredname"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/discussionmessage_response_compound.py b/eZmaxApi/models/discussionmessage_response_compound.py new file mode 100644 index 000000000..f3d9f6039 --- /dev/null +++ b/eZmaxApi/models/discussionmessage_response_compound.py @@ -0,0 +1,136 @@ +# 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.common_audit import CommonAudit +from eZmaxApi.models.field_e_discussionmessage_status import FieldEDiscussionmessageStatus +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class DiscussionmessageResponseCompound(BaseModel): + """ + A Discussionmessage Object and children + """ # noqa: E501 + pki_discussionmessage_id: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The unique ID of the Discussionmessage", alias="pkiDiscussionmessageID") + fki_discussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The unique ID of the Discussion", alias="fkiDiscussionID") + fki_discussionmembership_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Discussionmembership", alias="fkiDiscussionmembershipID") + fki_discussionmembership_id_actionrequired: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Discussionmembership", alias="fkiDiscussionmembershipIDActionrequired") + e_discussionmessage_status: FieldEDiscussionmessageStatus = Field(alias="eDiscussionmessageStatus") + t_discussionmessage_content: Annotated[str, Field(strict=True)] = Field(description="The content of the Discussionmessage", alias="tDiscussionmessageContent") + s_discussionmessage_creatorname: Annotated[str, Field(strict=True)] = Field(description="The name the creator of the Discussionmessage.", alias="sDiscussionmessageCreatorname") + s_discussionmessage_actionrequiredname: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The name the Actionrequired of the Discussionmessage.", alias="sDiscussionmessageActionrequiredname") + obj_audit: CommonAudit = Field(alias="objAudit") + __properties: ClassVar[List[str]] = ["pkiDiscussionmessageID", "fkiDiscussionID", "fkiDiscussionmembershipID", "fkiDiscussionmembershipIDActionrequired", "eDiscussionmessageStatus", "tDiscussionmessageContent", "sDiscussionmessageCreatorname", "sDiscussionmessageActionrequiredname", "objAudit"] + + @field_validator('t_discussionmessage_content') + def t_discussionmessage_content_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 + + @field_validator('s_discussionmessage_creatorname') + def s_discussionmessage_creatorname_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_discussionmessage_actionrequiredname') + def s_discussionmessage_actionrequiredname_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 DiscussionmessageResponseCompound 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 DiscussionmessageResponseCompound from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiDiscussionmessageID": obj.get("pkiDiscussionmessageID"), + "fkiDiscussionID": obj.get("fkiDiscussionID"), + "fkiDiscussionmembershipID": obj.get("fkiDiscussionmembershipID"), + "fkiDiscussionmembershipIDActionrequired": obj.get("fkiDiscussionmembershipIDActionrequired"), + "eDiscussionmessageStatus": obj.get("eDiscussionmessageStatus"), + "tDiscussionmessageContent": obj.get("tDiscussionmessageContent"), + "sDiscussionmessageCreatorname": obj.get("sDiscussionmessageCreatorname"), + "sDiscussionmessageActionrequiredname": obj.get("sDiscussionmessageActionrequiredname"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/ezsigndiscussion_create_object_v1_request.py b/eZmaxApi/models/ezsigndiscussion_create_object_v1_request.py new file mode 100644 index 000000000..b171f0edb --- /dev/null +++ b/eZmaxApi/models/ezsigndiscussion_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.ezsigndiscussion_request_compound import EzsigndiscussionRequestCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsigndiscussionCreateObjectV1Request(BaseModel): + """ + Request for POST /1/object/ezsigndiscussion + """ # noqa: E501 + a_obj_ezsigndiscussion: Annotated[List[EzsigndiscussionRequestCompound], Field(min_length=1)] = Field(alias="a_objEzsigndiscussion") + __properties: ClassVar[List[str]] = ["a_objEzsigndiscussion"] + + model_config = { + "populate_by_name": 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 EzsigndiscussionCreateObjectV1Request 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_ezsigndiscussion (list) + _items = [] + if self.a_obj_ezsigndiscussion: + for _item in self.a_obj_ezsigndiscussion: + if _item: + _items.append(_item.to_dict()) + _dict['a_objEzsigndiscussion'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsigndiscussionCreateObjectV1Request from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "a_objEzsigndiscussion": [EzsigndiscussionRequestCompound.from_dict(_item) for _item in obj.get("a_objEzsigndiscussion")] if obj.get("a_objEzsigndiscussion") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/ezsigndiscussion_create_object_v1_response.py b/eZmaxApi/models/ezsigndiscussion_create_object_v1_response.py new file mode 100644 index 000000000..823b34f70 --- /dev/null +++ b/eZmaxApi/models/ezsigndiscussion_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.ezsigndiscussion_create_object_v1_response_m_payload import EzsigndiscussionCreateObjectV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsigndiscussionCreateObjectV1Response(BaseModel): + """ + Response for POST /1/object/ezsigndiscussion + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigndiscussionCreateObjectV1ResponseMPayload = 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 EzsigndiscussionCreateObjectV1Response 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 EzsigndiscussionCreateObjectV1Response 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": EzsigndiscussionCreateObjectV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/ezsigndiscussion_create_object_v1_response_m_payload.py b/eZmaxApi/models/ezsigndiscussion_create_object_v1_response_m_payload.py new file mode 100644 index 000000000..9734182ed --- /dev/null +++ b/eZmaxApi/models/ezsigndiscussion_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 EzsigndiscussionCreateObjectV1ResponseMPayload(BaseModel): + """ + Payload for POST /1/object/ezsigndiscussion + """ # noqa: E501 + a_pki_ezsigndiscussion_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_pkiEzsigndiscussionID") + __properties: ClassVar[List[str]] = ["a_pkiEzsigndiscussionID"] + + model_config = { + "populate_by_name": 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 EzsigndiscussionCreateObjectV1ResponseMPayload 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 EzsigndiscussionCreateObjectV1ResponseMPayload from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "a_pkiEzsigndiscussionID": obj.get("a_pkiEzsigndiscussionID") + }) + return _obj + + diff --git a/eZmaxApi/models/ezsigndiscussion_delete_object_v1_response.py b/eZmaxApi/models/ezsigndiscussion_delete_object_v1_response.py new file mode 100644 index 000000000..23463bd74 --- /dev/null +++ b/eZmaxApi/models/ezsigndiscussion_delete_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 EzsigndiscussionDeleteObjectV1Response(BaseModel): + """ + Response for DELETE /1/object/ezsigndiscussion/{pkiEzsigndiscussionID} + """ # 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 EzsigndiscussionDeleteObjectV1Response 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 EzsigndiscussionDeleteObjectV1Response 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/ezsigndiscussion_get_object_v2_response.py b/eZmaxApi/models/ezsigndiscussion_get_object_v2_response.py new file mode 100644 index 000000000..b180f9383 --- /dev/null +++ b/eZmaxApi/models/ezsigndiscussion_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.ezsigndiscussion_get_object_v2_response_m_payload import EzsigndiscussionGetObjectV2ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsigndiscussionGetObjectV2Response(BaseModel): + """ + Response for GET /2/object/ezsigndiscussion/{pkiEzsigndiscussionID} + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigndiscussionGetObjectV2ResponseMPayload = 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 EzsigndiscussionGetObjectV2Response 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 EzsigndiscussionGetObjectV2Response 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": EzsigndiscussionGetObjectV2ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/ezsigndiscussion_get_object_v2_response_m_payload.py b/eZmaxApi/models/ezsigndiscussion_get_object_v2_response_m_payload.py new file mode 100644 index 000000000..3bf84728b --- /dev/null +++ b/eZmaxApi/models/ezsigndiscussion_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.ezsigndiscussion_response_compound import EzsigndiscussionResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsigndiscussionGetObjectV2ResponseMPayload(BaseModel): + """ + Payload for GET /2/object/ezsigndiscussion/{pkiEzsigndiscussionID} + """ # noqa: E501 + obj_ezsigndiscussion: EzsigndiscussionResponseCompound = Field(alias="objEzsigndiscussion") + __properties: ClassVar[List[str]] = ["objEzsigndiscussion"] + + model_config = { + "populate_by_name": 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 EzsigndiscussionGetObjectV2ResponseMPayload 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_ezsigndiscussion + if self.obj_ezsigndiscussion: + _dict['objEzsigndiscussion'] = self.obj_ezsigndiscussion.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsigndiscussionGetObjectV2ResponseMPayload from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "objEzsigndiscussion": EzsigndiscussionResponseCompound.from_dict(obj.get("objEzsigndiscussion")) if obj.get("objEzsigndiscussion") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/ezsigndiscussion_request.py b/eZmaxApi/models/ezsigndiscussion_request.py new file mode 100644 index 000000000..9cace1772 --- /dev/null +++ b/eZmaxApi/models/ezsigndiscussion_request.py @@ -0,0 +1,105 @@ +# 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, StrictInt +from pydantic import Field +from typing_extensions import Annotated +from eZmaxApi.models.discussion_request import DiscussionRequest +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsigndiscussionRequest(BaseModel): + """ + An Ezsigndiscussion Object + """ # noqa: E501 + pki_ezsigndiscussion_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigndiscussion", alias="pkiEzsigndiscussionID") + fki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigndocument", alias="fkiEzsigndocumentID") + i_ezsigndiscussion_pagenumber: StrictInt = Field(description="The page number in the Ezsigndocument for the Ezsigndiscussion", alias="iEzsigndiscussionPagenumber") + i_ezsigndiscussion_x: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The x of the Ezsigndiscussion", alias="iEzsigndiscussionX") + i_ezsigndiscussion_y: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The y of the Ezsigndiscussion", alias="iEzsigndiscussionY") + obj_discussion: DiscussionRequest = Field(alias="objDiscussion") + __properties: ClassVar[List[str]] = ["pkiEzsigndiscussionID", "fkiEzsigndocumentID", "iEzsigndiscussionPagenumber", "iEzsigndiscussionX", "iEzsigndiscussionY", "objDiscussion"] + + model_config = { + "populate_by_name": 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 EzsigndiscussionRequest 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_discussion + if self.obj_discussion: + _dict['objDiscussion'] = self.obj_discussion.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsigndiscussionRequest from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigndiscussionID": obj.get("pkiEzsigndiscussionID"), + "fkiEzsigndocumentID": obj.get("fkiEzsigndocumentID"), + "iEzsigndiscussionPagenumber": obj.get("iEzsigndiscussionPagenumber"), + "iEzsigndiscussionX": obj.get("iEzsigndiscussionX"), + "iEzsigndiscussionY": obj.get("iEzsigndiscussionY"), + "objDiscussion": DiscussionRequest.from_dict(obj.get("objDiscussion")) if obj.get("objDiscussion") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/ezsigndiscussion_request_compound.py b/eZmaxApi/models/ezsigndiscussion_request_compound.py new file mode 100644 index 000000000..089d68dbf --- /dev/null +++ b/eZmaxApi/models/ezsigndiscussion_request_compound.py @@ -0,0 +1,105 @@ +# 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, StrictInt +from pydantic import Field +from typing_extensions import Annotated +from eZmaxApi.models.discussion_request import DiscussionRequest +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsigndiscussionRequestCompound(BaseModel): + """ + A Ezsigndiscussion Object and children + """ # noqa: E501 + pki_ezsigndiscussion_id: Optional[Annotated[int, Field(le=16777215, strict=True, ge=0)]] = Field(default=None, description="The unique ID of the Ezsigndiscussion", alias="pkiEzsigndiscussionID") + fki_ezsigndocument_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsigndocument", alias="fkiEzsigndocumentID") + i_ezsigndiscussion_pagenumber: StrictInt = Field(description="The page number in the Ezsigndocument for the Ezsigndiscussion", alias="iEzsigndiscussionPagenumber") + i_ezsigndiscussion_x: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The x of the Ezsigndiscussion", alias="iEzsigndiscussionX") + i_ezsigndiscussion_y: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The y of the Ezsigndiscussion", alias="iEzsigndiscussionY") + obj_discussion: DiscussionRequest = Field(alias="objDiscussion") + __properties: ClassVar[List[str]] = ["pkiEzsigndiscussionID", "fkiEzsigndocumentID", "iEzsigndiscussionPagenumber", "iEzsigndiscussionX", "iEzsigndiscussionY", "objDiscussion"] + + model_config = { + "populate_by_name": 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 EzsigndiscussionRequestCompound 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_discussion + if self.obj_discussion: + _dict['objDiscussion'] = self.obj_discussion.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsigndiscussionRequestCompound from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigndiscussionID": obj.get("pkiEzsigndiscussionID"), + "fkiEzsigndocumentID": obj.get("fkiEzsigndocumentID"), + "iEzsigndiscussionPagenumber": obj.get("iEzsigndiscussionPagenumber"), + "iEzsigndiscussionX": obj.get("iEzsigndiscussionX"), + "iEzsigndiscussionY": obj.get("iEzsigndiscussionY"), + "objDiscussion": DiscussionRequest.from_dict(obj.get("objDiscussion")) if obj.get("objDiscussion") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/ezsigndiscussion_response.py b/eZmaxApi/models/ezsigndiscussion_response.py new file mode 100644 index 000000000..82780501e --- /dev/null +++ b/eZmaxApi/models/ezsigndiscussion_response.py @@ -0,0 +1,107 @@ +# 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 typing_extensions import Annotated +from eZmaxApi.models.discussion_response_compound import DiscussionResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsigndiscussionResponse(BaseModel): + """ + A Ezsigndiscussion Object + """ # noqa: E501 + pki_ezsigndiscussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The unique ID of the Ezsigndiscussion", alias="pkiEzsigndiscussionID") + fki_ezsignpage_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignpage", alias="fkiEzsignpageID") + fki_discussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The unique ID of the Discussion", alias="fkiDiscussionID") + i_ezsigndiscussion_x: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The x of the Ezsigndiscussion", alias="iEzsigndiscussionX") + i_ezsigndiscussion_y: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The y of the Ezsigndiscussion", alias="iEzsigndiscussionY") + i_ezsigndiscussion_pagenumber: StrictInt = Field(description="The page number in the Ezsigndocument for the Ezsigndiscussion", alias="iEzsigndiscussionPagenumber") + obj_discussion: DiscussionResponseCompound = Field(alias="objDiscussion") + __properties: ClassVar[List[str]] = ["pkiEzsigndiscussionID", "fkiEzsignpageID", "fkiDiscussionID", "iEzsigndiscussionX", "iEzsigndiscussionY", "iEzsigndiscussionPagenumber", "objDiscussion"] + + model_config = { + "populate_by_name": 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 EzsigndiscussionResponse 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_discussion + if self.obj_discussion: + _dict['objDiscussion'] = self.obj_discussion.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsigndiscussionResponse from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigndiscussionID": obj.get("pkiEzsigndiscussionID"), + "fkiEzsignpageID": obj.get("fkiEzsignpageID"), + "fkiDiscussionID": obj.get("fkiDiscussionID"), + "iEzsigndiscussionX": obj.get("iEzsigndiscussionX"), + "iEzsigndiscussionY": obj.get("iEzsigndiscussionY"), + "iEzsigndiscussionPagenumber": obj.get("iEzsigndiscussionPagenumber"), + "objDiscussion": DiscussionResponseCompound.from_dict(obj.get("objDiscussion")) if obj.get("objDiscussion") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/ezsigndiscussion_response_compound.py b/eZmaxApi/models/ezsigndiscussion_response_compound.py new file mode 100644 index 000000000..f3ffb0685 --- /dev/null +++ b/eZmaxApi/models/ezsigndiscussion_response_compound.py @@ -0,0 +1,107 @@ +# 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 typing_extensions import Annotated +from eZmaxApi.models.discussion_response_compound import DiscussionResponseCompound +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsigndiscussionResponseCompound(BaseModel): + """ + A Ezsigndiscussion Object + """ # noqa: E501 + pki_ezsigndiscussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The unique ID of the Ezsigndiscussion", alias="pkiEzsigndiscussionID") + fki_ezsignpage_id: Annotated[int, Field(strict=True, ge=0)] = Field(description="The unique ID of the Ezsignpage", alias="fkiEzsignpageID") + fki_discussion_id: Annotated[int, Field(le=16777215, strict=True, ge=0)] = Field(description="The unique ID of the Discussion", alias="fkiDiscussionID") + i_ezsigndiscussion_x: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The x of the Ezsigndiscussion", alias="iEzsigndiscussionX") + i_ezsigndiscussion_y: Annotated[int, Field(le=65535, strict=True, ge=0)] = Field(description="The y of the Ezsigndiscussion", alias="iEzsigndiscussionY") + i_ezsigndiscussion_pagenumber: StrictInt = Field(description="The page number in the Ezsigndocument for the Ezsigndiscussion", alias="iEzsigndiscussionPagenumber") + obj_discussion: DiscussionResponseCompound = Field(alias="objDiscussion") + __properties: ClassVar[List[str]] = ["pkiEzsigndiscussionID", "fkiEzsignpageID", "fkiDiscussionID", "iEzsigndiscussionX", "iEzsigndiscussionY", "iEzsigndiscussionPagenumber", "objDiscussion"] + + model_config = { + "populate_by_name": 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 EzsigndiscussionResponseCompound 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_discussion + if self.obj_discussion: + _dict['objDiscussion'] = self.obj_discussion.to_dict() + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsigndiscussionResponseCompound from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "pkiEzsigndiscussionID": obj.get("pkiEzsigndiscussionID"), + "fkiEzsignpageID": obj.get("fkiEzsignpageID"), + "fkiDiscussionID": obj.get("fkiDiscussionID"), + "iEzsigndiscussionX": obj.get("iEzsigndiscussionX"), + "iEzsigndiscussionY": obj.get("iEzsigndiscussionY"), + "iEzsigndiscussionPagenumber": obj.get("iEzsigndiscussionPagenumber"), + "objDiscussion": DiscussionResponseCompound.from_dict(obj.get("objDiscussion")) if obj.get("objDiscussion") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/ezsigndocument_apply_ezsigntemplate_v2_response.py b/eZmaxApi/models/ezsigndocument_apply_ezsigntemplate_v2_response.py index 183048bbd..ae7b0dad6 100644 --- a/eZmaxApi/models/ezsigndocument_apply_ezsigntemplate_v2_response.py +++ b/eZmaxApi/models/ezsigndocument_apply_ezsigntemplate_v2_response.py @@ -24,6 +24,7 @@ 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: @@ -35,7 +36,8 @@ class EzsigndocumentApplyEzsigntemplateV2Response(BaseModel): """ # noqa: E501 obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") - __properties: ClassVar[List[str]] = ["objDebugPayload", "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, @@ -80,6 +82,13 @@ def to_dict(self) -> Dict[str, Any]: # 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 each item in a_obj_warning (list) + _items = [] + if self.a_obj_warning: + for _item in self.a_obj_warning: + if _item: + _items.append(_item.to_dict()) + _dict['a_objWarning'] = _items return _dict @classmethod @@ -93,7 +102,8 @@ def from_dict(cls, obj: Dict) -> Self: _obj = cls.model_validate({ "objDebugPayload": CommonResponseObjDebugPayload.from_dict(obj.get("objDebugPayload")) if obj.get("objDebugPayload") is not None else None, - "objDebug": CommonResponseObjDebug.from_dict(obj.get("objDebug")) if obj.get("objDebug") 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/ezsigndocument_create_ezsignelements_positioned_by_word_v1_request.py b/eZmaxApi/models/ezsigndocument_create_ezsignelements_positioned_by_word_v1_request.py new file mode 100644 index 000000000..888656e56 --- /dev/null +++ b/eZmaxApi/models/ezsigndocument_create_ezsignelements_positioned_by_word_v1_request.py @@ -0,0 +1,108 @@ +# 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_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request import CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest +from eZmaxApi.models.custom_ezsignsignature_create_ezsignelements_positioned_by_word_request import CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsigndocumentCreateEzsignelementsPositionedByWordV1Request(BaseModel): + """ + Request for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/createEzsignelementsPositionedByWord + """ # noqa: E501 + a_obj_ezsignformfieldgroup: List[CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest] = Field(alias="a_objEzsignformfieldgroup") + a_obj_ezsignsignature: List[CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest] = Field(alias="a_objEzsignsignature") + __properties: ClassVar[List[str]] = ["a_objEzsignformfieldgroup", "a_objEzsignsignature"] + + model_config = { + "populate_by_name": 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 EzsigndocumentCreateEzsignelementsPositionedByWordV1Request 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_ezsignformfieldgroup (list) + _items = [] + if self.a_obj_ezsignformfieldgroup: + for _item in self.a_obj_ezsignformfieldgroup: + if _item: + _items.append(_item.to_dict()) + _dict['a_objEzsignformfieldgroup'] = _items + # override the default output from pydantic by calling `to_dict()` of each item in a_obj_ezsignsignature (list) + _items = [] + if self.a_obj_ezsignsignature: + for _item in self.a_obj_ezsignsignature: + if _item: + _items.append(_item.to_dict()) + _dict['a_objEzsignsignature'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsigndocumentCreateEzsignelementsPositionedByWordV1Request from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "a_objEzsignformfieldgroup": [CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest.from_dict(_item) for _item in obj.get("a_objEzsignformfieldgroup")] if obj.get("a_objEzsignformfieldgroup") is not None else None, + "a_objEzsignsignature": [CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest.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_create_ezsignelements_positioned_by_word_v1_response.py b/eZmaxApi/models/ezsigndocument_create_ezsignelements_positioned_by_word_v1_response.py new file mode 100644 index 000000000..c4ef8b1b8 --- /dev/null +++ b/eZmaxApi/models/ezsigndocument_create_ezsignelements_positioned_by_word_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_create_ezsignelements_positioned_by_word_v1_response_m_payload import EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsigndocumentCreateEzsignelementsPositionedByWordV1Response(BaseModel): + """ + Response for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/createEzsignelementsPositionedByWord + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload = 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 EzsigndocumentCreateEzsignelementsPositionedByWordV1Response 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 EzsigndocumentCreateEzsignelementsPositionedByWordV1Response 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": EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/ezsigndocument_create_ezsignelements_positioned_by_word_v1_response_m_payload.py b/eZmaxApi/models/ezsigndocument_create_ezsignelements_positioned_by_word_v1_response_m_payload.py new file mode 100644 index 000000000..2cd586a04 --- /dev/null +++ b/eZmaxApi/models/ezsigndocument_create_ezsignelements_positioned_by_word_v1_response_m_payload.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 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 EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload(BaseModel): + """ + Payload for POST /1/object/ezsigndocument/{pkiEzsigndocumentID}/createEzsignelementsPositionedByWord + """ # noqa: E501 + a_pki_ezsignsignature_id: List[Annotated[int, Field(strict=True, ge=0)]] = Field(alias="a_pkiEzsignsignatureID") + a_pki_ezsignformfieldgroup_id: List[Annotated[int, Field(strict=True, ge=0)]] = Field(alias="a_pkiEzsignformfieldgroupID") + __properties: ClassVar[List[str]] = ["a_pkiEzsignsignatureID", "a_pkiEzsignformfieldgroupID"] + + model_config = { + "populate_by_name": 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 EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload 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 EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "a_pkiEzsignsignatureID": obj.get("a_pkiEzsignsignatureID"), + "a_pkiEzsignformfieldgroupID": obj.get("a_pkiEzsignformfieldgroupID") + }) + return _obj + + diff --git a/eZmaxApi/models/ezsigndocument_get_ezsigndiscussions_v1_response.py b/eZmaxApi/models/ezsigndocument_get_ezsigndiscussions_v1_response.py new file mode 100644 index 000000000..5a2784cdd --- /dev/null +++ b/eZmaxApi/models/ezsigndocument_get_ezsigndiscussions_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_ezsigndiscussions_v1_response_m_payload import EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsigndocumentGetEzsigndiscussionsV1Response(BaseModel): + """ + Response for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsigndiscussions + """ # noqa: E501 + obj_debug_payload: CommonResponseObjDebugPayload = Field(alias="objDebugPayload") + obj_debug: Optional[CommonResponseObjDebug] = Field(default=None, alias="objDebug") + m_payload: EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload = 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 EzsigndocumentGetEzsigndiscussionsV1Response 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 EzsigndocumentGetEzsigndiscussionsV1Response 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": EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload.from_dict(obj.get("mPayload")) if obj.get("mPayload") is not None else None + }) + return _obj + + diff --git a/eZmaxApi/models/ezsigndocument_get_ezsigndiscussions_v1_response_m_payload.py b/eZmaxApi/models/ezsigndocument_get_ezsigndiscussions_v1_response_m_payload.py new file mode 100644 index 000000000..4162c4482 --- /dev/null +++ b/eZmaxApi/models/ezsigndocument_get_ezsigndiscussions_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.ezsigndiscussion_response import EzsigndiscussionResponse +try: + from typing import Self +except ImportError: + from typing_extensions import Self + +class EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload(BaseModel): + """ + Payload for GET /1/object/ezsigndocument/{pkiEzsigndocument}/getEzsigndiscussions + """ # noqa: E501 + a_obj_ezsigndiscussion: List[EzsigndiscussionResponse] = Field(alias="a_objEzsigndiscussion") + __properties: ClassVar[List[str]] = ["a_objEzsigndiscussion"] + + model_config = { + "populate_by_name": 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 EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload 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_ezsigndiscussion (list) + _items = [] + if self.a_obj_ezsigndiscussion: + for _item in self.a_obj_ezsigndiscussion: + if _item: + _items.append(_item.to_dict()) + _dict['a_objEzsigndiscussion'] = _items + return _dict + + @classmethod + def from_dict(cls, obj: Dict) -> Self: + """Create an instance of EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload from a dict""" + if obj is None: + return None + + if not isinstance(obj, dict): + return cls.model_validate(obj) + + _obj = cls.model_validate({ + "a_objEzsigndiscussion": [EzsigndiscussionResponse.from_dict(_item) for _item in obj.get("a_objEzsigndiscussion")] if obj.get("a_objEzsigndiscussion") 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 c54a8ed47..a4ed17e63 100644 --- a/eZmaxApi/models/ezsignfolder_get_object_v1_response_m_payload.py +++ b/eZmaxApi/models/ezsignfolder_get_object_v1_response_m_payload.py @@ -25,6 +25,7 @@ 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_completion import FieldEEzsignfolderCompletion from eZmaxApi.models.field_e_ezsignfolder_sendreminderfrequency import FieldEEzsignfolderSendreminderfrequency from eZmaxApi.models.field_e_ezsignfolder_step import FieldEEzsignfolderStep try: @@ -39,6 +40,7 @@ class EzsignfolderGetObjectV1ResponseMPayload(BaseModel): 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") + e_ezsignfolder_completion: Optional[FieldEEzsignfolderCompletion] = Field(default=None, alias="eEzsignfolderCompletion") 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") @@ -58,7 +60,7 @@ class EzsignfolderGetObjectV1ResponseMPayload(BaseModel): 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"] + __properties: ClassVar[List[str]] = ["pkiEzsignfolderID", "fkiEzsignfoldertypeID", "objEzsignfoldertype", "eEzsignfolderCompletion", "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): @@ -128,6 +130,7 @@ def from_dict(cls, obj: Dict) -> Self: "pkiEzsignfolderID": obj.get("pkiEzsignfolderID"), "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), "objEzsignfoldertype": CustomEzsignfoldertypeResponse.from_dict(obj.get("objEzsignfoldertype")) if obj.get("objEzsignfoldertype") is not None else None, + "eEzsignfolderCompletion": obj.get("eEzsignfolderCompletion"), "sEzsignfoldertypeNameX": obj.get("sEzsignfoldertypeNameX"), "fkiBillingentityinternalID": obj.get("fkiBillingentityinternalID"), "sBillingentityinternalDescriptionX": obj.get("sBillingentityinternalDescriptionX"), diff --git a/eZmaxApi/models/ezsignfolder_list_element.py b/eZmaxApi/models/ezsignfolder_list_element.py index 612586d12..9f2002a46 100644 --- a/eZmaxApi/models/ezsignfolder_list_element.py +++ b/eZmaxApi/models/ezsignfolder_list_element.py @@ -41,13 +41,14 @@ class EzsignfolderListElement(BaseModel): 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_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_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"] + __properties: ClassVar[List[str]] = ["pkiEzsignfolderID", "fkiEzsignfoldertypeID", "eEzsignfoldertypePrivacylevel", "sEzsignfoldertypeNameX", "sEzsignfolderDescription", "eEzsignfolderStep", "dtCreatedDate", "dtEzsignfolderDelayedsenddate", "dtEzsignfolderSentdate", "dtEzsignfolderDuedate", "iEzsigndocument", "iEzsigndocumentEdm", "iEzsignsignature", "iEzsignsignatureSigned"] model_config = { "populate_by_name": True, @@ -105,6 +106,7 @@ def from_dict(cls, obj: Dict) -> Self: "sEzsignfolderDescription": obj.get("sEzsignfolderDescription"), "eEzsignfolderStep": obj.get("eEzsignfolderStep"), "dtCreatedDate": obj.get("dtCreatedDate"), + "dtEzsignfolderDelayedsenddate": obj.get("dtEzsignfolderDelayedsenddate"), "dtEzsignfolderSentdate": obj.get("dtEzsignfolderSentdate"), "dtEzsignfolderDuedate": obj.get("dtEzsignfolderDuedate"), "iEzsigndocument": obj.get("iEzsigndocument"), diff --git a/eZmaxApi/models/ezsignfolder_response.py b/eZmaxApi/models/ezsignfolder_response.py index 81177f3ed..a05760a46 100644 --- a/eZmaxApi/models/ezsignfolder_response.py +++ b/eZmaxApi/models/ezsignfolder_response.py @@ -25,6 +25,7 @@ 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_completion import FieldEEzsignfolderCompletion from eZmaxApi.models.field_e_ezsignfolder_sendreminderfrequency import FieldEEzsignfolderSendreminderfrequency from eZmaxApi.models.field_e_ezsignfolder_step import FieldEEzsignfolderStep try: @@ -39,6 +40,7 @@ class EzsignfolderResponse(BaseModel): 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") + e_ezsignfolder_completion: Optional[FieldEEzsignfolderCompletion] = Field(default=None, alias="eEzsignfolderCompletion") 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") @@ -58,7 +60,7 @@ class EzsignfolderResponse(BaseModel): 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"] + __properties: ClassVar[List[str]] = ["pkiEzsignfolderID", "fkiEzsignfoldertypeID", "objEzsignfoldertype", "eEzsignfolderCompletion", "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): @@ -128,6 +130,7 @@ def from_dict(cls, obj: Dict) -> Self: "pkiEzsignfolderID": obj.get("pkiEzsignfolderID"), "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), "objEzsignfoldertype": CustomEzsignfoldertypeResponse.from_dict(obj.get("objEzsignfoldertype")) if obj.get("objEzsignfoldertype") is not None else None, + "eEzsignfolderCompletion": obj.get("eEzsignfolderCompletion"), "sEzsignfoldertypeNameX": obj.get("sEzsignfoldertypeNameX"), "fkiBillingentityinternalID": obj.get("fkiBillingentityinternalID"), "sBillingentityinternalDescriptionX": obj.get("sBillingentityinternalDescriptionX"), diff --git a/eZmaxApi/models/ezsignfolder_response_compound.py b/eZmaxApi/models/ezsignfolder_response_compound.py index dd79930fc..da79f087d 100644 --- a/eZmaxApi/models/ezsignfolder_response_compound.py +++ b/eZmaxApi/models/ezsignfolder_response_compound.py @@ -25,6 +25,7 @@ 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_completion import FieldEEzsignfolderCompletion from eZmaxApi.models.field_e_ezsignfolder_sendreminderfrequency import FieldEEzsignfolderSendreminderfrequency from eZmaxApi.models.field_e_ezsignfolder_step import FieldEEzsignfolderStep try: @@ -39,6 +40,7 @@ class EzsignfolderResponseCompound(BaseModel): 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") + e_ezsignfolder_completion: Optional[FieldEEzsignfolderCompletion] = Field(default=None, alias="eEzsignfolderCompletion") 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") @@ -58,7 +60,7 @@ class EzsignfolderResponseCompound(BaseModel): 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"] + __properties: ClassVar[List[str]] = ["pkiEzsignfolderID", "fkiEzsignfoldertypeID", "objEzsignfoldertype", "eEzsignfolderCompletion", "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): @@ -128,6 +130,7 @@ def from_dict(cls, obj: Dict) -> Self: "pkiEzsignfolderID": obj.get("pkiEzsignfolderID"), "fkiEzsignfoldertypeID": obj.get("fkiEzsignfoldertypeID"), "objEzsignfoldertype": CustomEzsignfoldertypeResponse.from_dict(obj.get("objEzsignfoldertype")) if obj.get("objEzsignfoldertype") is not None else None, + "eEzsignfolderCompletion": obj.get("eEzsignfolderCompletion"), "sEzsignfoldertypeNameX": obj.get("sEzsignfoldertypeNameX"), "fkiBillingentityinternalID": obj.get("fkiBillingentityinternalID"), "sBillingentityinternalDescriptionX": obj.get("sBillingentityinternalDescriptionX"), diff --git a/eZmaxApi/models/ezsignfoldertype_request.py b/eZmaxApi/models/ezsignfoldertype_request.py index 012d048e1..cbffe8d6e 100644 --- a/eZmaxApi/models/ezsignfoldertype_request.py +++ b/eZmaxApi/models/ezsignfoldertype_request.py @@ -23,6 +23,7 @@ from pydantic import BaseModel, StrictBool, StrictStr from pydantic import Field from typing_extensions import Annotated +from eZmaxApi.models.field_e_ezsignfoldertype_completion import FieldEEzsignfoldertypeCompletion 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 @@ -49,10 +50,13 @@ class EzsignfoldertypeRequest(BaseModel): 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") + e_ezsignfoldertype_completion: Optional[FieldEEzsignfoldertypeCompletion] = Field(default=None, alias="eEzsignfoldertypeCompletion") 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_reassignezsignsigner: Optional[StrictBool] = Field(default=None, description="Wheter if Reassignment of signature is allowed by a signatory to another signatory or not", alias="bEzsignfoldertypeReassignezsignsigner") + b_ezsignfoldertype_reassignuser: Optional[StrictBool] = Field(default=None, description="Wheter if Reassignment of signature is allowed by a user to a signatory or another user or not", alias="bEzsignfoldertypeReassignuser") 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") @@ -77,7 +81,7 @@ class EzsignfoldertypeRequest(BaseModel): 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"] + __properties: ClassVar[List[str]] = ["pkiEzsignfoldertypeID", "objEzsignfoldertypeName", "fkiBrandingID", "fkiBillingentityinternalID", "fkiUsergroupID", "fkiUsergroupIDRestricted", "fkiEzsigntsarequirementID", "sEmailAddressSigned", "sEmailAddressSummary", "eEzsignfoldertypePrivacylevel", "eEzsignfoldertypeSendreminderfrequency", "iEzsignfoldertypeArchivaldays", "eEzsignfoldertypeDisposal", "eEzsignfoldertypeCompletion", "iEzsignfoldertypeDisposaldays", "iEzsignfoldertypeDeadlinedays", "bEzsignfoldertypeDelegate", "bEzsignfoldertypeReassign", "bEzsignfoldertypeReassignezsignsigner", "bEzsignfoldertypeReassignuser", "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, @@ -144,10 +148,13 @@ def from_dict(cls, obj: Dict) -> Self: "eEzsignfoldertypeSendreminderfrequency": obj.get("eEzsignfoldertypeSendreminderfrequency"), "iEzsignfoldertypeArchivaldays": obj.get("iEzsignfoldertypeArchivaldays"), "eEzsignfoldertypeDisposal": obj.get("eEzsignfoldertypeDisposal"), + "eEzsignfoldertypeCompletion": obj.get("eEzsignfoldertypeCompletion"), "iEzsignfoldertypeDisposaldays": obj.get("iEzsignfoldertypeDisposaldays"), "iEzsignfoldertypeDeadlinedays": obj.get("iEzsignfoldertypeDeadlinedays"), "bEzsignfoldertypeDelegate": obj.get("bEzsignfoldertypeDelegate"), "bEzsignfoldertypeReassign": obj.get("bEzsignfoldertypeReassign"), + "bEzsignfoldertypeReassignezsignsigner": obj.get("bEzsignfoldertypeReassignezsignsigner"), + "bEzsignfoldertypeReassignuser": obj.get("bEzsignfoldertypeReassignuser"), "bEzsignfoldertypeSendattatchmentsigner": obj.get("bEzsignfoldertypeSendattatchmentsigner"), "bEzsignfoldertypeSendsignedtoezsignsigner": obj.get("bEzsignfoldertypeSendsignedtoezsignsigner"), "bEzsignfoldertypeSendsignedtouser": obj.get("bEzsignfoldertypeSendsignedtouser"), diff --git a/eZmaxApi/models/ezsignfoldertype_request_compound.py b/eZmaxApi/models/ezsignfoldertype_request_compound.py index fd074b6b5..fc6f0e6c8 100644 --- a/eZmaxApi/models/ezsignfoldertype_request_compound.py +++ b/eZmaxApi/models/ezsignfoldertype_request_compound.py @@ -23,6 +23,7 @@ from pydantic import BaseModel, StrictBool, StrictStr from pydantic import Field from typing_extensions import Annotated +from eZmaxApi.models.field_e_ezsignfoldertype_completion import FieldEEzsignfoldertypeCompletion 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 @@ -49,10 +50,13 @@ class EzsignfoldertypeRequestCompound(BaseModel): 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") + e_ezsignfoldertype_completion: Optional[FieldEEzsignfoldertypeCompletion] = Field(default=None, alias="eEzsignfoldertypeCompletion") 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_reassignezsignsigner: Optional[StrictBool] = Field(default=None, description="Wheter if Reassignment of signature is allowed by a signatory to another signatory or not", alias="bEzsignfoldertypeReassignezsignsigner") + b_ezsignfoldertype_reassignuser: Optional[StrictBool] = Field(default=None, description="Wheter if Reassignment of signature is allowed by a user to a signatory or another user or not", alias="bEzsignfoldertypeReassignuser") 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") @@ -79,7 +83,7 @@ class EzsignfoldertypeRequestCompound(BaseModel): 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"] + __properties: ClassVar[List[str]] = ["pkiEzsignfoldertypeID", "objEzsignfoldertypeName", "fkiBrandingID", "fkiBillingentityinternalID", "fkiUsergroupID", "fkiUsergroupIDRestricted", "fkiEzsigntsarequirementID", "sEmailAddressSigned", "sEmailAddressSummary", "eEzsignfoldertypePrivacylevel", "eEzsignfoldertypeSendreminderfrequency", "iEzsignfoldertypeArchivaldays", "eEzsignfoldertypeDisposal", "eEzsignfoldertypeCompletion", "iEzsignfoldertypeDisposaldays", "iEzsignfoldertypeDeadlinedays", "bEzsignfoldertypeDelegate", "bEzsignfoldertypeReassign", "bEzsignfoldertypeReassignezsignsigner", "bEzsignfoldertypeReassignuser", "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, @@ -146,10 +150,13 @@ def from_dict(cls, obj: Dict) -> Self: "eEzsignfoldertypeSendreminderfrequency": obj.get("eEzsignfoldertypeSendreminderfrequency"), "iEzsignfoldertypeArchivaldays": obj.get("iEzsignfoldertypeArchivaldays"), "eEzsignfoldertypeDisposal": obj.get("eEzsignfoldertypeDisposal"), + "eEzsignfoldertypeCompletion": obj.get("eEzsignfoldertypeCompletion"), "iEzsignfoldertypeDisposaldays": obj.get("iEzsignfoldertypeDisposaldays"), "iEzsignfoldertypeDeadlinedays": obj.get("iEzsignfoldertypeDeadlinedays"), "bEzsignfoldertypeDelegate": obj.get("bEzsignfoldertypeDelegate"), "bEzsignfoldertypeReassign": obj.get("bEzsignfoldertypeReassign"), + "bEzsignfoldertypeReassignezsignsigner": obj.get("bEzsignfoldertypeReassignezsignsigner"), + "bEzsignfoldertypeReassignuser": obj.get("bEzsignfoldertypeReassignuser"), "bEzsignfoldertypeSendattatchmentsigner": obj.get("bEzsignfoldertypeSendattatchmentsigner"), "bEzsignfoldertypeSendsignedtoezsignsigner": obj.get("bEzsignfoldertypeSendsignedtoezsignsigner"), "bEzsignfoldertypeSendsignedtouser": obj.get("bEzsignfoldertypeSendsignedtouser"), diff --git a/eZmaxApi/models/ezsignfoldertype_response.py b/eZmaxApi/models/ezsignfoldertype_response.py index 2259c0989..c23696648 100644 --- a/eZmaxApi/models/ezsignfoldertype_response.py +++ b/eZmaxApi/models/ezsignfoldertype_response.py @@ -23,6 +23,7 @@ from pydantic import BaseModel, StrictBool, StrictStr, field_validator from pydantic import Field from typing_extensions import Annotated +from eZmaxApi.models.field_e_ezsignfoldertype_completion import FieldEEzsignfoldertypeCompletion 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 @@ -54,10 +55,13 @@ class EzsignfoldertypeResponse(BaseModel): 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") + e_ezsignfoldertype_completion: Optional[FieldEEzsignfoldertypeCompletion] = Field(default=None, alias="eEzsignfoldertypeCompletion") 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_reassignezsignsigner: Optional[StrictBool] = Field(default=None, description="Wheter if Reassignment of signature is allowed by a signatory to another signatory or not", alias="bEzsignfoldertypeReassignezsignsigner") + b_ezsignfoldertype_reassignuser: Optional[StrictBool] = Field(default=None, description="Wheter if Reassignment of signature is allowed by a user to a signatory or another user or not", alias="bEzsignfoldertypeReassignuser") 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") @@ -82,7 +86,7 @@ class EzsignfoldertypeResponse(BaseModel): 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"] + __properties: ClassVar[List[str]] = ["pkiEzsignfoldertypeID", "objEzsignfoldertypeName", "fkiBrandingID", "fkiBillingentityinternalID", "fkiUsergroupID", "fkiUsergroupIDRestricted", "fkiEzsigntsarequirementID", "sBrandingDescriptionX", "sBillingentityinternalDescriptionX", "sEzsigntsarequirementDescriptionX", "sEmailAddressSigned", "sEmailAddressSummary", "sUsergroupNameX", "sUsergroupNameXRestricted", "eEzsignfoldertypePrivacylevel", "eEzsignfoldertypeSendreminderfrequency", "iEzsignfoldertypeArchivaldays", "eEzsignfoldertypeDisposal", "eEzsignfoldertypeCompletion", "iEzsignfoldertypeDisposaldays", "iEzsignfoldertypeDeadlinedays", "bEzsignfoldertypeDelegate", "bEzsignfoldertypeReassign", "bEzsignfoldertypeReassignezsignsigner", "bEzsignfoldertypeReassignuser", "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): @@ -174,10 +178,13 @@ def from_dict(cls, obj: Dict) -> Self: "eEzsignfoldertypeSendreminderfrequency": obj.get("eEzsignfoldertypeSendreminderfrequency"), "iEzsignfoldertypeArchivaldays": obj.get("iEzsignfoldertypeArchivaldays"), "eEzsignfoldertypeDisposal": obj.get("eEzsignfoldertypeDisposal"), + "eEzsignfoldertypeCompletion": obj.get("eEzsignfoldertypeCompletion"), "iEzsignfoldertypeDisposaldays": obj.get("iEzsignfoldertypeDisposaldays"), "iEzsignfoldertypeDeadlinedays": obj.get("iEzsignfoldertypeDeadlinedays"), "bEzsignfoldertypeDelegate": obj.get("bEzsignfoldertypeDelegate"), "bEzsignfoldertypeReassign": obj.get("bEzsignfoldertypeReassign"), + "bEzsignfoldertypeReassignezsignsigner": obj.get("bEzsignfoldertypeReassignezsignsigner"), + "bEzsignfoldertypeReassignuser": obj.get("bEzsignfoldertypeReassignuser"), "bEzsignfoldertypeSendattatchmentsigner": obj.get("bEzsignfoldertypeSendattatchmentsigner"), "bEzsignfoldertypeSendsignedtoezsignsigner": obj.get("bEzsignfoldertypeSendsignedtoezsignsigner"), "bEzsignfoldertypeSendsignedtouser": obj.get("bEzsignfoldertypeSendsignedtouser"), diff --git a/eZmaxApi/models/ezsignfoldertype_response_compound.py b/eZmaxApi/models/ezsignfoldertype_response_compound.py index 43c4671c2..e146bba46 100644 --- a/eZmaxApi/models/ezsignfoldertype_response_compound.py +++ b/eZmaxApi/models/ezsignfoldertype_response_compound.py @@ -23,6 +23,7 @@ from pydantic import BaseModel, StrictBool, StrictStr, field_validator from pydantic import Field from typing_extensions import Annotated +from eZmaxApi.models.field_e_ezsignfoldertype_completion import FieldEEzsignfoldertypeCompletion 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 @@ -54,10 +55,13 @@ class EzsignfoldertypeResponseCompound(BaseModel): 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") + e_ezsignfoldertype_completion: Optional[FieldEEzsignfoldertypeCompletion] = Field(default=None, alias="eEzsignfoldertypeCompletion") 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_reassignezsignsigner: Optional[StrictBool] = Field(default=None, description="Wheter if Reassignment of signature is allowed by a signatory to another signatory or not", alias="bEzsignfoldertypeReassignezsignsigner") + b_ezsignfoldertype_reassignuser: Optional[StrictBool] = Field(default=None, description="Wheter if Reassignment of signature is allowed by a user to a signatory or another user or not", alias="bEzsignfoldertypeReassignuser") 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") @@ -84,7 +88,7 @@ class EzsignfoldertypeResponseCompound(BaseModel): 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"] + __properties: ClassVar[List[str]] = ["pkiEzsignfoldertypeID", "objEzsignfoldertypeName", "fkiBrandingID", "fkiBillingentityinternalID", "fkiUsergroupID", "fkiUsergroupIDRestricted", "fkiEzsigntsarequirementID", "sBrandingDescriptionX", "sBillingentityinternalDescriptionX", "sEzsigntsarequirementDescriptionX", "sEmailAddressSigned", "sEmailAddressSummary", "sUsergroupNameX", "sUsergroupNameXRestricted", "eEzsignfoldertypePrivacylevel", "eEzsignfoldertypeSendreminderfrequency", "iEzsignfoldertypeArchivaldays", "eEzsignfoldertypeDisposal", "eEzsignfoldertypeCompletion", "iEzsignfoldertypeDisposaldays", "iEzsignfoldertypeDeadlinedays", "bEzsignfoldertypeDelegate", "bEzsignfoldertypeReassign", "bEzsignfoldertypeReassignezsignsigner", "bEzsignfoldertypeReassignuser", "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): @@ -176,10 +180,13 @@ def from_dict(cls, obj: Dict) -> Self: "eEzsignfoldertypeSendreminderfrequency": obj.get("eEzsignfoldertypeSendreminderfrequency"), "iEzsignfoldertypeArchivaldays": obj.get("iEzsignfoldertypeArchivaldays"), "eEzsignfoldertypeDisposal": obj.get("eEzsignfoldertypeDisposal"), + "eEzsignfoldertypeCompletion": obj.get("eEzsignfoldertypeCompletion"), "iEzsignfoldertypeDisposaldays": obj.get("iEzsignfoldertypeDisposaldays"), "iEzsignfoldertypeDeadlinedays": obj.get("iEzsignfoldertypeDeadlinedays"), "bEzsignfoldertypeDelegate": obj.get("bEzsignfoldertypeDelegate"), "bEzsignfoldertypeReassign": obj.get("bEzsignfoldertypeReassign"), + "bEzsignfoldertypeReassignezsignsigner": obj.get("bEzsignfoldertypeReassignezsignsigner"), + "bEzsignfoldertypeReassignuser": obj.get("bEzsignfoldertypeReassignuser"), "bEzsignfoldertypeSendattatchmentsigner": obj.get("bEzsignfoldertypeSendattatchmentsigner"), "bEzsignfoldertypeSendsignedtoezsignsigner": obj.get("bEzsignfoldertypeSendsignedtoezsignsigner"), "bEzsignfoldertypeSendsignedtouser": obj.get("bEzsignfoldertypeSendsignedtouser"), diff --git a/eZmaxApi/models/ezsignformfield_request.py b/eZmaxApi/models/ezsignformfield_request.py index f0e0b568b..0f0ad4ad6 100644 --- a/eZmaxApi/models/ezsignformfield_request.py +++ b/eZmaxApi/models/ezsignformfield_request.py @@ -43,7 +43,7 @@ class EzsignformfieldRequest(BaseModel): 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") + 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** You can use the codes below and they will be replaced at signature time. | Code | Description | Example | | ------------------------- | ------------ | ------------ | | {sUserFirstname} | The first name of the contact | John | | {sUserLastname} | The last name of the contact | Doe | | {sUserJobtitle} | The job title | Sales Representative | | {sEmailAddress} | The email address | email@example.com | | {sPhoneE164} | A phone number in E.164 Format | +15149901516 | | {sPhoneE164Cell} | A phone number in E.164 Format | +15149901516 |", 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"] diff --git a/eZmaxApi/models/ezsignformfield_request_compound.py b/eZmaxApi/models/ezsignformfield_request_compound.py index e2ee26c93..b1f70c012 100644 --- a/eZmaxApi/models/ezsignformfield_request_compound.py +++ b/eZmaxApi/models/ezsignformfield_request_compound.py @@ -44,7 +44,7 @@ class EzsignformfieldRequestCompound(BaseModel): 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") + 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** You can use the codes below and they will be replaced at signature time. | Code | Description | Example | | ------------------------- | ------------ | ------------ | | {sUserFirstname} | The first name of the contact | John | | {sUserLastname} | The last name of the contact | Doe | | {sUserJobtitle} | The job title | Sales Representative | | {sEmailAddress} | The email address | email@example.com | | {sPhoneE164} | A phone number in E.164 Format | +15149901516 | | {sPhoneE164Cell} | A phone number in E.164 Format | +15149901516 |", 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"] diff --git a/eZmaxApi/models/ezsignformfield_response.py b/eZmaxApi/models/ezsignformfield_response.py index 461ea684d..2b66191e5 100644 --- a/eZmaxApi/models/ezsignformfield_response.py +++ b/eZmaxApi/models/ezsignformfield_response.py @@ -43,7 +43,7 @@ class EzsignformfieldResponse(BaseModel): 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") + 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** You can use the codes below and they will be replaced at signature time. | Code | Description | Example | | ------------------------- | ------------ | ------------ | | {sUserFirstname} | The first name of the contact | John | | {sUserLastname} | The last name of the contact | Doe | | {sUserJobtitle} | The job title | Sales Representative | | {sEmailAddress} | The email address | email@example.com | | {sPhoneE164} | A phone number in E.164 Format | +15149901516 | | {sPhoneE164Cell} | A phone number in E.164 Format | +15149901516 |", 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"] diff --git a/eZmaxApi/models/ezsignformfield_response_compound.py b/eZmaxApi/models/ezsignformfield_response_compound.py index 45ac8f6d8..c41aae8dd 100644 --- a/eZmaxApi/models/ezsignformfield_response_compound.py +++ b/eZmaxApi/models/ezsignformfield_response_compound.py @@ -44,7 +44,7 @@ class EzsignformfieldResponseCompound(BaseModel): 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") + 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** You can use the codes below and they will be replaced at signature time. | Code | Description | Example | | ------------------------- | ------------ | ------------ | | {sUserFirstname} | The first name of the contact | John | | {sUserLastname} | The last name of the contact | Doe | | {sUserJobtitle} | The job title | Sales Representative | | {sEmailAddress} | The email address | email@example.com | | {sPhoneE164} | A phone number in E.164 Format | +15149901516 | | {sPhoneE164Cell} | A phone number in E.164 Format | +15149901516 |", 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"] diff --git a/eZmaxApi/models/ezsignsignature_response.py b/eZmaxApi/models/ezsignsignature_response.py index 25d4cbf79..ca8152b40 100644 --- a/eZmaxApi/models/ezsignsignature_response.py +++ b/eZmaxApi/models/ezsignsignature_response.py @@ -51,6 +51,7 @@ class EzsignsignatureResponse(BaseModel): 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") + i_ezsignsignature_stepadjusted: Optional[StrictInt] = Field(default=None, description="The step when the Ezsignsigner will be invited to sign", alias="iEzsignsignatureStepadjusted") 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") @@ -70,7 +71,7 @@ class EzsignsignatureResponse(BaseModel): 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"] + __properties: ClassVar[List[str]] = ["pkiEzsignsignatureID", "fkiEzsigndocumentID", "fkiEzsignfoldersignerassociationID", "fkiEzsignsigningreasonID", "sEzsignsigningreasonDescriptionX", "iEzsignpagePagenumber", "iEzsignsignatureX", "iEzsignsignatureY", "iEzsignsignatureHeight", "iEzsignsignatureWidth", "iEzsignsignatureStep", "iEzsignsignatureStepadjusted", "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): @@ -171,6 +172,7 @@ def from_dict(cls, obj: Dict) -> Self: "iEzsignsignatureHeight": obj.get("iEzsignsignatureHeight"), "iEzsignsignatureWidth": obj.get("iEzsignsignatureWidth"), "iEzsignsignatureStep": obj.get("iEzsignsignatureStep"), + "iEzsignsignatureStepadjusted": obj.get("iEzsignsignatureStepadjusted"), "eEzsignsignatureType": obj.get("eEzsignsignatureType"), "tEzsignsignatureTooltip": obj.get("tEzsignsignatureTooltip"), "eEzsignsignatureTooltipposition": obj.get("eEzsignsignatureTooltipposition"), diff --git a/eZmaxApi/models/ezsignsignature_response_compound.py b/eZmaxApi/models/ezsignsignature_response_compound.py index 7d3724572..6860d8e16 100644 --- a/eZmaxApi/models/ezsignsignature_response_compound.py +++ b/eZmaxApi/models/ezsignsignature_response_compound.py @@ -54,6 +54,7 @@ class EzsignsignatureResponseCompound(BaseModel): 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") + i_ezsignsignature_stepadjusted: Optional[StrictInt] = Field(default=None, description="The step when the Ezsignsigner will be invited to sign", alias="iEzsignsignatureStepadjusted") 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") @@ -77,7 +78,7 @@ class EzsignsignatureResponseCompound(BaseModel): 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"] + __properties: ClassVar[List[str]] = ["pkiEzsignsignatureID", "fkiEzsigndocumentID", "fkiEzsignfoldersignerassociationID", "fkiEzsignsigningreasonID", "sEzsignsigningreasonDescriptionX", "iEzsignpagePagenumber", "iEzsignsignatureX", "iEzsignsignatureY", "iEzsignsignatureHeight", "iEzsignsignatureWidth", "iEzsignsignatureStep", "iEzsignsignatureStepadjusted", "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): @@ -195,6 +196,7 @@ def from_dict(cls, obj: Dict) -> Self: "iEzsignsignatureHeight": obj.get("iEzsignsignatureHeight"), "iEzsignsignatureWidth": obj.get("iEzsignsignatureWidth"), "iEzsignsignatureStep": obj.get("iEzsignsignatureStep"), + "iEzsignsignatureStepadjusted": obj.get("iEzsignsignatureStepadjusted"), "eEzsignsignatureType": obj.get("eEzsignsignatureType"), "tEzsignsignatureTooltip": obj.get("tEzsignsignatureTooltip"), "eEzsignsignatureTooltipposition": obj.get("eEzsignsignatureTooltipposition"), diff --git a/eZmaxApi/models/ezsigntemplateformfield_request.py b/eZmaxApi/models/ezsigntemplateformfield_request.py index dfdac1f11..a7ac566d8 100644 --- a/eZmaxApi/models/ezsigntemplateformfield_request.py +++ b/eZmaxApi/models/ezsigntemplateformfield_request.py @@ -20,10 +20,12 @@ from typing import Any, ClassVar, Dict, List, Optional -from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import BaseModel, StrictBool, StrictInt, StrictStr, field_validator from pydantic import Field from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsigntemplateformfield_dependencyrequirement import FieldEEzsigntemplateformfieldDependencyrequirement +from eZmaxApi.models.field_e_ezsigntemplateformfield_positioning import FieldEEzsigntemplateformfieldPositioning +from eZmaxApi.models.field_e_ezsigntemplateformfield_positioningoccurence import FieldEEzsigntemplateformfieldPositioningoccurence try: from typing import Self except ImportError: @@ -34,17 +36,32 @@ class EzsigntemplateformfieldRequest(BaseModel): 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") + e_ezsigntemplateformfield_positioning: Optional[FieldEEzsigntemplateformfieldPositioning] = Field(default=None, alias="eEzsigntemplateformfieldPositioning") 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_x: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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"] + s_ezsigntemplateformfield_positioningpattern: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The string pattern to search for the positioning. **This is not a regexp** This will be required if **eEzsigntemplateformfieldPositioning** is set to **PerCoordinates**", alias="sEzsigntemplateformfieldPositioningpattern") + i_ezsigntemplateformfield_positioningoffsetx: Optional[StrictInt] = Field(default=None, description="The offset X This will be required if **eEzsigntemplateformfieldPositioning** is set to **PerCoordinates**", alias="iEzsigntemplateformfieldPositioningoffsetx") + i_ezsigntemplateformfield_positioningoffsety: Optional[StrictInt] = Field(default=None, description="The offset Y This will be required if **eEzsigntemplateformfieldPositioning** is set to **PerCoordinates**", alias="iEzsigntemplateformfieldPositioningoffsety") + e_ezsigntemplateformfield_positioningoccurence: Optional[FieldEEzsigntemplateformfieldPositioningoccurence] = Field(default=None, alias="eEzsigntemplateformfieldPositioningoccurence") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplateformfieldID", "eEzsigntemplateformfieldPositioning", "iEzsigntemplatedocumentpagePagenumber", "sEzsigntemplateformfieldLabel", "sEzsigntemplateformfieldValue", "iEzsigntemplateformfieldX", "iEzsigntemplateformfieldY", "iEzsigntemplateformfieldWidth", "iEzsigntemplateformfieldHeight", "bEzsigntemplateformfieldAutocomplete", "bEzsigntemplateformfieldSelected", "eEzsigntemplateformfieldDependencyrequirement", "sEzsigntemplateformfieldPositioningpattern", "iEzsigntemplateformfieldPositioningoffsetx", "iEzsigntemplateformfieldPositioningoffsety", "eEzsigntemplateformfieldPositioningoccurence"] + + @field_validator('s_ezsigntemplateformfield_positioningpattern') + def s_ezsigntemplateformfield_positioningpattern_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^.{0,30}$", value): + raise ValueError(r"must validate the regular expression /^.{0,30}$/") + return value model_config = { "populate_by_name": True, @@ -96,6 +113,7 @@ def from_dict(cls, obj: Dict) -> Self: _obj = cls.model_validate({ "pkiEzsigntemplateformfieldID": obj.get("pkiEzsigntemplateformfieldID"), + "eEzsigntemplateformfieldPositioning": obj.get("eEzsigntemplateformfieldPositioning"), "iEzsigntemplatedocumentpagePagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), "sEzsigntemplateformfieldLabel": obj.get("sEzsigntemplateformfieldLabel"), "sEzsigntemplateformfieldValue": obj.get("sEzsigntemplateformfieldValue"), @@ -105,7 +123,11 @@ def from_dict(cls, obj: Dict) -> Self: "iEzsigntemplateformfieldHeight": obj.get("iEzsigntemplateformfieldHeight"), "bEzsigntemplateformfieldAutocomplete": obj.get("bEzsigntemplateformfieldAutocomplete"), "bEzsigntemplateformfieldSelected": obj.get("bEzsigntemplateformfieldSelected"), - "eEzsigntemplateformfieldDependencyrequirement": obj.get("eEzsigntemplateformfieldDependencyrequirement") + "eEzsigntemplateformfieldDependencyrequirement": obj.get("eEzsigntemplateformfieldDependencyrequirement"), + "sEzsigntemplateformfieldPositioningpattern": obj.get("sEzsigntemplateformfieldPositioningpattern"), + "iEzsigntemplateformfieldPositioningoffsetx": obj.get("iEzsigntemplateformfieldPositioningoffsetx"), + "iEzsigntemplateformfieldPositioningoffsety": obj.get("iEzsigntemplateformfieldPositioningoffsety"), + "eEzsigntemplateformfieldPositioningoccurence": obj.get("eEzsigntemplateformfieldPositioningoccurence") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplateformfield_request_compound.py b/eZmaxApi/models/ezsigntemplateformfield_request_compound.py index 28c344b89..777d20f1c 100644 --- a/eZmaxApi/models/ezsigntemplateformfield_request_compound.py +++ b/eZmaxApi/models/ezsigntemplateformfield_request_compound.py @@ -20,11 +20,13 @@ from typing import Any, ClassVar, Dict, List, Optional -from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import BaseModel, StrictBool, StrictInt, StrictStr, field_validator 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 +from eZmaxApi.models.field_e_ezsigntemplateformfield_positioning import FieldEEzsigntemplateformfieldPositioning +from eZmaxApi.models.field_e_ezsigntemplateformfield_positioningoccurence import FieldEEzsigntemplateformfieldPositioningoccurence try: from typing import Self except ImportError: @@ -35,18 +37,33 @@ class EzsigntemplateformfieldRequestCompound(BaseModel): 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") + e_ezsigntemplateformfield_positioning: Optional[FieldEEzsigntemplateformfieldPositioning] = Field(default=None, alias="eEzsigntemplateformfieldPositioning") 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_x: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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") + s_ezsigntemplateformfield_positioningpattern: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The string pattern to search for the positioning. **This is not a regexp** This will be required if **eEzsigntemplateformfieldPositioning** is set to **PerCoordinates**", alias="sEzsigntemplateformfieldPositioningpattern") + i_ezsigntemplateformfield_positioningoffsetx: Optional[StrictInt] = Field(default=None, description="The offset X This will be required if **eEzsigntemplateformfieldPositioning** is set to **PerCoordinates**", alias="iEzsigntemplateformfieldPositioningoffsetx") + i_ezsigntemplateformfield_positioningoffsety: Optional[StrictInt] = Field(default=None, description="The offset Y This will be required if **eEzsigntemplateformfieldPositioning** is set to **PerCoordinates**", alias="iEzsigntemplateformfieldPositioningoffsety") + e_ezsigntemplateformfield_positioningoccurence: Optional[FieldEEzsigntemplateformfieldPositioningoccurence] = Field(default=None, alias="eEzsigntemplateformfieldPositioningoccurence") 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"] + __properties: ClassVar[List[str]] = ["pkiEzsigntemplateformfieldID", "eEzsigntemplateformfieldPositioning", "iEzsigntemplatedocumentpagePagenumber", "sEzsigntemplateformfieldLabel", "sEzsigntemplateformfieldValue", "iEzsigntemplateformfieldX", "iEzsigntemplateformfieldY", "iEzsigntemplateformfieldWidth", "iEzsigntemplateformfieldHeight", "bEzsigntemplateformfieldAutocomplete", "bEzsigntemplateformfieldSelected", "eEzsigntemplateformfieldDependencyrequirement", "sEzsigntemplateformfieldPositioningpattern", "iEzsigntemplateformfieldPositioningoffsetx", "iEzsigntemplateformfieldPositioningoffsety", "eEzsigntemplateformfieldPositioningoccurence", "a_objEzsigntemplateelementdependency"] + + @field_validator('s_ezsigntemplateformfield_positioningpattern') + def s_ezsigntemplateformfield_positioningpattern_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^.{0,30}$", value): + raise ValueError(r"must validate the regular expression /^.{0,30}$/") + return value model_config = { "populate_by_name": True, @@ -105,6 +122,7 @@ def from_dict(cls, obj: Dict) -> Self: _obj = cls.model_validate({ "pkiEzsigntemplateformfieldID": obj.get("pkiEzsigntemplateformfieldID"), + "eEzsigntemplateformfieldPositioning": obj.get("eEzsigntemplateformfieldPositioning"), "iEzsigntemplatedocumentpagePagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), "sEzsigntemplateformfieldLabel": obj.get("sEzsigntemplateformfieldLabel"), "sEzsigntemplateformfieldValue": obj.get("sEzsigntemplateformfieldValue"), @@ -115,6 +133,10 @@ def from_dict(cls, obj: Dict) -> Self: "bEzsigntemplateformfieldAutocomplete": obj.get("bEzsigntemplateformfieldAutocomplete"), "bEzsigntemplateformfieldSelected": obj.get("bEzsigntemplateformfieldSelected"), "eEzsigntemplateformfieldDependencyrequirement": obj.get("eEzsigntemplateformfieldDependencyrequirement"), + "sEzsigntemplateformfieldPositioningpattern": obj.get("sEzsigntemplateformfieldPositioningpattern"), + "iEzsigntemplateformfieldPositioningoffsetx": obj.get("iEzsigntemplateformfieldPositioningoffsetx"), + "iEzsigntemplateformfieldPositioningoffsety": obj.get("iEzsigntemplateformfieldPositioningoffsety"), + "eEzsigntemplateformfieldPositioningoccurence": obj.get("eEzsigntemplateformfieldPositioningoccurence"), "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 4f51a04d7..ae266ab09 100644 --- a/eZmaxApi/models/ezsigntemplateformfield_response.py +++ b/eZmaxApi/models/ezsigntemplateformfield_response.py @@ -20,10 +20,12 @@ from typing import Any, ClassVar, Dict, List, Optional -from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import BaseModel, StrictBool, StrictInt, StrictStr, field_validator from pydantic import Field from typing_extensions import Annotated from eZmaxApi.models.field_e_ezsigntemplateformfield_dependencyrequirement import FieldEEzsigntemplateformfieldDependencyrequirement +from eZmaxApi.models.field_e_ezsigntemplateformfield_positioning import FieldEEzsigntemplateformfieldPositioning +from eZmaxApi.models.field_e_ezsigntemplateformfield_positioningoccurence import FieldEEzsigntemplateformfieldPositioningoccurence try: from typing import Self except ImportError: @@ -34,17 +36,32 @@ class EzsigntemplateformfieldResponse(BaseModel): 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") + e_ezsigntemplateformfield_positioning: Optional[FieldEEzsigntemplateformfieldPositioning] = Field(default=None, alias="eEzsigntemplateformfieldPositioning") 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_x: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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"] + s_ezsigntemplateformfield_positioningpattern: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The string pattern to search for the positioning. **This is not a regexp** This will be required if **eEzsigntemplateformfieldPositioning** is set to **PerCoordinates**", alias="sEzsigntemplateformfieldPositioningpattern") + i_ezsigntemplateformfield_positioningoffsetx: Optional[StrictInt] = Field(default=None, description="The offset X This will be required if **eEzsigntemplateformfieldPositioning** is set to **PerCoordinates**", alias="iEzsigntemplateformfieldPositioningoffsetx") + i_ezsigntemplateformfield_positioningoffsety: Optional[StrictInt] = Field(default=None, description="The offset Y This will be required if **eEzsigntemplateformfieldPositioning** is set to **PerCoordinates**", alias="iEzsigntemplateformfieldPositioningoffsety") + e_ezsigntemplateformfield_positioningoccurence: Optional[FieldEEzsigntemplateformfieldPositioningoccurence] = Field(default=None, alias="eEzsigntemplateformfieldPositioningoccurence") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplateformfieldID", "eEzsigntemplateformfieldPositioning", "iEzsigntemplatedocumentpagePagenumber", "sEzsigntemplateformfieldLabel", "sEzsigntemplateformfieldValue", "iEzsigntemplateformfieldX", "iEzsigntemplateformfieldY", "iEzsigntemplateformfieldWidth", "iEzsigntemplateformfieldHeight", "bEzsigntemplateformfieldAutocomplete", "bEzsigntemplateformfieldSelected", "eEzsigntemplateformfieldDependencyrequirement", "sEzsigntemplateformfieldPositioningpattern", "iEzsigntemplateformfieldPositioningoffsetx", "iEzsigntemplateformfieldPositioningoffsety", "eEzsigntemplateformfieldPositioningoccurence"] + + @field_validator('s_ezsigntemplateformfield_positioningpattern') + def s_ezsigntemplateformfield_positioningpattern_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^.{0,30}$", value): + raise ValueError(r"must validate the regular expression /^.{0,30}$/") + return value model_config = { "populate_by_name": True, @@ -96,6 +113,7 @@ def from_dict(cls, obj: Dict) -> Self: _obj = cls.model_validate({ "pkiEzsigntemplateformfieldID": obj.get("pkiEzsigntemplateformfieldID"), + "eEzsigntemplateformfieldPositioning": obj.get("eEzsigntemplateformfieldPositioning"), "iEzsigntemplatedocumentpagePagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), "sEzsigntemplateformfieldLabel": obj.get("sEzsigntemplateformfieldLabel"), "sEzsigntemplateformfieldValue": obj.get("sEzsigntemplateformfieldValue"), @@ -105,7 +123,11 @@ def from_dict(cls, obj: Dict) -> Self: "iEzsigntemplateformfieldHeight": obj.get("iEzsigntemplateformfieldHeight"), "bEzsigntemplateformfieldAutocomplete": obj.get("bEzsigntemplateformfieldAutocomplete"), "bEzsigntemplateformfieldSelected": obj.get("bEzsigntemplateformfieldSelected"), - "eEzsigntemplateformfieldDependencyrequirement": obj.get("eEzsigntemplateformfieldDependencyrequirement") + "eEzsigntemplateformfieldDependencyrequirement": obj.get("eEzsigntemplateformfieldDependencyrequirement"), + "sEzsigntemplateformfieldPositioningpattern": obj.get("sEzsigntemplateformfieldPositioningpattern"), + "iEzsigntemplateformfieldPositioningoffsetx": obj.get("iEzsigntemplateformfieldPositioningoffsetx"), + "iEzsigntemplateformfieldPositioningoffsety": obj.get("iEzsigntemplateformfieldPositioningoffsety"), + "eEzsigntemplateformfieldPositioningoccurence": obj.get("eEzsigntemplateformfieldPositioningoccurence") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplateformfield_response_compound.py b/eZmaxApi/models/ezsigntemplateformfield_response_compound.py index 29e0041b3..15a60cc19 100644 --- a/eZmaxApi/models/ezsigntemplateformfield_response_compound.py +++ b/eZmaxApi/models/ezsigntemplateformfield_response_compound.py @@ -20,11 +20,13 @@ from typing import Any, ClassVar, Dict, List, Optional -from pydantic import BaseModel, StrictBool, StrictStr +from pydantic import BaseModel, StrictBool, StrictInt, StrictStr, field_validator 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 +from eZmaxApi.models.field_e_ezsigntemplateformfield_positioning import FieldEEzsigntemplateformfieldPositioning +from eZmaxApi.models.field_e_ezsigntemplateformfield_positioningoccurence import FieldEEzsigntemplateformfieldPositioningoccurence try: from typing import Self except ImportError: @@ -35,18 +37,33 @@ class EzsigntemplateformfieldResponseCompound(BaseModel): 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") + e_ezsigntemplateformfield_positioning: Optional[FieldEEzsigntemplateformfieldPositioning] = Field(default=None, alias="eEzsigntemplateformfieldPositioning") 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_x: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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") + s_ezsigntemplateformfield_positioningpattern: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The string pattern to search for the positioning. **This is not a regexp** This will be required if **eEzsigntemplateformfieldPositioning** is set to **PerCoordinates**", alias="sEzsigntemplateformfieldPositioningpattern") + i_ezsigntemplateformfield_positioningoffsetx: Optional[StrictInt] = Field(default=None, description="The offset X This will be required if **eEzsigntemplateformfieldPositioning** is set to **PerCoordinates**", alias="iEzsigntemplateformfieldPositioningoffsetx") + i_ezsigntemplateformfield_positioningoffsety: Optional[StrictInt] = Field(default=None, description="The offset Y This will be required if **eEzsigntemplateformfieldPositioning** is set to **PerCoordinates**", alias="iEzsigntemplateformfieldPositioningoffsety") + e_ezsigntemplateformfield_positioningoccurence: Optional[FieldEEzsigntemplateformfieldPositioningoccurence] = Field(default=None, alias="eEzsigntemplateformfieldPositioningoccurence") 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"] + __properties: ClassVar[List[str]] = ["pkiEzsigntemplateformfieldID", "eEzsigntemplateformfieldPositioning", "iEzsigntemplatedocumentpagePagenumber", "sEzsigntemplateformfieldLabel", "sEzsigntemplateformfieldValue", "iEzsigntemplateformfieldX", "iEzsigntemplateformfieldY", "iEzsigntemplateformfieldWidth", "iEzsigntemplateformfieldHeight", "bEzsigntemplateformfieldAutocomplete", "bEzsigntemplateformfieldSelected", "eEzsigntemplateformfieldDependencyrequirement", "sEzsigntemplateformfieldPositioningpattern", "iEzsigntemplateformfieldPositioningoffsetx", "iEzsigntemplateformfieldPositioningoffsety", "eEzsigntemplateformfieldPositioningoccurence", "a_objEzsigntemplateelementdependency"] + + @field_validator('s_ezsigntemplateformfield_positioningpattern') + def s_ezsigntemplateformfield_positioningpattern_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^.{0,30}$", value): + raise ValueError(r"must validate the regular expression /^.{0,30}$/") + return value model_config = { "populate_by_name": True, @@ -105,6 +122,7 @@ def from_dict(cls, obj: Dict) -> Self: _obj = cls.model_validate({ "pkiEzsigntemplateformfieldID": obj.get("pkiEzsigntemplateformfieldID"), + "eEzsigntemplateformfieldPositioning": obj.get("eEzsigntemplateformfieldPositioning"), "iEzsigntemplatedocumentpagePagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), "sEzsigntemplateformfieldLabel": obj.get("sEzsigntemplateformfieldLabel"), "sEzsigntemplateformfieldValue": obj.get("sEzsigntemplateformfieldValue"), @@ -115,6 +133,10 @@ def from_dict(cls, obj: Dict) -> Self: "bEzsigntemplateformfieldAutocomplete": obj.get("bEzsigntemplateformfieldAutocomplete"), "bEzsigntemplateformfieldSelected": obj.get("bEzsigntemplateformfieldSelected"), "eEzsigntemplateformfieldDependencyrequirement": obj.get("eEzsigntemplateformfieldDependencyrequirement"), + "sEzsigntemplateformfieldPositioningpattern": obj.get("sEzsigntemplateformfieldPositioningpattern"), + "iEzsigntemplateformfieldPositioningoffsetx": obj.get("iEzsigntemplateformfieldPositioningoffsetx"), + "iEzsigntemplateformfieldPositioningoffsety": obj.get("iEzsigntemplateformfieldPositioningoffsety"), + "eEzsigntemplateformfieldPositioningoccurence": obj.get("eEzsigntemplateformfieldPositioningoccurence"), "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/ezsigntemplatesignature_request.py b/eZmaxApi/models/ezsigntemplatesignature_request.py index 0cea6f11a..301096d91 100644 --- a/eZmaxApi/models/ezsigntemplatesignature_request.py +++ b/eZmaxApi/models/ezsigntemplatesignature_request.py @@ -27,6 +27,8 @@ 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_positioning import FieldEEzsigntemplatesignaturePositioning +from eZmaxApi.models.field_e_ezsigntemplatesignature_positioningoccurence import FieldEEzsigntemplatesignaturePositioningoccurence from eZmaxApi.models.field_e_ezsigntemplatesignature_tooltipposition import FieldEEzsigntemplatesignatureTooltipposition from eZmaxApi.models.field_e_ezsigntemplatesignature_type import FieldEEzsigntemplatesignatureType try: @@ -42,9 +44,10 @@ class EzsigntemplatesignatureRequest(BaseModel): 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") + e_ezsigntemplatesignature_positioning: Optional[FieldEEzsigntemplatesignaturePositioning] = Field(default=None, alias="eEzsigntemplatesignaturePositioning") 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_x: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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") @@ -60,7 +63,11 @@ class EzsigntemplatesignatureRequest(BaseModel): 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"] + s_ezsigntemplatesignature_positioningpattern: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The string pattern to search for the positioning. **This is not a regexp** This will be required if **eEzsigntemplatesignaturePositioning** is set to **PerCoordinates**", alias="sEzsigntemplatesignaturePositioningpattern") + i_ezsigntemplatesignature_positioningoffsetx: Optional[StrictInt] = Field(default=None, description="The offset X This will be required if **eEzsigntemplatesignaturePositioning** is set to **PerCoordinates**", alias="iEzsigntemplatesignaturePositioningoffsetx") + i_ezsigntemplatesignature_positioningoffsety: Optional[StrictInt] = Field(default=None, description="The offset Y This will be required if **eEzsigntemplatesignaturePositioning** is set to **PerCoordinates**", alias="iEzsigntemplatesignaturePositioningoffsety") + e_ezsigntemplatesignature_positioningoccurence: Optional[FieldEEzsigntemplatesignaturePositioningoccurence] = Field(default=None, alias="eEzsigntemplatesignaturePositioningoccurence") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatesignatureID", "fkiEzsigntemplatedocumentID", "fkiEzsigntemplatesignerID", "fkiEzsigntemplatesignerIDValidation", "eEzsigntemplatesignaturePositioning", "iEzsigntemplatedocumentpagePagenumber", "iEzsigntemplatesignatureX", "iEzsigntemplatesignatureY", "iEzsigntemplatesignatureWidth", "iEzsigntemplatesignatureHeight", "iEzsigntemplatesignatureStep", "eEzsigntemplatesignatureType", "tEzsigntemplatesignatureTooltip", "eEzsigntemplatesignatureTooltipposition", "eEzsigntemplatesignatureFont", "bEzsigntemplatesignatureRequired", "eEzsigntemplatesignatureAttachmentnamesource", "sEzsigntemplatesignatureAttachmentdescription", "iEzsigntemplatesignatureValidationstep", "iEzsigntemplatesignatureMaxlength", "sEzsigntemplatesignatureRegexp", "eEzsigntemplatesignatureTextvalidation", "eEzsigntemplatesignatureDependencyrequirement", "sEzsigntemplatesignaturePositioningpattern", "iEzsigntemplatesignaturePositioningoffsetx", "iEzsigntemplatesignaturePositioningoffsety", "eEzsigntemplatesignaturePositioningoccurence"] @field_validator('s_ezsigntemplatesignature_regexp') def s_ezsigntemplatesignature_regexp_validate_regular_expression(cls, value): @@ -72,6 +79,16 @@ def s_ezsigntemplatesignature_regexp_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^\^.*\$$|^$/") return value + @field_validator('s_ezsigntemplatesignature_positioningpattern') + def s_ezsigntemplatesignature_positioningpattern_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^.{0,30}$", value): + raise ValueError(r"must validate the regular expression /^.{0,30}$/") + return value + model_config = { "populate_by_name": True, "validate_assignment": True, @@ -125,6 +142,7 @@ def from_dict(cls, obj: Dict) -> Self: "fkiEzsigntemplatedocumentID": obj.get("fkiEzsigntemplatedocumentID"), "fkiEzsigntemplatesignerID": obj.get("fkiEzsigntemplatesignerID"), "fkiEzsigntemplatesignerIDValidation": obj.get("fkiEzsigntemplatesignerIDValidation"), + "eEzsigntemplatesignaturePositioning": obj.get("eEzsigntemplatesignaturePositioning"), "iEzsigntemplatedocumentpagePagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), "iEzsigntemplatesignatureX": obj.get("iEzsigntemplatesignatureX"), "iEzsigntemplatesignatureY": obj.get("iEzsigntemplatesignatureY"), @@ -142,7 +160,11 @@ def from_dict(cls, obj: Dict) -> Self: "iEzsigntemplatesignatureMaxlength": obj.get("iEzsigntemplatesignatureMaxlength"), "sEzsigntemplatesignatureRegexp": obj.get("sEzsigntemplatesignatureRegexp"), "eEzsigntemplatesignatureTextvalidation": obj.get("eEzsigntemplatesignatureTextvalidation"), - "eEzsigntemplatesignatureDependencyrequirement": obj.get("eEzsigntemplatesignatureDependencyrequirement") + "eEzsigntemplatesignatureDependencyrequirement": obj.get("eEzsigntemplatesignatureDependencyrequirement"), + "sEzsigntemplatesignaturePositioningpattern": obj.get("sEzsigntemplatesignaturePositioningpattern"), + "iEzsigntemplatesignaturePositioningoffsetx": obj.get("iEzsigntemplatesignaturePositioningoffsetx"), + "iEzsigntemplatesignaturePositioningoffsety": obj.get("iEzsigntemplatesignaturePositioningoffsety"), + "eEzsigntemplatesignaturePositioningoccurence": obj.get("eEzsigntemplatesignaturePositioningoccurence") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesignature_request_compound.py b/eZmaxApi/models/ezsigntemplatesignature_request_compound.py index 09fd19068..07a35f077 100644 --- a/eZmaxApi/models/ezsigntemplatesignature_request_compound.py +++ b/eZmaxApi/models/ezsigntemplatesignature_request_compound.py @@ -29,6 +29,8 @@ 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_positioning import FieldEEzsigntemplatesignaturePositioning +from eZmaxApi.models.field_e_ezsigntemplatesignature_positioningoccurence import FieldEEzsigntemplatesignaturePositioningoccurence from eZmaxApi.models.field_e_ezsigntemplatesignature_tooltipposition import FieldEEzsigntemplatesignatureTooltipposition from eZmaxApi.models.field_e_ezsigntemplatesignature_type import FieldEEzsigntemplatesignatureType try: @@ -44,9 +46,10 @@ class EzsigntemplatesignatureRequestCompound(BaseModel): 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") + e_ezsigntemplatesignature_positioning: Optional[FieldEEzsigntemplatesignaturePositioning] = Field(default=None, alias="eEzsigntemplatesignaturePositioning") 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_x: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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") @@ -62,10 +65,14 @@ class EzsigntemplatesignatureRequestCompound(BaseModel): 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") + s_ezsigntemplatesignature_positioningpattern: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The string pattern to search for the positioning. **This is not a regexp** This will be required if **eEzsigntemplatesignaturePositioning** is set to **PerCoordinates**", alias="sEzsigntemplatesignaturePositioningpattern") + i_ezsigntemplatesignature_positioningoffsetx: Optional[StrictInt] = Field(default=None, description="The offset X This will be required if **eEzsigntemplatesignaturePositioning** is set to **PerCoordinates**", alias="iEzsigntemplatesignaturePositioningoffsetx") + i_ezsigntemplatesignature_positioningoffsety: Optional[StrictInt] = Field(default=None, description="The offset Y This will be required if **eEzsigntemplatesignaturePositioning** is set to **PerCoordinates**", alias="iEzsigntemplatesignaturePositioningoffsety") + e_ezsigntemplatesignature_positioningoccurence: Optional[FieldEEzsigntemplatesignaturePositioningoccurence] = Field(default=None, alias="eEzsigntemplatesignaturePositioningoccurence") 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"] + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatesignatureID", "fkiEzsigntemplatedocumentID", "fkiEzsigntemplatesignerID", "fkiEzsigntemplatesignerIDValidation", "eEzsigntemplatesignaturePositioning", "iEzsigntemplatedocumentpagePagenumber", "iEzsigntemplatesignatureX", "iEzsigntemplatesignatureY", "iEzsigntemplatesignatureWidth", "iEzsigntemplatesignatureHeight", "iEzsigntemplatesignatureStep", "eEzsigntemplatesignatureType", "tEzsigntemplatesignatureTooltip", "eEzsigntemplatesignatureTooltipposition", "eEzsigntemplatesignatureFont", "bEzsigntemplatesignatureRequired", "eEzsigntemplatesignatureAttachmentnamesource", "sEzsigntemplatesignatureAttachmentdescription", "iEzsigntemplatesignatureValidationstep", "iEzsigntemplatesignatureMaxlength", "sEzsigntemplatesignatureRegexp", "eEzsigntemplatesignatureTextvalidation", "eEzsigntemplatesignatureDependencyrequirement", "sEzsigntemplatesignaturePositioningpattern", "iEzsigntemplatesignaturePositioningoffsetx", "iEzsigntemplatesignaturePositioningoffsety", "eEzsigntemplatesignaturePositioningoccurence", "bEzsigntemplatesignatureCustomdate", "a_objEzsigntemplatesignaturecustomdate", "a_objEzsigntemplateelementdependency"] @field_validator('s_ezsigntemplatesignature_regexp') def s_ezsigntemplatesignature_regexp_validate_regular_expression(cls, value): @@ -77,6 +84,16 @@ def s_ezsigntemplatesignature_regexp_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^\^.*\$$|^$/") return value + @field_validator('s_ezsigntemplatesignature_positioningpattern') + def s_ezsigntemplatesignature_positioningpattern_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^.{0,30}$", value): + raise ValueError(r"must validate the regular expression /^.{0,30}$/") + return value + model_config = { "populate_by_name": True, "validate_assignment": True, @@ -144,6 +161,7 @@ def from_dict(cls, obj: Dict) -> Self: "fkiEzsigntemplatedocumentID": obj.get("fkiEzsigntemplatedocumentID"), "fkiEzsigntemplatesignerID": obj.get("fkiEzsigntemplatesignerID"), "fkiEzsigntemplatesignerIDValidation": obj.get("fkiEzsigntemplatesignerIDValidation"), + "eEzsigntemplatesignaturePositioning": obj.get("eEzsigntemplatesignaturePositioning"), "iEzsigntemplatedocumentpagePagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), "iEzsigntemplatesignatureX": obj.get("iEzsigntemplatesignatureX"), "iEzsigntemplatesignatureY": obj.get("iEzsigntemplatesignatureY"), @@ -162,6 +180,10 @@ def from_dict(cls, obj: Dict) -> Self: "sEzsigntemplatesignatureRegexp": obj.get("sEzsigntemplatesignatureRegexp"), "eEzsigntemplatesignatureTextvalidation": obj.get("eEzsigntemplatesignatureTextvalidation"), "eEzsigntemplatesignatureDependencyrequirement": obj.get("eEzsigntemplatesignatureDependencyrequirement"), + "sEzsigntemplatesignaturePositioningpattern": obj.get("sEzsigntemplatesignaturePositioningpattern"), + "iEzsigntemplatesignaturePositioningoffsetx": obj.get("iEzsigntemplatesignaturePositioningoffsetx"), + "iEzsigntemplatesignaturePositioningoffsety": obj.get("iEzsigntemplatesignaturePositioningoffsety"), + "eEzsigntemplatesignaturePositioningoccurence": obj.get("eEzsigntemplatesignaturePositioningoccurence"), "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 diff --git a/eZmaxApi/models/ezsigntemplatesignature_response.py b/eZmaxApi/models/ezsigntemplatesignature_response.py index a23aaf98b..bf79633c2 100644 --- a/eZmaxApi/models/ezsigntemplatesignature_response.py +++ b/eZmaxApi/models/ezsigntemplatesignature_response.py @@ -27,6 +27,8 @@ 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_positioning import FieldEEzsigntemplatesignaturePositioning +from eZmaxApi.models.field_e_ezsigntemplatesignature_positioningoccurence import FieldEEzsigntemplatesignaturePositioningoccurence from eZmaxApi.models.field_e_ezsigntemplatesignature_tooltipposition import FieldEEzsigntemplatesignatureTooltipposition from eZmaxApi.models.field_e_ezsigntemplatesignature_type import FieldEEzsigntemplatesignatureType try: @@ -42,9 +44,10 @@ class EzsigntemplatesignatureResponse(BaseModel): 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") + e_ezsigntemplatesignature_positioning: Optional[FieldEEzsigntemplatesignaturePositioning] = Field(default=None, alias="eEzsigntemplatesignaturePositioning") 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_x: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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") @@ -60,7 +63,11 @@ class EzsigntemplatesignatureResponse(BaseModel): 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"] + s_ezsigntemplatesignature_positioningpattern: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The string pattern to search for the positioning. **This is not a regexp** This will be required if **eEzsigntemplatesignaturePositioning** is set to **PerCoordinates**", alias="sEzsigntemplatesignaturePositioningpattern") + i_ezsigntemplatesignature_positioningoffsetx: Optional[StrictInt] = Field(default=None, description="The offset X This will be required if **eEzsigntemplatesignaturePositioning** is set to **PerCoordinates**", alias="iEzsigntemplatesignaturePositioningoffsetx") + i_ezsigntemplatesignature_positioningoffsety: Optional[StrictInt] = Field(default=None, description="The offset Y This will be required if **eEzsigntemplatesignaturePositioning** is set to **PerCoordinates**", alias="iEzsigntemplatesignaturePositioningoffsety") + e_ezsigntemplatesignature_positioningoccurence: Optional[FieldEEzsigntemplatesignaturePositioningoccurence] = Field(default=None, alias="eEzsigntemplatesignaturePositioningoccurence") + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatesignatureID", "fkiEzsigntemplatedocumentID", "fkiEzsigntemplatesignerID", "fkiEzsigntemplatesignerIDValidation", "eEzsigntemplatesignaturePositioning", "iEzsigntemplatedocumentpagePagenumber", "iEzsigntemplatesignatureX", "iEzsigntemplatesignatureY", "iEzsigntemplatesignatureWidth", "iEzsigntemplatesignatureHeight", "iEzsigntemplatesignatureStep", "eEzsigntemplatesignatureType", "tEzsigntemplatesignatureTooltip", "eEzsigntemplatesignatureTooltipposition", "eEzsigntemplatesignatureFont", "iEzsigntemplatesignatureValidationstep", "sEzsigntemplatesignatureAttachmentdescription", "eEzsigntemplatesignatureAttachmentnamesource", "bEzsigntemplatesignatureRequired", "iEzsigntemplatesignatureMaxlength", "sEzsigntemplatesignatureRegexp", "eEzsigntemplatesignatureTextvalidation", "eEzsigntemplatesignatureDependencyrequirement", "sEzsigntemplatesignaturePositioningpattern", "iEzsigntemplatesignaturePositioningoffsetx", "iEzsigntemplatesignaturePositioningoffsety", "eEzsigntemplatesignaturePositioningoccurence"] @field_validator('s_ezsigntemplatesignature_regexp') def s_ezsigntemplatesignature_regexp_validate_regular_expression(cls, value): @@ -72,6 +79,16 @@ def s_ezsigntemplatesignature_regexp_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^\^.*\$$|^$/") return value + @field_validator('s_ezsigntemplatesignature_positioningpattern') + def s_ezsigntemplatesignature_positioningpattern_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^.{0,30}$", value): + raise ValueError(r"must validate the regular expression /^.{0,30}$/") + return value + model_config = { "populate_by_name": True, "validate_assignment": True, @@ -125,6 +142,7 @@ def from_dict(cls, obj: Dict) -> Self: "fkiEzsigntemplatedocumentID": obj.get("fkiEzsigntemplatedocumentID"), "fkiEzsigntemplatesignerID": obj.get("fkiEzsigntemplatesignerID"), "fkiEzsigntemplatesignerIDValidation": obj.get("fkiEzsigntemplatesignerIDValidation"), + "eEzsigntemplatesignaturePositioning": obj.get("eEzsigntemplatesignaturePositioning"), "iEzsigntemplatedocumentpagePagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), "iEzsigntemplatesignatureX": obj.get("iEzsigntemplatesignatureX"), "iEzsigntemplatesignatureY": obj.get("iEzsigntemplatesignatureY"), @@ -142,7 +160,11 @@ def from_dict(cls, obj: Dict) -> Self: "iEzsigntemplatesignatureMaxlength": obj.get("iEzsigntemplatesignatureMaxlength"), "sEzsigntemplatesignatureRegexp": obj.get("sEzsigntemplatesignatureRegexp"), "eEzsigntemplatesignatureTextvalidation": obj.get("eEzsigntemplatesignatureTextvalidation"), - "eEzsigntemplatesignatureDependencyrequirement": obj.get("eEzsigntemplatesignatureDependencyrequirement") + "eEzsigntemplatesignatureDependencyrequirement": obj.get("eEzsigntemplatesignatureDependencyrequirement"), + "sEzsigntemplatesignaturePositioningpattern": obj.get("sEzsigntemplatesignaturePositioningpattern"), + "iEzsigntemplatesignaturePositioningoffsetx": obj.get("iEzsigntemplatesignaturePositioningoffsetx"), + "iEzsigntemplatesignaturePositioningoffsety": obj.get("iEzsigntemplatesignaturePositioningoffsety"), + "eEzsigntemplatesignaturePositioningoccurence": obj.get("eEzsigntemplatesignaturePositioningoccurence") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesignature_response_compound.py b/eZmaxApi/models/ezsigntemplatesignature_response_compound.py index 323ee5a99..453fa3275 100644 --- a/eZmaxApi/models/ezsigntemplatesignature_response_compound.py +++ b/eZmaxApi/models/ezsigntemplatesignature_response_compound.py @@ -29,6 +29,8 @@ 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_positioning import FieldEEzsigntemplatesignaturePositioning +from eZmaxApi.models.field_e_ezsigntemplatesignature_positioningoccurence import FieldEEzsigntemplatesignaturePositioningoccurence from eZmaxApi.models.field_e_ezsigntemplatesignature_tooltipposition import FieldEEzsigntemplatesignatureTooltipposition from eZmaxApi.models.field_e_ezsigntemplatesignature_type import FieldEEzsigntemplatesignatureType try: @@ -44,9 +46,10 @@ class EzsigntemplatesignatureResponseCompound(BaseModel): 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") + e_ezsigntemplatesignature_positioning: Optional[FieldEEzsigntemplatesignaturePositioning] = Field(default=None, alias="eEzsigntemplatesignaturePositioning") 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_x: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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") @@ -62,10 +65,14 @@ class EzsigntemplatesignatureResponseCompound(BaseModel): 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") + s_ezsigntemplatesignature_positioningpattern: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The string pattern to search for the positioning. **This is not a regexp** This will be required if **eEzsigntemplatesignaturePositioning** is set to **PerCoordinates**", alias="sEzsigntemplatesignaturePositioningpattern") + i_ezsigntemplatesignature_positioningoffsetx: Optional[StrictInt] = Field(default=None, description="The offset X This will be required if **eEzsigntemplatesignaturePositioning** is set to **PerCoordinates**", alias="iEzsigntemplatesignaturePositioningoffsetx") + i_ezsigntemplatesignature_positioningoffsety: Optional[StrictInt] = Field(default=None, description="The offset Y This will be required if **eEzsigntemplatesignaturePositioning** is set to **PerCoordinates**", alias="iEzsigntemplatesignaturePositioningoffsety") + e_ezsigntemplatesignature_positioningoccurence: Optional[FieldEEzsigntemplatesignaturePositioningoccurence] = Field(default=None, alias="eEzsigntemplatesignaturePositioningoccurence") 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"] + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatesignatureID", "fkiEzsigntemplatedocumentID", "fkiEzsigntemplatesignerID", "fkiEzsigntemplatesignerIDValidation", "eEzsigntemplatesignaturePositioning", "iEzsigntemplatedocumentpagePagenumber", "iEzsigntemplatesignatureX", "iEzsigntemplatesignatureY", "iEzsigntemplatesignatureWidth", "iEzsigntemplatesignatureHeight", "iEzsigntemplatesignatureStep", "eEzsigntemplatesignatureType", "tEzsigntemplatesignatureTooltip", "eEzsigntemplatesignatureTooltipposition", "eEzsigntemplatesignatureFont", "iEzsigntemplatesignatureValidationstep", "sEzsigntemplatesignatureAttachmentdescription", "eEzsigntemplatesignatureAttachmentnamesource", "bEzsigntemplatesignatureRequired", "iEzsigntemplatesignatureMaxlength", "sEzsigntemplatesignatureRegexp", "eEzsigntemplatesignatureTextvalidation", "eEzsigntemplatesignatureDependencyrequirement", "sEzsigntemplatesignaturePositioningpattern", "iEzsigntemplatesignaturePositioningoffsetx", "iEzsigntemplatesignaturePositioningoffsety", "eEzsigntemplatesignaturePositioningoccurence", "bEzsigntemplatesignatureCustomdate", "a_objEzsigntemplatesignaturecustomdate", "a_objEzsigntemplateelementdependency"] @field_validator('s_ezsigntemplatesignature_regexp') def s_ezsigntemplatesignature_regexp_validate_regular_expression(cls, value): @@ -77,6 +84,16 @@ def s_ezsigntemplatesignature_regexp_validate_regular_expression(cls, value): raise ValueError(r"must validate the regular expression /^\^.*\$$|^$/") return value + @field_validator('s_ezsigntemplatesignature_positioningpattern') + def s_ezsigntemplatesignature_positioningpattern_validate_regular_expression(cls, value): + """Validates the regular expression""" + if value is None: + return value + + if not re.match(r"^.{0,30}$", value): + raise ValueError(r"must validate the regular expression /^.{0,30}$/") + return value + model_config = { "populate_by_name": True, "validate_assignment": True, @@ -144,6 +161,7 @@ def from_dict(cls, obj: Dict) -> Self: "fkiEzsigntemplatedocumentID": obj.get("fkiEzsigntemplatedocumentID"), "fkiEzsigntemplatesignerID": obj.get("fkiEzsigntemplatesignerID"), "fkiEzsigntemplatesignerIDValidation": obj.get("fkiEzsigntemplatesignerIDValidation"), + "eEzsigntemplatesignaturePositioning": obj.get("eEzsigntemplatesignaturePositioning"), "iEzsigntemplatedocumentpagePagenumber": obj.get("iEzsigntemplatedocumentpagePagenumber"), "iEzsigntemplatesignatureX": obj.get("iEzsigntemplatesignatureX"), "iEzsigntemplatesignatureY": obj.get("iEzsigntemplatesignatureY"), @@ -162,6 +180,10 @@ def from_dict(cls, obj: Dict) -> Self: "sEzsigntemplatesignatureRegexp": obj.get("sEzsigntemplatesignatureRegexp"), "eEzsigntemplatesignatureTextvalidation": obj.get("eEzsigntemplatesignatureTextvalidation"), "eEzsigntemplatesignatureDependencyrequirement": obj.get("eEzsigntemplatesignatureDependencyrequirement"), + "sEzsigntemplatesignaturePositioningpattern": obj.get("sEzsigntemplatesignaturePositioningpattern"), + "iEzsigntemplatesignaturePositioningoffsetx": obj.get("iEzsigntemplatesignaturePositioningoffsetx"), + "iEzsigntemplatesignaturePositioningoffsety": obj.get("iEzsigntemplatesignaturePositioningoffsety"), + "eEzsigntemplatesignaturePositioningoccurence": obj.get("eEzsigntemplatesignaturePositioningoccurence"), "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 diff --git a/eZmaxApi/models/ezsigntemplatesignaturecustomdate_request.py b/eZmaxApi/models/ezsigntemplatesignaturecustomdate_request.py index f87e23181..38cd3f547 100644 --- a/eZmaxApi/models/ezsigntemplatesignaturecustomdate_request.py +++ b/eZmaxApi/models/ezsigntemplatesignaturecustomdate_request.py @@ -33,10 +33,12 @@ class EzsigntemplatesignaturecustomdateRequest(BaseModel): 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") + i_ezsigntemplatesignaturecustomdate_x: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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") + i_ezsigntemplatesignaturecustomdate_offsetx: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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 of the signature, you would use \"200\" for the X coordinate.", alias="iEzsigntemplatesignaturecustomdateOffsetx") + i_ezsigntemplatesignaturecustomdate_offsety: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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 top of the signature, you would use \"200\" for the Y coordinate.", alias="iEzsigntemplatesignaturecustomdateOffsety") 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"] + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatesignaturecustomdateID", "iEzsigntemplatesignaturecustomdateX", "iEzsigntemplatesignaturecustomdateY", "iEzsigntemplatesignaturecustomdateOffsetx", "iEzsigntemplatesignaturecustomdateOffsety", "sEzsigntemplatesignaturecustomdateFormat"] model_config = { "populate_by_name": True, @@ -90,6 +92,8 @@ def from_dict(cls, obj: Dict) -> Self: "pkiEzsigntemplatesignaturecustomdateID": obj.get("pkiEzsigntemplatesignaturecustomdateID"), "iEzsigntemplatesignaturecustomdateX": obj.get("iEzsigntemplatesignaturecustomdateX"), "iEzsigntemplatesignaturecustomdateY": obj.get("iEzsigntemplatesignaturecustomdateY"), + "iEzsigntemplatesignaturecustomdateOffsetx": obj.get("iEzsigntemplatesignaturecustomdateOffsetx"), + "iEzsigntemplatesignaturecustomdateOffsety": obj.get("iEzsigntemplatesignaturecustomdateOffsety"), "sEzsigntemplatesignaturecustomdateFormat": obj.get("sEzsigntemplatesignaturecustomdateFormat") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesignaturecustomdate_request_compound.py b/eZmaxApi/models/ezsigntemplatesignaturecustomdate_request_compound.py index 8c5b4851f..b5f2d96d2 100644 --- a/eZmaxApi/models/ezsigntemplatesignaturecustomdate_request_compound.py +++ b/eZmaxApi/models/ezsigntemplatesignaturecustomdate_request_compound.py @@ -33,10 +33,12 @@ class EzsigntemplatesignaturecustomdateRequestCompound(BaseModel): 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") + i_ezsigntemplatesignaturecustomdate_x: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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") + i_ezsigntemplatesignaturecustomdate_offsetx: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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 of the signature, you would use \"200\" for the X coordinate.", alias="iEzsigntemplatesignaturecustomdateOffsetx") + i_ezsigntemplatesignaturecustomdate_offsety: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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 top of the signature, you would use \"200\" for the Y coordinate.", alias="iEzsigntemplatesignaturecustomdateOffsety") 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"] + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatesignaturecustomdateID", "iEzsigntemplatesignaturecustomdateX", "iEzsigntemplatesignaturecustomdateY", "iEzsigntemplatesignaturecustomdateOffsetx", "iEzsigntemplatesignaturecustomdateOffsety", "sEzsigntemplatesignaturecustomdateFormat"] model_config = { "populate_by_name": True, @@ -90,6 +92,8 @@ def from_dict(cls, obj: Dict) -> Self: "pkiEzsigntemplatesignaturecustomdateID": obj.get("pkiEzsigntemplatesignaturecustomdateID"), "iEzsigntemplatesignaturecustomdateX": obj.get("iEzsigntemplatesignaturecustomdateX"), "iEzsigntemplatesignaturecustomdateY": obj.get("iEzsigntemplatesignaturecustomdateY"), + "iEzsigntemplatesignaturecustomdateOffsetx": obj.get("iEzsigntemplatesignaturecustomdateOffsetx"), + "iEzsigntemplatesignaturecustomdateOffsety": obj.get("iEzsigntemplatesignaturecustomdateOffsety"), "sEzsigntemplatesignaturecustomdateFormat": obj.get("sEzsigntemplatesignaturecustomdateFormat") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesignaturecustomdate_response.py b/eZmaxApi/models/ezsigntemplatesignaturecustomdate_response.py index ad9633f4a..726e4f740 100644 --- a/eZmaxApi/models/ezsigntemplatesignaturecustomdate_response.py +++ b/eZmaxApi/models/ezsigntemplatesignaturecustomdate_response.py @@ -19,7 +19,7 @@ import json -from typing import Any, ClassVar, Dict, List +from typing import Any, ClassVar, Dict, List, Optional from pydantic import BaseModel, StrictStr from pydantic import Field from typing_extensions import Annotated @@ -33,10 +33,12 @@ class EzsigntemplatesignaturecustomdateResponse(BaseModel): 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") + i_ezsigntemplatesignaturecustomdate_x: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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") + i_ezsigntemplatesignaturecustomdate_offsetx: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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 of the signature, you would use \"200\" for the X coordinate.", alias="iEzsigntemplatesignaturecustomdateOffsetx") + i_ezsigntemplatesignaturecustomdate_offsety: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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 top of the signature, you would use \"200\" for the Y coordinate.", alias="iEzsigntemplatesignaturecustomdateOffsety") 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"] + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatesignaturecustomdateID", "iEzsigntemplatesignaturecustomdateX", "iEzsigntemplatesignaturecustomdateY", "iEzsigntemplatesignaturecustomdateOffsetx", "iEzsigntemplatesignaturecustomdateOffsety", "sEzsigntemplatesignaturecustomdateFormat"] model_config = { "populate_by_name": True, @@ -90,6 +92,8 @@ def from_dict(cls, obj: Dict) -> Self: "pkiEzsigntemplatesignaturecustomdateID": obj.get("pkiEzsigntemplatesignaturecustomdateID"), "iEzsigntemplatesignaturecustomdateX": obj.get("iEzsigntemplatesignaturecustomdateX"), "iEzsigntemplatesignaturecustomdateY": obj.get("iEzsigntemplatesignaturecustomdateY"), + "iEzsigntemplatesignaturecustomdateOffsetx": obj.get("iEzsigntemplatesignaturecustomdateOffsetx"), + "iEzsigntemplatesignaturecustomdateOffsety": obj.get("iEzsigntemplatesignaturecustomdateOffsety"), "sEzsigntemplatesignaturecustomdateFormat": obj.get("sEzsigntemplatesignaturecustomdateFormat") }) return _obj diff --git a/eZmaxApi/models/ezsigntemplatesignaturecustomdate_response_compound.py b/eZmaxApi/models/ezsigntemplatesignaturecustomdate_response_compound.py index 6eb24edac..302d3f5f8 100644 --- a/eZmaxApi/models/ezsigntemplatesignaturecustomdate_response_compound.py +++ b/eZmaxApi/models/ezsigntemplatesignaturecustomdate_response_compound.py @@ -19,7 +19,7 @@ import json -from typing import Any, ClassVar, Dict, List +from typing import Any, ClassVar, Dict, List, Optional from pydantic import BaseModel, StrictStr from pydantic import Field from typing_extensions import Annotated @@ -33,10 +33,12 @@ class EzsigntemplatesignaturecustomdateResponseCompound(BaseModel): 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") + i_ezsigntemplatesignaturecustomdate_x: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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") + i_ezsigntemplatesignaturecustomdate_offsetx: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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 of the signature, you would use \"200\" for the X coordinate.", alias="iEzsigntemplatesignaturecustomdateOffsetx") + i_ezsigntemplatesignaturecustomdate_offsety: Optional[Annotated[int, Field(strict=True, ge=0)]] = Field(default=None, 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 top of the signature, you would use \"200\" for the Y coordinate.", alias="iEzsigntemplatesignaturecustomdateOffsety") 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"] + __properties: ClassVar[List[str]] = ["pkiEzsigntemplatesignaturecustomdateID", "iEzsigntemplatesignaturecustomdateX", "iEzsigntemplatesignaturecustomdateY", "iEzsigntemplatesignaturecustomdateOffsetx", "iEzsigntemplatesignaturecustomdateOffsety", "sEzsigntemplatesignaturecustomdateFormat"] model_config = { "populate_by_name": True, @@ -90,6 +92,8 @@ def from_dict(cls, obj: Dict) -> Self: "pkiEzsigntemplatesignaturecustomdateID": obj.get("pkiEzsigntemplatesignaturecustomdateID"), "iEzsigntemplatesignaturecustomdateX": obj.get("iEzsigntemplatesignaturecustomdateX"), "iEzsigntemplatesignaturecustomdateY": obj.get("iEzsigntemplatesignaturecustomdateY"), + "iEzsigntemplatesignaturecustomdateOffsetx": obj.get("iEzsigntemplatesignaturecustomdateOffsetx"), + "iEzsigntemplatesignaturecustomdateOffsety": obj.get("iEzsigntemplatesignaturecustomdateOffsety"), "sEzsigntemplatesignaturecustomdateFormat": obj.get("sEzsigntemplatesignaturecustomdateFormat") }) return _obj diff --git a/eZmaxApi/models/field_e_discussionmessage_status.py b/eZmaxApi/models/field_e_discussionmessage_status.py new file mode 100644 index 000000000..63d3bbdb5 --- /dev/null +++ b/eZmaxApi/models/field_e_discussionmessage_status.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 FieldEDiscussionmessageStatus(str, Enum): + """ + The status of the Discussionmessage + """ + + """ + allowed enum values + """ + NEW = 'New' + EDITED = 'Edited' + DELETED = 'Deleted' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of FieldEDiscussionmessageStatus from a JSON string""" + 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 f768c1155..25d341b1f 100644 --- a/eZmaxApi/models/field_e_ezsigndocument_step.py +++ b/eZmaxApi/models/field_e_ezsigndocument_step.py @@ -40,6 +40,7 @@ class FieldEEzsigndocumentStep(str, Enum): PARTIALLYSIGNED = 'PartiallySigned' DECLINEDTOSIGN = 'DeclinedToSign' PREMATURELYENDED = 'PrematurelyEnded' + PENDINGCOMPLETION = 'PendingCompletion' COMPLETED = 'Completed' DISPOSED = 'Disposed' diff --git a/eZmaxApi/models/field_e_ezsignfolder_completion.py b/eZmaxApi/models/field_e_ezsignfolder_completion.py new file mode 100644 index 000000000..63d6adf4d --- /dev/null +++ b/eZmaxApi/models/field_e_ezsignfolder_completion.py @@ -0,0 +1,46 @@ +# 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 FieldEEzsignfolderCompletion(str, Enum): + """ + Indicates if the Ezsigndocument is completed when all signatures of this Ezsigndocument were applied or when all signatures of all Ezsigndocument were applied + """ + + """ + allowed enum values + """ + PEREZSIGNDOCUMENT = 'PerEzsigndocument' + PEREZSIGNFOLDER = 'PerEzsignfolder' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of FieldEEzsignfolderCompletion from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/eZmaxApi/models/field_e_ezsignfoldertype_completion.py b/eZmaxApi/models/field_e_ezsignfoldertype_completion.py new file mode 100644 index 000000000..4b25dc56f --- /dev/null +++ b/eZmaxApi/models/field_e_ezsignfoldertype_completion.py @@ -0,0 +1,46 @@ +# 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 FieldEEzsignfoldertypeCompletion(str, Enum): + """ + Indicates if the Ezsigndocument is completed when all signatures of this Ezsigndocument were applied or when all signatures of all Ezsigndocument were applied + """ + + """ + allowed enum values + """ + PEREZSIGNDOCUMENT = 'PerEzsigndocument' + PEREZSIGNFOLDER = 'PerEzsignfolder' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of FieldEEzsignfoldertypeCompletion from a JSON string""" + 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 7c74239bd..8f0c53b52 100644 --- a/eZmaxApi/models/field_e_ezsignsignature_type.py +++ b/eZmaxApi/models/field_e_ezsignsignature_type.py @@ -45,6 +45,7 @@ class FieldEEzsignsignatureType(str, Enum): ATTACHMENTSCONFIRMATION = 'AttachmentsConfirmation' FIELDTEXT = 'FieldText' FIELDTEXTAREA = 'FieldTextarea' + CONSULTATION = 'Consultation' @classmethod def from_json(cls, json_str: str) -> Self: diff --git a/eZmaxApi/models/field_e_ezsigntemplateformfield_positioning.py b/eZmaxApi/models/field_e_ezsigntemplateformfield_positioning.py new file mode 100644 index 000000000..fc5c86648 --- /dev/null +++ b/eZmaxApi/models/field_e_ezsigntemplateformfield_positioning.py @@ -0,0 +1,46 @@ +# 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 FieldEEzsigntemplateformfieldPositioning(str, Enum): + """ + How the positioning of the Ezsigntemplateformfield will be done + """ + + """ + allowed enum values + """ + PERCOORDINATES = 'PerCoordinates' + PERPOSITIONINGPATTERN = 'PerPositioningPattern' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of FieldEEzsigntemplateformfieldPositioning from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/eZmaxApi/models/field_e_ezsigntemplateformfield_positioningoccurence.py b/eZmaxApi/models/field_e_ezsigntemplateformfield_positioningoccurence.py new file mode 100644 index 000000000..862d8119d --- /dev/null +++ b/eZmaxApi/models/field_e_ezsigntemplateformfield_positioningoccurence.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 FieldEEzsigntemplateformfieldPositioningoccurence(str, Enum): + """ + The occurence of the pattern to add the Ezsigntemplateformfield This will be required if **eEzsigntemplateformfieldPositioning** is set to **PerCoordinates** + """ + + """ + allowed enum values + """ + ALL = 'All' + FIRST = 'First' + LAST = 'Last' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of FieldEEzsigntemplateformfieldPositioningoccurence from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/eZmaxApi/models/field_e_ezsigntemplatesignature_positioning.py b/eZmaxApi/models/field_e_ezsigntemplatesignature_positioning.py new file mode 100644 index 000000000..7ebef7391 --- /dev/null +++ b/eZmaxApi/models/field_e_ezsigntemplatesignature_positioning.py @@ -0,0 +1,46 @@ +# 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 FieldEEzsigntemplatesignaturePositioning(str, Enum): + """ + How the positioning of the Ezsigntemplatesignature will be done + """ + + """ + allowed enum values + """ + PERCOORDINATES = 'PerCoordinates' + PERPOSITIONINGPATTERN = 'PerPositioningPattern' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of FieldEEzsigntemplatesignaturePositioning from a JSON string""" + return cls(json.loads(json_str)) + + diff --git a/eZmaxApi/models/field_e_ezsigntemplatesignature_positioningoccurence.py b/eZmaxApi/models/field_e_ezsigntemplatesignature_positioningoccurence.py new file mode 100644 index 000000000..abafaf732 --- /dev/null +++ b/eZmaxApi/models/field_e_ezsigntemplatesignature_positioningoccurence.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 FieldEEzsigntemplatesignaturePositioningoccurence(str, Enum): + """ + The occurence of the pattern to add the Ezsigntemplatesignature This will be required if **eEzsigntemplatesignaturePositioning** is set to **PerCoordinates** + """ + + """ + allowed enum values + """ + ALL = 'All' + FIRST = 'First' + LAST = 'Last' + + @classmethod + def from_json(cls, json_str: str) -> Self: + """Create an instance of FieldEEzsigntemplatesignaturePositioningoccurence from a JSON string""" + 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 35bf6fe26..2c0778707 100644 --- a/eZmaxApi/models/field_e_ezsigntemplatesignature_type.py +++ b/eZmaxApi/models/field_e_ezsigntemplatesignature_type.py @@ -44,6 +44,7 @@ class FieldEEzsigntemplatesignatureType(str, Enum): ATTACHMENTS = 'Attachments' FIELDTEXT = 'FieldText' FIELDTEXTAREA = 'FieldTextarea' + CONSULTATION = 'Consultation' @classmethod def from_json(cls, json_str: str) -> Self: diff --git a/eZmaxApi/models/user_list_element.py b/eZmaxApi/models/user_list_element.py index 1bfab79dc..1d4af1112 100644 --- a/eZmaxApi/models/user_list_element.py +++ b/eZmaxApi/models/user_list_element.py @@ -45,7 +45,8 @@ class UserListElement(BaseModel): 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"] + s_user_jobtitle: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The job title of the user", alias="sUserJobtitle") + __properties: ClassVar[List[str]] = ["pkiUserID", "sUserFirstname", "sUserLastname", "sUserLoginname", "bUserIsactive", "eUserType", "eUserOrigin", "eUserEzsignaccess", "dtUserEzsignprepaidexpiration", "sEmailAddress", "sUserJobtitle"] @field_validator('s_user_loginname') def s_user_loginname_validate_regular_expression(cls, value): @@ -64,6 +65,16 @@ 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 + @field_validator('s_user_jobtitle') + def s_user_jobtitle_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, @@ -122,7 +133,8 @@ def from_dict(cls, obj: Dict) -> Self: "eUserOrigin": obj.get("eUserOrigin"), "eUserEzsignaccess": obj.get("eUserEzsignaccess"), "dtUserEzsignprepaidexpiration": obj.get("dtUserEzsignprepaidexpiration"), - "sEmailAddress": obj.get("sEmailAddress") + "sEmailAddress": obj.get("sEmailAddress"), + "sUserJobtitle": obj.get("sUserJobtitle") }) return _obj diff --git a/eZmaxApi/models/user_request.py b/eZmaxApi/models/user_request.py index d472e8b33..90fe29156 100644 --- a/eZmaxApi/models/user_request.py +++ b/eZmaxApi/models/user_request.py @@ -58,13 +58,14 @@ class UserRequest(BaseModel): 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_user_jobtitle: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The job title of the user", alias="sUserJobtitle") 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"] + __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", "sUserJobtitle", "eUserEzsignaccess", "bUserIsactive", "bUserValidatebyadministration", "bUserValidatebydirector", "bUserAttachmentautoverified", "bUserChangepassword"] @field_validator('s_user_loginname') def s_user_loginname_validate_regular_expression(cls, value): @@ -73,6 +74,16 @@ 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 + @field_validator('s_user_jobtitle') + def s_user_jobtitle_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, @@ -152,6 +163,7 @@ def from_dict(cls, obj: Dict) -> Self: "sUserFirstname": obj.get("sUserFirstname"), "sUserLastname": obj.get("sUserLastname"), "sUserLoginname": obj.get("sUserLoginname"), + "sUserJobtitle": obj.get("sUserJobtitle"), "eUserEzsignaccess": obj.get("eUserEzsignaccess"), "bUserIsactive": obj.get("bUserIsactive"), "bUserValidatebyadministration": obj.get("bUserValidatebyadministration"), diff --git a/eZmaxApi/models/user_request_compound.py b/eZmaxApi/models/user_request_compound.py index 74cbdebb1..cd9192c83 100644 --- a/eZmaxApi/models/user_request_compound.py +++ b/eZmaxApi/models/user_request_compound.py @@ -58,13 +58,14 @@ class UserRequestCompound(BaseModel): 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_user_jobtitle: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The job title of the user", alias="sUserJobtitle") 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"] + __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", "sUserJobtitle", "eUserEzsignaccess", "bUserIsactive", "bUserValidatebyadministration", "bUserValidatebydirector", "bUserAttachmentautoverified", "bUserChangepassword"] @field_validator('s_user_loginname') def s_user_loginname_validate_regular_expression(cls, value): @@ -73,6 +74,16 @@ 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 + @field_validator('s_user_jobtitle') + def s_user_jobtitle_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, @@ -152,6 +163,7 @@ def from_dict(cls, obj: Dict) -> Self: "sUserFirstname": obj.get("sUserFirstname"), "sUserLastname": obj.get("sUserLastname"), "sUserLoginname": obj.get("sUserLoginname"), + "sUserJobtitle": obj.get("sUserJobtitle"), "eUserEzsignaccess": obj.get("eUserEzsignaccess"), "bUserIsactive": obj.get("bUserIsactive"), "bUserValidatebyadministration": obj.get("bUserValidatebyadministration"), diff --git a/eZmaxApi/models/user_response.py b/eZmaxApi/models/user_response.py index 2d4e17495..17d3cefd8 100644 --- a/eZmaxApi/models/user_response.py +++ b/eZmaxApi/models/user_response.py @@ -66,6 +66,7 @@ class UserResponse(BaseModel): 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_user_jobtitle: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The job title of the user", alias="sUserJobtitle") 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") @@ -76,7 +77,7 @@ class UserResponse(BaseModel): 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"] + __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", "sUserJobtitle", "eUserEzsignaccess", "dtUserLastlogondate", "dtUserPasswordchanged", "dtUserEzsignprepaidexpiration", "bUserIsactive", "bUserValidatebyadministration", "bUserValidatebydirector", "bUserAttachmentautoverified", "bUserChangepassword", "objAudit"] @field_validator('s_user_loginname') def s_user_loginname_validate_regular_expression(cls, value): @@ -85,6 +86,16 @@ 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 + @field_validator('s_user_jobtitle') + def s_user_jobtitle_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_user_lastlogondate') def dt_user_lastlogondate_validate_regular_expression(cls, value): """Validates the regular expression""" @@ -203,6 +214,7 @@ def from_dict(cls, obj: Dict) -> Self: "sUserFirstname": obj.get("sUserFirstname"), "sUserLastname": obj.get("sUserLastname"), "sUserLoginname": obj.get("sUserLoginname"), + "sUserJobtitle": obj.get("sUserJobtitle"), "eUserEzsignaccess": obj.get("eUserEzsignaccess"), "dtUserLastlogondate": obj.get("dtUserLastlogondate"), "dtUserPasswordchanged": obj.get("dtUserPasswordchanged"), diff --git a/eZmaxApi/models/user_response_compound.py b/eZmaxApi/models/user_response_compound.py index d79ac29da..e88dd2843 100644 --- a/eZmaxApi/models/user_response_compound.py +++ b/eZmaxApi/models/user_response_compound.py @@ -66,6 +66,7 @@ class UserResponseCompound(BaseModel): 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_user_jobtitle: Optional[Annotated[str, Field(strict=True)]] = Field(default=None, description="The job title of the user", alias="sUserJobtitle") 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") @@ -76,7 +77,7 @@ class UserResponseCompound(BaseModel): 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"] + __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", "sUserJobtitle", "eUserEzsignaccess", "dtUserLastlogondate", "dtUserPasswordchanged", "dtUserEzsignprepaidexpiration", "bUserIsactive", "bUserValidatebyadministration", "bUserValidatebydirector", "bUserAttachmentautoverified", "bUserChangepassword", "objAudit"] @field_validator('s_user_loginname') def s_user_loginname_validate_regular_expression(cls, value): @@ -85,6 +86,16 @@ 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 + @field_validator('s_user_jobtitle') + def s_user_jobtitle_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_user_lastlogondate') def dt_user_lastlogondate_validate_regular_expression(cls, value): """Validates the regular expression""" @@ -203,6 +214,7 @@ def from_dict(cls, obj: Dict) -> Self: "sUserFirstname": obj.get("sUserFirstname"), "sUserLastname": obj.get("sUserLastname"), "sUserLoginname": obj.get("sUserLoginname"), + "sUserJobtitle": obj.get("sUserJobtitle"), "eUserEzsignaccess": obj.get("eUserEzsignaccess"), "dtUserLastlogondate": obj.get("dtUserLastlogondate"), "dtUserPasswordchanged": obj.get("dtUserPasswordchanged"), diff --git a/eZmaxApi/models/webhook_response.py b/eZmaxApi/models/webhook_response.py index e937eda43..47b2c303b 100644 --- a/eZmaxApi/models/webhook_response.py +++ b/eZmaxApi/models/webhook_response.py @@ -23,6 +23,7 @@ from pydantic import BaseModel, StrictBool, StrictInt, StrictStr from pydantic import Field from typing_extensions import Annotated +from eZmaxApi.models.common_audit import CommonAudit 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 @@ -49,7 +50,8 @@ class WebhookResponse(BaseModel): 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"] + obj_audit: CommonAudit = Field(alias="objAudit") + __properties: ClassVar[List[str]] = ["pkiWebhookID", "sWebhookDescription", "fkiEzsignfoldertypeID", "sEzsignfoldertypeNameX", "eWebhookModule", "eWebhookEzsignevent", "eWebhookManagementevent", "sWebhookUrl", "sWebhookEmailfailed", "sWebhookApikey", "sWebhookSecret", "bWebhookIsactive", "bWebhookIssigned", "bWebhookSkipsslvalidation", "objAudit"] model_config = { "populate_by_name": True, @@ -88,6 +90,9 @@ def to_dict(self) -> Dict[str, Any]: }, 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 @@ -113,7 +118,8 @@ def from_dict(cls, obj: Dict) -> Self: "sWebhookSecret": obj.get("sWebhookSecret"), "bWebhookIsactive": obj.get("bWebhookIsactive"), "bWebhookIssigned": obj.get("bWebhookIssigned"), - "bWebhookSkipsslvalidation": obj.get("bWebhookSkipsslvalidation") + "bWebhookSkipsslvalidation": obj.get("bWebhookSkipsslvalidation"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None }) return _obj diff --git a/eZmaxApi/models/webhook_response_compound.py b/eZmaxApi/models/webhook_response_compound.py index 34f264704..4f939eac0 100644 --- a/eZmaxApi/models/webhook_response_compound.py +++ b/eZmaxApi/models/webhook_response_compound.py @@ -23,6 +23,7 @@ from pydantic import BaseModel, StrictBool, StrictInt, StrictStr from pydantic import Field from typing_extensions import Annotated +from eZmaxApi.models.common_audit import CommonAudit 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 @@ -49,8 +50,9 @@ class WebhookResponseCompound(BaseModel): 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") + obj_audit: CommonAudit = Field(alias="objAudit") 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"] + __properties: ClassVar[List[str]] = ["pkiWebhookID", "sWebhookDescription", "fkiEzsignfoldertypeID", "sEzsignfoldertypeNameX", "eWebhookModule", "eWebhookEzsignevent", "eWebhookManagementevent", "sWebhookUrl", "sWebhookEmailfailed", "sWebhookApikey", "sWebhookSecret", "bWebhookIsactive", "bWebhookIssigned", "bWebhookSkipsslvalidation", "objAudit", "sWebhookEvent"] model_config = { "populate_by_name": True, @@ -89,6 +91,9 @@ def to_dict(self) -> Dict[str, Any]: }, 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 @@ -115,6 +120,7 @@ def from_dict(cls, obj: Dict) -> Self: "bWebhookIsactive": obj.get("bWebhookIsactive"), "bWebhookIssigned": obj.get("bWebhookIssigned"), "bWebhookSkipsslvalidation": obj.get("bWebhookSkipsslvalidation"), + "objAudit": CommonAudit.from_dict(obj.get("objAudit")) if obj.get("objAudit") is not None else None, "sWebhookEvent": obj.get("sWebhookEvent") }) return _obj diff --git a/test/test_custom_create_ezsignelements_positioned_by_word_request.py b/test/test_custom_create_ezsignelements_positioned_by_word_request.py new file mode 100644 index 000000000..fbc0aa703 --- /dev/null +++ b/test/test_custom_create_ezsignelements_positioned_by_word_request.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_create_ezsignelements_positioned_by_word_request import CustomCreateEzsignelementsPositionedByWordRequest + +class TestCustomCreateEzsignelementsPositionedByWordRequest(unittest.TestCase): + """CustomCreateEzsignelementsPositionedByWordRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> CustomCreateEzsignelementsPositionedByWordRequest: + """Test CustomCreateEzsignelementsPositionedByWordRequest + 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 `CustomCreateEzsignelementsPositionedByWordRequest` + """ + model = CustomCreateEzsignelementsPositionedByWordRequest() + if include_optional: + return CustomCreateEzsignelementsPositionedByWordRequest( + s_createezsignelementspositionedbyword_pattern = 'jUR,rZ#UM/?R,Fp^l6$AR', + i_createezsignelementspositionedbyword_offsetx = 56, + i_createezsignelementspositionedbyword_offsety = 56, + e_createezsignelementspositionedbyword_occurance = 'All' + ) + else: + return CustomCreateEzsignelementsPositionedByWordRequest( + s_createezsignelementspositionedbyword_pattern = 'jUR,rZ#UM/?R,Fp^l6$AR', + i_createezsignelementspositionedbyword_offsetx = 56, + i_createezsignelementspositionedbyword_offsety = 56, + e_createezsignelementspositionedbyword_occurance = 'All', + ) + """ + + def testCustomCreateEzsignelementsPositionedByWordRequest(self): + """Test CustomCreateEzsignelementsPositionedByWordRequest""" + # 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_discussionconfiguration_response.py b/test/test_custom_discussionconfiguration_response.py new file mode 100644 index 000000000..e56b195d2 --- /dev/null +++ b/test/test_custom_discussionconfiguration_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.custom_discussionconfiguration_response import CustomDiscussionconfigurationResponse + +class TestCustomDiscussionconfigurationResponse(unittest.TestCase): + """CustomDiscussionconfigurationResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> CustomDiscussionconfigurationResponse: + """Test CustomDiscussionconfigurationResponse + 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 `CustomDiscussionconfigurationResponse` + """ + model = CustomDiscussionconfigurationResponse() + if include_optional: + return CustomDiscussionconfigurationResponse( + b_discussionconfiguration_completehistorywhenadded = True, + b_discussionconfiguration_createallowed = True, + b_discussionconfiguration_deleteallowed = True, + b_discussionconfiguration_deletediscussionmessageallowed = True, + b_discussionconfiguration_editdiscussionmessageallowed = True + ) + else: + return CustomDiscussionconfigurationResponse( + b_discussionconfiguration_completehistorywhenadded = True, + b_discussionconfiguration_createallowed = True, + b_discussionconfiguration_deleteallowed = True, + b_discussionconfiguration_deletediscussionmessageallowed = True, + b_discussionconfiguration_editdiscussionmessageallowed = True, + ) + """ + + def testCustomDiscussionconfigurationResponse(self): + """Test CustomDiscussionconfigurationResponse""" + # 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_ezmaxinvoicing_ezsigndocument_response.py b/test/test_custom_ezmaxinvoicing_ezsigndocument_response.py index a86334f71..eb7c263a7 100644 --- a/test/test_custom_ezmaxinvoicing_ezsigndocument_response.py +++ b/test/test_custom_ezmaxinvoicing_ezsigndocument_response.py @@ -38,6 +38,7 @@ def make_instance(self, include_optional) -> CustomEzmaxinvoicingEzsigndocumentR if include_optional: return CustomEzmaxinvoicingEzsigndocumentResponse( fki_ezsignfolder_id = 33, + fki_billingentityinternal_id = 1, s_name = '', s_ezsignfolder_description = 'Test eZsign Folder', s_ezsigndocument_name = 'Contract #123', diff --git a/test/test_custom_ezmaxinvoicing_ezsignfolder_response.py b/test/test_custom_ezmaxinvoicing_ezsignfolder_response.py index 77f63bae0..fd443312c 100644 --- a/test/test_custom_ezmaxinvoicing_ezsignfolder_response.py +++ b/test/test_custom_ezmaxinvoicing_ezsignfolder_response.py @@ -38,6 +38,7 @@ def make_instance(self, include_optional) -> CustomEzmaxinvoicingEzsignfolderRes if include_optional: return CustomEzmaxinvoicingEzsignfolderResponse( fki_ezsignfolder_id = 33, + fki_billingentityinternal_id = 1, s_ezsignfolder_description = 'Test eZsign Folder', b_ezsigntsarequirement_billable = True, b_ezsignfolder_mfaused = True, diff --git a/test/test_custom_ezsignfoldertype_response.py b/test/test_custom_ezsignfoldertype_response.py index b7871fe98..8132acaf0 100644 --- a/test/test_custom_ezsignfoldertype_response.py +++ b/test/test_custom_ezsignfoldertype_response.py @@ -45,7 +45,9 @@ def make_instance(self, include_optional) -> CustomEzsignfoldertypeResponse: b_ezsignfoldertype_allowdownloadattachmentezsignsigner = False, b_ezsignfoldertype_allowdownloadproofezsignsigner = False, b_ezsignfoldertype_delegate = True, - b_ezsignfoldertype_reassign = True + b_ezsignfoldertype_reassign = True, + b_ezsignfoldertype_reassignezsignsigner = True, + b_ezsignfoldertype_reassignuser = True ) else: return CustomEzsignfoldertypeResponse( diff --git a/test/test_custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request.py b/test/test_custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request.py new file mode 100644 index 000000000..0d240177f --- /dev/null +++ b/test/test_custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request.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.custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request import CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest + +class TestCustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest(unittest.TestCase): + """CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest: + """Test CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest + 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 `CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest` + """ + model = CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest() + if include_optional: + return CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest( + pki_ezsignformfieldgroup_id = 26, + fki_ezsigndocument_id = 97, + e_ezsignformfieldgroup_type = 'Text', + e_ezsignformfieldgroup_signerrequirement = 'One', + s_ezsignformfieldgroup_label = 'Allergies', + i_ezsignformfieldgroup_step = 1, + s_ezsignformfieldgroup_defaultvalue = 'Foo', + i_ezsignformfieldgroup_filledmin = 1, + i_ezsignformfieldgroup_filledmax = 2, + b_ezsignformfieldgroup_readonly = True, + i_ezsignformfieldgroup_maxlength = 75, + b_ezsignformfieldgroup_encrypted = True, + s_ezsignformfieldgroup_regexp = '/[-0-9a-zA-Z.+_]+@[-0-9a-zA-Z.+_]+.[a-zA-Z]{2,4}/', + t_ezsignformfieldgroup_tooltip = 'Please enter a valid email address', + e_ezsignformfieldgroup_tooltipposition = 'TopLeft', + e_ezsignformfieldgroup_textvalidation = 'None', + a_obj_ezsignformfieldgroupsigner = [ + eZmaxApi.models.ezsignformfieldgroupsigner_request_compound.ezsignformfieldgroupsigner-RequestCompound() + ], + a_obj_dropdown_element = [ + eZmaxApi.models.custom_dropdown_element_request_compound.Custom-DropdownElement-RequestCompound() + ], + a_obj_ezsignformfield = [ + eZmaxApi.models.ezsignformfield_request_compound.ezsignformfield-RequestCompound() + ], + obj_createezsignelementspositionedbyword = eZmaxApi.models.custom_create_ezsignelements_positioned_by_word_request.Custom-CreateEzsignelementsPositionedByWord-Request( + s_createezsignelementspositionedbyword_pattern = 'jUR,rZ#UM/?R,Fp^l6$AR', + i_createezsignelementspositionedbyword_offsetx = 56, + i_createezsignelementspositionedbyword_offsety = 56, + e_createezsignelementspositionedbyword_occurance = 'All', ) + ) + else: + return CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest( + fki_ezsigndocument_id = 97, + e_ezsignformfieldgroup_type = 'Text', + e_ezsignformfieldgroup_signerrequirement = 'One', + s_ezsignformfieldgroup_label = 'Allergies', + i_ezsignformfieldgroup_step = 1, + i_ezsignformfieldgroup_filledmin = 1, + i_ezsignformfieldgroup_filledmax = 2, + b_ezsignformfieldgroup_readonly = True, + a_obj_ezsignformfieldgroupsigner = [ + eZmaxApi.models.ezsignformfieldgroupsigner_request_compound.ezsignformfieldgroupsigner-RequestCompound() + ], + a_obj_ezsignformfield = [ + eZmaxApi.models.ezsignformfield_request_compound.ezsignformfield-RequestCompound() + ], + obj_createezsignelementspositionedbyword = eZmaxApi.models.custom_create_ezsignelements_positioned_by_word_request.Custom-CreateEzsignelementsPositionedByWord-Request( + s_createezsignelementspositionedbyword_pattern = 'jUR,rZ#UM/?R,Fp^l6$AR', + i_createezsignelementspositionedbyword_offsetx = 56, + i_createezsignelementspositionedbyword_offsety = 56, + e_createezsignelementspositionedbyword_occurance = 'All', ), + ) + """ + + def testCustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest(self): + """Test CustomEzsignformfieldgroupCreateEzsignelementsPositionedByWordRequest""" + # 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_ezsignsignature_create_ezsignelements_positioned_by_word_request.py b/test/test_custom_ezsignsignature_create_ezsignelements_positioned_by_word_request.py new file mode 100644 index 000000000..8e8eaae59 --- /dev/null +++ b/test/test_custom_ezsignsignature_create_ezsignelements_positioned_by_word_request.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 + + +import unittest +import datetime + +from eZmaxApi.models.custom_ezsignsignature_create_ezsignelements_positioned_by_word_request import CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest + +class TestCustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest(unittest.TestCase): + """CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest: + """Test CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest + 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 `CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest` + """ + model = CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest() + if include_optional: + return CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest( + pki_ezsignsignature_id = 49, + fki_ezsignfoldersignerassociation_id = 20, + i_ezsignpage_pagenumber = 1, + i_ezsignsignature_x = 200, + i_ezsignsignature_y = 300, + i_ezsignsignature_width = 200, + i_ezsignsignature_height = 200, + i_ezsignsignature_step = 1, + e_ezsignsignature_type = 'Name', + fki_ezsigndocument_id = 97, + t_ezsignsignature_tooltip = 'Please sign here if you agree to the terms', + e_ezsignsignature_tooltipposition = 'TopLeft', + e_ezsignsignature_font = 'Normal', + fki_ezsignfoldersignerassociation_id_validation = 20, + b_ezsignsignature_required = True, + e_ezsignsignature_attachmentnamesource = 'Description', + s_ezsignsignature_attachmentdescription = 'Attachment', + i_ezsignsignature_validationstep = 1, + i_ezsignsignature_maxlength = 75, + e_ezsignsignature_textvalidation = 'None', + s_ezsignsignature_regexp = '/[-0-9a-zA-Z.+_]+@[-0-9a-zA-Z.+_]+.[a-zA-Z]{2,4}/', + e_ezsignsignature_dependencyrequirement = 'AllOf', + b_ezsignsignature_customdate = True, + a_obj_ezsignsignaturecustomdate = [ + eZmaxApi.models.ezsignsignaturecustomdate_request_compound.ezsignsignaturecustomdate-RequestCompound() + ], + a_obj_ezsignelementdependency = [ + eZmaxApi.models.ezsignelementdependency_request_compound.ezsignelementdependency-RequestCompound() + ], + obj_createezsignelementspositionedbyword = eZmaxApi.models.custom_create_ezsignelements_positioned_by_word_request.Custom-CreateEzsignelementsPositionedByWord-Request( + s_createezsignelementspositionedbyword_pattern = 'jUR,rZ#UM/?R,Fp^l6$AR', + i_createezsignelementspositionedbyword_offsetx = 56, + i_createezsignelementspositionedbyword_offsety = 56, + e_createezsignelementspositionedbyword_occurance = 'All', ) + ) + else: + return CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest( + fki_ezsignfoldersignerassociation_id = 20, + i_ezsignpage_pagenumber = 1, + i_ezsignsignature_x = 200, + i_ezsignsignature_y = 300, + i_ezsignsignature_step = 1, + e_ezsignsignature_type = 'Name', + fki_ezsigndocument_id = 97, + obj_createezsignelementspositionedbyword = eZmaxApi.models.custom_create_ezsignelements_positioned_by_word_request.Custom-CreateEzsignelementsPositionedByWord-Request( + s_createezsignelementspositionedbyword_pattern = 'jUR,rZ#UM/?R,Fp^l6$AR', + i_createezsignelementspositionedbyword_offsetx = 56, + i_createezsignelementspositionedbyword_offsety = 56, + e_createezsignelementspositionedbyword_occurance = 'All', ), + ) + """ + + def testCustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest(self): + """Test CustomEzsignsignatureCreateEzsignelementsPositionedByWordRequest""" + # 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_webhook_response.py b/test/test_custom_webhook_response.py index 2c6ed56a2..36098441d 100644 --- a/test/test_custom_webhook_response.py +++ b/test/test_custom_webhook_response.py @@ -51,6 +51,23 @@ def make_instance(self, include_optional) -> CustomWebhookResponse: b_webhook_isactive = True, b_webhook_issigned = True, b_webhook_skipsslvalidation = False, + 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', ), ), pks_customer_code = 'demo', b_webhook_test = True ) @@ -64,6 +81,23 @@ def make_instance(self, include_optional) -> CustomWebhookResponse: b_webhook_isactive = True, b_webhook_issigned = True, b_webhook_skipsslvalidation = False, + 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', ), ), pks_customer_code = 'demo', b_webhook_test = True, ) diff --git a/test/test_discussion_create_object_v1_request.py b/test/test_discussion_create_object_v1_request.py new file mode 100644 index 000000000..61f1009e6 --- /dev/null +++ b/test/test_discussion_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.discussion_create_object_v1_request import DiscussionCreateObjectV1Request + +class TestDiscussionCreateObjectV1Request(unittest.TestCase): + """DiscussionCreateObjectV1Request unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionCreateObjectV1Request: + """Test DiscussionCreateObjectV1Request + 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 `DiscussionCreateObjectV1Request` + """ + model = DiscussionCreateObjectV1Request() + if include_optional: + return DiscussionCreateObjectV1Request( + a_obj_discussion = [ + eZmaxApi.models.discussion_request_compound.discussion-RequestCompound() + ] + ) + else: + return DiscussionCreateObjectV1Request( + a_obj_discussion = [ + eZmaxApi.models.discussion_request_compound.discussion-RequestCompound() + ], + ) + """ + + def testDiscussionCreateObjectV1Request(self): + """Test DiscussionCreateObjectV1Request""" + # 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_discussion_create_object_v1_response.py b/test/test_discussion_create_object_v1_response.py new file mode 100644 index 000000000..0e0fbef31 --- /dev/null +++ b/test/test_discussion_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.discussion_create_object_v1_response import DiscussionCreateObjectV1Response + +class TestDiscussionCreateObjectV1Response(unittest.TestCase): + """DiscussionCreateObjectV1Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionCreateObjectV1Response: + """Test DiscussionCreateObjectV1Response + 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 `DiscussionCreateObjectV1Response` + """ + model = DiscussionCreateObjectV1Response() + if include_optional: + return DiscussionCreateObjectV1Response( + 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.discussion_create_object_v1_response_m_payload.discussion-createObject-v1-Response-mPayload( + a_pki_discussion_id = [ + 125 + ], ) + ) + else: + return DiscussionCreateObjectV1Response( + 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.discussion_create_object_v1_response_m_payload.discussion-createObject-v1-Response-mPayload( + a_pki_discussion_id = [ + 125 + ], ), + ) + """ + + def testDiscussionCreateObjectV1Response(self): + """Test DiscussionCreateObjectV1Response""" + # 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_discussion_create_object_v1_response_m_payload.py b/test/test_discussion_create_object_v1_response_m_payload.py new file mode 100644 index 000000000..e1079a598 --- /dev/null +++ b/test/test_discussion_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.discussion_create_object_v1_response_m_payload import DiscussionCreateObjectV1ResponseMPayload + +class TestDiscussionCreateObjectV1ResponseMPayload(unittest.TestCase): + """DiscussionCreateObjectV1ResponseMPayload unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionCreateObjectV1ResponseMPayload: + """Test DiscussionCreateObjectV1ResponseMPayload + 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 `DiscussionCreateObjectV1ResponseMPayload` + """ + model = DiscussionCreateObjectV1ResponseMPayload() + if include_optional: + return DiscussionCreateObjectV1ResponseMPayload( + a_pki_discussion_id = [ + 125 + ] + ) + else: + return DiscussionCreateObjectV1ResponseMPayload( + a_pki_discussion_id = [ + 125 + ], + ) + """ + + def testDiscussionCreateObjectV1ResponseMPayload(self): + """Test DiscussionCreateObjectV1ResponseMPayload""" + # 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_discussion_delete_object_v1_response.py b/test/test_discussion_delete_object_v1_response.py new file mode 100644 index 000000000..53a8208b3 --- /dev/null +++ b/test/test_discussion_delete_object_v1_response.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 +import datetime + +from eZmaxApi.models.discussion_delete_object_v1_response import DiscussionDeleteObjectV1Response + +class TestDiscussionDeleteObjectV1Response(unittest.TestCase): + """DiscussionDeleteObjectV1Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionDeleteObjectV1Response: + """Test DiscussionDeleteObjectV1Response + 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 `DiscussionDeleteObjectV1Response` + """ + model = DiscussionDeleteObjectV1Response() + if include_optional: + return DiscussionDeleteObjectV1Response( + 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}]} + ) + else: + return DiscussionDeleteObjectV1Response( + 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, ), + ) + """ + + def testDiscussionDeleteObjectV1Response(self): + """Test DiscussionDeleteObjectV1Response""" + # 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_discussion_get_object_v2_response.py b/test/test_discussion_get_object_v2_response.py new file mode 100644 index 000000000..b2bf79cbd --- /dev/null +++ b/test/test_discussion_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.discussion_get_object_v2_response import DiscussionGetObjectV2Response + +class TestDiscussionGetObjectV2Response(unittest.TestCase): + """DiscussionGetObjectV2Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionGetObjectV2Response: + """Test DiscussionGetObjectV2Response + 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 `DiscussionGetObjectV2Response` + """ + model = DiscussionGetObjectV2Response() + if include_optional: + return DiscussionGetObjectV2Response( + 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.discussion_get_object_v2_response_m_payload.discussion-getObject-v2-Response-mPayload( + obj_discussion = eZmaxApi.models.discussion_response_compound.discussion-ResponseCompound(), ) + ) + else: + return DiscussionGetObjectV2Response( + 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.discussion_get_object_v2_response_m_payload.discussion-getObject-v2-Response-mPayload( + obj_discussion = eZmaxApi.models.discussion_response_compound.discussion-ResponseCompound(), ), + ) + """ + + def testDiscussionGetObjectV2Response(self): + """Test DiscussionGetObjectV2Response""" + # 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_discussion_get_object_v2_response_m_payload.py b/test/test_discussion_get_object_v2_response_m_payload.py new file mode 100644 index 000000000..4f61eadce --- /dev/null +++ b/test/test_discussion_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.discussion_get_object_v2_response_m_payload import DiscussionGetObjectV2ResponseMPayload + +class TestDiscussionGetObjectV2ResponseMPayload(unittest.TestCase): + """DiscussionGetObjectV2ResponseMPayload unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionGetObjectV2ResponseMPayload: + """Test DiscussionGetObjectV2ResponseMPayload + 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 `DiscussionGetObjectV2ResponseMPayload` + """ + model = DiscussionGetObjectV2ResponseMPayload() + if include_optional: + return DiscussionGetObjectV2ResponseMPayload( + obj_discussion = eZmaxApi.models.discussion_response_compound.discussion-ResponseCompound() + ) + else: + return DiscussionGetObjectV2ResponseMPayload( + obj_discussion = eZmaxApi.models.discussion_response_compound.discussion-ResponseCompound(), + ) + """ + + def testDiscussionGetObjectV2ResponseMPayload(self): + """Test DiscussionGetObjectV2ResponseMPayload""" + # 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_discussion_patch_object_v1_request.py b/test/test_discussion_patch_object_v1_request.py new file mode 100644 index 000000000..62fbe0009 --- /dev/null +++ b/test/test_discussion_patch_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.discussion_patch_object_v1_request import DiscussionPatchObjectV1Request + +class TestDiscussionPatchObjectV1Request(unittest.TestCase): + """DiscussionPatchObjectV1Request unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionPatchObjectV1Request: + """Test DiscussionPatchObjectV1Request + 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 `DiscussionPatchObjectV1Request` + """ + model = DiscussionPatchObjectV1Request() + if include_optional: + return DiscussionPatchObjectV1Request( + obj_discussion = eZmaxApi.models.discussion_request_patch.discussion-RequestPatch( + s_discussion_description = 'John Doe', + b_discussion_closed = True, ) + ) + else: + return DiscussionPatchObjectV1Request( + obj_discussion = eZmaxApi.models.discussion_request_patch.discussion-RequestPatch( + s_discussion_description = 'John Doe', + b_discussion_closed = True, ), + ) + """ + + def testDiscussionPatchObjectV1Request(self): + """Test DiscussionPatchObjectV1Request""" + # 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_discussion_patch_object_v1_response.py b/test/test_discussion_patch_object_v1_response.py new file mode 100644 index 000000000..dfa74f162 --- /dev/null +++ b/test/test_discussion_patch_object_v1_response.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 +import datetime + +from eZmaxApi.models.discussion_patch_object_v1_response import DiscussionPatchObjectV1Response + +class TestDiscussionPatchObjectV1Response(unittest.TestCase): + """DiscussionPatchObjectV1Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionPatchObjectV1Response: + """Test DiscussionPatchObjectV1Response + 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 `DiscussionPatchObjectV1Response` + """ + model = DiscussionPatchObjectV1Response() + if include_optional: + return DiscussionPatchObjectV1Response( + 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}]} + ) + else: + return DiscussionPatchObjectV1Response( + 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, ), + ) + """ + + def testDiscussionPatchObjectV1Response(self): + """Test DiscussionPatchObjectV1Response""" + # 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_discussion_request.py b/test/test_discussion_request.py new file mode 100644 index 000000000..fc1fbd286 --- /dev/null +++ b/test/test_discussion_request.py @@ -0,0 +1,56 @@ +# 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.discussion_request import DiscussionRequest + +class TestDiscussionRequest(unittest.TestCase): + """DiscussionRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionRequest: + """Test DiscussionRequest + 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 `DiscussionRequest` + """ + model = DiscussionRequest() + if include_optional: + return DiscussionRequest( + pki_discussion_id = 125, + s_discussion_description = 'John Doe', + b_discussion_closed = True + ) + else: + return DiscussionRequest( + s_discussion_description = 'John Doe', + ) + """ + + def testDiscussionRequest(self): + """Test DiscussionRequest""" + # 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_discussion_request_compound.py b/test/test_discussion_request_compound.py new file mode 100644 index 000000000..cf74dba92 --- /dev/null +++ b/test/test_discussion_request_compound.py @@ -0,0 +1,56 @@ +# 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.discussion_request_compound import DiscussionRequestCompound + +class TestDiscussionRequestCompound(unittest.TestCase): + """DiscussionRequestCompound unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionRequestCompound: + """Test DiscussionRequestCompound + 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 `DiscussionRequestCompound` + """ + model = DiscussionRequestCompound() + if include_optional: + return DiscussionRequestCompound( + pki_discussion_id = 125, + s_discussion_description = 'John Doe', + b_discussion_closed = True + ) + else: + return DiscussionRequestCompound( + s_discussion_description = 'John Doe', + ) + """ + + def testDiscussionRequestCompound(self): + """Test DiscussionRequestCompound""" + # 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_discussion_request_patch.py b/test/test_discussion_request_patch.py new file mode 100644 index 000000000..bd683cad5 --- /dev/null +++ b/test/test_discussion_request_patch.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.discussion_request_patch import DiscussionRequestPatch + +class TestDiscussionRequestPatch(unittest.TestCase): + """DiscussionRequestPatch unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionRequestPatch: + """Test DiscussionRequestPatch + 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 `DiscussionRequestPatch` + """ + model = DiscussionRequestPatch() + if include_optional: + return DiscussionRequestPatch( + s_discussion_description = 'John Doe', + b_discussion_closed = True + ) + else: + return DiscussionRequestPatch( + ) + """ + + def testDiscussionRequestPatch(self): + """Test DiscussionRequestPatch""" + # 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_discussion_response.py b/test/test_discussion_response.py new file mode 100644 index 000000000..5028c649a --- /dev/null +++ b/test/test_discussion_response.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.discussion_response import DiscussionResponse + +class TestDiscussionResponse(unittest.TestCase): + """DiscussionResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionResponse: + """Test DiscussionResponse + 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 `DiscussionResponse` + """ + model = DiscussionResponse() + if include_optional: + return DiscussionResponse( + pki_discussion_id = 125, + s_discussion_description = 'John Doe', + b_discussion_closed = True, + dt_discussion_lastread = '2020-12-31 23:59:59', + i_discussionmessage_count = 4, + i_discussionmessage_countunread = 4, + obj_discussionconfiguration = eZmaxApi.models.custom_discussionconfiguration_response.Custom-Discussionconfiguration-Response() + ) + else: + return DiscussionResponse( + pki_discussion_id = 125, + s_discussion_description = 'John Doe', + b_discussion_closed = True, + i_discussionmessage_count = 4, + i_discussionmessage_countunread = 4, + ) + """ + + def testDiscussionResponse(self): + """Test DiscussionResponse""" + # 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_discussion_response_compound.py b/test/test_discussion_response_compound.py new file mode 100644 index 000000000..133514300 --- /dev/null +++ b/test/test_discussion_response_compound.py @@ -0,0 +1,76 @@ +# 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.discussion_response_compound import DiscussionResponseCompound + +class TestDiscussionResponseCompound(unittest.TestCase): + """DiscussionResponseCompound unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionResponseCompound: + """Test DiscussionResponseCompound + 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 `DiscussionResponseCompound` + """ + model = DiscussionResponseCompound() + if include_optional: + return DiscussionResponseCompound( + pki_discussion_id = 125, + s_discussion_description = 'John Doe', + b_discussion_closed = True, + dt_discussion_lastread = '2020-12-31 23:59:59', + i_discussionmessage_count = 4, + i_discussionmessage_countunread = 4, + obj_discussionconfiguration = eZmaxApi.models.custom_discussionconfiguration_response.Custom-Discussionconfiguration-Response(), + a_obj_discussionmembership = [ + eZmaxApi.models.discussionmembership_response_compound.discussionmembership-ResponseCompound() + ], + a_obj_discussionmessage = [ + eZmaxApi.models.discussionmessage_response_compound.discussionmessage-ResponseCompound() + ] + ) + else: + return DiscussionResponseCompound( + pki_discussion_id = 125, + s_discussion_description = 'John Doe', + b_discussion_closed = True, + i_discussionmessage_count = 4, + i_discussionmessage_countunread = 4, + a_obj_discussionmembership = [ + eZmaxApi.models.discussionmembership_response_compound.discussionmembership-ResponseCompound() + ], + a_obj_discussionmessage = [ + eZmaxApi.models.discussionmessage_response_compound.discussionmessage-ResponseCompound() + ], + ) + """ + + def testDiscussionResponseCompound(self): + """Test DiscussionResponseCompound""" + # 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_discussion_update_discussionreadstatus_v1_request.py b/test/test_discussion_update_discussionreadstatus_v1_request.py new file mode 100644 index 000000000..0e07c2026 --- /dev/null +++ b/test/test_discussion_update_discussionreadstatus_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.discussion_update_discussionreadstatus_v1_request import DiscussionUpdateDiscussionreadstatusV1Request + +class TestDiscussionUpdateDiscussionreadstatusV1Request(unittest.TestCase): + """DiscussionUpdateDiscussionreadstatusV1Request unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionUpdateDiscussionreadstatusV1Request: + """Test DiscussionUpdateDiscussionreadstatusV1Request + 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 `DiscussionUpdateDiscussionreadstatusV1Request` + """ + model = DiscussionUpdateDiscussionreadstatusV1Request() + if include_optional: + return DiscussionUpdateDiscussionreadstatusV1Request( + dt_discussionreadstatus_date = '2020-12-31 23:59:59' + ) + else: + return DiscussionUpdateDiscussionreadstatusV1Request( + ) + """ + + def testDiscussionUpdateDiscussionreadstatusV1Request(self): + """Test DiscussionUpdateDiscussionreadstatusV1Request""" + # 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_discussion_update_discussionreadstatus_v1_response.py b/test/test_discussion_update_discussionreadstatus_v1_response.py new file mode 100644 index 000000000..7889bac05 --- /dev/null +++ b/test/test_discussion_update_discussionreadstatus_v1_response.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 +import datetime + +from eZmaxApi.models.discussion_update_discussionreadstatus_v1_response import DiscussionUpdateDiscussionreadstatusV1Response + +class TestDiscussionUpdateDiscussionreadstatusV1Response(unittest.TestCase): + """DiscussionUpdateDiscussionreadstatusV1Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionUpdateDiscussionreadstatusV1Response: + """Test DiscussionUpdateDiscussionreadstatusV1Response + 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 `DiscussionUpdateDiscussionreadstatusV1Response` + """ + model = DiscussionUpdateDiscussionreadstatusV1Response() + if include_optional: + return DiscussionUpdateDiscussionreadstatusV1Response( + 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}]} + ) + else: + return DiscussionUpdateDiscussionreadstatusV1Response( + 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, ), + ) + """ + + def testDiscussionUpdateDiscussionreadstatusV1Response(self): + """Test DiscussionUpdateDiscussionreadstatusV1Response""" + # 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_discussionmembership_create_object_v1_request.py b/test/test_discussionmembership_create_object_v1_request.py new file mode 100644 index 000000000..07d8b497f --- /dev/null +++ b/test/test_discussionmembership_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.discussionmembership_create_object_v1_request import DiscussionmembershipCreateObjectV1Request + +class TestDiscussionmembershipCreateObjectV1Request(unittest.TestCase): + """DiscussionmembershipCreateObjectV1Request unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionmembershipCreateObjectV1Request: + """Test DiscussionmembershipCreateObjectV1Request + 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 `DiscussionmembershipCreateObjectV1Request` + """ + model = DiscussionmembershipCreateObjectV1Request() + if include_optional: + return DiscussionmembershipCreateObjectV1Request( + a_obj_discussionmembership = [ + eZmaxApi.models.discussionmembership_request_compound.discussionmembership-RequestCompound() + ] + ) + else: + return DiscussionmembershipCreateObjectV1Request( + a_obj_discussionmembership = [ + eZmaxApi.models.discussionmembership_request_compound.discussionmembership-RequestCompound() + ], + ) + """ + + def testDiscussionmembershipCreateObjectV1Request(self): + """Test DiscussionmembershipCreateObjectV1Request""" + # 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_discussionmembership_create_object_v1_response.py b/test/test_discussionmembership_create_object_v1_response.py new file mode 100644 index 000000000..36414bae2 --- /dev/null +++ b/test/test_discussionmembership_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.discussionmembership_create_object_v1_response import DiscussionmembershipCreateObjectV1Response + +class TestDiscussionmembershipCreateObjectV1Response(unittest.TestCase): + """DiscussionmembershipCreateObjectV1Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionmembershipCreateObjectV1Response: + """Test DiscussionmembershipCreateObjectV1Response + 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 `DiscussionmembershipCreateObjectV1Response` + """ + model = DiscussionmembershipCreateObjectV1Response() + if include_optional: + return DiscussionmembershipCreateObjectV1Response( + 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.discussionmembership_create_object_v1_response_m_payload.discussionmembership-createObject-v1-Response-mPayload( + a_pki_discussionmembership_id = [ + 165 + ], ) + ) + else: + return DiscussionmembershipCreateObjectV1Response( + 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.discussionmembership_create_object_v1_response_m_payload.discussionmembership-createObject-v1-Response-mPayload( + a_pki_discussionmembership_id = [ + 165 + ], ), + ) + """ + + def testDiscussionmembershipCreateObjectV1Response(self): + """Test DiscussionmembershipCreateObjectV1Response""" + # 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_discussionmembership_create_object_v1_response_m_payload.py b/test/test_discussionmembership_create_object_v1_response_m_payload.py new file mode 100644 index 000000000..83201ddc6 --- /dev/null +++ b/test/test_discussionmembership_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.discussionmembership_create_object_v1_response_m_payload import DiscussionmembershipCreateObjectV1ResponseMPayload + +class TestDiscussionmembershipCreateObjectV1ResponseMPayload(unittest.TestCase): + """DiscussionmembershipCreateObjectV1ResponseMPayload unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionmembershipCreateObjectV1ResponseMPayload: + """Test DiscussionmembershipCreateObjectV1ResponseMPayload + 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 `DiscussionmembershipCreateObjectV1ResponseMPayload` + """ + model = DiscussionmembershipCreateObjectV1ResponseMPayload() + if include_optional: + return DiscussionmembershipCreateObjectV1ResponseMPayload( + a_pki_discussionmembership_id = [ + 165 + ] + ) + else: + return DiscussionmembershipCreateObjectV1ResponseMPayload( + a_pki_discussionmembership_id = [ + 165 + ], + ) + """ + + def testDiscussionmembershipCreateObjectV1ResponseMPayload(self): + """Test DiscussionmembershipCreateObjectV1ResponseMPayload""" + # 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_discussionmembership_delete_object_v1_response.py b/test/test_discussionmembership_delete_object_v1_response.py new file mode 100644 index 000000000..64b642d30 --- /dev/null +++ b/test/test_discussionmembership_delete_object_v1_response.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 +import datetime + +from eZmaxApi.models.discussionmembership_delete_object_v1_response import DiscussionmembershipDeleteObjectV1Response + +class TestDiscussionmembershipDeleteObjectV1Response(unittest.TestCase): + """DiscussionmembershipDeleteObjectV1Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionmembershipDeleteObjectV1Response: + """Test DiscussionmembershipDeleteObjectV1Response + 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 `DiscussionmembershipDeleteObjectV1Response` + """ + model = DiscussionmembershipDeleteObjectV1Response() + if include_optional: + return DiscussionmembershipDeleteObjectV1Response( + 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}]} + ) + else: + return DiscussionmembershipDeleteObjectV1Response( + 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, ), + ) + """ + + def testDiscussionmembershipDeleteObjectV1Response(self): + """Test DiscussionmembershipDeleteObjectV1Response""" + # 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_discussionmembership_request.py b/test/test_discussionmembership_request.py new file mode 100644 index 000000000..0f31f9094 --- /dev/null +++ b/test/test_discussionmembership_request.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.discussionmembership_request import DiscussionmembershipRequest + +class TestDiscussionmembershipRequest(unittest.TestCase): + """DiscussionmembershipRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionmembershipRequest: + """Test DiscussionmembershipRequest + 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 `DiscussionmembershipRequest` + """ + model = DiscussionmembershipRequest() + if include_optional: + return DiscussionmembershipRequest( + pki_discussionmembership_id = 165, + fki_discussion_id = 125, + fki_user_id = 70, + fki_usergroup_id = 2, + fki_modulesection_id = 53, + dt_discussionmembership_joined = '2020-12-31 23:59:59' + ) + else: + return DiscussionmembershipRequest( + fki_discussion_id = 125, + dt_discussionmembership_joined = '2020-12-31 23:59:59', + ) + """ + + def testDiscussionmembershipRequest(self): + """Test DiscussionmembershipRequest""" + # 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_discussionmembership_request_compound.py b/test/test_discussionmembership_request_compound.py new file mode 100644 index 000000000..62a0fa124 --- /dev/null +++ b/test/test_discussionmembership_request_compound.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.discussionmembership_request_compound import DiscussionmembershipRequestCompound + +class TestDiscussionmembershipRequestCompound(unittest.TestCase): + """DiscussionmembershipRequestCompound unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionmembershipRequestCompound: + """Test DiscussionmembershipRequestCompound + 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 `DiscussionmembershipRequestCompound` + """ + model = DiscussionmembershipRequestCompound() + if include_optional: + return DiscussionmembershipRequestCompound( + pki_discussionmembership_id = 165, + fki_discussion_id = 125, + fki_user_id = 70, + fki_usergroup_id = 2, + fki_modulesection_id = 53, + dt_discussionmembership_joined = '2020-12-31 23:59:59' + ) + else: + return DiscussionmembershipRequestCompound( + fki_discussion_id = 125, + dt_discussionmembership_joined = '2020-12-31 23:59:59', + ) + """ + + def testDiscussionmembershipRequestCompound(self): + """Test DiscussionmembershipRequestCompound""" + # 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_discussionmembership_response.py b/test/test_discussionmembership_response.py new file mode 100644 index 000000000..92b7a8ddd --- /dev/null +++ b/test/test_discussionmembership_response.py @@ -0,0 +1,63 @@ +# 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.discussionmembership_response import DiscussionmembershipResponse + +class TestDiscussionmembershipResponse(unittest.TestCase): + """DiscussionmembershipResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionmembershipResponse: + """Test DiscussionmembershipResponse + 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 `DiscussionmembershipResponse` + """ + model = DiscussionmembershipResponse() + if include_optional: + return DiscussionmembershipResponse( + pki_discussionmembership_id = 165, + fki_discussion_id = 125, + fki_user_id = 70, + fki_usergroup_id = 2, + fki_modulesection_id = 53, + s_discussionmembership_description = 'John Doe', + dt_discussionmembership_joined = '2020-12-31 23:59:59' + ) + else: + return DiscussionmembershipResponse( + pki_discussionmembership_id = 165, + fki_discussion_id = 125, + s_discussionmembership_description = 'John Doe', + dt_discussionmembership_joined = '2020-12-31 23:59:59', + ) + """ + + def testDiscussionmembershipResponse(self): + """Test DiscussionmembershipResponse""" + # 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_discussionmembership_response_compound.py b/test/test_discussionmembership_response_compound.py new file mode 100644 index 000000000..5d1ef8e3e --- /dev/null +++ b/test/test_discussionmembership_response_compound.py @@ -0,0 +1,63 @@ +# 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.discussionmembership_response_compound import DiscussionmembershipResponseCompound + +class TestDiscussionmembershipResponseCompound(unittest.TestCase): + """DiscussionmembershipResponseCompound unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionmembershipResponseCompound: + """Test DiscussionmembershipResponseCompound + 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 `DiscussionmembershipResponseCompound` + """ + model = DiscussionmembershipResponseCompound() + if include_optional: + return DiscussionmembershipResponseCompound( + pki_discussionmembership_id = 165, + fki_discussion_id = 125, + fki_user_id = 70, + fki_usergroup_id = 2, + fki_modulesection_id = 53, + s_discussionmembership_description = 'John Doe', + dt_discussionmembership_joined = '2020-12-31 23:59:59' + ) + else: + return DiscussionmembershipResponseCompound( + pki_discussionmembership_id = 165, + fki_discussion_id = 125, + s_discussionmembership_description = 'John Doe', + dt_discussionmembership_joined = '2020-12-31 23:59:59', + ) + """ + + def testDiscussionmembershipResponseCompound(self): + """Test DiscussionmembershipResponseCompound""" + # 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_discussionmessage_create_object_v1_request.py b/test/test_discussionmessage_create_object_v1_request.py new file mode 100644 index 000000000..b7906bea6 --- /dev/null +++ b/test/test_discussionmessage_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.discussionmessage_create_object_v1_request import DiscussionmessageCreateObjectV1Request + +class TestDiscussionmessageCreateObjectV1Request(unittest.TestCase): + """DiscussionmessageCreateObjectV1Request unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionmessageCreateObjectV1Request: + """Test DiscussionmessageCreateObjectV1Request + 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 `DiscussionmessageCreateObjectV1Request` + """ + model = DiscussionmessageCreateObjectV1Request() + if include_optional: + return DiscussionmessageCreateObjectV1Request( + a_obj_discussionmessage = [ + eZmaxApi.models.discussionmessage_request_compound.discussionmessage-RequestCompound() + ] + ) + else: + return DiscussionmessageCreateObjectV1Request( + a_obj_discussionmessage = [ + eZmaxApi.models.discussionmessage_request_compound.discussionmessage-RequestCompound() + ], + ) + """ + + def testDiscussionmessageCreateObjectV1Request(self): + """Test DiscussionmessageCreateObjectV1Request""" + # 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_discussionmessage_create_object_v1_response.py b/test/test_discussionmessage_create_object_v1_response.py new file mode 100644 index 000000000..08147a9a5 --- /dev/null +++ b/test/test_discussionmessage_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.discussionmessage_create_object_v1_response import DiscussionmessageCreateObjectV1Response + +class TestDiscussionmessageCreateObjectV1Response(unittest.TestCase): + """DiscussionmessageCreateObjectV1Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionmessageCreateObjectV1Response: + """Test DiscussionmessageCreateObjectV1Response + 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 `DiscussionmessageCreateObjectV1Response` + """ + model = DiscussionmessageCreateObjectV1Response() + if include_optional: + return DiscussionmessageCreateObjectV1Response( + 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.discussionmessage_create_object_v1_response_m_payload.discussionmessage-createObject-v1-Response-mPayload( + a_pki_discussionmessage_id = [ + 123 + ], ) + ) + else: + return DiscussionmessageCreateObjectV1Response( + 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.discussionmessage_create_object_v1_response_m_payload.discussionmessage-createObject-v1-Response-mPayload( + a_pki_discussionmessage_id = [ + 123 + ], ), + ) + """ + + def testDiscussionmessageCreateObjectV1Response(self): + """Test DiscussionmessageCreateObjectV1Response""" + # 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_discussionmessage_create_object_v1_response_m_payload.py b/test/test_discussionmessage_create_object_v1_response_m_payload.py new file mode 100644 index 000000000..21c92abec --- /dev/null +++ b/test/test_discussionmessage_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.discussionmessage_create_object_v1_response_m_payload import DiscussionmessageCreateObjectV1ResponseMPayload + +class TestDiscussionmessageCreateObjectV1ResponseMPayload(unittest.TestCase): + """DiscussionmessageCreateObjectV1ResponseMPayload unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionmessageCreateObjectV1ResponseMPayload: + """Test DiscussionmessageCreateObjectV1ResponseMPayload + 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 `DiscussionmessageCreateObjectV1ResponseMPayload` + """ + model = DiscussionmessageCreateObjectV1ResponseMPayload() + if include_optional: + return DiscussionmessageCreateObjectV1ResponseMPayload( + a_pki_discussionmessage_id = [ + 123 + ] + ) + else: + return DiscussionmessageCreateObjectV1ResponseMPayload( + a_pki_discussionmessage_id = [ + 123 + ], + ) + """ + + def testDiscussionmessageCreateObjectV1ResponseMPayload(self): + """Test DiscussionmessageCreateObjectV1ResponseMPayload""" + # 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_discussionmessage_delete_object_v1_response.py b/test/test_discussionmessage_delete_object_v1_response.py new file mode 100644 index 000000000..3b41b8a86 --- /dev/null +++ b/test/test_discussionmessage_delete_object_v1_response.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 +import datetime + +from eZmaxApi.models.discussionmessage_delete_object_v1_response import DiscussionmessageDeleteObjectV1Response + +class TestDiscussionmessageDeleteObjectV1Response(unittest.TestCase): + """DiscussionmessageDeleteObjectV1Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionmessageDeleteObjectV1Response: + """Test DiscussionmessageDeleteObjectV1Response + 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 `DiscussionmessageDeleteObjectV1Response` + """ + model = DiscussionmessageDeleteObjectV1Response() + if include_optional: + return DiscussionmessageDeleteObjectV1Response( + 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}]} + ) + else: + return DiscussionmessageDeleteObjectV1Response( + 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, ), + ) + """ + + def testDiscussionmessageDeleteObjectV1Response(self): + """Test DiscussionmessageDeleteObjectV1Response""" + # 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_discussionmessage_patch_object_v1_request.py b/test/test_discussionmessage_patch_object_v1_request.py new file mode 100644 index 000000000..a55e0d1a4 --- /dev/null +++ b/test/test_discussionmessage_patch_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.discussionmessage_patch_object_v1_request import DiscussionmessagePatchObjectV1Request + +class TestDiscussionmessagePatchObjectV1Request(unittest.TestCase): + """DiscussionmessagePatchObjectV1Request unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionmessagePatchObjectV1Request: + """Test DiscussionmessagePatchObjectV1Request + 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 `DiscussionmessagePatchObjectV1Request` + """ + model = DiscussionmessagePatchObjectV1Request() + if include_optional: + return DiscussionmessagePatchObjectV1Request( + obj_discussionmessage = eZmaxApi.models.discussionmessage_request_patch.discussionmessage-RequestPatch( + fki_discussionmembership_id_actionrequired = 165, + t_discussionmessage_content = 'Hello, this is an example of content in a message', ) + ) + else: + return DiscussionmessagePatchObjectV1Request( + obj_discussionmessage = eZmaxApi.models.discussionmessage_request_patch.discussionmessage-RequestPatch( + fki_discussionmembership_id_actionrequired = 165, + t_discussionmessage_content = 'Hello, this is an example of content in a message', ), + ) + """ + + def testDiscussionmessagePatchObjectV1Request(self): + """Test DiscussionmessagePatchObjectV1Request""" + # 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_discussionmessage_patch_object_v1_response.py b/test/test_discussionmessage_patch_object_v1_response.py new file mode 100644 index 000000000..512905616 --- /dev/null +++ b/test/test_discussionmessage_patch_object_v1_response.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 +import datetime + +from eZmaxApi.models.discussionmessage_patch_object_v1_response import DiscussionmessagePatchObjectV1Response + +class TestDiscussionmessagePatchObjectV1Response(unittest.TestCase): + """DiscussionmessagePatchObjectV1Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionmessagePatchObjectV1Response: + """Test DiscussionmessagePatchObjectV1Response + 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 `DiscussionmessagePatchObjectV1Response` + """ + model = DiscussionmessagePatchObjectV1Response() + if include_optional: + return DiscussionmessagePatchObjectV1Response( + 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}]} + ) + else: + return DiscussionmessagePatchObjectV1Response( + 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, ), + ) + """ + + def testDiscussionmessagePatchObjectV1Response(self): + """Test DiscussionmessagePatchObjectV1Response""" + # 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_discussionmessage_request.py b/test/test_discussionmessage_request.py new file mode 100644 index 000000000..9de0a8735 --- /dev/null +++ b/test/test_discussionmessage_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.discussionmessage_request import DiscussionmessageRequest + +class TestDiscussionmessageRequest(unittest.TestCase): + """DiscussionmessageRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionmessageRequest: + """Test DiscussionmessageRequest + 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 `DiscussionmessageRequest` + """ + model = DiscussionmessageRequest() + if include_optional: + return DiscussionmessageRequest( + pki_discussionmessage_id = 123, + fki_discussion_id = 125, + fki_discussionmembership_id_actionrequired = 165, + t_discussionmessage_content = 'Hello, this is an example of content in a message' + ) + else: + return DiscussionmessageRequest( + fki_discussion_id = 125, + t_discussionmessage_content = 'Hello, this is an example of content in a message', + ) + """ + + def testDiscussionmessageRequest(self): + """Test DiscussionmessageRequest""" + # 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_discussionmessage_request_compound.py b/test/test_discussionmessage_request_compound.py new file mode 100644 index 000000000..0f5bd89d7 --- /dev/null +++ b/test/test_discussionmessage_request_compound.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.discussionmessage_request_compound import DiscussionmessageRequestCompound + +class TestDiscussionmessageRequestCompound(unittest.TestCase): + """DiscussionmessageRequestCompound unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionmessageRequestCompound: + """Test DiscussionmessageRequestCompound + 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 `DiscussionmessageRequestCompound` + """ + model = DiscussionmessageRequestCompound() + if include_optional: + return DiscussionmessageRequestCompound( + pki_discussionmessage_id = 123, + fki_discussion_id = 125, + fki_discussionmembership_id_actionrequired = 165, + t_discussionmessage_content = 'Hello, this is an example of content in a message' + ) + else: + return DiscussionmessageRequestCompound( + fki_discussion_id = 125, + t_discussionmessage_content = 'Hello, this is an example of content in a message', + ) + """ + + def testDiscussionmessageRequestCompound(self): + """Test DiscussionmessageRequestCompound""" + # 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_discussionmessage_request_patch.py b/test/test_discussionmessage_request_patch.py new file mode 100644 index 000000000..f2f24597b --- /dev/null +++ b/test/test_discussionmessage_request_patch.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.discussionmessage_request_patch import DiscussionmessageRequestPatch + +class TestDiscussionmessageRequestPatch(unittest.TestCase): + """DiscussionmessageRequestPatch unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionmessageRequestPatch: + """Test DiscussionmessageRequestPatch + 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 `DiscussionmessageRequestPatch` + """ + model = DiscussionmessageRequestPatch() + if include_optional: + return DiscussionmessageRequestPatch( + fki_discussionmembership_id_actionrequired = 165, + t_discussionmessage_content = 'Hello, this is an example of content in a message' + ) + else: + return DiscussionmessageRequestPatch( + ) + """ + + def testDiscussionmessageRequestPatch(self): + """Test DiscussionmessageRequestPatch""" + # 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_discussionmessage_response.py b/test/test_discussionmessage_response.py new file mode 100644 index 000000000..5d4766161 --- /dev/null +++ b/test/test_discussionmessage_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 + + +import unittest +import datetime + +from eZmaxApi.models.discussionmessage_response import DiscussionmessageResponse + +class TestDiscussionmessageResponse(unittest.TestCase): + """DiscussionmessageResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionmessageResponse: + """Test DiscussionmessageResponse + 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 `DiscussionmessageResponse` + """ + model = DiscussionmessageResponse() + if include_optional: + return DiscussionmessageResponse( + pki_discussionmessage_id = 123, + fki_discussion_id = 125, + fki_discussionmembership_id = 165, + fki_discussionmembership_id_actionrequired = 165, + e_discussionmessage_status = 'New', + t_discussionmessage_content = 'Hello, this is an example of content in a message', + s_discussionmessage_creatorname = 'John Doe', + s_discussionmessage_actionrequiredname = 'Jane Doe', + 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 DiscussionmessageResponse( + pki_discussionmessage_id = 123, + fki_discussion_id = 125, + e_discussionmessage_status = 'New', + t_discussionmessage_content = 'Hello, this is an example of content in a message', + s_discussionmessage_creatorname = 'John Doe', + 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', ), ), + ) + """ + + def testDiscussionmessageResponse(self): + """Test DiscussionmessageResponse""" + # 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_discussionmessage_response_compound.py b/test/test_discussionmessage_response_compound.py new file mode 100644 index 000000000..5d7049230 --- /dev/null +++ b/test/test_discussionmessage_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 + + +import unittest +import datetime + +from eZmaxApi.models.discussionmessage_response_compound import DiscussionmessageResponseCompound + +class TestDiscussionmessageResponseCompound(unittest.TestCase): + """DiscussionmessageResponseCompound unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> DiscussionmessageResponseCompound: + """Test DiscussionmessageResponseCompound + 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 `DiscussionmessageResponseCompound` + """ + model = DiscussionmessageResponseCompound() + if include_optional: + return DiscussionmessageResponseCompound( + pki_discussionmessage_id = 123, + fki_discussion_id = 125, + fki_discussionmembership_id = 165, + fki_discussionmembership_id_actionrequired = 165, + e_discussionmessage_status = 'New', + t_discussionmessage_content = 'Hello, this is an example of content in a message', + s_discussionmessage_creatorname = 'John Doe', + s_discussionmessage_actionrequiredname = 'Jane Doe', + 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 DiscussionmessageResponseCompound( + pki_discussionmessage_id = 123, + fki_discussion_id = 125, + e_discussionmessage_status = 'New', + t_discussionmessage_content = 'Hello, this is an example of content in a message', + s_discussionmessage_creatorname = 'John Doe', + 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', ), ), + ) + """ + + def testDiscussionmessageResponseCompound(self): + """Test DiscussionmessageResponseCompound""" + # 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_ezsigndiscussion_create_object_v1_request.py b/test/test_ezsigndiscussion_create_object_v1_request.py new file mode 100644 index 000000000..255927e7f --- /dev/null +++ b/test/test_ezsigndiscussion_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.ezsigndiscussion_create_object_v1_request import EzsigndiscussionCreateObjectV1Request + +class TestEzsigndiscussionCreateObjectV1Request(unittest.TestCase): + """EzsigndiscussionCreateObjectV1Request unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsigndiscussionCreateObjectV1Request: + """Test EzsigndiscussionCreateObjectV1Request + 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 `EzsigndiscussionCreateObjectV1Request` + """ + model = EzsigndiscussionCreateObjectV1Request() + if include_optional: + return EzsigndiscussionCreateObjectV1Request( + a_obj_ezsigndiscussion = [ + eZmaxApi.models.ezsigndiscussion_request_compound.ezsigndiscussion-RequestCompound() + ] + ) + else: + return EzsigndiscussionCreateObjectV1Request( + a_obj_ezsigndiscussion = [ + eZmaxApi.models.ezsigndiscussion_request_compound.ezsigndiscussion-RequestCompound() + ], + ) + """ + + def testEzsigndiscussionCreateObjectV1Request(self): + """Test EzsigndiscussionCreateObjectV1Request""" + # 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_ezsigndiscussion_create_object_v1_response.py b/test/test_ezsigndiscussion_create_object_v1_response.py new file mode 100644 index 000000000..ddf54a9a6 --- /dev/null +++ b/test/test_ezsigndiscussion_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.ezsigndiscussion_create_object_v1_response import EzsigndiscussionCreateObjectV1Response + +class TestEzsigndiscussionCreateObjectV1Response(unittest.TestCase): + """EzsigndiscussionCreateObjectV1Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsigndiscussionCreateObjectV1Response: + """Test EzsigndiscussionCreateObjectV1Response + 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 `EzsigndiscussionCreateObjectV1Response` + """ + model = EzsigndiscussionCreateObjectV1Response() + if include_optional: + return EzsigndiscussionCreateObjectV1Response( + 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.ezsigndiscussion_create_object_v1_response_m_payload.ezsigndiscussion-createObject-v1-Response-mPayload( + a_pki_ezsigndiscussion_id = [ + 194 + ], ) + ) + else: + return EzsigndiscussionCreateObjectV1Response( + 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.ezsigndiscussion_create_object_v1_response_m_payload.ezsigndiscussion-createObject-v1-Response-mPayload( + a_pki_ezsigndiscussion_id = [ + 194 + ], ), + ) + """ + + def testEzsigndiscussionCreateObjectV1Response(self): + """Test EzsigndiscussionCreateObjectV1Response""" + # 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_ezsigndiscussion_create_object_v1_response_m_payload.py b/test/test_ezsigndiscussion_create_object_v1_response_m_payload.py new file mode 100644 index 000000000..90ca02ccd --- /dev/null +++ b/test/test_ezsigndiscussion_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.ezsigndiscussion_create_object_v1_response_m_payload import EzsigndiscussionCreateObjectV1ResponseMPayload + +class TestEzsigndiscussionCreateObjectV1ResponseMPayload(unittest.TestCase): + """EzsigndiscussionCreateObjectV1ResponseMPayload unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsigndiscussionCreateObjectV1ResponseMPayload: + """Test EzsigndiscussionCreateObjectV1ResponseMPayload + 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 `EzsigndiscussionCreateObjectV1ResponseMPayload` + """ + model = EzsigndiscussionCreateObjectV1ResponseMPayload() + if include_optional: + return EzsigndiscussionCreateObjectV1ResponseMPayload( + a_pki_ezsigndiscussion_id = [ + 194 + ] + ) + else: + return EzsigndiscussionCreateObjectV1ResponseMPayload( + a_pki_ezsigndiscussion_id = [ + 194 + ], + ) + """ + + def testEzsigndiscussionCreateObjectV1ResponseMPayload(self): + """Test EzsigndiscussionCreateObjectV1ResponseMPayload""" + # 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_ezsigndiscussion_delete_object_v1_response.py b/test/test_ezsigndiscussion_delete_object_v1_response.py new file mode 100644 index 000000000..32b5a84fc --- /dev/null +++ b/test/test_ezsigndiscussion_delete_object_v1_response.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 +import datetime + +from eZmaxApi.models.ezsigndiscussion_delete_object_v1_response import EzsigndiscussionDeleteObjectV1Response + +class TestEzsigndiscussionDeleteObjectV1Response(unittest.TestCase): + """EzsigndiscussionDeleteObjectV1Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsigndiscussionDeleteObjectV1Response: + """Test EzsigndiscussionDeleteObjectV1Response + 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 `EzsigndiscussionDeleteObjectV1Response` + """ + model = EzsigndiscussionDeleteObjectV1Response() + if include_optional: + return EzsigndiscussionDeleteObjectV1Response( + 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}]} + ) + else: + return EzsigndiscussionDeleteObjectV1Response( + 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, ), + ) + """ + + def testEzsigndiscussionDeleteObjectV1Response(self): + """Test EzsigndiscussionDeleteObjectV1Response""" + # 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_ezsigndiscussion_get_object_v2_response.py b/test/test_ezsigndiscussion_get_object_v2_response.py new file mode 100644 index 000000000..3ce042d2d --- /dev/null +++ b/test/test_ezsigndiscussion_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.ezsigndiscussion_get_object_v2_response import EzsigndiscussionGetObjectV2Response + +class TestEzsigndiscussionGetObjectV2Response(unittest.TestCase): + """EzsigndiscussionGetObjectV2Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsigndiscussionGetObjectV2Response: + """Test EzsigndiscussionGetObjectV2Response + 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 `EzsigndiscussionGetObjectV2Response` + """ + model = EzsigndiscussionGetObjectV2Response() + if include_optional: + return EzsigndiscussionGetObjectV2Response( + 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.ezsigndiscussion_get_object_v2_response_m_payload.ezsigndiscussion-getObject-v2-Response-mPayload( + obj_ezsigndiscussion = eZmaxApi.models.ezsigndiscussion_response_compound.ezsigndiscussion-ResponseCompound(), ) + ) + else: + return EzsigndiscussionGetObjectV2Response( + 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.ezsigndiscussion_get_object_v2_response_m_payload.ezsigndiscussion-getObject-v2-Response-mPayload( + obj_ezsigndiscussion = eZmaxApi.models.ezsigndiscussion_response_compound.ezsigndiscussion-ResponseCompound(), ), + ) + """ + + def testEzsigndiscussionGetObjectV2Response(self): + """Test EzsigndiscussionGetObjectV2Response""" + # 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_ezsigndiscussion_get_object_v2_response_m_payload.py b/test/test_ezsigndiscussion_get_object_v2_response_m_payload.py new file mode 100644 index 000000000..b6661f86e --- /dev/null +++ b/test/test_ezsigndiscussion_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.ezsigndiscussion_get_object_v2_response_m_payload import EzsigndiscussionGetObjectV2ResponseMPayload + +class TestEzsigndiscussionGetObjectV2ResponseMPayload(unittest.TestCase): + """EzsigndiscussionGetObjectV2ResponseMPayload unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsigndiscussionGetObjectV2ResponseMPayload: + """Test EzsigndiscussionGetObjectV2ResponseMPayload + 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 `EzsigndiscussionGetObjectV2ResponseMPayload` + """ + model = EzsigndiscussionGetObjectV2ResponseMPayload() + if include_optional: + return EzsigndiscussionGetObjectV2ResponseMPayload( + obj_ezsigndiscussion = eZmaxApi.models.ezsigndiscussion_response_compound.ezsigndiscussion-ResponseCompound() + ) + else: + return EzsigndiscussionGetObjectV2ResponseMPayload( + obj_ezsigndiscussion = eZmaxApi.models.ezsigndiscussion_response_compound.ezsigndiscussion-ResponseCompound(), + ) + """ + + def testEzsigndiscussionGetObjectV2ResponseMPayload(self): + """Test EzsigndiscussionGetObjectV2ResponseMPayload""" + # 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_ezsigndiscussion_request.py b/test/test_ezsigndiscussion_request.py new file mode 100644 index 000000000..03363b1da --- /dev/null +++ b/test/test_ezsigndiscussion_request.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.ezsigndiscussion_request import EzsigndiscussionRequest + +class TestEzsigndiscussionRequest(unittest.TestCase): + """EzsigndiscussionRequest unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsigndiscussionRequest: + """Test EzsigndiscussionRequest + 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 `EzsigndiscussionRequest` + """ + model = EzsigndiscussionRequest() + if include_optional: + return EzsigndiscussionRequest( + pki_ezsigndiscussion_id = 194, + fki_ezsigndocument_id = 97, + i_ezsigndiscussion_pagenumber = 4, + i_ezsigndiscussion_x = 57208, + i_ezsigndiscussion_y = 57652, + obj_discussion = eZmaxApi.models.discussion_request.discussion-Request( + pki_discussion_id = 125, + s_discussion_description = 'John Doe', + b_discussion_closed = True, ) + ) + else: + return EzsigndiscussionRequest( + fki_ezsigndocument_id = 97, + i_ezsigndiscussion_pagenumber = 4, + i_ezsigndiscussion_x = 57208, + i_ezsigndiscussion_y = 57652, + obj_discussion = eZmaxApi.models.discussion_request.discussion-Request( + pki_discussion_id = 125, + s_discussion_description = 'John Doe', + b_discussion_closed = True, ), + ) + """ + + def testEzsigndiscussionRequest(self): + """Test EzsigndiscussionRequest""" + # 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_ezsigndiscussion_request_compound.py b/test/test_ezsigndiscussion_request_compound.py new file mode 100644 index 000000000..c8f147558 --- /dev/null +++ b/test/test_ezsigndiscussion_request_compound.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.ezsigndiscussion_request_compound import EzsigndiscussionRequestCompound + +class TestEzsigndiscussionRequestCompound(unittest.TestCase): + """EzsigndiscussionRequestCompound unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsigndiscussionRequestCompound: + """Test EzsigndiscussionRequestCompound + 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 `EzsigndiscussionRequestCompound` + """ + model = EzsigndiscussionRequestCompound() + if include_optional: + return EzsigndiscussionRequestCompound( + pki_ezsigndiscussion_id = 194, + fki_ezsigndocument_id = 97, + i_ezsigndiscussion_pagenumber = 4, + i_ezsigndiscussion_x = 57208, + i_ezsigndiscussion_y = 57652, + obj_discussion = eZmaxApi.models.discussion_request.discussion-Request( + pki_discussion_id = 125, + s_discussion_description = 'John Doe', + b_discussion_closed = True, ) + ) + else: + return EzsigndiscussionRequestCompound( + fki_ezsigndocument_id = 97, + i_ezsigndiscussion_pagenumber = 4, + i_ezsigndiscussion_x = 57208, + i_ezsigndiscussion_y = 57652, + obj_discussion = eZmaxApi.models.discussion_request.discussion-Request( + pki_discussion_id = 125, + s_discussion_description = 'John Doe', + b_discussion_closed = True, ), + ) + """ + + def testEzsigndiscussionRequestCompound(self): + """Test EzsigndiscussionRequestCompound""" + # 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_ezsigndiscussion_response.py b/test/test_ezsigndiscussion_response.py new file mode 100644 index 000000000..a63a71976 --- /dev/null +++ b/test/test_ezsigndiscussion_response.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.ezsigndiscussion_response import EzsigndiscussionResponse + +class TestEzsigndiscussionResponse(unittest.TestCase): + """EzsigndiscussionResponse unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsigndiscussionResponse: + """Test EzsigndiscussionResponse + 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 `EzsigndiscussionResponse` + """ + model = EzsigndiscussionResponse() + if include_optional: + return EzsigndiscussionResponse( + pki_ezsigndiscussion_id = 194, + fki_ezsignpage_id = 64, + fki_discussion_id = 125, + i_ezsigndiscussion_x = 57208, + i_ezsigndiscussion_y = 57652, + i_ezsigndiscussion_pagenumber = 4, + obj_discussion = eZmaxApi.models.discussion_response_compound.discussion-ResponseCompound() + ) + else: + return EzsigndiscussionResponse( + pki_ezsigndiscussion_id = 194, + fki_ezsignpage_id = 64, + fki_discussion_id = 125, + i_ezsigndiscussion_x = 57208, + i_ezsigndiscussion_y = 57652, + i_ezsigndiscussion_pagenumber = 4, + obj_discussion = eZmaxApi.models.discussion_response_compound.discussion-ResponseCompound(), + ) + """ + + def testEzsigndiscussionResponse(self): + """Test EzsigndiscussionResponse""" + # 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_ezsigndiscussion_response_compound.py b/test/test_ezsigndiscussion_response_compound.py new file mode 100644 index 000000000..31d0281de --- /dev/null +++ b/test/test_ezsigndiscussion_response_compound.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.ezsigndiscussion_response_compound import EzsigndiscussionResponseCompound + +class TestEzsigndiscussionResponseCompound(unittest.TestCase): + """EzsigndiscussionResponseCompound unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsigndiscussionResponseCompound: + """Test EzsigndiscussionResponseCompound + 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 `EzsigndiscussionResponseCompound` + """ + model = EzsigndiscussionResponseCompound() + if include_optional: + return EzsigndiscussionResponseCompound( + pki_ezsigndiscussion_id = 194, + fki_ezsignpage_id = 64, + fki_discussion_id = 125, + i_ezsigndiscussion_x = 57208, + i_ezsigndiscussion_y = 57652, + i_ezsigndiscussion_pagenumber = 4, + obj_discussion = eZmaxApi.models.discussion_response_compound.discussion-ResponseCompound() + ) + else: + return EzsigndiscussionResponseCompound( + pki_ezsigndiscussion_id = 194, + fki_ezsignpage_id = 64, + fki_discussion_id = 125, + i_ezsigndiscussion_x = 57208, + i_ezsigndiscussion_y = 57652, + i_ezsigndiscussion_pagenumber = 4, + obj_discussion = eZmaxApi.models.discussion_response_compound.discussion-ResponseCompound(), + ) + """ + + def testEzsigndiscussionResponseCompound(self): + """Test EzsigndiscussionResponseCompound""" + # 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_apply_ezsigntemplate_v2_response.py b/test/test_ezsigndocument_apply_ezsigntemplate_v2_response.py index d4a2c89fb..cab732c40 100644 --- a/test/test_ezsigndocument_apply_ezsigntemplate_v2_response.py +++ b/test/test_ezsigndocument_apply_ezsigntemplate_v2_response.py @@ -44,7 +44,12 @@ def make_instance(self, include_optional) -> EzsigndocumentApplyEzsigntemplateV2 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}]} + 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}]}, + a_obj_warning = [ + eZmaxApi.models.common_response_warning.Common-Response-Warning( + s_warning_message = '', + e_warning_code = '', ) + ] ) else: return EzsigndocumentApplyEzsigntemplateV2Response( diff --git a/test/test_ezsigndocument_create_ezsignelements_positioned_by_word_v1_request.py b/test/test_ezsigndocument_create_ezsignelements_positioned_by_word_v1_request.py new file mode 100644 index 000000000..31e049ea4 --- /dev/null +++ b/test/test_ezsigndocument_create_ezsignelements_positioned_by_word_v1_request.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.ezsigndocument_create_ezsignelements_positioned_by_word_v1_request import EzsigndocumentCreateEzsignelementsPositionedByWordV1Request + +class TestEzsigndocumentCreateEzsignelementsPositionedByWordV1Request(unittest.TestCase): + """EzsigndocumentCreateEzsignelementsPositionedByWordV1Request unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsigndocumentCreateEzsignelementsPositionedByWordV1Request: + """Test EzsigndocumentCreateEzsignelementsPositionedByWordV1Request + 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 `EzsigndocumentCreateEzsignelementsPositionedByWordV1Request` + """ + model = EzsigndocumentCreateEzsignelementsPositionedByWordV1Request() + if include_optional: + return EzsigndocumentCreateEzsignelementsPositionedByWordV1Request( + a_obj_ezsignformfieldgroup = [ + eZmaxApi.models.custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request.Custom-EzsignformfieldgroupCreateEzsignelementsPositionedByWord-Request() + ], + a_obj_ezsignsignature = [ + eZmaxApi.models.custom_ezsignsignature_create_ezsignelements_positioned_by_word_request.Custom-EzsignsignatureCreateEzsignelementsPositionedByWord-Request() + ] + ) + else: + return EzsigndocumentCreateEzsignelementsPositionedByWordV1Request( + a_obj_ezsignformfieldgroup = [ + eZmaxApi.models.custom_ezsignformfieldgroup_create_ezsignelements_positioned_by_word_request.Custom-EzsignformfieldgroupCreateEzsignelementsPositionedByWord-Request() + ], + a_obj_ezsignsignature = [ + eZmaxApi.models.custom_ezsignsignature_create_ezsignelements_positioned_by_word_request.Custom-EzsignsignatureCreateEzsignelementsPositionedByWord-Request() + ], + ) + """ + + def testEzsigndocumentCreateEzsignelementsPositionedByWordV1Request(self): + """Test EzsigndocumentCreateEzsignelementsPositionedByWordV1Request""" + # 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_create_ezsignelements_positioned_by_word_v1_response.py b/test/test_ezsigndocument_create_ezsignelements_positioned_by_word_v1_response.py new file mode 100644 index 000000000..2879683e0 --- /dev/null +++ b/test/test_ezsigndocument_create_ezsignelements_positioned_by_word_v1_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.ezsigndocument_create_ezsignelements_positioned_by_word_v1_response import EzsigndocumentCreateEzsignelementsPositionedByWordV1Response + +class TestEzsigndocumentCreateEzsignelementsPositionedByWordV1Response(unittest.TestCase): + """EzsigndocumentCreateEzsignelementsPositionedByWordV1Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsigndocumentCreateEzsignelementsPositionedByWordV1Response: + """Test EzsigndocumentCreateEzsignelementsPositionedByWordV1Response + 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 `EzsigndocumentCreateEzsignelementsPositionedByWordV1Response` + """ + model = EzsigndocumentCreateEzsignelementsPositionedByWordV1Response() + if include_optional: + return EzsigndocumentCreateEzsignelementsPositionedByWordV1Response( + 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_create_ezsignelements_positioned_by_word_v1_response_m_payload.ezsigndocument-createEzsignelementsPositionedByWord-v1-Response-mPayload( + a_pki_ezsignsignature_id = [ + 49 + ], + a_pki_ezsignformfieldgroup_id = [ + 26 + ], ) + ) + else: + return EzsigndocumentCreateEzsignelementsPositionedByWordV1Response( + 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_create_ezsignelements_positioned_by_word_v1_response_m_payload.ezsigndocument-createEzsignelementsPositionedByWord-v1-Response-mPayload( + a_pki_ezsignsignature_id = [ + 49 + ], + a_pki_ezsignformfieldgroup_id = [ + 26 + ], ), + ) + """ + + def testEzsigndocumentCreateEzsignelementsPositionedByWordV1Response(self): + """Test EzsigndocumentCreateEzsignelementsPositionedByWordV1Response""" + # 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_create_ezsignelements_positioned_by_word_v1_response_m_payload.py b/test/test_ezsigndocument_create_ezsignelements_positioned_by_word_v1_response_m_payload.py new file mode 100644 index 000000000..ddb91542f --- /dev/null +++ b/test/test_ezsigndocument_create_ezsignelements_positioned_by_word_v1_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.ezsigndocument_create_ezsignelements_positioned_by_word_v1_response_m_payload import EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload + +class TestEzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload(unittest.TestCase): + """EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload: + """Test EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload + 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 `EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload` + """ + model = EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload() + if include_optional: + return EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload( + a_pki_ezsignsignature_id = [ + 49 + ], + a_pki_ezsignformfieldgroup_id = [ + 26 + ] + ) + else: + return EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload( + a_pki_ezsignsignature_id = [ + 49 + ], + a_pki_ezsignformfieldgroup_id = [ + 26 + ], + ) + """ + + def testEzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload(self): + """Test EzsigndocumentCreateEzsignelementsPositionedByWordV1ResponseMPayload""" + # 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_ezsigndiscussions_v1_response.py b/test/test_ezsigndocument_get_ezsigndiscussions_v1_response.py new file mode 100644 index 000000000..ae0b96282 --- /dev/null +++ b/test/test_ezsigndocument_get_ezsigndiscussions_v1_response.py @@ -0,0 +1,89 @@ +# 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_ezsigndiscussions_v1_response import EzsigndocumentGetEzsigndiscussionsV1Response + +class TestEzsigndocumentGetEzsigndiscussionsV1Response(unittest.TestCase): + """EzsigndocumentGetEzsigndiscussionsV1Response unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsigndocumentGetEzsigndiscussionsV1Response: + """Test EzsigndocumentGetEzsigndiscussionsV1Response + 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 `EzsigndocumentGetEzsigndiscussionsV1Response` + """ + model = EzsigndocumentGetEzsigndiscussionsV1Response() + if include_optional: + return EzsigndocumentGetEzsigndiscussionsV1Response( + 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_ezsigndiscussions_v1_response_m_payload.ezsigndocument-getEzsigndiscussions-v1-Response-mPayload( + a_obj_ezsigndiscussion = [ + eZmaxApi.models.ezsigndiscussion_response.ezsigndiscussion-Response( + pki_ezsigndiscussion_id = 194, + fki_ezsignpage_id = 64, + fki_discussion_id = 125, + i_ezsigndiscussion_x = 57208, + i_ezsigndiscussion_y = 57652, + i_ezsigndiscussion_pagenumber = 4, + obj_discussion = eZmaxApi.models.discussion_response_compound.discussion-ResponseCompound(), ) + ], ) + ) + else: + return EzsigndocumentGetEzsigndiscussionsV1Response( + 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_ezsigndiscussions_v1_response_m_payload.ezsigndocument-getEzsigndiscussions-v1-Response-mPayload( + a_obj_ezsigndiscussion = [ + eZmaxApi.models.ezsigndiscussion_response.ezsigndiscussion-Response( + pki_ezsigndiscussion_id = 194, + fki_ezsignpage_id = 64, + fki_discussion_id = 125, + i_ezsigndiscussion_x = 57208, + i_ezsigndiscussion_y = 57652, + i_ezsigndiscussion_pagenumber = 4, + obj_discussion = eZmaxApi.models.discussion_response_compound.discussion-ResponseCompound(), ) + ], ), + ) + """ + + def testEzsigndocumentGetEzsigndiscussionsV1Response(self): + """Test EzsigndocumentGetEzsigndiscussionsV1Response""" + # 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_ezsigndiscussions_v1_response_m_payload.py b/test/test_ezsigndocument_get_ezsigndiscussions_v1_response_m_payload.py new file mode 100644 index 000000000..df84fc506 --- /dev/null +++ b/test/test_ezsigndocument_get_ezsigndiscussions_v1_response_m_payload.py @@ -0,0 +1,72 @@ +# 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_ezsigndiscussions_v1_response_m_payload import EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload + +class TestEzsigndocumentGetEzsigndiscussionsV1ResponseMPayload(unittest.TestCase): + """EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def make_instance(self, include_optional) -> EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload: + """Test EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload + 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 `EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload` + """ + model = EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload() + if include_optional: + return EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload( + a_obj_ezsigndiscussion = [ + eZmaxApi.models.ezsigndiscussion_response.ezsigndiscussion-Response( + pki_ezsigndiscussion_id = 194, + fki_ezsignpage_id = 64, + fki_discussion_id = 125, + i_ezsigndiscussion_x = 57208, + i_ezsigndiscussion_y = 57652, + i_ezsigndiscussion_pagenumber = 4, + obj_discussion = eZmaxApi.models.discussion_response_compound.discussion-ResponseCompound(), ) + ] + ) + else: + return EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload( + a_obj_ezsigndiscussion = [ + eZmaxApi.models.ezsigndiscussion_response.ezsigndiscussion-Response( + pki_ezsigndiscussion_id = 194, + fki_ezsignpage_id = 64, + fki_discussion_id = 125, + i_ezsigndiscussion_x = 57208, + i_ezsigndiscussion_y = 57652, + i_ezsigndiscussion_pagenumber = 4, + obj_discussion = eZmaxApi.models.discussion_response_compound.discussion-ResponseCompound(), ) + ], + ) + """ + + def testEzsigndocumentGetEzsigndiscussionsV1ResponseMPayload(self): + """Test EzsigndocumentGetEzsigndiscussionsV1ResponseMPayload""" + # 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_list_v1_response_m_payload.py b/test/test_ezsignfolder_get_list_v1_response_m_payload.py index a15a6a235..fc3c2e92c 100644 --- a/test/test_ezsignfolder_get_list_v1_response_m_payload.py +++ b/test/test_ezsignfolder_get_list_v1_response_m_payload.py @@ -48,6 +48,7 @@ def make_instance(self, include_optional) -> EzsignfolderGetListV1ResponseMPaylo s_ezsignfolder_description = 'Test eZsign Folder', e_ezsignfolder_step = 'Completed', dt_created_date = '2020-12-31 23:59:59', + dt_ezsignfolder_delayedsenddate = '2020-12-31T23:59:59.000Z', dt_ezsignfolder_sentdate = '2020-12-31T23:59:59.000Z', dt_ezsignfolder_duedate = '2020-12-31 23:59:59', i_ezsigndocument = 56, @@ -69,6 +70,7 @@ def make_instance(self, include_optional) -> EzsignfolderGetListV1ResponseMPaylo s_ezsignfolder_description = 'Test eZsign Folder', e_ezsignfolder_step = 'Completed', dt_created_date = '2020-12-31 23:59:59', + dt_ezsignfolder_delayedsenddate = '2020-12-31T23:59:59.000Z', dt_ezsignfolder_sentdate = '2020-12-31T23:59:59.000Z', dt_ezsignfolder_duedate = '2020-12-31 23:59:59', i_ezsigndocument = 56, 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 26cc13bad..e54ccfc97 100644 --- a/test/test_ezsignfolder_get_object_v1_response_m_payload.py +++ b/test/test_ezsignfolder_get_object_v1_response_m_payload.py @@ -40,6 +40,7 @@ def make_instance(self, include_optional) -> EzsignfolderGetObjectV1ResponseMPay pki_ezsignfolder_id = 33, fki_ezsignfoldertype_id = 5, obj_ezsignfoldertype = eZmaxApi.models.custom_ezsignfoldertype_response.Custom-Ezsignfoldertype-Response(), + e_ezsignfolder_completion = 'PerEzsigndocument', s_ezsignfoldertype_name_x = '', fki_billingentityinternal_id = 1, s_billingentityinternal_description_x = 'Default', diff --git a/test/test_ezsignfolder_list_element.py b/test/test_ezsignfolder_list_element.py index e2832a53b..7d2add28a 100644 --- a/test/test_ezsignfolder_list_element.py +++ b/test/test_ezsignfolder_list_element.py @@ -44,6 +44,7 @@ def make_instance(self, include_optional) -> EzsignfolderListElement: s_ezsignfolder_description = 'Test eZsign Folder', e_ezsignfolder_step = 'Completed', dt_created_date = '2020-12-31 23:59:59', + dt_ezsignfolder_delayedsenddate = '2020-12-31T23:59:59.000Z', dt_ezsignfolder_sentdate = '2020-12-31T23:59:59.000Z', dt_ezsignfolder_duedate = '2020-12-31 23:59:59', i_ezsigndocument = 56, diff --git a/test/test_ezsignfolder_response.py b/test/test_ezsignfolder_response.py index 7afcf842a..83e3d3449 100644 --- a/test/test_ezsignfolder_response.py +++ b/test/test_ezsignfolder_response.py @@ -40,6 +40,7 @@ def make_instance(self, include_optional) -> EzsignfolderResponse: pki_ezsignfolder_id = 33, fki_ezsignfoldertype_id = 5, obj_ezsignfoldertype = eZmaxApi.models.custom_ezsignfoldertype_response.Custom-Ezsignfoldertype-Response(), + e_ezsignfolder_completion = 'PerEzsigndocument', s_ezsignfoldertype_name_x = '', fki_billingentityinternal_id = 1, s_billingentityinternal_description_x = 'Default', diff --git a/test/test_ezsignfolder_response_compound.py b/test/test_ezsignfolder_response_compound.py index bb03e5611..6dfa687ee 100644 --- a/test/test_ezsignfolder_response_compound.py +++ b/test/test_ezsignfolder_response_compound.py @@ -40,6 +40,7 @@ def make_instance(self, include_optional) -> EzsignfolderResponseCompound: pki_ezsignfolder_id = 33, fki_ezsignfoldertype_id = 5, obj_ezsignfoldertype = eZmaxApi.models.custom_ezsignfoldertype_response.Custom-Ezsignfoldertype-Response(), + e_ezsignfolder_completion = 'PerEzsigndocument', s_ezsignfoldertype_name_x = '', fki_billingentityinternal_id = 1, s_billingentityinternal_description_x = 'Default', diff --git a/test/test_ezsignfoldertype_request.py b/test/test_ezsignfoldertype_request.py index ce21662bd..b81808aee 100644 --- a/test/test_ezsignfoldertype_request.py +++ b/test/test_ezsignfoldertype_request.py @@ -52,10 +52,13 @@ def make_instance(self, include_optional) -> EzsignfoldertypeRequest: e_ezsignfoldertype_sendreminderfrequency = 'None', i_ezsignfoldertype_archivaldays = 30, e_ezsignfoldertype_disposal = 'Manual', + e_ezsignfoldertype_completion = 'PerEzsigndocument', i_ezsignfoldertype_disposaldays = 365, i_ezsignfoldertype_deadlinedays = 5, b_ezsignfoldertype_delegate = True, b_ezsignfoldertype_reassign = True, + b_ezsignfoldertype_reassignezsignsigner = True, + b_ezsignfoldertype_reassignuser = True, b_ezsignfoldertype_sendattatchmentsigner = False, b_ezsignfoldertype_sendsignedtoezsignsigner = False, b_ezsignfoldertype_sendsignedtouser = False, diff --git a/test/test_ezsignfoldertype_request_compound.py b/test/test_ezsignfoldertype_request_compound.py index e26993bfd..d3e9b29af 100644 --- a/test/test_ezsignfoldertype_request_compound.py +++ b/test/test_ezsignfoldertype_request_compound.py @@ -52,10 +52,13 @@ def make_instance(self, include_optional) -> EzsignfoldertypeRequestCompound: e_ezsignfoldertype_sendreminderfrequency = 'None', i_ezsignfoldertype_archivaldays = 30, e_ezsignfoldertype_disposal = 'Manual', + e_ezsignfoldertype_completion = 'PerEzsigndocument', i_ezsignfoldertype_disposaldays = 365, i_ezsignfoldertype_deadlinedays = 5, b_ezsignfoldertype_delegate = True, b_ezsignfoldertype_reassign = True, + b_ezsignfoldertype_reassignezsignsigner = True, + b_ezsignfoldertype_reassignuser = True, b_ezsignfoldertype_sendattatchmentsigner = False, b_ezsignfoldertype_sendsignedtoezsignsigner = False, b_ezsignfoldertype_sendsignedtouser = False, diff --git a/test/test_ezsignfoldertype_response.py b/test/test_ezsignfoldertype_response.py index 7d4a666b2..89fe7b87f 100644 --- a/test/test_ezsignfoldertype_response.py +++ b/test/test_ezsignfoldertype_response.py @@ -57,10 +57,13 @@ def make_instance(self, include_optional) -> EzsignfoldertypeResponse: e_ezsignfoldertype_sendreminderfrequency = 'None', i_ezsignfoldertype_archivaldays = 30, e_ezsignfoldertype_disposal = 'Manual', + e_ezsignfoldertype_completion = 'PerEzsigndocument', i_ezsignfoldertype_disposaldays = 365, i_ezsignfoldertype_deadlinedays = 5, b_ezsignfoldertype_delegate = True, b_ezsignfoldertype_reassign = True, + b_ezsignfoldertype_reassignezsignsigner = True, + b_ezsignfoldertype_reassignuser = True, b_ezsignfoldertype_sendattatchmentsigner = False, b_ezsignfoldertype_sendsignedtoezsignsigner = False, b_ezsignfoldertype_sendsignedtouser = False, diff --git a/test/test_ezsignfoldertype_response_compound.py b/test/test_ezsignfoldertype_response_compound.py index f086dd9be..e7cf29edf 100644 --- a/test/test_ezsignfoldertype_response_compound.py +++ b/test/test_ezsignfoldertype_response_compound.py @@ -57,10 +57,13 @@ def make_instance(self, include_optional) -> EzsignfoldertypeResponseCompound: e_ezsignfoldertype_sendreminderfrequency = 'None', i_ezsignfoldertype_archivaldays = 30, e_ezsignfoldertype_disposal = 'Manual', + e_ezsignfoldertype_completion = 'PerEzsigndocument', i_ezsignfoldertype_disposaldays = 365, i_ezsignfoldertype_deadlinedays = 5, b_ezsignfoldertype_delegate = True, b_ezsignfoldertype_reassign = True, + b_ezsignfoldertype_reassignezsignsigner = True, + b_ezsignfoldertype_reassignuser = True, b_ezsignfoldertype_sendattatchmentsigner = False, b_ezsignfoldertype_sendsignedtoezsignsigner = False, b_ezsignfoldertype_sendsignedtouser = False, diff --git a/test/test_ezsignsignature_response.py b/test/test_ezsignsignature_response.py index b942329c2..20fea57ad 100644 --- a/test/test_ezsignsignature_response.py +++ b/test/test_ezsignsignature_response.py @@ -48,6 +48,7 @@ def make_instance(self, include_optional) -> EzsignsignatureResponse: i_ezsignsignature_height = 200, i_ezsignsignature_width = 200, i_ezsignsignature_step = 1, + i_ezsignsignature_stepadjusted = 1, e_ezsignsignature_type = 'Name', t_ezsignsignature_tooltip = 'Please sign here if you agree to the terms', e_ezsignsignature_tooltipposition = 'TopLeft', diff --git a/test/test_ezsignsignature_response_compound.py b/test/test_ezsignsignature_response_compound.py index 2cca08742..f3eecfaa6 100644 --- a/test/test_ezsignsignature_response_compound.py +++ b/test/test_ezsignsignature_response_compound.py @@ -48,6 +48,7 @@ def make_instance(self, include_optional) -> EzsignsignatureResponseCompound: i_ezsignsignature_height = 200, i_ezsignsignature_width = 200, i_ezsignsignature_step = 1, + i_ezsignsignature_stepadjusted = 1, e_ezsignsignature_type = 'Name', t_ezsignsignature_tooltip = 'Please sign here if you agree to the terms', e_ezsignsignature_tooltipposition = 'TopLeft', diff --git a/test/test_ezsigntemplateformfield_request.py b/test/test_ezsigntemplateformfield_request.py index fd9548631..cde8cc37c 100644 --- a/test/test_ezsigntemplateformfield_request.py +++ b/test/test_ezsigntemplateformfield_request.py @@ -38,6 +38,7 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldRequest: if include_optional: return EzsigntemplateformfieldRequest( pki_ezsigntemplateformfield_id = 71, + e_ezsigntemplateformfield_positioning = 'PerCoordinates', i_ezsigntemplatedocumentpage_pagenumber = 1, s_ezsigntemplateformfield_label = 'Peanuts', s_ezsigntemplateformfield_value = 'Yes', @@ -47,14 +48,16 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldRequest: i_ezsigntemplateformfield_height = 22, b_ezsigntemplateformfield_autocomplete = True, b_ezsigntemplateformfield_selected = True, - e_ezsigntemplateformfield_dependencyrequirement = 'AllOf' + e_ezsigntemplateformfield_dependencyrequirement = 'AllOf', + s_ezsigntemplateformfield_positioningpattern = 'Signature', + i_ezsigntemplateformfield_positioningoffsetx = 200, + i_ezsigntemplateformfield_positioningoffsety = 200, + e_ezsigntemplateformfield_positioningoccurence = 'All' ) else: return EzsigntemplateformfieldRequest( i_ezsigntemplatedocumentpage_pagenumber = 1, s_ezsigntemplateformfield_label = 'Peanuts', - i_ezsigntemplateformfield_x = 200, - i_ezsigntemplateformfield_y = 300, i_ezsigntemplateformfield_width = 102, i_ezsigntemplateformfield_height = 22, ) diff --git a/test/test_ezsigntemplateformfield_request_compound.py b/test/test_ezsigntemplateformfield_request_compound.py index 32ecee042..fbf7deae1 100644 --- a/test/test_ezsigntemplateformfield_request_compound.py +++ b/test/test_ezsigntemplateformfield_request_compound.py @@ -38,6 +38,7 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldRequestCompo if include_optional: return EzsigntemplateformfieldRequestCompound( pki_ezsigntemplateformfield_id = 71, + e_ezsigntemplateformfield_positioning = 'PerCoordinates', i_ezsigntemplatedocumentpage_pagenumber = 1, s_ezsigntemplateformfield_label = 'Peanuts', s_ezsigntemplateformfield_value = 'Yes', @@ -48,6 +49,10 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldRequestCompo b_ezsigntemplateformfield_autocomplete = True, b_ezsigntemplateformfield_selected = True, e_ezsigntemplateformfield_dependencyrequirement = 'AllOf', + s_ezsigntemplateformfield_positioningpattern = 'Signature', + i_ezsigntemplateformfield_positioningoffsetx = 200, + i_ezsigntemplateformfield_positioningoffsety = 200, + e_ezsigntemplateformfield_positioningoccurence = 'All', a_obj_ezsigntemplateelementdependency = [ eZmaxApi.models.ezsigntemplateelementdependency_request_compound.ezsigntemplateelementdependency-RequestCompound() ] @@ -56,8 +61,6 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldRequestCompo return EzsigntemplateformfieldRequestCompound( i_ezsigntemplatedocumentpage_pagenumber = 1, s_ezsigntemplateformfield_label = 'Peanuts', - i_ezsigntemplateformfield_x = 200, - i_ezsigntemplateformfield_y = 300, i_ezsigntemplateformfield_width = 102, i_ezsigntemplateformfield_height = 22, ) diff --git a/test/test_ezsigntemplateformfield_response.py b/test/test_ezsigntemplateformfield_response.py index fb76100ab..d47cfb517 100644 --- a/test/test_ezsigntemplateformfield_response.py +++ b/test/test_ezsigntemplateformfield_response.py @@ -38,6 +38,7 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldResponse: if include_optional: return EzsigntemplateformfieldResponse( pki_ezsigntemplateformfield_id = 71, + e_ezsigntemplateformfield_positioning = 'PerCoordinates', i_ezsigntemplatedocumentpage_pagenumber = 1, s_ezsigntemplateformfield_label = 'Peanuts', s_ezsigntemplateformfield_value = 'Yes', @@ -47,15 +48,17 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldResponse: i_ezsigntemplateformfield_height = 22, b_ezsigntemplateformfield_autocomplete = True, b_ezsigntemplateformfield_selected = True, - e_ezsigntemplateformfield_dependencyrequirement = 'AllOf' + e_ezsigntemplateformfield_dependencyrequirement = 'AllOf', + s_ezsigntemplateformfield_positioningpattern = 'Signature', + i_ezsigntemplateformfield_positioningoffsetx = 200, + i_ezsigntemplateformfield_positioningoffsety = 200, + e_ezsigntemplateformfield_positioningoccurence = 'All' ) else: return EzsigntemplateformfieldResponse( pki_ezsigntemplateformfield_id = 71, i_ezsigntemplatedocumentpage_pagenumber = 1, s_ezsigntemplateformfield_label = 'Peanuts', - i_ezsigntemplateformfield_x = 200, - i_ezsigntemplateformfield_y = 300, i_ezsigntemplateformfield_width = 102, i_ezsigntemplateformfield_height = 22, ) diff --git a/test/test_ezsigntemplateformfield_response_compound.py b/test/test_ezsigntemplateformfield_response_compound.py index d4175ccfb..1ae05a9de 100644 --- a/test/test_ezsigntemplateformfield_response_compound.py +++ b/test/test_ezsigntemplateformfield_response_compound.py @@ -38,6 +38,7 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldResponseComp if include_optional: return EzsigntemplateformfieldResponseCompound( pki_ezsigntemplateformfield_id = 71, + e_ezsigntemplateformfield_positioning = 'PerCoordinates', i_ezsigntemplatedocumentpage_pagenumber = 1, s_ezsigntemplateformfield_label = 'Peanuts', s_ezsigntemplateformfield_value = 'Yes', @@ -48,6 +49,10 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldResponseComp b_ezsigntemplateformfield_autocomplete = True, b_ezsigntemplateformfield_selected = True, e_ezsigntemplateformfield_dependencyrequirement = 'AllOf', + s_ezsigntemplateformfield_positioningpattern = 'Signature', + i_ezsigntemplateformfield_positioningoffsetx = 200, + i_ezsigntemplateformfield_positioningoffsety = 200, + e_ezsigntemplateformfield_positioningoccurence = 'All', a_obj_ezsigntemplateelementdependency = [ eZmaxApi.models.ezsigntemplateelementdependency_response_compound.ezsigntemplateelementdependency-ResponseCompound() ] @@ -57,8 +62,6 @@ def make_instance(self, include_optional) -> EzsigntemplateformfieldResponseComp pki_ezsigntemplateformfield_id = 71, i_ezsigntemplatedocumentpage_pagenumber = 1, s_ezsigntemplateformfield_label = 'Peanuts', - i_ezsigntemplateformfield_x = 200, - i_ezsigntemplateformfield_y = 300, i_ezsigntemplateformfield_width = 102, i_ezsigntemplateformfield_height = 22, ) diff --git a/test/test_ezsigntemplatesignature_request.py b/test/test_ezsigntemplatesignature_request.py index bc5454232..8603430fe 100644 --- a/test/test_ezsigntemplatesignature_request.py +++ b/test/test_ezsigntemplatesignature_request.py @@ -41,6 +41,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignatureRequest: fki_ezsigntemplatedocument_id = 133, fki_ezsigntemplatesigner_id = 9, fki_ezsigntemplatesigner_id_validation = 9, + e_ezsigntemplatesignature_positioning = 'PerCoordinates', i_ezsigntemplatedocumentpage_pagenumber = 1, i_ezsigntemplatesignature_x = 200, i_ezsigntemplatesignature_y = 300, @@ -58,15 +59,17 @@ def make_instance(self, include_optional) -> EzsigntemplatesignatureRequest: i_ezsigntemplatesignature_maxlength = 75, s_ezsigntemplatesignature_regexp = '/[-0-9a-zA-Z.+_]+@[-0-9a-zA-Z.+_]+.[a-zA-Z]{2,4}/', e_ezsigntemplatesignature_textvalidation = 'None', - e_ezsigntemplatesignature_dependencyrequirement = 'AllOf' + e_ezsigntemplatesignature_dependencyrequirement = 'AllOf', + s_ezsigntemplatesignature_positioningpattern = 'Signature', + i_ezsigntemplatesignature_positioningoffsetx = 200, + i_ezsigntemplatesignature_positioningoffsety = 200, + e_ezsigntemplatesignature_positioningoccurence = 'All' ) else: return EzsigntemplatesignatureRequest( fki_ezsigntemplatedocument_id = 133, fki_ezsigntemplatesigner_id = 9, i_ezsigntemplatedocumentpage_pagenumber = 1, - i_ezsigntemplatesignature_x = 200, - i_ezsigntemplatesignature_y = 300, i_ezsigntemplatesignature_step = 1, e_ezsigntemplatesignature_type = 'Name', ) diff --git a/test/test_ezsigntemplatesignature_request_compound.py b/test/test_ezsigntemplatesignature_request_compound.py index 016320d98..4ab0c8aec 100644 --- a/test/test_ezsigntemplatesignature_request_compound.py +++ b/test/test_ezsigntemplatesignature_request_compound.py @@ -41,6 +41,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignatureRequestCompo fki_ezsigntemplatedocument_id = 133, fki_ezsigntemplatesigner_id = 9, fki_ezsigntemplatesigner_id_validation = 9, + e_ezsigntemplatesignature_positioning = 'PerCoordinates', i_ezsigntemplatedocumentpage_pagenumber = 1, i_ezsigntemplatesignature_x = 200, i_ezsigntemplatesignature_y = 300, @@ -59,6 +60,10 @@ def make_instance(self, include_optional) -> EzsigntemplatesignatureRequestCompo s_ezsigntemplatesignature_regexp = '/[-0-9a-zA-Z.+_]+@[-0-9a-zA-Z.+_]+.[a-zA-Z]{2,4}/', e_ezsigntemplatesignature_textvalidation = 'None', e_ezsigntemplatesignature_dependencyrequirement = 'AllOf', + s_ezsigntemplatesignature_positioningpattern = 'Signature', + i_ezsigntemplatesignature_positioningoffsetx = 200, + i_ezsigntemplatesignature_positioningoffsety = 200, + e_ezsigntemplatesignature_positioningoccurence = 'All', b_ezsigntemplatesignature_customdate = True, a_obj_ezsigntemplatesignaturecustomdate = [ eZmaxApi.models.ezsigntemplatesignaturecustomdate_request_compound.ezsigntemplatesignaturecustomdate-RequestCompound() @@ -72,8 +77,6 @@ def make_instance(self, include_optional) -> EzsigntemplatesignatureRequestCompo fki_ezsigntemplatedocument_id = 133, fki_ezsigntemplatesigner_id = 9, i_ezsigntemplatedocumentpage_pagenumber = 1, - i_ezsigntemplatesignature_x = 200, - i_ezsigntemplatesignature_y = 300, i_ezsigntemplatesignature_step = 1, e_ezsigntemplatesignature_type = 'Name', ) diff --git a/test/test_ezsigntemplatesignature_response.py b/test/test_ezsigntemplatesignature_response.py index e07f41b13..48e4f0ece 100644 --- a/test/test_ezsigntemplatesignature_response.py +++ b/test/test_ezsigntemplatesignature_response.py @@ -41,6 +41,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignatureResponse: fki_ezsigntemplatedocument_id = 133, fki_ezsigntemplatesigner_id = 9, fki_ezsigntemplatesigner_id_validation = 9, + e_ezsigntemplatesignature_positioning = 'PerCoordinates', i_ezsigntemplatedocumentpage_pagenumber = 1, i_ezsigntemplatesignature_x = 200, i_ezsigntemplatesignature_y = 300, @@ -58,7 +59,11 @@ def make_instance(self, include_optional) -> EzsigntemplatesignatureResponse: i_ezsigntemplatesignature_maxlength = 75, s_ezsigntemplatesignature_regexp = '/[-0-9a-zA-Z.+_]+@[-0-9a-zA-Z.+_]+.[a-zA-Z]{2,4}/', e_ezsigntemplatesignature_textvalidation = 'None', - e_ezsigntemplatesignature_dependencyrequirement = 'AllOf' + e_ezsigntemplatesignature_dependencyrequirement = 'AllOf', + s_ezsigntemplatesignature_positioningpattern = 'Signature', + i_ezsigntemplatesignature_positioningoffsetx = 200, + i_ezsigntemplatesignature_positioningoffsety = 200, + e_ezsigntemplatesignature_positioningoccurence = 'All' ) else: return EzsigntemplatesignatureResponse( @@ -66,8 +71,6 @@ def make_instance(self, include_optional) -> EzsigntemplatesignatureResponse: fki_ezsigntemplatedocument_id = 133, fki_ezsigntemplatesigner_id = 9, i_ezsigntemplatedocumentpage_pagenumber = 1, - i_ezsigntemplatesignature_x = 200, - i_ezsigntemplatesignature_y = 300, i_ezsigntemplatesignature_step = 1, e_ezsigntemplatesignature_type = 'Name', ) diff --git a/test/test_ezsigntemplatesignature_response_compound.py b/test/test_ezsigntemplatesignature_response_compound.py index 4316f044f..925322eac 100644 --- a/test/test_ezsigntemplatesignature_response_compound.py +++ b/test/test_ezsigntemplatesignature_response_compound.py @@ -41,6 +41,7 @@ def make_instance(self, include_optional) -> EzsigntemplatesignatureResponseComp fki_ezsigntemplatedocument_id = 133, fki_ezsigntemplatesigner_id = 9, fki_ezsigntemplatesigner_id_validation = 9, + e_ezsigntemplatesignature_positioning = 'PerCoordinates', i_ezsigntemplatedocumentpage_pagenumber = 1, i_ezsigntemplatesignature_x = 200, i_ezsigntemplatesignature_y = 300, @@ -59,6 +60,10 @@ def make_instance(self, include_optional) -> EzsigntemplatesignatureResponseComp s_ezsigntemplatesignature_regexp = '/[-0-9a-zA-Z.+_]+@[-0-9a-zA-Z.+_]+.[a-zA-Z]{2,4}/', e_ezsigntemplatesignature_textvalidation = 'None', e_ezsigntemplatesignature_dependencyrequirement = 'AllOf', + s_ezsigntemplatesignature_positioningpattern = 'Signature', + i_ezsigntemplatesignature_positioningoffsetx = 200, + i_ezsigntemplatesignature_positioningoffsety = 200, + e_ezsigntemplatesignature_positioningoccurence = 'All', b_ezsigntemplatesignature_customdate = True, a_obj_ezsigntemplatesignaturecustomdate = [ eZmaxApi.models.ezsigntemplatesignaturecustomdate_response_compound.ezsigntemplatesignaturecustomdate-ResponseCompound() @@ -73,8 +78,6 @@ def make_instance(self, include_optional) -> EzsigntemplatesignatureResponseComp fki_ezsigntemplatedocument_id = 133, fki_ezsigntemplatesigner_id = 9, i_ezsigntemplatedocumentpage_pagenumber = 1, - i_ezsigntemplatesignature_x = 200, - i_ezsigntemplatesignature_y = 300, i_ezsigntemplatesignature_step = 1, e_ezsigntemplatesignature_type = 'Name', ) diff --git a/test/test_ezsigntemplatesignaturecustomdate_request.py b/test/test_ezsigntemplatesignaturecustomdate_request.py index dadf782ba..e0f3c47da 100644 --- a/test/test_ezsigntemplatesignaturecustomdate_request.py +++ b/test/test_ezsigntemplatesignaturecustomdate_request.py @@ -40,12 +40,12 @@ def make_instance(self, include_optional) -> EzsigntemplatesignaturecustomdateRe pki_ezsigntemplatesignaturecustomdate_id = 58, i_ezsigntemplatesignaturecustomdate_x = 200, i_ezsigntemplatesignaturecustomdate_y = 300, + i_ezsigntemplatesignaturecustomdate_offsetx = 200, + i_ezsigntemplatesignaturecustomdate_offsety = 200, s_ezsigntemplatesignaturecustomdate_format = 'Signature date: {YYYY}/{MM}/{DD} {hh}:{mm}{ss} {Z}' ) else: return EzsigntemplatesignaturecustomdateRequest( - i_ezsigntemplatesignaturecustomdate_x = 200, - i_ezsigntemplatesignaturecustomdate_y = 300, s_ezsigntemplatesignaturecustomdate_format = 'Signature date: {YYYY}/{MM}/{DD} {hh}:{mm}{ss} {Z}', ) """ diff --git a/test/test_ezsigntemplatesignaturecustomdate_request_compound.py b/test/test_ezsigntemplatesignaturecustomdate_request_compound.py index a25d51f23..d629e81bd 100644 --- a/test/test_ezsigntemplatesignaturecustomdate_request_compound.py +++ b/test/test_ezsigntemplatesignaturecustomdate_request_compound.py @@ -40,12 +40,12 @@ def make_instance(self, include_optional) -> EzsigntemplatesignaturecustomdateRe pki_ezsigntemplatesignaturecustomdate_id = 58, i_ezsigntemplatesignaturecustomdate_x = 200, i_ezsigntemplatesignaturecustomdate_y = 300, + i_ezsigntemplatesignaturecustomdate_offsetx = 200, + i_ezsigntemplatesignaturecustomdate_offsety = 200, s_ezsigntemplatesignaturecustomdate_format = 'Signature date: {YYYY}/{MM}/{DD} {hh}:{mm}{ss} {Z}' ) else: return EzsigntemplatesignaturecustomdateRequestCompound( - i_ezsigntemplatesignaturecustomdate_x = 200, - i_ezsigntemplatesignaturecustomdate_y = 300, s_ezsigntemplatesignaturecustomdate_format = 'Signature date: {YYYY}/{MM}/{DD} {hh}:{mm}{ss} {Z}', ) """ diff --git a/test/test_ezsigntemplatesignaturecustomdate_response.py b/test/test_ezsigntemplatesignaturecustomdate_response.py index 860f831ec..1087f84d5 100644 --- a/test/test_ezsigntemplatesignaturecustomdate_response.py +++ b/test/test_ezsigntemplatesignaturecustomdate_response.py @@ -40,13 +40,13 @@ def make_instance(self, include_optional) -> EzsigntemplatesignaturecustomdateRe pki_ezsigntemplatesignaturecustomdate_id = 58, i_ezsigntemplatesignaturecustomdate_x = 200, i_ezsigntemplatesignaturecustomdate_y = 300, + i_ezsigntemplatesignaturecustomdate_offsetx = 200, + i_ezsigntemplatesignaturecustomdate_offsety = 200, s_ezsigntemplatesignaturecustomdate_format = 'Signature date: {YYYY}/{MM}/{DD} {hh}:{mm}{ss} {Z}' ) else: return EzsigntemplatesignaturecustomdateResponse( pki_ezsigntemplatesignaturecustomdate_id = 58, - i_ezsigntemplatesignaturecustomdate_x = 200, - i_ezsigntemplatesignaturecustomdate_y = 300, s_ezsigntemplatesignaturecustomdate_format = 'Signature date: {YYYY}/{MM}/{DD} {hh}:{mm}{ss} {Z}', ) """ diff --git a/test/test_ezsigntemplatesignaturecustomdate_response_compound.py b/test/test_ezsigntemplatesignaturecustomdate_response_compound.py index 302c0423a..be0996bc7 100644 --- a/test/test_ezsigntemplatesignaturecustomdate_response_compound.py +++ b/test/test_ezsigntemplatesignaturecustomdate_response_compound.py @@ -40,13 +40,13 @@ def make_instance(self, include_optional) -> EzsigntemplatesignaturecustomdateRe pki_ezsigntemplatesignaturecustomdate_id = 58, i_ezsigntemplatesignaturecustomdate_x = 200, i_ezsigntemplatesignaturecustomdate_y = 300, + i_ezsigntemplatesignaturecustomdate_offsetx = 200, + i_ezsigntemplatesignaturecustomdate_offsety = 200, s_ezsigntemplatesignaturecustomdate_format = 'Signature date: {YYYY}/{MM}/{DD} {hh}:{mm}{ss} {Z}' ) else: return EzsigntemplatesignaturecustomdateResponseCompound( pki_ezsigntemplatesignaturecustomdate_id = 58, - i_ezsigntemplatesignaturecustomdate_x = 200, - i_ezsigntemplatesignaturecustomdate_y = 300, s_ezsigntemplatesignaturecustomdate_format = 'Signature date: {YYYY}/{MM}/{DD} {hh}:{mm}{ss} {Z}', ) """ diff --git a/test/test_field_e_discussionmessage_status.py b/test/test_field_e_discussionmessage_status.py new file mode 100644 index 000000000..da5f62834 --- /dev/null +++ b/test/test_field_e_discussionmessage_status.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_discussionmessage_status import FieldEDiscussionmessageStatus + +class TestFieldEDiscussionmessageStatus(unittest.TestCase): + """FieldEDiscussionmessageStatus unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFieldEDiscussionmessageStatus(self): + """Test FieldEDiscussionmessageStatus""" + # inst = FieldEDiscussionmessageStatus() + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_field_e_ezsignfolder_completion.py b/test/test_field_e_ezsignfolder_completion.py new file mode 100644 index 000000000..e52a5cf3e --- /dev/null +++ b/test/test_field_e_ezsignfolder_completion.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_ezsignfolder_completion import FieldEEzsignfolderCompletion + +class TestFieldEEzsignfolderCompletion(unittest.TestCase): + """FieldEEzsignfolderCompletion unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFieldEEzsignfolderCompletion(self): + """Test FieldEEzsignfolderCompletion""" + # inst = FieldEEzsignfolderCompletion() + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_field_e_ezsignfoldertype_completion.py b/test/test_field_e_ezsignfoldertype_completion.py new file mode 100644 index 000000000..948c4973a --- /dev/null +++ b/test/test_field_e_ezsignfoldertype_completion.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_ezsignfoldertype_completion import FieldEEzsignfoldertypeCompletion + +class TestFieldEEzsignfoldertypeCompletion(unittest.TestCase): + """FieldEEzsignfoldertypeCompletion unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFieldEEzsignfoldertypeCompletion(self): + """Test FieldEEzsignfoldertypeCompletion""" + # inst = FieldEEzsignfoldertypeCompletion() + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_field_e_ezsigntemplateformfield_positioning.py b/test/test_field_e_ezsigntemplateformfield_positioning.py new file mode 100644 index 000000000..2fa6a0c0e --- /dev/null +++ b/test/test_field_e_ezsigntemplateformfield_positioning.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_ezsigntemplateformfield_positioning import FieldEEzsigntemplateformfieldPositioning + +class TestFieldEEzsigntemplateformfieldPositioning(unittest.TestCase): + """FieldEEzsigntemplateformfieldPositioning unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFieldEEzsigntemplateformfieldPositioning(self): + """Test FieldEEzsigntemplateformfieldPositioning""" + # inst = FieldEEzsigntemplateformfieldPositioning() + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_field_e_ezsigntemplateformfield_positioningoccurence.py b/test/test_field_e_ezsigntemplateformfield_positioningoccurence.py new file mode 100644 index 000000000..de1a5709c --- /dev/null +++ b/test/test_field_e_ezsigntemplateformfield_positioningoccurence.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_ezsigntemplateformfield_positioningoccurence import FieldEEzsigntemplateformfieldPositioningoccurence + +class TestFieldEEzsigntemplateformfieldPositioningoccurence(unittest.TestCase): + """FieldEEzsigntemplateformfieldPositioningoccurence unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFieldEEzsigntemplateformfieldPositioningoccurence(self): + """Test FieldEEzsigntemplateformfieldPositioningoccurence""" + # inst = FieldEEzsigntemplateformfieldPositioningoccurence() + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_field_e_ezsigntemplatesignature_positioning.py b/test/test_field_e_ezsigntemplatesignature_positioning.py new file mode 100644 index 000000000..67f35103e --- /dev/null +++ b/test/test_field_e_ezsigntemplatesignature_positioning.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_ezsigntemplatesignature_positioning import FieldEEzsigntemplatesignaturePositioning + +class TestFieldEEzsigntemplatesignaturePositioning(unittest.TestCase): + """FieldEEzsigntemplatesignaturePositioning unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFieldEEzsigntemplatesignaturePositioning(self): + """Test FieldEEzsigntemplatesignaturePositioning""" + # inst = FieldEEzsigntemplatesignaturePositioning() + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_field_e_ezsigntemplatesignature_positioningoccurence.py b/test/test_field_e_ezsigntemplatesignature_positioningoccurence.py new file mode 100644 index 000000000..bb9a5c86f --- /dev/null +++ b/test/test_field_e_ezsigntemplatesignature_positioningoccurence.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_ezsigntemplatesignature_positioningoccurence import FieldEEzsigntemplatesignaturePositioningoccurence + +class TestFieldEEzsigntemplatesignaturePositioningoccurence(unittest.TestCase): + """FieldEEzsigntemplatesignaturePositioningoccurence unit test stubs""" + + def setUp(self): + pass + + def tearDown(self): + pass + + def testFieldEEzsigntemplatesignaturePositioningoccurence(self): + """Test FieldEEzsigntemplatesignaturePositioningoccurence""" + # inst = FieldEEzsigntemplatesignaturePositioningoccurence() + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_object_discussion_api.py b/test/test_object_discussion_api.py new file mode 100644 index 000000000..a5c71f18f --- /dev/null +++ b/test/test_object_discussion_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_discussion_api import ObjectDiscussionApi + + +class TestObjectDiscussionApi(unittest.TestCase): + """ObjectDiscussionApi unit test stubs""" + + def setUp(self) -> None: + self.api = ObjectDiscussionApi() + + def tearDown(self) -> None: + pass + + def test_discussion_create_object_v1(self) -> None: + """Test case for discussion_create_object_v1 + + Create a new Discussion + """ + pass + + def test_discussion_delete_object_v1(self) -> None: + """Test case for discussion_delete_object_v1 + + Delete an existing Discussion + """ + pass + + def test_discussion_get_object_v2(self) -> None: + """Test case for discussion_get_object_v2 + + Retrieve an existing Discussion + """ + pass + + def test_discussion_patch_object_v1(self) -> None: + """Test case for discussion_patch_object_v1 + + Patch an existing Discussion + """ + pass + + def test_discussion_update_discussionreadstatus_v1(self) -> None: + """Test case for discussion_update_discussionreadstatus_v1 + + Update the read status of the discussion + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_object_discussionmembership_api.py b/test/test_object_discussionmembership_api.py new file mode 100644 index 000000000..28403d636 --- /dev/null +++ b/test/test_object_discussionmembership_api.py @@ -0,0 +1,46 @@ +# 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_discussionmembership_api import ObjectDiscussionmembershipApi + + +class TestObjectDiscussionmembershipApi(unittest.TestCase): + """ObjectDiscussionmembershipApi unit test stubs""" + + def setUp(self) -> None: + self.api = ObjectDiscussionmembershipApi() + + def tearDown(self) -> None: + pass + + def test_discussionmembership_create_object_v1(self) -> None: + """Test case for discussionmembership_create_object_v1 + + Create a new Discussionmembership + """ + pass + + def test_discussionmembership_delete_object_v1(self) -> None: + """Test case for discussionmembership_delete_object_v1 + + Delete an existing Discussionmembership + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_object_discussionmessage_api.py b/test/test_object_discussionmessage_api.py new file mode 100644 index 000000000..2a12b99f9 --- /dev/null +++ b/test/test_object_discussionmessage_api.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 + +from eZmaxApi.api.object_discussionmessage_api import ObjectDiscussionmessageApi + + +class TestObjectDiscussionmessageApi(unittest.TestCase): + """ObjectDiscussionmessageApi unit test stubs""" + + def setUp(self) -> None: + self.api = ObjectDiscussionmessageApi() + + def tearDown(self) -> None: + pass + + def test_discussionmessage_create_object_v1(self) -> None: + """Test case for discussionmessage_create_object_v1 + + Create a new Discussionmessage + """ + pass + + def test_discussionmessage_delete_object_v1(self) -> None: + """Test case for discussionmessage_delete_object_v1 + + Delete an existing Discussionmessage + """ + pass + + def test_discussionmessage_patch_object_v1(self) -> None: + """Test case for discussionmessage_patch_object_v1 + + Patch an existing Discussionmessage + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_object_ezsigndiscussion_api.py b/test/test_object_ezsigndiscussion_api.py new file mode 100644 index 000000000..9c80fa5da --- /dev/null +++ b/test/test_object_ezsigndiscussion_api.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 + +from eZmaxApi.api.object_ezsigndiscussion_api import ObjectEzsigndiscussionApi + + +class TestObjectEzsigndiscussionApi(unittest.TestCase): + """ObjectEzsigndiscussionApi unit test stubs""" + + def setUp(self) -> None: + self.api = ObjectEzsigndiscussionApi() + + def tearDown(self) -> None: + pass + + def test_ezsigndiscussion_create_object_v1(self) -> None: + """Test case for ezsigndiscussion_create_object_v1 + + Create a new Ezsigndiscussion + """ + pass + + def test_ezsigndiscussion_delete_object_v1(self) -> None: + """Test case for ezsigndiscussion_delete_object_v1 + + Delete an existing Ezsigndiscussion + """ + pass + + def test_ezsigndiscussion_get_object_v2(self) -> None: + """Test case for ezsigndiscussion_get_object_v2 + + Retrieve an existing Ezsigndiscussion + """ + pass + + +if __name__ == '__main__': + unittest.main() diff --git a/test/test_object_ezsigndocument_api.py b/test/test_object_ezsigndocument_api.py index 80f77702c..500be325d 100644 --- a/test/test_object_ezsigndocument_api.py +++ b/test/test_object_ezsigndocument_api.py @@ -41,6 +41,13 @@ def test_ezsigndocument_apply_ezsigntemplate_v2(self) -> None: """ pass + def test_ezsigndocument_create_ezsignelements_positioned_by_word_v1(self) -> None: + """Test case for ezsigndocument_create_ezsignelements_positioned_by_word_v1 + + Create multiple Ezsignsignatures/Ezsignformfieldgroups + """ + pass + def test_ezsigndocument_create_object_v1(self) -> None: """Test case for ezsigndocument_create_object_v1 @@ -132,6 +139,13 @@ def test_ezsigndocument_get_ezsignannotations_v1(self) -> None: """ pass + def test_ezsigndocument_get_ezsigndiscussions_v1(self) -> None: + """Test case for ezsigndocument_get_ezsigndiscussions_v1 + + Retrieve an existing Ezsigndocument's Ezsigndiscussions + """ + pass + def test_ezsigndocument_get_ezsignformfieldgroups_v1(self) -> None: """Test case for ezsigndocument_get_ezsignformfieldgroups_v1 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 f5866af38..1899d10eb 100644 --- a/test/test_user_get_list_v1_response_m_payload.py +++ b/test/test_user_get_list_v1_response_m_payload.py @@ -50,7 +50,8 @@ def make_instance(self, include_optional) -> UserGetListV1ResponseMPayload: e_user_origin = 'BuiltIn', e_user_ezsignaccess = 'PaidByOffice', dt_user_ezsignprepaidexpiration = '2020-12-31', - s_email_address = 'email@example.com', ) + s_email_address = 'email@example.com', + s_user_jobtitle = 'Sales Representative', ) ] ) else: @@ -68,7 +69,8 @@ def make_instance(self, include_optional) -> UserGetListV1ResponseMPayload: e_user_origin = 'BuiltIn', e_user_ezsignaccess = 'PaidByOffice', dt_user_ezsignprepaidexpiration = '2020-12-31', - s_email_address = 'email@example.com', ) + s_email_address = 'email@example.com', + s_user_jobtitle = 'Sales Representative', ) ], ) """ diff --git a/test/test_user_list_element.py b/test/test_user_list_element.py index 69e41e21d..87daef4d5 100644 --- a/test/test_user_list_element.py +++ b/test/test_user_list_element.py @@ -46,7 +46,8 @@ def make_instance(self, include_optional) -> UserListElement: e_user_origin = 'BuiltIn', e_user_ezsignaccess = 'PaidByOffice', dt_user_ezsignprepaidexpiration = '2020-12-31', - s_email_address = 'email@example.com' + s_email_address = 'email@example.com', + s_user_jobtitle = 'Sales Representative' ) else: return UserListElement( diff --git a/test/test_user_request.py b/test/test_user_request.py index 8dfd59a57..3418e157b 100644 --- a/test/test_user_request.py +++ b/test/test_user_request.py @@ -58,6 +58,7 @@ def make_instance(self, include_optional) -> UserRequest: s_user_firstname = 'John', s_user_lastname = 'Doe', s_user_loginname = 'JohnDoe', + s_user_jobtitle = 'Sales Representative', e_user_ezsignaccess = 'PaidByOffice', b_user_isactive = True, b_user_validatebyadministration = False, diff --git a/test/test_user_request_compound.py b/test/test_user_request_compound.py index d46684e7d..7ae27ef4e 100644 --- a/test/test_user_request_compound.py +++ b/test/test_user_request_compound.py @@ -58,6 +58,7 @@ def make_instance(self, include_optional) -> UserRequestCompound: s_user_firstname = 'John', s_user_lastname = 'Doe', s_user_loginname = 'JohnDoe', + s_user_jobtitle = 'Sales Representative', e_user_ezsignaccess = 'PaidByOffice', b_user_isactive = True, b_user_validatebyadministration = False, diff --git a/test/test_user_response.py b/test/test_user_response.py index a2adeb7ac..72fa2c4c7 100644 --- a/test/test_user_response.py +++ b/test/test_user_response.py @@ -64,6 +64,7 @@ def make_instance(self, include_optional) -> UserResponse: s_user_firstname = 'John', s_user_lastname = 'Doe', s_user_loginname = 'JohnDoe', + s_user_jobtitle = 'Sales Representative', e_user_ezsignaccess = 'PaidByOffice', dt_user_lastlogondate = '2020-12-31 23:59:59', dt_user_passwordchanged = '2020-12-31 23:59:59', diff --git a/test/test_user_response_compound.py b/test/test_user_response_compound.py index 1150cddc6..9fa68746f 100644 --- a/test/test_user_response_compound.py +++ b/test/test_user_response_compound.py @@ -64,6 +64,7 @@ def make_instance(self, include_optional) -> UserResponseCompound: s_user_firstname = 'John', s_user_lastname = 'Doe', s_user_loginname = 'JohnDoe', + s_user_jobtitle = 'Sales Representative', e_user_ezsignaccess = 'PaidByOffice', dt_user_lastlogondate = '2020-12-31 23:59:59', dt_user_passwordchanged = '2020-12-31 23:59:59', diff --git a/test/test_webhook_ezsign_ezsignsigner_acceptclause.py b/test/test_webhook_ezsign_ezsignsigner_acceptclause.py index c2202a0a1..5c77b3390 100644 --- a/test/test_webhook_ezsign_ezsignsigner_acceptclause.py +++ b/test/test_webhook_ezsign_ezsignsigner_acceptclause.py @@ -45,6 +45,7 @@ def make_instance(self, include_optional) -> WebhookEzsignEzsignsignerAcceptclau pki_ezsignfolder_id = 33, fki_ezsignfoldertype_id = 5, obj_ezsignfoldertype = eZmaxApi.models.custom_ezsignfoldertype_response.Custom-Ezsignfoldertype-Response(), + e_ezsignfolder_completion = 'PerEzsigndocument', s_ezsignfoldertype_name_x = '', fki_billingentityinternal_id = 1, s_billingentityinternal_description_x = 'Default', diff --git a/test/test_webhook_ezsign_ezsignsigner_connect.py b/test/test_webhook_ezsign_ezsignsigner_connect.py index d9eac6bd8..d601b9165 100644 --- a/test/test_webhook_ezsign_ezsignsigner_connect.py +++ b/test/test_webhook_ezsign_ezsignsigner_connect.py @@ -45,6 +45,7 @@ def make_instance(self, include_optional) -> WebhookEzsignEzsignsignerConnect: pki_ezsignfolder_id = 33, fki_ezsignfoldertype_id = 5, obj_ezsignfoldertype = eZmaxApi.models.custom_ezsignfoldertype_response.Custom-Ezsignfoldertype-Response(), + e_ezsignfolder_completion = 'PerEzsigndocument', s_ezsignfoldertype_name_x = '', fki_billingentityinternal_id = 1, s_billingentityinternal_description_x = 'Default', diff --git a/test/test_webhook_ezsign_folder_completed.py b/test/test_webhook_ezsign_folder_completed.py index b1355d705..94273f97a 100644 --- a/test/test_webhook_ezsign_folder_completed.py +++ b/test/test_webhook_ezsign_folder_completed.py @@ -45,6 +45,7 @@ def make_instance(self, include_optional) -> WebhookEzsignFolderCompleted: pki_ezsignfolder_id = 33, fki_ezsignfoldertype_id = 5, obj_ezsignfoldertype = eZmaxApi.models.custom_ezsignfoldertype_response.Custom-Ezsignfoldertype-Response(), + e_ezsignfolder_completion = 'PerEzsigndocument', s_ezsignfoldertype_name_x = '', fki_billingentityinternal_id = 1, s_billingentityinternal_description_x = 'Default', @@ -99,6 +100,7 @@ def make_instance(self, include_optional) -> WebhookEzsignFolderCompleted: pki_ezsignfolder_id = 33, fki_ezsignfoldertype_id = 5, obj_ezsignfoldertype = eZmaxApi.models.custom_ezsignfoldertype_response.Custom-Ezsignfoldertype-Response(), + e_ezsignfolder_completion = 'PerEzsigndocument', s_ezsignfoldertype_name_x = '', fki_billingentityinternal_id = 1, s_billingentityinternal_description_x = 'Default', diff --git a/test/test_webhook_response.py b/test/test_webhook_response.py index c8d06169d..df5cec668 100644 --- a/test/test_webhook_response.py +++ b/test/test_webhook_response.py @@ -50,7 +50,24 @@ def make_instance(self, include_optional) -> WebhookResponse: s_webhook_secret = '', b_webhook_isactive = True, b_webhook_issigned = True, - b_webhook_skipsslvalidation = False + b_webhook_skipsslvalidation = False, + 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 WebhookResponse( @@ -62,6 +79,23 @@ def make_instance(self, include_optional) -> WebhookResponse: b_webhook_isactive = True, b_webhook_issigned = True, b_webhook_skipsslvalidation = False, + 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', ), ), ) """ diff --git a/test/test_webhook_response_compound.py b/test/test_webhook_response_compound.py index 6898227a8..8531b4fbf 100644 --- a/test/test_webhook_response_compound.py +++ b/test/test_webhook_response_compound.py @@ -51,6 +51,23 @@ def make_instance(self, include_optional) -> WebhookResponseCompound: b_webhook_isactive = True, b_webhook_issigned = True, b_webhook_skipsslvalidation = False, + 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', ), ), s_webhook_event = 'Ezsign-DocumentCompleted' ) else: @@ -63,6 +80,23 @@ def make_instance(self, include_optional) -> WebhookResponseCompound: b_webhook_isactive = True, b_webhook_issigned = True, b_webhook_skipsslvalidation = False, + 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', ), ), ) """