Class: Zavudev::Resources::RegulatoryDocuments

Inherits:
Object
  • Object
show all
Defined in:
lib/zavudev/resources/regulatory_documents.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ RegulatoryDocuments

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of RegulatoryDocuments.

Parameters:



121
122
123
 
# File 'lib/zavudev/resources/regulatory_documents.rb', line 121

def initialize(client:)
  @client = client
end

Instance Method Details

#create(document_type:, file_size:, mime_type:, name:, storage_id:, request_options: {}) ⇒ Zavudev::Models::RegulatoryDocumentCreateResponse

Create a regulatory document record after uploading the file. Use the upload-url endpoint first to get an upload URL.

Parameters:

Returns:

See Also:



26
27
28
29
30
31
32
33
34
35
 
# File 'lib/zavudev/resources/regulatory_documents.rb', line 26

def create(params)
  parsed, options = Zavudev::RegulatoryDocumentCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "v1/documents",
    body: parsed,
    model: Zavudev::Models::RegulatoryDocumentCreateResponse,
    options: options
  )
end

#delete(document_id, request_options: {}) ⇒ nil

Delete a regulatory document. Cannot delete verified documents.

Parameters:

Returns:

  • (nil)

See Also:



90
91
92
93
94
95
96
97
 
# File 'lib/zavudev/resources/regulatory_documents.rb', line 90

def delete(document_id, params = {})
  @client.request(
    method: :delete,
    path: ["v1/documents/%1$s", document_id],
    model: NilClass,
    options: params[:request_options]
  )
end

#list(cursor: nil, limit: nil, request_options: {}) ⇒ Zavudev::Internal::Cursor<Zavudev::Models::RegulatoryDocument>

List regulatory documents for this project.

Parameters:

Returns:

See Also:



67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/zavudev/resources/regulatory_documents.rb', line 67

def list(params = {})
  parsed, options = Zavudev::RegulatoryDocumentListParams.dump_request(params)
  query = Zavudev::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "v1/documents",
    query: query,
    page: Zavudev::Internal::Cursor,
    model: Zavudev::RegulatoryDocument,
    options: options
  )
end

#retrieve(document_id, request_options: {}) ⇒ Zavudev::Models::RegulatoryDocumentRetrieveResponse

Get a specific regulatory document.

Parameters:

Returns:

See Also:



47
48
49
50
51
52
53
54
 
# File 'lib/zavudev/resources/regulatory_documents.rb', line 47

def retrieve(document_id, params = {})
  @client.request(
    method: :get,
    path: ["v1/documents/%1$s", document_id],
    model: Zavudev::Models::RegulatoryDocumentRetrieveResponse,
    options: params[:request_options]
  )
end

#upload_url(request_options: {}) ⇒ Zavudev::Models::RegulatoryDocumentUploadURLResponse

Get a presigned URL to upload a document file. After uploading, use the storageId to create the document record.

Parameters:

Returns:

See Also:



109
110
111
112
113
114
115
116
 
# File 'lib/zavudev/resources/regulatory_documents.rb', line 109

def upload_url(params = {})
  @client.request(
    method: :post,
    path: "v1/documents/upload-url",
    model: Zavudev::Models::RegulatoryDocumentUploadURLResponse,
    options: params[:request_options]
  )
end