Class: Notiflows::Models::NotiflowRunParams::Actor

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/notiflows/models/notiflow_run_params.rb

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(actor: nil, data: nil, recipients: nil, topic: nil, request_options: {}) ⇒ Object

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

Parameters:

  • actor (Notiflows::Models::NotiflowRunParams::Actor) (defaults to: nil) —

    Actor (triggering user) specification. Accessible in templates as actor.*.

  • data (Object) (defaults to: nil) —

    Template variables. Accessible in notification templates as data.*.

  • recipients (Array<Notiflows::Models::NotiflowRunParams::Recipient>) (defaults to: nil) —

    List of recipients. Each recipient must have an external_id. Users are auto-cr

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

    Topic name for pub/sub targeting. Cannot be used with recipients.

  • request_options (Notiflows::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 


49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/notiflows/models/notiflow_run_params.rb', line 49

class Actor < Notiflows::Internal::Type::BaseModel
  # @!attribute external_id
  #   Your system's identifier for the actor (required)
  #
  #   @return [String]
  required :external_id, String

  # @!attribute avatar
  #
  #   @return [String, nil]
  optional :avatar, String

  # @!attribute custom_fields
  #
  #   @return [Object, nil]
  optional :custom_fields, Notiflows::Internal::Type::Unknown

  # @!attribute email
  #
  #   @return [String, nil]
  optional :email, String

  # @!attribute first_name
  #
  #   @return [String, nil]
  optional :first_name, String

  # @!attribute last_name
  #
  #   @return [String, nil]
  optional :last_name, String

  # @!attribute locale
  #
  #   @return [String, nil]
  optional :locale, String

  # @!attribute phone
  #
  #   @return [String, nil]
  optional :phone, String

  # @!attribute timezone
  #
  #   @return [String, nil]
  optional :timezone, String

  # @!method initialize(external_id:, avatar: nil, custom_fields: nil, email: nil, first_name: nil, last_name: nil, locale: nil, phone: nil, timezone: nil)
  #   Actor (triggering user) specification. Accessible in templates as `actor.*`.
  #
  #   @param external_id [String] Your system's identifier for the actor (required)
  #
  #   @param avatar [String]
  #
  #   @param custom_fields [Object]
  #
  #   @param email [String]
  #
  #   @param first_name [String]
  #
  #   @param last_name [String]
  #
  #   @param locale [String]
  #
  #   @param phone [String]
  #
  #   @param timezone [String]
end

Instance Attribute Details

#avatar ⇒ String?

Returns:

  • (String, nil) 


59
 
# File 'lib/notiflows/models/notiflow_run_params.rb', line 59

optional :avatar, String

#custom_fields ⇒ Object?

Returns:

  • (Object, nil) 


64
 
# File 'lib/notiflows/models/notiflow_run_params.rb', line 64

optional :custom_fields, Notiflows::Internal::Type::Unknown

#email ⇒ String?

Returns:

  • (String, nil) 


69
 
# File 'lib/notiflows/models/notiflow_run_params.rb', line 69

optional :email, String

#external_id ⇒ String

Your system's identifier for the actor (required)

Returns:

  • (String) 


54
 
# File 'lib/notiflows/models/notiflow_run_params.rb', line 54

required :external_id, String

#first_name ⇒ String?

Returns:

  • (String, nil) 


74
 
# File 'lib/notiflows/models/notiflow_run_params.rb', line 74

optional :first_name, String

#last_name ⇒ String?

Returns:

  • (String, nil) 


79
 
# File 'lib/notiflows/models/notiflow_run_params.rb', line 79

optional :last_name, String

#locale ⇒ String?

Returns:

  • (String, nil) 


84
 
# File 'lib/notiflows/models/notiflow_run_params.rb', line 84

optional :locale, String

#phone ⇒ String?

Returns:

  • (String, nil) 


89
 
# File 'lib/notiflows/models/notiflow_run_params.rb', line 89

optional :phone, String

#timezone ⇒ String?

Returns:

  • (String, nil) 


94
 
# File 'lib/notiflows/models/notiflow_run_params.rb', line 94

optional :timezone, String