twilio-ruby 7.4.4 → 7.10.4

data/lib/twilio-ruby/rest/api/v2010/account/usage/trigger.rb

@@ -28,6 +28,7 @@ module Twilio
                     # @return [TriggerList] TriggerList
                     def initialize(version, account_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { account_sid: account_sid }
                         @uri = "/Accounts/#{@solution[:account_sid]}/Usage/Triggers.json"
@@ -37,7 +38,7 @@ module Twilio
                     # Create the TriggerInstance
                     # @param [String] callback_url The URL we should call using `callback_method` when the trigger fires.
                     # @param [String] trigger_value The usage value at which the trigger should fire.  For convenience, you can use an offset value such as `+30` to specify a trigger_value that is 30 units more than the current usage value. Be sure to urlencode a `+` as `%2B`.
-                    # @param [UsageCategory] usage_category 
+                    # @param [String] usage_category The usage category that the trigger should watch.  Use one of the supported [usage categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) for this value.
                     # @param [String] callback_method The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is `POST`.
                     # @param [String] friendly_name A descriptive string that you create to describe the resource. It can be up to 64 characters long.
                     # @param [Recurring] recurring 
@@ -77,6 +78,56 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the TriggerInstanceMetadata
+                    # @param [String] callback_url The URL we should call using `callback_method` when the trigger fires.
+                    # @param [String] trigger_value The usage value at which the trigger should fire.  For convenience, you can use an offset value such as `+30` to specify a trigger_value that is 30 units more than the current usage value. Be sure to urlencode a `+` as `%2B`.
+                    # @param [String] usage_category The usage category that the trigger should watch.  Use one of the supported [usage categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) for this value.
+                    # @param [String] callback_method The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is `POST`.
+                    # @param [String] friendly_name A descriptive string that you create to describe the resource. It can be up to 64 characters long.
+                    # @param [Recurring] recurring 
+                    # @param [TriggerField] trigger_by 
+                    # @return [TriggerInstance] Created TriggerInstance
+                    def create_with_metadata(
+                      callback_url: nil, 
+                      trigger_value: nil, 
+                      usage_category: nil, 
+                      callback_method: :unset, 
+                      friendly_name: :unset, 
+                      recurring: :unset, 
+                      trigger_by: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'CallbackUrl' => callback_url,
+                            'TriggerValue' => trigger_value,
+                            'UsageCategory' => usage_category,
+                            'CallbackMethod' => callback_method,
+                            'FriendlyName' => friendly_name,
+                            'Recurring' => recurring,
+                            'TriggerBy' => trigger_by,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        trigger_instance = TriggerInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                        )
+                        TriggerInstanceMetadata.new(
+                            @version,
+                            trigger_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists TriggerInstance records from the API as a list.
@@ -84,7 +135,7 @@ module Twilio
                     # memory before returning.
                     # @param [Recurring] recurring The frequency of recurring UsageTriggers to read. Can be: `daily`, `monthly`, or `yearly` to read recurring UsageTriggers. An empty value or a value of `alltime` reads non-recurring UsageTriggers.
                     # @param [TriggerField] trigger_by The trigger field of the UsageTriggers to read.  Can be: `count`, `usage`, or `price` as described in the [UsageRecords documentation](https://www.twilio.com/docs/usage/api/usage-record#usage-count-price).
-                    # @param [UsageCategory] usage_category The usage category of the UsageTriggers to read. Must be a supported [usage categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories).
+                    # @param [String] usage_category The usage category of the UsageTriggers to read. Must be a supported [usage categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories).
                     # @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
@@ -108,7 +159,7 @@ module Twilio
                     # is reached.
                     # @param [Recurring] recurring The frequency of recurring UsageTriggers to read. Can be: `daily`, `monthly`, or `yearly` to read recurring UsageTriggers. An empty value or a value of `alltime` reads non-recurring UsageTriggers.
                     # @param [TriggerField] trigger_by The trigger field of the UsageTriggers to read.  Can be: `count`, `usage`, or `price` as described in the [UsageRecords documentation](https://www.twilio.com/docs/usage/api/usage-record#usage-count-price).
-                    # @param [UsageCategory] usage_category The usage category of the UsageTriggers to read. Must be a supported [usage categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories).
+                    # @param [String] usage_category The usage category of the UsageTriggers to read. Must be a supported [usage categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories).
                     # @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
@@ -128,6 +179,34 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists TriggerPageMetadata records from the API as a list.
+                      # @param [Recurring] recurring The frequency of recurring UsageTriggers to read. Can be: `daily`, `monthly`, or `yearly` to read recurring UsageTriggers. An empty value or a value of `alltime` reads non-recurring UsageTriggers.
+                      # @param [TriggerField] trigger_by The trigger field of the UsageTriggers to read.  Can be: `count`, `usage`, or `price` as described in the [UsageRecords documentation](https://www.twilio.com/docs/usage/api/usage-record#usage-count-price).
+                      # @param [String] usage_category The usage category of the UsageTriggers to read. Must be a supported [usage categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories).
+                    # @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_with_metadata(recurring: :unset, trigger_by: :unset, usage_category: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'Recurring' => recurring,
+                            'TriggerBy' => trigger_by,
+                            'UsageCategory' => usage_category,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        TriggerPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields TriggerInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -147,12 +226,12 @@ module Twilio
                     # Request is executed immediately.
                     # @param [Recurring] recurring The frequency of recurring UsageTriggers to read. Can be: `daily`, `monthly`, or `yearly` to read recurring UsageTriggers. An empty value or a value of `alltime` reads non-recurring UsageTriggers.
                     # @param [TriggerField] trigger_by The trigger field of the UsageTriggers to read.  Can be: `count`, `usage`, or `price` as described in the [UsageRecords documentation](https://www.twilio.com/docs/usage/api/usage-record#usage-count-price).
-                    # @param [UsageCategory] usage_category The usage category of the UsageTriggers to read. Must be a supported [usage categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories).
+                    # @param [String] usage_category The usage category of the UsageTriggers to read. Must be a supported [usage categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories).
                     # @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 TriggerInstance
-                    def page(recurring: :unset, trigger_by: :unset, usage_category: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(recurring: :unset, trigger_by: :unset, usage_category: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'Recurring' => recurring,
                             'TriggerBy' => trigger_by,
@@ -201,6 +280,7 @@ module Twilio
                     # @return [TriggerContext] TriggerContext
                     def initialize(version, account_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { account_sid: account_sid, sid: sid,  }
@@ -217,9 +297,29 @@ module Twilio
                         
                         
                         
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the TriggerInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          trigger_instance = TriggerInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          TriggerInstanceMetadata.new(@version, trigger_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the TriggerInstance
                     # @return [TriggerInstance] Fetched TriggerInstance
@@ -240,6 +340,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the TriggerInstanceMetadata
+                    # @return [TriggerInstance] Fetched TriggerInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        trigger_instance = TriggerInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            sid: @solution[:sid],
+                        )
+                        TriggerInstanceMetadata.new(
+                            @version,
+                            trigger_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the TriggerInstance
                     # @param [String] callback_method The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is `POST`.
@@ -273,6 +399,45 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the TriggerInstanceMetadata
+                    # @param [String] callback_method The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is `POST`.
+                    # @param [String] callback_url The URL we should call using `callback_method` when the trigger fires.
+                    # @param [String] friendly_name A descriptive string that you create to describe the resource. It can be up to 64 characters long.
+                    # @return [TriggerInstance] Updated TriggerInstance
+                    def update_with_metadata(
+                      callback_method: :unset, 
+                      callback_url: :unset, 
+                      friendly_name: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'CallbackMethod' => callback_method,
+                            'CallbackUrl' => callback_url,
+                            'FriendlyName' => friendly_name,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        trigger_instance = TriggerInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            sid: @solution[:sid],
+                        )
+                        TriggerInstanceMetadata.new(
+                            @version,
+                            trigger_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -289,6 +454,53 @@ module Twilio
                     end
                 end
 
+                class TriggerInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new TriggerInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}TriggerInstance] trigger_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [TriggerInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, trigger_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @trigger_instance = trigger_instance
+                    end
+
+                    def trigger
+                        @trigger_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.TriggerInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class TriggerListResponse < InstanceListResource
+                    # @param [Array<TriggerInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @trigger_instance = payload.body[key].map do |data|
+                        TriggerInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def trigger_instance
+                          @instance
+                      end
+                  end
+
                 class TriggerPage < Page
                     ##
                     # Initialize the TriggerPage
@@ -298,6 +510,7 @@ module Twilio
                     # @return [TriggerPage] TriggerPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -317,6 +530,66 @@ module Twilio
                         '<Twilio.Api.V2010.TriggerPage>'
                     end
                 end
+
+                class TriggerPageMetadata < PageMetadata
+                    attr_reader :trigger_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @trigger_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @trigger_page << TriggerListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @trigger_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Api::V2010PageMetadata>';
+                    end
+                end
+                class TriggerListResponse < InstanceListResource
+
+                    # @param [Array<TriggerInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @trigger = data_list.map do |data|
+                        TriggerInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def trigger
+                        @trigger
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class TriggerInstance < InstanceResource
                     ##
                     # Initialize the TriggerInstance
@@ -330,6 +603,7 @@ module Twilio
                     def initialize(version, payload , account_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],
@@ -451,7 +725,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [UsageCategory] 
+                    # @return [String] The usage category the trigger watches. Must be one of the supported [usage categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories).
                     def usage_category
                         @properties['usage_category']
                     end

data/lib/twilio-ruby/rest/api/v2010/account/usage.rb

@@ -27,6 +27,7 @@ module Twilio
                     # @return [UsageList] UsageList
                     def initialize(version, account_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { account_sid: account_sid }
                         @uri = "/Accounts/#{@solution[:account_sid]}/Usage.json"
@@ -72,6 +73,7 @@ module Twilio
                     # @return [UsagePage] UsagePage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -91,6 +93,66 @@ module Twilio
                         '<Twilio.Api.V2010.UsagePage>'
                     end
                 end
+
+                class UsagePageMetadata < PageMetadata
+                    attr_reader :usage_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @usage_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @usage_page << UsageListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @usage_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Api::V2010PageMetadata>';
+                    end
+                end
+                class UsageListResponse < InstanceListResource
+
+                    # @param [Array<UsageInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @usage = data_list.map do |data|
+                        UsageInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def usage
+                        @usage
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class UsageInstance < InstanceResource
                     ##
                     # Initialize the UsageInstance
@@ -104,6 +166,7 @@ module Twilio
                     def initialize(version , account_sid: nil)
                         super(version)
                         
+                        
                     end
 
                     

data/lib/twilio-ruby/rest/api/v2010/account/validation_request.rb

@@ -27,6 +27,7 @@ module Twilio
                     # @return [ValidationRequestList] ValidationRequestList
                     def initialize(version, account_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { account_sid: account_sid }
                         @uri = "/Accounts/#{@solution[:account_sid]}/OutgoingCallerIds.json"
@@ -73,6 +74,53 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the ValidationRequestInstanceMetadata
+                    # @param [String] phone_number The phone number to verify in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.
+                    # @param [String] friendly_name A descriptive string that you create to describe the new caller ID resource. It can be up to 64 characters long. The default value is a formatted version of the phone number.
+                    # @param [String] call_delay The number of seconds to delay before initiating the verification call. Can be an integer between `0` and `60`, inclusive. The default is `0`.
+                    # @param [String] extension The digits to dial after connecting the verification call.
+                    # @param [String] status_callback The URL we should call using the `status_callback_method` to send status information about the verification process to your application.
+                    # @param [String] status_callback_method The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST`, and the default is `POST`.
+                    # @return [ValidationRequestInstance] Created ValidationRequestInstance
+                    def create_with_metadata(
+                      phone_number: nil, 
+                      friendly_name: :unset, 
+                      call_delay: :unset, 
+                      extension: :unset, 
+                      status_callback: :unset, 
+                      status_callback_method: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'PhoneNumber' => phone_number,
+                            'FriendlyName' => friendly_name,
+                            'CallDelay' => call_delay,
+                            'Extension' => extension,
+                            'StatusCallback' => status_callback,
+                            'StatusCallbackMethod' => status_callback_method,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        validation_request_instance = ValidationRequestInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                        )
+                        ValidationRequestInstanceMetadata.new(
+                            @version,
+                            validation_request_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
 
 
@@ -91,6 +139,7 @@ module Twilio
                     # @return [ValidationRequestPage] ValidationRequestPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -110,6 +159,66 @@ module Twilio
                         '<Twilio.Api.V2010.ValidationRequestPage>'
                     end
                 end
+
+                class ValidationRequestPageMetadata < PageMetadata
+                    attr_reader :validation_request_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @validation_request_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @validation_request_page << ValidationRequestListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += @payload.body[key].size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @validation_request_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Api::V2010PageMetadata>';
+                    end
+                end
+                class ValidationRequestListResponse < InstanceListResource
+
+                    # @param [Array<ValidationRequestInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @validation_request = data_list.map do |data|
+                        ValidationRequestInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def validation_request
+                        @validation_request
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class ValidationRequestInstance < InstanceResource
                     ##
                     # Initialize the ValidationRequestInstance
@@ -123,6 +232,7 @@ module Twilio
                     def initialize(version, payload , account_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],