MailchimpTransactional 1.0.6 → 1.0.8

Sign up to get free protection for your applications and to get access to all the features.
@@ -3,7 +3,7 @@
3
3
 
4
4
  #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
5
 
6
- OpenAPI spec version: 1.0.6
6
+ OpenAPI spec version: 1.0.8
7
7
  Contact: apihelp@mandrill.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.4.12
@@ -22,17 +22,17 @@ module MailchimpTransactional
22
22
  @api_key = api_key
23
23
  @api_client = api_client
24
24
  end
25
- # /metadata/add
25
+ # Add metadata field
26
26
  # Add a new custom metadata field to be indexed for the account.
27
27
  # @param body
28
28
  # @param [Hash] opts the optional parameters
29
29
  # @return [InlineResponse20034]
30
30
  def add(body = {}, opts = {})
31
- data, _status_code, _headers = add_with_http_info(body, opts)
31
+ data = add_with_http_info(body, opts)
32
32
  data
33
33
  end
34
34
 
35
- # /metadata/add
35
+ # Add metadata field
36
36
  # Add a new custom metadata field to be indexed for the account.
37
37
  # @param body
38
38
  # @param [Hash] opts the optional parameters
@@ -45,24 +45,20 @@ module MailchimpTransactional
45
45
  local_var_path = '/metadata/add'
46
46
 
47
47
  # http body (model)
48
- auth_names = []
49
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
50
- :body => body,
51
- :auth_names => auth_names,
52
- :return_type => 'InlineResponse20034')
53
- return data, status_code, headers
48
+ data = @api_client.call_api(:POST, local_var_path, :body => body)
49
+ return data
54
50
  end
55
- # /metadata/delete
51
+ # Delete metadata field
56
52
  # Delete an existing custom metadata field. Deletion isn't instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete.
57
53
  # @param body
58
54
  # @param [Hash] opts the optional parameters
59
55
  # @return [InlineResponse20036]
60
56
  def delete(body = {}, opts = {})
61
- data, _status_code, _headers = delete_with_http_info(body, opts)
57
+ data = delete_with_http_info(body, opts)
62
58
  data
63
59
  end
64
60
 
65
- # /metadata/delete
61
+ # Delete metadata field
66
62
  # Delete an existing custom metadata field. Deletion isn't instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete.
67
63
  # @param body
68
64
  # @param [Hash] opts the optional parameters
@@ -75,24 +71,20 @@ module MailchimpTransactional
75
71
  local_var_path = '/metadata/delete'
76
72
 
77
73
  # http body (model)
78
- auth_names = []
79
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
80
- :body => body,
81
- :auth_names => auth_names,
82
- :return_type => 'InlineResponse20036')
83
- return data, status_code, headers
74
+ data = @api_client.call_api(:POST, local_var_path, :body => body)
75
+ return data
84
76
  end
85
- # /metadata/list
77
+ # List metadata fields
86
78
  # Get the list of custom metadata fields indexed for the account.
87
79
  # @param body
88
80
  # @param [Hash] opts the optional parameters
89
81
  # @return [Array<InlineResponse20033>]
90
82
  def list(body = {}, opts = {})
91
- data, _status_code, _headers = list_with_http_info(body, opts)
83
+ data = list_with_http_info(body, opts)
92
84
  data
93
85
  end
94
86
 
95
- # /metadata/list
87
+ # List metadata fields
96
88
  # Get the list of custom metadata fields indexed for the account.
97
89
  # @param body
98
90
  # @param [Hash] opts the optional parameters
@@ -105,25 +97,21 @@ module MailchimpTransactional
105
97
  local_var_path = '/metadata/list'
106
98
 
107
99
  # http body (model)
108
- auth_names = []
109
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
110
- :body => body,
111
- :auth_names => auth_names,
112
- :return_type => 'Array<InlineResponse20033>')
113
- return data, status_code, headers
100
+ data = @api_client.call_api(:POST, local_var_path, :body => body)
101
+ return data
114
102
  end
115
- # /metadata/update
116
- # Delete an existing custom metadata field. Deletion isn't instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete.
103
+ # Update metadata field
104
+ # Update an existing custom metadata field.
117
105
  # @param body
