io-complyance-unify-sdk 3.0.6 → 3.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 818b96f31985aa2454ff497c342713a313472d1ff935ce4ca2c05781e2610d62
-  data.tar.gz: ccf0aaa28e2663d52d1a33fbf9d04d904f3264f4996dd9293e3ff1e1a88e51c7
+  metadata.gz: 1a36d70d360c931f556c4f663b96e05cbdcb49095e133dff1d962e919ad2dd47
+  data.tar.gz: 41e452e7169f3fa28f0c6562ed249c2ac1b1da158ef4320fa32da35cd6c5fc9e
 SHA512:
-  metadata.gz: 65c672dc16899b2d2c7a282484bb791ea87e538fa49dd96bab3ea78eafb0a17058b0030e431a4c9aa58b1994547a51ad48b6ba8109879b6cb6c67ab42e8d79d6
-  data.tar.gz: 8268faa0b449277088cc7ebce3c0558f149a22cb76d36f5a3b545780b31fdb26773937f2c9c5bba5eb85113d4bd724cf6da1ea9317f70f166c8176c59a42e327
+  metadata.gz: 7f980700e30a8d070e326278fd42218517fddd1cb294d0c2eaededb3ba54aa2901eb36dc52dd06df9214f06888eadd4717e84520237de8d584216d81971d57ba
+  data.tar.gz: 3b1205f174b11a72a51d85a3192a7022ff5f79f30b68221d9c3c373f2a7212b477f585b2a279d6529ae7999542034736be749a8c9334308f59765cc53f905750

data/lib/complyance_sdk/config/sdk_config.rb

@@ -12,6 +12,9 @@ module ComplyanceSDK
       
       # Environment (sandbox, production)
       attr_accessor :environment
+
+      # Client/workspace ID for purchase invoice APIs
+      attr_accessor :client_id
       
       # Array of sources
       attr_accessor :sources
@@ -36,6 +39,7 @@ module ComplyanceSDK
       # @param options [Hash] Configuration options
       # @option options [String] :api_key API key for authentication
       # @option options [String, Symbol] :environment Environment (sandbox, production)
+      # @option options [String] :client_id Client/workspace ID for purchase invoice APIs
       # @option options [Array<ComplyanceSDK::Models::Source>] :sources Array of sources
       # @option options [ComplyanceSDK::Config::RetryConfig] :retry_config Retry configuration
       # @option options [Boolean] :logging_enabled Whether logging is enabled
@@ -43,6 +47,7 @@ module ComplyanceSDK
       def initialize(options = {})
         @api_key = options[:api_key]
         @environment = parse_environment(options[:environment])
+        @client_id = options[:client_id]
         @sources = options[:sources] || []
         @retry_config = options[:retry_config] || RetryConfig.default
         @logging_enabled = options.fetch(:logging_enabled, true)
@@ -75,6 +80,7 @@ module ComplyanceSDK
         new(
           api_key: ENV["COMPLYANCE_API_KEY"],
           environment: ENV["COMPLYANCE_ENVIRONMENT"],
+          client_id: ENV["COMPLYANCE_CLIENT_ID"],
           logging_enabled: ENV.fetch("COMPLYANCE_LOGGING_ENABLED", "true") == "true",
           log_level: ENV.fetch("COMPLYANCE_LOG_LEVEL", "info").to_sym
         )
@@ -99,6 +105,7 @@ module ComplyanceSDK
         new(
           api_key: config[:api_key],
           environment: config[:environment],
+          client_id: config[:client_id],
           logging_enabled: config.fetch(:logging_enabled, true),
           log_level: config.fetch(:log_level, :info).to_sym
         )

data/lib/complyance_sdk/http/client.rb

@@ -94,6 +94,17 @@ module ComplyanceSDK
         end
       end
 
+      def extract_error_message(parsed_body, fallback)
+        if parsed_body.is_a?(Hash)
+          parsed_body['message'] || parsed_body[:message] ||
+            parsed_body['error_msg'] || parsed_body[:error_msg] ||
+            parsed_body['error'] || parsed_body[:error] ||
+            fallback
+        else
+          fallback
+        end
+      end
+
       def build_connection
         base_url = ComplyanceSDK::Models::Environment.base_url(@config.environment)
         
