Class: Telnyx::Resources::MessagingOptouts

Inherits:

Object

• Object
• Telnyx::Resources::MessagingOptouts

Defined in:

lib/telnyx/resources/messaging_optouts.rb

Overview

Opt-Out Management

Instance Method Summary

• #initialize(client:) ⇒ MessagingOptouts constructor private

  A new instance of MessagingOptouts.

• #list(created_at: nil, filter: nil, page_number: nil, page_size: nil, redaction_enabled: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::MessagingOptoutListResponse>

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

Constructor Details

#initialize(client:) ⇒ MessagingOptouts

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 MessagingOptouts.

Parameters:

• client (Telnyx::Client)

# File 'lib/telnyx/resources/messaging_optouts.rb', line 45

def initialize(client:)
  @client = client
end

Instance Method Details

#list(created_at: nil, filter: nil, page_number: nil, page_size: nil, redaction_enabled: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::MessagingOptoutListResponse>

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

Retrieve a list of opt-out blocks.

Parameters:

• created_at (Telnyx::Models::MessagingOptoutListParams::CreatedAt) —

  Consolidated created_at parameter (deepObject style). Originally: created_at[gte

• filter (Telnyx::Models::MessagingOptoutListParams::Filter) —

  Consolidated filter parameter (deepObject style). Originally: filter[messaging_p

• page_number (Integer)
• page_size (Integer)
• redaction_enabled (String) —

  If receiving address (+E.164 formatted phone number) should be redacted

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

Returns:

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

See Also:

• Models::MessagingOptoutListParams

# File 'lib/telnyx/resources/messaging_optouts.rb', line 29

def list(params = {})
  parsed, options = Telnyx::MessagingOptoutListParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "messaging_optouts",
    query: query.transform_keys(page_number: "page[number]", page_size: "page[size]"),
    page: Telnyx::Internal::DefaultFlatPagination,
    model: Telnyx::Models::MessagingOptoutListResponse,
    options: options
  )
end