Class: Norbelys::SuppressionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/norbelys/api/suppressions_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SuppressionsApi

Returns a new instance of SuppressionsApi.



19
20
21
 
# File 'lib/norbelys/api/suppressions_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/norbelys/api/suppressions_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#suppressions_archive(id, opts = {}) ⇒ Suppression

Delete a suppression

Parameters:

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

    the optional parameters

Returns:



26
27
28
29
 
# File 'lib/norbelys/api/suppressions_api.rb', line 26

def suppressions_archive(id, opts = {})
  data, _status_code, _headers = suppressions_archive_with_http_info(id, opts)
  data
end

#suppressions_archive_with_http_info(id, opts = {}) ⇒ Array<(Suppression, Integer, Hash)>

Delete a suppression

Parameters:

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

    the optional parameters

Returns:

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

    Suppression data, response status code and response headers



35
36
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
 
# File 'lib/norbelys/api/suppressions_api.rb', line 35

def suppressions_archive_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SuppressionsApi.suppressions_archive ...'
  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 SuppressionsApi.suppressions_archive"
  end
  # resource path
  local_var_path = '/suppressions/{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']) unless header_params['Accept']

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

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

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

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

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

#suppressions_bulk(suppression_bulk_params, opts = {}) ⇒ SuppressionBulkResult

Bulk-suppress addresses Add many email addresses or bare domains to the do-not-contact list in one call (up to 10,000). Idempotent per value — already-suppressed entries are skipped; the response returns how many were newly added.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.

Returns:



89
90
91
92
 
# File 'lib/norbelys/api/suppressions_api.rb', line 89

def suppressions_bulk(suppression_bulk_params, opts = {})
  data, _status_code, _headers = suppressions_bulk_with_http_info(suppression_bulk_params, opts)
  data
end

#suppressions_bulk_with_http_info(suppression_bulk_params, opts = {}) ⇒ Array<(SuppressionBulkResult, Integer, Hash)>

Bulk-suppress addresses Add many email addresses or bare domains to the do-not-contact list in one call (up to 10,000). Idempotent per value — already-suppressed entries are skipped; the response returns how many were newly added.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :idempotency_key (String) —

    Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.

Returns:

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

    SuppressionBulkResult data, response status code and response headers



100
101
102
103
104
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/norbelys/api/suppressions_api.rb', line 100

def suppressions_bulk_with_http_info(suppression_bulk_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SuppressionsApi.suppressions_bulk ...'
  end
  # verify the required parameter 'suppression_bulk_params' is set
  if @api_client.config.client_side_validation && suppression_bulk_params.nil?
    fail ArgumentError, "Missing the required parameter 'suppression_bulk_params' when calling SuppressionsApi.suppressions_bulk"
  end
  if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
    fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling SuppressionsApi.suppressions_bulk, the character length must be smaller than or equal to 255.'
  end

  # resource path
  local_var_path = '/suppressions/bulk'

  # 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
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

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

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

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

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

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

#suppressions_create(suppression_create_params, opts = {}) ⇒ Suppression

Suppress an address or domain Add one email address or bare domain to the do-not-contact list so it is never emailed. Idempotent and lowercased — re-suppressing an existing value is a no-op, not an error. Defaults to org-wide scope; pass scope program with a programId to suppress within a single campaign only. To add many at once, use bulk instead.

Parameters:

Options Hash (opts):

  • :idempotency_key (String) —

    Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.

Returns:



164
165
166
167
 
# File 'lib/norbelys/api/suppressions_api.rb', line 164

def suppressions_create(suppression_create_params, opts = {})
  data, _status_code, _headers = suppressions_create_with_http_info(suppression_create_params, opts)
  data
end

#suppressions_create_with_http_info(suppression_create_params, opts = {}) ⇒ Array<(Suppression, Integer, Hash)>

Suppress an address or domain Add one email address or bare domain to the do-not-contact list so it is never emailed. Idempotent and lowercased — re-suppressing an existing value is a no-op, not an error. Defaults to org-wide scope; pass scope `program` with a `programId` to suppress within a single campaign only. To add many at once, use bulk instead.

Parameters:

Options Hash (opts):

  • :idempotency_key (String) —

    Opt-in idempotency for a safely retried write: reuse the same key to replay the original result for 24h instead of re-executing. Recommended on every POST.

Returns:

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

    Suppression data, response status code and response headers



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
227
228
229
230
231
 
# File 'lib/norbelys/api/suppressions_api.rb', line 175

def suppressions_create_with_http_info(suppression_create_params, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SuppressionsApi.suppressions_create ...'
  end
  # verify the required parameter 'suppression_create_params' is set
  if @api_client.config.client_side_validation && suppression_create_params.nil?
    fail ArgumentError, "Missing the required parameter 'suppression_create_params' when calling SuppressionsApi.suppressions_create"
  end
  if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
    fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling SuppressionsApi.suppressions_create, the character length must be smaller than or equal to 255.'
  end

  # resource path
  local_var_path = '/suppressions'

  # 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
  header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?

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

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

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

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

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

#suppressions_find(id, opts = {}) ⇒ Suppression

Get a suppression Read one suppression entry by id.

Parameters:

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

    the optional parameters

Returns:



238
239
240
241
 
# File 'lib/norbelys/api/suppressions_api.rb', line 238

def suppressions_find(id, opts = {})
  data, _status_code, _headers = suppressions_find_with_http_info(id, opts)
  data
end

#suppressions_find_with_http_info(id, opts = {}) ⇒ Array<(Suppression, Integer, Hash)>

Get a suppression Read one suppression entry by id.

Parameters:

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

    the optional parameters

Returns:

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

    Suppression data, response status code and response headers



248
249
250
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
 
# File 'lib/norbelys/api/suppressions_api.rb', line 248

def suppressions_find_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SuppressionsApi.suppressions_find ...'
  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 SuppressionsApi.suppressions_find"
  end
  # resource path
  local_var_path = '/suppressions/{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']) unless header_params['Accept']

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

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

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

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

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

#suppressions_list(opts = {}) ⇒ SuppressionList

List suppressions List the org's do-not-contact entries — suppressed email addresses and bare domains — newest first. A suppressed address or domain is never emailed by any campaign.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String)
  • :include_archived (Boolean)
  • :limit (Integer)

Returns:



303
304
305
306
 
# File 'lib/norbelys/api/suppressions_api.rb', line 303

def suppressions_list(opts = {})
  data, _status_code, _headers = suppressions_list_with_http_info(opts)
  data
end

#suppressions_list_with_http_info(opts = {}) ⇒ Array<(SuppressionList, Integer, Hash)>

List suppressions List the org's do-not-contact entries — suppressed email addresses and bare domains — newest first. A suppressed address or domain is never emailed by any campaign.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String)
  • :include_archived (Boolean)
  • :limit (Integer)

Returns:

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

    SuppressionList data, response status code and response headers



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
 
# File 'lib/norbelys/api/suppressions_api.rb', line 315

def suppressions_list_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SuppressionsApi.suppressions_list ...'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SuppressionsApi.suppressions_list, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SuppressionsApi.suppressions_list, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/suppressions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'includeArchived'] = opts[:'include_archived'] if !opts[:'include_archived'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # 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']

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

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

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

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

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