inttegro 6.0.1 → 8.0.0

data/lib/inttegro/refund/settlement_mobile_money_payment_method_mobile_money.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "../shared/mobile_money_network"
+
+module Inttegro
+  class Refund
+    # Typed representation of the settlement mobile money payment method mobile money object in
+    # the Inttegro API.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] account_number
+    #   Masked mobile-money account number. The full number is never returned.
+    #
+    #   Required in the API payload. Wire name: `account_number`.
+    #   @return [String]
+    #
+    # @!attribute [r] last4
+    #   Last four numeric digits of the original account number.
+    #
+    #   Required in the API payload. Wire name: `last4`.
+    #   @return [String]
+    #
+    # @!attribute [r] network
+    #   Value of the `network` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `network`.
+    #   @return [Inttegro::Shared::MobileMoneyNetwork]
+    class SettlementMobileMoneyPaymentMethodMobileMoney < T::Struct
+      const :account_number, String
+      const :last4, String
+      const :network, Inttegro::Shared::MobileMoneyNetwork
+    end
+  end
+end

data/lib/inttegro/refund/settlement_mobile_money_payment_method_type.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+
+module Inttegro
+  class Refund
+    # String-backed values accepted by the Inttegro API for
+    # Inttegro::Refund::SettlementMobileMoneyPaymentMethodType.
+    #
+    # Use the constants below when constructing a request. `#serialize` returns the documented
+    # string wire value received from or sent to the API.
+    #
+    # @api public
+    class SettlementMobileMoneyPaymentMethodType < T::Enum
+      enums do
+        # Serialized wire value: `mobile_money`.
+        # @return [Inttegro::Refund::SettlementMobileMoneyPaymentMethodType]
+        MOBILE_MONEY = new("mobile_money")
+      end
+    end
+  end
+end

data/lib/inttegro/refund/settlement_payment_method.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "settlement_bank_account_payment_method"
+require_relative "settlement_mobile_money_payment_method"
+
+module Inttegro
+  class Refund
+    # Caller-safe immutable snapshot of the original payment method. Account values are masked and
+    # management-only payment-method data is never included.
+    #
+    # @api public
+    # @return [Inttegro::Refund::SettlementMobileMoneyPaymentMethod, Inttegro::Refund::SettlementBankAccountPaymentMethod]
+    SettlementPaymentMethod = T.type_alias { T.any(Inttegro::Refund::SettlementMobileMoneyPaymentMethod, Inttegro::Refund::SettlementBankAccountPaymentMethod) }
+  end
+end

data/lib/inttegro/resources/orders.rb

@@ -104,6 +104,14 @@ module Inttegro
         @http.post_resource("/orders/create", Inttegro::Order, :order, payload)
       end
 
+      # Create a new order and keep HTTP response metadata with the decoded order.
+      #
+      # @param payload [Hash, Inttegro::Order::CreateNewCustomer, Inttegro::Order::CreateExistingCustomer]
+      # @return [Inttegro::APIResponse] response whose data is an Inttegro::Order
+      def create_with_response(payload)
+        @http.post_resource_with_response("/orders/create", Inttegro::Order, :order, payload)
+      end
+
       # Retrieve an existing order by its ID.
       #
       # Returns full order details including customer, line items, payment state, and invoice information.

data/lib/inttegro/resources/payouts.rb

@@ -18,20 +18,16 @@ module Inttegro
 
       # Configure which financial account should be used for payouts in each currency.
       #
-      # Sets payout destinations by mapping currency codes to financial account IDs. Each financial
-      # account must be owned by your application, have push operations enabled, and its currency
-      # must match the currency key in the destinations map.
+      # Sets the supported GHS payout destination. The financial account must be owned by your
+      # application, have push operations enabled, and use Ghana cedi.
       #
-      # @param destinations [Hash] Map of currency codes to financial account IDs (required)
+      # @param destinations [Inttegro::Payout::Destinations] supported destination assignments
       #
       # @return [Inttegro::Payout::SettingsMutation] Updated payout settings
       #
-      # @example Set payout destinations for multiple currencies
+      # @example Set the GHS payout destination
       #   result = client.payouts.set_destinations(
-      #     destinations: {
-      #       'ghs' => 'fa_1234567890abcdef',
-      #       'usd' => 'fa_0987654321fedcba'
-      #     }
+      #     destinations: Inttegro::Payout::Destinations.new(ghs: "fa_1234567890abcdef")
       #   )
       #
       #   puts "Destinations configured: #{result.destinations}"
