Class: FormAPI::PDFApi

Inherits:
Object
  • Object
show all
Defined in:
lib/form_api/api/pdf_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PDFApi

Returns a new instance of PDFApi.



19
20
21
 
# File 'lib/form_api/api/pdf_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/form_api/api/pdf_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#expire_submission(submission_id, opts = {}) ⇒ InlineResponse201Submission

Expire a PDF submission

Parameters:

  • submission_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/form_api/api/pdf_api.rb', line 28

def expire_submission(submission_id, opts = {})
  data, _status_code, _headers = expire_submission_with_http_info(submission_id, opts)
  return data
end

#expire_submission_with_http_info(submission_id, opts = {}) ⇒ Array<(InlineResponse201Submission, Fixnum, Hash)>

Expire a PDF submission

Parameters:

  • submission_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/form_api/api/pdf_api.rb', line 38

def expire_submission_with_http_info(submission_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PDFApi.expire_submission ..."
  end
  # verify the required parameter 'submission_id' is set
  if @api_client.config.client_side_validation && submission_id.nil?
    fail ArgumentError, "Missing the required parameter 'submission_id' when calling PDFApi.expire_submission"
  end
  # resource path
  local_var_path = "/submissions/{submission_id}".sub('{' + 'submission_id' + '}', submission_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basic']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse201Submission')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#expire_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#generate_pdf(template_id, opts = {}) ⇒ InlineResponse201

Generates a new PDF

Parameters:

  • template_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



82
83
84
85
 
# File 'lib/form_api/api/pdf_api.rb', line 82

def generate_pdf(template_id, opts = {})
  data, _status_code, _headers = generate_pdf_with_http_info(template_id, opts)
  return data
end

#generate_pdf_with_http_info(template_id, opts = {}) ⇒ Array<(InlineResponse201, Fixnum, Hash)>

Generates a new PDF

Parameters:

  • template_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(InlineResponse201, Fixnum, Hash)>) —

    InlineResponse201 data, response status code and response headers



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
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/form_api/api/pdf_api.rb', line 93

def generate_pdf_with_http_info(template_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PDFApi.generate_pdf ..."
  end
  # verify the required parameter 'template_id' is set
  if @api_client.config.client_side_validation && template_id.nil?
    fail ArgumentError, "Missing the required parameter 'template_id' when calling PDFApi.generate_pdf"
  end
  # resource path
  local_var_path = "/templates/{template_id}/submissions".sub('{' + 'template_id' + '}', template_id.to_s)

  # 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(opts[:'data'])
  auth_names = ['basic']
  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,
    :auth_names => auth_names,
    :return_type => 'InlineResponse201')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#generate_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_submission(submission_id, opts = {}) ⇒ InlineResponse201Submission

Check the status of a PDF

Parameters:

  • submission_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



138
139
140
141
 
# File 'lib/form_api/api/pdf_api.rb', line 138

def get_submission(submission_id, opts = {})
  data, _status_code, _headers = get_submission_with_http_info(submission_id, opts)
  return data
end

#get_submission_with_http_info(submission_id, opts = {}) ⇒ Array<(InlineResponse201Submission, Fixnum, Hash)>

Check the status of a PDF

Parameters:

  • submission_id
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



148
149
150
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
177
178
179
180
181
182
183
184
 
# File 'lib/form_api/api/pdf_api.rb', line 148

def get_submission_with_http_info(submission_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PDFApi.get_submission ..."
  end
  # verify the required parameter 'submission_id' is set
  if @api_client.config.client_side_validation && submission_id.nil?
    fail ArgumentError, "Missing the required parameter 'submission_id' when calling PDFApi.get_submission"
  end
  # resource path
  local_var_path = "/submissions/{submission_id}".sub('{' + 'submission_id' + '}', submission_id.to_s)

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['basic']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'InlineResponse201Submission')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PDFApi#get_submission\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end