sendx-ruby-sdk 1.0.2 → 1.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +18 -6
  3. data/lib/sendx-ruby-sdk/api/campaign_api.rb +1 -1
  4. data/lib/sendx-ruby-sdk/api/contact_api.rb +1 -1
  5. data/lib/sendx-ruby-sdk/api/event_api.rb +158 -0
  6. data/lib/sendx-ruby-sdk/api/getting_started_api.rb +158 -0
  7. data/lib/sendx-ruby-sdk/api/list_api.rb +1 -1
  8. data/lib/sendx-ruby-sdk/api/reports_api.rb +1 -1
  9. data/lib/sendx-ruby-sdk/api/sender_api.rb +1 -1
  10. data/lib/sendx-ruby-sdk/api/tags_api.rb +1 -1
  11. data/lib/sendx-ruby-sdk/api_client.rb +1 -1
  12. data/lib/sendx-ruby-sdk/api_error.rb +1 -1
  13. data/lib/sendx-ruby-sdk/configuration.rb +1 -1
  14. data/lib/sendx-ruby-sdk/models/campaign.rb +1 -1
  15. data/lib/sendx-ruby-sdk/models/campaign_dashboard_data.rb +1 -1
  16. data/lib/sendx-ruby-sdk/models/campaign_request.rb +1 -1
  17. data/lib/sendx-ruby-sdk/models/contact.rb +1 -1
  18. data/lib/sendx-ruby-sdk/models/contact_request.rb +1 -1
  19. data/lib/sendx-ruby-sdk/models/create_response.rb +1 -1
  20. data/lib/sendx-ruby-sdk/models/custom_event_request.rb +275 -0
  21. data/lib/sendx-ruby-sdk/models/dashboard_stats.rb +1 -1
  22. data/lib/sendx-ruby-sdk/models/delete_campaign200_response.rb +1 -1
  23. data/lib/sendx-ruby-sdk/models/delete_request.rb +1 -1
  24. data/lib/sendx-ruby-sdk/models/delete_response.rb +1 -1
  25. data/lib/sendx-ruby-sdk/models/event_response.rb +235 -0
  26. data/lib/sendx-ruby-sdk/models/identify_request.rb +284 -0
  27. data/lib/sendx-ruby-sdk/models/identify_response.rb +232 -0
  28. data/lib/sendx-ruby-sdk/models/last_sent_campaign_stat.rb +1 -1
  29. data/lib/sendx-ruby-sdk/models/list_model.rb +1 -1
  30. data/lib/sendx-ruby-sdk/models/list_request.rb +1 -1
  31. data/lib/sendx-ruby-sdk/models/report_data.rb +1 -1
  32. data/lib/sendx-ruby-sdk/models/response.rb +1 -1
  33. data/lib/sendx-ruby-sdk/models/revenue_event_request.rb +290 -0
  34. data/lib/sendx-ruby-sdk/models/sender.rb +1 -1
  35. data/lib/sendx-ruby-sdk/models/sender_request.rb +1 -1
  36. data/lib/sendx-ruby-sdk/models/sender_response.rb +1 -1
  37. data/lib/sendx-ruby-sdk/models/tag.rb +1 -1
  38. data/lib/sendx-ruby-sdk/models/tag_request.rb +1 -1
  39. data/lib/sendx-ruby-sdk/models/track_request.rb +237 -0
  40. data/lib/sendx-ruby-sdk/models/track_response.rb +223 -0
  41. data/lib/sendx-ruby-sdk/version.rb +2 -2
  42. data/lib/sendx-ruby-sdk.rb +10 -1
  43. data/spec/api/event_api_spec.rb +59 -0
  44. data/spec/api/getting_started_api_spec.rb +59 -0
  45. data/spec/models/custom_event_request_spec.rb +54 -0
  46. data/spec/models/event_response_spec.rb +48 -0
  47. data/spec/models/identify_request_spec.rb +72 -0
  48. data/spec/models/identify_response_spec.rb +48 -0
  49. data/spec/models/revenue_event_request_spec.rb +60 -0
  50. data/spec/models/track_request_spec.rb +48 -0
  51. data/spec/models/track_response_spec.rb +42 -0
  52. data/spec/spec_helper.rb +1 -1
  53. metadata +29 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3a42a2cd69e7b9ea8e4162a38183effa20ede3c7954be0281883f927d29387df