@@ -146,21 +157,21 @@ module ComplyanceSDK
         when 200..299
           parsed_body || {}
         when 400..499
-          error_message = parsed_body&.dig('message') || parsed_body&.dig('error_msg') || response.reason_phrase
+          error_message = extract_error_message(parsed_body, response.reason_phrase)
           raise ComplyanceSDK::Exceptions::APIError.new(
             "Client error: #{error_message}",
             status_code: response.status,
             context: { response_body: parsed_body }
           )
         when 500..599
-          error_message = parsed_body&.dig('message') || parsed_body&.dig('error_msg') || response.reason_phrase
+          error_message = extract_error_message(parsed_body, response.reason_phrase)
           raise ComplyanceSDK::Exceptions::APIError.new(
             "Server error: #{error_message}",
             status_code: response.status,
             context: { response_body: parsed_body }
           )
         else
-          error_message = parsed_body&.dig('message') || parsed_body&.dig('error_msg') || "Unexpected response"
+          error_message = extract_error_message(parsed_body, "Unexpected response")
           raise ComplyanceSDK::Exceptions::APIError.new(
             "#{error_message}: #{response.status}",
             status_code: response.status,
@@ -220,4 +231,4 @@ module ComplyanceSDK
       end
     end
   end
-end
+end

data/lib/complyance_sdk/models/gets_document_type_v2.rb

@@ -85,6 +85,17 @@ module ComplyanceSDK
       CONSOLIDATED = GetsDocumentModifier::CONSOLIDATED
     end
 
+    module VARIANT
+      STANDARD = GetsDocumentVariant::STANDARD
+      ADVANCE = GetsDocumentVariant::ADVANCE
+      REFUND = GetsDocumentVariant::REFUND
+      PARTIAL = GetsDocumentVariant::PARTIAL
+      PARTIAL_CONSTRUCTION = GetsDocumentVariant::PARTIAL_CONSTRUCTION
+      PARTIAL_FINAL_CONSTRUCTION = GetsDocumentVariant::PARTIAL_FINAL_CONSTRUCTION
+      FINAL_CONSTRUCTION = GetsDocumentVariant::FINAL_CONSTRUCTION
+      CORRECTIVE = GetsDocumentVariant::CORRECTIVE
+    end
+
     class GetsDocumentTypeV2
       attr_accessor :base, :modifiers, :variant
 

data/lib/complyance_sdk/purchase_invoice/models.rb

@@ -0,0 +1,218 @@
+# frozen_string_literal: true
+
+module ComplyanceSDK
+  module PurchaseInvoice
+    module ModelHelpers
+      module_function
+
+      def value_for(hash, key)
+        return nil unless hash.is_a?(Hash)
+
+        hash[key] || hash[key.to_s] || hash[key.to_sym]
+      end
+    end
+
+    class PurchaseInvoiceArtifacts
+      attr_reader :invoice_xml_base64, :invoice_xml_encoding, :tdd_xml_base64
+
+      def initialize(invoice_xml_base64:, invoice_xml_encoding:, tdd_xml_base64:)
+        @invoice_xml_base64 = invoice_xml_base64
+        @invoice_xml_encoding = invoice_xml_encoding
+        @tdd_xml_base64 = tdd_xml_base64
+      end
+
+      def self.from_h(data)
+        return nil unless data.is_a?(Hash)
+
+        new(
+          invoice_xml_base64: ModelHelpers.value_for(data, :invoiceXmlBase64),
+          invoice_xml_encoding: ModelHelpers.value_for(data, :invoiceXmlEncoding),
+          tdd_xml_base64: ModelHelpers.value_for(data, :tddXmlBase64)
+        )
+      end
+    end
+
+    class PurchaseInvoiceGovernmentStatus
+      attr_reader :document_id, :country, :environment, :success, :error_code, :error_message, :timestamp, :status
+
+      def initialize(document_id:, country:, environment:, success:, error_code:, error_message:, timestamp:, status:)
+        @document_id = document_id
+        @country = country
+        @environment = environment
+        @success = success
+        @error_code = error_code
+        @error_message = error_message
+        @timestamp = timestamp
+        @status = status
+      end
+
+      def self.from_h(data)
+        return nil unless data.is_a?(Hash)
+
+        new(
+          document_id: ModelHelpers.value_for(data, :documentId),
+          country: ModelHelpers.value_for(data, :country),
+          environment: ModelHelpers.value_for(data, :environment),
+          success: ModelHelpers.value_for(data, :success),
+          error_code: ModelHelpers.value_for(data, :errorCode),
+          error_message: ModelHelpers.value_for(data, :errorMessage),
+          timestamp: ModelHelpers.value_for(data, :timestamp),
+          status: ModelHelpers.value_for(data, :status)
+        )
+      end
+    end
+
+    class PurchaseInvoiceCompliance
+      attr_reader :uuid, :fta_approved_status, :business_process_identifier, :specification_identifier
+
+      def initialize(uuid:, fta_approved_status:, business_process_identifier:, specification_identifier:)
+        @uuid = uuid
+        @fta_approved_status = fta_approved_status
+        @business_process_identifier = business_process_identifier
+        @specification_identifier = specification_identifier
+      end
+
+      def self.from_h(data)
+        return nil unless data.is_a?(Hash)
+
+        new(
+          uuid: ModelHelpers.value_for(data, :uuid),
+          fta_approved_status: ModelHelpers.value_for(data, :ftaApprovedStatus),
+          business_process_identifier: ModelHelpers.value_for(data, :businessProcessIdentifier),
+          specification_identifier: ModelHelpers.value_for(data, :specificationIdentifier)
+        )
+      end
+    end
+
+    class PurchaseInvoiceValidationErrorEntry
+      attr_reader :code, :message, :path, :source
+
+      def initialize(code:, message:, path:, source:)
+        @code = code
+        @message = message
+        @path = path || []
+        @source = source
+      end
+
+      def self.from_h(data)
+        return nil unless data.is_a?(Hash)
+
+        new(
+          code: ModelHelpers.value_for(data, :code),
+          message: ModelHelpers.value_for(data, :message),
+          path: ModelHelpers.value_for(data, :path) || [],
+          source: ModelHelpers.value_for(data, :source)
+        )
+      end
+    end
+
+    class PurchaseInvoiceValidationStep
+      attr_reader :name, :status, :error
+
+      def initialize(name:, status:, error:)
+        @name = name
+        @status = status
+        @error = error
+      end
+
+      def self.from_h(data)
+        return nil unless data.is_a?(Hash)
+
+        new(
+          name: ModelHelpers.value_for(data, :name),
+          status: ModelHelpers.value_for(data, :status),
+          error: ModelHelpers.value_for(data, :error)
+        )
+      end
+    end
+
+    class PurchaseInvoiceValidationResults
+      attr_reader :status, :validation_steps
+
+      def initialize(status:, validation_steps:)
+        @status = status
+        @validation_steps = validation_steps || []
+      end
+
+      def self.from_h(data)
+        return nil unless data.is_a?(Hash)
+
+        validation_steps = Array(ModelHelpers.value_for(data, :validationSteps)).filter_map do |step|
+          PurchaseInvoiceValidationStep.from_h(step)
+        end
+
+        new(
+          status: ModelHelpers.value_for(data, :status),
+          validation_steps: validation_steps
+        )
+      end
+    end
+
+    class PurchaseInvoiceResult
+      attr_reader :document_id,
+                  :client_id,
+                  :country,
+                  :environment,
+                  :document_number,
+                  :state,
+                  :is_terminal,
+                  :last_updated_at,
+                  :invoice,
+                  :xml,
+                  :xml_response,
+                  :artifacts,
+                  :government,
+                  :compliance,
+                  :errors,
+                  :validation_results
+
+      def initialize(document_id:, client_id:, country:, environment:, document_number:, state:, is_terminal:,
+                     last_updated_at:, invoice:, xml:, xml_response:, artifacts:, government:, compliance:,
+                     errors:, validation_results:)
+        @document_id = document_id
+        @client_id = client_id
+        @country = country
+        @environment = environment
+        @document_number = document_number
+        @state = state
+        @is_terminal = is_terminal
+        @last_updated_at = last_updated_at
+        @invoice = invoice
+        @xml = xml
+        @xml_response = xml_response
+        @artifacts = artifacts
+        @government = government
+        @compliance = compliance
+        @errors = errors || []
+        @validation_results = validation_results
+      end
+
+      def self.from_h(data)
+        return nil unless data.is_a?(Hash)
+
+        errors = Array(ModelHelpers.value_for(data, :errors)).filter_map do |entry|
+          PurchaseInvoiceValidationErrorEntry.from_h(entry)
+        end
+
+        new(
+          document_id: ModelHelpers.value_for(data, :documentId),
+          client_id: ModelHelpers.value_for(data, :clientId),
+          country: ModelHelpers.value_for(data, :country),
+          environment: ModelHelpers.value_for(data, :environment),
+          document_number: ModelHelpers.value_for(data, :documentNumber),
+          state: ModelHelpers.value_for(data, :state),
+          is_terminal: ModelHelpers.value_for(data, :isTerminal),
+          last_updated_at: ModelHelpers.value_for(data, :lastUpdatedAt),
+          invoice: ModelHelpers.value_for(data, :invoice),
+          xml: ModelHelpers.value_for(data, :xml),
+          xml_response: ModelHelpers.value_for(data, :xmlResponse),
+          artifacts: PurchaseInvoiceArtifacts.from_h(ModelHelpers.value_for(data, :artifacts)),
+          government: PurchaseInvoiceGovernmentStatus.from_h(ModelHelpers.value_for(data, :government)),
+          compliance: PurchaseInvoiceCompliance.from_h(ModelHelpers.value_for(data, :compliance)),
+          errors: errors,
+          validation_results: PurchaseInvoiceValidationResults.from_h(ModelHelpers.value_for(data, :validationResults))
+        )
+      end
+    end
+  end
+end

data/lib/complyance_sdk/retry/retry_manager.rb

@@ -24,7 +24,7 @@ module ComplyanceSDK
       # @yield The block to execute
       # @return The result of the block
       def execute(operation_name, context = {})
-        circuit_breaker = get_circuit_breaker(operation_name)
+        circuit_breaker = @config.retry_config&.circuit_breaker_enabled ? get_circuit_breaker(operation_name) : nil
         retry_strategy = RetryStrategy.new(@config.retry_config, circuit_breaker)
         
         retry_strategy.execute(context.merge(operation: operation_name)) do
@@ -98,11 +98,11 @@ module ComplyanceSDK
 
       def get_circuit_breaker(operation_name)
         @circuit_breakers[operation_name] ||= CircuitBreaker.new(
-          operation_name,
-          @config.retry_config,
-          @redis_config
+          failure_threshold: @config.retry_config.failure_threshold,
+          timeout_seconds: @config.retry_config.circuit_breaker_timeout.to_i,
+          success_threshold: 1
         )
       end
     end
   end
-end
+end

data/lib/complyance_sdk/retry/retry_strategy.rb

@@ -141,6 +141,9 @@ module ComplyanceSDK
       def should_retry?(error, attempt)
         return false if attempt >= @config.max_attempts
 
+        return true if retryable_error_class?(error)
+        return true if retryable_api_error?(error)
+
         error_detail = error.context
         return false unless error_detail
 
@@ -222,4 +225,4 @@ module ComplyanceSDK
       end
     end
   end
-end
+end

data/lib/complyance_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ComplyanceSDK
-  VERSION = "3.0.6"
+  VERSION = "3.0.7"
 end

data/lib/complyance_sdk.rb

@@ -22,10 +22,11 @@ require "complyance_sdk/exceptions/sdk_exception"
 require "complyance_sdk/exceptions/circuit_breaker_open_error"
 # require "complyance_sdk/middleware/rack_middleware" # Removed - not needed
 require "complyance_sdk/http/client"
-# require "complyance_sdk/retry/retry_manager" # Removed - not needed
+require "complyance_sdk/retry/retry_manager"
 require "complyance_sdk/retry/circuit_breaker"
 require "complyance_sdk/retry/retry_strategy"
 require "complyance_sdk/queue/persistent_queue_manager"
+require "complyance_sdk/purchase_invoice/models"
 require "openssl"
 require "uri"
 
@@ -108,7 +109,16 @@ module ComplyanceSDK
     # @param payload [Hash] The business data payload
     # @param destinations [Array, nil] Optional destinations (auto-generated if nil)
     # @return [ComplyanceSDK::Models::UnifyResponse] The response object
-    def push_to_unify(source_name, source_version, logical_doc_type, country, operation, mode, purpose, payload, destinations = nil)
+    def push_to_unify(*args)
+      if args.length == 1 && (args[0].is_a?(Hash) || args[0].is_a?(ComplyanceSDK::Models::UnifyRequest))
+        return push_to_unify_request(args[0])
+      end
+
+      if args.length < 8 || args.length > 9
+        raise ArgumentError, "wrong number of arguments (given #{args.length}, expected 1 or 8..9)"
+      end
+
+      source_name, source_version, logical_doc_type, country, operation, mode, purpose, payload, destinations = args
       push_to_unify_logical(source_name, source_version, logical_doc_type, country, operation, mode, purpose, payload, destinations)
     end
 
@@ -672,7 +682,7 @@ module ComplyanceSDK
     def list_purchase_invoices(filters = {})
       ensure_configured_for_purchase_api!
       query = { type: "purchases" }.merge(filters.reject { |_key, value| value.nil? })
-      http_client.get("/documents", query)
+      http_client.get("/api/v3/documents", query)
     end
 
     def get_purchase_invoice(id)
@@ -685,7 +695,19 @@ module ComplyanceSDK
         )
       end
 
