Class: ConnectWise::PortalConfigurationPasswordEmailSetupsApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ PortalConfigurationPasswordEmailSetupsApi

Returns a new instance of PortalConfigurationPasswordEmailSetupsApi.



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

def api_client
  @api_client
end

Instance Method Details

#system_portal_configurations_id_password_email_setups_get(id, opts = {}) ⇒ Array<PortalConfigurationPasswordEmailSetup>

Get Portal Configuration Password Email Setup

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:



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

def system_portal_configurations_id_password_email_setups_get(id, opts = {})
  data, _status_code, _headers = system_portal_configurations_id_password_email_setups_get_with_http_info(id, opts)
  return data
end

#system_portal_configurations_id_password_email_setups_get_with_http_info(id, opts = {}) ⇒ Array<(Array<PortalConfigurationPasswordEmailSetup>, Fixnum, Hash)>

Get Portal Configuration Password Email Setup

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:



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
76
77
78
79
80
81
 
# File 'lib/connectwise-ruby-sdk/api/portal_configuration_password_email_setups_api.rb', line 39

def system_portal_configurations_id_password_email_setups_get_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PortalConfigurationPasswordEmailSetupsApi.system_portal_configurations_id_password_email_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 PortalConfigurationPasswordEmailSetupsApi.system_portal_configurations_id_password_email_setups_get"
  end
  # resource path
  local_var_path = "/system/portalConfigurations/{id}/passwordEmailSetups".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<PortalConfigurationPasswordEmailSetup>')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PortalConfigurationPasswordEmailSetupsApi#system_portal_configurations_id_password_email_setups_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_portal_configurations_id_password_email_setups_password_email_setup_id_get(id, password_email_setup_id, opts = {}) ⇒ PortalConfigurationPasswordEmailSetup

Get Portal Configuration Password Email Setup

Parameters:

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

    the optional parameters

Returns:



89
90
91
92
 
# File 'lib/connectwise-ruby-sdk/api/portal_configuration_password_email_setups_api.rb', line 89

def system_portal_configurations_id_password_email_setups_password_email_setup_id_get(id, password_email_setup_id, opts = {})
  data, _status_code, _headers = system_portal_configurations_id_password_email_setups_password_email_setup_id_get_with_http_info(id, password_email_setup_id, opts)
  return data
end

#system_portal_configurations_id_password_email_setups_password_email_setup_id_get_with_http_info(id, password_email_setup_id, opts = {}) ⇒ Array<(PortalConfigurationPasswordEmailSetup, Fixnum, Hash)>

Get Portal Configuration Password Email Setup

Parameters:

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

    the optional parameters

Returns:



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
138
139
140
 
# File 'lib/connectwise-ruby-sdk/api/portal_configuration_password_email_setups_api.rb', line 100

