inttegro 8.0.0 → 8.1.0

data/lib/inttegro/refund/refund.rb

@@ -150,5 +150,23 @@ module Inttegro
     const :status, Inttegro::Refund::Status
     const :succeeded_at, T.nilable(Time), default: nil
     const :total, Inttegro::Money::Amount
+
+    extend T::Sig
+
+    sig { params(hash: T::Hash[String, Object], strict: T::Boolean).returns(T.attached_class) }
+    def self.from_hash(hash, strict = false)
+      data = hash.dup
+      if (settlement_value = data["settlement"]).is_a?(Hash)
+        data["settlement"] = case settlement_value["type"]
+        when "offline"
+          Inttegro::Refund::OfflineSettlement.from_hash(settlement_value)
+        when "payment_method"
+          Inttegro::Refund::PaymentMethodSettlement.from_hash(settlement_value)
+        else
+          settlement_value
+        end
+      end
+      super(data, strict)
+    end
   end
 end

data/lib/inttegro/resources/customers.rb

@@ -43,6 +43,14 @@ module Inttegro
       def page(payload = {})
         @http.post_resource("/customers/page", Inttegro::Customer::Page, :page, payload || {})
       end
+
+      # Search customer profiles using indexed fields and full-text matching.
+      #
+      # @param payload [Inttegro::Search::Request] search query, filters, sorting, facets, and cursor
+      # @return [Inttegro::Search::Page] typed search results
+      def search(payload)
+        @http.post_resource("/customers/search", Inttegro::Search::Page, :search, payload)
+      end
     end
   end
 end

data/lib/inttegro/resources/financial_accounts.rb

@@ -60,6 +60,18 @@ module Inttegro
         )
       end
 
+      # Search financial accounts using indexed fields and full-text matching.
+      #
+      # @param payload [Inttegro::Search::Request] search query, filters, sorting, facets, and cursor
+      # @return [Inttegro::Search::Page] typed search results
+      def search(payload)
+        @http.post_resource(
+          "/financial_accounts/search",
+          Inttegro::Search::Page, :search,
+          payload
+        )
+      end
+
       # Update mutable account profile fields.
       #
       # @param payload [Hash, Inttegro::FinancialAccount::UpdateRequest] account identifier and fields to change

data/lib/inttegro/resources/orders.rb

@@ -398,6 +398,14 @@ module Inttegro
         @http.post_resource("/orders/page", Inttegro::Order::Page, :page, payload || {})
       end
 
+      # Search orders using indexed fields and full-text matching.
+      #
+      # @param payload [Inttegro::Search::Request] search query, filters, sorting, facets, and cursor
+      # @return [Inttegro::Search::Page] typed search results
+      def search(payload)
+        @http.post_resource("/orders/search", Inttegro::Search::Page, :search, payload)
+      end
+
       private
 
       def stable_order_request_meta(action, order_id)

data/lib/inttegro/resources/payouts.rb

@@ -156,6 +156,14 @@ module Inttegro
         @http.post_resource("/payouts/page", Inttegro::Payout::Page, :page, payload)
       end
 
+      # Search payouts using indexed fields and full-text matching.
+      #
+      # @param payload [Inttegro::Search::Request] search query, filters, sorting, facets, and cursor
+      # @return [Inttegro::Search::Page] typed search results
+      def search(payload)
+        @http.post_resource("/payouts/search", Inttegro::Search::Page, :search, payload)
+      end
+
       # Schedule a payout from the application's available balance.
       #
       # @param payload [Inttegro::Schedule::PayoutRequest] typed amount, destination, and execution fields

data/lib/inttegro/resources/products.rb

@@ -83,6 +83,14 @@ module Inttegro
       def page(payload = {})
         @http.post_resource("/products/page", Inttegro::Product::Page, :page, payload || {})
       end
+
+      # Search products using indexed fields and full-text matching.
+      #
+      # @param payload [Inttegro::Search::Request] search query, filters, sorting, facets, and cursor
+      # @return [Inttegro::Search::Page] typed search results
+      def search(payload)
+        @http.post_resource("/products/search", Inttegro::Search::Page, :search, payload)
+      end
     end
   end
 end

