Class: WhopSDK::Models::AdCampaignRetrieveParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/whop_sdk/models/ad_campaign_retrieve_params.rb,
sig/whop_sdk/models/ad_campaign_retrieve_params.rbs

Overview

See Also:

  • WhopSDK::Resources::AdCampaigns#retrieve

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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(id:, stats_from: nil, stats_to: nil, time_zone: nil, request_options: {}) ⇒ Object

Parameters:

  • id (String)
  • stats_from (String) (defaults to: nil) —

    Start of the stats window.

  • stats_to (String) (defaults to: nil) —

    End of the stats window.

  • time_zone (String) (defaults to: nil) —

    IANA timezone the stats window is interpreted in. Defaults to UTC.

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



# File 'lib/whop_sdk/models/ad_campaign_retrieve_params.rb', line 33

Instance Attribute Details

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


13
 
# File 'lib/whop_sdk/models/ad_campaign_retrieve_params.rb', line 13

required :id, String

#stats_from ⇒ String?

Start of the stats window.

Parameters:

  • (String)

Returns:

  • (String, nil) 


19
 
# File 'lib/whop_sdk/models/ad_campaign_retrieve_params.rb', line 19

optional :stats_from, String

#stats_to ⇒ String?

End of the stats window.

Parameters:

  • (String)

Returns:

  • (String, nil) 


25
 
# File 'lib/whop_sdk/models/ad_campaign_retrieve_params.rb', line 25

optional :stats_to, String

#time_zone ⇒ String?

IANA timezone the stats window is interpreted in. Defaults to UTC.

Parameters:

  • (String)

Returns:

  • (String, nil) 


31
 
# File 'lib/whop_sdk/models/ad_campaign_retrieve_params.rb', line 31

optional :time_zone, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


33
 
# File 'sig/whop_sdk/models/ad_campaign_retrieve_params.rbs', line 33

def to_hash: -> {