@@ -110,7 +106,7 @@ module Inttegro
       # Important: FX conversion incurs additional fees beyond standard payout fees, and exchange rates are
       # determined at payout execution time. FX-enabled payouts require approval and special configuration.
       #
-      # @return [Inttegro::Payout::SettingsLookup] Updated payout settings
+      # @return [Inttegro::Payout::SettingsMutation] Updated payout settings
       #
       # @example Enable foreign exchange for payouts
       #   result = client.payouts.enable_fx
@@ -119,7 +115,7 @@ module Inttegro
       #
       # @see https://studio.inttegro.com/enable-fx-payouts for FX payout guide
       def enable_fx
-        @http.post_resource("/payouts/enable_fx", Inttegro::Payout::SettingsLookup, :settings, {})
+        @http.post_resource("/payouts/enable_fx", Inttegro::Payout::SettingsMutation, :settings, {})
       end
 
       # Disable foreign exchange conversion for payouts.
@@ -127,7 +123,7 @@ module Inttegro
       # Disables FX conversion, restricting payouts to accounts that match the transaction currency.
       # After disabling FX, GHS balance can only be paid out to GHS accounts, USD balance only to USD accounts, etc.
       #
-      # @return [Inttegro::Payout::SettingsLookup] Updated payout settings
+      # @return [Inttegro::Payout::SettingsMutation] Updated payout settings
       #
       # @example Disable foreign exchange for payouts
       #   result = client.payouts.disable_fx
@@ -136,46 +132,33 @@ module Inttegro
       #
       # @see https://studio.inttegro.com/disable-fx-payouts for FX payout guide
       def disable_fx
-        @http.post_resource("/payouts/disable_fx", Inttegro::Payout::SettingsLookup, :settings, {})
+        @http.post_resource("/payouts/disable_fx", Inttegro::Payout::SettingsMutation, :settings, {})
       end
 
       # Retrieve a paginated list of payouts.
       #
-      # Returns payouts in reverse chronological order (most recent first). Use the has_more field
-      # and page parameter to navigate through results. Supports filtering by status and time range.
+      # Returns payouts in reverse chronological order (most recent first).
       #
-      # @param payload [Hash, Inttegro::Payout::PageRequest] Pagination and filter parameters (optional)
-      # @option payload [Integer] :page Page number to retrieve (minimum 1, default: 1)
-      # @option payload [Integer] :per_page Number of results per page (minimum 1, maximum 100, default: 10)
-      # @option payload [String] :status Filter by payout status (e.g., 'pending', 'paid', 'failed')
-      # @option payload [Time] :created_after Filter payouts created after this timestamp
-      # @option payload [Time] :created_before Filter payouts created before this timestamp
+      # @param payload [Inttegro::Payout::PageRequest] Typed pagination parameters
       #
       # @return [Inttegro::Payout::Page] Paginated list of payouts
       #
       # @example Get first page of payouts
       #   result = client.payouts.page(
-      #     per_page: 25,
-      #     page: 1
+      #     Inttegro::Payout::PageRequest.new(page_number: 1, page_size: 25)
       #   )
       #
       #   puts "Retrieved #{result.payouts&.length || 0} payouts"
       #
-      # @example Filter by status
-      #   paid_payouts = client.payouts.page(
-      #     status: 'paid',
-      #     per_page: 50
-      #   )
-      #
       # @see https://studio.inttegro.com/pagination for pagination guide
       # @see https://studio.inttegro.com/product-payouts for payouts overview
-      def page(payload = {})
-        @http.post_resource("/payouts/page", Inttegro::Payout::Page, :page, payload || {})
+      def page(payload)
+        @http.post_resource("/payouts/page", Inttegro::Payout::Page, :page, payload)
       end
 
       # Schedule a payout from the application's available balance.
       #
-      # @param payload [Hash, Inttegro::Schedule::PayoutRequest] amount, destination, and execution fields
+      # @param payload [Inttegro::Schedule::PayoutRequest] typed amount, destination, and execution fields
       # @return [Inttegro::Payout] scheduled payout
       def schedule(payload)
         @http.post_resource("/payouts/schedule", Inttegro::Payout, :payout, payload)

data/lib/inttegro/resources/refunds.rb

@@ -23,12 +23,15 @@ module Inttegro
       # Cancel a pending refund before processing claims it.
       #
       # @param refund_id [String] unique refund identifier