def system_portal_configurations_id_password_email_setups_password_email_setup_id_get_with_http_info(id, password_email_setup_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PortalConfigurationPasswordEmailSetupsApi.system_portal_configurations_id_password_email_setups_password_email_setup_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 PortalConfigurationPasswordEmailSetupsApi.system_portal_configurations_id_password_email_setups_password_email_setup_id_get"
  end
  # verify the required parameter 'password_email_setup_id' is set
  if @api_client.config.client_side_validation && password_email_setup_id.nil?
    fail ArgumentError, "Missing the required parameter 'password_email_setup_id' when calling PortalConfigurationPasswordEmailSetupsApi.system_portal_configurations_id_password_email_setups_password_email_setup_id_get"
  end
  # resource path
  local_var_path = "/system/portalConfigurations/{id}/passwordEmailSetups/{passwordEmailSetupId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'passwordEmailSetupId' + '}', password_email_setup_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 => 'PortalConfigurationPasswordEmailSetup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PortalConfigurationPasswordEmailSetupsApi#system_portal_configurations_id_password_email_setups_password_email_setup_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_portal_configurations_id_password_email_setups_password_email_setup_id_patch(id, password_email_setup_id, operations, opts = {}) ⇒ PortalConfigurationPasswordEmailSetup

Update Portal Configuration Password Email Setup

Parameters:

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

    the optional parameters

Returns:



149
150
151
152
 
# File 'lib/connectwise-ruby-sdk/api/portal_configuration_password_email_setups_api.rb', line 149

def system_portal_configurations_id_password_email_setups_password_email_setup_id_patch(id, password_email_setup_id, operations, opts = {})
  data, _status_code, _headers = system_portal_configurations_id_password_email_setups_password_email_setup_id_patch_with_http_info(id, password_email_setup_id, operations, opts)
  return data
end

#system_portal_configurations_id_password_email_setups_password_email_setup_id_patch_with_http_info(id, password_email_setup_id, operations, opts = {}) ⇒ Array<(PortalConfigurationPasswordEmailSetup, Fixnum, Hash)>

Update Portal Configuration Password Email Setup

Parameters:

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

    the optional parameters

Returns:



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
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/connectwise-ruby-sdk/api/portal_configuration_password_email_setups_api.rb', line 161

def system_portal_configurations_id_password_email_setups_password_email_setup_id_patch_with_http_info(id, password_email_setup_id, operations, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PortalConfigurationPasswordEmailSetupsApi.system_portal_configurations_id_password_email_setups_password_email_setup_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 PortalConfigurationPasswordEmailSetupsApi.system_portal_configurations_id_password_email_setups_password_email_setup_id_patch"
  end
  # verify the required parameter 'password_email_setup_id' is set
  if @api_client.config.client_side_validation && password_email_setup_id.nil?
    fail ArgumentError, "Missing the required parameter 'password_email_setup_id' when calling PortalConfigurationPasswordEmailSetupsApi.system_portal_configurations_id_password_email_setups_password_email_setup_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 PortalConfigurationPasswordEmailSetupsApi.system_portal_configurations_id_password_email_setups_password_email_setup_id_patch"
  end
  # resource path
  local_var_path = "/system/portalConfigurations/{id}/passwordEmailSetups/{passwordEmailSetupId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'passwordEmailSetupId' + '}', password_email_setup_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 => 'PortalConfigurationPasswordEmailSetup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PortalConfigurationPasswordEmailSetupsApi#system_portal_configurations_id_password_email_setups_password_email_setup_id_patch\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_portal_configurations_id_password_email_setups_password_email_setup_id_put(id, password_email_setup_id, password_email_setup, opts = {}) ⇒ PortalConfigurationPasswordEmailSetup

Replace Portal Configuration Password Email Setup

Parameters:

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

    the optional parameters

Returns:



216
217
218
219
 
# File 'lib/connectwise-ruby-sdk/api/portal_configuration_password_email_setups_api.rb', line 216

def system_portal_configurations_id_password_email_setups_password_email_setup_id_put(id, password_email_setup_id, password_email_setup, opts = {})
  data, _status_code, _headers = system_portal_configurations_id_password_email_setups_password_email_setup_id_put_with_http_info(id, password_email_setup_id, password_email_setup, opts)
  return data
end

#system_portal_configurations_id_password_email_setups_password_email_setup_id_put_with_http_info(id, password_email_setup_id, password_email_setup, opts = {}) ⇒ Array<(PortalConfigurationPasswordEmailSetup, Fixnum, Hash)>

Replace Portal Configuration Password Email Setup

Parameters:

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

    the optional parameters

Returns:



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
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/connectwise-ruby-sdk/api/portal_configuration_password_email_setups_api.rb', line 228

def system_portal_configurations_id_password_email_setups_password_email_setup_id_put_with_http_info(id, password_email_setup_id, password_email_setup, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: PortalConfigurationPasswordEmailSetupsApi.system_portal_configurations_id_password_email_setups_password_email_setup_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 PortalConfigurationPasswordEmailSetupsApi.system_portal_configurations_id_password_email_setups_password_email_setup_id_put"
  end
  # verify the required parameter 'password_email_setup_id' is set
  if @api_client.config.client_side_validation && password_email_setup_id.nil?
    fail ArgumentError, "Missing the required parameter 'password_email_setup_id' when calling PortalConfigurationPasswordEmailSetupsApi.system_portal_configurations_id_password_email_setups_password_email_setup_id_put"
  end
  # verify the required parameter 'password_email_setup' is set
  if @api_client.config.client_side_validation && password_email_setup.nil?
    fail ArgumentError, "Missing the required parameter 'password_email_setup' when calling PortalConfigurationPasswordEmailSetupsApi.system_portal_configurations_id_password_email_setups_password_email_setup_id_put"
  end
  # resource path
  local_var_path = "/system/portalConfigurations/{id}/passwordEmailSetups/{passwordEmailSetupId}".sub('{' + 'id' + '}', id.to_s).sub('{' + 'passwordEmailSetupId' + '}', password_email_setup_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(password_email_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 => 'PortalConfigurationPasswordEmailSetup')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: PortalConfigurationPasswordEmailSetupsApi#system_portal_configurations_id_password_email_setups_password_email_setup_id_put\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end