data/lib/inttegro/search/base.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require "sorbet-runtime"
+
+module Inttegro
+  # Namespace for generated search models and enums.
+  #
+  # Each public type in this namespace is defined in its own file and follows the field names
+  # and wire values declared by the Inttegro OpenAPI contract.
+  #
+  # @api public
+  module Search
+  end
+end

data/lib/inttegro/search/facet.rb

@@ -0,0 +1,34 @@
+# 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 Search
+    # Typed representation of the facet 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] field
+    #   Unqualified route-local field to group and count.
+    #
+    #   Required in the API payload. Wire name: `field`.
+    #   @return [String]
+    #
+    # @!attribute [r] limit
+    #   Value of the `limit` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `limit`.
+    #   @return [Integer, nil]
+    class Facet < T::Struct
+      const :field, String
+      const :limit, T.nilable(Integer), default: nil
+    end
+  end
+end

data/lib/inttegro/search/facet_bucket.rb

@@ -0,0 +1,34 @@
+# 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 Search
+    # Typed representation of the facet bucket 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] value
+    #   Value of the `value` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `value`.
+    #   @return [String]
+    #
+    # @!attribute [r] count
+    #   Value of the `count` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `count`.
+    #   @return [Integer]
+    class FacetBucket < T::Struct
+      const :value, String
+      const :count, Integer
+    end
+  end
+end

data/lib/inttegro/search/facet_result.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"
+require_relative "facet_bucket"
+
+module Inttegro
+  module Search
+    # Typed representation of the facet result 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] field
+    #   The same unqualified route-local field requested by the caller.
+    #
+    #   Required in the API payload. Wire name: `field`.
+    #   @return [String]
+    #
+    # @!attribute [r] buckets
+    #   Value of the `buckets` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `buckets`.
+    #   @return [Array<Inttegro::Search::FacetBucket>]
+    class FacetResult < T::Struct
+      const :field, String
+      const :buckets, T::Array[Inttegro::Search::FacetBucket]
+    end
+  end
+end

data/lib/inttegro/search/filter.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "filter_operator"
+
+module Inttegro
+  module Search
+    # Typed representation of the filter 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] field
+    #   Unqualified route-local field name documented by the selected endpoint.
+    #
+    #   Required in the API payload. Wire name: `field`.
+    #   @return [String]
+    #
+    # @!attribute [r] operator
+    #   `eq` requires exactly one value; `in` matches any supplied value.
+    #
+    #   Required in the API payload. Wire name: `operator`.
+    #   @return [Inttegro::Search::FilterOperator]
+    #
+    # @!attribute [r] values
+    #   Value of the `values` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `values`.
+    #   @return [Array<String>]
+    class Filter < T::Struct
+      const :field, String
+      const :operator, Inttegro::Search::FilterOperator
+      const :values, T::Array[String]
+    end
+  end
+end

data/lib/inttegro/search/filter_operator.rb

@@ -0,0 +1,27 @@
+# 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 Search
+    # `eq` requires exactly one value; `in` matches any supplied value.
+    #
+    # 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 FilterOperator < T::Enum
+      enums do
+        # Serialized wire value: `eq`.
+        # @return [Inttegro::Search::FilterOperator]
+        EQ = new("eq")
+        # Serialized wire value: `in`.
+        # @return [Inttegro::Search::FilterOperator]
+        IN = new("in")
+      end
+    end
+  end
+end

data/lib/inttegro/search/freshness.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 "freshness_state"
+require_relative "resource_freshness"
+
+module Inttegro
+  module Search
+    # Typed representation of the freshness 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] state
+    #   Value of the `state` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `state`.
+    #   @return [Inttegro::Search::FreshnessState]
+    #
+    # @!attribute [r] observed_at
+    #   Value of the `observed_at` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `observed_at`.
+    #   @return [Time, nil]
+    #
+    # @!attribute [r] resources
+    #   Value of the `resources` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `resources`.
+    #   @return [Array<Inttegro::Search::ResourceFreshness>, nil]
+    class Freshness < T::Struct
+      const :state, Inttegro::Search::FreshnessState
+      const :observed_at, T.nilable(Time), default: nil
+      const :resources, T.nilable(T::Array[Inttegro::Search::ResourceFreshness]), default: nil
+    end
+  end
+end

