Class: Knockapi::Models::AudienceRemoveMembersParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Knockapi::Models::AudienceRemoveMembersParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/knockapi/models/audience_remove_members_params.rb,
sig/knockapi/models/audience_remove_members_params.rbs

Overview

See Also:

• Knockapi::Resources::Audiences#remove_members

Instance Attribute Summary

• #key ⇒ String
• #members ⇒ Array<Knockapi::Models::AudienceMemberRequest>

  A list of audience members to remove.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(key:, members:, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see AudienceRemoveMembersParams for more details.

• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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(key:, members:, request_options: {}) ⇒ Object

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

Parameters:

• key (String)
• members (Array<Knockapi::Models::AudienceMemberRequest>) —

  A list of audience members to remove. You can remove up to 1,000 members per req

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

# File 'lib/knockapi/models/audience_remove_members_params.rb', line 22

Instance Attribute Details

#key ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/knockapi/models/audience_remove_members_params.rb', line 13

required :key, String

#members ⇒ Array<Knockapi::Models::AudienceMemberRequest>

A list of audience members to remove. You can remove up to 1,000 members per request.

Parameters:

• value (::Array[Knockapi::AudienceMemberRequest])

Returns:

• (Array<Knockapi::Models::AudienceMemberRequest>)

# File 'lib/knockapi/models/audience_remove_members_params.rb', line 20

required :members, -> { Knockapi::Internal::Type::ArrayOf[Knockapi::AudienceMemberRequest] }

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/knockapi/models/audience_remove_members_params.rbs', line 21

def to_hash: -> {