metrifox-sdk 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f814153e75795c0d87de3d15f3164f73fc6a561be992a209900880d2b8461406
-  data.tar.gz: 5329b40387f7555df0895e7889f0e5f63b52b854571d34816627d159340bccd5
+  metadata.gz: 61978214945170e21af55446d8aa5606a14710fa5515cdd327d11227b5f95a22
+  data.tar.gz: cc96ae1ea46452d1d1221b936048bb9ad8931bd93317c727352272f08ad796a6
 SHA512:
-  metadata.gz: 0efde0b9967198c7f0631b7bd35343f00fa94c56d8cfde2696eb7b6f4405ca6995adb82776f5ea516a6f5e40d132ff1023690e4c0526560ad429879a1dfc605a
-  data.tar.gz: 7c14771a87ad8032448a53d38b20e3ed94fb423c4b674897c9263408cc4693fcfd7033931c1ac66e53c0c962dda0f92f29841aa8b9a35065a1512fd496aa11b1
+  metadata.gz: b31ffd58d394c50d65fd22b339f939dcbfa8ae31bb716cce31c759cd1ad9ab584746f1476e1e376541e6ac27539e4abed0b3aca665f6607136a594226881f2bf
+  data.tar.gz: b7e0c2167befb2befc63e50b4cef0b940c0a4f81890933f2100937fe458a3c3a626451d7b4fc103f1f649cc7b6cac83ff79ed74c5fee21b023a5692479256d59

data/README.md

@@ -7,7 +7,7 @@ A Ruby SDK for interacting with the Metrifox platform API.
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'metrifox_sdk'
+gem 'metrifox-sdk'
 ```
 
 And then execute:
@@ -19,7 +19,7 @@ $ bundle install
 Or install it yourself as:
 
 ```bash
-$ gem install metrifox_sdk
+$ gem install metrifox-sdk
 ```
 
 ## Usage
@@ -27,25 +27,21 @@ $ gem install metrifox_sdk
 ### Configuration
 
 ```ruby
-require 'metrifox_sdk'
+require 'metrifox-sdk'
 
 # Initialize with configuration
-MetrifoxSDK.init({
-  api_key: "your-api-key",
-  base_url: "https://metrifox-api.staging.useyala.com/api/v1/",
-  web_app_base_url: "https://frontend-v3.staging.useyala.com"
-})
+METRIFOX_SDK = MetrifoxSDK.init({ api_key: "your-api-key"})
 
 # Or set environment variable
 ENV["METRIFOX_API_KEY"] = "your-api-key"
-MetrifoxSDK.init
+METRIFOX_SDK = MetrifoxSDK.init
 ```
 
 ### Access Control
 
 ```ruby
 # Check feature access