-      http_client.get("/documents/#{URI.encode_www_form_component(id.to_s)}", { type: "purchases" })
+      response = http_client.get(
+        "/api/v3/documents/#{URI.encode_www_form_component(id.to_s)}?type=purchases",
+        {},
+        purchase_invoice_headers
+      )
+
+      payload = if response.is_a?(Hash)
+                  response[:data] || response['data'] || response
+                else
+                  response
+                end
+
+      ComplyanceSDK::PurchaseInvoice::PurchaseInvoiceResult.from_h(payload)
     end
 
     def verify_webhook_signature(payload, signature, secret, algorithm = "sha256")
@@ -718,6 +740,25 @@ module ComplyanceSDK
           "SDK must be configured before making API calls"
         )
       end
+
+      if configuration.client_id.to_s.strip.empty?
+        raise ComplyanceSDK::Exceptions::ConfigurationError.new(
+          "client_id is required for purchase invoice APIs",
+          suggestion: "Set client_id on SDKConfig or COMPLYANCE_CLIENT_ID in the environment."
+        )
+      end
+    end
+
+    def purchase_invoice_headers
+      {
+        "Authorization" => "Bearer #{configuration.api_key}",
+        "x-client-id" => configuration.client_id.to_s,
+        "x-api-key-environment" => purchase_invoice_api_environment
+      }
+    end
+
+    def purchase_invoice_api_environment
+      configuration.environment == ComplyanceSDK::Models::Environment::PRODUCTION ? "production" : "mock"
     end
 
     def secure_compare(left, right)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: io-complyance-unify-sdk
 version: !ruby/object:Gem::Version
-  version: 3.0.6
+  version: 3.0.7
 platform: ruby
 authors:
 - Complyance Team
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-05-02 00:00:00.000000000 Z
+date: 2026-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -282,6 +282,7 @@ files:
 - lib/complyance_sdk/models/source_ref.rb
 - lib/complyance_sdk/models/unify_request.rb
 - lib/complyance_sdk/models/unify_response.rb
+- lib/complyance_sdk/purchase_invoice/models.rb
 - lib/complyance_sdk/queue/persistent_queue_manager.rb
 - lib/complyance_sdk/railtie.rb
 - lib/complyance_sdk/retry/circuit_breaker.rb