plivo 4.62.5 → 4.63.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ab232d10176adbaaf1375e8d53cf04fc9cbca55c
-  data.tar.gz: b092be2a259e7dd451db35a742951c7291b47094
+SHA256:
+  metadata.gz: 3b904e37c728e7361a0e4ad43f9302fc39f09dea88d3ce0c7c7c763b29282f5f
+  data.tar.gz: 3df71c5a41b9d3396398046c926cb324013aa8a7046976b6c44b6f4c9bfd1431
 SHA512:
-  metadata.gz: d7c2b0e1b7fd3b27ec9634187f5fdafb5b7ede1b11531901b9ba23de9024c0da81c668bddc3897d6c7202ea2065814d809077b83f541e69887e783f66d145022
-  data.tar.gz: 3c6b3aea56c356103037991df5815d9d12424929ba93a9ef1639c7328ec6d7852961c85c3402260a60b10505a2a6f8d3ea38244a2706c47f54efe9997222fc6d
+  metadata.gz: 8878f8bf2f322bbb1640ca403c917864970c9a014675a84a2492f652a855697ab98da486c7b85e70886f075b1a604e143decf8f67e04eb356db42a85ed9b1054
+  data.tar.gz: 42f4fe995b8c9d4a054cca33330bdc214e4ba4e2c5b2e91cf4a40e990c8cd50aeb46c3a9ad07201b8125f637d8306e44cab570a05682c5bf58f62294c89f25d2

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # Change Log
 
+## [4.63.1](https://github.com/plivo/plivo-ruby/tree/v4.63.1) (2026-04-16)
+**Bug Fix - PhoneNumber Compliance API response mapping**
+- Fixed GET single compliance to unwrap `compliance` wrapper key from API response, making all fields directly accessible on the resource object
+- Fixed List response to remap `compliances` key to `objects` for base class compatibility, returning proper `PhoneNumberCompliance` resource instances
+- Fixed update() to unwrap `compliance` wrapper key from API response, returning the compliance object directly
+
+## [4.63.0](https://github.com/plivo/plivo-ruby/tree/v4.63.0) (2026-04-08)
+**Feature - PhoneNumber Compliance API support**
+- Added `phone_number_compliance_requirements` resource for discovering compliance requirements by country, number type, and user type
+- Added `phone_number_compliances` resource with full CRUD support (create, get, list, update, delete) for compliance applications
+- Added `phone_number_compliance_link` resource for bulk linking phone numbers to accepted compliance applications
+- Added PATCH HTTP method support to `base_client` for compliance application updates
+- Create and update operations support multipart file uploads for compliance documents
+
 ## [4.62.5](https://github.com/plivo/plivo-ruby/tree/v4.62.5) (2026-01-21)
 **Feature - HA Number support**
 - Added `ha_enable` optional parameter to PhoneNumber `buy` method

data/lib/plivo/base_client.rb

@@ -47,6 +47,7 @@ module Plivo
         response = case method
                    when 'GET' then send_get(resource_path, data, timeout, is_voice_request: options[:is_voice_request], voice_retry_count: @@voice_retry_count)
                    when 'POST' then send_post(resource_path, data, timeout, use_multipart_conn, is_voice_request: options[:is_voice_request], voice_retry_count: @@voice_retry_count)
+                   when 'PATCH' then send_patch(resource_path, data, timeout, use_multipart_conn, is_voice_request: options[:is_voice_request], voice_retry_count: @@voice_retry_count)
                    when 'DELETE' then send_delete(resource_path, data, timeout, is_voice_request: options[:is_voice_request], voice_retry_count: @@voice_retry_count)
                    else raise_invalid_request("#{method} not supported by Plivo, yet")
                    end
@@ -64,6 +65,7 @@ module Plivo
       elsif options[:is_lookup_request] == true
         response = case method
                    when 'GET' then send_get(resource_path, data, timeout, is_lookup_request: options[:is_lookup_request])
+                   when 'PATCH' then send_patch(resource_path, data, timeout, use_multipart_conn, is_lookup_request: options[:is_lookup_request])
                    else raise_invalid_request("#{method} not supported by Plivo, yet")
                    end
         process_response(method, response.to_hash)
@@ -71,6 +73,7 @@ module Plivo
         response = case method
                    when 'GET' then send_get(resource_path, data, timeout)
                    when 'POST' then send_post(resource_path, data, timeout, use_multipart_conn)
