Class: Telnyx::Resources::EmailUnsubscribeGroups

Inherits:
Object
  • Object
show all
Defined in:
lib/telnyx/resources/email_unsubscribe_groups.rb,
lib/telnyx/resources/email_unsubscribe_groups/suppressions.rb,
sig/telnyx/resources/email_unsubscribe_groups.rbs,
sig/telnyx/resources/email_unsubscribe_groups/suppressions.rbs

Overview

Named groups and group-scoped suppressions.

Defined Under Namespace

Classes: Suppressions

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ EmailUnsubscribeGroups

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

Parameters:



145
146
147
148
 
# File 'lib/telnyx/resources/email_unsubscribe_groups.rb', line 145

def initialize(client:)
  @client = client
  @suppressions = Telnyx::Resources::EmailUnsubscribeGroups::Suppressions.new(client: client)
end

Instance Attribute Details

#suppressions ⇒ Telnyx::Resources::EmailUnsubscribeGroups::Suppressions (readonly)

Named groups and group-scoped suppressions.

Returns:



9
10
11
 
# File 'lib/telnyx/resources/email_unsubscribe_groups.rb', line 9

def suppressions
  @suppressions
end

Instance Method Details

#create(name:, description: nil, request_options: {}) ⇒ Telnyx::Models::UnsubscribeGroupResponse

Create an unsubscribe group

Parameters:

Returns:

See Also:



22
23
24
25
26
27
28
29
30
31
 
# File 'lib/telnyx/resources/email_unsubscribe_groups.rb', line 22

def create(params)
  parsed, options = Telnyx::EmailUnsubscribeGroupCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "email_unsubscribe_groups",
    body: parsed,
    model: Telnyx::UnsubscribeGroupResponse,
    options: options
  )
end

#delete(id, force: nil, request_options: {}) ⇒ nil

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

If the group has 0 active suppressions, hard-deletes the row. With force=true, soft-deletes all active suppressions first (status → removed, group_id cleared, removed audit event per block) in a single transaction, then hard-deletes the group. Without force and active suppressions present → 409. Audit trail is preserved. force only accepts the string "true" or boolean true; all other values are false.

Parameters:

Returns:

  • (nil)

See Also:



130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/telnyx/resources/email_unsubscribe_groups.rb', line 130

def delete(id, params = {})
  parsed, options = Telnyx::EmailUnsubscribeGroupDeleteParams.dump_request(params)
  query = Telnyx::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :delete,
    path: ["email_unsubscribe_groups/%1$s", id],
    query: query,
    model: NilClass,
    options: options
  )
end

#list(page_number: nil, page_size: nil, request_options: {}) ⇒ Telnyx::Internal::DefaultFlatPagination<Telnyx::Models::UnsubscribeGroup>

Offset pagination only (page[number] default 1, page[size] default 25, max 100). No sort/filter/cursor — ordering fixed desc created_at, desc id. Uses the shared QueryParser.parse_offset/1 — a malformed page (e.g. flat ?page=1 instead of ?page[number]=1) returns 400 (code 10015), consistent with GET /v2/email_blocks. meta includes total_pages.

Parameters:

  • page_number (Integer) —

    Offset page number (≥1, default 1).

  • page_size (Integer) —

    Page size (1–100, default 25).

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

Returns:

See Also:



96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/telnyx/resources/email_unsubscribe_groups.rb', line 96

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

#retrieve(id, request_options: {}) ⇒ Telnyx::Models::UnsubscribeGroupResponse

Retrieve an unsubscribe group

Parameters:

  • id (String) —

    Resource UUID. Malformed UUIDs are treated as not-found (not 400).

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

Returns:

See Also:



44
45
46
47
48
49
50
51
 
# File 'lib/telnyx/resources/email_unsubscribe_groups.rb', line 44

def retrieve(id, params = {})
  @client.request(
    method: :get,
    path: ["email_unsubscribe_groups/%1$s", id],
    model: Telnyx::UnsubscribeGroupResponse,
    options: params[:request_options]
  )
end

#update(id, description: nil, name: nil, request_options: {}) ⇒ Telnyx::Models::UnsubscribeGroupResponse

Partial update (only name / description). PUT is not routed.

Parameters:

  • id (String) —

    Resource UUID. Malformed UUIDs are treated as not-found (not 400).

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

Returns:

See Also:



68
69
70
71
72
73
74
75
76
77
 
# File 'lib/telnyx/resources/email_unsubscribe_groups.rb', line 68

def update(id, params = {})
  parsed, options = Telnyx::EmailUnsubscribeGroupUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["email_unsubscribe_groups/%1$s", id],
    body: parsed,
    model: Telnyx::UnsubscribeGroupResponse,
    options: options
  )
end