+      # @param reason [String, nil] optional explanation for canceling the refund
       # @return [Inttegro::Refund] canceled refund
-      def cancel(refund_id:)
+      def cancel(refund_id:, reason: nil)
+        payload = T.let({ refund_id: refund_id }, Inttegro::Types::Payload)
+        payload[:reason] = reason unless reason.nil?
         @http.post_resource(
           "/refunds/cancel",
           Inttegro::Refund, :refund,
-          { refund_id: refund_id }
+          payload
         )
       end
 

data/lib/inttegro/schedule/payout_request.rb

@@ -7,7 +7,7 @@ require_relative "base"
 
 module Inttegro
   module Schedule
-    # Typed representation of the payout request object in the Inttegro API.
+    # Parameters for scheduling a payout.
     #
     # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
     # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
@@ -16,25 +16,25 @@ module Inttegro
     # @api public
     #
     # @!attribute [r] destination_id
-    #   Financial account that should receive the payout
+    #   Financial account that should receive the payout.
     #
     #   Required in the API payload. Wire name: `destination_id`.
     #   @return [String]
     #
     # @!attribute [r] execute_after
-    #   Optional future time after which execution may begin
+    #   Optional future time after which execution may begin.
     #
     #   Optional in the API payload; omitted values default to `nil`. Wire name: `execute_after`.
     #   @return [Time, nil]
     #
     # @!attribute [r] max_amount
-    #   Maximum amount, in the smallest currency unit, that this payout may transfer
+    #   Maximum amount, in the smallest currency unit, that this payout may transfer.
     #
     #   Optional in the API payload; omitted values default to `nil`. Wire name: `max_amount`.
     #   @return [Integer, nil]
     #
     # @!attribute [r] reference
-    #   Merchant reference carried on the payout
+    #   Merchant reference carried on the payout.
     #
     #   Required in the API payload. Wire name: `reference`.
     #   @return [String]

data/lib/inttegro/shared/fee_details.rb

@@ -4,6 +4,7 @@
 # Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
 
 require_relative "base"
+require_relative "../custom_data"
 require_relative "../money/amount_params"
 
 module Inttegro
@@ -45,7 +46,7 @@ module Inttegro
     #   collection rather than a raw map.
     #
     #   Optional in the API payload; omitted values default to `nil`. Wire name: `custom_data`.
-    #   @return [Hash{String => String}, nil]
+    #   @return [Inttegro::CustomData, nil]
     #
     # @!attribute [r] amount
     #   Value of the `amount` field in the Inttegro API payload.
@@ -57,7 +58,7 @@ module Inttegro
       const :label, T.nilable(String), default: nil
       const :tax_code, T.nilable(String), default: nil
       const :description, T.nilable(String), default: nil
-      const :custom_data, T.nilable(T::Hash[String, String]), default: nil
+      const :custom_data, T.nilable(Inttegro::CustomData), default: nil
       const :amount, Inttegro::Money::AmountParams
     end
   end

data/lib/inttegro/shared/invoice_settings.rb

@@ -4,6 +4,7 @@
 # Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
 
 require_relative "base"
+require_relative "../custom_data"
 
 module Inttegro
   module Shared
@@ -40,12 +41,12 @@ module Inttegro
     #   collection rather than a raw map.
     #
     #   Optional in the API payload; omitted values default to `nil`. Wire name: `custom_data`.
-    #   @return [Hash{String => String}, nil]
+    #   @return [Inttegro::CustomData, nil]
     class InvoiceSettings < T::Struct
       const :number, T.nilable(String), default: nil
       const :memo, T.nilable(String), default: nil
       const :footer, T.nilable(String), default: nil
-      const :custom_data, T.nilable(T::Hash[String, String]), default: nil
+      const :custom_data, T.nilable(Inttegro::CustomData), default: nil
     end
   end
 end

data/lib/inttegro/shared/response_meta.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+
+module Inttegro
+  module Shared
+    # Curated response metadata. This is body metadata and does not replace native HTTP status or
+    # response headers.
+    #
+    # This generated model is immutable. Construct it with `.new`, or decode a string-keyed API
+    # payload with `.from_hash`. `#serialize` produces a string-keyed hash using the original wire
+    # field names and serialized enum values.
+    #
+    # @api public
+    #
+    # @!attribute [r] request_id
+    #   Inttegro request identifier for this API response.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `request_id`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] debug
+    #   Optional debug information returned only when explicitly enabled and authorized.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `debug`.
+    #   @return [Hash{String => Object}, nil]
+    class ResponseMeta < T::Struct
+      const :request_id, T.nilable(String), default: nil
+      const :debug, T.nilable(T::Hash[String, Object]), default: nil
+    end
+  end
+end