118
106
  # @param [Hash] opts the optional parameters
119
107
  # @return [InlineResponse20035]
120
108
  def update(body = {}, opts = {})
121
- data, _status_code, _headers = update_with_http_info(body, opts)
109
+ data = update_with_http_info(body, opts)
122
110
  data
123
111
  end
124
112
 
125
- # /metadata/update
126
- # Delete an existing custom metadata field. Deletion isn&#39;t instataneous, and /metadata/list will continue to return the field until the asynchronous deletion process is complete.
113
+ # Update metadata field
114
+ # Update an existing custom metadata field.
127
115
  # @param body
128
116
  # @param [Hash] opts the optional parameters
129
117
  # @return [Array<(InlineResponse20035, Fixnum, Hash)>] InlineResponse20035 data, response status code and response headers
@@ -135,12 +123,8 @@ module MailchimpTransactional
135
123
  local_var_path = '/metadata/update'
136
124
 
137
125
  # http body (model)
138
- auth_names = []
139
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
140
- :body => body,
141
- :auth_names => auth_names,
142
- :return_type => 'InlineResponse20035')
143
- return data, status_code, headers
126
+ data = @api_client.call_api(:POST, local_var_path, :body => body)
127
+ return data
144
128
  end
145
129
  end
146
130
  end
@@ -3,7 +3,7 @@
3
3
 
4
4
  #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
5
 
6
- OpenAPI spec version: 1.0.6
6
+ OpenAPI spec version: 1.0.8
7
7
  Contact: apihelp@mandrill.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.4.12
@@ -22,17 +22,17 @@ module MailchimpTransactional
22
22
  @api_key = api_key
23
23
  @api_client = api_client
24
24
  end
25
- # /rejects/add
25
+ # Add email to blacklist
26
26
  # Adds an email to your email rejection blacklist. Addresses that you add manually will never expire and there is no reputation penalty for removing them from your blacklist. Attempting to blacklist an address that has been whitelisted will have no effect.
27
27
  # @param body
28
28
  # @param [Hash] opts the optional parameters
29
29
  # @return [InlineResponse20037]
30
30
  def add(body = {}, opts = {})
31
- data, _status_code, _headers = add_with_http_info(body, opts)
31
+ data = add_with_http_info(body, opts)
32
32
  data
33
33
  end
34
34
 
35
- # /rejects/add
35
+ # Add email to blacklist
36
36
  # Adds an email to your email rejection blacklist. Addresses that you add manually will never expire and there is no reputation penalty for removing them from your blacklist. Attempting to blacklist an address that has been whitelisted will have no effect.
37
37
  # @param body
38
38
  # @param [Hash] opts the optional parameters
@@ -45,24 +45,20 @@ module MailchimpTransactional
45
45
  local_var_path = '/rejects/add'
46
46
 
47
47
  # http body (model)
48
- auth_names = []
49
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
50
- :body => body,
51
- :auth_names => auth_names,
52
- :return_type => 'InlineResponse20037')
53
- return data, status_code, headers
48
+ data = @api_client.call_api(:POST, local_var_path, :body => body)
49
+ return data
54
50
  end
55
- # /rejects/delete
51
+ # Delete email from blacklist
56
52
  # Deletes an email rejection. There is no limit to how many rejections you can remove from your blacklist, but keep in mind that each deletion has an affect on your reputation.
57
53
  # @param body
58
54
  # @param [Hash] opts the optional parameters
59
55
  # @return [InlineResponse20039]
60
56
  def delete(body = {}, opts = {})
61
- data, _status_code, _headers = delete_with_http_info(body, opts)
57
+ data = delete_with_http_info(body, opts)
62
58
  data
63
59
  end
64
60
 
65
- # /rejects/delete
61
+ # Delete email from blacklist
66
62
  # Deletes an email rejection. There is no limit to how many rejections you can remove from your blacklist, but keep in mind that each deletion has an affect on your reputation.
67
63
  # @param body
68
64
  # @param [Hash] opts the optional parameters
@@ -75,24 +71,20 @@ module MailchimpTransactional
75
71
  local_var_path = '/rejects/delete'
76
72
 
77
73
  # http body (model)
