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

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/messaging/v1/service.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, sid: nil) ⇒ ServiceInstance

Initialize the ServiceInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The SID of the Service resource to fetch.



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 442

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'friendly_name' => payload['friendly_name'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'inbound_request_url' => payload['inbound_request_url'],
      'inbound_method' => payload['inbound_method'],
      'fallback_url' => payload['fallback_url'],
      'fallback_method' => payload['fallback_method'],
      'status_callback' => payload['status_callback'],
      'sticky_sender' => payload['sticky_sender'],
      'mms_converter' => payload['mms_converter'],
      'smart_encoding' => payload['smart_encoding'],
      'scan_message_content' => payload['scan_message_content'],
      'fallback_to_long_code' => payload['fallback_to_long_code'],
      'area_code_geomatch' => payload['area_code_geomatch'],
      'synchronous_validation' => payload['synchronous_validation'],
      'validity_period' => payload['validity_period'].to_i,
      'url' => payload['url'],
      'links' => payload['links'],
      'use_inbound_webhook_on_number' => payload['use_inbound_webhook_on_number'],
  }

  # Context
  @instance_context = nil
  @params = {'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



494
495
496
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 494

def 
  @properties['account_sid']
end

#alpha_senders ⇒ alpha_senders

Access the alpha_senders

Returns:



712
713
714
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 712

def alpha_senders
  context.alpha_senders
end

#area_code_geomatch ⇒ Boolean

Returns Whether to enable Area Code Geomatch on the Service Instance.

Returns:

  • (Boolean) —

    Whether to enable Area Code Geomatch on the Service Instance



578
579
580
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 578

def area_code_geomatch
  @properties['area_code_geomatch']
end

#context ⇒ ServiceContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



479
480
481
482
483
484
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 479

def context
  unless @instance_context
    @instance_context = ServiceContext.new(@version, @params['sid'], )
  end
  @instance_context
end

#date_created ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created



506
507
508
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 506

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated



512
513
514
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 512

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ServiceInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



691
692
693
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 691

def delete
  context.delete
end

#fallback_method ⇒ String

Returns The HTTP method we use to call fallback_url.

Returns:

  • (String) —

    The HTTP method we use to call fallback_url



536
537
538
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 536

def fallback_method
  @properties['fallback_method']
end

#fallback_to_long_code ⇒ Boolean

Returns Whether to enable Fallback to Long Code for messages sent through the Service instance.

Returns:

  • (Boolean) —

    Whether to enable Fallback to Long Code for messages sent through the Service instance



572
573
574
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 572

def fallback_to_long_code
  @properties['fallback_to_long_code']
end

#fallback_url ⇒ String

Returns The URL that we call using fallback_method if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. This field will be overridden if the ‘use_inbound_webhook_on_number` field is enabled.

Returns:

  • (String) —

    The URL that we call using fallback_method if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. This field will be overridden if the ‘use_inbound_webhook_on_number` field is enabled.



530
531
532
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 530

def fallback_url
  @properties['fallback_url']
end

#fetch ⇒ ServiceInstance

Fetch the ServiceInstance

Returns:



684
685
686
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 684

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • (String) —

    The string that you assigned to describe the resource



500
501
502
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 500

def friendly_name
  @properties['friendly_name']
end

#inbound_method ⇒ String

Returns The HTTP method we use to call inbound_request_url.

Returns:

  • (String) —

    The HTTP method we use to call inbound_request_url



524
525
526
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 524

def inbound_method
  @properties['inbound_method']
end

#inbound_request_url ⇒ String

Returns The URL we call using inbound_method when a message is received by any phone number or short code in the Service. This field will be overridden if the ‘use_inbound_webhook_on_number` field is enabled.

Returns:

  • (String) —

    The URL we call using inbound_method when a message is received by any phone number or short code in the Service. This field will be overridden if the ‘use_inbound_webhook_on_number` field is enabled.



518
519
520
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 518

def inbound_request_url
  @properties['inbound_request_url']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



739
740
741
742
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 739

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Messaging.V1.ServiceInstance #{values}>"
end

#links ⇒ String

Returns The absolute URLs of related resources.

Returns:

  • (String) —

    The absolute URLs of related resources



602
603
604
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 602

def links
  @properties['links']
end

#mms_converter ⇒ Boolean

Returns Whether to enable the MMS Converter for messages sent through the Service instance.

Returns:

  • (Boolean) —

    Whether to enable the MMS Converter for messages sent through the Service instance



554
555
556
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 554

def mms_converter
  @properties['mms_converter']
end

#phone_numbers ⇒ phone_numbers

Access the phone_numbers

Returns:



698
699
700
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 698

def phone_numbers
  context.phone_numbers
end

#scan_message_content ⇒ service.ScanMessageContent

Returns Reserved.

Returns:

  • (service.ScanMessageContent) —

    Reserved



566
567
568
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 566

def scan_message_content
  @properties['scan_message_content']
end

#short_codes ⇒ short_codes

Access the short_codes

Returns:



705
706
707
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 705

def short_codes
  context.short_codes
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



488
489
490
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 488

def sid
  @properties['sid']
end

#smart_encoding ⇒ Boolean

Returns Whether to enable Encoding for messages sent through the Service instance.

Returns:

  • (Boolean) —

    Whether to enable Encoding for messages sent through the Service instance



560
561
562
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 560

def smart_encoding
  @properties['smart_encoding']
end

#status_callback ⇒ String

Returns The URL we call to pass status updates about message delivery.

Returns:

  • (String) —

    The URL we call to pass status updates about message delivery



542
543
544
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 542

def status_callback
  @properties['status_callback']
end

#sticky_sender ⇒ Boolean

Returns Whether to enable Sticky Sender on the Service instance.

Returns:

  • (Boolean) —

    Whether to enable Sticky Sender on the Service instance



548
549
550
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 548

def sticky_sender
  @properties['sticky_sender']
end

#synchronous_validation ⇒ Boolean

Returns Reserved.

Returns:

  • (Boolean) —

    Reserved



584
585
586
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 584

def synchronous_validation
  @properties['synchronous_validation']
end

#to_s ⇒ Object

Provide a user friendly representation



732
733
734
735
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 732

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Messaging.V1.ServiceInstance #{values}>"
end

#update(friendly_name: :unset, inbound_request_url: :unset, inbound_method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, sticky_sender: :unset, mms_converter: :unset, smart_encoding: :unset, scan_message_content: :unset, fallback_to_long_code: :unset, area_code_geomatch: :unset, validity_period: :unset, synchronous_validation: :unset, use_inbound_webhook_on_number: :unset) ⇒ ServiceInstance

Update the ServiceInstance

Parameters:

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

    A descriptive string that you create to describe the resource. It can be up to 64 characters long.

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

    The URL we call using ‘inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled. All messages sent to the Twilio phone number or short code will not be logged and received on the Account. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `inbound_request_url` defined for the Messaging Service.

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

    The HTTP method we should use to call ‘inbound_request_url`. Can be `GET` or `POST` and the default is `POST`.

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

    The URL that we call using ‘fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `fallback_url` defined for the Messaging Service.

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

    The HTTP method we should use to call ‘fallback_url`. Can be: `GET` or `POST`.

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

    The URL we should call to pass status updates about message delivery.

  • sticky_sender (Boolean) (defaults to: :unset) —

    Whether to enable Sticky Sender on the Service instance.

  • mms_converter (Boolean) (defaults to: :unset) —

    Whether to enable the MMS Converter for messages sent through the Service instance.

  • smart_encoding (Boolean) (defaults to: :unset) —

    Whether to enable Smart Encoding for messages sent through the Service instance.

  • scan_message_content (service.ScanMessageContent) (defaults to: :unset) —

    Reserved.

  • fallback_to_long_code (Boolean) (defaults to: :unset) —

    Whether to enable Fallback to Long Code for messages sent through the Service instance.

  • area_code_geomatch (Boolean) (defaults to: :unset) —

    Whether to enable Area Code Geomatch on the Service Instance.

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

    How long, in seconds, messages sent from the Service are valid. Can be an integer from ‘1` to `14,400`.

  • synchronous_validation (Boolean) (defaults to: :unset) —

    Reserved.

  • use_inbound_webhook_on_number (Boolean) (defaults to: :unset) —

    A boolean value that indicates either the webhook url configured on the phone number will be used or ‘inbound_request_url`/`fallback_url` url will be called when a message is received from the phone number. If this field is enabled then the webhook url defined on the phone number will override the `inbound_request_url`/`fallback_url` defined for the Messaging Service.

Returns:



661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 661

def update(friendly_name: :unset, inbound_request_url: :unset, inbound_method: :unset, fallback_url: :unset, fallback_method: :unset, status_callback: :unset, sticky_sender: :unset, mms_converter: :unset, smart_encoding: :unset, scan_message_content: :unset, fallback_to_long_code: :unset, area_code_geomatch: :unset, validity_period: :unset, synchronous_validation: :unset, use_inbound_webhook_on_number: :unset)
  context.update(
      friendly_name: friendly_name,
      inbound_request_url: inbound_request_url,
      inbound_method: inbound_method,
      fallback_url: fallback_url,
      fallback_method: fallback_method,
      status_callback: status_callback,
      sticky_sender: sticky_sender,
      mms_converter: mms_converter,
      smart_encoding: smart_encoding,
      scan_message_content: scan_message_content,
      fallback_to_long_code: fallback_to_long_code,
      area_code_geomatch: area_code_geomatch,
      validity_period: validity_period,
      synchronous_validation: synchronous_validation,
      use_inbound_webhook_on_number: use_inbound_webhook_on_number,
  )
end

#url ⇒ String

Returns The absolute URL of the Service resource.

Returns:

  • (String) —

    The absolute URL of the Service resource



596
597
598
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 596

def url
  @properties['url']
end

#us_app_to_person ⇒ us_app_to_person

Access the us_app_to_person

Returns:



719
720
721
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 719

def us_app_to_person
  context.us_app_to_person
end

#us_app_to_person_usecases ⇒ us_app_to_person_usecases

Access the us_app_to_person_usecases

Returns:



726
727
728
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 726

def us_app_to_person_usecases
  context.us_app_to_person_usecases
end

#use_inbound_webhook_on_number ⇒ Boolean

Returns If enabled, the webhook url configured on the phone number will be used and will override the ‘inbound_request_url`/`fallback_url` url called when an inbound message is received.

Returns:

  • (Boolean) —

    If enabled, the webhook url configured on the phone number will be used and will override the ‘inbound_request_url`/`fallback_url` url called when an inbound message is received.



608
609
610
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 608

def use_inbound_webhook_on_number
  @properties['use_inbound_webhook_on_number']
end

#validity_period ⇒ String

Returns How long, in seconds, messages sent from the Service are valid.

Returns:

  • (String) —

    How long, in seconds, messages sent from the Service are valid



590
591
592
 
# File 'lib/twilio-ruby/rest/messaging/v1/service.rb', line 590

def validity_period
  @properties['validity_period']
end