Class: Knockapi::Models::AudienceMember

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/knockapi/models/audience_member.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(_typename:, added_at:, user:, user_id:, tenant: nil) ⇒ Object

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

An audience member.

Parameters:

  • _typename (String) —

    The typename of the schema.

  • added_at (Time) —

    Timestamp when the resource was created.

  • user (Knockapi::Models::User) —

    A [User](/concepts/users) represents an individual in your system who can receiv

  • user_id (String) —

    The unique identifier of the user.

  • tenant (String, nil) (defaults to: nil) —

    The unique identifier for the tenant.




# File 'lib/knockapi/models/audience_member.rb', line 38

Instance Attribute Details

#_typename ⇒ String

The typename of the schema.

Returns:

  • (String) 


10
 
# File 'lib/knockapi/models/audience_member.rb', line 10

required :_typename, String, api_name: :__typename

#added_at ⇒ Time

Timestamp when the resource was created.

Returns:

  • (Time) 


16
 
# File 'lib/knockapi/models/audience_member.rb', line 16

required :added_at, Time

#tenant ⇒ String?

The unique identifier for the tenant.

Returns:

  • (String, nil) 


36
 
# File 'lib/knockapi/models/audience_member.rb', line 36

optional :tenant, String, nil?: true

#user ⇒ Knockapi::Models::User

A [User](/concepts/users) represents an individual in your system who can receive notifications through Knock. Users are the most common recipients of notifications and are always referenced by your internal identifier.

Returns:



24
 
# File 'lib/knockapi/models/audience_member.rb', line 24

required :user, -> { Knockapi::User }

#user_id ⇒ String

The unique identifier of the user.

Returns:

  • (String) 


30
 
# File 'lib/knockapi/models/audience_member.rb', line 30

required :user_id, String