Class: WhopSDK::Models::Audience

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

Overview

See Also:

  • WhopSDK::Resources::Audiences#create

Defined Under Namespace

Modules: Status Classes: MatchRate

Instance Attribute Summary collapse

Class Method 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 ⇒ Object 



44
 
# File 'sig/whop_sdk/models/audience.rbs', line 44

def initialize: (

Instance Attribute Details

#created_at ⇒ String

When the audience was created, as an ISO 8601 timestamp.

Parameters:

  • value (String)

Returns:

  • (String) 


17
 
# File 'lib/whop_sdk/models/audience.rb', line 17

required :created_at, String

#error_message ⇒ String?

Processing error message. null unless processing is partial or failed.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


23
 
# File 'lib/whop_sdk/models/audience.rb', line 23

required :error_message, String, nil?: true

#id ⇒ String

Audience ID, prefixed adaud_.

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/whop_sdk/models/audience.rb', line 11

required :id, String

#match_rates ⇒ Array<WhopSDK::Models::Audience::MatchRate>

Parameters:

  • value (::Array[WhopSDK::Audience::MatchRate])

Returns:



28
 
# File 'lib/whop_sdk/models/audience.rb', line 28

required :match_rates, -> { WhopSDK::Internal::Type::ArrayOf[WhopSDK::Audience::MatchRate] }

#matched_rows ⇒ Float

Rows successfully uploaded to connected ad accounts.

Parameters:

  • value (Float)

Returns:

  • (Float) 


34
 
# File 'lib/whop_sdk/models/audience.rb', line 34

required :matched_rows, Float

#name ⇒ String

Audience display name.

Parameters:

  • value (String)

Returns:

  • (String) 


40
 
# File 'lib/whop_sdk/models/audience.rb', line 40

required :name, String

#platform_audience_ids ⇒ Array<String>

Parameters:

  • value (::Array[String])

Returns:

  • (Array<String>) 


45
 
# File 'lib/whop_sdk/models/audience.rb', line 45

required :platform_audience_ids, WhopSDK::Internal::Type::ArrayOf[String]

#processed_rows ⇒ Float

Rows processed from the uploaded CSV.

Parameters:

  • value (Float)

Returns:

  • (Float) 


51
 
# File 'lib/whop_sdk/models/audience.rb', line 51

required :processed_rows, Float

#progress_percent ⇒ Float

Processing progress from 0 to 100.

Parameters:

  • value (Float)

Returns:

  • (Float) 


57
 
# File 'lib/whop_sdk/models/audience.rb', line 57

required :progress_percent, Float

#status ⇒ Symbol, WhopSDK::Models::Audience::Status

Current state of the audience import. syncing means Whop is sending matched rows to connected ad accounts. When status is partial or failed, error_message explains what went wrong.

Parameters:

  • value (WhopSDK::Models::Audience::status)

Returns:



65
 
# File 'lib/whop_sdk/models/audience.rb', line 65

required :status, enum: -> { WhopSDK::Audience::Status }

#total_rows ⇒ Float

Total rows detected in the uploaded CSV.

Parameters:

  • value (Float)

Returns:

  • (Float) 


71
 
# File 'lib/whop_sdk/models/audience.rb', line 71

required :total_rows, Float

#updated_at ⇒ String

When the audience was last updated, as an ISO 8601 timestamp.

Parameters:

  • value (String)

Returns:

  • (String) 


77
 
# File 'lib/whop_sdk/models/audience.rb', line 77

required :updated_at, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/whop_sdk/models/audience.rb', line 166

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


59
 
# File 'sig/whop_sdk/models/audience.rbs', line 59

def to_hash: -> {