Class: Twilio::REST::Messaging::V1

Inherits:
Version
  • Object
show all
Defined in:
lib/twilio-ruby/rest/messaging/v1.rb,
lib/twilio-ruby/rest/messaging/v1/service.rb,
lib/twilio-ruby/rest/messaging/v1/usecase.rb,
lib/twilio-ruby/rest/messaging/v1/domain_certs.rb,
lib/twilio-ruby/rest/messaging/v1/deactivations.rb,
lib/twilio-ruby/rest/messaging/v1/domain_config.rb,
lib/twilio-ruby/rest/messaging/v1/external_campaign.rb,
lib/twilio-ruby/rest/messaging/v1/brand_registration.rb,
lib/twilio-ruby/rest/messaging/v1/domain_validate_dn.rb,
lib/twilio-ruby/rest/messaging/v1/service/short_code.rb,
lib/twilio-ruby/rest/messaging/v1/request_managed_cert.rb,
lib/twilio-ruby/rest/messaging/v1/service/alpha_sender.rb,
lib/twilio-ruby/rest/messaging/v1/service/phone_number.rb,
lib/twilio-ruby/rest/messaging/v1/tollfree_verification.rb,
lib/twilio-ruby/rest/messaging/v1/service/channel_sender.rb,
lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person.rb,
lib/twilio-ruby/rest/messaging/v1/domain_config_messaging_service.rb,
lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb,
lib/twilio-ruby/rest/messaging/v1/linkshortening_messaging_service.rb,
lib/twilio-ruby/rest/messaging/v1/service/destination_alpha_sender.rb,
lib/twilio-ruby/rest/messaging/v1/service/us_app_to_person_usecase.rb,
lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_registration_otp.rb,
lib/twilio-ruby/rest/messaging/v1/linkshortening_messaging_service_domain_association.rb

Defined Under Namespace

Classes: BrandRegistrationContext, BrandRegistrationInstance, BrandRegistrationInstanceMetadata, BrandRegistrationList, BrandRegistrationListResponse, BrandRegistrationPage, BrandRegistrationPageMetadata, DeactivationsContext, DeactivationsInstance, DeactivationsInstanceMetadata, DeactivationsList, DeactivationsListResponse, DeactivationsPage, DeactivationsPageMetadata, DomainCertsContext, DomainCertsInstance, DomainCertsInstanceMetadata, DomainCertsList, DomainCertsListResponse, DomainCertsPage, DomainCertsPageMetadata, DomainConfigContext, DomainConfigInstance, DomainConfigInstanceMetadata, DomainConfigList, DomainConfigListResponse, DomainConfigMessagingServiceContext, DomainConfigMessagingServiceInstance, DomainConfigMessagingServiceInstanceMetadata, DomainConfigMessagingServiceList, DomainConfigMessagingServiceListResponse, DomainConfigMessagingServicePage, DomainConfigMessagingServicePageMetadata, DomainConfigPage, DomainConfigPageMetadata, DomainValidateDnContext, DomainValidateDnInstance, DomainValidateDnInstanceMetadata, DomainValidateDnList, DomainValidateDnListResponse, DomainValidateDnPage, DomainValidateDnPageMetadata, ExternalCampaignInstance, ExternalCampaignList, ExternalCampaignListResponse, ExternalCampaignPage, ExternalCampaignPageMetadata, LinkshorteningMessagingServiceContext, LinkshorteningMessagingServiceDomainAssociationContext, LinkshorteningMessagingServiceDomainAssociationInstance, LinkshorteningMessagingServiceDomainAssociationInstanceMetadata, LinkshorteningMessagingServiceDomainAssociationList, LinkshorteningMessagingServiceDomainAssociationListResponse, LinkshorteningMessagingServiceDomainAssociationPage, LinkshorteningMessagingServiceDomainAssociationPageMetadata, LinkshorteningMessagingServiceInstance, LinkshorteningMessagingServiceInstanceMetadata, LinkshorteningMessagingServiceList, LinkshorteningMessagingServiceListResponse, LinkshorteningMessagingServicePage, LinkshorteningMessagingServicePageMetadata, RequestManagedCertContext, RequestManagedCertInstance, RequestManagedCertInstanceMetadata, RequestManagedCertList, RequestManagedCertListResponse, RequestManagedCertPage, RequestManagedCertPageMetadata, ServiceContext, ServiceInstance, ServiceInstanceMetadata, ServiceList, ServiceListResponse, ServicePage, ServicePageMetadata, TollfreeVerificationContext, TollfreeVerificationInstance, TollfreeVerificationInstanceMetadata, TollfreeVerificationList, TollfreeVerificationListResponse, TollfreeVerificationPage, TollfreeVerificationPageMetadata, UsecaseInstance, UsecaseList, UsecaseListResponse, UsecasePage, UsecasePageMetadata

Instance Attribute Summary

Attributes inherited from Version

#domain, #version

Instance Method Summary collapse

Methods inherited from Version

