Class: Lockally::SuppressionsApi

Inherits:
Object
  • Object
show all
Defined in:
lib/lockally/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/lockally/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/lockally/api/suppressions_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#v1_suppressions_email_delete(email, opts = {}) ⇒ nil

Remove a suppression

Parameters:

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

    the optional parameters

Returns:

  • (nil) 


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

def v1_suppressions_email_delete(email, opts = {})
  v1_suppressions_email_delete_with_http_info(email, opts)
  nil
end

#v1_suppressions_email_delete_with_http_info(email, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Remove a suppression

Parameters:

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

    the optional parameters

Returns:

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

    nil, 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/lockally/api/suppressions_api.rb', line 35

def v1_suppressions_email_delete_with_http_info(email, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SuppressionsApi.v1_suppressions_email_delete ...'
  end
  # verify the required parameter 'email' is set
  if @api_client.config.client_side_validation && email.nil?
    fail ArgumentError, "Missing the required parameter 'email' when calling SuppressionsApi.v1_suppressions_email_delete"
  end
  # resource path
  local_var_path = '/v1/suppressions/{email}'.sub('{email}', CGI.escape(email.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/problem+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]

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

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

#v1_suppressions_email_get(email, opts = {}) ⇒ Suppression

Check whether an address is suppressed

Parameters:

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

    the optional parameters

Returns:



87
88
89
90
 
# File 'lib/lockally/api/suppressions_api.rb', line 87

def v1_suppressions_email_get(email, opts = {})
  data, _status_code, _headers = v1_suppressions_email_get_with_http_info(email, opts)
  data
end

#v1_suppressions_email_get_with_http_info(email, opts = {}) ⇒ Array<(Suppression, Integer, Hash)>

Check whether an address is suppressed

Parameters:

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

    the optional parameters

Returns:

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

    Suppression data, response status code and response headers



96
97
98
99
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
 
# File 'lib/lockally/api/suppressions_api.rb', line 96

def v1_suppressions_email_get_with_http_info(email, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SuppressionsApi.v1_suppressions_email_get ...'
  end
  # verify the required parameter 'email' is set
  if @api_client.config.client_side_validation && email.nil?
    fail ArgumentError, "Missing the required parameter 'email' when calling SuppressionsApi.v1_suppressions_email_get"
  end
  # resource path
  local_var_path = '/v1/suppressions/{email}'.sub('{email}', CGI.escape(email.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', 'application/problem+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.v1_suppressions_email_get",
    :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#v1_suppressions_email_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#v1_suppressions_get(opts = {}) ⇒ V1SuppressionsGet200Response

List suppressed recipients

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :reason (String)
  • :cursor (String)
  • :limit (Integer) — default: default to 50

Returns:



150
151
152
153
 
# File 'lib/lockally/api/suppressions_api.rb', line 150

def v1_suppressions_get(opts = {})
  data, _status_code, _headers = v1_suppressions_get_with_http_info(opts)
  data
end

#v1_suppressions_get_with_http_info(opts = {}) ⇒ Array<(V1SuppressionsGet200Response, Integer, Hash)>

List suppressed recipients

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :reason (String)
  • :cursor (String)
  • :limit (Integer) — default: default to 50

Returns:



161
162
163
164
165
166
167
168
169
170
171
172
173
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
 
# File 'lib/lockally/api/suppressions_api.rb', line 161

def v1_suppressions_get_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SuppressionsApi.v1_suppressions_get ...'
  end
  allowable_values = ["unsubscribe", "complaint", "bounce", "manual"]
  if @api_client.config.client_side_validation && opts[:'reason'] && !allowable_values.include?(opts[:'reason'])
    fail ArgumentError, "invalid value for \"reason\", must be one of #{allowable_values}"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 200
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling SuppressionsApi.v1_suppressions_get, must be smaller than or equal to 200.'
  end

  # resource path
  local_var_path = '/v1/suppressions'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'reason'] = opts[:'reason'] if !opts[:'reason'].nil?
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].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', 'application/problem+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] || 'V1SuppressionsGet200Response'

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

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

#v1_suppressions_post(v1_suppressions_post_request, opts = {}) ⇒ Suppression

Add a suppression

Parameters:

Returns:



220
221
222
223
 
# File 'lib/lockally/api/suppressions_api.rb', line 220

def v1_suppressions_post(v1_suppressions_post_request, opts = {})
  data, _status_code, _headers = v1_suppressions_post_with_http_info(v1_suppressions_post_request, opts)
  data
end

#v1_suppressions_post_with_http_info(v1_suppressions_post_request, opts = {}) ⇒ Array<(Suppression, Integer, Hash)>

Add a suppression

Parameters:

Returns:

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

    Suppression data, response status code and response headers



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
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
 
# File 'lib/lockally/api/suppressions_api.rb', line 229

def v1_suppressions_post_with_http_info(v1_suppressions_post_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SuppressionsApi.v1_suppressions_post ...'
  end
  # verify the required parameter 'v1_suppressions_post_request' is set
  if @api_client.config.client_side_validation && v1_suppressions_post_request.nil?
    fail ArgumentError, "Missing the required parameter 'v1_suppressions_post_request' when calling SuppressionsApi.v1_suppressions_post"
  end
  # resource path
  local_var_path = '/v1/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', 'application/problem+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(v1_suppressions_post_request)

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

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

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