Class: GroupDocsSignatureCloud::PreviewApi

Inherits:
Object
  • Object
show all
Defined in:
lib/groupdocs_signature_cloud/api/preview_api.rb

Overview

GroupDocs.Signature Cloud API

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config) ⇒ PreviewApi

Initializes new instance of PreviewApi

Parameters:



43
44
45
46
47
 
# File 'lib/groupdocs_signature_cloud/api/preview_api.rb', line 43

def initialize(config)
  @config = config
  @api_client = ApiClient.new(config)
  @access_token = nil
end

Instance Attribute Details

#config ⇒ Object

Returns the value of attribute config.



34
35
36
 
# File 'lib/groupdocs_signature_cloud/api/preview_api.rb', line 34

def config
  @config
end

Class Method Details

.from_config(config) ⇒ PreviewApi

Initializes new instance of PreviewApi

Parameters:

Returns:



63
64
65
 
# File 'lib/groupdocs_signature_cloud/api/preview_api.rb', line 63

def self.from_config(config)
  return new(config)
end

.from_keys(app_sid, app_key) ⇒ PreviewApi

Initializes new instance of PreviewApi

Parameters:

  • Application (app_sid) —

    identifier (App SID)

  • Application (app_key) —

    private key (App Key)

Returns:



54
55
56
57
 
# File 'lib/groupdocs_signature_cloud/api/preview_api.rb', line 54

def self.from_keys(app_sid, app_key)
  config = Configuration.new(app_sid, app_key)
  return new(config)
end

Instance Method Details

#preview_document(request) ⇒ PreviewResult

Creates document preview images

Parameters:

  • request —

    preview_document_request

Returns:



71
72
73
74
 
# File 'lib/groupdocs_signature_cloud/api/preview_api.rb', line 71

def preview_document(request)
  data, _status_code, _headers = preview_document_with_http_info(request)
  data
end

#preview_document_with_http_info(request) ⇒ Array<(PreviewResult, Fixnum, Hash)>

Creates document preview images

PreviewResult data, response status code and response headers

Parameters:

  • request —

    preview_document_request

Returns:

Raises:

  • (ArgumentError) 


81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/groupdocs_signature_cloud/api/preview_api.rb', line 81

def preview_document_with_http_info(request)
  raise ArgumentError, 'Incorrect request type' unless request.is_a? PreviewDocumentRequest

  @api_client.config.logger.debug 'Calling API: PreviewApi.preview_document ...' if @api_client.config.debugging
  # verify the required parameter 'preview_settings' is set
  raise ArgumentError, 'Missing the required parameter preview_settings when calling PreviewApi.preview_document' if @api_client.config.client_side_validation && request.preview_settings.nil?
  # resource path
  local_var_path = '/signature/preview'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(request.preview_settings)
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
                                                    header_params: header_params,
                                                    query_params: query_params,
                                                    form_params: form_params,
                                                    body: post_body,
                                                    access_token: get_access_token,
                                                    return_type: 'PreviewResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called:
    PreviewApi#preview_document\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  [data, status_code, headers]
end