#absolute_url, #create, #create_with_metadata, #delete, #delete_with_metadata, #exception, #fetch, #fetch_with_metadata, #page, #patch, #read_limits, #relative_uri, #request, #stream, #stream_with_metadata, #update, #update_with_metadata

Constructor Details

#initialize(domain) ⇒ V1

Initialize the V1 version of Messaging



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/twilio-ruby/rest/messaging/v1.rb', line 21

def initialize(domain)
    super
    @version = 'v1'
    @brand_registrations = nil
    @deactivations = nil
    @domain_certs = nil
    @domain_config = nil
    @domain_config_messaging_service = nil
    @domain_validate_dns = nil
    @external_campaign = nil
    @linkshortening_messaging_service = nil
    @linkshortening_messaging_service_domain_association = nil
    @request_managed_cert = nil
    @services = nil
    @tollfree_verifications = nil
    @usecases = nil
end

Instance Method Details

#brand_registrations(sid = :unset) ⇒ Twilio::REST::Messaging::V1::BrandRegistrationContext, Twilio::REST::Messaging::V1::BrandRegistrationList

Parameters:

  • sid (String) (defaults to: :unset) —

    The SID of the Brand Registration resource to fetch.

Returns:



43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/twilio-ruby/rest/messaging/v1.rb', line 43

def brand_registrations(sid=:unset)
    if sid.nil?
        raise ArgumentError, 'sid cannot be nil'
    end

    if sid == :unset
        @brand_registrations ||= BrandRegistrationList.new self
    else
        BrandRegistrationContext.new(self, sid)
    end
end

#deactivations ⇒ Twilio::REST::Messaging::V1::deactivationsContext

Returns:

  • (Twilio::REST::Messaging::V1::deactivationsContext) 


56
57
58
 
# File 'lib/twilio-ruby/rest/messaging/v1.rb', line 56

def deactivations
    @deactivations ||= DeactivationsContext.new self
end

#domain_certs(domain_sid = :unset) ⇒ Twilio::REST::Messaging::V1::DomainCertsContext, Twilio::REST::Messaging::V1::DomainCertsList

Parameters:

  • domain_sid (String) (defaults to: :unset) —

    Unique string used to identify the domain that this certificate should be associated with.

Returns:



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/twilio-ruby/rest/messaging/v1.rb', line 63

def domain_certs(domain_sid=:unset)
    if domain_sid.nil?
        raise ArgumentError, 'domain_sid cannot be nil'
    end

    if domain_sid == :unset
        @domain_certs ||= DomainCertsList.new self
    else
        DomainCertsContext.new(self, domain_sid)
    end
end

#domain_config(domain_sid = :unset) ⇒ Twilio::REST::Messaging::V1::DomainConfigContext, Twilio::REST::Messaging::V1::DomainConfigList

Parameters:

  • domain_sid (String) (defaults to: :unset) —

    Unique string used to identify the domain that this config should be associated with.

Returns:



78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/twilio-ruby/rest/messaging/v1.rb', line 78

def domain_config(domain_sid=:unset)
    if domain_sid.nil?
        raise ArgumentError, 'domain_sid cannot be nil'
    end

    if domain_sid == :unset
        @domain_config ||= DomainConfigList.new self
    else
        DomainConfigContext.new(self, domain_sid)
    end
end

#domain_config_messaging_service(messaging_service_sid = :unset) ⇒ Twilio::REST::Messaging::V1::DomainConfigMessagingServiceContext, Twilio::REST::Messaging::V1::DomainConfigMessagingServiceList

Parameters:

  • messaging_service_sid (String) (defaults to: :unset) —

    Unique string used to identify the Messaging service that this domain should be associated with.

Returns:



93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/twilio-ruby/rest/messaging/v1.rb', line 93

def domain_config_messaging_service(messaging_service_sid=:unset)
    if messaging_service_sid.nil?
        raise ArgumentError, 'messaging_service_sid cannot be nil'
    end

    if messaging_service_sid == :unset
        @domain_config_messaging_service ||= DomainConfigMessagingServiceList.new self
    else
        DomainConfigMessagingServiceContext.new(self, messaging_service_sid)
    end
end

#domain_validate_dns(domain_sid = :unset) ⇒ Twilio::REST::Messaging::V1::DomainValidateDnContext, Twilio::REST::Messaging::V1::DomainValidateDnList

Parameters:

  • domain_sid (String) (defaults to: :unset) —

    Unique string used to identify the domain.

Returns:



108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/twilio-ruby/rest/messaging/v1.rb', line 108

def domain_validate_dns(domain_sid=:unset)
    if domain_sid.nil?
        raise ArgumentError, 'domain_sid cannot be nil'
    end

    if domain_sid == :unset
        @domain_validate_dns ||= DomainValidateDnList.new self
    else
        DomainValidateDnContext.new(self, domain_sid)
    end
end

#external_campaign ⇒ Twilio::REST::Messaging::V1::ExternalCampaignList

Returns:



121
122
123
 
# File 'lib/twilio-ruby/rest/messaging/v1.rb', line 121

