class MailSlurpClient::TrackingControllerApi
Attributes
Public Class Methods
# File lib/mailslurp_client/api/tracking_controller_api.rb, line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Create tracking pixel Create a tracking pixel. A tracking pixel is an image that can be embedded in an email. When the email is viewed and the image is seen MailSlurp will mark the pixel as seen. Use tracking pixels to monitor email open events. You can receive open notifications via webhook or by fetching the pixel. @param create_tracking_pixel_options [CreateTrackingPixelOptions] createTrackingPixelOptions @param [Hash] opts the optional parameters @return [TrackingPixelDto]
# File lib/mailslurp_client/api/tracking_controller_api.rb, line 27 def create_tracking_pixel(create_tracking_pixel_options, opts = {}) data, _status_code, _headers = create_tracking_pixel_with_http_info(create_tracking_pixel_options, opts) data end
Create tracking pixel Create a tracking pixel. A tracking pixel is an image that can be embedded in an email. When the email is viewed and the image is seen MailSlurp will mark the pixel as seen. Use tracking pixels to monitor email open events. You can receive open notifications via webhook or by fetching the pixel. @param create_tracking_pixel_options [CreateTrackingPixelOptions] createTrackingPixelOptions @param [Hash] opts the optional parameters @return [Array<(TrackingPixelDto
, Integer, Hash)>] TrackingPixelDto
data, response status code and response headers
# File lib/mailslurp_client/api/tracking_controller_api.rb, line 37 def create_tracking_pixel_with_http_info(create_tracking_pixel_options, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TrackingControllerApi.create_tracking_pixel ...' end # verify the required parameter 'create_tracking_pixel_options' is set if @api_client.config.client_side_validation && create_tracking_pixel_options.nil? fail ArgumentError, "Missing the required parameter 'create_tracking_pixel_options' when calling TrackingControllerApi.create_tracking_pixel" end # resource path local_var_path = '/tracking/pixels' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[: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 = opts[:form_params] || {} # http body (model) post_body = opts[:body] || @api_client.object_to_http_body(create_tracking_pixel_options) # return_type return_type = opts[:return_type] || 'TrackingPixelDto' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: TrackingControllerApi#create_tracking_pixel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get tracking pixels List tracking pixels in paginated form @param [Hash] opts the optional parameters @option opts [DateTime] :before Filter by created at before the given timestamp @option opts [Integer] :page Optional page index in list pagination (default to 0) @option opts [String] :search_filter Optional search filter @option opts [DateTime] :since Filter by created at after the given timestamp @option opts [Integer] :size Optional page size in list pagination (default to 20) @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC') @return [PageTrackingPixelProjection]
# File lib/mailslurp_client/api/tracking_controller_api.rb, line 96 def get_all_tracking_pixels(opts = {}) data, _status_code, _headers = get_all_tracking_pixels_with_http_info(opts) data end
Get tracking pixels List tracking pixels in paginated form @param [Hash] opts the optional parameters @option opts [DateTime] :before Filter by created at before the given timestamp @option opts [Integer] :page Optional page index in list pagination @option opts [String] :search_filter Optional search filter @option opts [DateTime] :since Filter by created at after the given timestamp @option opts [Integer] :size Optional page size in list pagination @option opts [String] :sort Optional createdAt sort direction ASC or DESC @return [Array<(PageTrackingPixelProjection
, Integer, Hash)>] PageTrackingPixelProjection
data, response status code and response headers
# File lib/mailslurp_client/api/tracking_controller_api.rb, line 111 def get_all_tracking_pixels_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TrackingControllerApi.get_all_tracking_pixels ...' end allowable_values = ["ASC", "DESC"] if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort']) fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}" end # resource path local_var_path = '/tracking/pixels' # query parameters query_params = opts[:query_params] || {} query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil? query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil? query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil? query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil? query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'PageTrackingPixelProjection' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: TrackingControllerApi#get_all_tracking_pixels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get pixel @param id [String] id @param [Hash] opts the optional parameters @return [TrackingPixelDto]
# File lib/mailslurp_client/api/tracking_controller_api.rb, line 168 def get_tracking_pixel(id, opts = {}) data, _status_code, _headers = get_tracking_pixel_with_http_info(id, opts) data end
Get pixel @param id [String] id @param [Hash] opts the optional parameters @return [Array<(TrackingPixelDto
, Integer, Hash)>] TrackingPixelDto
data, response status code and response headers
# File lib/mailslurp_client/api/tracking_controller_api.rb, line 177 def get_tracking_pixel_with_http_info(id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: TrackingControllerApi.get_tracking_pixel ...' 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 TrackingControllerApi.get_tracking_pixel" end # resource path local_var_path = '/tracking/pixels/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:body] # return_type return_type = opts[:return_type] || 'TrackingPixelDto' # auth_names auth_names = opts[:auth_names] || ['API_KEY'] new_options = opts.merge( :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: TrackingControllerApi#get_tracking_pixel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end