78
- auth_names = []
79
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
80
- :body => body,
81
- :auth_names => auth_names,
82
- :return_type => 'InlineResponse20039')
83
- return data, status_code, headers
74
+ data = @api_client.call_api(:POST, local_var_path, :body => body)
75
+ return data
84
76
  end
85
- # /rejects/list
77
+ # List blacklisted emails
86
78
  # Retrieves your email rejection blacklist. You can provide an email address to limit the results. Returns up to 1000 results. By default, entries that have expired are excluded from the results; set include_expired to true to include them.
87
79
  # @param body
88
80
  # @param [Hash] opts the optional parameters
89
81
  # @return [Array<InlineResponse20038>]
90
82
  def list(body = {}, opts = {})
91
- data, _status_code, _headers = list_with_http_info(body, opts)
83
+ data = list_with_http_info(body, opts)
92
84
  data
93
85
  end
94
86
 
95
- # /rejects/list
87
+ # List blacklisted emails
96
88
  # Retrieves your email rejection blacklist. You can provide an email address to limit the results. Returns up to 1000 results. By default, entries that have expired are excluded from the results; set include_expired to true to include them.
97
89
  # @param body
98
90
  # @param [Hash] opts the optional parameters
@@ -105,12 +97,8 @@ module MailchimpTransactional
105
97
  local_var_path = '/rejects/list'
106
98
 
107
99
  # http body (model)
108
- auth_names = []
109
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
110
- :body => body,
111
- :auth_names => auth_names,
112
- :return_type => 'Array<InlineResponse20038>')
113
- return data, status_code, headers
100
+ data = @api_client.call_api(:POST, local_var_path, :body => body)
101
+ return data
114
102
  end
115
103
  end
116
104
  end
@@ -3,7 +3,7 @@
3
3
 
4
4
  #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
5
 
6
- OpenAPI spec version: 1.0.6
6
+ OpenAPI spec version: 1.0.8
7
7
  Contact: apihelp@mandrill.com
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
9
  Swagger Codegen version: 2.4.12
@@ -22,17 +22,17 @@ module MailchimpTransactional
22
22
  @api_key = api_key
23
23
  @api_client = api_client
24
24
  end
25
- # /senders/add-domain
25
+ # Add sender domain
26
26
  # Adds a sender domain to your account. Sender domains are added automatically as you send, but you can use this call to add them ahead of time.
27
27
  # @param body
28
28
  # @param [Hash] opts the optional parameters
29
29
  # @return [InlineResponse20042]
30
30
  def add_domain(body = {}, opts = {})
31
- data, _status_code, _headers = add_domain_with_http_info(body, opts)
31
+ data = add_domain_with_http_info(body, opts)
32
32
  data
33
33
  end
34
34
 
35
- # /senders/add-domain
35
+ # Add sender domain
36
36
  # Adds a sender domain to your account. Sender domains are added automatically as you send, but you can use this call to add them ahead of time.
37
37
  # @param body
38
38
  # @param [Hash] opts the optional parameters
@@ -45,24 +45,20 @@ module MailchimpTransactional
45
45
  local_var_path = '/senders/add-domain'
46
46
 
47
47
  # http body (model)
48
- auth_names = []
49
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
50
- :body => body,
51
- :auth_names => auth_names,
52
- :return_type => 'InlineResponse20042')
53
- return data, status_code, headers
48
+ data = @api_client.call_api(:POST, local_var_path, :body => body)
49
+ return data
54
50
  end
55
- # /senders/check-domain
51
+ # Check domain settings
56
52
  # Checks the SPF and DKIM settings for a domain. If you haven't already added this domain to your account, it will be added automatically.
57
53
  # @param body
58
54
  # @param [Hash] opts the optional parameters
59
55
  # @return [InlineResponse20043]
60
56
  def check_domain(body = {}, opts = {})
61
- data, _status_code, _headers = check_domain_with_http_info(body, opts)
57
+ data = check_domain_with_http_info(body, opts)
62
58
  data
63
59
  end
64
60
 
65
- # /senders/check-domain
61
+ # Check domain settings
66
62
  # Checks the SPF and DKIM settings for a domain. If you haven&#39;t already added this domain to your account, it will be added automatically.
67
63
  # @param body
68
64
  # @param [Hash] opts the optional parameters
