Class: ConnectWise::PortalConfigurationProjectSetupsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PortalConfigurationProjectSetupsApi

Returns a new instance of PortalConfigurationProjectSetupsApi.



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

def api_client
  @api_client
end

Instance Method Details

#system_portal_configurations_id_project_setups_count_get(id, opts = {}) ⇒ Count

Get Portal Configuration Project Setups Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)

Returns:



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

def system_portal_configurations_id_project_setups_count_get(id, opts = {})
  data, _status_code, _headers = system_portal_configurations_id_project_setups_count_get_with_http_info(id, opts)
  return data
end

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

Get Portal Configuration Project Setups Count

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :conditions (String)

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/portal_configuration_project_setups_api.rb', line 29

def system_portal_configurations_id_project_setups_count_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PortalConfigurationProjectSetupsApi.system_portal_configurations_id_project_setups_count_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 PortalConfigurationProjectSetupsApi.system_portal_configurations_id_project_setups_count_get"
  end
  # resource path
  local_var_path = "/system/portalConfigurations/{id}/projectSetups/count".sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}
  query_params[:'conditions'] = opts[:'conditions'] if !opts[:'conditions'].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: PortalConfigurationProjectSetupsApi#system_portal_configurations_id_project_setups_count_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_portal_configurations_id_project_setups_get(id, opts = {}) ⇒ Array<PortalConfigurationProjectSetup>

Get Portal Configuration Project Setups

Parameters:

  • id
  • 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:



79
80
81
82
 
# File 'lib/connectwise-ruby-sdk/api/portal_configuration_project_setups_api.rb', line 79

def system_portal_configurations_id_project_setups_get(id, opts = {})
  data, _status_code, _headers = system_portal_configurations_id_project_setups_get_with_http_info(id, opts)
  return data
end

#system_portal_configurations_id_project_setups_get_with_http_info(id, opts = {}) ⇒ Array<(Array<PortalConfigurationProjectSetup>, Fixnum, Hash)>

Get Portal Configuration Project Setups

Parameters:

  • id
  • 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<PortalConfigurationProjectSetup>, Fixnum, Hash)>) —

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



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
130
131
132
133
134
135
136
137
 
# File 'lib/connectwise-ruby-sdk/api/portal_configuration_project_setups_api.rb', line 95

def system_portal_configurations_id_project_setups_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PortalConfigurationProjectSetupsApi.system_portal_configurations_id_project_setups_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 PortalConfigurationProjectSetupsApi.system_portal_configurations_id_project_setups_get"
  end
  # resource path
  local_var_path = "/system/portalConfigurations/{id}/projectSetups".sub('{' + 'id' + '}', id.to_s)

  # 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<PortalConfigurationProjectSetup>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PortalConfigurationProjectSetupsApi#system_portal_configurations_id_project_setups_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_portal_configurations_id_project_setups_portal_configuration_id_get(id, portal_configuration_id, opts = {}) ⇒ PortalConfigurationProjectSetup

Get Portal Configuration Project Setup By Id

Parameters:

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

    the optional parameters

Returns:



145
146
147
148
 
# File 'lib/connectwise-ruby-sdk/api/portal_configuration_project_setups_api.rb', line 145

def system_portal_configurations_id_project_setups_portal_configuration_id_get(id, portal_configuration_id, opts = {})
  data, _status_code, _headers = system_portal_configurations_id_project_setups_portal_configuration_id_get_with_http_info(id, portal_configuration_id, opts)
  return data
end

#system_portal_configurations_id_project_setups_portal_configuration_id_get_with_http_info(id, portal_configuration_id, opts = {}) ⇒ Array<(PortalConfigurationProjectSetup, Fixnum, Hash)>

Get Portal Configuration Project Setup By Id

Parameters:

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

    the optional parameters

Returns:



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
190
191
192
193
194
195
196
 
# File 'lib/connectwise-ruby-sdk/api/portal_configuration_project_setups_api.rb', line 156