data/lib/inttegro/search/freshness_state.rb

@@ -0,0 +1,36 @@
+# 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 Search
+    # String-backed values accepted by the Inttegro API for Inttegro::Search::FreshnessState.
+    #
+    # 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 FreshnessState < T::Enum
+      enums do
+        # Serialized wire value: `current`.
+        # @return [Inttegro::Search::FreshnessState]
+        CURRENT = new("current")
+        # Serialized wire value: `delayed`.
+        # @return [Inttegro::Search::FreshnessState]
+        DELAYED = new("delayed")
+        # Serialized wire value: `partial`.
+        # @return [Inttegro::Search::FreshnessState]
+        PARTIAL = new("partial")
+        # Serialized wire value: `unknown`.
+        # @return [Inttegro::Search::FreshnessState]
+        UNKNOWN = new("unknown")
+        # Serialized wire value: `unavailable`.
+        # @return [Inttegro::Search::FreshnessState]
+        UNAVAILABLE = new("unavailable")
+      end
+    end
+  end
+end

data/lib/inttegro/search/page.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "facet_result"
+require_relative "freshness"
+require_relative "resource_total"
+require_relative "result"
+require_relative "sort"
+require_relative "total"
+require_relative "type"
+
+module Inttegro
+  module Search
+    # Typed representation of the page 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] resource_types
+    #   Value of the `resource_types` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `resource_types`.
+    #   @return [Array<Inttegro::Search::Type>]
+    #
+    # @!attribute [r] sort
+    #   Value of the `sort` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `sort`.
+    #   @return [Inttegro::Search::Sort]
+    #
+    # @!attribute [r] page_size
+    #   Value of the `page_size` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `page_size`.
+    #   @return [Integer]
+    #
+    # @!attribute [r] result_count
+    #   Value of the `result_count` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `result_count`.
+    #   @return [Integer]
+    #
+    # @!attribute [r] has_more
+    #   Value of the `has_more` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `has_more`.
+    #   @return [Boolean]
+    #
+    # @!attribute [r] total
+    #   Value of the `total` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `total`.
+    #   @return [Inttegro::Search::Total]
+    #
+    # @!attribute [r] resource_totals
+    #   Value of the `resource_totals` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `resource_totals`.
+    #   @return [Array<Inttegro::Search::ResourceTotal>]
+    #
+    # @!attribute [r] results
+    #   Search projections for discovery, not canonical resource snapshots.
+    #
+    #   Required in the API payload. Wire name: `results`.
+    #   @return [Array<Inttegro::Search::Result>]
+    #
+    # @!attribute [r] facets
+    #   Value of the `facets` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `facets`.
+    #   @return [Array<Inttegro::Search::FacetResult>]
+    #
+    # @!attribute [r] next_cursor
+    #   Value of the `next_cursor` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `next_cursor`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] freshness
+    #   Value of the `freshness` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `freshness`.
+    #   @return [Inttegro::Search::Freshness]
+    class Page < T::Struct
+      const :resource_types, T::Array[Inttegro::Search::Type]
+      const :sort, Inttegro::Search::Sort
+      const :page_size, Integer
+      const :result_count, Integer
+      const :has_more, T::Boolean
+      const :total, Inttegro::Search::Total
+      const :resource_totals, T::Array[Inttegro::Search::ResourceTotal]
+      const :results, T::Array[Inttegro::Search::Result]
+      const :facets, T::Array[Inttegro::Search::FacetResult]
+      const :next_cursor, T.nilable(String), default: nil
+      const :freshness, Inttegro::Search::Freshness
+    end
+  end
+end