-response = MetrifoxSDK.usages.check_access({
+response = METRIFOX_SDK.usages.check_access({
   feature_key: "premium_feature",
   customer_key: "customer_123"
 })
@@ -56,64 +52,146 @@ puts response["can_access"] # true/false
 ### Usage Tracking
 
 ```ruby
-# Record usage event
-response = MetrifoxSDK.usages.record_usage({
+# Basic usage recording
+response = METRIFOX_SDK.usages.record_usage({
   customer_key: "customer_123",
   event_name: "api_call",
   amount: 1
 })
+
+# Advanced usage recording with additional fields
+response = METRIFOX_SDK.usages.record_usage({
+  customer_key: "customer_123",
+  event_name: "api_call",
+  amount: 1,
+  credit_used: 5,
+  event_id: "event_uuid_123",
+  timestamp: 1640995200,
+  metadata: {
+    source: "web_app",
+    feature: "premium_search"
+  }
+})
+
+# Using structured request object
+usage_request = MetrifoxSDK::Types::UsageEventRequest.new(
+  customer_key: "customer_123",
+  event_name: "api_call",
+  amount: 1,
+  credit_used: 5,
+  event_id: "event_uuid_123",
+  timestamp: Time.now.to_i,
+  metadata: { source: "mobile_app" }
+)
+
+response = METRIFOX_SDK.usages.record_usage(usage_request)
 ```
 
 ### Customer Management
 
 ```ruby
-# Create customer
+# Create customer (customer_key is REQUIRED)
 customer_data = {
-  customer_key: "customer_123",
+  customer_key: "customer_123",  # Required - unique identifier for the customer
   customer_type: "BUSINESS",
   primary_email: "customer@example.com",
   legal_name: "Acme Corp",
   display_name: "ACME"
 }
 
-response = MetrifoxSDK.customers.create(customer_data)
+response = METRIFOX_SDK.customers.create(customer_data)
 
-# Update customer
+# Update customer (customer_key cannot be changed and is passed as a parameter)
 update_data = {
   display_name: "ACME Corporation",
   website_url: "https://acme.com"
+  # Note: customer_key is NOT included here - it's immutable
 }
 
-response = MetrifoxSDK.customers.update("customer_123", update_data)
+response = METRIFOX_SDK.customers.update("customer_123", update_data)
 
 # Get customer
-response = MetrifoxSDK.customers.get_customer({ customer_key: "customer_123" })
+response = METRIFOX_SDK.customers.get_customer({ customer_key: "customer_123" })
 
 # Get customer details
-response = MetrifoxSDK.customers.get_details({ customer_key: "customer_123" })
+response = METRIFOX_SDK.customers.get_details({ customer_key: "customer_123" })
+
+# Check for an active subscription
+has_active_subscription = MetrifoxSDK.customers.has_active_subscription?(customer_key: "customer_123")
+puts has_active_subscription # true or false
+
+# List customers
+response = METRIFOX_SDK.customers.list
+
+# List customers with pagination
+response = METRIFOX_SDK.customers.list({ page: 2, per_page: 10 })
+
+# List customers with filters
+response = METRIFOX_SDK.customers.list({ 
+  search_term: "TechStart",
+  customer_type: "BUSINESS",
+  date_created: "2025-09-01"
+})
+
+# List customers with combined pagination and filters
+response = METRIFOX_SDK.customers.list({ 
+  page: 1,
+  per_page: 5,
+  search_term: "John",
+  customer_type: "INDIVIDUAL"
+})
 
 # Delete customer
-response = MetrifoxSDK.delete_customer({ customer_key: "customer_123" })
+response = METRIFOX_SDK.customers.delete_customer({ customer_key: "customer_123" })
+
 ```
 
 ### CSV Upload
 
 ```ruby
 # Upload customers via CSV
-response = MetrifoxSDK.customers.upload_csv("/path/to/customers.csv")
+response = METRIFOX_SDK.customers.upload_csv("/path/to/customers.csv")
 
 puts response["data"]["total_customers"]
 puts response["data"]["successful_upload_count"]
 ```
 
-### Using Client Instance
+### Checkout URL Generation
 
 ```ruby
-client = MetrifoxSDK::Client.new({
-  api_key: "your-api-key"
+# Basic checkout URL generation
+checkout_url = METRIFOX_SDK.checkout.url({
+  offering_key: "your_offering_key"
+})
+
+# With optional billing interval
+checkout_url = METRIFOX_SDK.checkout.url({
+  offering_key: "your_offering_key",
+  billing_interval: "monthly"
+})
+
+# With customer key for pre-filled checkout
+checkout_url = METRIFOX_SDK.checkout.url({
+  offering_key: "your_offering_key",
+  billing_interval: "monthly",
+  customer_key: "customer_123"
 })
 
-response = client.usages.check_access({
+# Using structured config object
+checkout_config = MetrifoxSDK::Types::CheckoutConfig.new(
+  offering_key: "your_offering_key",
+  billing_interval: "monthly",
+  customer_key: "customer_123"
+)
+
+checkout_url = METRIFOX_SDK.checkout.url(checkout_config)
+```
+
+### Using Client Instance
+
+```ruby
+
+response = METRIFOX_SDK.usages.check_access({
   feature_key: "premium_feature",
   customer_key: "customer_123"
 })
@@ -130,24 +208,33 @@ access_request = MetrifoxSDK::Types::AccessCheckRequest.new(
   customer_key: "customer_123"
 )
 
-response = MetrifoxSDK.usages.check_access(access_request)
+response = METRIFOX_SDK.usages.check_access(access_request)
 
-# Customer creation with structured data
+# Customer creation with structured data (customer_key is REQUIRED)
 customer_request = MetrifoxSDK::Types::CustomerCreateRequest.new(
-  customer_key: "customer_123",
+  customer_key: "customer_123",  # Required
   customer_type: MetrifoxSDK::Types::CustomerType::BUSINESS,
   primary_email: "customer@example.com",
   legal_name: "Acme Corp"
 )
 
-response = MetrifoxSDK.customers.create(customer_request)
+response = METRIFOX_SDK.customers.create(customer_request)
+
+# Customer update with structured data (customer_key is immutable)
+customer_update = MetrifoxSDK::Types::CustomerUpdateRequest.new(
+  display_name: "Acme Corporation",
+  website_url: "https://acme.com"
+  # Note: customer_key is NOT a field in CustomerUpdateRequest
+)
+
+response = METRIFOX_SDK.customers.update("customer_123", customer_update)
 ```
 
 ## Error Handling
 
 ```ruby
 begin
-  response = MetrifoxSDK.usages.check_access({
+  response = METRIFOX_SDK.usages.check_access({
     feature_key: "premium_feature",
     customer_key: "customer_123"
   })
@@ -168,4 +255,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/yourus
 
 ## License
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/metrifox-sdk.rb

@@ -4,8 +4,11 @@ require_relative "metrifox_sdk/types"
 require_relative "metrifox_sdk/util_methods"
 require_relative "metrifox_sdk/base_api"
 require_relative "metrifox_sdk/base_module"
+require_relative "metrifox_sdk/customers/api"
 require_relative "metrifox_sdk/customers/module"
 require_relative "metrifox_sdk/usages/module"
+require_relative "metrifox_sdk/checkout/api"
+require_relative "metrifox_sdk/checkout/module"
 
 module MetrifoxSDK
   class << self

data/lib/metrifox_sdk/checkout/api.rb

@@ -0,0 +1,23 @@
+require "net/http"
+require "uri"
+require "json"
+require_relative "../base_api"
+
+module MetrifoxSDK::Checkout
+  class API < MetrifoxSDK::BaseApi
+    def fetch_checkout_key(base_url, api_key)
+      uri = URI.join(base_url, "auth/checkout-username")
+      response = make_request(uri, "GET", api_key)
+      data = parse_response(response, "Failed to get tenant checkout settings")
+      data.dig("data", "checkout_username")
+    end
+
+    def generate_checkout_url(base_url, api_key, query_params)
+      uri = URI.join(base_url, "products/offerings/generate-checkout-url")
+      uri.query = URI.encode_www_form(query_params)
+      response = make_request(uri, "GET", api_key)
+      data = parse_response(response, "Failed to generate checkout URL")
+      data.dig("data", "checkout_url")
+    end
+  end
+end

data/lib/metrifox_sdk/checkout/module.rb

@@ -0,0 +1,55 @@
+require_relative "api"
+require_relative "../base_module"
+
+module MetrifoxSDK
+  module Checkout
+    class Module < BaseModule
+      def url(config)
+        validate_api_key!
+
+        # Handle both hash and struct access patterns
+        offering_key = get_value(config, :offering_key)
+        billing_interval = get_value(config, :billing_interval)
+        customer_key = get_value(config, :customer_key)
+
+        raise ArgumentError, "offering_key is required" if offering_key.nil? || offering_key.empty?
+
+        # Build query parameters
+        query_params = { offering_key: offering_key }
+        query_params[:billing_interval] = billing_interval if billing_interval && !billing_interval.empty?
+        query_params[:customer_key] = customer_key if customer_key && !customer_key.empty?
+
+        # Call API to generate checkout URL
+        checkout_url = api.generate_checkout_url(base_url, api_key, query_params)
+        raise StandardError, "Checkout URL could not be generated" if checkout_url.nil? || checkout_url.empty?
+
+        checkout_url
+      end
+
+      private
+
+      def get_checkout_key
+        api.fetch_checkout_key(base_url, api_key)
+      end
+
+      def web_app_base_url
+        @client.web_app_base_url
+      end
+
+      def api
+        @api ||= API.new
+      end
+
+      # Helper method to get value from either hash or struct
+      def get_value(object, key)
+        if object.respond_to?(key)
+          object.public_send(key)
+        elsif object.respond_to?(:[])
+          object[key] || object[key.to_s]
+        else
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/metrifox_sdk/client.rb

@@ -21,6 +21,10 @@ module MetrifoxSDK
       @usages ||= Usages::Module.new(self)
     end
 
+    def checkout
+      @checkout ||= Checkout::Module.new(self)
+    end
+
     private
 
     def get_api_key_from_environment

data/lib/metrifox_sdk/customers/api.rb

@@ -41,6 +41,25 @@ module MetrifoxSDK::Customers
       parse_response(response, "Failed to Fetch Customer Details")
     end
 
+    def customer_active_subscription_request(base_url, api_key, customer_key)
+      uri = URI.join(base_url, "customers/#{customer_key}/check-active-subscription")
+      response = make_request(uri, "GET", api_key)
+      parse_response(response, "Failed to Check Active Subscription")
+    end
+
+    def customer_list_request(base_url, api_key, request_payload = {})
+      uri = URI.join(base_url, "customers")
+      
+      # Build query parameters from the request payload
+      query_params = build_query_params(request_payload)
+      if query_params && !query_params.empty?
+        uri.query = URI.encode_www_form(query_params)
+      end
+      
+      response = make_request(uri, "GET", api_key)
+      parse_response(response, "Failed to Fetch Customers")
+    end
+
     def upload_customers_csv(base_url, api_key, file_path)
       uri = URI.join(base_url, "customers/csv-upload")
 
@@ -68,6 +87,24 @@ module MetrifoxSDK::Customers
       end
     end
 
+    # Helper method to build query parameters for list requests
+    def build_query_params(request_payload)
+      return {} unless request_payload
+
+      params = {}
+      
+      # Handle pagination parameters
+      params[:page] = get_value(request_payload, :page) if get_value(request_payload, :page)
+      params[:per_page] = get_value(request_payload, :per_page) if get_value(request_payload, :per_page)
+      
+      # Handle filter parameters
+      params[:search_term] = get_value(request_payload, :search_term) if get_value(request_payload, :search_term)
+      params[:customer_type] = get_value(request_payload, :customer_type) if get_value(request_payload, :customer_type)
+      params[:date_created] = get_value(request_payload, :date_created) if get_value(request_payload, :date_created)
+      
+      params.compact
+    end
+
     # Helper method to get value from either hash or struct
     def get_value(object, key)
       if object.respond_to?(key)
@@ -79,4 +116,4 @@ module MetrifoxSDK::Customers
       end
     end
   end
-end
+end

data/lib/metrifox_sdk/customers/module.rb

@@ -19,16 +19,36 @@ module MetrifoxSDK
         api.customer_get_request(base_url, api_key, request_payload)
       end
 
+      def get(request_payload)
+        get_customer(request_payload)
+      end
+
       def get_details(request_payload)
         validate_api_key!
         api.customer_details_get_request(base_url, api_key, request_payload)
       end
 
+      def has_active_subscription?(customer_key:)
+        validate_api_key!
+        result = api.customer_active_subscription_request(base_url, api_key, customer_key)
+        data = result["data"] || {}
+        data["has_active_subscription"]
+      end
+
       def delete_customer(request_payload)
         validate_api_key!
         api.customer_delete_request(base_url, api_key, request_payload)
       end
 
+      def delete(request_payload)
+        delete_customer(request_payload)
+      end
+
+      def list(request_payload = {})
+        validate_api_key!
+        api.customer_list_request(base_url, api_key, request_payload)
+      end
+
       def upload_csv(file_path)
         validate_api_key!
         api.upload_customers_csv(base_url, api_key, file_path)
@@ -41,4 +61,4 @@ module MetrifoxSDK
       end
     end
   end
-end
+end

data/lib/metrifox_sdk/types.rb

@@ -44,8 +44,11 @@ module MetrifoxSDK
       :carryover_quantity, :balance, keyword_init: true
     )
 
-    UsageEventRequest = Struct.new(:customer_key, :event_name, :amount, keyword_init: true) do
-      def initialize(customer_key:, event_name:, amount: 1)
+    UsageEventRequest = Struct.new(
+      :customer_key, :event_name, :amount, :credit_used, :event_id, :timestamp, :metadata,
+      keyword_init: true
+    ) do
+      def initialize(customer_key:, event_name:, amount: 1, credit_used: nil, event_id: nil, timestamp: nil, metadata: {})
         super
       end
     end
@@ -53,7 +56,7 @@ module MetrifoxSDK
     UsageEventResponse = Struct.new(:message, :event_name, :customer_key, keyword_init: true)
 
     CustomerCreateRequest = Struct.new(
-      # Core fields
+      # Core fields (customer_key is REQUIRED)
       :customer_key, :customer_type, :primary_email, :primary_phone,
       # Business fields
       :legal_name, :display_name, :legal_number, :tax_identification_number,
@@ -73,8 +76,8 @@ module MetrifoxSDK
     )
 
     CustomerUpdateRequest = Struct.new(
-      # Core fields
-      :customer_key, :customer_type, :primary_email, :primary_phone, :billing_email,
+      # Core fields (customer_key is NOT included - it's immutable and passed as a parameter)
+      :customer_type, :primary_email, :primary_phone, :billing_email,
       # Business fields
       :legal_name, :display_name, :legal_number, :tax_identification_number,
       :logo_url, :website_url, :account_manager,
@@ -107,5 +110,6 @@ module MetrifoxSDK
     APIResponse = Struct.new(:status_code, :message, :data, :errors, :meta, keyword_init: true)
 
     EmbedConfig = Struct.new(:container, :product_key, keyword_init: true)
+    CheckoutConfig = Struct.new(:offering_key, :billing_interval, :customer_key, keyword_init: true)
   end
 end

data/lib/metrifox_sdk/usages/api.rb

@@ -29,6 +29,10 @@ module MetrifoxSDK::Usages
       customer_key = get_value(request_payload, :customer_key)
       event_name = get_value(request_payload, :event_name)
       amount = get_value(request_payload, :amount) || 1
+      credit_used = get_value(request_payload, :credit_used)
+      event_id = get_value(request_payload, :event_id)
+      timestamp = get_value(request_payload, :timestamp)
+      metadata = get_value(request_payload, :metadata) || {}
 
       body = {
         customer_key: customer_key,
@@ -36,6 +40,12 @@ module MetrifoxSDK::Usages
         amount: amount
       }
 
+      # Add optional fields if present
+      body[:credit_used] = credit_used if credit_used
+      body[:event_id] = event_id if event_id && !event_id.empty?
+      body[:timestamp] = timestamp if timestamp
+      body[:metadata] = metadata if metadata
+
       response = make_request(uri, "POST", api_key, body)
       parse_response(response, "Failed to record usage")
     end

data/lib/metrifox_sdk/version.rb

@@ -1,3 +1,3 @@
 module MetrifoxSDK
-  VERSION = '1.0.1'
+  VERSION = '1.0.3'
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: metrifox-sdk
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Metrifox
-autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-09-01 00:00:00.000000000 Z
+date: 2025-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -121,6 +120,8 @@ files:
 - lib/metrifox-sdk.rb
 - lib/metrifox_sdk/base_api.rb
 - lib/metrifox_sdk/base_module.rb
+- lib/metrifox_sdk/checkout/api.rb
+- lib/metrifox_sdk/checkout/module.rb
 - lib/metrifox_sdk/client.rb
 - lib/metrifox_sdk/customers/api.rb
 - lib/metrifox_sdk/customers/module.rb
@@ -136,7 +137,6 @@ metadata:
   homepage_uri: https://github.com/metrifox/metrifox-ruby
   source_code_uri: https://github.com/metrifox/metrifox-ruby
   changelog_uri: https://github.com/metrifox/metrifox-ruby/tree/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -151,8 +151,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Ruby SDK for Metrifox API
 test_files: []