data/lib/inttegro/shared/shipping_details.rb

@@ -4,6 +4,7 @@
 # Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
 
 require_relative "base"
+require_relative "../custom_data"
 require_relative "../money/amount_params"
 
 module Inttegro
@@ -33,7 +34,7 @@ module Inttegro
     #   collection rather than a raw map.
     #
     #   Optional in the API payload; omitted values default to `nil`. Wire name: `custom_data`.
-    #   @return [Hash{String => String}, nil]
+    #   @return [Inttegro::CustomData, nil]
     #
     # @!attribute [r] fee
     #   Value of the `fee` field in the Inttegro API payload.
@@ -43,7 +44,7 @@ module Inttegro
     class ShippingDetails < T::Struct
       const :id, T.nilable(String), default: nil
       const :tax_code, T.nilable(String), default: nil
-      const :custom_data, T.nilable(T::Hash[String, String]), default: nil
+      const :custom_data, T.nilable(Inttegro::CustomData), default: nil
       const :fee, Inttegro::Money::AmountParams
     end
   end

data/lib/inttegro/upload_request/create_request.rb

@@ -4,6 +4,7 @@
 # Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
 
 require_relative "base"
+require_relative "../custom_data"
 require_relative "../file/actor_input"
 require_relative "../file/party"
 require_relative "../file/resource"
@@ -74,7 +75,7 @@ module Inttegro
     #   collection rather than a raw map.
     #
     #   Optional in the API payload; omitted values default to `nil`. Wire name: `custom_data`.
-    #   @return [Hash{String => String}, nil]
+    #   @return [Inttegro::CustomData, nil]
     #
     # @!attribute [r] expires_at
     #   Value of the `expires_at` field in the Inttegro API payload.
@@ -90,7 +91,7 @@ module Inttegro
       const :resource, T.nilable(Inttegro::File::Resource), default: nil
       const :requester, T.nilable(Inttegro::File::ActorInput), default: nil
       const :attempts, T.nilable(Inttegro::UploadRequest::AttemptsRequest), default: nil
-      const :custom_data, T.nilable(T::Hash[String, String]), default: nil
+      const :custom_data, T.nilable(Inttegro::CustomData), default: nil
       const :expires_at, T.nilable(Time), default: nil
     end
   end

data/lib/inttegro/upload_request/details.rb

@@ -4,6 +4,7 @@
 # Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
 
 require_relative "base"
+require_relative "../custom_data"
 require_relative "../file/party"
 require_relative "../file/resource"
 require_relative "actor"
@@ -119,7 +120,7 @@ module Inttegro
     #   collection rather than a raw map.
     #
     #   Optional in the API payload; omitted values default to `nil`. Wire name: `custom_data`.
-    #   @return [Hash{String => String}, nil]
+    #   @return [Inttegro::CustomData, nil]
     #
     # @!attribute [r] metadata
     #   System-managed string metadata attached to a file resource.
@@ -190,7 +191,7 @@ module Inttegro
       const :attempts, Inttegro::UploadRequest::Attempts
       const :latest_error, T.nilable(Inttegro::UploadRequest::LatestError), default: nil
       const :canceled_by, T.nilable(Inttegro::UploadRequest::Actor), default: nil
-      const :custom_data, T.nilable(T::Hash[String, String]), default: nil
+      const :custom_data, T.nilable(Inttegro::CustomData), default: nil
       const :metadata, T.nilable(T::Hash[String, String]), default: nil
       const :created_at, Time
       const :updated_at, Time

data/lib/inttegro/upload_request/upload_request.rb

@@ -4,6 +4,7 @@
 # Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
 
 require_relative "base"
+require_relative "../custom_data"
 require_relative "../file/party"
 require_relative "../file/resource"
 require_relative "actor"
@@ -117,7 +118,7 @@ module Inttegro
   #   collection rather than a raw map.
   #
   #   Optional in the API payload; omitted values default to `nil`. Wire name: `custom_data`.
