Class: Telnyx::Resources::Whatsapp::Templates

Inherits:

Object

• Object
• Telnyx::Resources::Whatsapp::Templates

Defined in:

lib/telnyx/resources/whatsapp/templates.rb

Overview

Manage Whatsapp message templates

Instance Method Summary

• #create(category:, components:, language:, name:, waba_id:, request_options: {}) ⇒ Telnyx::Models::Whatsapp::TemplateCreateResponse

  Some parameter documentations has been truncated, see Models::Whatsapp::TemplateCreateParams for more details.

• #initialize(client:) ⇒ Templates constructor private

  A new instance of Templates.

• #list(filter_category: nil, filter_search: nil, filter_status: nil, filter_waba_id: nil, page_number: nil, page_size: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::WhatsappTemplateData>

  List Whatsapp message templates.

Constructor Details

#initialize(client:) ⇒ Templates

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Templates.

Parameters:

• client (Telnyx::Client)

# File 'lib/telnyx/resources/whatsapp/templates.rb', line 85

def initialize(client:)
  @client = client
end

Instance Method Details

#create(category:, components:, language:, name:, waba_id:, request_options: {}) ⇒ Telnyx::Models::Whatsapp::TemplateCreateResponse

Some parameter documentations has been truncated, see Models::Whatsapp::TemplateCreateParams for more details.

Create a Whatsapp message template

Parameters:

• category (Symbol, Telnyx::Models::Whatsapp::TemplateCreateParams::Category) —

  Template category: AUTHENTICATION, UTILITY, or MARKETING.

• components (Array<Telnyx::Models::Whatsapp::TemplateCreateParams::Component::Header, Telnyx::Models::Whatsapp::TemplateCreateParams::Component::Body, Telnyx::Models::Whatsapp::TemplateCreateParams::Component::Footer, Telnyx::Models::Whatsapp::TemplateCreateParams::Component::Buttons, Telnyx::Models::Whatsapp::TemplateCreateParams::Component::Carousel>) —

  Template components defining message structure. Passed through to Meta Graph API

• language (String) —

  Template language code (e.g. en_US, es, pt_BR).

• name (String) —

  Template name. Lowercase letters, numbers, and underscores only.

• waba_id (String) —

  The WhatsApp Business Account ID.

• request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Telnyx::Models::Whatsapp::TemplateCreateResponse)

See Also:

• Models::Whatsapp::TemplateCreateParams

# File 'lib/telnyx/resources/whatsapp/templates.rb', line 30

def create(params)
  parsed, options = Telnyx::Whatsapp::TemplateCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "v2/whatsapp/message_templates",
    body: parsed,
    model: Telnyx::Models::Whatsapp::TemplateCreateResponse,
    options: options
  )
end

#list(filter_category: nil, filter_search: nil, filter_status: nil, filter_waba_id: nil, page_number: nil, page_size: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::WhatsappTemplateData>

List Whatsapp message templates

Parameters:

• filter_category (Symbol, Telnyx::Models::Whatsapp::TemplateListParams::FilterCategory) —

  Filter by category

• filter_search (String) —

  Search templates by name

• filter_status (String) —

  Filter by template status

• filter_waba_id (String) —

  Filter by WABA ID

• page_number (Integer)
• page_size (Integer)
• request_options (Telnyx::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::WhatsappTemplateData>)

See Also:

• Models::Whatsapp::TemplateListParams

# File 'lib/telnyx/resources/whatsapp/templates.rb', line 62

def list(params = {})
  parsed, options = Telnyx::Whatsapp::TemplateListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "v2/whatsapp/message_templates",
    query: query.transform_keys(
      filter_category: "filter[category]",
      filter_search: "filter[search]",
      filter_status: "filter[status]",
      filter_waba_id: "filter[waba_id]",
      page_number: "page[number]",
      page_size: "page[size]"
    ),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::WhatsappTemplateData,
    options: options
  )
end