data/lib/inttegro/search/request.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "facet"
+require_relative "filter"
+require_relative "sort"
+
+module Inttegro
+  module Search
+    # A resource-local search request. Send `text`, at least one filter, or both. Field names are
+    # unqualified and depend on the endpoint. The application and resource type are derived by
+    # Inttegro and cannot be supplied by the caller. To continue a search, repeat the same request
+    # and add the returned `next_cursor`.
+    #
+    # 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] text
+    #   Words, identifiers, or names to search for.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `text`.
+    #   @return [String, nil]
+    #
+    # @!attribute [r] filters
+    #   Value of the `filters` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `filters`.
+    #   @return [Array<Inttegro::Search::Filter>, nil]
+    #
+    # @!attribute [r] facets
+    #   Value of the `facets` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `facets`.
+    #   @return [Array<Inttegro::Search::Facet>, nil]
+    #
+    # @!attribute [r] sort
+    #   Value of the `sort` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `sort`.
+    #   @return [Inttegro::Search::Sort, nil]
+    #
+    # @!attribute [r] page_size
+    #   Value of the `page_size` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `page_size`.
+    #   @return [Integer, nil]
+    #
+    # @!attribute [r] cursor
+    #   Opaque continuation value returned as `next_cursor` by the preceding page.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `cursor`.
+    #   @return [String, nil]
+    class Request < T::Struct
+      const :text, T.nilable(String), default: nil
+      const :filters, T.nilable(T::Array[Inttegro::Search::Filter]), default: nil
+      const :facets, T.nilable(T::Array[Inttegro::Search::Facet]), default: nil
+      const :sort, T.nilable(Inttegro::Search::Sort), default: nil
+      const :page_size, T.nilable(Integer), default: nil
+      const :cursor, T.nilable(String), default: nil
+    end
+  end
+end

data/lib/inttegro/search/resource_freshness.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+# typed: strict
+
+# Generated from openapi/commerce.yml by bin/generate-openapi-types. Do not edit.
+
+require_relative "base"
+require_relative "resource_freshness_state"
+require_relative "type"
+
+module Inttegro
+  module Search
+    # Typed representation of the resource freshness 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] resource_type
+    #   Value of the `resource_type` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `resource_type`.
+    #   @return [Inttegro::Search::Type]
+    #
+    # @!attribute [r] state
+    #   Value of the `state` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `state`.
+    #   @return [Inttegro::Search::ResourceFreshnessState]
+    #
+    # @!attribute [r] observed_at
+    #   Value of the `observed_at` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `observed_at`.
+    #   @return [Time, nil]
+    #
+    # @!attribute [r] last_indexed_at
+    #   Value of the `last_indexed_at` field in the Inttegro API payload.
+    #
+    #   Optional in the API payload; omitted values default to `nil`. Wire name: `last_indexed_at`.
+    #   @return [Time, nil]
+    class ResourceFreshness < T::Struct
+      const :resource_type, Inttegro::Search::Type
+      const :state, Inttegro::Search::ResourceFreshnessState
+      const :observed_at, T.nilable(Time), default: nil
+      const :last_indexed_at, T.nilable(Time), default: nil
+    end
+  end
+end

data/lib/inttegro/search/resource_freshness_state.rb

@@ -0,0 +1,37 @@
+# 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 Search
+    # String-backed values accepted by the Inttegro API for
+    # Inttegro::Search::ResourceFreshnessState.
+    #
+    # 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 ResourceFreshnessState < T::Enum
+      enums do
+        # Serialized wire value: `current`.
+        # @return [Inttegro::Search::ResourceFreshnessState]
+        CURRENT = new("current")
+        # Serialized wire value: `delayed`.
+        # @return [Inttegro::Search::ResourceFreshnessState]
+        DELAYED = new("delayed")
+        # Serialized wire value: `partial`.
+        # @return [Inttegro::Search::ResourceFreshnessState]
+        PARTIAL = new("partial")
+        # Serialized wire value: `unknown`.
+        # @return [Inttegro::Search::ResourceFreshnessState]
+        UNKNOWN = new("unknown")
+        # Serialized wire value: `unavailable`.
+        # @return [Inttegro::Search::ResourceFreshnessState]
+        UNAVAILABLE = new("unavailable")
+      end
+    end
+  end
+end

data/lib/inttegro/search/resource_reference.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"
+require_relative "type"
+
+module Inttegro
+  module Search
+    # Typed representation of the resource reference 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] type
+    #   Value of the `type` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `type`.
+    #   @return [Inttegro::Search::Type]
+    #
+    # @!attribute [r] id
+    #   Value of the `id` field in the Inttegro API payload.
+    #
+    #   Required in the API payload. Wire name: `id`.
+    #   @return [String]
+    class ResourceReference < T::Struct
+      const :type, Inttegro::Search::Type
+      const :id, String
+    end
+  end
+end