Class: SendX::ContactApi

Inherits:
Object
  • Object
show all
Defined in:
lib/sendx-ruby-sdk/api/contact_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ContactApi

Returns a new instance of ContactApi.



19
20
21
 
# File 'lib/sendx-ruby-sdk/api/contact_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/sendx-ruby-sdk/api/contact_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_contact(contact_request, opts = {}) ⇒ Response

Create a contact Create Contact with given data

Parameters:

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/sendx-ruby-sdk/api/contact_api.rb', line 27

def create_contact(contact_request, opts = {})
  data, _status_code, _headers = create_contact_with_http_info(contact_request, opts)
  data
end

#create_contact_with_http_info(contact_request, opts = {}) ⇒ Array<(Response, Integer, Hash)>

Create a contact Create Contact with given data

Parameters:

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

    the optional parameters

Returns:

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

    Response 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/sendx-ruby-sdk/api/contact_api.rb', line 37

def create_contact_with_http_info(contact_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactApi.create_contact ...'
  end
  # verify the required parameter 'contact_request' is set
  if @api_client.config.client_side_validation && contact_request.nil?
    fail ArgumentError, "Missing the required parameter 'contact_request' when calling ContactApi.create_contact"
  end
  # resource path
  local_var_path = '/contact'

  # 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(contact_request)

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

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

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

#delete_contact(contact_id, opts = {}) ⇒ Response

Delete Contact Deletes Contact

Parameters:

  • contact_id (String) —

    The Contact ID to delete

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

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/sendx-ruby-sdk/api/contact_api.rb', line 95

def delete_contact(contact_id, opts = {})
  data, _status_code, _headers = delete_contact_with_http_info(contact_id, opts)
  data
end

#delete_contact_with_http_info(contact_id, opts = {}) ⇒ Array<(Response, Integer, Hash)>

Delete Contact Deletes Contact

Parameters:

  • contact_id (String) —

    The Contact ID to delete

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

    the optional parameters

Returns:

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

    Response 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
 
# File 'lib/sendx-ruby-sdk/api/contact_api.rb', line 105

def delete_contact_with_http_info(contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactApi.delete_contact ...'
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactApi.delete_contact"
  end
  # resource path
  local_var_path = '/contact/{contactId}'.sub('{' + 'contactId' + '}', CGI.escape(contact_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] || 'Response'

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

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

#get_all_contacts(opts = {}) ⇒ Array<Contact>

Get All Contacts Find all contacts with optional filters

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    Offset for pagination (default to 0)

  • :limit (Integer) —

    Limit for pagination (default to 10)

  • :contact_type (String) —

    Filter contacts by type

  • :search (String) —

    Search term to filter contacts

Returns:



161
162
163
164
 
# File 'lib/sendx-ruby-sdk/api/contact_api.rb', line 161

def get_all_contacts(opts = {})
  data, _status_code, _headers = get_all_contacts_with_http_info(opts)
  data
end

#get_all_contacts_with_http_info(opts = {}) ⇒ Array<(Array<Contact>, Integer, Hash)>

Get All Contacts Find all contacts with optional filters

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :offset (Integer) —

    Offset for pagination (default to 0)

  • :limit (Integer) —

    Limit for pagination (default to 10)

  • :contact_type (String) —

    Filter contacts by type

  • :search (String) —

    Search term to filter contacts

Returns:

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

    Array<Contact> 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
 
# File 'lib/sendx-ruby-sdk/api/contact_api.rb', line 174

def get_all_contacts_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactApi.get_all_contacts ...'
  end
  allowable_values = ["all", "unsubscribed", "bounced", "markedspam"]
  if @api_client.config.client_side_validation && opts[:'contact_type'] && !allowable_values.include?(opts[:'contact_type'])
    fail ArgumentError, "invalid value for \"contact_type\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/contact'

  # 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[:'contactType'] = opts[:'contact_type'] if !opts[:'contact_type'].nil?
  query_params[:'search'] = opts[:'search'] if !opts[:'search'].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<Contact>'

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

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

#get_contact_by_id(contact_id, opts = {}) ⇒ Contact

Get Contact by ID Retrieve a specific contact by its contactId.

Parameters:

  • contact_id (String) —

    The ID of the contact to retrieve.

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

    the optional parameters

Returns:



231
232
233
234
 
# File 'lib/sendx-ruby-sdk/api/contact_api.rb', line 231

def get_contact_by_id(contact_id, opts = {})
  data, _status_code, _headers = get_contact_by_id_with_http_info(contact_id, opts)
  data
end

#get_contact_by_id_with_http_info(contact_id, opts = {}) ⇒ Array<(Contact, Integer, Hash)>

Get Contact by ID Retrieve a specific contact by its contactId.

Parameters:

  • contact_id (String) —

    The ID of the contact to retrieve.

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

    the optional parameters

Returns:

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

    Contact data, response status code and response headers



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
281
282
283
284
285
286
287
 
# File 'lib/sendx-ruby-sdk/api/contact_api.rb', line 241

def get_contact_by_id_with_http_info(contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactApi.get_contact_by_id ...'
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactApi.get_contact_by_id"
  end
  # resource path
  local_var_path = '/contact/{contactId}'.sub('{' + 'contactId' + '}', CGI.escape(contact_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] || 'Contact'

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

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

#unsubscribe_contact(contact_id, opts = {}) ⇒ Response

Unsubscribe Contact Unsubscribe a globally existing contact

Parameters:

  • contact_id (String) —

    The Contact ID to unsubscribe

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

    the optional parameters

Returns:



294
295
296
297
 
# File 'lib/sendx-ruby-sdk/api/contact_api.rb', line 294

def unsubscribe_contact(contact_id, opts = {})
  data, _status_code, _headers = unsubscribe_contact_with_http_info(contact_id, opts)
  data
end

#unsubscribe_contact_with_http_info(contact_id, opts = {}) ⇒ Array<(Response, Integer, Hash)>

Unsubscribe Contact Unsubscribe a globally existing contact

Parameters:

  • contact_id (String) —

    The Contact ID to unsubscribe

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

    the optional parameters

Returns:

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

    Response data, response status code and response headers



304
305
306
307
308
309
310
311
312
313
314
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
 
# File 'lib/sendx-ruby-sdk/api/contact_api.rb', line 304

def unsubscribe_contact_with_http_info(contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactApi.unsubscribe_contact ...'
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactApi.unsubscribe_contact"
  end
  # resource path
  local_var_path = '/contact/unsubscribe/{contactId}'.sub('{' + 'contactId' + '}', CGI.escape(contact_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] || 'Response'

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

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

#update_contact(contact_request, contact_id, opts = {}) ⇒ Contact

Update Contact Update Contact with given data

Parameters:

  • contact_request (ContactRequest)
  • contact_id (String) —

    The ID of the Contact to update

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

    the optional parameters

Returns:



358
359
360
361
 
# File 'lib/sendx-ruby-sdk/api/contact_api.rb', line 358

def update_contact(contact_request, contact_id, opts = {})
  data, _status_code, _headers = update_contact_with_http_info(contact_request, contact_id, opts)
  data
end

#update_contact_with_http_info(contact_request, contact_id, opts = {}) ⇒ Array<(Contact, Integer, Hash)>

Update Contact Update Contact with given data

Parameters:

  • contact_request (ContactRequest)
  • contact_id (String) —

    The ID of the Contact to update

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

    the optional parameters

Returns:

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

    Contact data, response status code and response headers



369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/sendx-ruby-sdk/api/contact_api.rb', line 369

def update_contact_with_http_info(contact_request, contact_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ContactApi.update_contact ...'
  end
  # verify the required parameter 'contact_request' is set
  if @api_client.config.client_side_validation && contact_request.nil?
    fail ArgumentError, "Missing the required parameter 'contact_request' when calling ContactApi.update_contact"
  end
  # verify the required parameter 'contact_id' is set
  if @api_client.config.client_side_validation && contact_id.nil?
    fail ArgumentError, "Missing the required parameter 'contact_id' when calling ContactApi.update_contact"
  end
  # resource path
  local_var_path = '/contact/{contactId}'.sub('{' + 'contactId' + '}', CGI.escape(contact_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']
  # 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(contact_request)

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

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

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