@@ -75,25 +71,21 @@ module MailchimpTransactional
75
71
  local_var_path = '/senders/check-domain'
76
72
 
77
73
  # http body (model)
78
- auth_names = []
79
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
80
- :body => body,
81
- :auth_names => auth_names,
82
- :return_type => 'InlineResponse20043')
83
- return data, status_code, headers
74
+ data = @api_client.call_api(:POST, local_var_path, :body => body)
75
+ return data
84
76
  end
85
- # /senders/domains
86
- # Returns the sender domains that have been added to this account
77
+ # List sender domains
78
+ # Returns the sender domains that have been added to this account.
87
79
  # @param body
88
80
  # @param [Hash] opts the optional parameters
89
81
  # @return [Array<InlineResponse20041>]
90
82
  def domains(body = {}, opts = {})
91
- data, _status_code, _headers = domains_with_http_info(body, opts)
83
+ data = domains_with_http_info(body, opts)
92
84
  data
93
85
  end
94
86
 
95
- # /senders/domains
96
- # Returns the sender domains that have been added to this account
87
+ # List sender domains
88
+ # Returns the sender domains that have been added to this account.
97
89
  # @param body
98
90
  # @param [Hash] opts the optional parameters
99
91
  # @return [Array<(Array<InlineResponse20041>, Fixnum, Hash)>] Array<InlineResponse20041> data, response status code and response headers
@@ -105,25 +97,21 @@ module MailchimpTransactional
105
97
  local_var_path = '/senders/domains'
106
98
 
107
99
  # http body (model)
108
- auth_names = []
109
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
110
- :body => body,
111
- :auth_names => auth_names,
112
- :return_type => 'Array<InlineResponse20041>')
113
- return data, status_code, headers
100
+ data = @api_client.call_api(:POST, local_var_path, :body => body)
101
+ return data
114
102
  end
115
- # /senders/info
116
- # Return more detailed information about a single sender, including aggregates of recent stats
103
+ # Get sender info
104
+ # Return more detailed information about a single sender, including aggregates of recent stats.
117
105
  # @param body
118
106
  # @param [Hash] opts the optional parameters
119
107
  # @return [InlineResponse20045]
120
108
  def info(body = {}, opts = {})
121
- data, _status_code, _headers = info_with_http_info(body, opts)
109
+ data = info_with_http_info(body, opts)
122
110
  data
123
111
  end
124
112
 
125
- # /senders/info
126
- # Return more detailed information about a single sender, including aggregates of recent stats
113
+ # Get sender info
114
+ # Return more detailed information about a single sender, including aggregates of recent stats.
127
115
  # @param body
128
116
  # @param [Hash] opts the optional parameters
129
117
  # @return [Array<(InlineResponse20045, Fixnum, Hash)>] InlineResponse20045 data, response status code and response headers
@@ -135,25 +123,21 @@ module MailchimpTransactional
135
123
  local_var_path = '/senders/info'
136
124
 
137
125
  # http body (model)
138
- auth_names = []
139
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
140
- :body => body,
141
- :auth_names => auth_names,
142
- :return_type => 'InlineResponse20045')
143
- return data, status_code, headers
126
+ data = @api_client.call_api(:POST, local_var_path, :body => body)
127
+ return data
144
128
  end
145
- # /senders/list
146
- # Return the senders that have tried to use this account
129
+ # List account senders
130
+ # Return the senders that have tried to use this account.
147
131
  # @param body
148
132
  # @param [Hash] opts the optional parameters
149
133
  # @return [Array<InlineResponse20040>]
150
134
  def list(body = {}, opts = {})
151
- data, _status_code, _headers = list_with_http_info(body, opts)
135
+ data = list_with_http_info(body, opts)
152
136
  data
153
137
  end
154
138
 
155
- # /senders/list
156
- # Return the senders that have tried to use this account
139
+ # List account senders
140
+ # Return the senders that have tried to use this account.
157
141
  # @param body
158
142
  # @param [Hash] opts the optional parameters
159
143
  # @return [Array<(Array<InlineResponse20040>, Fixnum, Hash)>] Array<InlineResponse20040> data, response status code and response headers
@@ -165,25 +149,21 @@ module MailchimpTransactional
165
149
  local_var_path = '/senders/list'