+                   when 'PATCH' then send_patch(resource_path, data, timeout, use_multipart_conn)
                    when 'DELETE' then send_delete(resource_path, data, timeout)
                    else raise_invalid_request("#{method} not supported by Plivo, yet")
                    end
@@ -311,6 +314,41 @@ module Plivo
       response
     end
 
+    def send_patch(resource_path, data, timeout, use_multipart_conn, options = nil)
+      if use_multipart_conn
+        multipart_conn = Faraday.new(@base_uri) do |faraday|
+          faraday.headers = {
+              'User-Agent' => @headers['User-Agent'],
+              'Accept' => @headers['Accept']
+          }
+
+          # DANGER: Basic auth should always come after headers, else
+          # The headers will replace the basic_auth
+
+          faraday.request :multipart
+          faraday.request :url_encoded
+          faraday.headers['Authorization'] = "Basic #{Base64.strict_encode64("#{auth_id}:#{auth_token}")}"
+
+          faraday.proxy=@proxy_hash if @proxy_hash
+          faraday.response :json, content_type: /\bjson$/
+          faraday.adapter Faraday.default_adapter
+        end
+
+        response = multipart_conn.patch do |req|
+          req.url resource_path
+          req.options.timeout = timeout if timeout
+          req.body = data
+        end
+      else
+        response = @conn.patch do |req|
+          req.url resource_path
+          req.options.timeout = timeout if timeout
+          req.body = JSON.generate(data) if data
+        end
+      end
+      response
+    end
+
     def send_delete(resource_path, data, timeout, options = nil)
       if options
         if options[:voice_retry_count] == 0 and options[:is_voice_request] == true

data/lib/plivo/resources/phone_number_compliance.rb

