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

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/messaging/v1/brand_registration.rb,
lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_vetting.rb,
lib/twilio-ruby/rest/messaging/v1/brand_registration/brand_registration_otp.rb

Defined Under Namespace

Classes: BrandRegistrationOtpInstance, BrandRegistrationOtpList, BrandRegistrationOtpListResponse, BrandRegistrationOtpPage, BrandRegistrationOtpPageMetadata, BrandVettingContext, BrandVettingInstance, BrandVettingInstanceMetadata, BrandVettingList, BrandVettingListResponse, BrandVettingPage, BrandVettingPageMetadata

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ BrandRegistrationContext

Initialize the BrandRegistrationContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    The SID of the Brand Registration resource to update.



247
248
249
250
251
252
253
254
255
256
257
258
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 247

def initialize(version, sid)
    super(version)
    

    # Path Solution
    @solution = { sid: sid,  }
    @uri = "/a2p/BrandRegistrations/#{@solution[:sid]}"

    # Dependents
    @brand_registration_otps = nil
    @brand_vettings = nil
end

Instance Method Details

#brand_registration_otps ⇒ BrandRegistrationOtpList, BrandRegistrationOtpContext

Access the brand_registration_otps

Returns:



351
352
353
354
355
356
357
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 351

def brand_registration_otps
  unless @brand_registration_otps
    @brand_registration_otps = BrandRegistrationOtpList.new(
            @version, brand_registration_sid: @solution[:sid], )
  end
  @brand_registration_otps
end

#brand_vettings(brand_vetting_sid = :unset) ⇒ BrandVettingList, BrandVettingContext

Access the brand_vettings

Returns:

Raises:

  • (ArgumentError) 


362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 362

def brand_vettings(brand_vetting_sid=:unset)

    raise ArgumentError, 'brand_vetting_sid cannot be nil' if brand_vetting_sid.nil?

    if brand_vetting_sid != :unset
        return BrandVettingContext.new(@version, @solution[:sid],brand_vetting_sid )
    end

    unless @brand_vettings
        @brand_vettings = BrandVettingList.new(
            @version, brand_sid: @solution[:sid], )
    end

 @brand_vettings
end

#fetch ⇒ BrandRegistrationInstance

Fetch the BrandRegistrationInstance

Returns:



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 262

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    BrandRegistrationInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#fetch_with_metadata ⇒ BrandRegistrationInstance

Fetch the BrandRegistrationInstanceMetadata

Returns:



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 281

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    brand_registration_instance = BrandRegistrationInstance.new(
        @version,
        response.body,
        sid: @solution[:sid],
    )
    BrandRegistrationInstanceMetadata.new(
        @version,
        brand_registration_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



387
388
389
390
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 387

def inspect
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Messaging.V1.BrandRegistrationContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



380
381
382
383
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 380

def to_s
    context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
    "#<Twilio.Messaging.V1.BrandRegistrationContext #{context}>"
end

#update ⇒ BrandRegistrationInstance

Update the BrandRegistrationInstance

Returns:



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 306

def update

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.update('POST', @uri, headers: headers)
    BrandRegistrationInstance.new(
        @version,
        payload,
        sid: @solution[:sid],
    )
end

#update_with_metadata ⇒ BrandRegistrationInstance

Update the BrandRegistrationInstanceMetadata

Returns:



325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/twilio-ruby/rest/messaging/v1/brand_registration.rb', line 325

def update_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.update_with_metadata('POST', @uri, headers: headers)
    brand_registration_instance = BrandRegistrationInstance.new(
        @version,
        response.body,
        sid: @solution[:sid],
    )
    BrandRegistrationInstanceMetadata.new(
        @version,
        brand_registration_instance,
        response.headers,
        response.status_code
    )
end