class Bfwd::EmailprovidersApi
Attributes
Public Class Methods
# File lib/bf_ruby2/api/emailproviders_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Create an email provider. {"nickname":"Create an email provider","request":"createEmailProviderRequest.html","response":"creatEmailProviderResponse.html"} @param request . @param [Hash] opts the optional parameters @return [EmailProviderPagedMetadata]
# File lib/bf_ruby2/api/emailproviders_api.rb, line 28 def create_email_provider(request, opts = {}) data, _status_code, _headers = create_email_provider_with_http_info(request, opts) return data end
Create an email provider. {"nickname":"Create an email provider","request":"createEmailProviderRequest.html","response":"creatEmailProviderResponse.html"} @param request . @param [Hash] opts the optional parameters @return [Array<(EmailProviderPagedMetadata
, Fixnum, Hash)>] EmailProviderPagedMetadata
data, response status code and response headers
# File lib/bf_ruby2/api/emailproviders_api.rb, line 38 def create_email_provider_with_http_info(request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: EmailprovidersApi.create_email_provider ..." end # verify the required parameter 'request' is set if @api_client.config.client_side_validation && request.nil? fail ArgumentError, "Missing the required parameter 'request' when calling EmailprovidersApi.create_email_provider" end # resource path local_var_path = "/email-providers" # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8']) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(request) auth_names = [] 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 => 'EmailProviderPagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: EmailprovidersApi#create_email_provider\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Deletes a single email provider, specified by id or name parameter. { "nickname" : "delete","response" : "deleteEmailProvider.html"} @param email_provider_id @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @return [EmailProviderPagedMetadata]
# File lib/bf_ruby2/api/emailproviders_api.rb, line 84 def delete(email_provider_id, opts = {}) data, _status_code, _headers = delete_with_http_info(email_provider_id, opts) return data end
Deletes a single email provider, specified by id or name parameter. { "nickname" : "delete","response" : "deleteEmailProvider.html"} @param email_provider_id @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @return [Array<(EmailProviderPagedMetadata
, Fixnum, Hash)>] EmailProviderPagedMetadata
data, response status code and response headers
# File lib/bf_ruby2/api/emailproviders_api.rb, line 95 def delete_with_http_info(email_provider_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: EmailprovidersApi.delete ..." end # verify the required parameter 'email_provider_id' is set if @api_client.config.client_side_validation && email_provider_id.nil? fail ArgumentError, "Missing the required parameter 'email_provider_id' when calling EmailprovidersApi.delete" end # resource path local_var_path = "/email-providers/{email-provider-ID}".sub('{' + 'email-provider-ID' + '}', email_provider_id.to_s) # query parameters query_params = {} query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] 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, :return_type => 'EmailProviderPagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: EmailprovidersApi#delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Returns a collection of all email-providers. By default 10 values are returned. Records are returned in natural order. {"nickname":"Get all email providers","response":"getEmailProvidersAll.html"} @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @option opts [Integer] :offset The offset from the first email-provider to return. (default to 0) @option opts [Integer] :records The maximum number of email-provider to return. (default to 10) @option opts [String] :order_by Specify a field used to order the result set. (default to created) @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. (default to DESC) @option opts [BOOLEAN] :include_retired Include deleted email-providers (default to false) @return [EmailProviderPagedMetadata]
# File lib/bf_ruby2/api/emailproviders_api.rb, line 146 def get_all_email_providers(opts = {}) data, _status_code, _headers = get_all_email_providers_with_http_info(opts) return data end
Returns a collection of all email-providers. By default 10 values are returned. Records are returned in natural order. {"nickname":"Get all email providers","response":"getEmailProvidersAll.html"} @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @option opts [Integer] :offset The offset from the first email-provider to return. @option opts [Integer] :records The maximum number of email-provider to return. @option opts [String] :order_by Specify a field used to order the result set. @option opts [String] :order Ihe direction of any ordering, either ASC or DESC. @option opts [BOOLEAN] :include_retired Include deleted email-providers @return [Array<(EmailProviderPagedMetadata
, Fixnum, Hash)>] EmailProviderPagedMetadata
data, response status code and response headers
# File lib/bf_ruby2/api/emailproviders_api.rb, line 161 def get_all_email_providers_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: EmailprovidersApi.get_all_email_providers ..." end if @api_client.config.client_side_validation && opts[:'order'] && !['ASC', 'DESC'].include?(opts[:'order']) fail ArgumentError, 'invalid value for "order", must be one of ASC, DESC' end # resource path local_var_path = "/email-providers" # query parameters query_params = {} query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil? query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil? query_params[:'records'] = opts[:'records'] if !opts[:'records'].nil? query_params[:'order_by'] = opts[:'order_by'] if !opts[:'order_by'].nil? query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil? query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] 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 => 'EmailProviderPagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: EmailprovidersApi#get_all_email_providers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Retrieves a single email provider, specified by the version-ID parameter. { "nickname" : "Retrieve by version","response" : "getEmailProviderByID.html"} @param email_provider_id @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @option opts [BOOLEAN] :include_retired Include deleted email-providers (default to false) @return [EmailProviderPagedMetadata]
# File lib/bf_ruby2/api/emailproviders_api.rb, line 211 def get_email_by_provider_id(email_provider_id, opts = {}) data, _status_code, _headers = get_email_by_provider_id_with_http_info(email_provider_id, opts) return data end
Retrieves a single email provider, specified by the version-ID parameter. { "nickname" : "Retrieve by version","response" : "getEmailProviderByID.html"} @param email_provider_id @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @option opts [BOOLEAN] :include_retired Include deleted email-providers @return [Array<(EmailProviderPagedMetadata
, Fixnum, Hash)>] EmailProviderPagedMetadata
data, response status code and response headers
# File lib/bf_ruby2/api/emailproviders_api.rb, line 223 def get_email_by_provider_id_with_http_info(email_provider_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: EmailprovidersApi.get_email_by_provider_id ..." end # verify the required parameter 'email_provider_id' is set if @api_client.config.client_side_validation && email_provider_id.nil? fail ArgumentError, "Missing the required parameter 'email_provider_id' when calling EmailprovidersApi.get_email_by_provider_id" end # resource path local_var_path = "/email-providers/{email-provider-ID}".sub('{' + 'email-provider-ID' + '}', email_provider_id.to_s) # query parameters query_params = {} query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil? query_params[:'include_retired'] = opts[:'include_retired'] if !opts[:'include_retired'].nil? # header parameters header_params = {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8']) # HTTP header 'Content-Type' header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain']) # form parameters form_params = {} # http body (model) post_body = nil auth_names = [] 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 => 'EmailProviderPagedMetadata') if @api_client.config.debugging @api_client.config.logger.debug "API called: EmailprovidersApi#get_email_by_provider_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end