Class: Courier::Models::JourneySendNodeToMsTeams

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/courier/models/journey_send_node_to_ms_teams.rb,
sig/courier/models/journey_send_node_to_ms_teams.rbs

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(channel_id: nil, channel_name: nil, email: nil, service_url: nil, team_id: nil, tenant_id: nil, user_id: nil) ⇒ Object

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

Send to a Microsoft Teams address directly, bypassing the recipient's stored profile. Requires exactly one target: channel_id, channel_name (with team_id), user_id, or email. channel_name, user_id, and email also need at least one of service_url or tenant_id — if you provide both, they must agree. channel_id doesn't require tenant context to publish, but provide service_url or tenant_id anyway: sends without either have failed at delivery in testing. conversation_id and reply_to_activity_id, available on the send API's MsTeams profile, aren't supported here yet.

Parameters:

  • channel_id (String) (defaults to: nil) —

    Bot Framework channel ID to send to.

  • channel_name (String) (defaults to: nil) —

    Teams channel name to send to. Requires team_id.

  • email (String) (defaults to: nil) —

    Email address of the Teams user to send to.

  • service_url (String) (defaults to: nil) —

    The regional Bot Framework host for this conversation, e.g. `https://smba.traffi

  • team_id (String) (defaults to: nil) —

    Microsoft Teams team ID. Required alongside channel_name.

  • tenant_id (String) (defaults to: nil) —

    The Microsoft (Azure AD) tenant this send targets or authenticates against. Unre

  • user_id (String) (defaults to: nil) —

    Microsoft Teams user ID to send to.




# File 'lib/courier/models/journey_send_node_to_ms_teams.rb', line 53

Instance Attribute Details

#channel_id ⇒ String?

Bot Framework channel ID to send to.

Parameters:

  • (String)

Returns:

  • (String, nil) 


10
 
# File 'lib/courier/models/journey_send_node_to_ms_teams.rb', line 10

optional :channel_id, String

#channel_name ⇒ String?

Teams channel name to send to. Requires team_id.

Parameters:

  • (String)

Returns:

  • (String, nil) 


16
 
# File 'lib/courier/models/journey_send_node_to_ms_teams.rb', line 16

optional :channel_name, String

#email ⇒ String?

Email address of the Teams user to send to.

Parameters:

  • (String)

Returns:

  • (String, nil) 


22
 
# File 'lib/courier/models/journey_send_node_to_ms_teams.rb', line 22

optional :email, String

#service_url ⇒ String?

The regional Bot Framework host for this conversation, e.g. https://smba.trafficmanager.net/amer. A path segment naming the Microsoft tenant may follow it and is used to derive tenant_id when it is not supplied directly.

Parameters:

  • (String)

Returns:

  • (String, nil) 


31
 
# File 'lib/courier/models/journey_send_node_to_ms_teams.rb', line 31

optional :service_url, String

#team_id ⇒ String?

Microsoft Teams team ID. Required alongside channel_name.

Parameters:

  • (String)

Returns:

  • (String, nil) 


37
 
# File 'lib/courier/models/journey_send_node_to_ms_teams.rb', line 37

optional :team_id, String

#tenant_id ⇒ String?

The Microsoft (Azure AD) tenant this send targets or authenticates against. Unrelated to message.context.tenant_id, which is the Courier customer's own multi-tenant context.

Parameters:

  • (String)

Returns:

  • (String, nil) 


45
 
# File 'lib/courier/models/journey_send_node_to_ms_teams.rb', line 45

optional :tenant_id, String

#user_id ⇒ String?

Microsoft Teams user ID to send to.

Parameters:

  • (String)

Returns:

  • (String, nil) 


51
 
# File 'lib/courier/models/journey_send_node_to_ms_teams.rb', line 51

optional :user_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


53
 
# File 'sig/courier/models/journey_send_node_to_ms_teams.rbs', line 53

def to_hash: -> {