twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/notify/v1/credential.rb

@@ -18,12 +18,14 @@ module Twilio
         class Notify < NotifyBase
             class V1 < Version
                 class CredentialList < ListResource
+                
                     ##
                     # Initialize the CredentialList
                     # @param [Version] version Version that contains the resource
                     # @return [CredentialList] CredentialList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Credentials"
@@ -40,13 +42,13 @@ module Twilio
                     # @param [String] secret [FCM only] The `Server key` of your project from Firebase console under Settings / Cloud messaging.
                     # @return [CredentialInstance] Created CredentialInstance
                     def create(
-                        type: nil, 
-                        friendly_name: :unset, 
-                        certificate: :unset, 
-                        private_key: :unset, 
-                        sandbox: :unset, 
-                        api_key: :unset, 
-                        secret: :unset
+                      type: nil, 
+                      friendly_name: :unset, 
+                      certificate: :unset, 
+                      private_key: :unset, 
+                      sandbox: :unset, 
+                      api_key: :unset, 
+                      secret: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -59,13 +61,68 @@ module Twilio
                             'Secret' => secret,
                         })
 
-                        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)
                         CredentialInstance.new(
                             @version,
                             payload,
                         )
                     end
 
+                    ##
+                    # Create the CredentialInstanceMetadata
+                    # @param [PushService] type 
+                    # @param [String] friendly_name A descriptive string that you create to describe the resource. It can be up to 64 characters long.
+                    # @param [String] certificate [APN only] The URL-encoded representation of the certificate. Strip everything outside of the headers, e.g. `-----BEGIN CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`
+                    # @param [String] private_key [APN only] The URL-encoded representation of the private key. Strip everything outside of the headers, e.g. `-----BEGIN RSA PRIVATE KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\\\\n.-----END RSA PRIVATE KEY-----`
+                    # @param [Boolean] sandbox [APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.
+                    # @param [String] api_key [GCM only] The `Server key` of your project from Firebase console under Settings / Cloud messaging.
+                    # @param [String] secret [FCM only] The `Server key` of your project from Firebase console under Settings / Cloud messaging.
+                    # @return [CredentialInstance] Created CredentialInstance
+                    def create_with_metadata(
+                      type: nil, 
+                      friendly_name: :unset, 
+                      certificate: :unset, 
+                      private_key: :unset, 
+                      sandbox: :unset, 
+                      api_key: :unset, 
+                      secret: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Type' => type,
+                            'FriendlyName' => friendly_name,
+                            'Certificate' => certificate,
+                            'PrivateKey' => private_key,
+                            'Sandbox' => sandbox,
+                            'ApiKey' => api_key,
+                            'Secret' => secret,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        credential_instance = CredentialInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        CredentialInstanceMetadata.new(
+                            @version,
+                            credential_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists CredentialInstance records from the API as a list.
@@ -102,7 +159,33 @@ module Twilio
                         page = self.page(
                             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 CredentialPageMetadata 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)
+
+                        CredentialPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -114,9 +197,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
 
                     ##
@@ -126,14 +213,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 CredentialInstance
-                    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)
 
                         CredentialPage.new(@version, response, @solution)
                     end
@@ -160,8 +250,6 @@ module Twilio
                 end
 
 
-                ##
-                #PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
                 class CredentialContext < InstanceContext
                     ##
                     # Initialize the CredentialContext
@@ -170,6 +258,7 @@ module Twilio
                     # @return [CredentialContext] CredentialContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -182,7 +271,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 CredentialInstanceMetadata
+                    # @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)
+                          credential_instance = CredentialInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          CredentialInstanceMetadata.new(@version, credential_instance, response.headers, response.status_code)
                     end
 
                     ##
@@ -190,7 +303,13 @@ module Twilio
                     # @return [CredentialInstance] Fetched CredentialInstance
                     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)
                         CredentialInstance.new(
                             @version,
                             payload,
@@ -198,6 +317,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the CredentialInstanceMetadata
+                    # @return [CredentialInstance] Fetched CredentialInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        credential_instance = CredentialInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        CredentialInstanceMetadata.new(
+                            @version,
+                            credential_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the CredentialInstance
                     # @param [String] friendly_name A descriptive string that you create to describe the resource. It can be up to 64 characters long.
@@ -208,12 +352,12 @@ module Twilio
                     # @param [String] secret [FCM only] The `Server key` of your project from Firebase console under Settings / Cloud messaging.
                     # @return [CredentialInstance] Updated CredentialInstance
                     def update(
-                        friendly_name: :unset, 
-                        certificate: :unset, 
-                        private_key: :unset, 
-                        sandbox: :unset, 
-                        api_key: :unset, 
-                        secret: :unset
+                      friendly_name: :unset, 
+                      certificate: :unset, 
+                      private_key: :unset, 
+                      sandbox: :unset, 
+                      api_key: :unset, 
+                      secret: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -225,7 +369,13 @@ module Twilio
                             'Secret' => secret,
                         })
 