def system_portal_configurations_id_project_setups_portal_configuration_id_get_with_http_info(id, portal_configuration_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PortalConfigurationProjectSetupsApi.system_portal_configurations_id_project_setups_portal_configuration_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 PortalConfigurationProjectSetupsApi.system_portal_configurations_id_project_setups_portal_configuration_id_get"
  end
  # verify the required parameter 'portal_configuration_id' is set
  if @api_client.config.client_side_validation && portal_configuration_id.nil?
    fail ArgumentError, "Missing the required parameter 'portal_configuration_id' when calling PortalConfigurationProjectSetupsApi.system_portal_configurations_id_project_setups_portal_configuration_id_get"
  end
  # resource path
  local_var_path = "/system/portalConfigurations/{id}/projectSetups/{portalConfigurationId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'portalConfigurationId' + '}', portal_configuration_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 => 'PortalConfigurationProjectSetup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PortalConfigurationProjectSetupsApi#system_portal_configurations_id_project_setups_portal_configuration_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_portal_configurations_id_project_setups_portal_configuration_id_patch(id, portal_configuration_id, operations, opts = {}) ⇒ PortalConfigurationProjectSetup

Update Portal Configuration Project Setup

Parameters:

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

    the optional parameters

Returns:



205
206
207
208
 
# File 'lib/connectwise-ruby-sdk/api/portal_configuration_project_setups_api.rb', line 205

def system_portal_configurations_id_project_setups_portal_configuration_id_patch(id, portal_configuration_id, operations, opts = {})
  data, _status_code, _headers = system_portal_configurations_id_project_setups_portal_configuration_id_patch_with_http_info(id, portal_configuration_id, operations, opts)
  return data
end

#system_portal_configurations_id_project_setups_portal_configuration_id_patch_with_http_info(id, portal_configuration_id, operations, opts = {}) ⇒ Array<(PortalConfigurationProjectSetup, Fixnum, Hash)>

Update Portal Configuration Project Setup

Parameters:

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

    the optional parameters

Returns:



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
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/connectwise-ruby-sdk/api/portal_configuration_project_setups_api.rb', line 217

def system_portal_configurations_id_project_setups_portal_configuration_id_patch_with_http_info(id, portal_configuration_id, operations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PortalConfigurationProjectSetupsApi.system_portal_configurations_id_project_setups_portal_configuration_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 PortalConfigurationProjectSetupsApi.system_portal_configurations_id_project_setups_portal_configuration_id_patch"
  end
  # verify the required parameter 'portal_configuration_id' is set
  if @api_client.config.client_side_validation && portal_configuration_id.nil?
    fail ArgumentError, "Missing the required parameter 'portal_configuration_id' when calling PortalConfigurationProjectSetupsApi.system_portal_configurations_id_project_setups_portal_configuration_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 PortalConfigurationProjectSetupsApi.system_portal_configurations_id_project_setups_portal_configuration_id_patch"
  end
  # resource path
  local_var_path = "/system/portalConfigurations/{id}/projectSetups/{portalConfigurationId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'portalConfigurationId' + '}', portal_configuration_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 => 'PortalConfigurationProjectSetup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PortalConfigurationProjectSetupsApi#system_portal_configurations_id_project_setups_portal_configuration_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_portal_configurations_id_project_setups_portal_configuration_id_put(id, portal_configuration_id, portal_configuration_project_setup, opts = {}) ⇒ PortalConfigurationProjectSetup

Replace Portal Configuration Project Setup

Parameters:

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

    the optional parameters

Returns:



272
273
274
275
 
# File 'lib/connectwise-ruby-sdk/api/portal_configuration_project_setups_api.rb', line 272

def system_portal_configurations_id_project_setups_portal_configuration_id_put(id, portal_configuration_id, portal_configuration_project_setup, opts = {})
  data, _status_code, _headers = system_portal_configurations_id_project_setups_portal_configuration_id_put_with_http_info(id, portal_configuration_id, portal_configuration_project_setup, opts)
  return data
end

#system_portal_configurations_id_project_setups_portal_configuration_id_put_with_http_info(id, portal_configuration_id, portal_configuration_project_setup, opts = {}) ⇒ Array<(PortalConfigurationProjectSetup, Fixnum, Hash)>

Replace Portal Configuration Project Setup

Parameters:

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

    the optional parameters

Returns:



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/connectwise-ruby-sdk/api/portal_configuration_project_setups_api.rb', line 284

def system_portal_configurations_id_project_setups_portal_configuration_id_put_with_http_info(id, portal_configuration_id, portal_configuration_project_setup, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PortalConfigurationProjectSetupsApi.system_portal_configurations_id_project_setups_portal_configuration_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 PortalConfigurationProjectSetupsApi.system_portal_configurations_id_project_setups_portal_configuration_id_put"
  end
  # verify the required parameter 'portal_configuration_id' is set
  if @api_client.config.client_side_validation && portal_configuration_id.nil?
    fail ArgumentError, "Missing the required parameter 'portal_configuration_id' when calling PortalConfigurationProjectSetupsApi.system_portal_configurations_id_project_setups_portal_configuration_id_put"
  end
  # verify the required parameter 'portal_configuration_project_setup' is set
  if @api_client.config.client_side_validation && portal_configuration_project_setup.nil?
    fail ArgumentError, "Missing the required parameter 'portal_configuration_project_setup' when calling PortalConfigurationProjectSetupsApi.system_portal_configurations_id_project_setups_portal_configuration_id_put"
  end
  # resource path
  local_var_path = "/system/portalConfigurations/{id}/projectSetups/{portalConfigurationId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'portalConfigurationId' + '}', portal_configuration_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(portal_configuration_project_setup)
  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 => 'PortalConfigurationProjectSetup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PortalConfigurationProjectSetupsApi#system_portal_configurations_id_project_setups_portal_configuration_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end