def external_campaign
    @external_campaign ||= ExternalCampaignList.new self
end

#linkshortening_messaging_service(domain_sid = :unset, messaging_service_sid = :unset) ⇒ Twilio::REST::Messaging::V1::LinkshorteningMessagingServiceContext, Twilio::REST::Messaging::V1::LinkshorteningMessagingServiceList

Parameters:

  • domain_sid (String) (defaults to: :unset) —

    The domain SID to associate with a messaging service. With URL shortening enabled, links in messages sent with the associated messaging service will be shortened to the provided domain

  • messaging_service_sid (String) (defaults to: :unset) —

    A messaging service SID to associate with a domain. With URL shortening enabled, links in messages sent with the provided messaging service will be shortened to the associated domain

Returns:



129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/twilio-ruby/rest/messaging/v1.rb', line 129

def linkshortening_messaging_service(domain_sid=:unset, messaging_service_sid=:unset)
    if domain_sid.nil?
        raise ArgumentError, 'domain_sid cannot be nil'
    end
    if messaging_service_sid.nil?
        raise ArgumentError, 'messaging_service_sid cannot be nil'
    end

    if domain_sid == :unset && messaging_service_sid == :unset
        @linkshortening_messaging_service ||= LinkshorteningMessagingServiceList.new self
    elsif domain_sid != :unset && messaging_service_sid == :unset
        LinkshorteningMessagingServiceList.new(self, domain_sid: domain_sid)
    else
        LinkshorteningMessagingServiceContext.new(self, domain_sid, messaging_service_sid)
    end
end

#linkshortening_messaging_service_domain_association(messaging_service_sid = :unset) ⇒ Twilio::REST::Messaging::V1::LinkshorteningMessagingServiceDomainAssociationContext, Twilio::REST::Messaging::V1::LinkshorteningMessagingServiceDomainAssociationList

Parameters:

  • messaging_service_sid (String) (defaults to: :unset) —

    Unique string used to identify the Messaging service that this domain should be associated with.

Returns:



170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/twilio-ruby/rest/messaging/v1.rb', line 170

def linkshortening_messaging_service_domain_association(messaging_service_sid=:unset)
    if messaging_service_sid.nil?
        raise ArgumentError, 'messaging_service_sid cannot be nil'
    end

    if messaging_service_sid == :unset
        @linkshortening_messaging_service_domain_association ||= LinkshorteningMessagingServiceDomainAssociationList.new self
    else
        LinkshorteningMessagingServiceDomainAssociationContext.new(self, messaging_service_sid)
    end
end

#request_managed_cert(domain_sid = :unset) ⇒ Twilio::REST::Messaging::V1::RequestManagedCertContext, Twilio::REST::Messaging::V1::RequestManagedCertList

Parameters:

  • domain_sid (String) (defaults to: :unset) —

    Unique string used to identify the domain that this certificate should be associated with.

Returns:



185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/twilio-ruby/rest/messaging/v1.rb', line 185

def request_managed_cert(domain_sid=:unset)
    if domain_sid.nil?
        raise ArgumentError, 'domain_sid cannot be nil'
    end

    if domain_sid == :unset
        @request_managed_cert ||= RequestManagedCertList.new self
    else
        RequestManagedCertContext.new(self, domain_sid)
    end
end

#services(sid = :unset) ⇒ Twilio::REST::Messaging::V1::ServiceContext, Twilio::REST::Messaging::V1::ServiceList

Parameters:

  • sid (String) (defaults to: :unset) —

    The SID of the Service resource to fetch.

Returns:



200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/twilio-ruby/rest/messaging/v1.rb', line 200

def services(sid=:unset)
    if sid.nil?
        raise ArgumentError, 'sid cannot be nil'
    end

    if sid == :unset
        @services ||= ServiceList.new self
    else
        ServiceContext.new(self, sid)
    end
end

#to_s ⇒ Object

Provide a user friendly representation



233
234
235
 
# File 'lib/twilio-ruby/rest/messaging/v1.rb', line 233

def to_s
    '<Twilio::REST::Messaging::V1>';
end

#tollfree_verifications(sid = :unset) ⇒ Twilio::REST::Messaging::V1::TollfreeVerificationContext, Twilio::REST::Messaging::V1::TollfreeVerificationList

Parameters:

  • sid (String) (defaults to: :unset) —

    A unique string identifying a Tollfree Verification.

Returns:



215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/twilio-ruby/rest/messaging/v1.rb', line 215

def tollfree_verifications(sid=:unset)
    if sid.nil?
        raise ArgumentError, 'sid cannot be nil'
    end

    if sid == :unset
        @tollfree_verifications ||= TollfreeVerificationList.new self
    else
        TollfreeVerificationContext.new(self, sid)
    end
end

#usecases ⇒ Twilio::REST::Messaging::V1::UsecaseList

Returns:



228
229
230
 
# File 'lib/twilio-ruby/rest/messaging/v1.rb', line 228

def usecases
    @usecases ||= UsecaseList.new self
end