-                        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)
                         CredentialInstance.new(
                             @version,
                             payload,
@@ -233,6 +383,53 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the CredentialInstanceMetadata
+                    # @param [String] friendly_name A descriptive string that you create to describe the resource. It can be up to 64 characters long.
+                    # @param [String] certificate [APN only] The URL-encoded representation of the certificate. Strip everything outside of the headers, e.g. `-----BEGIN CERTIFICATE-----MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A==-----END CERTIFICATE-----`
+                    # @param [String] private_key [APN only] The URL-encoded representation of the private key. Strip everything outside of the headers, e.g. `-----BEGIN RSA PRIVATE KEY-----MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR\\\\n.-----END RSA PRIVATE KEY-----`
+                    # @param [Boolean] sandbox [APN only] Whether to send the credential to sandbox APNs. Can be `true` to send to sandbox APNs or `false` to send to production.
+                    # @param [String] api_key [GCM only] The `Server key` of your project from Firebase console under Settings / Cloud messaging.
+                    # @param [String] secret [FCM only] The `Server key` of your project from Firebase console under Settings / Cloud messaging.
+                    # @return [CredentialInstance] Updated CredentialInstance
+                    def update_with_metadata(
+                      friendly_name: :unset, 
+                      certificate: :unset, 
+                      private_key: :unset, 
+                      sandbox: :unset, 
+                      api_key: :unset, 
+                      secret: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'Certificate' => certificate,
+                            'PrivateKey' => private_key,
+                            'Sandbox' => sandbox,
+                            'ApiKey' => api_key,
+                            'Secret' => secret,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        credential_instance = CredentialInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        CredentialInstanceMetadata.new(
+                            @version,
+                            credential_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -249,6 +446,53 @@ module Twilio
                     end
                 end
 
+                class CredentialInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new CredentialInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}CredentialInstance] credential_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 [CredentialInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, credential_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @credential_instance = credential_instance
+                    end
+
+                    def credential
+                        @credential_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.CredentialInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class CredentialListResponse < InstanceListResource
+                    # @param [Array<CredentialInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @credential_instance = payload.body[key].map do |data|
+                        CredentialInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def credential_instance
+                          @instance
+                      end
+                  end
+
                 class CredentialPage < Page
                     ##
                     # Initialize the CredentialPage
@@ -258,6 +502,7 @@ module Twilio
                     # @return [CredentialPage] CredentialPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -277,6 +522,66 @@ module Twilio
                         '<Twilio.Notify.V1.CredentialPage>'
                     end
                 end
+
+                class CredentialPageMetadata < PageMetadata
+                    attr_reader :credential_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @credential_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @credential_page << CredentialListResponse.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
+                        @credential_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Notify::V1PageMetadata>';
+                    end
+                end
+                class CredentialListResponse < InstanceListResource
+
+                    # @param [Array<CredentialInstance>] 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
+                      @credential = data_list.map do |data|
+                        CredentialInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def credential
+                        @credential
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class CredentialInstance < InstanceResource
                     ##
                     # Initialize the CredentialInstance
@@ -290,6 +595,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],
@@ -392,12 +698,12 @@ module Twilio
                     # @param [String] secret [FCM only] The `Server key` of your project from Firebase console under Settings / Cloud messaging.
                     # @return [CredentialInstance] Updated CredentialInstance
                     def update(
-                        friendly_name: :unset, 
-                        certificate: :unset, 
-                        private_key: :unset, 
-                        sandbox: :unset, 
-                        api_key: :unset, 
-                        secret: :unset
+                      friendly_name: :unset, 
+                      certificate: :unset, 
+                      private_key: :unset, 
+                      sandbox: :unset, 
+                      api_key: :unset, 
+                      secret: :unset
                     )
 
                         context.update(