Class: ConnectWise::DocumentsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/connectwise-ruby-sdk/api/documents_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DocumentsApi

Returns a new instance of DocumentsApi.



8
9
10
 
# File 'lib/connectwise-ruby-sdk/api/documents_api.rb', line 8

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



6
7
8
 
# File 'lib/connectwise-ruby-sdk/api/documents_api.rb', line 6

def api_client
  @api_client
end

Instance Method Details

#system_documents_count_get(opts = {}) ⇒ Count

Get Documents Info Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :record_type (String)
  • :record_id (Integer)

Returns:



18
19
20
21
 
# File 'lib/connectwise-ruby-sdk/api/documents_api.rb', line 18

def system_documents_count_get(opts = {})
  data, _status_code, _headers = system_documents_count_get_with_http_info(opts)
  return data
end

#system_documents_count_get_with_http_info(opts = {}) ⇒ Array<(Count, Fixnum, Hash)>

Get Documents Info Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :record_type (String)
  • :record_id (Integer)

Returns:

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

    Count data, response status code and response headers



29
30
31
32
33
34
35
36
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
 
# File 'lib/connectwise-ruby-sdk/api/documents_api.rb', line 29

def system_documents_count_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DocumentsApi.system_documents_count_get ..."
  end
  if @api_client.config.client_side_validation && opts[:'record_type'] && !['Agreement', 'Company', 'Configuration', 'Contact', 'Expense', 'HTMLTemplate', 'Opportunity', 'Project', 'PurchaseOrder', 'Rma', 'SalesOrder', 'Ticket', 'ServiceTemplate', 'KnowledgeBase', 'ToolbarIcon', 'Meeting', 'MeetingNote', 'ProductSetup', 'ProjectTemplateTicket', 'WordTemplate', 'Member'].include?(opts[:'record_type'])
    fail ArgumentError, 'invalid value for "record_type", must be one of Agreement, Company, Configuration, Contact, Expense, HTMLTemplate, Opportunity, Project, PurchaseOrder, Rma, SalesOrder, Ticket, ServiceTemplate, KnowledgeBase, ToolbarIcon, Meeting, MeetingNote, ProductSetup, ProjectTemplateTicket, WordTemplate, Member'
  end
  # resource path
  local_var_path = "/system/documents/count"

  # query parameters
  query_params = {}
  query_params[:'recordType'] = opts[:'record_type'] if !opts[:'record_type'].nil?
  query_params[:'recordId'] = opts[:'record_id'] if !opts[:'record_id'].nil?

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

#system_documents_get(opts = {}) ⇒ Array<DocumentInfo>

Get Documents Info

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :record_type (String)
  • :record_id (Integer)
  • :page (Integer)
  • :page_size (Integer)

Returns:



76
77
78
79
 
# File 'lib/connectwise-ruby-sdk/api/documents_api.rb', line 76

def system_documents_get(opts = {})
  data, _status_code, _headers = system_documents_get_with_http_info(opts)
  return data
end

#system_documents_get_with_http_info(opts = {}) ⇒ Array<(Array<DocumentInfo>, Fixnum, Hash)>

Get Documents Info

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :record_type (String)
  • :record_id (Integer)
  • :page (Integer)
  • :page_size (Integer)

Returns:

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

    Array<DocumentInfo> data, response status code and response headers



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
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/connectwise-ruby-sdk/api/documents_api.rb', line 89