@@ -0,0 +1,260 @@
+module Plivo
+  module Resources
+    include Plivo::Utils
+
+    class PhoneNumberComplianceRequirement < Base::Resource
+      def initialize(client, options = nil)
+        @_name = 'PhoneNumber/Compliance/Requirements'
+        @_identifier_string = 'requirement_id'
+        super
+      end
+
+      def to_s
+        {
+          api_id: @api_id,
+          requirement_id: @requirement_id,
+          country_iso: @country_iso,
+          number_type: @number_type,
+          user_type: @user_type,
+          document_types: @document_types
+        }.delete_if { |key, value| value.nil? }.to_s
+      end
+    end
+
+    class PhoneNumberComplianceRequirementsInterface < Base::ResourceInterface
+      def initialize(client, resource_list_json = nil)
+        @_name = 'PhoneNumber/Compliance/Requirements'
+        @_resource_type = PhoneNumberComplianceRequirement
+        @_identifier_string = 'requirement_id'
+        super
+      end
+
+      ##
+      # Get phone number compliance requirements
+      # @param [Hash] options
+      # @option options [String] :country_iso
+      # @option options [String] :number_type
+      # @option options [String] :user_type
+      # @return [PhoneNumberComplianceRequirement]
+      def get(options = nil)
+        params = {}
+        if options
+          valid_param?(:options, options, Hash, true)
+          %i[country_iso number_type user_type].each do |param|
+            if options.key?(param) &&
+               valid_param?(param, options[param], [String, Symbol], false)
+              params[param] = options[param]
+            end
+          end
+        end
+        perform_get_without_identifier(params)
+      end
+    end
+
+    class PhoneNumberCompliance < Base::Resource
+      def initialize(client, options = nil)
+        @_name = 'PhoneNumber/Compliance'
+        @_identifier_string = 'compliance_id'
+        super
+      end
+
+      def update(params)
+        unless @id
+          raise_invalid_request("Cannot update a #{@_name} resource "\
+                                  'without an identifier')
+        end
+
+        response_json = @_client.send_request(@_resource_uri, 'PATCH', params, nil, true, is_voice_request: false)
+
+        # Unwrap compliance wrapper if present (API returns {api_id, message, compliance: {...}})
+        compliance_data = response_json['compliance'] || response_json
+        compliance_data['api_id'] = response_json['api_id'] if response_json['api_id']
+        # Include message from response so callers can access update status via resp.message
+        compliance_data['message'] = response_json['message'] if response_json['message']
+        parse_and_set(compliance_data)
+        self
+      end
+
+      def delete
+        perform_delete
+      end
+
+      def to_s
+        {
+          api_id: @api_id,
+          compliance_id: @compliance_id,
+          alias: @alias,
+          status: @status,
+          country_iso: @country_iso,
+          number_type: @number_type,
+          user_type: @user_type,
+          created_at: @created_at,
+          updated_at: @updated_at
+        }.delete_if { |key, value| value.nil? }.to_s
+      end
+    end
+
+    class PhoneNumberCompliancesInterface < Base::ResourceInterface
+      def initialize(client, resource_list_json = nil)
+        @_name = 'PhoneNumber/Compliance'
+        @_resource_type = PhoneNumberCompliance
+        @_identifier_string = 'compliance_id'
+        super
+      end
+
+      ##
+      # Create a phone number compliance application
+      # @param [Hash] data_hash - compliance data (country_iso, number_type, alias, end_user, documents, etc.)
+      # @param [Array] documents - list of local file paths for document uploads (optional)
+      # @return [Response]
+      def create(data_hash, documents = nil)
+        params = { data: JSON.generate(data_hash) }
+        if documents
+          documents.each_with_index do |filepath, index|
+            file_extension = filepath.split('.')[-1]
+            content_type = case file_extension
+                           when 'jpeg', 'jpg' then 'image/jpeg'
+                           when 'png' then 'image/png'
+                           when 'pdf' then 'application/pdf'
+                           else raise_invalid_request("#{file_extension} is not supported")
+                           end
+            params["documents[#{index}].file"] = Faraday::UploadIO.new(filepath, content_type)
+          end
+        end
+        perform_create(params, true)
+      end
+
+      ##
+      # Get a phone number compliance application
+      # @param [String] compliance_id
+      # @param [Hash] options
+      # @option options [String] :expand
+      # @return [PhoneNumberCompliance]
+      def get(compliance_id, options = nil)
+        valid_param?(:compliance_id, compliance_id, [String, Symbol], true)
+        params = {}
+        if options
+          valid_param?(:options, options, Hash, true)
+          if options.key?(:expand) &&
+             valid_param?(:expand, options[:expand], [String, Symbol], false)
+            params[:expand] = options[:expand]
+          end
+        end
+        response_json = @_client.send_request(@_resource_uri + compliance_id.to_s + '/', 'GET', params, nil, false, is_voice_request: false)
+        # Extract the compliance wrapper returned by the API
+        compliance_data = response_json['compliance'] || response_json
+        compliance_data['api_id'] = response_json['api_id'] if response_json['api_id']
+        @_resource_type.new(@_client, resource_json: compliance_data)
+      end
+
+      ##
+      # List phone number compliance applications
+      # @param [Hash] options
+      # @option options [Int] :limit
+      # @option options [Int] :offset
+      # @option options [String] :status
+      # @option options [String] :country_iso
+      # @option options [String] :number_type
+      # @option options [String] :user_type
+      # @option options [String] :alias
+      # @option options [String] :expand
+      # @return [Hash]
+      def list(options = nil)
+        params = {}
+        if options
+          valid_param?(:options, options, Hash, true)
+
+          %i[status country_iso number_type user_type alias expand].each do |param|
+            if options.key?(param) &&
+               valid_param?(param, options[param], [String, Symbol], false)
+              params[param] = options[param]
+            end
+          end
+
+          %i[offset limit].each do |param|
+            if options.key?(param) && valid_param?(param, options[param],
+                                                   [Integer], false)
+              params[param] = options[param]
+            end
+          end
+
+          raise_invalid_request("Offset can't be negative") if options.key?(:offset) && options[:offset] < 0
+
+          if options.key?(:limit) && (options[:limit] > 20 || options[:limit] <= 0)
+            raise_invalid_request('The maximum number of results that can be '\
+            "fetched is 20. limit can't be more than 20 or less than 1")
+          end
+        end
+
+        response_json = @_client.send_request(@_resource_uri, 'GET', params, nil, false, is_voice_request: false)
+
+        # Remap 'compliances' to 'objects' for base class compatibility
+        if response_json.key?('compliances')
+          response_json['objects'] = response_json.delete('compliances')
+        end
+
+        parse_and_set(response_json)
+        {
+          api_id: @api_id,
+          meta: @_meta,
+          objects: @_resource_list
+        }
+      end
+
+      ##
+      # Update a phone number compliance application
+      # @param [String] compliance_id
+      # @param [Hash] data_hash - compliance data to update
+      # @param [Array] documents - list of local file paths for document uploads (optional)
+      # @return [PhoneNumberCompliance]
+      def update(compliance_id, data_hash, documents = nil)
+        valid_param?(:compliance_id, compliance_id, [String, Symbol], true)
+
+        params = { data: JSON.generate(data_hash) }
+        if documents
+          documents.each_with_index do |filepath, index|
+            file_extension = filepath.split('.')[-1]
+            content_type = case file_extension
+                           when 'jpeg', 'jpg' then 'image/jpeg'
+                           when 'png' then 'image/png'
+                           when 'pdf' then 'application/pdf'
+                           else raise_invalid_request("#{file_extension} is not supported")
+                           end
+            params["documents[#{index}].file"] = Faraday::UploadIO.new(filepath, content_type)
+          end
+        end
+
+        PhoneNumberCompliance.new(@_client,
+                        resource_id: compliance_id).update(params)
+      end
+
+      ##
+      # Delete a phone number compliance application
+      # @param [String] compliance_id
+      def delete(compliance_id)
+        valid_param?(:compliance_id, compliance_id, [String, Symbol], true)
+        PhoneNumberCompliance.new(@_client,
+                        resource_id: compliance_id).delete
+      end
+    end
+
+    class PhoneNumberComplianceLinkInterface < Base::ResourceInterface
+      def initialize(client, resource_list_json = nil)
+        @_name = 'PhoneNumber/Compliance/Link'
+        @_resource_type = PhoneNumberCompliance
+        @_identifier_string = 'compliance_id'
+        super
+      end
+
+      ##
+      # Link numbers to compliance applications
+      # @param [Array] numbers - list of hashes with 'number' and 'compliance_application_id'
+      # @return [Response]
+      def create(numbers)
+        valid_param?(:numbers, numbers, Array, true)
+        params = { numbers: numbers }
+        perform_create(params)
+      end
+    end
+  end
+end

