Class: Courier::Resources::Tenants::Preferences::Items

Inherits:
Object
  • Object
show all
Defined in:
lib/courier/resources/tenants/preferences/items.rb,
sig/courier/resources/tenants/preferences/items.rbs

Overview

Manage tenants — the organizations, teams, or accounts your users belong to — along with their users and default preferences.

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Items

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

Parameters:



79
80
81
 
# File 'lib/courier/resources/tenants/preferences/items.rb', line 79

def initialize(client:)
  @client = client
end

Instance Method Details

#delete(topic_id, tenant_id:, request_options: {}) ⇒ nil

Removes a tenant's default preference for one subscription topic, addressed by tenant id and topic id.

Parameters:

  • topic_id (String) —

    Id of the subscription topic you want to have a default preference for.

  • tenant_id (String) —

    Id of the tenant to update the default preferences for.

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

Returns:

  • (nil)

See Also:



62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/courier/resources/tenants/preferences/items.rb', line 62

def delete(topic_id, params)
  parsed, options = Courier::Tenants::Preferences::ItemDeleteParams.dump_request(params)
  tenant_id =
    parsed.delete(:tenant_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["tenants/%1$s/default_preferences/items/%2$s", tenant_id, topic_id],
    model: NilClass,
    options: options
  )
end

#update(topic_id, tenant_id:, status:, custom_routing: nil, has_custom_routing: nil, request_options: {}) ⇒ nil

Some parameter documentations has been truncated, see Models::Tenants::Preferences::ItemUpdateParams for more details.

Sets a tenant's default opt-in status for one subscription topic, which applies to every member unless a user sets their own override.

Parameters:

  • topic_id (String) —

    Path param: Id of the subscription topic you want to have a default preference f

  • tenant_id (String) —

    Path param: Id of the tenant to update the default preferences for.

  • status (Symbol, Courier::Models::SubscriptionTopicNew::Status) —

    Body param

  • custom_routing (Array<Symbol, Courier::Models::ChannelClassification>, nil) —

    Body param: The default channels to send to this tenant when has_custom_routing

  • has_custom_routing (Boolean, nil) —

    Body param: Override channel routing with custom preferences. This will override

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

Returns:

  • (nil)

See Also:



33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/courier/resources/tenants/preferences/items.rb', line 33

def update(topic_id, params)
  parsed, options = Courier::Tenants::Preferences::ItemUpdateParams.dump_request(params)
  tenant_id =
    parsed.delete(:tenant_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :put,
    path: ["tenants/%1$s/default_preferences/items/%2$s", tenant_id, topic_id],
    body: parsed,
    model: NilClass,
    options: options
  )
end