Class: SurgeAPI::Models::AudienceCreateResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/surge_api/models/audience_create_response.rb,
sig/surge_api/models/audience_create_response.rbs

Overview

See Also:

  • SurgeAPI::Resources::Audiences#create

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(id:, name:) ⇒ AudienceCreateResponse

A group of contacts used for targeting messages.

Parameters:

  • id (String) —

    Unique identifier for the object.

  • name (String) —

    A name to identify this Audience. This name will only be visible within Surge.

  • id: (String)
  • name: (String) 



# File 'lib/surge_api/models/audience_create_response.rb', line 19

Instance Attribute Details

#id ⇒ String

Unique identifier for the object.

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/surge_api/models/audience_create_response.rb', line 11

required :id, String

#name ⇒ String

A name to identify this Audience. This name will only be visible within Surge.

Parameters:

  • value (String)

Returns:

  • (String) 


17
 
# File 'lib/surge_api/models/audience_create_response.rb', line 17

required :name, String

Instance Method Details

#to_hash ⇒ { id: String, name: String }

Returns:

  • ({ id: String, name: String }) 


12
 
# File 'sig/surge_api/models/audience_create_response.rbs', line 12

def to_hash: -> { id: String, name: String }