Class: SendX::GettingStartedApi
- Inherits:
-
Object
- Object
- SendX::GettingStartedApi
- Defined in:
- lib/sendx-ruby-sdk/api/getting_started_api.rb
Instance Attribute Summary collapse
-
#api_client ⇒ Object
Returns the value of attribute api_client.
Instance Method Summary collapse
-
#identify_contact(identify_request, opts = {}) ⇒ IdentifyResponse
Identify contact Identify a contact by email address.
-
#identify_contact_with_http_info(identify_request, opts = {}) ⇒ Array<(IdentifyResponse, Integer, Hash)>
Identify contact Identify a contact by email address.
-
#initialize(api_client = ApiClient.default) ⇒ GettingStartedApi
constructor
A new instance of GettingStartedApi.
-
#tracking_contact(track_request, opts = {}) ⇒ TrackResponse
Add Tracking info Track a contact.
-
#tracking_contact_with_http_info(track_request, opts = {}) ⇒ Array<(TrackResponse, Integer, Hash)>
Add Tracking info Track a contact.
Constructor Details
#initialize(api_client = ApiClient.default) ⇒ GettingStartedApi
Returns a new instance of GettingStartedApi.
19 20 21 |
# File 'lib/sendx-ruby-sdk/api/getting_started_api.rb', line 19 def initialize(api_client = ApiClient.default) @api_client = api_client end |
Instance Attribute Details
#api_client ⇒ Object
Returns the value of attribute api_client.
17 18 19 |
# File 'lib/sendx-ruby-sdk/api/getting_started_api.rb', line 17 def api_client @api_client end |
Instance Method Details
#identify_contact(identify_request, opts = {}) ⇒ IdentifyResponse
Identify contact Identify a contact by email address. If the contact already exists, it will be updated.
27 28 29 30 |
# File 'lib/sendx-ruby-sdk/api/getting_started_api.rb', line 27 def identify_contact(identify_request, opts = {}) data, _status_code, _headers = identify_contact_with_http_info(identify_request, opts) data end |
#identify_contact_with_http_info(identify_request, opts = {}) ⇒ Array<(IdentifyResponse, Integer, Hash)>
Identify contact Identify a contact by email address. If the contact already exists, it will be updated.
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 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 |
# File 'lib/sendx-ruby-sdk/api/getting_started_api.rb', line 37 def identify_contact_with_http_info(identify_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: GettingStartedApi.identify_contact ...' end # verify the required parameter 'identify_request' is set if @api_client.config.client_side_validation && identify_request.nil? fail ArgumentError, "Missing the required parameter 'identify_request' when calling GettingStartedApi.identify_contact" end # resource path local_var_path = '/contact/identify' # 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']) unless header_params['Accept'] # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(identify_request) # return_type return_type = opts[:debug_return_type] || 'IdentifyResponse' # auth_names auth_names = opts[:debug_auth_names] || ['apiKeyAuth'] = opts.merge( :operation => :"GettingStartedApi.identify_contact", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: GettingStartedApi#identify_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |
#tracking_contact(track_request, opts = {}) ⇒ TrackResponse
Add Tracking info Track a contact
95 96 97 98 |
# File 'lib/sendx-ruby-sdk/api/getting_started_api.rb', line 95 def tracking_contact(track_request, opts = {}) data, _status_code, _headers = tracking_contact_with_http_info(track_request, opts) data end |
#tracking_contact_with_http_info(track_request, opts = {}) ⇒ Array<(TrackResponse, Integer, Hash)>
Add Tracking info Track a contact
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 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 |
# File 'lib/sendx-ruby-sdk/api/getting_started_api.rb', line 105 def tracking_contact_with_http_info(track_request, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: GettingStartedApi.tracking_contact ...' end # verify the required parameter 'track_request' is set if @api_client.config.client_side_validation && track_request.nil? fail ArgumentError, "Missing the required parameter 'track_request' when calling GettingStartedApi.tracking_contact" end # resource path local_var_path = '/contact/track' # 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']) unless header_params['Accept'] # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(track_request) # return_type return_type = opts[:debug_return_type] || 'TrackResponse' # auth_names auth_names = opts[:debug_auth_names] || ['apiKeyAuth'] = opts.merge( :operation => :"GettingStartedApi.tracking_contact", :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, ) if @api_client.config.debugging @api_client.config.logger.debug "API called: GettingStartedApi#tracking_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end |