stigg 0.1.0.pre.beta.34 → 0.1.0.pre.beta.35

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80d339977dd4c2a272f750387cdca3877af06c445be9f269c62bf34b3d726d2e
-  data.tar.gz: 2facee5ad32bbf4bac99ab3a42e5dcb2566ccc5d7a985d7c453a9241fd85e9ec
+  metadata.gz: 37796b53d48cf3448b56cb9d463ed46c3308e729cf52f572513f959c7dacec50
+  data.tar.gz: 5d16deb29b585ff6bef9e6a996e39e53069a93fc0bd0c2dc00a4a4f5552d96c3
 SHA512:
-  metadata.gz: 9ebeb2844178122c5a3a3f8cdc23e56a18718b489f3dfab8f494aba9ff25b15d5a287fd43a250d2f9d4b037eb53eb80915e0bc0341dfde8a135a17a817896427
-  data.tar.gz: dc1048e2f992e0f085936490e6a0d7052dafe8a8cb267da25d302e57407bdca07faee084b3beb808e50e71763eec421f48335f545591ae6c8ff8aff1b6cdf654
+  metadata.gz: 8cdc6cb04e672018779405902befa35db1a420df3390f661dd126cc15ef9fc4b76c92dd3bedfb354814aecc51a8b5844181aa54b3bc00021d481260f6e1ded45
+  data.tar.gz: 37357f0095e9611dd9cf877b09bbb3bc908279bf4fda021cb07d431c2844ce509379648ff91bda4ddd7ae1722dc4c67d526a1f45085f000dc1a3a85d3154fe15

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.1.0-beta.35 (2026-07-01)
+
+Full Changelog: [v0.1.0-beta.34...v0.1.0-beta.35](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.34...v0.1.0-beta.35)
+
+### Features
+
+* **api:** add consumption sub-resource to credits ([91984a0](https://github.com/stiggio/stigg-ruby/commit/91984a0134e60ec1b03ed1c0ad34fdbdabea9426))
+
 ## 0.1.0-beta.34 (2026-06-30)
 
 Full Changelog: [v0.1.0-beta.33...v0.1.0-beta.34](https://github.com/stiggio/stigg-ruby/compare/v0.1.0-beta.33...v0.1.0-beta.34)

data/README.md

@@ -24,7 +24,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "stigg", "~> 0.1.0.pre.beta.34"
+gem "stigg", "~> 0.1.0.pre.beta.35"
 ```
 
 <!-- x-release-please-end -->

data/lib/stigg/models/v1/credits/consumption_consume_async_params.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      module Credits
+        # @see Stigg::Resources::V1::Credits::Consumption#consume_async
+        class ConsumptionConsumeAsyncParams < Stigg::Internal::Type::BaseModel
+          extend Stigg::Internal::Type::RequestParameters::Converter
+          include Stigg::Internal::Type::RequestParameters
+
+          # @!attribute consumptions
+          #   The credit consumptions to report (up to 1000)
+          #
+          #   @return [Array<Stigg::Models::V1::Credits::ConsumptionConsumeAsyncParams::Consumption>]
+          required :consumptions,
+                   -> { Stigg::Internal::Type::ArrayOf[Stigg::V1::Credits::ConsumptionConsumeAsyncParams::Consumption] }
+
+          # @!attribute x_account_id
+          #
+          #   @return [String, nil]
+          optional :x_account_id, String
+
+          # @!attribute x_environment_id
+          #
+          #   @return [String, nil]
+          optional :x_environment_id, String
+
+          # @!method initialize(consumptions:, x_account_id: nil, x_environment_id: nil, request_options: {})
+          #   @param consumptions [Array<Stigg::Models::V1::Credits::ConsumptionConsumeAsyncParams::Consumption>] The credit consumptions to report (up to 1000)
+          #
+          #   @param x_account_id [String]
+          #
+          #   @param x_environment_id [String]
+          #
+          #   @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
+
+          class Consumption < Stigg::Internal::Type::BaseModel
+            # @!attribute amount
+            #   The amount of credits to consume
+            #
+            #   @return [Float]
+            required :amount, Float
+
+            # @!attribute currency_id
+            #   The credit currency to consume from (required)
+            #
+            #   @return [String]
+            required :currency_id, String, api_name: :currencyId
+
+            # @!attribute customer_id
+            #   The customer to consume credits from (required)
+            #
+            #   @return [String]
+            required :customer_id, String, api_name: :customerId
+
+            # @!attribute idempotency_key
+            #   A unique key used to deduplicate the consumption (required)
+            #
+            #   @return [String]
+            required :idempotency_key, String, api_name: :idempotencyKey
+
+            # @!attribute created_at
+            #   Optional timestamp the consumption is attributed to
+            #
+            #   @return [Time, nil]
+            optional :created_at, Time, api_name: :createdAt
+
+            # @!attribute dimensions
+            #   Optional dimensions describing the consumption
+            #
+            #   @return [Hash{Symbol=>String, Float, Boolean}, nil]
+            optional :dimensions,
+                     -> { Stigg::Internal::Type::HashOf[union: Stigg::V1::Credits::ConsumptionConsumeAsyncParams::Consumption::Dimension] }
+
+            # @!attribute resource_id
+            #   Optional resource the consumption is attributed to
+            #
+            #   @return [String, nil]
+            optional :resource_id, String, api_name: :resourceId
+
+            # @!method initialize(amount:, currency_id:, customer_id:, idempotency_key:, created_at: nil, dimensions: nil, resource_id: nil)
+            #   Request body for consuming credits directly from a wallet
+            #
+            #   @param amount [Float] The amount of credits to consume
+            #
+            #   @param currency_id [String] The credit currency to consume from (required)
+            #
+            #   @param customer_id [String] The customer to consume credits from (required)
+            #
+            #   @param idempotency_key [String] A unique key used to deduplicate the consumption (required)
+            #
+            #   @param created_at [Time] Optional timestamp the consumption is attributed to
+            #
+            #   @param dimensions [Hash{Symbol=>String, Float, Boolean}] Optional dimensions describing the consumption
+            #
+            #   @param resource_id [String] Optional resource the consumption is attributed to
+
+            module Dimension
+              extend Stigg::Internal::Type::Union
+
+              variant String
+
+              variant Float
+
+              variant Stigg::Internal::Type::Boolean
+
+              # @!method self.variants
+              #   @return [Array(String, Float, Boolean)]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stigg/models/v1/credits/consumption_consume_async_response.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      module Credits
+        # @see Stigg::Resources::V1::Credits::Consumption#consume_async
+        class ConsumptionConsumeAsyncResponse < Stigg::Internal::Type::BaseModel
+          # @!attribute data
+          #   Confirmation that the credit consumptions were accepted for processing
+          #
+          #   @return [Object]
+          required :data, Stigg::Internal::Type::Unknown
+
+          # @!method initialize(data:)
+          #   Response object
+          #
+          #   @param data [Object] Confirmation that the credit consumptions were accepted for processing
+        end
+      end
+    end
+  end
+end

data/lib/stigg/models/v1/credits/consumption_consume_params.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      module Credits
+        # @see Stigg::Resources::V1::Credits::Consumption#consume
+        class ConsumptionConsumeParams < Stigg::Internal::Type::BaseModel
+          extend Stigg::Internal::Type::RequestParameters::Converter
+          include Stigg::Internal::Type::RequestParameters
+
+          # @!attribute amount
+          #   The amount of credits to consume
+          #
+          #   @return [Float]
+          required :amount, Float
+
+          # @!attribute currency_id
+          #   The credit currency to consume from (required)
+          #
+          #   @return [String]
+          required :currency_id, String, api_name: :currencyId
+
+          # @!attribute customer_id
+          #   The customer to consume credits from (required)
+          #
+          #   @return [String]
+          required :customer_id, String, api_name: :customerId
+
+          # @!attribute idempotency_key
+          #   A unique key used to deduplicate the consumption (required)
+          #
+          #   @return [String]
+          required :idempotency_key, String, api_name: :idempotencyKey
+
+          # @!attribute created_at
+          #   Optional timestamp the consumption is attributed to
+          #
+          #   @return [Time, nil]
+          optional :created_at, Time, api_name: :createdAt
+
+          # @!attribute dimensions
+          #   Optional dimensions describing the consumption
+          #
+          #   @return [Hash{Symbol=>String, Float, Boolean}, nil]
+          optional :dimensions,
+                   -> { Stigg::Internal::Type::HashOf[union: Stigg::V1::Credits::ConsumptionConsumeParams::Dimension] }
+
+          # @!attribute resource_id
+          #   Optional resource the consumption is attributed to
+          #
+          #   @return [String, nil]
+          optional :resource_id, String, api_name: :resourceId
+
+          # @!attribute x_account_id
+          #
+          #   @return [String, nil]
+          optional :x_account_id, String
+
+          # @!attribute x_environment_id
+          #
+          #   @return [String, nil]
+          optional :x_environment_id, String
+
+          # @!method initialize(amount:, currency_id:, customer_id:, idempotency_key:, created_at: nil, dimensions: nil, resource_id: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
+          #   @param amount [Float] The amount of credits to consume
+          #
+          #   @param currency_id [String] The credit currency to consume from (required)
+          #
+          #   @param customer_id [String] The customer to consume credits from (required)
+          #
+          #   @param idempotency_key [String] A unique key used to deduplicate the consumption (required)
+          #
+          #   @param created_at [Time] Optional timestamp the consumption is attributed to
+          #
+          #   @param dimensions [Hash{Symbol=>String, Float, Boolean}] Optional dimensions describing the consumption
+          #
+          #   @param resource_id [String] Optional resource the consumption is attributed to
+          #
+          #   @param x_account_id [String]
+          #
+          #   @param x_environment_id [String]
+          #
+          #   @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
+
+          module Dimension
+            extend Stigg::Internal::Type::Union
+
+            variant String
+
+            variant Float
+
+            variant Stigg::Internal::Type::Boolean
+
+            # @!method self.variants
+            #   @return [Array(String, Float, Boolean)]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stigg/models/v1/credits/consumption_consume_response.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      module Credits
+        # @see Stigg::Resources::V1::Credits::Consumption#consume
+        class ConsumptionConsumeResponse < Stigg::Internal::Type::BaseModel
+          # @!attribute data
+          #   Result of a synchronous direct credit consumption
+          #
+          #   @return [Stigg::Models::V1::Credits::ConsumptionConsumeResponse::Data]
+          required :data, -> { Stigg::Models::V1::Credits::ConsumptionConsumeResponse::Data }
+
+          # @!method initialize(data:)
+          #   Response object
+          #
+          #   @param data [Stigg::Models::V1::Credits::ConsumptionConsumeResponse::Data] Result of a synchronous direct credit consumption
+
+          # @see Stigg::Models::V1::Credits::ConsumptionConsumeResponse#data
+          class Data < Stigg::Internal::Type::BaseModel
+            # @!attribute amount
+            #   The amount of credits consumed
+            #
+            #   @return [Float]
+            required :amount, Float
+
+            # @!attribute currency_id
+            #   The credit currency the credits were consumed from
+            #
+            #   @return [String]
+            required :currency_id, String, api_name: :currencyId
+
+            # @!attribute customer_id
+            #   The customer the credits were consumed from
+            #
+            #   @return [String]
+            required :customer_id, String, api_name: :customerId
+
+            # @!attribute timestamp
+            #   The timestamp the consumption was attributed to
+            #
+            #   @return [Time]
+            required :timestamp, Time
+
+            # @!attribute credit
+            #   The optimistic credit balance after consumption (when sync credit consumption is
+            #   enabled)
+            #
+            #   @return [Stigg::Models::V1::Credits::ConsumptionConsumeResponse::Data::Credit, nil]
+            optional :credit, -> { Stigg::Models::V1::Credits::ConsumptionConsumeResponse::Data::Credit }, nil?: true
+
+            # @!attribute resource_id
+            #   The resource the consumption was attributed to
+            #
+            #   @return [String, nil]
+            optional :resource_id, String, api_name: :resourceId, nil?: true
+
+            # @!method initialize(amount:, currency_id:, customer_id:, timestamp:, credit: nil, resource_id: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Stigg::Models::V1::Credits::ConsumptionConsumeResponse::Data} for more details.
+            #
+            #   Result of a synchronous direct credit consumption
+            #
+            #   @param amount [Float] The amount of credits consumed
+            #
+            #   @param currency_id [String] The credit currency the credits were consumed from
+            #
+            #   @param customer_id [String] The customer the credits were consumed from
+            #
+            #   @param timestamp [Time] The timestamp the consumption was attributed to
+            #
+            #   @param credit [Stigg::Models::V1::Credits::ConsumptionConsumeResponse::Data::Credit, nil] The optimistic credit balance after consumption (when sync credit consumption is
+            #
+            #   @param resource_id [String, nil] The resource the consumption was attributed to
+
+            # @see Stigg::Models::V1::Credits::ConsumptionConsumeResponse::Data#credit
+            class Credit < Stigg::Internal::Type::BaseModel
+              # @!attribute currency_id
+              #   The credit currency identifier
+              #
+              #   @return [String]
+              required :currency_id, String, api_name: :currencyId
+
+              # @!attribute current_usage
+              #   The credits consumed (optimistic — includes not-yet-reconciled usage)
+              #
+              #   @return [Float]
+              required :current_usage, Float, api_name: :currentUsage
+
+              # @!attribute timestamp
+              #   The grant-version timestamp of this balance, used by the SDK for last-write-wins
+              #   reconciliation
+              #
+              #   @return [Time]
+              required :timestamp, Time
+
+              # @!attribute usage_limit
+              #   The total credits granted
+              #
+              #   @return [Float]
+              required :usage_limit, Float, api_name: :usageLimit
+
+              # @!attribute usage_period_end
+              #   End of the current credit grant period (when recurring credits reset), if
+              #   applicable
+              #
+              #   @return [Time, nil]
+              optional :usage_period_end, Time, api_name: :usagePeriodEnd, nil?: true
+
+              # @!method initialize(currency_id:, current_usage:, timestamp:, usage_limit:, usage_period_end: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {Stigg::Models::V1::Credits::ConsumptionConsumeResponse::Data::Credit} for more
+              #   details.
+              #
+              #   The optimistic credit balance after consumption (when sync credit consumption is
+              #   enabled)
+              #
+              #   @param currency_id [String] The credit currency identifier
+              #
+              #   @param current_usage [Float] The credits consumed (optimistic — includes not-yet-reconciled usage)
+              #
+              #   @param timestamp [Time] The grant-version timestamp of this balance, used by the SDK for last-write-wins
+              #
+              #   @param usage_limit [Float] The total credits granted
+              #
+              #   @param usage_period_end [Time, nil] End of the current credit grant period (when recurring credits reset), if applic
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stigg/resources/v1/credits/consumption.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Resources
+    class V1
+      class Credits
+        class Consumption
+          # Some parameter documentations has been truncated, see
+          # {Stigg::Models::V1::Credits::ConsumptionConsumeParams} for more details.
+          #
+          # Consumes a specified amount of credits directly from a customer wallet, with no
+          # feature mapping. Returns the optimistic balance.
+          #
+          # @overload consume(amount:, currency_id:, customer_id:, idempotency_key:, created_at: nil, dimensions: nil, resource_id: nil, x_account_id: nil, x_environment_id: nil, request_options: {})
+          #
+          # @param amount [Float] Body param: The amount of credits to consume
+          #
+          # @param currency_id [String] Body param: The credit currency to consume from (required)
+          #
+          # @param customer_id [String] Body param: The customer to consume credits from (required)
+          #
+          # @param idempotency_key [String] Body param: A unique key used to deduplicate the consumption (required)
+          #
+          # @param created_at [Time] Body param: Optional timestamp the consumption is attributed to
+          #
+          # @param dimensions [Hash{Symbol=>String, Float, Boolean}] Body param: Optional dimensions describing the consumption
+          #
+          # @param resource_id [String] Body param: Optional resource the consumption is attributed to
+          #
+          # @param x_account_id [String] Header param: Account ID — optional when authenticating with a user JWT (Bearer
+          #
+          # @param x_environment_id [String] Header param: Environment ID — required when authenticating with a user JWT (Bea
+          #
+          # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Stigg::Models::V1::Credits::ConsumptionConsumeResponse]
+          #
+          # @see Stigg::Models::V1::Credits::ConsumptionConsumeParams
+          def consume(params)
+            parsed, options = Stigg::V1::Credits::ConsumptionConsumeParams.dump_request(params)
+            header_params = {x_account_id: "x-account-id", x_environment_id: "x-environment-id"}
+            @client.request(
+              method: :post,
+              path: "api/v1/credits/consumption",
+              headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+              body: parsed.except(*header_params.keys),
+              model: Stigg::Models::V1::Credits::ConsumptionConsumeResponse,
+              options: options
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {Stigg::Models::V1::Credits::ConsumptionConsumeAsyncParams} for more details.
+          #
+          # Consumes credits directly from customer wallets asynchronously. Consumptions are
+          # reconciled asynchronously into the credit balances.
+          #
+          # @overload consume_async(consumptions:, x_account_id: nil, x_environment_id: nil, request_options: {})
+          #
+          # @param consumptions [Array<Stigg::Models::V1::Credits::ConsumptionConsumeAsyncParams::Consumption>] Body param: The credit consumptions to report (up to 1000)
+          #
+          # @param x_account_id [String] Header param: Account ID — optional when authenticating with a user JWT (Bearer
+          #
+          # @param x_environment_id [String] Header param: Environment ID — required when authenticating with a user JWT (Bea
+          #
+          # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [Stigg::Models::V1::Credits::ConsumptionConsumeAsyncResponse]
+          #
+          # @see Stigg::Models::V1::Credits::ConsumptionConsumeAsyncParams
+          def consume_async(params)
+            parsed, options = Stigg::V1::Credits::ConsumptionConsumeAsyncParams.dump_request(params)
+            header_params = {x_account_id: "x-account-id", x_environment_id: "x-environment-id"}
+            @client.request(
+              method: :post,
+              path: "api/v1/credits/consumption/async",
+              headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+              body: parsed.except(*header_params.keys),
+              model: Stigg::Models::V1::Credits::ConsumptionConsumeAsyncResponse,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [Stigg::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stigg/resources/v1/credits.rb

@@ -12,6 +12,9 @@ module Stigg
         # @return [Stigg::Resources::V1::Credits::CustomCurrencies]
         attr_reader :custom_currencies
 
+        # @return [Stigg::Resources::V1::Credits::Consumption]
+        attr_reader :consumption
+
         # Some parameter documentations has been truncated, see
         # {Stigg::Models::V1::CreditGetAutoRechargeParams} for more details.
         #
@@ -181,6 +184,7 @@ module Stigg
           @client = client
           @grants = Stigg::Resources::V1::Credits::Grants.new(client: client)
           @custom_currencies = Stigg::Resources::V1::Credits::CustomCurrencies.new(client: client)
+          @consumption = Stigg::Resources::V1::Credits::Consumption.new(client: client)
         end
       end
     end

data/lib/stigg/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stigg
-  VERSION = "0.1.0.pre.beta.34"
+  VERSION = "0.1.0.pre.beta.35"
 end

data/lib/stigg.rb

@@ -87,6 +87,10 @@ require_relative "stigg/models/v1/credit_get_usage_params"
 require_relative "stigg/models/v1/credit_get_usage_response"
 require_relative "stigg/models/v1/credit_list_ledger_params"
 require_relative "stigg/models/v1/credit_list_ledger_response"
+require_relative "stigg/models/v1/credits/consumption_consume_async_params"
+require_relative "stigg/models/v1/credits/consumption_consume_async_response"
+require_relative "stigg/models/v1/credits/consumption_consume_params"
+require_relative "stigg/models/v1/credits/consumption_consume_response"
 require_relative "stigg/models/v1/credits/credit_grant_response"
 require_relative "stigg/models/v1/credits/custom_currency_archive_params"
 require_relative "stigg/models/v1/credits/custom_currency_create_params"
@@ -241,6 +245,7 @@ require_relative "stigg/resources/v1/addons"
 require_relative "stigg/resources/v1/addons/entitlements"
 require_relative "stigg/resources/v1/coupons"
 require_relative "stigg/resources/v1/credits"
+require_relative "stigg/resources/v1/credits/consumption"
 require_relative "stigg/resources/v1/credits/custom_currencies"
 require_relative "stigg/resources/v1/credits/grants"
 require_relative "stigg/resources/v1/customers"