twilio-ruby 4.6.1 → 6.9.0

data/lib/twilio-ruby/rest/preview.rb

@@ -0,0 +1,102 @@
+module Twilio
+  module REST
+    class Preview < PreviewBase
+      ##
+      # @param [String] sid Contains a 34 character string that uniquely identifies this
+      #   Fleet resource.
+      # @return [Twilio::REST::Preview::DeployedDevices::FleetInstance] if sid was passed.
+      # @return [Twilio::REST::Preview::DeployedDevices::FleetList]
+      def fleets(sid=:unset)
+        warn "fleets is deprecated. Use deployed_devices.fleets instead."
+        self.deployed_devices.fleets(sid)
+      end
+
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this
+      #   AuthorizationDocument.
+      # @return [Twilio::REST::Preview::HostedNumbers::AuthorizationDocumentInstance] if sid was passed.
+      # @return [Twilio::REST::Preview::HostedNumbers::AuthorizationDocumentList]
+      def authorization_documents(sid=:unset)
+        warn "authorization_documents is deprecated. Use hosted_numbers.authorization_documents instead."
+        self.hosted_numbers.authorization_documents(sid)
+      end
+
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this
+      #   HostedNumberOrder.
+      # @return [Twilio::REST::Preview::HostedNumbers::HostedNumberOrderInstance] if sid was passed.
+      # @return [Twilio::REST::Preview::HostedNumbers::HostedNumberOrderList]
+      def hosted_number_orders(sid=:unset)
+        warn "hosted_number_orders is deprecated. Use hosted_numbers.hosted_number_orders instead."
+        self.hosted_numbers.hosted_number_orders(sid)
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify the
+      #   AvailableAddOn resource.
+      # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnInstance] if sid was passed.
+      # @return [Twilio::REST::Preview::Marketplace::AvailableAddOnList]
+      def available_add_ons(sid=:unset)
+        warn "available_add_ons is deprecated. Use marketplace.available_add_ons instead."
+        self.marketplace.available_add_ons(sid)
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify the
+      #   InstalledAddOn resource. This Sid can also be found in the Console on that
+      #   specific Add-ons page as the 'Available Add-on Sid'.
+      # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnInstance] if sid was passed.
+      # @return [Twilio::REST::Preview::Marketplace::InstalledAddOnList]
+      def installed_add_ons(sid=:unset)
+        warn "installed_add_ons is deprecated. Use marketplace.installed_add_ons instead."
+        self.marketplace.installed_add_ons(sid)
+      end
+
+      ##
+      # @param [String] sid The sid
+      # @return [Twilio::REST::Preview::Sync::ServiceInstance] if sid was passed.
+      # @return [Twilio::REST::Preview::Sync::ServiceList]
+      def services(sid=:unset)
+        warn "services is deprecated. Use sync.services instead."
+        self.sync.services(sid)
+      end
+
+      ##
+      # @param [String] sid A 34 character string that uniquely identifies this
+      #   resource.
+      # @return [Twilio::REST::Preview::Understand::AssistantInstance] if sid was passed.
+      # @return [Twilio::REST::Preview::Understand::AssistantList]
+      def assistants(sid=:unset)
+        warn "assistants is deprecated. Use understand.assistants instead."
+        self.understand.assistants(sid)
+      end
+
+      ##
+      # @param [String] sid The sid
+      # @return [Twilio::REST::Preview::Wireless::CommandInstance] if sid was passed.
+      # @return [Twilio::REST::Preview::Wireless::CommandList]
+      def commands(sid=:unset)
+        warn "commands is deprecated. Use wireless.commands instead."
+        self.wireless.commands(sid)
+      end
+
+      ##
+      # @param [String] sid The sid
+      # @return [Twilio::REST::Preview::Wireless::RatePlanInstance] if sid was passed.
+      # @return [Twilio::REST::Preview::Wireless::RatePlanList]
+      def rate_plans(sid=:unset)
+        warn "rate_plans is deprecated. Use wireless.rate_plans instead."
+        self.wireless.rate_plans(sid)
+      end
+
+      ##
+      # @param [String] sid The sid
+      # @return [Twilio::REST::Preview::Wireless::SimInstance] if sid was passed.
+      # @return [Twilio::REST::Preview::Wireless::SimList]
+      def sims(sid=:unset)
+        warn "sims is deprecated. Use wireless.sims instead."
+        self.wireless.sims(sid)
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/preview_base.rb

