Class: ConnectWise::DocumentsSetupApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ DocumentsSetupApi

Returns a new instance of DocumentsSetupApi.

[View source]

8
9
10
 
# File 'lib/connectwise-ruby-sdk/api/documents_setup_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_setup_api.rb', line 6

def api_client
  @api_client
end

Instance Method Details

#system_mycompany_documents_get(opts = {}) ⇒ Array<DocumentSetup>

Get Documents

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :order_by (String)
  • :childconditions (String)
  • :customfieldconditions (String)
  • :page (Integer)
  • :page_size (Integer)

Returns:

[View source]

22
23
24
25
 
# File 'lib/connectwise-ruby-sdk/api/documents_setup_api.rb', line 22

def system_mycompany_documents_get(opts = {})
  data, _status_code, _headers = system_mycompany_documents_get_with_http_info(opts)
  return data
end

#system_mycompany_documents_get_with_http_info(opts = {}) ⇒ Array<(Array<DocumentSetup>, Fixnum, Hash)>

Get Documents

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)
  • :order_by (String)
  • :childconditions (String)
  • :customfieldconditions (String)
  • :page (Integer)
  • :page_size (Integer)

Returns:

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

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

[View source]

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/connectwise-ruby-sdk/api/documents_setup_api.rb', line 37

def system_mycompany_documents_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DocumentsSetupApi.system_mycompany_documents_get ..."
  end
  # resource path
  local_var_path = "/system/mycompany/documents"

  # query parameters
  query_params = {}
  query_params[:'conditions'] = opts[:'conditions'] if !opts[:'conditions'].nil?
  query_params[:'orderBy'] = opts[:'order_by'] if !opts[:'order_by'].nil?
  query_params[:'childconditions'] = opts[:'childconditions'] if !opts[:'childconditions'].nil?
  query_params[:'customfieldconditions'] = opts[:'customfieldconditions'] if !opts[:'customfieldconditions'].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<DocumentSetup>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocumentsSetupApi#system_mycompany_documents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_mycompany_documents_id_get(id, opts = {}) ⇒ DocumentSetup

Get Document By Id

Parameters:

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

    the optional parameters

Returns:

[View source]

82
83
84
85
 
# File 'lib/connectwise-ruby-sdk/api/documents_setup_api.rb', line 82

def system_mycompany_documents_id_get(id, opts = {})
  data, _status_code, _headers = system_mycompany_documents_id_get_with_http_info(id, opts)
  return data
end

#system_mycompany_documents_id_get_with_http_info(id, opts = {}) ⇒ Array<(DocumentSetup, Fixnum, Hash)>

Get Document By Id

Parameters:

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

    the optional parameters

Returns:

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

    DocumentSetup data, response status code and response headers

[View source]

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_setup_api.rb', line 92

def system_mycompany_documents_id_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DocumentsSetupApi.system_mycompany_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 DocumentsSetupApi.system_mycompany_documents_id_get"
  end
  # resource path
  local_var_path = "/system/mycompany/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 => 'DocumentSetup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: DocumentsSetupApi#system_mycompany_documents_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_mycompany_documents_id_patch(id, operations, opts = {}) ⇒ DocumentSetup

Update Document

Parameters:

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

    the optional parameters

Returns:

[View source]

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

def system_mycompany_documents_id_patch(id, operations, opts = {})
  data, _status_code, _headers = system_mycompany_documents_id_patch_with_http_info(id, operations, opts)
  return data
end

#system_mycompany_documents_id_patch_with_http_info(id, operations, opts = {}) ⇒ Array<(DocumentSetup, Fixnum, Hash)>

Update Document

Parameters:

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

    the optional parameters

Returns:

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

    DocumentSetup data, response status code and response headers

[View source]

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
187
188
189
 
# File 'lib/connectwise-ruby-sdk/api/documents_setup_api.rb', line 147

def system_mycompany_documents_id_patch_with_http_info(id, operations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DocumentsSetupApi.system_mycompany_documents_id_patch ..."
  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 DocumentsSetupApi.system_mycompany_documents_id_patch"
  end
  # verify the required parameter 'operations' is set
  if @api_client.config.client_side_validation && operations.nil?
    fail ArgumentError, "Missing the required parameter 'operations' when calling DocumentsSetupApi.system_mycompany_documents_id_patch"
  end
  # resource path
  local_var_path = "/system/mycompany/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(['application/json'])

  # form parameters
  form_params = {}

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

#system_mycompany_documents_id_put(id, document, opts = {}) ⇒ DocumentSetup

Replace Document

Parameters:

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

    the optional parameters

Returns:

[View source]

197
198
199
200
 
# File 'lib/connectwise-ruby-sdk/api/documents_setup_api.rb', line 197

def system_mycompany_documents_id_put(id, document, opts = {})
  data, _status_code, _headers = system_mycompany_documents_id_put_with_http_info(id, document, opts)
  return data
end

#system_mycompany_documents_id_put_with_http_info(id, document, opts = {}) ⇒ Array<(DocumentSetup, Fixnum, Hash)>

Replace Document

Parameters:

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

    the optional parameters

Returns:

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

    DocumentSetup data, response status code and response headers

[View source]

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
244
245
246
247
248
249
250
 
# File 'lib/connectwise-ruby-sdk/api/documents_setup_api.rb', line 208

def system_mycompany_documents_id_put_with_http_info(id, document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: DocumentsSetupApi.system_mycompany_documents_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 DocumentsSetupApi.system_mycompany_documents_id_put"
  end
  # verify the required parameter 'document' is set
  if @api_client.config.client_side_validation && document.nil?
    fail ArgumentError, "Missing the required parameter 'document' when calling DocumentsSetupApi.system_mycompany_documents_id_put"
  end
  # resource path
  local_var_path = "/system/mycompany/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(['application/json'])

  # form parameters
  form_params = {}

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