Class: SignRequestClient::SignrequestsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/signrequest_client/api/signrequests_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SignrequestsApi 



19
20
21
 
# File 'lib/signrequest_client/api/signrequests_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/signrequest_client/api/signrequests_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#signrequests_cancel_signrequest(uuid, opts = {}) ⇒ InlineResponse201

Cancel a SignRequest



27
28
29
30
 
# File 'lib/signrequest_client/api/signrequests_api.rb', line 27

def signrequests_cancel_signrequest(uuid, opts = {})
  data, _status_code, _headers = signrequests_cancel_signrequest_with_http_info(uuid, opts)
  data
end

#signrequests_cancel_signrequest_with_http_info(uuid, opts = {}) ⇒ Array<(InlineResponse201, Fixnum, Hash)>

Cancel a SignRequest



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
75
 
# File 'lib/signrequest_client/api/signrequests_api.rb', line 37

def signrequests_cancel_signrequest_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SignrequestsApi.signrequests_cancel_signrequest ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling SignrequestsApi.signrequests_cancel_signrequest"
  end
  # resource path
  local_var_path = '/signrequests/{uuid}/cancel_signrequest/'.sub('{' + 'uuid' + '}', uuid.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 = ['Token']
  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: SignrequestsApi#signrequests_cancel_signrequest\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#signrequests_create(data, opts = {}) ⇒ SignRequest

Create a SignRequest



81
82
83
84
 
# File 'lib/signrequest_client/api/signrequests_api.rb', line 81

def signrequests_create(data, opts = {})
  data, _status_code, _headers = signrequests_create_with_http_info(data, opts)
  data
end

#signrequests_create_with_http_info(data, opts = {}) ⇒ Array<(SignRequest, Fixnum, Hash)>

Create a SignRequest



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
129
 
# File 'lib/signrequest_client/api/signrequests_api.rb', line 91

def signrequests_create_with_http_info(data, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SignrequestsApi.signrequests_create ...'
  end
  # verify the required parameter 'data' is set
  if @api_client.config.client_side_validation && data.nil?
    fail ArgumentError, "Missing the required parameter 'data' when calling SignrequestsApi.signrequests_create"
  end
  # resource path
  local_var_path = '/signrequests/'

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

#signrequests_list(opts = {}) ⇒ InlineResponse2005

Retrieve a list of SignRequests

Options Hash (opts):

  • :who (String)
  • :from_email (String)
  • :page (Integer) —

    A page number within the paginated result set.

  • :limit (Integer) —

    Number of results to return per page.



138
139
140
141
 
# File 'lib/signrequest_client/api/signrequests_api.rb', line 138

def signrequests_list(opts = {})
  data, _status_code, _headers = signrequests_list_with_http_info(opts)
  data
end

#signrequests_list_with_http_info(opts = {}) ⇒ Array<(InlineResponse2005, Fixnum, Hash)>

Retrieve a list of SignRequests

Options Hash (opts):

  • :who (String)
  • :from_email (String)
  • :page (Integer) —

    A page number within the paginated result set.

  • :limit (Integer) —

    Number of results to return per page.



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
187
188
189
 
# File 'lib/signrequest_client/api/signrequests_api.rb', line 151

def signrequests_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SignrequestsApi.signrequests_list ...'
  end
  # resource path
  local_var_path = '/signrequests/'

  # query parameters
  query_params = {}
  query_params[:'who'] = opts[:'who'] if !opts[:'who'].nil?
  query_params[:'from_email'] = opts[:'from_email'] if !opts[:'from_email'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # 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 = ['Token']
  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 => 'InlineResponse2005')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SignrequestsApi#signrequests_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#signrequests_read(uuid, opts = {}) ⇒ SignRequest

Retrieve a SignRequest



195
196
197
198
 
# File 'lib/signrequest_client/api/signrequests_api.rb', line 195

def signrequests_read(uuid, opts = {})
  data, _status_code, _headers = signrequests_read_with_http_info(uuid, opts)
  data
end

#signrequests_read_with_http_info(uuid, opts = {}) ⇒ Array<(SignRequest, Fixnum, Hash)>

Retrieve a SignRequest



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
239
240
241
242
243
 
# File 'lib/signrequest_client/api/signrequests_api.rb', line 205

def signrequests_read_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SignrequestsApi.signrequests_read ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling SignrequestsApi.signrequests_read"
  end
  # resource path
  local_var_path = '/signrequests/{uuid}/'.sub('{' + 'uuid' + '}', uuid.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 = ['Token']
  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 => 'SignRequest')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SignrequestsApi#signrequests_read\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#signrequests_resend_signrequest_email(uuid, opts = {}) ⇒ InlineResponse2011

Resend a SignRequest



249
250
251
252
 
# File 'lib/signrequest_client/api/signrequests_api.rb', line 249

def signrequests_resend_signrequest_email(uuid, opts = {})
  data, _status_code, _headers = signrequests_resend_signrequest_email_with_http_info(uuid, opts)
  data
end

#signrequests_resend_signrequest_email_with_http_info(uuid, opts = {}) ⇒ Array<(InlineResponse2011, Fixnum, Hash)>

Resend a SignRequest



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/signrequest_client/api/signrequests_api.rb', line 259

def signrequests_resend_signrequest_email_with_http_info(uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SignrequestsApi.signrequests_resend_signrequest_email ...'
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling SignrequestsApi.signrequests_resend_signrequest_email"
  end
  # resource path
  local_var_path = '/signrequests/{uuid}/resend_signrequest_email/'.sub('{' + 'uuid' + '}', uuid.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 = ['Token']
  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 => 'InlineResponse2011')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SignrequestsApi#signrequests_resend_signrequest_email\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end