4
- data.tar.gz: 3831f17146ae2e3d23043f0e8ede428a85e8118b27c4c3cc2337a178d22f8472
3
+ metadata.gz: 38894a39717dc8728c8b8ed3378158e0519a994c3647a928f5c08e5db5f76126
4
+ data.tar.gz: 9e2d5e999d7ddd8b4b02c0f85a4231034e756a886058c3f1612e07f52567f0d8
5
5
  SHA512:
6
- metadata.gz: 9212032cb16a569bd2a394a1f87bb8e27b0fb08dc363b363d43f910b5413ff614a6e335d9dcec11930b9ff2fb3f885317d871daa1883c2aefc654709fe71f5ca
7
- data.tar.gz: 17bb196b661df70d5180214f73e90e9ff224df8eaab050bf36b44e3f9c116ee34d180b79d62f1c858d0287410b69b82f8270476663f2d8e9e1fd0c96e70cca7e
6
+ metadata.gz: bd677afcec408905aeba611e444b3a2eb56d44acc1357df892a0c6d2691798a2e14c23d857c4e52c960d5370b5edf6af1bb60173a838c53177a3c008bf8274f2
7
+ data.tar.gz: c6b1cdefe416359ac146ffe46b7f9c95bdc76f224905d2ded2d543402bfdc07ec67537df738b4942d4795ee35f3732b6203fa04685884e0e0e64aa9dc4399b57
data/README.md CHANGED
@@ -1,4 +1,5 @@
1
- # SendX Ruby SDK
1
+ # [SendX Ruby SDK](https://rubygems.org/gems/sendx-ruby-sdk)
2
+ [![Gem Version](https://badge.fury.io/rb/sendx-ruby-sdk.svg)](https://badge.fury.io/rb/sendx-ruby-sdk)
2
3
 
3
4
  SendX - the Ruby gem for the SendX REST API
4
5
 
@@ -26,7 +27,7 @@ Install via Gemfile
26
27
 
27
28
  ```ruby
28
29
  source "https://rubygems.pkg.github.com/sendx" do
29
- gem "sendx-ruby-sdk", "1.0.1"
30
+ gem "sendx-ruby-sdk", "1.1.0"
30
31
  end
31
32
  ```
32
33
 
@@ -96,11 +97,15 @@ Class | Method | HTTP request | Description
96
97
  *SendX::CampaignApi* | [**get_all_campaigns**](docs/CampaignApi.md#get_all_campaigns) | **GET** /campaign | Get All Campaigns
97
98
  *SendX::CampaignApi* | [**get_campaign_by_id**](docs/CampaignApi.md#get_campaign_by_id) | **GET** /campaign/{campaignId} | Get Campaign By Id
98
99
  *SendX::ContactApi* | [**create_contact**](docs/ContactApi.md#create_contact) | **POST** /contact | Create a contact
99
- *SendX::ContactApi* | [**delete_contact**](docs/ContactApi.md#delete_contact) | **DELETE** /contact/{contactId} | Delete Contact
100
+ *SendX::ContactApi* | [**delete_contact**](docs/ContactApi.md#delete_contact) | **DELETE** /contact/{identifier} | Delete Contact
100
101
  *SendX::ContactApi* | [**get_all_contacts**](docs/ContactApi.md#get_all_contacts) | **GET** /contact | Get All Contacts
101
- *SendX::ContactApi* | [**get_contact_by_id**](docs/ContactApi.md#get_contact_by_id) | **GET** /contact/{contactId} | Get Contact by ID
102
- *SendX::ContactApi* | [**unsubscribe_contact**](docs/ContactApi.md#unsubscribe_contact) | **POST** /contact/unsubscribe/{contactId} | Unsubscribe Contact
103
- *SendX::ContactApi* | [**update_contact**](docs/ContactApi.md#update_contact) | **PUT** /contact/{contactId} | Update Contact
102
+ *SendX::ContactApi* | [**get_contact_by_id**](docs/ContactApi.md#get_contact_by_id) | **GET** /contact/{identifier} | Get Contact by Identifier
103
+ *SendX::ContactApi* | [**unsubscribe_contact**](docs/ContactApi.md#unsubscribe_contact) | **POST** /contact/unsubscribe/{identifier} | Unsubscribe Contact
104
+ *SendX::ContactApi* | [**update_contact**](docs/ContactApi.md#update_contact) | **PUT** /contact/{identifier} | Update Contact
105
+ *SendX::EventApi* | [**create_revenue_event**](docs/EventApi.md#create_revenue_event) | **POST** /events/revenue | Record a revenue event for a specific contact
106
+ *SendX::EventApi* | [**push_custom_event**](docs/EventApi.md#push_custom_event) | **POST** /events/custom | Push a custom event associated with a contact
107
+ *SendX::GettingStartedApi* | [**identify_contact**](docs/GettingStartedApi.md#identify_contact) | **POST** /contact/identify | Identify contact
108
+ *SendX::GettingStartedApi* | [**tracking_contact**](docs/GettingStartedApi.md#tracking_contact) | **POST** /contact/track | Add Tracking info
104
109
  *SendX::ListApi* | [**create_list**](docs/ListApi.md#create_list) | **POST** /list | Create List
105
110
  *SendX::ListApi* | [**delete_list**](docs/ListApi.md#delete_list) | **DELETE** /list/{listId} | Delete List
106
111
  *SendX::ListApi* | [**get_all_lists**](docs/ListApi.md#get_all_lists) | **GET** /list | Get All Lists
@@ -124,20 +129,27 @@ Class | Method | HTTP request | Description
124
129
  - [SendX::Contact](docs/Contact.md)
125
130
  - [SendX::ContactRequest](docs/ContactRequest.md)
126
131
  - [SendX::CreateResponse](docs/CreateResponse.md)
132
+ - [SendX::CustomEventRequest](docs/CustomEventRequest.md)
127
133
  - [SendX::DashboardStats](docs/DashboardStats.md)
128
134
  - [SendX::DeleteCampaign200Response](docs/DeleteCampaign200Response.md)
129
135
  - [SendX::DeleteRequest](docs/DeleteRequest.md)
130
136
  - [SendX::DeleteResponse](docs/DeleteResponse.md)
137
+ - [SendX::EventResponse](docs/EventResponse.md)
138
+ - [SendX::IdentifyRequest](docs/IdentifyRequest.md)
139
+ - [SendX::IdentifyResponse](docs/IdentifyResponse.md)
131
140
  - [SendX::LastSentCampaignStat](docs/LastSentCampaignStat.md)
132
141
  - [SendX::ListModel](docs/ListModel.md)
133
142
  - [SendX::ListRequest](docs/ListRequest.md)
134
143
  - [SendX::ReportData](docs/ReportData.md)
135
144
  - [SendX::Response](docs/Response.md)
145
+ - [SendX::RevenueEventRequest](docs/RevenueEventRequest.md)
136
146
  - [SendX::Sender](docs/Sender.md)
137
147
  - [SendX::SenderRequest](docs/SenderRequest.md)
138
148
  - [SendX::SenderResponse](docs/SenderResponse.md)
139
149
  - [SendX::Tag](docs/Tag.md)
140
150
  - [SendX::TagRequest](docs/TagRequest.md)
151
+ - [SendX::TrackRequest](docs/TrackRequest.md)
152
+ - [SendX::TrackResponse](docs/TrackResponse.md)
141
153
 
142
154
 
143
155
  ## Documentation for Authorization
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Introduction SendX is an email marketing product. It helps you convert website visitors to customers, send them promotional emails, engage with them using drip sequences and craft custom journeys using powerful but simple automations. The SendX API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The SendX Rest API doesn’t support bulk updates. You can work on only one object per request. <br>
5
5
 
6
- The version of the OpenAPI document: 1.0.1
6
+ The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@sendx.io
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.8.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Introduction SendX is an email marketing product. It helps you convert website visitors to customers, send them promotional emails, engage with them using drip sequences and craft custom journeys using powerful but simple automations. The SendX API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The SendX Rest API doesn’t support bulk updates. You can work on only one object per request. <br>
5
5
 
6
- The version of the OpenAPI document: 1.0.1
6
+ The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@sendx.io
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.8.0
@@ -0,0 +1,158 @@
1
+ =begin
2
+ #SendX REST API
3
+
4
+ ## Introduction SendX is an email marketing product. It helps you convert website visitors to customers, send them promotional emails, engage with them using drip sequences and craft custom journeys using powerful but simple automations. The SendX API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The SendX Rest API doesn’t support bulk updates. You can work on only one object per request. <br>
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: support@sendx.io
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.8.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module SendX
16
+ class EventApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Record a revenue event for a specific contact
23
+ # Records a revenue event, which can be attributed to campaigns, drips, workflows, or other sources of user interaction.
24
+ # @param revenue_event_request [RevenueEventRequest]
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [EventResponse]
27
+ def create_revenue_event(revenue_event_request, opts = {})
28
+ data, _status_code, _headers = create_revenue_event_with_http_info(revenue_event_request, opts)
29
+ data
30
+ end
31
+
32
+ # Record a revenue event for a specific contact
33
+ # Records a revenue event, which can be attributed to campaigns, drips, workflows, or other sources of user interaction.
34
+ # @param revenue_event_request [RevenueEventRequest]
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(EventResponse, Integer, Hash)>] EventResponse data, response status code and response headers
37
+ def create_revenue_event_with_http_info(revenue_event_request, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: EventApi.create_revenue_event ...'
40
+ end
41
+ # verify the required parameter 'revenue_event_request' is set
42
+ if @api_client.config.client_side_validation && revenue_event_request.nil?
43
+ fail ArgumentError, "Missing the required parameter 'revenue_event_request' when calling EventApi.create_revenue_event"
44
+ end
45
+ # resource path
46
+ local_var_path = '/events/revenue'
47
+
48
+ # query parameters
49
+ query_params = opts[:query_params] || {}
50
+
51
+ # header parameters
52
+ header_params = opts[:header_params] || {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
55
+ # HTTP header 'Content-Type'
56
+ content_type = @api_client.select_header_content_type(['application/json'])
57
+ if !content_type.nil?
58
+ header_params['Content-Type'] = content_type
59
+ end
60
+
61
+ # form parameters
62
+ form_params = opts[:form_params] || {}
63
+
64
+ # http body (model)
65
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(revenue_event_request)
66
+
67
+ # return_type
68
+ return_type = opts[:debug_return_type] || 'EventResponse'
69
+
70
+ # auth_names
71
+ auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
72
+
73
+ new_options = opts.merge(
74
+ :operation => :"EventApi.create_revenue_event",
75
+ :header_params => header_params,
76
+ :query_params => query_params,
77
+ :form_params => form_params,
78
+ :body => post_body,
79
+ :auth_names => auth_names,
80
+ :return_type => return_type
81
+ )
82
+
83
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
84
+ if @api_client.config.debugging
85
+ @api_client.config.logger.debug "API called: EventApi#create_revenue_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
86
+ end
87
+ return data, status_code, headers
88
+ end
89
+
90
+ # Push a custom event associated with a contact
91
+ # Pushes a custom event with properties and values for a specified contact.
92
+ # @param custom_event_request [CustomEventRequest]
93
+ # @param [Hash] opts the optional parameters
94
+ # @return [EventResponse]
95
+ def push_custom_event(custom_event_request, opts = {})
96
+ data, _status_code, _headers = push_custom_event_with_http_info(custom_event_request, opts)
97
+ data
98
+ end
99
+
100
+ # Push a custom event associated with a contact
101
+ # Pushes a custom event with properties and values for a specified contact.
102
+ # @param custom_event_request [CustomEventRequest]
103
+ # @param [Hash] opts the optional parameters
104
+ # @return [Array<(EventResponse, Integer, Hash)>] EventResponse data, response status code and response headers
105
+ def push_custom_event_with_http_info(custom_event_request, opts = {})
106
+ if @api_client.config.debugging
107
+ @api_client.config.logger.debug 'Calling API: EventApi.push_custom_event ...'
108
+ end
109
+ # verify the required parameter 'custom_event_request' is set
110
+ if @api_client.config.client_side_validation && custom_event_request.nil?
111
+ fail ArgumentError, "Missing the required parameter 'custom_event_request' when calling EventApi.push_custom_event"
112
+ end
113
+ # resource path
114
+ local_var_path = '/events/custom'
115
+
116
+ # query parameters
117
+ query_params = opts[:query_params] || {}
118
+
119
+ # header parameters
120
+ header_params = opts[:header_params] || {}
121
+ # HTTP header 'Accept' (if needed)
122
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
123
+ # HTTP header 'Content-Type'
124
+ content_type = @api_client.select_header_content_type(['application/json'])
125
+ if !content_type.nil?
126
+ header_params['Content-Type'] = content_type
127
+ end
128
+
129
+ # form parameters
130
+ form_params = opts[:form_params] || {}
131
+
132
+ # http body (model)
133
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(custom_event_request)
134
+
135
+ # return_type
136
+ return_type = opts[:debug_return_type] || 'EventResponse'
137
+
138
+ # auth_names
139
+ auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
140
+
141
+ new_options = opts.merge(
142
+ :operation => :"EventApi.push_custom_event",
143
+ :header_params => header_params,
144
+ :query_params => query_params,
145
+ :form_params => form_params,
146
+ :body => post_body,
147
+ :auth_names => auth_names,
148
+ :return_type => return_type
149
+ )
150
+
151
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
152
+ if @api_client.config.debugging
153
+ @api_client.config.logger.debug "API called: EventApi#push_custom_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
154
+ end
155
+ return data, status_code, headers
156
+ end
157
+ end
158
+ end
@@ -0,0 +1,158 @@
1
+ =begin
2
+ #SendX REST API
3
+
4
+ ## Introduction SendX is an email marketing product. It helps you convert website visitors to customers, send them promotional emails, engage with them using drip sequences and craft custom journeys using powerful but simple automations. The SendX API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The SendX Rest API doesn’t support bulk updates. You can work on only one object per request. <br>
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: support@sendx.io
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.8.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module SendX
16
+ class GettingStartedApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Identify contact
23
+ # Identify a contact by email address. If the contact already exists, it will be updated.
24
+ # @param identify_request [IdentifyRequest]
25
+ # @param [Hash] opts the optional parameters
26
+ # @return [IdentifyResponse]
27
+ def identify_contact(identify_request, opts = {})
28
+ data, _status_code, _headers = identify_contact_with_http_info(identify_request, opts)
29
+ data
30
+ end
31
+
32
+ # Identify contact
33
+ # Identify a contact by email address. If the contact already exists, it will be updated.
34
+ # @param identify_request [IdentifyRequest]
35
+ # @param [Hash] opts the optional parameters
36
+ # @return [Array<(IdentifyResponse, Integer, Hash)>] IdentifyResponse data, response status code and response headers
37
+ def identify_contact_with_http_info(identify_request, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: GettingStartedApi.identify_contact ...'
40
+ end
41
+ # verify the required parameter 'identify_request' is set
42
+ if @api_client.config.client_side_validation && identify_request.nil?
43
+ fail ArgumentError, "Missing the required parameter 'identify_request' when calling GettingStartedApi.identify_contact"
44
+ end
45
+ # resource path
46
+ local_var_path = '/contact/identify'
47
+
48
+ # query parameters
49
+ query_params = opts[:query_params] || {}
50
+
51
+ # header parameters
52
+ header_params = opts[:header_params] || {}
53
+ # HTTP header 'Accept' (if needed)
54
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
55
+ # HTTP header 'Content-Type'
56
+ content_type = @api_client.select_header_content_type(['application/json'])
57
+ if !content_type.nil?
58
+ header_params['Content-Type'] = content_type
59
+ end
60
+
61
+ # form parameters
62
+ form_params = opts[:form_params] || {}
63
+
64
+ # http body (model)
65
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(identify_request)
66
+
67
+ # return_type
68
+ return_type = opts[:debug_return_type] || 'IdentifyResponse'
69
+
70
+ # auth_names
71
+ auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
72
+
73
+ new_options = opts.merge(
74
+ :operation => :"GettingStartedApi.identify_contact",
75
+ :header_params => header_params,
76
+ :query_params => query_params,
77
+ :form_params => form_params,
78
+ :body => post_body,
79
+ :auth_names => auth_names,
80
+ :return_type => return_type
81
+ )
82
+
83
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
84
+ if @api_client.config.debugging
85
+ @api_client.config.logger.debug "API called: GettingStartedApi#identify_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
86
+ end
87
+ return data, status_code, headers
88
+ end
89
+
90
+ # Add Tracking info
91
+ # Track a contact
92
+ # @param track_request [TrackRequest]
93
+ # @param [Hash] opts the optional parameters
94
+ # @return [TrackResponse]
95
+ def tracking_contact(track_request, opts = {})
96
+ data, _status_code, _headers = tracking_contact_with_http_info(track_request, opts)
97
+ data
98
+ end
99
+
100
+ # Add Tracking info
101
+ # Track a contact
102
+ # @param track_request [TrackRequest]
103
+ # @param [Hash] opts the optional parameters
104
+ # @return [Array<(TrackResponse, Integer, Hash)>] TrackResponse data, response status code and response headers
105
+ def tracking_contact_with_http_info(track_request, opts = {})
106
+ if @api_client.config.debugging
107
+ @api_client.config.logger.debug 'Calling API: GettingStartedApi.tracking_contact ...'
108
+ end
109
+ # verify the required parameter 'track_request' is set
110
+ if @api_client.config.client_side_validation && track_request.nil?
111
+ fail ArgumentError, "Missing the required parameter 'track_request' when calling GettingStartedApi.tracking_contact"
112
+ end
113
+ # resource path
114
+ local_var_path = '/contact/track'
115
+
116
+ # query parameters
117
+ query_params = opts[:query_params] || {}
118
+
119
+ # header parameters
120
+ header_params = opts[:header_params] || {}
121
+ # HTTP header 'Accept' (if needed)
122
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
123
+ # HTTP header 'Content-Type'
124
+ content_type = @api_client.select_header_content_type(['application/json'])
125
+ if !content_type.nil?
126
+ header_params['Content-Type'] = content_type
127
+ end
128
+
129
+ # form parameters
130
+ form_params = opts[:form_params] || {}
131
+
132
+ # http body (model)
133
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(track_request)
134
+
135
+ # return_type
136
+ return_type = opts[:debug_return_type] || 'TrackResponse'
137
+
138
+ # auth_names
139
+ auth_names = opts[:debug_auth_names] || ['apiKeyAuth']
140
+
141
+ new_options = opts.merge(
142
+ :operation => :"GettingStartedApi.tracking_contact",
143
+ :header_params => header_params,
144
+ :query_params => query_params,
145
+ :form_params => form_params,
146
+ :body => post_body,
147
+ :auth_names => auth_names,
148
+ :return_type => return_type
149
+ )
150
+
151
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
152
+ if @api_client.config.debugging
153
+ @api_client.config.logger.debug "API called: GettingStartedApi#tracking_contact\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
154
+ end
155
+ return data, status_code, headers
156
+ end
157
+ end
158
+ end
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Introduction SendX is an email marketing product. It helps you convert website visitors to customers, send them promotional emails, engage with them using drip sequences and craft custom journeys using powerful but simple automations. The SendX API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The SendX Rest API doesn’t support bulk updates. You can work on only one object per request. <br>
5
5
 
6
- The version of the OpenAPI document: 1.0.1
6
+ The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@sendx.io
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.8.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Introduction SendX is an email marketing product. It helps you convert website visitors to customers, send them promotional emails, engage with them using drip sequences and craft custom journeys using powerful but simple automations. The SendX API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The SendX Rest API doesn’t support bulk updates. You can work on only one object per request. <br>
5
5
 
6
- The version of the OpenAPI document: 1.0.1
6
+ The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@sendx.io
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.8.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Introduction SendX is an email marketing product. It helps you convert website visitors to customers, send them promotional emails, engage with them using drip sequences and craft custom journeys using powerful but simple automations. The SendX API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The SendX Rest API doesn’t support bulk updates. You can work on only one object per request. <br>
5
5
 
6
- The version of the OpenAPI document: 1.0.1
6
+ The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@sendx.io
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.8.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Introduction SendX is an email marketing product. It helps you convert website visitors to customers, send them promotional emails, engage with them using drip sequences and craft custom journeys using powerful but simple automations. The SendX API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The SendX Rest API doesn’t support bulk updates. You can work on only one object per request. <br>
5
5
 
6
- The version of the OpenAPI document: 1.0.1
6
+ The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@sendx.io
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.8.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Introduction SendX is an email marketing product. It helps you convert website visitors to customers, send them promotional emails, engage with them using drip sequences and craft custom journeys using powerful but simple automations. The SendX API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The SendX Rest API doesn’t support bulk updates. You can work on only one object per request. <br>
5
5
 
6
- The version of the OpenAPI document: 1.0.1
6
+ The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@sendx.io
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.8.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Introduction SendX is an email marketing product. It helps you convert website visitors to customers, send them promotional emails, engage with them using drip sequences and craft custom journeys using powerful but simple automations. The SendX API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The SendX Rest API doesn’t support bulk updates. You can work on only one object per request. <br>
5
5
 
6
- The version of the OpenAPI document: 1.0.1
6
+ The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@sendx.io
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.8.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Introduction SendX is an email marketing product. It helps you convert website visitors to customers, send them promotional emails, engage with them using drip sequences and craft custom journeys using powerful but simple automations. The SendX API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The SendX Rest API doesn’t support bulk updates. You can work on only one object per request. <br>
5
5
 
6
- The version of the OpenAPI document: 1.0.1
6
+ The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@sendx.io
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.8.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Introduction SendX is an email marketing product. It helps you convert website visitors to customers, send them promotional emails, engage with them using drip sequences and craft custom journeys using powerful but simple automations. The SendX API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The SendX Rest API doesn’t support bulk updates. You can work on only one object per request. <br>
5
5
 
6
- The version of the OpenAPI document: 1.0.1
6
+ The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@sendx.io
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.8.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Introduction SendX is an email marketing product. It helps you convert website visitors to customers, send them promotional emails, engage with them using drip sequences and craft custom journeys using powerful but simple automations. The SendX API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The SendX Rest API doesn’t support bulk updates. You can work on only one object per request. <br>
5
5
 
6
- The version of the OpenAPI document: 1.0.1
6
+ The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@sendx.io
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.8.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Introduction SendX is an email marketing product. It helps you convert website visitors to customers, send them promotional emails, engage with them using drip sequences and craft custom journeys using powerful but simple automations. The SendX API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The SendX Rest API doesn’t support bulk updates. You can work on only one object per request. <br>
5
5
 
6
- The version of the OpenAPI document: 1.0.1
6
+ The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@sendx.io
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.8.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Introduction SendX is an email marketing product. It helps you convert website visitors to customers, send them promotional emails, engage with them using drip sequences and craft custom journeys using powerful but simple automations. The SendX API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The SendX Rest API doesn’t support bulk updates. You can work on only one object per request. <br>
5
5
 
6
- The version of the OpenAPI document: 1.0.1
6
+ The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@sendx.io
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.8.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Introduction SendX is an email marketing product. It helps you convert website visitors to customers, send them promotional emails, engage with them using drip sequences and craft custom journeys using powerful but simple automations. The SendX API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The SendX Rest API doesn’t support bulk updates. You can work on only one object per request. <br>
5
5
 
6
- The version of the OpenAPI document: 1.0.1
6
+ The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@sendx.io
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.8.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## Introduction SendX is an email marketing product. It helps you convert website visitors to customers, send them promotional emails, engage with them using drip sequences and craft custom journeys using powerful but simple automations. The SendX API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The SendX Rest API doesn’t support bulk updates. You can work on only one object per request. <br>
5
5
 
6
- The version of the OpenAPI document: 1.0.1
6
+ The version of the OpenAPI document: 1.0.0
7
7
  Contact: support@sendx.io
8
8
  Generated by: https://openapi-generator.tech
9
9
  Generator version: 7.8.0