Class: SurgeAPI::Models::CampaignCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• SurgeAPI::Models::CampaignCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/surge_api/models/campaign_create_params.rb

Overview

See Also:

• Resources::Campaigns#create

Instance Attribute Summary

• #campaign_params ⇒ SurgeAPI::Models::CampaignParams::StandardCampaignParams, SurgeAPI::Models::CampaignParams::ExternalCampaignParams

  Parameters for creating a new campaign.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(campaign_params:, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see CampaignCreateParams for more details.

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(campaign_params:, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see SurgeAPI::Models::CampaignCreateParams for more details.

Parameters:

• campaign_params (SurgeAPI::Models::CampaignParams::StandardCampaignParams, SurgeAPI::Models::CampaignParams::ExternalCampaignParams) —

  Parameters for creating a new campaign. Either provide full campaign details or

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

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

Instance Attribute Details

#campaign_params ⇒ SurgeAPI::Models::CampaignParams::StandardCampaignParams, SurgeAPI::Models::CampaignParams::ExternalCampaignParams

Parameters for creating a new campaign. Either provide full campaign details or import using a TCR ID.

Returns:

• (SurgeAPI::Models::CampaignParams::StandardCampaignParams, SurgeAPI::Models::CampaignParams::ExternalCampaignParams)

# File 'lib/surge_api/models/campaign_create_params.rb', line 15

required :campaign_params, union: -> { SurgeAPI::CampaignParams }