166
150
 
167
151
  # http body (model)
168
- auth_names = []
169
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
170
- :body => body,
171
- :auth_names => auth_names,
172
- :return_type => 'Array<InlineResponse20040>')
173
- return data, status_code, headers
152
+ data = @api_client.call_api(:POST, local_var_path, :body => body)
153
+ return data
174
154
  end
175
- # /senders/time-series
176
- # Return the recent history (hourly stats for the last 30 days) for a sender
155
+ # View sender history
156
+ # Return the recent history (hourly stats for the last 30 days) for a sender.
177
157
  # @param body
178
158
  # @param [Hash] opts the optional parameters
179
159
  # @return [Array<InlineResponse20046>]
180
160
  def time_series(body = {}, opts = {})
181
- data, _status_code, _headers = time_series_with_http_info(body, opts)
161
+ data = time_series_with_http_info(body, opts)
182
162
  data
183
163
  end
184
164
 
185
- # /senders/time-series
186
- # Return the recent history (hourly stats for the last 30 days) for a sender
165
+ # View sender history
166
+ # Return the recent history (hourly stats for the last 30 days) for a sender.
187
167
  # @param body
188
168
  # @param [Hash] opts the optional parameters
189
169
  # @return [Array<(Array<InlineResponse20046>, Fixnum, Hash)>] Array<InlineResponse20046> data, response status code and response headers
@@ -195,25 +175,21 @@ module MailchimpTransactional
195
175
  local_var_path = '/senders/time-series'
196
176
 
197
177
  # http body (model)
198
- auth_names = []
199
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
200
- :body => body,
201
- :auth_names => auth_names,
202
- :return_type => 'Array<InlineResponse20046>')
203
- return data, status_code, headers
178
+ data = @api_client.call_api(:POST, local_var_path, :body => body)
179
+ return data
204
180
  end
205
- # /senders/verify-domain
206
- # Sends a verification email in order to verify ownership of a domain. Domain verification is a required step to confirm ownership of a domain. Once a domain has been verified in a Mandrill account, other accounts may not have their messages signed by that domain unless they also verify the domain. This prevents other Mandrill accounts from sending mail signed by your domain.
181
+ # Verify domain
182
+ # Sends a verification email in order to verify ownership of a domain. Domain verification is a required step to confirm ownership of a domain. Once a domain has been verified in a Transactional API account, other accounts may not have their messages signed by that domain unless they also verify the domain. This prevents other Transactional API accounts from sending mail signed by your domain.
207
183
  # @param body
208
184
  # @param [Hash] opts the optional parameters
209
185
  # @return [InlineResponse20044]
210
186
  def verify_domain(body = {}, opts = {})
211
- data, _status_code, _headers = verify_domain_with_http_info(body, opts)
187
+ data = verify_domain_with_http_info(body, opts)
212
188
  data
213
189
  end
214
190
 
215
- # /senders/verify-domain
216
- # Sends a verification email in order to verify ownership of a domain. Domain verification is a required step to confirm ownership of a domain. Once a domain has been verified in a Mandrill account, other accounts may not have their messages signed by that domain unless they also verify the domain. This prevents other Mandrill accounts from sending mail signed by your domain.
191
+ # Verify domain
192
+ # Sends a verification email in order to verify ownership of a domain. Domain verification is a required step to confirm ownership of a domain. Once a domain has been verified in a Transactional API account, other accounts may not have their messages signed by that domain unless they also verify the domain. This prevents other Transactional API accounts from sending mail signed by your domain.
217
193
  # @param body
218
194
  # @param [Hash] opts the optional parameters
219
195
  # @return [Array<(InlineResponse20044, Fixnum, Hash)>] InlineResponse20044 data, response status code and response headers
@@ -225,12 +201,8 @@ module MailchimpTransactional
225
201
  local_var_path = '/senders/verify-domain'
226
202
 
227
203
  # http body (model)
228
- auth_names = []
229
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
230
- :body => body,
231
- :auth_names => auth_names,
232
- :return_type => 'InlineResponse20044')
233
- return data, status_code, headers
204
+ data = @api_client.call_api(:POST, local_var_path, :body => body)
205
+ return data
234
206
  end
235
207
  end
236
208
  end