Class: YousignClient::FileObjectsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ FileObjectsApi

Returns a new instance of FileObjectsApi.



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

def api_client
  @api_client
end

Instance Method Details

#file_objects_id_delete(id, opts = {}) ⇒ nil

Delete a File Object Delete a File Object

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/yousign_client/api/file_objects_api.rb', line 27

def file_objects_id_delete(id, opts = {})
  file_objects_id_delete_with_http_info(id, opts)
  nil
end

#file_objects_id_delete_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

Delete a File Object Delete a File Object

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



37
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/yousign_client/api/file_objects_api.rb', line 37

def file_objects_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FileObjectsApi.file_objects_id_delete ...'
  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 FileObjectsApi.file_objects_id_delete"
  end
  # resource path
  local_var_path = '/file_objects/{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'])

  # form parameters
  form_params = {}

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

#file_objects_id_get(id, opts = {}) ⇒ FileObjectOutput

Find a File Object by ID Get a File Object

Parameters:

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

    the optional parameters

Returns:



80
81
82
83
 
# File 'lib/yousign_client/api/file_objects_api.rb', line 80

def file_objects_id_get(id, opts = {})
  data, _status_code, _headers = file_objects_id_get_with_http_info(id, opts)
  data
end

#file_objects_id_get_with_http_info(id, opts = {}) ⇒ Array<(FileObjectOutput, Fixnum, Hash)>

Find a File Object by ID Get a File Object

Parameters:

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

    the optional parameters

Returns:

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

    FileObjectOutput data, response status code and response headers



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
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/yousign_client/api/file_objects_api.rb', line 90

def file_objects_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FileObjectsApi.file_objects_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 FileObjectsApi.file_objects_id_get"
  end
  # resource path
  local_var_path = '/file_objects/{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'])

  # form parameters
  form_params = {}

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

#file_objects_id_put(id, body, opts = {}) ⇒ FileObjectOutput

Update a File Object Update a File Object

Parameters:

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

    the optional parameters

Returns:



135
136
137
138
 
# File 'lib/yousign_client/api/file_objects_api.rb', line 135

def file_objects_id_put(id, body, opts = {})
  data, _status_code, _headers = file_objects_id_put_with_http_info(id, body, opts)
  data
end

#file_objects_id_put_with_http_info(id, body, opts = {}) ⇒ Array<(FileObjectOutput, Fixnum, Hash)>

Update a File Object Update a File Object

Parameters:

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

    the optional parameters

Returns:

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

    FileObjectOutput data, response status code and response headers



146
147
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
185
186
 
# File 'lib/yousign_client/api/file_objects_api.rb', line 146

def file_objects_id_put_with_http_info(id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FileObjectsApi.file_objects_id_put ...'
  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 FileObjectsApi.file_objects_id_put"
  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 FileObjectsApi.file_objects_id_put"
  end
  # resource path
  local_var_path = '/file_objects/{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'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['api_key']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'FileObjectOutput')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: FileObjectsApi#file_objects_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#file_objects_post(body, opts = {}) ⇒ FileObjectOutput

Create a new File Object Create a new fileObject

Parameters:

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

    the optional parameters

Returns:



192
193
194
195
 
# File 'lib/yousign_client/api/file_objects_api.rb', line 192

def file_objects_post(body, opts = {})
  data, _status_code, _headers = file_objects_post_with_http_info(body, opts)
  data
end

#file_objects_post_with_http_info(body, opts = {}) ⇒ Array<(FileObjectOutput, Fixnum, Hash)>

Create a new File Object Create a new fileObject

Parameters:

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

    the optional parameters

Returns:

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

    FileObjectOutput data, response status code and response headers



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/yousign_client/api/file_objects_api.rb', line 202

def file_objects_post_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: FileObjectsApi.file_objects_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 FileObjectsApi.file_objects_post"
  end
  # resource path
  local_var_path = '/file_objects'

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