Class: MessenteApi::WhatsAppTemplatesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/messente_api/api/whats_app_templates_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ WhatsAppTemplatesApi

Returns a new instance of WhatsAppTemplatesApi.



19
20
21
 
# File 'lib/messente_api/api/whats_app_templates_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/messente_api/api/whats_app_templates_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_whatsapp_template(waba_id, whatsapp_create_template_request, opts = {}) ⇒ WhatsappCreateTemplateResponse

Creates a WhatsApp template

Parameters:

  • waba_id (String) —

    The ID of the WABA

  • whatsapp_create_template_request (WhatsappCreateTemplateRequest) —

    The WhatsApp template to create

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/messente_api/api/whats_app_templates_api.rb', line 27

def create_whatsapp_template(waba_id, whatsapp_create_template_request, opts = {})
  data, _status_code, _headers = create_whatsapp_template_with_http_info(waba_id, whatsapp_create_template_request, opts)
  data
end

#create_whatsapp_template_with_http_info(waba_id, whatsapp_create_template_request, opts = {}) ⇒ Array<(WhatsappCreateTemplateResponse, Integer, Hash)>

Creates a WhatsApp template

Parameters:

  • waba_id (String) —

    The ID of the WABA

  • whatsapp_create_template_request (WhatsappCreateTemplateRequest) —

    The WhatsApp template to create

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

    the optional parameters

Returns:



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
89
90
91
92
 
# File 'lib/messente_api/api/whats_app_templates_api.rb', line 37

