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

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

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

An audience member.

Parameters:

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

    A set of parameters to inline-identify a user with. Inline identifying the user

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

    The unique identifier for the tenant.



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/knockapi/models/audience_add_members_params.rb', line 36

class Member < Knockapi::Internal::Type::BaseModel
  # @!attribute user
  #   A set of parameters to inline-identify a user with. Inline identifying the user
  #   will ensure that the user is available before the request is executed in Knock.
  #   It will perform an upsert for the user you're supplying, replacing any
  #   properties specified.
  #
  #   @return [Knockapi::Models::InlineIdentifyUserRequest]
  required :user, -> { Knockapi::InlineIdentifyUserRequest }

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

  # @!method initialize(user:, tenant: nil)
  #   Some parameter documentations has been truncated, see
  #   {Knockapi::Models::AudienceAddMembersParams::Member} for more details.
  #
  #   An audience member.
  #
  #   @param user [Knockapi::Models::InlineIdentifyUserRequest] A set of parameters to inline-identify a user with. Inline identifying the user
  #
  #   @param tenant [String, nil] The unique identifier for the tenant.
end

Instance Attribute Details

#tenant ⇒ String?

The unique identifier for the tenant.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


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

optional :tenant, String, nil?: true

#user ⇒ Knockapi::Models::InlineIdentifyUserRequest

A set of parameters to inline-identify a user with. Inline identifying the user will ensure that the user is available before the request is executed in Knock. It will perform an upsert for the user you're supplying, replacing any properties specified.

Parameters:

Returns:



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

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

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


50
 
# File 'sig/knockapi/models/audience_add_members_params.rbs', line 50

def to_hash: -> {