Class: Sendpost::SuppressionApi

Inherits:
Object
  • Object
show all
Defined in:
lib/sendpost_ruby_sdk/api/suppression_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SuppressionApi

Returns a new instance of SuppressionApi.



19
20
21
 
# File 'lib/sendpost_ruby_sdk/api/suppression_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/sendpost_ruby_sdk/api/suppression_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#count(x_sub_account_api_key, opts = {}) ⇒ CountStat

Count Total Suppressions

Parameters:

  • x_sub_account_api_key (String) —

    Sub-Account API Key

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :from (String) —

    from date

  • :to (String) —

    to date

Returns:



28
29
30
31
 
# File 'lib/sendpost_ruby_sdk/api/suppression_api.rb', line 28

def count(, opts = {})
  data, _status_code, _headers = count_with_http_info(, opts)
  data
end

#count_with_http_info(x_sub_account_api_key, opts = {}) ⇒ Array<(CountStat, Integer, Hash)>

Count Total Suppressions

Parameters:

  • x_sub_account_api_key (String) —

    Sub-Account API Key

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :from (String) —

    from date

  • :to (String) —

    to date

Returns:

  • (Array<(CountStat, Integer, Hash)>) —

    CountStat data, response status code and response headers



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/sendpost_ruby_sdk/api/suppression_api.rb', line 39

def count_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SuppressionApi.count ...'
  end
  # verify the required parameter 'x_sub_account_api_key' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_sub_account_api_key' when calling SuppressionApi.count"
  end
  # resource path
  local_var_path = '/subaccount/suppression/count'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-SubAccount-ApiKey'] = 

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CountStat'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"SuppressionApi.count",
    :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: SuppressionApi#count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_suppressions(x_sub_account_api_key, opts = {}) ⇒ Array<Suppression>

Add Email Addresses To Suppression List

Parameters:

  • x_sub_account_api_key (String) —

    Sub-Account API Key

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



95
96
97
98
 
# File 'lib/sendpost_ruby_sdk/api/suppression_api.rb', line 95

def create_suppressions(, opts = {})
  data, _status_code, _headers = create_suppressions_with_http_info(, opts)
  data
end

#create_suppressions_with_http_info(x_sub_account_api_key, opts = {}) ⇒ Array<(Array<Suppression>, Integer, Hash)>

Add Email Addresses To Suppression List

Parameters:

  • x_sub_account_api_key (String) —

    Sub-Account API Key

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Array<Suppression>, Integer, Hash)>) —

    Array<Suppression> data, response status code and response headers



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
157
 
# File 'lib/sendpost_ruby_sdk/api/suppression_api.rb', line 105

def create_suppressions_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SuppressionApi.create_suppressions ...'
  end
  # verify the required parameter 'x_sub_account_api_key' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_sub_account_api_key' when calling SuppressionApi.create_suppressions"
  end
  # resource path
  local_var_path = '/subaccount/suppression/'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'X-SubAccount-ApiKey'] = 

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'r_suppression'])

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Suppression>'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"SuppressionApi.create_suppressions",
    :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: SuppressionApi#create_suppressions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_suppression(x_sub_account_api_key, opts = {}) ⇒ Array<DeleteResponse>

Delete specific emails which are in suppression list

Parameters:

  • x_sub_account_api_key (String) —

    Sub-Account API Key

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:



164
165
166
167
 
# File 'lib/sendpost_ruby_sdk/api/suppression_api.rb', line 164

def delete_suppression(, opts = {})
  data, _status_code, _headers = delete_suppression_with_http_info(, opts)
  data
end

#delete_suppression_with_http_info(x_sub_account_api_key, opts = {}) ⇒ Array<(Array<DeleteResponse>, Integer, Hash)>

Delete specific emails which are in suppression list

Parameters:

  • x_sub_account_api_key (String) —

    Sub-Account API Key

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(Array<DeleteResponse>, Integer, Hash)>) —

    Array<DeleteResponse> data, response status code and response headers



174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/sendpost_ruby_sdk/api/suppression_api.rb', line 174

def delete_suppression_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SuppressionApi.delete_suppression ...'
  end
  # verify the required parameter 'x_sub_account_api_key' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_sub_account_api_key' when calling SuppressionApi.delete_suppression"
  end
  # resource path
  local_var_path = '/subaccount/suppression/'

  # 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'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  header_params[:'X-SubAccount-ApiKey'] = 

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'rd_suppression'])

  # return_type
  return_type = opts[:debug_return_type] || 'Array<DeleteResponse>'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"SuppressionApi.delete_suppression",
    :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(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SuppressionApi#delete_suppression\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_suppressions(x_sub_account_api_key, opts = {}) ⇒ Array<Suppression>

Get all suppressions

Parameters:

  • x_sub_account_api_key (String) —

    Sub-Account API Key

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    offset

  • :limit (Integer) —

    limit

  • :search (String) —

    search

  • :from (String) —

    from date

  • :to (String) —

    to date

Returns:



237
238
239
240
 
# File 'lib/sendpost_ruby_sdk/api/suppression_api.rb', line 237

def get_suppressions(, opts = {})
  data, _status_code, _headers = get_suppressions_with_http_info(, opts)
  data
end

#get_suppressions_with_http_info(x_sub_account_api_key, opts = {}) ⇒ Array<(Array<Suppression>, Integer, Hash)>

Get all suppressions

Parameters:

  • x_sub_account_api_key (String) —

    Sub-Account API Key

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    offset

  • :limit (Integer) —

    limit

  • :search (String) —

    search

  • :from (String) —

    from date

  • :to (String) —

    to date

Returns:

  • (Array<(Array<Suppression>, Integer, Hash)>) —

    Array<Suppression> data, response status code and response headers



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/sendpost_ruby_sdk/api/suppression_api.rb', line 251

def get_suppressions_with_http_info(, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SuppressionApi.get_suppressions ...'
  end
  # verify the required parameter 'x_sub_account_api_key' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_sub_account_api_key' when calling SuppressionApi.get_suppressions"
  end
  # resource path
  local_var_path = '/subaccount/suppression/'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'from'] = opts[:'from'] if !opts[:'from'].nil?
  query_params[:'to'] = opts[:'to'] if !opts[:'to'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-SubAccount-ApiKey'] = 

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<Suppression>'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"SuppressionApi.get_suppressions",
    :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: SuppressionApi#get_suppressions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end