twilio-ruby 7.3.3 → 7.10.1

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

@@ -27,6 +27,7 @@ module Twilio
                     # @return [ShortCodeList] ShortCodeList
                     def initialize(version, account_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { account_sid: account_sid }
                         @uri = "/Accounts/#{@solution[:account_sid]}/SMS/ShortCodes.json"
@@ -79,6 +80,32 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists ShortCodePageMetadata records from the API as a list.
+                      # @param [String] friendly_name The string that identifies the ShortCode resources to read.
+                      # @param [String] short_code Only show the ShortCode resources that match this pattern. You can specify partial numbers and use '*' as a wildcard for any digit.
+                    # @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(friendly_name: :unset, short_code: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'ShortCode' => short_code,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        ShortCodePageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields ShortCodeInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -102,7 +129,7 @@ module Twilio
                     # @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 ShortCodeInstance
-                    def page(friendly_name: :unset, short_code: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(friendly_name: :unset, short_code: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'FriendlyName' => friendly_name,
                             'ShortCode' => short_code,
@@ -110,8 +137,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)
 
                         ShortCodePage.new(@version, response, @solution)
                     end
@@ -147,6 +177,7 @@ module Twilio
                     # @return [ShortCodeContext] ShortCodeContext
                     def initialize(version, account_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { account_sid: account_sid, sid: sid,  }
@@ -161,6 +192,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.fetch('GET', @uri, headers: headers)
                         ShortCodeInstance.new(
                             @version,
@@ -170,6 +205,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the ShortCodeInstanceMetadata
+                    # @return [ShortCodeInstance] Fetched ShortCodeInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        short_code_instance = ShortCodeInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            sid: @solution[:sid],
+                        )
+                        ShortCodeInstanceMetadata.new(
+                            @version,
+                            short_code_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the ShortCodeInstance
                     # @param [String] friendly_name A descriptive string that you created to describe this resource. It can be up to 64 characters long. By default, the `FriendlyName` is the short code.
@@ -199,6 +260,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.update('POST', @uri, data: data, headers: headers)
                         ShortCodeInstance.new(
                             @version,
@@ -208,6 +273,54 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the ShortCodeInstanceMetadata
+                    # @param [String] friendly_name A descriptive string that you created to describe this resource. It can be up to 64 characters long. By default, the `FriendlyName` is the short code.
+                    # @param [String] api_version The API version to use to start a new TwiML session. Can be: `2010-04-01` or `2008-08-01`.
+                    # @param [String] sms_url The URL we should call when receiving an incoming SMS message to this short code.
+                    # @param [String] sms_method The HTTP method we should use when calling the `sms_url`. Can be: `GET` or `POST`.
+                    # @param [String] sms_fallback_url The URL that we should call if an error occurs while retrieving or executing the TwiML from `sms_url`.
+                    # @param [String] sms_fallback_method The HTTP method that we should use to call the `sms_fallback_url`. Can be: `GET` or `POST`.
+                    # @return [ShortCodeInstance] Updated ShortCodeInstance
+                    def update_with_metadata(
+                      friendly_name: :unset, 
+                      api_version: :unset, 
+                      sms_url: :unset, 
+                      sms_method: :unset, 
+                      sms_fallback_url: :unset, 
+                      sms_fallback_method: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'ApiVersion' => api_version,
+                            'SmsUrl' => sms_url,
+                            'SmsMethod' => sms_method,
+                            'SmsFallbackUrl' => sms_fallback_url,
+                            'SmsFallbackMethod' => sms_fallback_method,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        short_code_instance = ShortCodeInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            sid: @solution[:sid],
+                        )
+                        ShortCodeInstanceMetadata.new(
+                            @version,
+                            short_code_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -224,6 +337,53 @@ module Twilio
                     end
                 end
 
+                class ShortCodeInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new ShortCodeInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}ShortCodeInstance] short_code_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 [ShortCodeInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, short_code_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @short_code_instance = short_code_instance
+                    end
+
+                    def short_code
+                        @short_code_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.ShortCodeInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class ShortCodeListResponse < InstanceListResource
+                    # @param [Array<ShortCodeInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @short_code_instance = payload.body[key].map do |data|
+                        ShortCodeInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def short_code_instance
+                          @instance
+                      end
+                  end
+
                 class ShortCodePage < Page
                     ##
                     # Initialize the ShortCodePage
@@ -233,6 +393,7 @@ module Twilio
                     # @return [ShortCodePage] ShortCodePage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -252,6 +413,66 @@ module Twilio
                         '<Twilio.Api.V2010.ShortCodePage>'
                     end
                 end
+
+                class ShortCodePageMetadata < PageMetadata
+                    attr_reader :short_code_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @short_code_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @short_code_page << ShortCodeListResponse.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
+                        @short_code_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Api::V2010PageMetadata>';
+                    end
+                end
+                class ShortCodeListResponse < InstanceListResource
+
+                    # @param [Array<ShortCodeInstance>] 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
+                      @short_code = data_list.map do |data|
+                        ShortCodeInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def short_code
+                        @short_code
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class ShortCodeInstance < InstanceResource
                     ##
                     # Initialize the ShortCodeInstance
@@ -265,6 +486,7 @@ module Twilio
                     def initialize(version, payload , account_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],

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

@@ -27,6 +27,7 @@ module Twilio
                     # @return [SigningKeyList] SigningKeyList
                     def initialize(version, account_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { account_sid: account_sid }
                         @uri = "/Accounts/#{@solution[:account_sid]}/SigningKeys.json"
@@ -71,6 +72,28 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists SigningKeyPageMetadata records from the API as a list.
+                    # @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(limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        SigningKeyPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields SigningKeyInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -92,14 +115,17 @@ module Twilio
                     # @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 SigningKeyInstance
-                    def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'PageToken' => page_token,
                             '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)
 
                         SigningKeyPage.new(@version, response, @solution)
                     end
@@ -135,6 +161,7 @@ module Twilio
                     # @return [SigningKeyContext] SigningKeyContext
                     def initialize(version, account_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { account_sid: account_sid, sid: sid,  }
@@ -149,9 +176,31 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the SigningKeyInstanceMetadata
+                    # @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)
+                          signingKey_instance = SigningKeyInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          SigningKeyInstanceMetadata.new(@version, signingKey_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the SigningKeyInstance
                     # @return [SigningKeyInstance] Fetched SigningKeyInstance
@@ -159,6 +208,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.fetch('GET', @uri, headers: headers)
                         SigningKeyInstance.new(
                             @version,
@@ -168,6 +221,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the SigningKeyInstanceMetadata
+                    # @return [SigningKeyInstance] Fetched SigningKeyInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        signing_key_instance = SigningKeyInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            sid: @solution[:sid],
+                        )
+                        SigningKeyInstanceMetadata.new(
+                            @version,
+                            signing_key_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the SigningKeyInstance
                     # @param [String] friendly_name 
@@ -182,6 +261,10 @@ module Twilio
 
                         headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
                         
+                        
+                        
+                        
+                        
                         payload = @version.update('POST', @uri, data: data, headers: headers)
                         SigningKeyInstance.new(
                             @version,
@@ -191,6 +274,39 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the SigningKeyInstanceMetadata
+                    # @param [String] friendly_name 
+                    # @return [SigningKeyInstance] Updated SigningKeyInstance
+                    def update_with_metadata(
+                      friendly_name: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            '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)
+                        signing_key_instance = SigningKeyInstance.new(
+                            @version,
+                            response.body,
+                            account_sid: @solution[:account_sid],
+                            sid: @solution[:sid],
+                        )
+                        SigningKeyInstanceMetadata.new(
+                            @version,
+                            signing_key_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -207,6 +323,53 @@ module Twilio
                     end
                 end
 
+                class SigningKeyInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new SigningKeyInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}SigningKeyInstance] signing_key_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 [SigningKeyInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, signing_key_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @signing_key_instance = signing_key_instance
+                    end
+
+                    def signing_key
+                        @signing_key_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.SigningKeyInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class SigningKeyListResponse < InstanceListResource
+                    # @param [Array<SigningKeyInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @signing_key_instance = payload.body[key].map do |data|
+                        SigningKeyInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def signing_key_instance
+                          @instance
+                      end
+                  end
+
                 class SigningKeyPage < Page
                     ##
                     # Initialize the SigningKeyPage
@@ -216,6 +379,7 @@ module Twilio
                     # @return [SigningKeyPage] SigningKeyPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -235,6 +399,66 @@ module Twilio
                         '<Twilio.Api.V2010.SigningKeyPage>'
                     end
                 end
+
+                class SigningKeyPageMetadata < PageMetadata
+                    attr_reader :signing_key_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @signing_key_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @signing_key_page << SigningKeyListResponse.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
+                        @signing_key_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Api::V2010PageMetadata>';
+                    end
+                end
+                class SigningKeyListResponse < InstanceListResource
+
+                    # @param [Array<SigningKeyInstance>] 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
+                      @signing_key = data_list.map do |data|
+                        SigningKeyInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def signing_key
+                        @signing_key
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class SigningKeyInstance < InstanceResource
                     ##
                     # Initialize the SigningKeyInstance
@@ -248,6 +472,7 @@ module Twilio
                     def initialize(version, payload , account_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],