Class: Telnyx::Models::Messaging10dlc::PhoneNumberAssignmentByProfileAssignParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/telnyx/models/messaging_10dlc/phone_number_assignment_by_profile_assign_params.rb

Overview

See Also:

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(messaging_profile_id:, campaign_id: nil, tcr_campaign_id: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Telnyx::Models::Messaging10dlc::PhoneNumberAssignmentByProfileAssignParams for more details.

Parameters:

  • messaging_profile_id (String) —

    The ID of the messaging profile that you want to link to the specified campaign.

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

    The ID of the campaign you want to link to the specified messaging profile. If y

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

    The TCR ID of the shared campaign you want to link to the specified messaging pr

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



# File 'lib/telnyx/models/messaging_10dlc/phone_number_assignment_by_profile_assign_params.rb', line 32

Instance Attribute Details

#campaign_id ⇒ String?

The ID of the campaign you want to link to the specified messaging profile. If you supply this ID in the request, do not also include a tcrCampaignId.

Returns:

  • (String, nil) 


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

optional :campaign_id, String, api_name: :campaignId

#messaging_profile_id ⇒ String

The ID of the messaging profile that you want to link to the specified campaign.

Returns:

  • (String) 


15
 
# File 'lib/telnyx/models/messaging_10dlc/phone_number_assignment_by_profile_assign_params.rb', line 15

required :messaging_profile_id, String, api_name: :messagingProfileId

#tcr_campaign_id ⇒ String?

The TCR ID of the shared campaign you want to link to the specified messaging profile (for campaigns not created using Telnyx 10DLC services only). If you supply this ID in the request, do not also include a campaignId.

Returns:

  • (String, nil) 


30
 
# File 'lib/telnyx/models/messaging_10dlc/phone_number_assignment_by_profile_assign_params.rb', line 30

optional :tcr_campaign_id, String, api_name: :tcrCampaignId