twilio-ruby 6.8.0 → 7.10.7

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

@@ -21,12 +21,14 @@ module Twilio
                 class UsageList < ListResource
 
                      class TriggerList < ListResource
+                
                     ##
                     # Initialize the TriggerList
                     # @param [Version] version Version that contains the resource
                     # @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"
@@ -36,20 +38,20 @@ 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 
                     # @param [TriggerField] trigger_by 
                     # @return [TriggerInstance] Created TriggerInstance
                     def create(
-                        callback_url: nil, 
-                        trigger_value: nil, 
-                        usage_category: nil, 
-                        callback_method: :unset, 
-                        friendly_name: :unset, 
-                        recurring: :unset, 
-                        trigger_by: :unset
+                      callback_url: nil, 
+                      trigger_value: nil, 
+                      usage_category: nil, 
+                      callback_method: :unset, 
+                      friendly_name: :unset, 
+                      recurring: :unset, 
+                      trigger_by: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -62,7 +64,13 @@ module Twilio
                             'TriggerBy' => trigger_by,
                         })
 
-                        payload = @version.create('POST', @uri, data: data)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
                         TriggerInstance.new(
                             @version,
                             payload,
@@ -70,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.
@@ -77,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
@@ -101,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
@@ -118,7 +176,39 @@ module Twilio
                             usage_category: usage_category,
                             page_size: limits[:page_size], )
 
-                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
+                    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
 
                     ##
@@ -130,9 +220,13 @@ module Twilio
 
                         page = self.page(page_size: limits[:page_size], )
 
-                        @version.stream(page,
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
                             limit: limits[:limit],
-                            page_limit: limits[:page_limit]).each {|x| yield x}
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
                     end
 
                     ##
@@ -140,12 +234,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,
@@ -154,8 +248,11 @@ module Twilio
                             'Page' => page_number,
                             'PageSize' => page_size,
                         })
+                        headers = Twilio::Values.of({})
+                        
+                        
 
-                        response = @version.page('GET', @uri, params: params)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         TriggerPage.new(@version, response, @solution)
                     end
@@ -191,6 +288,7 @@ module Twilio
                     # @return [TriggerContext] TriggerContext
                     def initialize(version, account_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { account_sid: account_sid, sid: sid,  }
@@ -203,7 +301,31 @@ module Twilio
                     # @return [Boolean] True if delete succeeds, false otherwise
                     def delete
 
-                        @version.delete('DELETE', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+
+                        @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
 
                     ##
@@ -211,7 +333,13 @@ module Twilio
                     # @return [TriggerInstance] Fetched TriggerInstance
                     def fetch
 
-                        payload = @version.fetch('GET', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
                         TriggerInstance.new(
                             @version,
                             payload,
@@ -220,6 +348,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`.
@@ -227,9 +381,9 @@ module Twilio
                     # @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(
-                        callback_method: :unset, 
-                        callback_url: :unset, 
-                        friendly_name: :unset
+                      callback_method: :unset, 
+                      callback_url: :unset, 
+                      friendly_name: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -238,7 +392,13 @@ module Twilio
                             'FriendlyName' => friendly_name,
                         })
 
-                        payload = @version.update('POST', @uri, data: data)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.update('POST', @uri, data: data, headers: headers)
                         TriggerInstance.new(
                             @version,
                             payload,
@@ -247,6 +407,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
@@ -263,6 +462,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
@@ -272,6 +518,7 @@ module Twilio
                     # @return [TriggerPage] TriggerPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -291,6 +538,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
@@ -304,6 +611,7 @@ module Twilio
                     def initialize(version, payload , account_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],
@@ -425,7 +733,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
@@ -459,9 +767,9 @@ module Twilio
                     # @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(
-                        callback_method: :unset, 
-                        callback_url: :unset, 
-                        friendly_name: :unset
+                      callback_method: :unset, 
+                      callback_url: :unset, 
+                      friendly_name: :unset
                     )
 
                         context.update(

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

@@ -20,12 +20,14 @@ module Twilio
                 class AccountContext < InstanceContext
 
                      class UsageList < ListResource
+                
                     ##
                     # Initialize the UsageList
                     # @param [Version] version Version that contains the resource
                     # @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"
@@ -71,6 +73,7 @@ module Twilio
                     # @return [UsagePage] UsagePage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -90,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
@@ -103,6 +166,7 @@ module Twilio
                     def initialize(version , account_sid: nil)
                         super(version)
                         
+                        
                     end