class

RightDocuments::DocumentsApi

Inherits Reference < Object

Constructors

new(api_client : RightDocuments::ApiClient = ApiClient.default)

Source

Instance methods

api_client

Source

api_client=(api_client : ApiClient)

Source

api_v1_documents_document_id_deliveries_get(document_id : String)

List how a document was sent @param document_id [String] @return [nil]

Source

api_v1_documents_document_id_deliveries_get_with_http_info(document_id : String)

List how a document was sent @param document_id [String] @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

Source

api_v1_documents_document_id_deliveries_id_patch(document_id : String, id : String, api_v1_documents_document_id_deliveries_id_patch_request : ApiV1DocumentsDocumentIdDeliveriesIdPatchRequest | Nil)

Update a delivery (e.g. mark delivered) @param document_id [String] @param id [String] @return [nil]

Source

api_v1_documents_document_id_deliveries_id_patch_with_http_info(document_id : String, id : String, api_v1_documents_document_id_deliveries_id_patch_request : ApiV1DocumentsDocumentIdDeliveriesIdPatchRequest | Nil)

Update a delivery (e.g. mark delivered) @param document_id [String] @param id [String] @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

Source

api_v1_documents_document_id_deliveries_id_sync_post(document_id : String, id : String)

Refresh the postal tracking of a mailed letter @param document_id [String] @param id [String] @return [nil]

Source

api_v1_documents_document_id_deliveries_id_sync_post_with_http_info(document_id : String, id : String)

Refresh the postal tracking of a mailed letter @param document_id [String] @param id [String] @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

Source

api_v1_documents_document_id_deliveries_mail_post(document_id : String, api_v1_documents_document_id_deliveries_mail_post_request : ApiV1DocumentsDocumentIdDeliveriesMailPostRequest | Nil)

Mail the document to a matter party as a letter (costs postage) @param document_id [String] @return [nil]

Source

api_v1_documents_document_id_deliveries_mail_post_with_http_info(document_id : String, api_v1_documents_document_id_deliveries_mail_post_request : ApiV1DocumentsDocumentIdDeliveriesMailPostRequest | Nil)

Mail the document to a matter party as a letter (costs postage) @param document_id [String] @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

Source

api_v1_documents_document_id_deliveries_post(document_id : String, api_v1_documents_document_id_deliveries_post_request : ApiV1DocumentsDocumentIdDeliveriesPostRequest | Nil)

Log a delivery @param document_id [String] @return [nil]

Source

api_v1_documents_document_id_deliveries_post_with_http_info(document_id : String, api_v1_documents_document_id_deliveries_post_request : ApiV1DocumentsDocumentIdDeliveriesPostRequest | Nil)

Log a delivery @param document_id [String] @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

Source

api_v1_documents_document_id_files_id_get(document_id : String, id : String)

Download one stored file of a document @param document_id [String] @param id [String] executed, unsigned, certificate, original, filed (the asset marked as the filed copy), or the key of an asset (see `files` on the document) @return [nil]

Source

api_v1_documents_document_id_files_id_get_with_http_info(document_id : String, id : String)

Source

api_v1_documents_id_delete(id : String)

Delete a voided document permanently (admins only) @param id [String] @return [nil]

Source

api_v1_documents_id_delete_with_http_info(id : String)

Delete a voided document permanently (admins only) @param id [String] @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

Source

api_v1_documents_id_get(id : String)

Show a document @param id [String] @return [nil]

Source

api_v1_documents_id_get_with_http_info(id : String)

Show a document @param id [String] @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

Source

api_v1_documents_id_patch(id : String, api_v1_documents_id_patch_request : ApiV1DocumentsIdPatchRequest | Nil)

Update document metadata (tags, name) @param id [String] @return [nil]

Source

api_v1_documents_id_patch_with_http_info(id : String, api_v1_documents_id_patch_request : ApiV1DocumentsIdPatchRequest | Nil)

Update document metadata (tags, name) @param id [String] @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

Source

api_v1_documents_id_restore_post(id : String)

Restore a voided document @param id [String] @return [nil]

Source

api_v1_documents_id_restore_post_with_http_info(id : String)

Restore a voided document @param id [String] @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

Source

api_v1_documents_id_void_post(id : String)

Void a document (hide it from lists and checklists) @param id [String] @return [nil]

Source

api_v1_documents_id_void_post_with_http_info(id : String)

Void a document (hide it from lists and checklists) @param id [String] @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

Source

api_v1_entities_entity_id_documents_get(entity_id : String)

List documents for an entity @param entity_id [String] @return [nil]

Source

api_v1_entities_entity_id_documents_get_with_http_info(entity_id : String)

List documents for an entity @param entity_id [String] @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

Source

api_v1_entities_entity_id_documents_import_post(entity_id : String)

Import a PDF as an executed document @param entity_id [String] @return [nil]

Source

api_v1_entities_entity_id_documents_import_post_with_http_info(entity_id : String)

Import a PDF as an executed document @param entity_id [String] @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

Source