def create_whatsapp_template_with_http_info(waba_id, whatsapp_create_template_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WhatsAppTemplatesApi.create_whatsapp_template ...'
  end
  # verify the required parameter 'waba_id' is set
  if @api_client.config.client_side_validation && waba_id.nil?
    fail ArgumentError, "Missing the required parameter 'waba_id' when calling WhatsAppTemplatesApi.create_whatsapp_template"
  end
  # verify the required parameter 'whatsapp_create_template_request' is set
  if @api_client.config.client_side_validation && whatsapp_create_template_request.nil?
    fail ArgumentError, "Missing the required parameter 'whatsapp_create_template_request' when calling WhatsAppTemplatesApi.create_whatsapp_template"
  end
  # resource path
  local_var_path = '/whatsapp/wabas/{wabaId}/templates'.sub('{' + 'wabaId' + '}', CGI.escape(waba_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(whatsapp_create_template_request)

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

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

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

#delete_whatsapp_template(waba_id, name, opts = {}) ⇒ Object

Deletes a WhatsApp template

Parameters:

  • waba_id (String) —

    The ID of the WABA

  • name (String) —

    The name of the template to delete

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

    the optional parameters

Options Hash (opts):

  • :hsm_id (String) —

    The ID of the template to delete

Returns:

  • (Object) 


100
101
102
103
 
# File 'lib/messente_api/api/whats_app_templates_api.rb', line 100

def delete_whatsapp_template(waba_id, name, opts = {})
  data, _status_code, _headers = delete_whatsapp_template_with_http_info(waba_id, name, opts)
  data
end

#delete_whatsapp_template_with_http_info(waba_id, name, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Deletes a WhatsApp template

Parameters:

  • waba_id (String) —

    The ID of the WABA

  • name (String) —

    The name of the template to delete

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

    the optional parameters

Options Hash (opts):

  • :hsm_id (String) —

    The ID of the template to delete

Returns:

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

    Object data, response status code and response headers



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
158
159
160
161
162
163
 
# File 'lib/messente_api/api/whats_app_templates_api.rb', line 111

def delete_whatsapp_template_with_http_info(waba_id, name, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WhatsAppTemplatesApi.delete_whatsapp_template ...'
  end
  # verify the required parameter 'waba_id' is set
  if @api_client.config.client_side_validation && waba_id.nil?
    fail ArgumentError, "Missing the required parameter 'waba_id' when calling WhatsAppTemplatesApi.delete_whatsapp_template"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling WhatsAppTemplatesApi.delete_whatsapp_template"
  end
  # resource path
  local_var_path = '/whatsapp/wabas/{wabaId}/templates'.sub('{' + 'wabaId' + '}', CGI.escape(waba_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'name'] = name
  query_params[:'hsmId'] = opts[:'hsm_id'] if !opts[:'hsm_id'].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] || 'Object'

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

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

#get_whatsapp_template_by_id(waba_id, template_id, opts = {}) ⇒ WhatsappTemplateResponse

Requests a WhatsApp template with the given ID

Parameters:

  • waba_id (String) —

    The ID of the WABA

  • template_id (String) —

    The ID of the template to retrieve

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

    the optional parameters

Returns:



170
171
172
173
 
# File 'lib/messente_api/api/whats_app_templates_api.rb', line 170

def get_whatsapp_template_by_id(waba_id, template_id, opts = {})
  data, _status_code, _headers = get_whatsapp_template_by_id_with_http_info(waba_id, template_id, opts)
  data
end

#get_whatsapp_template_by_id_with_http_info(waba_id, template_id, opts = {}) ⇒ Array<(WhatsappTemplateResponse, Integer, Hash)>

Requests a WhatsApp template with the given ID

Parameters:

  • waba_id (String) —

    The ID of the WABA

  • template_id (String) —

    The ID of the template to retrieve

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

    the optional parameters

Returns:

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

    WhatsappTemplateResponse data, response status code and response headers



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
 
# File 'lib/messente_api/api/whats_app_templates_api.rb', line 180

def get_whatsapp_template_by_id_with_http_info(waba_id, template_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WhatsAppTemplatesApi.get_whatsapp_template_by_id ...'
  end
  # verify the required parameter 'waba_id' is set
  if @api_client.config.client_side_validation && waba_id.nil?
    fail ArgumentError, "Missing the required parameter 'waba_id' when calling WhatsAppTemplatesApi.get_whatsapp_template_by_id"
  end
  # verify the required parameter 'template_id' is set
  if @api_client.config.client_side_validation && template_id.nil?
    fail ArgumentError, "Missing the required parameter 'template_id' when calling WhatsAppTemplatesApi.get_whatsapp_template_by_id"
  end
  # resource path
  local_var_path = '/whatsapp/wabas/{wabaId}/templates/{templateId}'.sub('{' + 'wabaId' + '}', CGI.escape(waba_id.to_s)).sub('{' + 'templateId' + '}', CGI.escape(template_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] || 'WhatsappTemplateResponse'

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

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

#list_whatsapp_templates(waba_id, opts = {}) ⇒ WhatsappListTemplatesResponse

Requests a list of WhatsApp templates

Parameters:

  • waba_id (String) —

    The ID of the WABA

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of templates to return in the list. Although the max size is 500, for large datasets it is recommended to use a lower limit and instead use pagination to avoid potential timeouts. Defaults to 25. (default to 25)

  • :before (String) —

    A cursor point used for a paginated request to indicate the template to paginate backwards from.

  • :after (String) —

    A cursor point used for a paginated request to indicate the template to paginate forwards from.

  • :category (WhatsappTemplateCategory) —

    A filter for returning only templates matching a specific category.

  • :content (String) —

    A search filter representing the content of a template. Only matching templates will be returned in the list.

  • :language (String) —

    A filter for returning only templates matching a specific language code. A list of supported languages is available in the WhatsApp documentation

  • :name (String) —

    A search filter representing the name, either full or partial, of a template. Only matching templates will be returned in the list.

  • :status (WhatsappTemplateStatus) —

    A filter for returning only templates matching a specific status.

Returns:



244
245
246
247
 
# File 'lib/messente_api/api/whats_app_templates_api.rb', line 244

def list_whatsapp_templates(waba_id, opts = {})
  data, _status_code, _headers = list_whatsapp_templates_with_http_info(waba_id, opts)
  data
end

#list_whatsapp_templates_with_http_info(waba_id, opts = {}) ⇒ Array<(WhatsappListTemplatesResponse, Integer, Hash)>

Requests a list of WhatsApp templates

Parameters:

  • waba_id (String) —

    The ID of the WABA

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    The number of templates to return in the list. Although the max size is 500, for large datasets it is recommended to use a lower limit and instead use pagination to avoid potential timeouts. Defaults to 25. (default to 25)

  • :before (String) —

    A cursor point used for a paginated request to indicate the template to paginate backwards from.

  • :after (String) —

    A cursor point used for a paginated request to indicate the template to paginate forwards from.

  • :category (WhatsappTemplateCategory) —

    A filter for returning only templates matching a specific category.

  • :content (String) —

    A search filter representing the content of a template. Only matching templates will be returned in the list.

  • :language (String) —

    A filter for returning only templates matching a specific language code. A list of supported languages is available in the WhatsApp documentation

  • :name (String) —

    A search filter representing the name, either full or partial, of a template. Only matching templates will be returned in the list.

  • :status (WhatsappTemplateStatus) —

    A filter for returning only templates matching a specific status.

Returns:



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
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/messente_api/api/whats_app_templates_api.rb', line 261

def list_whatsapp_templates_with_http_info(waba_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WhatsAppTemplatesApi.list_whatsapp_templates ...'
  end
  # verify the required parameter 'waba_id' is set
  if @api_client.config.client_side_validation && waba_id.nil?
    fail ArgumentError, "Missing the required parameter 'waba_id' when calling WhatsAppTemplatesApi.list_whatsapp_templates"
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 500
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling WhatsAppTemplatesApi.list_whatsapp_templates, must be smaller than or equal to 500.'
  end

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

  # resource path
  local_var_path = '/whatsapp/wabas/{wabaId}/templates'.sub('{' + 'wabaId' + '}', CGI.escape(waba_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
  query_params[:'after'] = opts[:'after'] if !opts[:'after'].nil?
  query_params[:'category'] = opts[:'category'] if !opts[:'category'].nil?
  query_params[:'content'] = opts[:'content'] if !opts[:'content'].nil?
  query_params[:'language'] = opts[:'language'] if !opts[:'language'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].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] || 'WhatsappListTemplatesResponse'

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

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

#update_whatsapp_template(waba_id, template_id, whatsapp_update_template_request, opts = {}) ⇒ Object

Updates a WhatsApp template

Parameters:

  • waba_id (String) —

    The ID of the WABA

  • template_id (String) —

    The ID of the template to update

  • whatsapp_update_template_request (WhatsappUpdateTemplateRequest) —

    The template data to be updated

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

    the optional parameters

Returns:

  • (Object) 


331
332
333
334
 
# File 'lib/messente_api/api/whats_app_templates_api.rb', line 331

def update_whatsapp_template(waba_id, template_id, whatsapp_update_template_request, opts = {})
  data, _status_code, _headers = update_whatsapp_template_with_http_info(waba_id, template_id, whatsapp_update_template_request, opts)
  data
end

#update_whatsapp_template_with_http_info(waba_id, template_id, whatsapp_update_template_request, opts = {}) ⇒ Array<(Object, Integer, Hash)>

Updates a WhatsApp template

Parameters:

  • waba_id (String) —

    The ID of the WABA

  • template_id (String) —

    The ID of the template to update

  • whatsapp_update_template_request (WhatsappUpdateTemplateRequest) —

    The template data to be updated

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

    the optional parameters

Returns:

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

    Object data, response status code and response headers



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
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
 
# File 'lib/messente_api/api/whats_app_templates_api.rb', line 342

def update_whatsapp_template_with_http_info(waba_id, template_id, whatsapp_update_template_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WhatsAppTemplatesApi.update_whatsapp_template ...'
  end
  # verify the required parameter 'waba_id' is set
  if @api_client.config.client_side_validation && waba_id.nil?
    fail ArgumentError, "Missing the required parameter 'waba_id' when calling WhatsAppTemplatesApi.update_whatsapp_template"
  end
  # verify the required parameter 'template_id' is set
  if @api_client.config.client_side_validation && template_id.nil?
    fail ArgumentError, "Missing the required parameter 'template_id' when calling WhatsAppTemplatesApi.update_whatsapp_template"
  end
  # resource path
  local_var_path = '/whatsapp/wabas/{wabaId}/templates/{templateId}'.sub('{' + 'wabaId' + '}', CGI.escape(waba_id.to_s)).sub('{' + 'templateId' + '}', CGI.escape(template_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(whatsapp_update_template_request)

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

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

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