Class: CloudPDF::Documents::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/CloudPDF/documents/client.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ void

Parameters:



9
10
11
 
# File 'lib/CloudPDF/documents/client.rb', line 9

def initialize(client:)
  @client = client
end

Instance Method Details

#commit(request_options: {}, **params) ⇒ CloudPDF::Types::DocumentsCommit200Response

Examples:

client.documents.commit(
  tenant_id: "tenantId",
  id: "id",
  sha256: "sha256"
)

Parameters:

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :tenant_id (String)
  • :id (String)

Returns:



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/CloudPDF/documents/client.rb', line 151

def commit(request_options: {}, **params)
  params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
  request_data = CloudPDF::Documents::Types::DocumentsCommitRequest.new(params).to_h
  non_body_param_names = %w[tenantId id]
  body = request_data.except(*non_body_param_names)

  request = CloudPDF::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "POST",
    path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/documents/#{URI.encode_uri_component(params[:id].to_s)}/commit",
    body: body,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise CloudPDF::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    CloudPDF::Types::DocumentsCommit200Response.load(response.body)
  else
    error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#delete(request_options: {}, **params) ⇒ untyped

Examples:

client.documents.delete(
  tenant_id: "tenantId",
  id: "id"
)

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :tenant_id (String)
  • :id (String)

Returns:

  • (untyped)

Raises:

  • (error_class) 


113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/CloudPDF/documents/client.rb', line 113

def delete(request_options: {}, **params)
  params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
  request = CloudPDF::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "DELETE",
    path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/documents/#{URI.encode_uri_component(params[:id].to_s)}",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise CloudPDF::Errors::TimeoutError
  end
  code = response.code.to_i
  return if code.between?(200, 299)

  error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
  raise error_class.new(response.body, code: code)
end

#download(request_options: {}, **params) ⇒ untyped

Examples:

client.documents.download(
  tenant_id: "tenantId",
  id: "id"
)

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :tenant_id (String)
  • :id (String)

Returns:

  • (untyped)

Raises:

  • (error_class) 


195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/CloudPDF/documents/client.rb', line 195

def download(request_options: {}, **params)
  params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
  request = CloudPDF::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/documents/#{URI.encode_uri_component(params[:id].to_s)}/download",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise CloudPDF::Errors::TimeoutError
  end
  code = response.code.to_i
  return if code.between?(200, 299)

  error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
  raise error_class.new(response.body, code: code)
end

#get(request_options: {}, **params) ⇒ CloudPDF::Types::DocumentsGet200Response

Examples:

client.documents.get(
  tenant_id: "tenantId",
  id: "id"
)

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :tenant_id (String)
  • :id (String)

Returns:



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/CloudPDF/documents/client.rb', line 74

def get(request_options: {}, **params)
  params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
  request = CloudPDF::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/documents/#{URI.encode_uri_component(params[:id].to_s)}",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise CloudPDF::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    CloudPDF::Types::DocumentsGet200Response.load(response.body)
  else
    error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#init(request_options: {}, **params) ⇒ CloudPDF::Types::DocumentsInit200Response

Examples:

client.documents.init(
  tenant_id: "tenantId",
  content_length: 1.1,
  content_sha256: "contentSha256"
)

Parameters:

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :tenant_id (String)

Returns:



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/CloudPDF/documents/client.rb', line 319

def init(request_options: {}, **params)
  params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
  request_data = CloudPDF::Documents::Types::DocumentsInitRequest.new(params).to_h
  non_body_param_names = %w[tenantId]
  body = request_data.except(*non_body_param_names)

  request = CloudPDF::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "POST",
    path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/documents/init",
    body: body,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise CloudPDF::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    CloudPDF::Types::DocumentsInit200Response.load(response.body)
  else
    error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#list(request_options: {}, **params) ⇒ CloudPDF::Types::DocumentsList200Response

Examples:

client.documents.list(tenant_id: "tenantId")

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

Returns:



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/CloudPDF/documents/client.rb', line 29

def list(request_options: {}, **params)
  params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
  query_params = {}
  query_params["limit"] = params[:limit] if params.key?(:limit)
  query_params["cursor"] = params[:cursor] if params.key?(:cursor)
  query_params["state"] = params[:state] if params.key?(:state)

  request = CloudPDF::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/documents",
    query: query_params,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise CloudPDF::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    CloudPDF::Types::DocumentsList200Response.load(response.body)
  else
    error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end

#thumbnail(request_options: {}, **params) ⇒ untyped

Examples:

client.documents.thumbnail(
  tenant_id: "tenantId",
  id: "id"
)

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (Hash)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :tenant_id (String)
  • :id (String)

Returns:

  • (untyped)

Raises:

  • (error_class) 


232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/CloudPDF/documents/client.rb', line 232

def thumbnail(request_options: {}, **params)
  params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
  request = CloudPDF::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/documents/#{URI.encode_uri_component(params[:id].to_s)}/thumbnail",
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise CloudPDF::Errors::TimeoutError
  end
  code = response.code.to_i
  return if code.between?(200, 299)

  error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
  raise error_class.new(response.body, code: code)
end

#upload_proxy(request_options: {}, **params) ⇒ CloudPDF::Types::DocumentsUploadProxy200Response

This bounded origin-mediated fallback must only be used after documents.init returns upload.kind=proxy. Auto mode prefers a presigned object-store PUT whenever available.

Examples:

client.documents.upload_proxy(
  tenant_id: "tenantId",
  id: "id",
  file: File.open("document.pdf", "rb")
)

Parameters:

  • request_options (Hash) (defaults to: {})
  • params (void)

Options Hash (request_options:):

  • :base_url (String)
  • :additional_headers (Hash{String => Object})
  • :additional_query_parameters (Hash{String => Object})
  • :additional_body_parameters (Hash{String => Object})
  • :timeout_in_seconds (Integer)

Options Hash (**params):

  • :tenant_id (String)
  • :id (String)
  • :file (#read)

Returns:

Raises:

  • (ArgumentError) 


274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'lib/CloudPDF/documents/client.rb', line 274

def upload_proxy(request_options: {}, **params)
  params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
  body = Internal::Multipart::FormData.new

  raise ArgumentError, "file is required" unless params[:file]
  body.add_file(name: "file", file: params[:file], content_type: "application/pdf")

  request = CloudPDF::Internal::Multipart::Request.new(
    base_url: request_options[:base_url],
    method: "POST",
    path: "v1/tenants/#{URI.encode_uri_component(params[:tenant_id].to_s)}/documents/#{URI.encode_uri_component(params[:id].to_s)}/upload-proxy",
    body: body,
    request_options: request_options
  )
  begin
    response = @client.send(request)
  rescue Net::HTTPRequestTimeout
    raise CloudPDF::Errors::TimeoutError
  end
  code = response.code.to_i
  if code.between?(200, 299)
    CloudPDF::Types::DocumentsUploadProxy200Response.load(response.body)
  else
    error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end