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

#create_suppression(create_suppression_request, opts = {}) ⇒ Array<Suppression>

Create Suppressions Add email addresses to your suppression list to prevent future emails from being sent. This is essential for maintaining sender reputation and compliance. When to Use Each Type: | Type | Use When | |------|----------| | hardBounce | You know an address is permanently invalid | | manual | Processing do-not-contact requests from support | | unsubscribe | Syncing unsubscribes from external systems | | spamComplaint | Importing complaints from other providers | Common Use Cases: - Migration: Import suppression list from previous email provider - CRM Sync: Add unsubscribes from your marketing platform - Bulk Cleanup: Add known invalid addresses from data cleaning - Support Tickets: Honor do-not-contact requests Best Practices: - Import historical bounce data when migrating providers - Sync unsubscribes immediately when received from external sources - Process support-requested suppressions within 24 hours - Use manual for addresses you want to suppress without categorization

Parameters:

Returns:



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

def create_suppression(create_suppression_request, opts = {})
  data, _status_code, _headers = create_suppression_with_http_info(create_suppression_request, opts)
  data
end

#create_suppression_with_http_info(create_suppression_request, opts = {}) ⇒ Array<(Array<Suppression>, Integer, Hash)>

Create Suppressions Add email addresses to your suppression list to prevent future emails from being sent. This is essential for maintaining sender reputation and compliance. When to Use Each Type: | Type | Use When | |------|----------| | `hardBounce` | You know an address is permanently invalid | | `manual` | Processing do-not-contact requests from support | | `unsubscribe` | Syncing unsubscribes from external systems | | `spamComplaint` | Importing complaints from other providers | Common Use Cases: - Migration: Import suppression list from previous email provider - CRM Sync: Add unsubscribes from your marketing platform - Bulk Cleanup: Add known invalid addresses from data cleaning - Support Tickets: Honor do-not-contact requests Best Practices: - Import historical bounce data when migrating providers - Sync unsubscribes immediately when received from external sources - Process support-requested suppressions within 24 hours - Use `manual` for addresses you want to suppress without categorization

Parameters:

Returns:

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

    Array data, response status code and response headers



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

def create_suppression_with_http_info(create_suppression_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SuppressionApi.create_suppression ...'
  end
  # verify the required parameter 'create_suppression_request' is set
  if @api_client.config.client_side_validation && create_suppression_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_suppression_request' when calling SuppressionApi.create_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']) 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(create_suppression_request)

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

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

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

#delete_suppression(delete_suppression_request, opts = {}) ⇒ DeleteSuppression200Response

Delete Suppressions Remove email addresses from your suppression list, allowing them to receive emails again. ⚠️ Important: Use with caution! Re-enabling sending to previously suppressed addresses can harm your sender reputation if used incorrectly. Valid Use Cases: - User confirms their valid email was incorrectly bounced - Manual suppression was added by mistake - User explicitly requests re-subscription after unsubscribing - Testing/development addresses that were suppressed Not Recommended: - Bulk removing hard bounces without individual verification - Removing spam complaints (users rarely want to receive emails again) - Attempting to re-engage addresses that bounced Best Practice: Before removing a suppression, verify with the recipient that they want to receive emails and that their address is valid.

Parameters:

Returns:



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

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

#delete_suppression_with_http_info(delete_suppression_request, opts = {}) ⇒ Array<(DeleteSuppression200Response, Integer, Hash)>

Delete Suppressions Remove email addresses from your suppression list, allowing them to receive emails again. ⚠️ Important: Use with caution! Re-enabling sending to previously suppressed addresses can harm your sender reputation if used incorrectly. Valid Use Cases: - User confirms their valid email was incorrectly bounced - Manual suppression was added by mistake - User explicitly requests re-subscription after unsubscribing - Testing/development addresses that were suppressed Not Recommended: - Bulk removing hard bounces without individual verification - Removing spam complaints (users rarely want to receive emails again) - Attempting to re-engage addresses that bounced Best Practice: Before removing a suppression, verify with the recipient that they want to receive emails and that their address is valid.

Parameters:

Returns:



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

