twilio-ruby 5.52.0 → 5.67.3

data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/bundle.rb

@@ -34,12 +34,14 @@ module Twilio
             #   status changes.
             # @param [String] regulation_sid The unique string of a regulation that is
             #   associated to the Bundle resource.
-            # @param [String] iso_country The ISO country code of the Bundle's phone number
-            #   country ownership request.
-            # @param [bundle.EndUserType] end_user_type The type of End User of the Bundle
-            #   resource.
+            # @param [String] iso_country The {ISO country
+            #   code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the Bundle's phone
+            #   number country ownership request.
+            # @param [bundle.EndUserType] end_user_type The {type of End
+            #   User}[https://www.twilio.com/docs/phone-numbers/regulatory/api/end-user-types]
+            #   of the Bundle resource.
             # @param [String] number_type The type of phone number of the Bundle's ownership
-            #   request.
+            #   request. Can be `local`, `mobile`, `national`, or `toll free`.
             # @return [BundleInstance] Created BundleInstance
             def create(friendly_name: nil, email: nil, status_callback: :unset, regulation_sid: :unset, iso_country: :unset, end_user_type: :unset, number_type: :unset)
               data = Twilio::Values.of({
@@ -62,14 +64,28 @@ module Twilio
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
             # @param [bundle.Status] status The verification status of the Bundle resource.
+            #   Please refer to {Bundle
+            #   Statuses}[https://www.twilio.com/docs/phone-numbers/regulatory/api/bundles#bundle-statuses]
+            #   for more details.
             # @param [String] friendly_name The string that you assigned to describe the
-            #   resource.
-            # @param [String] regulation_sid The unique string of a regulation that is
-            #   associated to the Bundle resource.
-            # @param [String] iso_country The ISO country code of the Bundle's phone number
-            #   country ownership request.
+            #   resource. The column can contain 255 variable characters.
+            # @param [String] regulation_sid The unique string of a {Regulation
+            #   resource}[https://www.twilio.com/docs/phone-numbers/regulatory/api/regulations]
+            #   that is associated to the Bundle resource.
+            # @param [String] iso_country The 2-digit {ISO country
+            #   code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the Bundle's phone
+            #   number country ownership request.
             # @param [String] number_type The type of phone number of the Bundle's ownership
-            #   request.
+            #   request. Can be `local`, `mobile`, `national`, or `tollfree`.
+            # @param [Boolean] has_valid_until_date Indicates that the Bundle is a valid
+            #   Bundle until a specified expiration date.
+            # @param [bundle.SortBy] sort_by Can be `valid-until` or `date-updated`. Defaults
+            #   to `date-created`.
+            # @param [bundle.SortDirection] sort_direction Default is `DESC`. Can be `ASC` or
+            #   `DESC`.
+            # @param [Time] valid_until_date_before Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well.
+            # @param [Time] valid_until_date Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well.
+            # @param [Time] valid_until_date_after Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well.
             # @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
@@ -77,13 +93,19 @@ module Twilio
             #    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(status: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_type: :unset, limit: nil, page_size: nil)
+            def list(status: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_type: :unset, has_valid_until_date: :unset, sort_by: :unset, sort_direction: :unset, valid_until_date_before: :unset, valid_until_date: :unset, valid_until_date_after: :unset, limit: nil, page_size: nil)
               self.stream(
                   status: status,
                   friendly_name: friendly_name,
                   regulation_sid: regulation_sid,
                   iso_country: iso_country,
                   number_type: number_type,
+                  has_valid_until_date: has_valid_until_date,
+                  sort_by: sort_by,
+                  sort_direction: sort_direction,
+                  valid_until_date_before: valid_until_date_before,
+                  valid_until_date: valid_until_date,
+                  valid_until_date_after: valid_until_date_after,
                   limit: limit,
                   page_size: page_size
               ).entries
@@ -94,14 +116,28 @@ module Twilio
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
             # @param [bundle.Status] status The verification status of the Bundle resource.
+            #   Please refer to {Bundle
+            #   Statuses}[https://www.twilio.com/docs/phone-numbers/regulatory/api/bundles#bundle-statuses]
+            #   for more details.
             # @param [String] friendly_name The string that you assigned to describe the
-            #   resource.
-            # @param [String] regulation_sid The unique string of a regulation that is
-            #   associated to the Bundle resource.
-            # @param [String] iso_country The ISO country code of the Bundle's phone number
-            #   country ownership request.
+            #   resource. The column can contain 255 variable characters.
+            # @param [String] regulation_sid The unique string of a {Regulation
+            #   resource}[https://www.twilio.com/docs/phone-numbers/regulatory/api/regulations]
+            #   that is associated to the Bundle resource.
+            # @param [String] iso_country The 2-digit {ISO country
+            #   code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the Bundle's phone
+            #   number country ownership request.
             # @param [String] number_type The type of phone number of the Bundle's ownership
-            #   request.
+            #   request. Can be `local`, `mobile`, `national`, or `tollfree`.
+            # @param [Boolean] has_valid_until_date Indicates that the Bundle is a valid
+            #   Bundle until a specified expiration date.
+            # @param [bundle.SortBy] sort_by Can be `valid-until` or `date-updated`. Defaults
+            #   to `date-created`.
+            # @param [bundle.SortDirection] sort_direction Default is `DESC`. Can be `ASC` or
+            #   `DESC`.
+            # @param [Time] valid_until_date_before Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well.
+            # @param [Time] valid_until_date Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well.
+            # @param [Time] valid_until_date_after Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well.
             # @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
@@ -109,7 +145,7 @@ module Twilio
             #    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(status: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_type: :unset, limit: nil, page_size: nil)
+            def stream(status: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_type: :unset, has_valid_until_date: :unset, sort_by: :unset, sort_direction: :unset, valid_until_date_before: :unset, valid_until_date: :unset, valid_until_date_after: :unset, limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
               page = self.page(
@@ -118,6 +154,12 @@ module Twilio
                   regulation_sid: regulation_sid,
                   iso_country: iso_country,
                   number_type: number_type,
+                  has_valid_until_date: has_valid_until_date,
+                  sort_by: sort_by,
+                  sort_direction: sort_direction,
+                  valid_until_date_before: valid_until_date_before,
+                  valid_until_date: valid_until_date,
+                  valid_until_date_after: valid_until_date_after,
                   page_size: limits[:page_size],
               )
 
@@ -142,25 +184,45 @@ module Twilio
             # Retrieve a single page of BundleInstance records from the API.
             # Request is executed immediately.
             # @param [bundle.Status] status The verification status of the Bundle resource.
+            #   Please refer to {Bundle
+            #   Statuses}[https://www.twilio.com/docs/phone-numbers/regulatory/api/bundles#bundle-statuses]
+            #   for more details.
             # @param [String] friendly_name The string that you assigned to describe the
-            #   resource.
-            # @param [String] regulation_sid The unique string of a regulation that is
-            #   associated to the Bundle resource.
-            # @param [String] iso_country The ISO country code of the Bundle's phone number
-            #   country ownership request.
+            #   resource. The column can contain 255 variable characters.
+            # @param [String] regulation_sid The unique string of a {Regulation
+            #   resource}[https://www.twilio.com/docs/phone-numbers/regulatory/api/regulations]
+            #   that is associated to the Bundle resource.
+            # @param [String] iso_country The 2-digit {ISO country
+            #   code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the Bundle's phone
+            #   number country ownership request.
             # @param [String] number_type The type of phone number of the Bundle's ownership
-            #   request.
+            #   request. Can be `local`, `mobile`, `national`, or `tollfree`.
+            # @param [Boolean] has_valid_until_date Indicates that the Bundle is a valid
+            #   Bundle until a specified expiration date.
+            # @param [bundle.SortBy] sort_by Can be `valid-until` or `date-updated`. Defaults
+            #   to `date-created`.
+            # @param [bundle.SortDirection] sort_direction Default is `DESC`. Can be `ASC` or
+            #   `DESC`.
+            # @param [Time] valid_until_date_before Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well.
+            # @param [Time] valid_until_date Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well.
+            # @param [Time] valid_until_date_after Date to filter Bundles having their `valid_until_date` before or after the specified date. Can be `ValidUntilDate>=` or `ValidUntilDate<=`. Both can be used in conjunction as well.
             # @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 BundleInstance
-            def page(status: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_type: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+            def page(status: :unset, friendly_name: :unset, regulation_sid: :unset, iso_country: :unset, number_type: :unset, has_valid_until_date: :unset, sort_by: :unset, sort_direction: :unset, valid_until_date_before: :unset, valid_until_date: :unset, valid_until_date_after: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
               params = Twilio::Values.of({
                   'Status' => status,
                   'FriendlyName' => friendly_name,
                   'RegulationSid' => regulation_sid,
                   'IsoCountry' => iso_country,
                   'NumberType' => number_type,
+                  'HasValidUntilDate' => has_valid_until_date,
+                  'SortBy' => sort_by,
+                  'SortDirection' => sort_direction,
+                  'ValidUntilDate<' => Twilio.serialize_iso8601_datetime(valid_until_date_before),
+                  'ValidUntilDate' => Twilio.serialize_iso8601_datetime(valid_until_date),
+                  'ValidUntilDate>' => Twilio.serialize_iso8601_datetime(valid_until_date_after),
                   'PageToken' => page_token,
                   'Page' => page_number,
                   'PageSize' => page_size,
@@ -237,6 +299,8 @@ module Twilio
               # Dependents
               @evaluations = nil
               @item_assignments = nil
+              @bundle_copies = nil
+              @replace_items = nil
             end
 
             ##
@@ -314,6 +378,30 @@ module Twilio
               @item_assignments
             end
 
+            ##
+            # Access the bundle_copies
+            # @return [BundleCopyList]
+            # @return [BundleCopyContext]
+            def bundle_copies
+              unless @bundle_copies
+                @bundle_copies = BundleCopyList.new(@version, bundle_sid: @solution[:sid], )
+              end
+
+              @bundle_copies
+            end
+
+            ##
+            # Access the replace_items
+            # @return [ReplaceItemsList]
+            # @return [ReplaceItemsContext]
+            def replace_items
+              unless @replace_items
+                @replace_items = ReplaceItemsList.new(@version, bundle_sid: @solution[:sid], )
+              end
+
+              @replace_items
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
@@ -491,6 +579,20 @@ module Twilio
               context.item_assignments
             end
 
+            ##
+            # Access the bundle_copies
+            # @return [bundle_copies] bundle_copies
+            def bundle_copies
+              context.bundle_copies
+            end
+
+            ##
+            # Access the replace_items
+            # @return [replace_items] replace_items
+            def replace_items
+              context.replace_items
+            end
+
             ##
             # Provide a user friendly representation
             def to_s

data/lib/twilio-ruby/rest/numbers/v2/regulatory_compliance/supporting_document.rb

@@ -242,6 +242,7 @@ module Twilio
                   'friendly_name' => payload['friendly_name'],
                   'mime_type' => payload['mime_type'],
                   'status' => payload['status'],
+                  'failure_reason' => payload['failure_reason'],
                   'type' => payload['type'],
                   'attributes' => payload['attributes'],
                   'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
@@ -295,6 +296,12 @@ module Twilio
               @properties['status']
             end
 
+            ##
+            # @return [String] The failure reason of the Supporting Document Resource.
+            def failure_reason
+              @properties['failure_reason']
+            end
+
             ##
             # @return [String] The type of the Supporting Document
             def type

data/lib/twilio-ruby/rest/pricing/v2/country.rb

@@ -0,0 +1,280 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Pricing < Domain
+      class V2 < Version
+        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 = "/Trunking/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 CountryInstance 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.V2.CountryList>'
+          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.V2.CountryPage>'
+          end
+        end
+
+        class CountryContext < InstanceContext
+          ##
+          # Initialize the CountryContext
+          # @param [Version] version Version that contains the resource
+          # @param [String] iso_country The {ISO country
+          #   code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the origin-based
+          #   voice pricing information to fetch.
+          # @return [CountryContext] CountryContext
+          def initialize(version, iso_country)
+            super(version)
+
+            # Path Solution
+            @solution = {iso_country: iso_country, }
+            @uri = "/Trunking/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.V2.CountryContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Pricing.V2.CountryContext #{context}>"
+          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] iso_country The {ISO country
+          #   code}[https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2] of the origin-based
+          #   voice pricing information 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'],
+                'terminating_prefix_prices' => payload['terminating_prefix_prices'],
+                'originating_call_prices' => payload['originating_call_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] CountryContext for this CountryInstance
+          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
+          def iso_country
+            @properties['iso_country']
+          end
+
+          ##
+          # @return [Array[String]] The list of TerminatingPrefixPrice records
+          def terminating_prefix_prices
+            @properties['terminating_prefix_prices']
+          end
+
+          ##
+          # @return [Array[String]] The list of OriginatingCallPrice records
+          def originating_call_prices
+            @properties['originating_call_prices']
+          end
+
+          ##
+          # @return [String] The currency in which prices are measured, in ISO 4127 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.V2.CountryInstance #{values}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+            "<Twilio.Pricing.V2.CountryInstance #{values}>"
+          end
+        end
+      end
+    end
+  end
+end