Class: YousignClient::FilesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/yousign_client/api/files_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FilesApi

Returns a new instance of FilesApi.



19
20
21
 
# File 'lib/yousign_client/api/files_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/yousign_client/api/files_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#files_id_download_get(id, authorization, opts = {}) ⇒ String

Download a File Used to get the base64 content of a file

Parameters:

  • id
  • authorization —

    Authentication credentials for HTTP authentication

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

    the optional parameters

Returns:

  • (String) 


28
29
30
31
 
# File 'lib/yousign_client/api/files_api.rb', line 28

def files_id_download_get(id, authorization, opts = {})
  data, _status_code, _headers = files_id_download_get_with_http_info(id, authorization, opts)
  data
end

#files_id_download_get_with_http_info(id, authorization, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Download a File Used to get the base64 content of a file

Parameters:

  • id
  • authorization —

    Authentication credentials for HTTP authentication

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

    the optional parameters

Returns:

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

    String data, response status code and response headers



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
75
76
77
78
79
80
81
82
 
# File 'lib/yousign_client/api/files_api.rb', line 39

def files_id_download_get_with_http_info(id, authorization, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.files_id_download_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling FilesApi.files_id_download_get"
  end
  # verify the required parameter 'authorization' is set
  if @api_client.config.client_side_validation && authorization.nil?
    fail ArgumentError, "Missing the required parameter 'authorization' when calling FilesApi.files_id_download_get"
  end
  # resource path
  local_var_path = '/files/{id}/download'.sub('{' + 'id' + '}', 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'])
  header_params[:'Authorization'] = authorization

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FilesApi#files_id_download_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#files_id_duplicate_post(id, authorization, content_type, opts = {}) ⇒ FileOutput

Duplicate a File Duplicate a file. It will be create a clone of this file, with a new ID.

Parameters:

  • id
  • authorization —

    Authentication credentials for HTTP authentication

  • content_type —

    The MIME type of the body of the request

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

    the optional parameters

Returns:



90
91
92
93
 
# File 'lib/yousign_client/api/files_api.rb', line 90

def files_id_duplicate_post(id, authorization, content_type, opts = {})
  data, _status_code, _headers = files_id_duplicate_post_with_http_info(id, authorization, content_type, opts)
  data
end

#files_id_duplicate_post_with_http_info(id, authorization, content_type, opts = {}) ⇒ Array<(FileOutput, Fixnum, Hash)>

Duplicate a File Duplicate a file. It will be create a clone of this file, with a new ID.

Parameters:

  • id
  • authorization —

    Authentication credentials for HTTP authentication

  • content_type —

    The MIME type of the body of the request

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

    the optional parameters

Returns:

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

    FileOutput data, response status code and response headers



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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/yousign_client/api/files_api.rb', line 102

def files_id_duplicate_post_with_http_info(id, authorization, content_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.files_id_duplicate_post ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling FilesApi.files_id_duplicate_post"
  end
  # verify the required parameter 'authorization' is set
  if @api_client.config.client_side_validation && authorization.nil?
    fail ArgumentError, "Missing the required parameter 'authorization' when calling FilesApi.files_id_duplicate_post"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling FilesApi.files_id_duplicate_post"
  end
  # resource path
  local_var_path = '/files/{id}/duplicate'.sub('{' + 'id' + '}', 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'])
  header_params[:'Authorization'] = authorization
  header_params[:'Content-Type'] = content_type

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'FileOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FilesApi#files_id_duplicate_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#files_id_get(id, authorization, opts = {}) ⇒ FileOutput

Find a File by ID Returns all the information regarding the File but without its content (for performance issue).

Parameters:

  • id
  • authorization —

    Authentication credentials for HTTP authentication

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

    the optional parameters

Returns:



157
158
159
160
 
# File 'lib/yousign_client/api/files_api.rb', line 157

def files_id_get(id, authorization, opts = {})
  data, _status_code, _headers = files_id_get_with_http_info(id, authorization, opts)
  data
end

#files_id_get_with_http_info(id, authorization, opts = {}) ⇒ Array<(FileOutput, Fixnum, Hash)>

Find a File by ID Returns all the information regarding the File but without its content (for performance issue).

Parameters:

  • id
  • authorization —

    Authentication credentials for HTTP authentication

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

    the optional parameters

Returns:

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

    FileOutput data, response status code and response headers



168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/yousign_client/api/files_api.rb', line 168

def files_id_get_with_http_info(id, authorization, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.files_id_get ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling FilesApi.files_id_get"
  end
  # verify the required parameter 'authorization' is set
  if @api_client.config.client_side_validation && authorization.nil?
    fail ArgumentError, "Missing the required parameter 'authorization' when calling FilesApi.files_id_get"
  end
  # resource path
  local_var_path = '/files/{id}'.sub('{' + 'id' + '}', 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'])
  header_params[:'Authorization'] = authorization

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  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 => 'FileOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FilesApi#files_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#files_post(authorization, content_type, body, opts = {}) ⇒ FileOutput

Create a new File Used to upload a file in base64 on our platform

Parameters:

  • authorization —

    Authentication credentials for HTTP authentication

  • content_type —

    The MIME type of the body of the request

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

    the optional parameters

Returns:



219
220
221
222
 
# File 'lib/yousign_client/api/files_api.rb', line 219

def files_post(authorization, content_type, body, opts = {})
  data, _status_code, _headers = files_post_with_http_info(authorization, content_type, body, opts)
  data
end

#files_post_with_http_info(authorization, content_type, body, opts = {}) ⇒ Array<(FileOutput, Fixnum, Hash)>

Create a new File Used to upload a file in base64 on our platform

Parameters:

  • authorization —

    Authentication credentials for HTTP authentication

  • content_type —

    The MIME type of the body of the request

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

    the optional parameters

Returns:

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

    FileOutput data, response status code and response headers



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
 
# File 'lib/yousign_client/api/files_api.rb', line 231

def files_post_with_http_info(authorization, content_type, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FilesApi.files_post ...'
  end
  # verify the required parameter 'authorization' is set
  if @api_client.config.client_side_validation && authorization.nil?
    fail ArgumentError, "Missing the required parameter 'authorization' when calling FilesApi.files_post"
  end
  # verify the required parameter 'content_type' is set
  if @api_client.config.client_side_validation && content_type.nil?
    fail ArgumentError, "Missing the required parameter 'content_type' when calling FilesApi.files_post"
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling FilesApi.files_post"
  end
  # resource path
  local_var_path = '/files'

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = []
  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 => 'FileOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FilesApi#files_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end