def delete_suppression_with_http_info(delete_suppression_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SuppressionApi.delete_suppression ...'
  end
  # verify the required parameter 'delete_suppression_request' is set
  if @api_client.config.client_side_validation && delete_suppression_request.nil?
    fail ArgumentError, "Missing the required parameter 'delete_suppression_request' 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']) 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(delete_suppression_request)

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

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

  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_suppression_list(from, to, opts = {}) ⇒ Array<Suppression>

List Suppressions Retrieve the suppression list for your sub-account. Suppressions are email addresses that should not receive emails to protect your sender reputation and ensure compliance. Suppression Types: | Type | Reason Code | Description | |------|-------------|-------------| | manual | 0 | Manually added by your team | | unsubscribe | 1 | User clicked unsubscribe link | | hardBounce | 2 | Permanent delivery failure (invalid address) | | spamComplaint | 3 | User marked email as spam | Why Suppressions Matter: - Reputation Protection: Repeatedly sending to bounced addresses damages sender reputation - Compliance: Required for CAN-SPAM, GDPR, and other regulations - Cost Savings: Avoid paying to send undeliverable emails - Deliverability: ISPs penalize senders with high bounce/complaint rates Use Cases: - Export suppression list for compliance audits - Sync suppressions with your CRM or marketing platform - Review recent bounces to identify data quality issues - Monitor spam complaints for content/targeting problems Pagination: Use limit and offset for large suppression lists. Note: Maximum date range is 60 days.

Parameters:

  • from (Date) —

    Start date for suppression records (inclusive). Format YYYY-MM-DD.

  • to (Date) —

    End date for suppression records (inclusive). Max 60 days from `from` date.

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of records to return per request. Default 20, max 100. (default to 20)

  • :offset (Integer) —

    Number of initial records to skip for pagination. (default to 0)

  • :search (String) —

    Case-insensitive search against suppression email addresses.

  • :type (String) —

    Filter by suppression type. Omit to return all types.

Returns:



168
169
170
171
 
# File 'lib/sendpost_ruby_sdk/api/suppression_api.rb', line 168

def get_suppression_list(from, to, opts = {})
  data, _status_code, _headers = get_suppression_list_with_http_info(from, to, opts)
  data
end

#get_suppression_list_with_http_info(from, to, opts = {}) ⇒ Array<(Array<Suppression>, Integer, Hash)>

List Suppressions Retrieve the suppression list for your sub-account. Suppressions are email addresses that should not receive emails to protect your sender reputation and ensure compliance. Suppression Types: | Type | Reason Code | Description | |------|-------------|-------------| | `manual` | 0 | Manually added by your team | | `unsubscribe` | 1 | User clicked unsubscribe link | | `hardBounce` | 2 | Permanent delivery failure (invalid address) | | `spamComplaint` | 3 | User marked email as spam | Why Suppressions Matter: - Reputation Protection: Repeatedly sending to bounced addresses damages sender reputation - Compliance: Required for CAN-SPAM, GDPR, and other regulations - Cost Savings: Avoid paying to send undeliverable emails - Deliverability: ISPs penalize senders with high bounce/complaint rates Use Cases: - Export suppression list for compliance audits - Sync suppressions with your CRM or marketing platform - Review recent bounces to identify data quality issues - Monitor spam complaints for content/targeting problems Pagination: Use `limit` and `offset` for large suppression lists. Note: Maximum date range is 60 days.

Parameters:

  • from (Date) —

    Start date for suppression records (inclusive). Format YYYY-MM-DD.

  • to (Date) —

    End date for suppression records (inclusive). Max 60 days from `from` date.

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of records to return per request. Default 20, max 100. (default to 20)

  • :offset (Integer) —

    Number of initial records to skip for pagination. (default to 0)

  • :search (String) —

    Case-insensitive search against suppression email addresses.

  • :type (String) —

    Filter by suppression type. Omit to return all types.

Returns:

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

    Array data, response status code and response headers



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
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/sendpost_ruby_sdk/api/suppression_api.rb', line 183

def get_suppression_list_with_http_info(from, to, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SuppressionApi.get_suppression_list ...'
  end
  # verify the required parameter 'from' is set
  if @api_client.config.client_side_validation && from.nil?
    fail ArgumentError, "Missing the required parameter 'from' when calling SuppressionApi.get_suppression_list"
  end
  # verify the required parameter 'to' is set
  if @api_client.config.client_side_validation && to.nil?
    fail ArgumentError, "Missing the required parameter 'to' when calling SuppressionApi.get_suppression_list"
  end
  allowable_values = ["hardBounce", "manual", "spamComplaint", "unsubscribe"]
  if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
    fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/subaccount/suppression'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'from'] = from
  query_params[:'to'] = to
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].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] || 'Array<Suppression>'

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

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