@@ -0,0 +1,63 @@
+##
+ # This code was generated by
+ # ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+ #  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+ #  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+ #
+ # NOTE: This class is auto generated by OpenAPI Generator.
+ # https://openapi-generator.tech
+ # Do not edit the class manually.
+# frozen_string_literal: true
+module Twilio
+  module REST
+    class PreviewBase < Domain
+      ##
+      # Initialize preview domain
+      #
+      # @param twilio - The twilio client
+      #
+      def initialize(twilio)
+        super(twilio)
+        @base_url =  "https://preview.twilio.com"
+        @host = "preview.twilio.com"
+        @port = 443
+        @deployed_devices = nil
+        @hosted_numbers = nil
+        @sync = nil
+        @marketplace = nil
+        @understand = nil
+        @wireless = nil
+      end
+
+      def deployed_devices
+        @deployed_devices ||= Preview::DeployedDevices.new self
+      end
+
+      def hosted_numbers
+        @hosted_numbers ||= Preview::HostedNumbers.new self
+      end
+
+      def sync
+        @sync ||= Preview::Sync.new self
+      end
+
+      def marketplace
+        @marketplace ||= Preview::Marketplace.new self
+      end
+
+      def understand
+        @understand ||= Preview::Understand.new self
+      end
+
+      def wireless
+        @wireless ||= Preview::Wireless.new self
+      end
+
+      ##
+      # Provide a user friendly representation
+      def to_s
+        '<Twilio::REST::Preview>';
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/pricing/v1/messaging/country.rb