data/lib/plivo/resources.rb

@@ -22,6 +22,7 @@ require_relative 'resources/campaign'
 require_relative 'resources/profile'
 require_relative 'resources/lookup'
 require_relative 'resources/regulatory_compliance'
+require_relative 'resources/phone_number_compliance'
 require_relative 'resources/multipartycalls'
 require_relative 'resources/verify_session'
 require_relative 'resources/tollfree_verification'

data/lib/plivo/rest_client.rb

@@ -22,6 +22,7 @@ module Plivo
     attr_reader :tollfree_verifications
     attr_reader :verify_caller_id
     attr_reader :maskingsession
+    attr_reader :phone_number_compliance_requirements, :phone_number_compliances, :phone_number_compliance_link
 
     def initialize(auth_id = nil, auth_token = nil, proxy_options = nil, timeout = 5)
       configure_base_uri
@@ -69,6 +70,9 @@ module Plivo
       @compliance_documents = Resources::ComplianceDocumentsInterface.new(self)
       @compliance_requirements = Resources::ComplianceRequirementsInterface.new(self)
       @compliance_applications = Resources::ComplianceApplicationsInterface.new(self)
+      @phone_number_compliance_requirements = Resources::PhoneNumberComplianceRequirementsInterface.new(self)
+      @phone_number_compliances = Resources::PhoneNumberCompliancesInterface.new(self)
+      @phone_number_compliance_link = Resources::PhoneNumberComplianceLinkInterface.new(self)
       @verify_session = Resources::SessionInterface.new(self)
       @tollfree_verifications = Resources::TollfreeVerificationsInterface.new(self)
       @verify_caller_id = Resources::VerifyCallerIdInterface.new(self)

data/lib/plivo/version.rb

@@ -1,3 +1,3 @@
 module Plivo
-  VERSION = "4.62.5".freeze
+  VERSION = "4.63.1".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plivo
 version: !ruby/object:Gem::Version
-  version: 4.62.5
+  version: 4.63.1
 platform: ruby
 authors:
 - The Plivo SDKs Team
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-21 00:00:00.000000000 Z
+date: 2026-04-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -190,6 +190,7 @@ files:
 - lib/plivo/resources/numbers.rb
 - lib/plivo/resources/phlo_member.rb
 - lib/plivo/resources/phlos.rb
+- lib/plivo/resources/phone_number_compliance.rb
 - lib/plivo/resources/powerpacks.rb
 - lib/plivo/resources/pricings.rb
 - lib/plivo/resources/profile.rb
@@ -241,7 +242,7 @@ homepage: https://github.com/plivo/plivo-ruby
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -256,9 +257,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.4
-signing_key: 
+rubygems_version: 3.4.19
+signing_key:
 specification_version: 4
 summary: A Ruby SDK to make voice calls & send SMS using Plivo and to generate Plivo
   XML