Class: Telnyx::Models::CampaignStatusUpdate

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/telnyx/models/campaign_status_update.rb

Defined Under Namespace

Modules: Status, Type

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(brand_id: nil, campaign_id: nil, create_date: nil, csp_id: nil, description: nil, is_t_mobile_registered: nil, status: nil, type: nil) ⇒ Object

Parameters:

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

    Brand ID associated with the campaign.

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

    The ID of the campaign.

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

    Unix timestamp when campaign was created.

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

    Alphanumeric identifier of the CSP associated with this campaign.

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

    Description of the event.

  • is_t_mobile_registered (Boolean) (defaults to: nil) —

    Indicates whether the campaign is registered with T-Mobile.

  • status (Symbol, Telnyx::Models::CampaignStatusUpdate::Status) (defaults to: nil) —

    The status of the campaign.

  • type (Symbol, Telnyx::Models::CampaignStatusUpdate::Type) (defaults to: nil) 



# File 'lib/telnyx/models/campaign_status_update.rb', line 53

Instance Attribute Details

#brand_id ⇒ String?

Brand ID associated with the campaign.

Returns:

  • (String, nil) 


10
 
# File 'lib/telnyx/models/campaign_status_update.rb', line 10

optional :brand_id, String, api_name: :brandId

#campaign_id ⇒ String?

The ID of the campaign.

Returns:

  • (String, nil) 


16
 
# File 'lib/telnyx/models/campaign_status_update.rb', line 16

optional :campaign_id, String, api_name: :campaignId

#create_date ⇒ String?

Unix timestamp when campaign was created.

Returns:

  • (String, nil) 


22
 
# File 'lib/telnyx/models/campaign_status_update.rb', line 22

optional :create_date, String, api_name: :createDate

#csp_id ⇒ String?

Alphanumeric identifier of the CSP associated with this campaign.

Returns:

  • (String, nil) 


28
 
# File 'lib/telnyx/models/campaign_status_update.rb', line 28

optional :csp_id, String, api_name: :cspId

#description ⇒ String?

Description of the event.

Returns:

  • (String, nil) 


34
 
# File 'lib/telnyx/models/campaign_status_update.rb', line 34

optional :description, String

#is_t_mobile_registered ⇒ Boolean?

Indicates whether the campaign is registered with T-Mobile.

Returns:

  • (Boolean, nil) 


40
 
# File 'lib/telnyx/models/campaign_status_update.rb', line 40

optional :is_t_mobile_registered, Telnyx::Internal::Type::Boolean, api_name: :isTMobileRegistered

#status ⇒ Symbol, ...

The status of the campaign.

Returns:



46
 
# File 'lib/telnyx/models/campaign_status_update.rb', line 46

optional :status, enum: -> { Telnyx::CampaignStatusUpdate::Status }

#type ⇒ Symbol, ...

Returns:



51
 
# File 'lib/telnyx/models/campaign_status_update.rb', line 51

optional :type, enum: -> { Telnyx::CampaignStatusUpdate::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/telnyx/models/campaign_status_update.rb', line 82