class

RightDocuments::SubmissionsApi

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_submissions_get(document_id : String)

List a document's submissions @param document_id [String] Document UUID @return [nil]

Source
api_v1_documents_document_id_submissions_get_with_http_info(document_id : String)

List a document's submissions @param document_id [String] Document UUID @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

Source
api_v1_documents_document_id_submissions_post(document_id : String, api_v1_documents_document_id_submissions_post_request : ApiV1DocumentsDocumentIdSubmissionsPostRequest | Nil)

Add a submission of the document Records that the document was sent to an authority or a party. Nothing is proven until what comes back is recorded (POST /api/v1/submissions/{id}/accept). A court submission belongs to a court case of the document's matter (court_case may be left out when the matter has one). Times without an offset are read in the authority's time zone (the court's calendar, or by jurisdiction). @param document_id [String] Document UUID @return [nil]

Source
api_v1_documents_document_id_submissions_post_with_http_info(document_id : String, api_v1_documents_document_id_submissions_post_request : ApiV1DocumentsDocumentIdSubmissionsPostRequest | Nil)

Add a submission of the document Records that the document was sent to an authority or a party. Nothing is proven until what comes back is recorded (POST /api/v1/submissions/{id}/accept). A court submission belongs to a court case of the document's matter (court_case may be left out when the matter has one). Times without an offset are read in the authority's time zone (the court's calendar, or by jurisdiction). @param document_id [String] Document UUID @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

Source
api_v1_submissions_id_accept_post(id : String)

Record the acceptance or the filed copy (proves the facts) returned: acceptance (the authority's confirmation; needs received_at), filed_copy (the stamped or endorsed copy, the default; becomes the document's filed copy and accepts an open submission with received_at or filed_on) or certified_copy (of an accepted submission). file is required. A court submission received electronically on a non-court day is deemed filed the next court day (CCP 1010.6(e)(3); CRC 2.259); outside the court's calendar the filed date stays empty with a warning. Facts: court: case_number (filed_on goes to the case); secretary_of_state: file_number, formation_date (defaults to the filed date for a state-filing document of a company without one); irs: ein. They are written with the document as their source. dry_run=true returns the plan only. @param id [String] @return [nil]

Source
api_v1_submissions_id_accept_post_with_http_info(id : String)

Record the acceptance or the filed copy (proves the facts) returned: acceptance (the authority's confirmation; needs received_at), filed_copy (the stamped or endorsed copy, the default; becomes the document's filed copy and accepts an open submission with received_at or filed_on) or certified_copy (of an accepted submission). file is required. A court submission received electronically on a non-court day is deemed filed the next court day (CCP 1010.6(e)(3); CRC 2.259); outside the court's calendar the filed date stays empty with a warning. Facts: court: case_number (filed_on goes to the case); secretary_of_state: file_number, formation_date (defaults to the filed date for a state-filing document of a company without one); irs: ein. They are written with the document as their source. dry_run=true returns the plan only. @param id [String] @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

Source
api_v1_submissions_id_correct_post(id : String, api_v1_submissions_id_correct_post_request : ApiV1SubmissionsIdCorrectPostRequest | Nil)

Correct a submission (logged with a reason) Needs reason, and the person who made or recorded the submission or an organization admin. Fields: submitted_at, received_at, filed_on, reference, channel, channel_provider, recipient_name, jurisdiction, fees, notes, rejection_reason, status (only withdrawn, from submitted), and on an accepted submission the facts it proves. A new received time recomputes the filed date. @param id [String] @return [nil]

Source
api_v1_submissions_id_correct_post_with_http_info(id : String, api_v1_submissions_id_correct_post_request : ApiV1SubmissionsIdCorrectPostRequest | Nil)

Correct a submission (logged with a reason) Needs reason, and the person who made or recorded the submission or an organization admin. Fields: submitted_at, received_at, filed_on, reference, channel, channel_provider, recipient_name, jurisdiction, fees, notes, rejection_reason, status (only withdrawn, from submitted), and on an accepted submission the facts it proves. A new received time recomputes the filed date. @param id [String] @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

Source
api_v1_submissions_id_get(id : String)

Show a submission: status, history, and the facts it proved @param id [String] Submission UUID @return [nil]

Source
api_v1_submissions_id_get_with_http_info(id : String)

Show a submission: status, history, and the facts it proved @param id [String] Submission UUID @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

Source
api_v1_submissions_id_receipt_post(id : String)

Record the submission receipt (proves nothing) @param id [String] @return [nil]

Source
api_v1_submissions_id_receipt_post_with_http_info(id : String)

Record the submission receipt (proves nothing) @param id [String] @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

Source
api_v1_submissions_id_reject_post(id : String)

Record a rejection (proves nothing; resubmit with a new submission) @param id [String] @return [nil]

Source
api_v1_submissions_id_reject_post_with_http_info(id : String)

Record a rejection (proves nothing; resubmit with a new submission) @param id [String] @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers

Source