class ConnectWise::PortalConfigurationPasswordEmailSetupsApi
Attributes
Public Class Methods
# 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
Public Instance Methods
Get Portal Configuration
Password Email Setup @param id @param [Hash] opts the optional parameters @option opts [String] :conditions @option opts [String] :order_by @option opts [String] :childconditions @option opts [String] :customfieldconditions @option opts [Integer] :page @option opts [Integer] :page_size @return [Array<PortalConfigurationPasswordEmailSetup>]
# 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
Get Portal Configuration
Password Email Setup @param id @param [Hash] opts the optional parameters @option opts [String] :conditions @option opts [String] :order_by @option opts [String] :childconditions @option opts [String] :customfieldconditions @option opts [Integer] :page @option opts [Integer] :page_size @return [Array<(Array<PortalConfigurationPasswordEmailSetup>, Fixnum, Hash)>] Array<PortalConfigurationPasswordEmailSetup> data, response status code and response headers
# 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
Get Portal Configuration
Password Email Setup @param id @param password_email_setup_id @param [Hash] opts the optional parameters @return [PortalConfigurationPasswordEmailSetup]
# 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
Get Portal Configuration
Password Email Setup @param id @param password_email_setup_id @param [Hash] opts the optional parameters @return [Array<(PortalConfigurationPasswordEmailSetup
, Fixnum, Hash)>] PortalConfigurationPasswordEmailSetup
data, response status code and response headers
# 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
Update Portal Configuration
Password Email Setup @param id @param password_email_setup_id @param operations @param [Hash] opts the optional parameters @return [PortalConfigurationPasswordEmailSetup]
# 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
Update Portal Configuration
Password Email Setup @param id @param password_email_setup_id @param operations @param [Hash] opts the optional parameters @return [Array<(PortalConfigurationPasswordEmailSetup
, Fixnum, Hash)>] PortalConfigurationPasswordEmailSetup
data, response status code and response headers
# 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
Replace Portal Configuration
Password Email Setup @param id @param password_email_setup_id @param password_email_setup @param [Hash] opts the optional parameters @return [PortalConfigurationPasswordEmailSetup]
# 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
Replace Portal Configuration
Password Email Setup @param id @param password_email_setup_id @param password_email_setup @param [Hash] opts the optional parameters @return [Array<(PortalConfigurationPasswordEmailSetup
, Fixnum, Hash)>] PortalConfigurationPasswordEmailSetup
data, response status code and response headers
# 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