def system_documents_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DocumentsApi.system_documents_get ..."
  end
  if @api_client.config.client_side_validation && opts[:'record_type'] && !['Agreement', 'Company', 'Configuration', 'Contact', 'Expense', 'HTMLTemplate', 'Opportunity', 'Project', 'PurchaseOrder', 'Rma', 'SalesOrder', 'Ticket', 'ServiceTemplate', 'KnowledgeBase', 'ToolbarIcon', 'Meeting', 'MeetingNote', 'ProductSetup', 'ProjectTemplateTicket', 'WordTemplate', 'Member'].include?(opts[:'record_type'])
    fail ArgumentError, 'invalid value for "record_type", must be one of Agreement, Company, Configuration, Contact, Expense, HTMLTemplate, Opportunity, Project, PurchaseOrder, Rma, SalesOrder, Ticket, ServiceTemplate, KnowledgeBase, ToolbarIcon, Meeting, MeetingNote, ProductSetup, ProjectTemplateTicket, WordTemplate, Member'
  end
  # resource path
  local_var_path = "/system/documents"

  # query parameters
  query_params = {}
  query_params[:'recordType'] = opts[:'record_type'] if !opts[:'record_type'].nil?
  query_params[:'recordId'] = opts[:'record_id'] if !opts[:'record_id'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?

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

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

Delete Document Info By Id

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


135
136
137
138
 
# File 'lib/connectwise-ruby-sdk/api/documents_api.rb', line 135

def system_documents_id_delete(id, opts = {})
  system_documents_id_delete_with_http_info(id, opts)
  return nil
end

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

Delete Document Info By Id

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



145
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
 
# File 'lib/connectwise-ruby-sdk/api/documents_api.rb', line 145

def system_documents_id_delete_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DocumentsApi.system_documents_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 DocumentsApi.system_documents_id_delete"
  end
  # resource path
  local_var_path = "/system/documents/{id}".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['BasicAuth']
  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: DocumentsApi#system_documents_id_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Download Document

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :last_modified (String)

Returns:

  • (nil) 


186
187
188
189
 
# File 'lib/connectwise-ruby-sdk/api/documents_api.rb', line 186

def system_documents_id_download_get(id, opts = {})
  system_documents_id_download_get_with_http_info(id, opts)
  return nil
end

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

Download Document

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :last_modified (String)

Returns:

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

    nil, response status code and response headers



197
198
199
200
201
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
 
# File 'lib/connectwise-ruby-sdk/api/documents_api.rb', line 197

def system_documents_id_download_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DocumentsApi.system_documents_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 DocumentsApi.system_documents_id_download_get"
  end
  # resource path
  local_var_path = "/system/documents/{id}/download".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'lastModified'] = opts[:'last_modified'] if !opts[:'last_modified'].nil?

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

  # form parameters
  form_params = {}

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

#system_documents_id_get(id, opts = {}) ⇒ DocumentInfo

Get Document Info By Id

Parameters:

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

    the optional parameters

Returns:



240
241
242
243
 
# File 'lib/connectwise-ruby-sdk/api/documents_api.rb', line 240

def system_documents_id_get(id, opts = {})
  data, _status_code, _headers = system_documents_id_get_with_http_info(id, opts)
  return data
end

#system_documents_id_get_with_http_info(id, opts = {}) ⇒ Array<(DocumentInfo, Fixnum, Hash)>

Get Document Info By Id

Parameters:

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

    the optional parameters

Returns:

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

    DocumentInfo data, response status code and response headers



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
278
279
280
281
282
283
284
285
286
 
# File 'lib/connectwise-ruby-sdk/api/documents_api.rb', line 250

def system_documents_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DocumentsApi.system_documents_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 DocumentsApi.system_documents_id_get"
  end
  # resource path
  local_var_path = "/system/documents/{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 = nil
  auth_names = ['BasicAuth']
  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 => 'DocumentInfo')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocumentsApi#system_documents_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_documents_id_post(id, record_id, record_type, title, url, opts = {}) ⇒ DocumentInfo

Update Document By Id

Parameters:

  • id
  • record_id —

    Entity id

  • record_type —

    Entity type

  • title —

    Document title

  • url —

    Document url

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

    the optional parameters

Options Hash (opts):

  • :file (File) —

    File to upload

  • :private_flag (BOOLEAN) —

    Indicates if document is private

  • :read_only_flag (BOOLEAN) —

    Indicates if document is readonly

  • :is_avatar (BOOLEAN) —

    Indicates if document contains an avatar

Returns:



301
302
303
304
 
# File 'lib/connectwise-ruby-sdk/api/documents_api.rb', line 301

def system_documents_id_post(id, record_id, record_type, title, url, opts = {})
  data, _status_code, _headers = system_documents_id_post_with_http_info(id, record_id, record_type, title, url, opts)
  return data
end

#system_documents_id_post_with_http_info(id, record_id, record_type, title, url, opts = {}) ⇒ Array<(DocumentInfo, Fixnum, Hash)>

Update Document By Id

