Package: qumranica
qumranicaPython connector to thequmranicaapi(generated by Openapi Generatorhttps://github.com/openapitools/openapi-generator)This Python package is automatically generated by theOpenAPI Generatorproject:API version: v1Package version: 0.7.2Build package: org.openapitools.codegen.languages.PythonClientCodegenRequirements.Python 2.7 and 3.4+Installation & Usagepip installIf the python package is hosted on a repository, you can install directly using:pipinstallqumranica(you may need to runpipwith root permission:sudo pip install qumranica)Then import the package:importqumranicaSetuptoolsInstall viaSetuptools.pythonsetup.pyinstall--user(orsudo python setup.py installto install the package for all users)Then import the package:importqumranicaGetting StartedPlease follow theinstallation procedureand then run the following:from__future__importprint_functionimporttimeimportqumranicafromqumranica.restimportApiExceptionfrompprintimportpprint# Defining the host is optional and defaults to http://localhost# See configuration.py for a list of all supported configuration parameters.configuration=qumranica.Configuration(host="http://localhost")# 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: Bearerconfiguration=qumranica.Configuration(host="http://localhost",api_key={'Authorization':'YOUR_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 clientwithqumranica.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_instance=qumranica.ArtefactApi(api_client)edition_id=56# int | Unique Id of the desired editionartefact_group_id=56# int | Unique Id of the artefact group to be deletedtry:# Deletes the specified artefact group.api_response=api_instance.v1_editions_edition_id_artefact_groups_artefact_group_id_delete(edition_id,artefact_group_id)pprint(api_response)exceptApiExceptionase:print("Exception when calling ArtefactApi->v1_editions_edition_id_artefact_groups_artefact_group_id_delete:%s\n"%e)Documentation for API EndpointsAll URIs are relative tohttp://localhostClassMethodHTTP requestDescriptionArtefactApiv1_editions_edition_id_artefact_groups_artefact_group_id_deleteDELETE/v1/editions/{editionId}/artefact-groups/{artefactGroupId}Deletes the specified artefact group.ArtefactApiv1_editions_edition_id_artefact_groups_artefact_group_id_getGET/v1/editions/{editionId}/artefact-groups/{artefactGroupId}Gets the details of a specific artefact group in the editionArtefactApiv1_editions_edition_id_artefact_groups_artefact_group_id_putPUT/v1/editions/{editionId}/artefact-groups/{artefactGroupId}Updates the details of an artefact group.  The artefact group will now only contain the artefacts listed in the JSON payload.  If the name is null, no change will be made, otherwise the name will also be updated.ArtefactApiv1_editions_edition_id_artefact_groups_getGET/v1/editions/{editionId}/artefact-groupsGets a listing of all artefact groups in the editionArtefactApiv1_editions_edition_id_artefact_groups_postPOST/v1/editions/{editionId}/artefact-groupsCreates a new artefact group with the submitted data.  The new artefact must have a list of artefacts that belong to the group.  It is not necessary to give the group a name.ArtefactApiv1_editions_edition_id_artefacts_artefact_id_deleteDELETE/v1/editions/{editionId}/artefacts/{artefactId}Deletes the specified artefactArtefactApiv1_editions_edition_id_artefacts_artefact_id_getGET/v1/editions/{editionId}/artefacts/{artefactId}Provides a listing of all artefacts that are part of the specified editionArtefactApiv1_editions_edition_id_artefacts_artefact_id_putPUT/v1/editions/{editionId}/artefacts/{artefactId}Updates the specified artefact.  There are many possible attributes that can be changed for  an artefact.  The caller should only input only those that  should be changed. Attributes with a null value will be ignored.  For instance, setting the mask to null or &quot;&quot; will result in  no changes to the current mask, and no value for the mask will  be returned (or broadcast). Likewise, the transformation, name,  or status message may be set to null and no change will be made  to those entities (though any unchanged values will be returned  along with the changed values and also broadcast to co-editors).ArtefactApiv1_editions_edition_id_artefacts_artefact_id_rois_getGET/v1/editions/{editionId}/artefacts/{artefactId}/roisProvides a listing of all rois belonging to an artefact in the specified editionArtefactApiv1_editions_edition_id_artefacts_artefact_id_text_fragments_getGET/v1/editions/{editionId}/artefacts/{artefactId}/text-fragmentsProvides a listing of text fragments that have text in the specified artefact.  With the optional query parameter &quot;suggested&quot;, this endpoint will also return  any text fragment that the system suggests might have text in the artefact.ArtefactApiv1_editions_edition_id_artefacts_batch_transformation_postPOST/v1/editions/{editionId}/artefacts/batch-transformationUpdates the positional data for a batch of artefactsArtefactApiv1_editions_edition_id_artefacts_getGET/v1/editions/{editionId}/artefactsProvides a listing of all artefacts that are part of the specified editionArtefactApiv1_editions_edition_id_artefacts_postPOST/v1/editions/{editionId}/artefactsCreates a new artefact with the provided data.  If no mask is provided, a placeholder mask will be created with the values:  &quot;POLYGON((0 0,1 1,1 0,0 0))&quot; (the system requires a valid WKT polygon mask for  every artefact). It is not recommended to leave the mask, name, or work status  blank or null. It will often be advantageous to leave the transformation null  when first creating a new artefact.CatalogueApiv1_catalogue_confirm_match_iaa_edition_catalog_to_text_fragment_id_deleteDELETE/v1/catalogue/confirm-match/{iaaEditionCatalogToTextFragmentId}Remove an existing imaged object and text fragment match, which is not correctCatalogueApiv1_catalogue_confirm_match_iaa_edition_catalog_to_text_fragment_id_postPOST/v1/catalogue/confirm-match/{iaaEditionCatalogToTextFragmentId}Confirm the correctness of an existing imaged object and text fragment matchCatalogueApiv1_catalogue_editions_edition_id_imaged_object_text_fragment_matches_getGET/v1/catalogue/editions/{editionId}/imaged-object-text-fragment-matchesGet a listing of all corresponding imaged objects and transcribed text fragment in a specified editionCatalogueApiv1_catalogue_imaged_objects_imaged_object_id_text_fragments_getGET/v1/catalogue/imaged-objects/{imagedObjectId}/text-fragmentsGet a listing of all text fragments matches that correspond to an imaged objectCatalogueApiv1_catalogue_manuscripts_manuscript_id_imaged_object_text_fragment_matches_getGET/v1/catalogue/manuscripts/{manuscriptId}/imaged-object-text-fragment-matchesGet a listing of all corresponding imaged objects and transcribed text fragment in a specified manuscriptCatalogueApiv1_catalogue_postPOST/v1/catalogueCreate a new matched pair for an imaged object and a text fragment along with the edition princeps informationCatalogueApiv1_catalogue_text_fragments_text_fragment_id_imaged_objects_getGET/v1/catalogue/text-fragments/{textFragmentId}/imaged-objectsGet a listing of all imaged objects that matches that correspond to a transcribed text fragmentEditionApiv1_editions_admin_share_requests_getGET/v1/editions/admin-share-requestsGet a list of requests issued by the current user for other users  to become editors of a shared editionEditionApiv1_editions_confirm_editorship_token_postPOST/v1/editions/confirm-editorship/{token}Confirm addition of an editor to the specified editionEditionApiv1_editions_edition_id_add_editor_request_postPOST/v1/editions/{editionId}/add-editor-requestAdds an editor to the specified editionEditionApiv1_editions_edition_id_deleteDELETE/v1/editions/{editionId}Provides details about the specified edition and all accessible alternate editionsEditionApiv1_editions_edition_id_editors_editor_email_id_putPUT/v1/editions/{editionId}/editors/{editorEmailId}Changes the rights for an editor of the specified editionEditionApiv1_editions_edition_id_getGET/v1/editions/{editionId}Provides details about the specified edition and all accessible alternate editionsEditionApiv1_editions_edition_id_postPOST/v1/editions/{editionId}Creates a copy of the specified editionEditionApiv1_editions_edition_id_putPUT/v1/editions/{editionId}Updates data for the specified editionEditionApiv1_editions_edition_id_script_collection_getGET/v1/editions/{editionId}/script-collectionProvides spatial data for all letters in the editionEditionApiv1_editions_edition_id_script_lines_getGET/v1/editions/{editionId}/script-linesProvides spatial data for all letters in the edition organized and oriented  by lines.EditionApiv1_editions_editor_invitations_getGET/v1/editions/editor-invitationsGet a list of invitations issued to the current user to become an editor of a shared editionEditionApiv1_editions_getGET/v1/editionsProvides a listing of all editions accessible to the current userImagedObjectApiv1_editions_edition_id_imaged_objects_getGET/v1/editions/{editionId}/imaged-objectsProvides a listing of imaged objects related to the specified edition, can include images and also their masks with  optional.ImagedObjectApiv1_editions_edition_id_imaged_objects_imaged_object_id_getGET/v1/editions/{editionId}/imaged-objects/{imagedObjectId}Provides information for the specified imaged object related to the specified edition, can include images and also  their masks with optional.ImagedObjectApiv1_imaged_objects_imaged_object_id_getGET/v1/imaged-objects/{imagedObjectId}Provides information for the specified imaged object.ImagedObjectApiv1_imaged_objects_imaged_object_id_text_fragments_getGET/v1/imaged-objects/{imagedObjectId}/text-fragmentsProvides a list of all text fragments that should correspond to the imaged object.ImagedObjectApiv1_imaged_objects_institutions_getGET/v1/imaged-objects/institutionsProvides a list of all institutional image providers.ImagedObjectApiv1_imaged_objects_institutions_institution_name_getGET/v1/imaged-objects/institutions/{institutionName}Provides a list of all institutional image providers.RoiApiv1_editions_edition_id_rois_batch_edit_postPOST/v1/editions/{editionId}/rois/batch-editProcesses a series of create/update/delete ROI requests in the given edition of a scrollRoiApiv1_editions_edition_id_rois_batch_postPOST/v1/editions/{editionId}/rois/batchCreates new sign ROI's in the given edition of a scrollRoiApiv1_editions_edition_id_rois_batch_putPUT/v1/editions/{editionId}/rois/batchUpdate existing sign ROI's in the given edition of a scrollRoiApiv1_editions_edition_id_rois_postPOST/v1/editions/{editionId}/roisCreates new sign ROI in the given edition of a scrollRoiApiv1_editions_edition_id_rois_roi_id_deleteDELETE/v1/editions/{editionId}/rois/{roiId}Deletes a sign ROI from the given edition of a scrollRoiApiv1_editions_edition_id_rois_roi_id_getGET/v1/editions/{editionId}/rois/{roiId}Get the details for a ROI in the given edition of a scrollRoiApiv1_editions_edition_id_rois_roi_id_putPUT/v1/editions/{editionId}/rois/{roiId}Update an existing sign ROI in the given edition of a scrollSignInterpretationApiv1_editions_edition_id_sign_interpretations_attributes_attribute_id_deleteDELETE/v1/editions/{editionId}/sign-interpretations-attributes/{attributeId}Delete an attribute from an editionSignInterpretationApiv1_editions_edition_id_sign_interpretations_attributes_attribute_id_putPUT/v1/editions/{editionId}/sign-interpretations-attributes/{attributeId}Change the details of an attribute in an editionSignInterpretationApiv1_editions_edition_id_sign_interpretations_attributes_getGET/v1/editions/{editionId}/sign-interpretations-attributesRetrieve a list of all possible attributes for an editionSignInterpretationApiv1_editions_edition_id_sign_interpretations_attributes_postPOST/v1/editions/{editionId}/sign-interpretations-attributesCreate a new attribute for an editionSignInterpretationApiv1_editions_edition_id_sign_interpretations_postPOST/v1/editions/{editionId}/sign-interpretationsCreates a new sign interpretationSignInterpretationApiv1_editions_edition_id_sign_interpretations_sign_interpretation_id_attributes_attribute_value_id_deleteDELETE/v1/editions/{editionId}/sign-interpretations/{signInterpretationId}/attributes/{attributeValueId}This deletes the specified attribute value from the specified sign interpretation.SignInterpretationApiv1_editions_edition_id_sign_interpretations_sign_interpretation_id_attributes_attribute_value_id_putPUT/v1/editions/{editionId}/sign-interpretations/{signInterpretationId}/attributes/{attributeValueId}This changes the values of the specified sign interpretation attribute,  mainly used to change commentary.SignInterpretationApiv1_editions_edition_id_sign_interpretations_sign_interpretation_id_attributes_postPOST/v1/editions/{editionId}/sign-interpretations/{signInterpretationId}/attributesThis adds a new attribute to the specified sign interpretation.SignInterpretationApiv1_editions_edition_id_sign_interpretations_sign_interpretation_id_commentary_putPUT/v1/editions/{editionId}/sign-interpretations/{signInterpretationId}/commentaryUpdates the commentary of a sign interpretationSignInterpretationApiv1_editions_edition_id_sign_interpretations_sign_interpretation_id_deleteDELETE/v1/editions/{editionId}/sign-interpretations/{signInterpretationId}Deletes the sign interpretation in the route. The endpoint automatically manages the sign stream  by connecting all the deleted sign's next and previous nodes.SignInterpretationApiv1_editions_edition_id_sign_interpretations_sign_interpretation_id_getGET/v1/editions/{editionId}/sign-interpretations/{signInterpretationId}Retrieve the details of a sign interpretation in an editionSignInterpretationApiv1_editions_edition_id_sign_interpretations_sign_interpretation_id_link_to_next_sign_interpretation_id_postPOST/v1/editions/{editionId}/sign-interpretations/{signInterpretationId}/link-to/{nextSignInterpretationId}Links two sign interpretations in the edition's sign streamSignInterpretationApiv1_editions_edition_id_sign_interpretations_sign_interpretation_id_unlink_from_next_sign_interpretation_id_postPOST/v1/editions/{editionId}/sign-interpretations/{signInterpretationId}/unlink-from/{nextSignInterpretationId}Links two sign interpretations in the edition's sign streamTextApiv1_editions_edition_id_lines_line_id_getGET/v1/editions/{editionId}/lines/{lineId}Retrieves all signs and their data from the given lineTextApiv1_editions_edition_id_text_fragments_getGET/v1/editions/{editionId}/text-fragmentsRetrieves the ids of all Fragments of all fragments in the given edition of a scrollTextApiv1_editions_edition_id_text_fragments_postPOST/v1/editions/{editionId}/text-fragmentsCreates a new text fragment in the given edition of a scrollTextApiv1_editions_edition_id_text_fragments_text_fragment_id_artefacts_getGET/v1/editions/{editionId}/text-fragments/{textFragmentId}/artefactsRetrieves the ids of all Artefacts in the given textFragmentNameTextApiv1_editions_edition_id_text_fragments_text_fragment_id_getGET/v1/editions/{editionId}/text-fragments/{textFragmentId}Retrieves all signs and their data from the given textFragmentNameTextApiv1_editions_edition_id_text_fragments_text_fragment_id_lines_getGET/v1/editions/{editionId}/text-fragments/{textFragmentId}/linesRetrieves the ids of all lines in the given textFragmentNameTextApiv1_editions_edition_id_text_fragments_text_fragment_id_putPUT/v1/editions/{editionId}/text-fragments/{textFragmentId}Updates the specified text fragment with the submitted propertiesUserApiv1_users_change_forgotten_password_postPOST/v1/users/change-forgotten-passwordUses the secret token from /users/forgot-password to validate a reset of the user's passwordUserApiv1_users_change_password_postPOST/v1/users/change-passwordChanges the password for the currently logged in userUserApiv1_users_change_unactivated_email_postPOST/v1/users/change-unactivated-emailAllows a user who has not yet activated their account to change their email address. This will not work if the user  account associated with the email address has already been activatedUserApiv1_users_confirm_registration_postPOST/v1/users/confirm-registrationConfirms registration of new user account.UserApiv1_users_forgot_password_postPOST/v1/users/forgot-passwordSends a secret token to the user's email to allow password reset.UserApiv1_users_getGET/v1/usersProvides the user details for a user with valid JWT in the Authorize headerUserApiv1_users_login_postPOST/v1/users/loginProvides a JWT bearer token for valid email and passwordUserApiv1_users_postPOST/v1/usersCreates a new user with the submitted data.UserApiv1_users_putPUT/v1/usersUpdates a user's registration details.  Note that the if the email address has changed, the account will be set to  inactive until the account is activated with the secret token.UserApiv1_users_resend_activation_email_postPOST/v1/users/resend-activation-emailSends a new activation email for the user's account. This will not work if the user account associated with the  email address has already been activated.UtilApiv1_utils_repair_wkt_polygon_postPOST/v1/utils/repair-wkt-polygonChecks a WKT polygon to ensure validity. If the polygon is invalid,  it attempts to construct a valid polygon that matches the original  as closely as possible.Documentation For ModelsAccountActivationRequestDTOAdminEditorRequestDTOAdminEditorRequestListDTOArtefactDTOArtefactDataDTOArtefactDataListDTOArtefactGroupDTOArtefactGroupListDTOArtefactListDTOArtefactTextFragmentMatchDTOArtefactTextFragmentMatchListDTOAttributeDTOAttributeListDTOAttributeValueDTOBatchEditRoiDTOBatchEditRoiResponseDTOBatchUpdateArtefactPlacementDTOBatchUpdatedArtefactTransformDTOCatalogueMatchDTOCatalogueMatchInputDTOCatalogueMatchListDTOCharacterShapeDTOCommentaryCreateDTOCommentaryDTOCreateArtefactDTOCreateArtefactGroupDTOCreateAttributeDTOCreateAttributeValueDTOCreateTextFragmentDTODeleteDTODeleteTokenDTODetailedEditorRightsDTODetailedUserDTODetailedUserTokenDTODirectionEditionCopyDTOEditionDTOEditionEntitiesEditionGroupDTOEditionListDTOEditionManuscriptMetricsDTOEditionScriptCollectionDTOEditionScriptLinesDTOEditionUpdateRequestDTOEditorDTOEditorInvitationDTOEditorInvitationListDTOImageDTOImageInstitutionDTOImageInstitutionListDTOImageStackDTOImagedObjectDTOImagedObjectListDTOImagedObjectTextFragmentMatchDTOImagedObjectTextFragmentMatchListDTOInstitutionalImageDTOInstitutionalImageListDTOInterpretationAttributeCreateDTOInterpretationAttributeDTOInterpretationRoiDTOInterpretationRoiDTOListInviteEditorDTOLightingLineDTOLineDataDTOLineDataListDTOLineTextDTOLoginRequestDTONewUserRequestDTONextSignInterpretationDTOPermissionDTOPlacementDTOResendUserAccountActivationRequestDTOResetForgottenUserPasswordRequestDTOResetLoggedInUserPasswordRequestDTOResetUserPasswordRequestDTOScriptArtefactCharactersDTOScriptLineDTOScriptTextFragmentDTOSetInterpretationRoiDTOSetInterpretationRoiDTOListSideDesignationSignDTOSignInterpretationCreateDTOSignInterpretationDTOSignInterpretationListDTOSimpleImageDTOSimpleImageListDTOTextEditionDTOTextFragmentDTOTextFragmentDataDTOTextFragmentDataListDTOTranslateDTOUnactivatedEmailUpdateRequestDTOUpdateArtefactDTOUpdateArtefactGroupDTOUpdateArtefactPlacementDTOUpdateAttributeDTOUpdateAttributeValueDTOUpdateEditionManuscriptMetricsDTOUpdateEditorRightsDTOUpdateInterpretationRoiDTOUpdateInterpretationRoiDTOListUpdateTextFragmentDTOUpdatedArtefactPlacementDTOUpdatedInterpretationRoiDTOUpdatedInterpretationRoiDTOListUserDTOUserUpdateRequestDTOWktPolygonDTODocumentation For AuthorizationBearerType: API keyAPI key parameter name: AuthorizationLocation: HTTP headerAuthor