Class: CloudPDF::Doc::Metadata::Client

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

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ void

Parameters:



10
11
12
 
# File 'lib/CloudPDF/doc/metadata/client.rb', line 10

def initialize(client:)
  @client = client
end

Instance Method Details

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

Examples:

client.doc.metadata.get(
  doc_id: "docId",
  layer_name: "layerName"
)

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):

  • :doc_id (String)
  • :layer_name (String)
  • :document_password (String, nil)

Returns:



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

def get(request_options: {}, **params)
  params = CloudPDF::Internal::Types::Utils.normalize_keys(params)
  headers = {}
  headers["X-Document-Password"] = params[:document_password] if params[:document_password]

  request = CloudPDF::Internal::JSON::Request.new(
    base_url: request_options[:base_url],
    method: "GET",
    path: "v1/docs/#{URI.encode_uri_component(params[:doc_id].to_s)}/layers/#{URI.encode_uri_component(params[:layer_name].to_s)}/metadata",
    headers: headers,
    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::DocMetadataGet200Response.load(response.body)
  else
    error_class = CloudPDF::Errors::ResponseError.subclass_for_code(code)
    raise error_class.new(response.body, code: code)
  end
end