Class: Sentdm::Models::Profiles::CampaignListResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/sentdm/models/profiles/campaign_list_response.rb

Overview

See Also:

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(data: nil, error: nil, meta: nil, success: nil) ⇒ Object

Standard API response envelope for all v3 endpoints

Parameters:




# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 34

Instance Attribute Details

#data ⇒ Array<Sentdm::Models::Profiles::TcrCampaignWithUseCases>?

The response data (null if error)

Returns:



12
13
14
 
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 12

optional :data,
-> { Sentdm::Internal::Type::ArrayOf[Sentdm::Profiles::TcrCampaignWithUseCases] },
nil?: true

#error ⇒ Sentdm::Models::ErrorDetail?

Error information

Returns:



20
 
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 20

optional :error, -> { Sentdm::ErrorDetail }, nil?: true

#meta ⇒ Sentdm::Models::APIMeta?

Request and response metadata

Returns:



26
 
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 26

optional :meta, -> { Sentdm::APIMeta }

#success ⇒ Boolean?

Indicates whether the request was successful

Returns:

  • (Boolean, nil) 


32
 
# File 'lib/sentdm/models/profiles/campaign_list_response.rb', line 32

optional :success, Sentdm::Internal::Type::Boolean