Class: Knockapi::Models::AudienceAddMembersParams::Member

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/knockapi/models/audience_add_members_params.rb

Defined Under Namespace

Classes: User

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(user:, tenant: nil) ⇒ Object

An audience member.

Parameters:



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/knockapi/models/audience_add_members_params.rb', line 21

class Member < Knockapi::Internal::Type::BaseModel
  # @!attribute user
  #   An object containing the user's ID.
  #
  #   @return [Knockapi::Models::AudienceAddMembersParams::Member::User]
  required :user, -> { Knockapi::AudienceAddMembersParams::Member::User }

  # @!attribute tenant
  #   The unique identifier for the tenant.
  #
  #   @return [String, nil]
  optional :tenant, String, nil?: true

  # @!method initialize(user:, tenant: nil)
  #   An audience member.
  #
  #   @param user [Knockapi::Models::AudienceAddMembersParams::Member::User] An object containing the user's ID.
  #
  #   @param tenant [String, nil] The unique identifier for the tenant.

  # @see Knockapi::Models::AudienceAddMembersParams::Member#user
  class User < Knockapi::Internal::Type::BaseModel
    # @!attribute id
    #   The unique identifier of the user.
    #
    #   @return [String, nil]
    optional :id, String

    # @!method initialize(id: nil)
    #   An object containing the user's ID.
    #
    #   @param id [String] The unique identifier of the user.
  end
end

Instance Attribute Details

#tenant ⇒ String?

The unique identifier for the tenant.

Returns:

  • (String, nil) 


32
 
# File 'lib/knockapi/models/audience_add_members_params.rb', line 32

optional :tenant, String, nil?: true

#user ⇒ Knockapi::Models::AudienceAddMembersParams::Member::User

An object containing the user’s ID.

Returns:



26
 
# File 'lib/knockapi/models/audience_add_members_params.rb', line 26

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