Parameters:

  • id
  • record_id —

    Entity id

  • record_type —

    Entity type

  • title —

    Document title

  • url —

    Document url

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

    the optional parameters

Options Hash (opts):

  • :file (File) —

    File to upload

  • :private_flag (BOOLEAN) —

    Indicates if document is private

  • :read_only_flag (BOOLEAN) —

    Indicates if document is readonly

  • :is_avatar (BOOLEAN) —

    Indicates if document contains an avatar

Returns:

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

    DocumentInfo data, response status code and response headers



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/connectwise-ruby-sdk/api/documents_api.rb', line 319

def system_documents_id_post_with_http_info(id, record_id, record_type, title, url, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DocumentsApi.system_documents_id_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 DocumentsApi.system_documents_id_post"
  end
  # verify the required parameter 'record_id' is set
  if @api_client.config.client_side_validation && record_id.nil?
    fail ArgumentError, "Missing the required parameter 'record_id' when calling DocumentsApi.system_documents_id_post"
  end
  # verify the required parameter 'record_type' is set
  if @api_client.config.client_side_validation && record_type.nil?
    fail ArgumentError, "Missing the required parameter 'record_type' when calling DocumentsApi.system_documents_id_post"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['Ticket', 'Company', 'Configuration', 'Contact', 'Expense', 'Opportunity', 'PurchaseOrder', 'Project', 'SalesOrder', 'ServiceTemplate', 'Rma', 'Agreement', 'ToolbarIcon', 'WordTemplate', 'BillingSetup', 'ServiceBoard', 'TopNavigationLogo'].include?(record_type)
    fail ArgumentError, "invalid value for 'record_type', must be one of Ticket, Company, Configuration, Contact, Expense, Opportunity, PurchaseOrder, Project, SalesOrder, ServiceTemplate, Rma, Agreement, ToolbarIcon, WordTemplate, BillingSetup, ServiceBoard, TopNavigationLogo"
  end
  # verify the required parameter 'title' is set
  if @api_client.config.client_side_validation && title.nil?
    fail ArgumentError, "Missing the required parameter 'title' when calling DocumentsApi.system_documents_id_post"
  end
  if @api_client.config.client_side_validation && title.to_s.length > 100
    fail ArgumentError, 'invalid value for "title" when calling DocumentsApi.system_documents_id_post, the character length must be smaller than or equal to 100.'
  end

  # verify the required parameter 'url' is set
  if @api_client.config.client_side_validation && url.nil?
    fail ArgumentError, "Missing the required parameter 'url' when calling DocumentsApi.system_documents_id_post"
  end
  if @api_client.config.client_side_validation && url.to_s.length > 500
    fail ArgumentError, 'invalid value for "url" when calling DocumentsApi.system_documents_id_post, the character length must be smaller than or equal to 500.'
  end

  # resource path
  local_var_path = "/system/documents/{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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params["recordId"] = record_id
  form_params["recordType"] = record_type
  form_params["title"] = title
  form_params["url"] = url
  form_params["file"] = opts[:'file'] if !opts[:'file'].nil?
  form_params["privateFlag"] = opts[:'private_flag'] if !opts[:'private_flag'].nil?
  form_params["readOnlyFlag"] = opts[:'read_only_flag'] if !opts[:'read_only_flag'].nil?
  form_params["isAvatar"] = opts[:'is_avatar'] if !opts[:'is_avatar'].nil?

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

#system_documents_post(record_type, title, url, opts = {}) ⇒ DocumentInfo

Insert Document

Parameters:

  • record_type —

    Entity type

  • title —

    Document title

  • url —

    Document url

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

    the optional parameters

Options Hash (opts):

  • :file (File) —

    File to upload

  • :record_id (Integer) —

    Entity id

  • :private_flag (BOOLEAN) —

    Indicates if document is private

  • :read_only_flag (BOOLEAN) —

    Indicates if document is readonly

  • :is_avatar (BOOLEAN) —

    Indicates if document contains an avatar

Returns:



407
408
409
410
 
# File 'lib/connectwise-ruby-sdk/api/documents_api.rb', line 407

def system_documents_post(record_type, title, url, opts = {})
  data, _status_code, _headers = system_documents_post_with_http_info(record_type, title, url, opts)
  return data
end

#system_documents_post_with_http_info(record_type, title, url, opts = {}) ⇒ Array<(DocumentInfo, Fixnum, Hash)>

Insert Document

Parameters:

  • record_type —

    Entity type

  • title —

    Document title

  • url —

    Document url

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

    the optional parameters

Options Hash (opts):

  • :file (File) —

    File to upload

  • :record_id (Integer) —

    Entity id

  • :private_flag (BOOLEAN) —

    Indicates if document is private

  • :read_only_flag (BOOLEAN) —

    Indicates if document is readonly

  • :is_avatar (BOOLEAN) —

    Indicates if document contains an avatar

Returns:

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

    DocumentInfo data, response status code and response headers



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/connectwise-ruby-sdk/api/documents_api.rb', line 424

def system_documents_post_with_http_info(record_type, title, url, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DocumentsApi.system_documents_post ..."
  end
  # verify the required parameter 'record_type' is set
  if @api_client.config.client_side_validation && record_type.nil?
    fail ArgumentError, "Missing the required parameter 'record_type' when calling DocumentsApi.system_documents_post"
  end
  # verify enum value
  if @api_client.config.client_side_validation && !['Ticket', 'Company', 'Configuration', 'Contact', 'Expense', 'Member', 'Opportunity', 'PurchaseOrder', 'Project', 'SalesOrder', 'ServiceTemplate', 'Rma', 'Agreement', 'ToolbarIcon', 'WordTemplate', 'BillingSetup', 'PortalImagePortalLogo', 'PortalImageReportLogo', 'ServiceBoard', 'TopNavigationLogo'].include?(record_type)
    fail ArgumentError, "invalid value for 'record_type', must be one of Ticket, Company, Configuration, Contact, Expense, Member, Opportunity, PurchaseOrder, Project, SalesOrder, ServiceTemplate, Rma, Agreement, ToolbarIcon, WordTemplate, BillingSetup, PortalImagePortalLogo, PortalImageReportLogo, ServiceBoard, TopNavigationLogo"
  end
  # verify the required parameter 'title' is set
  if @api_client.config.client_side_validation && title.nil?
    fail ArgumentError, "Missing the required parameter 'title' when calling DocumentsApi.system_documents_post"
  end
  if @api_client.config.client_side_validation && title.to_s.length > 100
    fail ArgumentError, 'invalid value for "title" when calling DocumentsApi.system_documents_post, the character length must be smaller than or equal to 100.'
  end

  # verify the required parameter 'url' is set
  if @api_client.config.client_side_validation && url.nil?
    fail ArgumentError, "Missing the required parameter 'url' when calling DocumentsApi.system_documents_post"
  end
  if @api_client.config.client_side_validation && url.to_s.length > 500
    fail ArgumentError, 'invalid value for "url" when calling DocumentsApi.system_documents_post, the character length must be smaller than or equal to 500.'
  end

  # resource path
  local_var_path = "/system/documents"

  # 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(['multipart/form-data'])

  # form parameters
  form_params = {}
  form_params["recordType"] = record_type
  form_params["title"] = title
  form_params["url"] = url
  form_params["file"] = opts[:'file'] if !opts[:'file'].nil?
  form_params["recordId"] = opts[:'record_id'] if !opts[:'record_id'].nil?
  form_params["privateFlag"] = opts[:'private_flag'] if !opts[:'private_flag'].nil?
  form_params["readOnlyFlag"] = opts[:'read_only_flag'] if !opts[:'read_only_flag'].nil?
  form_params["isAvatar"] = opts[:'is_avatar'] if !opts[:'is_avatar'].nil?

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

#system_documents_uploadsample_get(opts = {}) ⇒ nil

Get Upload Sample Page

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


496
497
498
499
 
# File 'lib/connectwise-ruby-sdk/api/documents_api.rb', line 496

def system_documents_uploadsample_get(opts = {})
  system_documents_uploadsample_get_with_http_info(opts)
  return nil
end

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

Get Upload Sample Page

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/connectwise-ruby-sdk/api/documents_api.rb', line 505

def system_documents_uploadsample_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DocumentsApi.system_documents_uploadsample_get ..."
  end
  # resource path
  local_var_path = "/system/documents/uploadsample"

  # query parameters
  query_params = {}

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

  # form parameters
  form_params = {}

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