-  #   @return [Hash{String => String}, nil]
+  #   @return [Inttegro::CustomData, nil]
   #
   # @!attribute [r] metadata
   #   System-managed string metadata attached to a file resource.
@@ -182,7 +183,7 @@ module Inttegro
     const :attempts, Inttegro::UploadRequest::Attempts
     const :latest_error, T.nilable(Inttegro::UploadRequest::LatestError), default: nil
     const :canceled_by, T.nilable(Inttegro::UploadRequest::Actor), default: nil
-    const :custom_data, T.nilable(T::Hash[String, String]), default: nil
+    const :custom_data, T.nilable(Inttegro::CustomData), default: nil
     const :metadata, T.nilable(T::Hash[String, String]), default: nil
     const :created_at, Time
     const :updated_at, Time

data/lib/inttegro/version.rb

@@ -2,5 +2,5 @@
 # typed: strict
 
 module Inttegro
-  VERSION = "6.0.1"
+  VERSION = "8.0.0"
 end

data/lib/inttegro.rb

@@ -4,7 +4,9 @@
 require "sorbet-runtime"
 
 require_relative "inttegro/types"
+require_relative "inttegro/api_response"
 require_relative "inttegro/client"
+require_relative "inttegro/custom_data"
 require_relative "inttegro/errors"
 require_relative "inttegro/error_reporting"
 require_relative "inttegro/enums"

data/rbi/inttegro/generated.rbi

@@ -250,6 +250,9 @@ module Inttegro
       sig { params(payload: T.any(T.any(Inttegro::Order::CreateNewCustomer, Inttegro::Order::CreateExistingCustomer), Inttegro::Types::Payload)).returns(Inttegro::Order) }
       def create(payload); end
 
+      sig { params(payload: T.any(T.any(Inttegro::Order::CreateNewCustomer, Inttegro::Order::CreateExistingCustomer), Inttegro::Types::Payload)).returns(Inttegro::APIResponse) }
+      def create_with_response(payload); end
+
       sig { params(order_id: String, request_meta: T.nilable(Inttegro::Types::Payload)).returns(Inttegro::Order) }
       def finalize(order_id:, request_meta: nil); end
 
@@ -353,25 +356,25 @@ module Inttegro
       sig { returns(Inttegro::Payout::SettingsMutation) }
       def disable_automatic(); end
 
-      sig { returns(Inttegro::Payout::SettingsLookup) }
+      sig { returns(Inttegro::Payout::SettingsMutation) }
       def disable_fx(); end
 
       sig { returns(Inttegro::Payout::SettingsMutation) }
       def enable_automatic(); end
 
-      sig { returns(Inttegro::Payout::SettingsLookup) }
+      sig { returns(Inttegro::Payout::SettingsMutation) }
       def enable_fx(); end
 
       sig { params(payout_id: String).returns(Inttegro::Payout) }
       def lookup(payout_id:); end
 
-      sig { params(payload: T.nilable(T.any(Inttegro::Payout::PageRequest, Inttegro::Types::Payload))).returns(Inttegro::Payout::Page) }
-      def page(payload = nil); end
+      sig { params(payload: Inttegro::Payout::PageRequest).returns(Inttegro::Payout::Page) }
+      def page(payload); end
 
-      sig { params(payload: T.any(Inttegro::Schedule::PayoutRequest, Inttegro::Types::Payload)).returns(Inttegro::Payout) }
+      sig { params(payload: Inttegro::Schedule::PayoutRequest).returns(Inttegro::Payout) }
       def schedule(payload); end
 
-      sig { params(destinations: T::Hash[String, String]).returns(Inttegro::Payout::SettingsMutation) }
+      sig { params(destinations: Inttegro::Payout::Destinations).returns(Inttegro::Payout::SettingsMutation) }
       def set_destinations(destinations:); end
 
       sig { returns(Inttegro::Payout::SettingsLookup) }
@@ -460,8 +463,8 @@ module Inttegro
       sig { params(http: Inttegro::HTTPClient).void }
       def initialize(http); end
 
-      sig { params(refund_id: String).returns(Inttegro::Refund) }
-      def cancel(refund_id:); end
+      sig { params(refund_id: String, reason: T.nilable(Inttegro::Types::WireValue)).returns(Inttegro::Refund) }
+      def cancel(refund_id:, reason: nil); end
 
       sig { params(payload: T.any(Inttegro::Refund::CreateRequest, Inttegro::Types::Payload)).returns(Inttegro::Refund) }
       def create(payload); end