@@ -0,0 +1,304 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Pricing
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Pricing < PricingBase
+            class V1 < Version
+                class MessagingList < ListResource
+
+                     class CountryList < ListResource
+                    ##
+                    # Initialize the CountryList
+                    # @param [Version] version Version that contains the resource
+                    # @return [CountryList] CountryList
+                    def initialize(version)
+                        super(version)
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Messaging/Countries"
+                        
+                    end
+                
+                    ##
+                    # Lists CountryInstance records from the API as a list.
+                    # Unlike stream(), this operation is eager and will load `limit` records into
+                    # memory before returning.
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit.  Default is no limit
+                    # @param [Integer] page_size Number of records to fetch per request, when
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Array] Array of up to limit results
+                    def list(limit: nil, page_size: nil)
+                        self.stream(
+                            limit: limit,
+                            page_size: page_size
+                        ).entries
+                    end
+
+                    ##
+                    # Streams Instance records from the API as an Enumerable.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit.  Default is no limit
+                    # @param [Integer] page_size Number of records to fetch per request, when
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Enumerable] Enumerable that will yield up to limit results
+                    def stream(limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+
+                        page = self.page(
+                            page_size: limits[:page_size], )
+
+                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                    end
+
+                    ##
+                    # When passed a block, yields CountryInstance records from the API.
+                    # This operation lazily loads records as efficiently as possible until the limit
+                    # is reached.
+                    def each
+                        limits = @version.read_limits
+
+                        page = self.page(page_size: limits[:page_size], )
+
+                        @version.stream(page,
+                            limit: limits[:limit],
+                            page_limit: limits[:page_limit]).each {|x| yield x}
+                    end
+
+                    ##
+                    # Retrieve a single page of CountryInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] page_token PageToken provided by the API
+                    # @param [Integer] page_number Page Number, this value is simply for client state
+                    # @param [Integer] page_size Number of records to return, defaults to 50
+                    # @return [Page] Page of CountryInstance
+                    def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                        params = Twilio::Values.of({
+                            'PageToken' => page_token,
+                            'Page' => page_number,
+                            'PageSize' => page_size,
+                        })
+
+                        response = @version.page('GET', @uri, params: params)
+
+                        CountryPage.new(@version, response, @solution)
+                    end
+
+                    ##
+                    # Retrieve a single page of CountryInstance records from the API.
+                    # Request is executed immediately.
+                    # @param [String] target_url API-generated URL for the requested results page
+                    # @return [Page] Page of CountryInstance
+                    def get_page(target_url)
+                        response = @version.domain.request(
+                            'GET',
+                            target_url
+                        )
+                    CountryPage.new(@version, response, @solution)
+                    end
+                    
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Pricing.V1.CountryList>'
+                    end
+                end
+
+
+                class CountryContext < InstanceContext
+                    ##
+                    # Initialize the CountryContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] iso_country The [ISO country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the pricing information to fetch.
+                    # @return [CountryContext] CountryContext
+                    def initialize(version, iso_country)
+                        super(version)
+
+                        # Path Solution
+                        @solution = { iso_country: iso_country,  }
+                        @uri = "/Messaging/Countries/#{@solution[:iso_country]}"
+
+                        
+                    end
+                    ##
+                    # Fetch the CountryInstance
+                    # @return [CountryInstance] Fetched CountryInstance
+                    def fetch
+
+                        payload = @version.fetch('GET', @uri)
+                        CountryInstance.new(
+                            @version,
+                            payload,
+                            iso_country: @solution[:iso_country],
+                        )
+                    end
+
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Pricing.V1.CountryContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Pricing.V1.CountryContext #{context}>"
+                    end
+                end
+
+                class CountryPage < Page
+                    ##
+                    # Initialize the CountryPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [CountryPage] CountryPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of CountryInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [CountryInstance] CountryInstance
+                    def get_instance(payload)
+                        CountryInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Pricing.V1.CountryPage>'
+                    end
+                end
+                class CountryInstance < InstanceResource
+                    ##
+                    # Initialize the CountryInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Country
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [CountryInstance] CountryInstance
+                    def initialize(version, payload , iso_country: nil)
+                        super(version)
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'country' => payload['country'],
+                            'iso_country' => payload['iso_country'],
+                            'outbound_sms_prices' => payload['outbound_sms_prices'],
+                            'inbound_sms_prices' => payload['inbound_sms_prices'],
+                            'price_unit' => payload['price_unit'],
+                            'url' => payload['url'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'iso_country' => iso_country  || @properties['iso_country']  , }
+                    end
+
+                    ##
+                    # Generate an instance context for the instance, the context is capable of
+                    # performing various actions.  All instance actions are proxied to the context
+                    # @return [CountryContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = CountryContext.new(@version , @params['iso_country'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The name of the country.
+                    def country
+                        @properties['country']
+                    end
+                    
+                    ##
+                    # @return [String] The [ISO country code](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
+                    def iso_country
+                        @properties['iso_country']
+                    end
+                    
+                    ##
+                    # @return [Array<PricingV1MessagingMessagingCountryInstanceOutboundSmsPrices>] The list of [OutboundSMSPrice](https://www.twilio.com/docs/sms/api/pricing#outbound-sms-price) records that represent the price to send a message for each MCC/MNC applicable in this country.
+                    def outbound_sms_prices
+                        @properties['outbound_sms_prices']
+                    end
+                    
+                    ##
+                    # @return [Array<PricingV1MessagingMessagingCountryInstanceInboundSmsPrices>] The list of [InboundPrice](https://www.twilio.com/docs/sms/api/pricing#inbound-price) records that describe the price to receive an inbound SMS to the different Twilio phone number types supported in this country
+                    def inbound_sms_prices
+                        @properties['inbound_sms_prices']
+                    end
+                    
+                    ##
+                    # @return [String] The currency in which prices are measured, specified in [ISO 4127](http://www.iso.org/iso/home/standards/currency_codes.htm) format (e.g. `usd`, `eur`, `jpy`).
+                    def price_unit
+                        @properties['price_unit']
+                    end
+                    
+                    ##
+                    # @return [String] The absolute URL of the resource.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Fetch the CountryInstance
+                    # @return [CountryInstance] Fetched CountryInstance
+                    def fetch
+
+                        context.fetch
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Pricing.V1.CountryInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Pricing.V1.CountryInstance #{values}>"
+                    end
+                end
+
+             end
+            end
+        end
+    end
+end
+
+

data/lib/twilio-ruby/rest/pricing/v1/messaging.rb

@@ -0,0 +1,115 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Pricing
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Pricing < PricingBase
+            class V1 < Version
+                class MessagingList < ListResource
+                    ##
+                    # Initialize the MessagingList
+                    # @param [Version] version Version that contains the resource
+                    # @return [MessagingList] MessagingList
+                    def initialize(version)
+                        super(version)
+                        # Path Solution
+                        @solution = {  }
+                        @uri = "/Messaging"
+                        # Components
+                        @countries = nil
+                    end
+                
+
+                ##
+                # Access the countries
+                # @return [CountryList]
+                # @return [CountryContext] if sid was passed.
+                def countries(iso_country=:unset)
+                    raise ArgumentError, 'iso_country cannot be nil' if iso_country.nil?
+
+                    if iso_country != :unset
+                        return CountryContext.new(@version,iso_country )
+                    end
+
+                    @countries ||= CountryList.new(@version )
+                end
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Pricing.V1.MessagingList>'
+                    end
+                end
+
+                class MessagingPage < Page
+                    ##
+                    # Initialize the MessagingPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [MessagingPage] MessagingPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of MessagingInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [MessagingInstance] MessagingInstance
+                    def get_instance(payload)
+                        MessagingInstance.new(@version, payload)
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Pricing.V1.MessagingPage>'
+                    end
+                end
+                class MessagingInstance < InstanceResource
+                    ##
+                    # Initialize the MessagingInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this Messaging
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [MessagingInstance] MessagingInstance
+                    def initialize(version )
+                        super(version)
+                        
+                    end
+
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Pricing.V1.MessagingInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Pricing.V1.MessagingInstance>"
+                    end
+                end
+
+            end
+        end
+    end
+end