stigg 0.1.0.pre.alpha.1 → 0.1.0.pre.alpha.2

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

@@ -7,29 +7,59 @@ module Stigg
         # @return [Stigg::Resources::V1::Subscriptions::FutureUpdate]
         attr_reader :future_update
 
-        # Create a new Subscription
+        # Provision subscription
         #
-        # @overload create(customer_id:, plan_id:, id: nil, await_payment_confirmation: nil, billing_period: nil, checkout_options: nil, metadata: nil, paying_customer_id: nil, resource_id: nil, trial_override_configuration: nil, request_options: {})
+        # @overload create(customer_id:, plan_id:, id: nil, addons: nil, applied_coupon: nil, await_payment_confirmation: nil, billing_country_code: nil, billing_id: nil, billing_information: nil, billing_period: nil, budget: nil, charges: nil, checkout_options: nil, metadata: nil, minimum_spend: nil, paying_customer_id: nil, payment_collection_method: nil, price_overrides: nil, resource_id: nil, salesforce_id: nil, schedule_strategy: nil, start_date: nil, subscription_entitlements: nil, trial_override_configuration: nil, unit_quantity: nil, request_options: {})
         #
         # @param customer_id [String] Customer ID to provision the subscription for
         #
         # @param plan_id [String] Plan ID to provision
         #
-        # @param id [String, nil] Unique identifier for the subscription
+        # @param id [String] Unique identifier for the subscription
+        #
+        # @param addons [Array<Stigg::Models::V1::SubscriptionCreateParams::Addon>]
+        #
+        # @param applied_coupon [Stigg::Models::V1::SubscriptionCreateParams::AppliedCoupon] Coupon configuration
         #
         # @param await_payment_confirmation [Boolean] Whether to wait for payment confirmation before returning the subscription
         #
-        # @param billing_period [Symbol, Stigg::Models::V1::SubscriptionCreateParams::BillingPeriod]
+        # @param billing_country_code [String, nil] The ISO 3166-1 alpha-2 country code for billing
+        #
+        # @param billing_id [String, nil] External billing system identifier
+        #
+        # @param billing_information [Stigg::Models::V1::SubscriptionCreateParams::BillingInformation]
+        #
+        # @param billing_period [Symbol, Stigg::Models::V1::SubscriptionCreateParams::BillingPeriod] Billing period (MONTHLY or ANNUALLY)
+        #
+        # @param budget [Stigg::Models::V1::SubscriptionCreateParams::Budget, nil]
+        #
+        # @param charges [Array<Stigg::Models::V1::SubscriptionCreateParams::Charge>]
         #
-        # @param checkout_options [Stigg::Models::V1::SubscriptionCreateParams::CheckoutOptions]
+        # @param checkout_options [Stigg::Models::V1::SubscriptionCreateParams::CheckoutOptions] Checkout page configuration for payment collection
         #
         # @param metadata [Hash{Symbol=>String}] Additional metadata for the subscription
         #
+        # @param minimum_spend [Stigg::Models::V1::SubscriptionCreateParams::MinimumSpend, nil]
+        #
         # @param paying_customer_id [String, nil] Optional paying customer ID for split billing scenarios
         #
+        # @param payment_collection_method [Symbol, Stigg::Models::V1::SubscriptionCreateParams::PaymentCollectionMethod] How payments should be collected for this subscription
+        #
+        # @param price_overrides [Array<Stigg::Models::V1::SubscriptionCreateParams::PriceOverride>]
+        #
         # @param resource_id [String, nil] Optional resource ID for multi-instance subscriptions
         #
-        # @param trial_override_configuration [Stigg::Models::V1::SubscriptionCreateParams::TrialOverrideConfiguration]
+        # @param salesforce_id [String, nil] Salesforce ID
+        #
+        # @param schedule_strategy [Symbol, Stigg::Models::V1::SubscriptionCreateParams::ScheduleStrategy] Strategy for scheduling subscription changes
+        #
+        # @param start_date [Time] Subscription start date
+        #
+        # @param subscription_entitlements [Array<Stigg::Models::V1::SubscriptionCreateParams::SubscriptionEntitlement>]
+        #
+        # @param trial_override_configuration [Stigg::Models::V1::SubscriptionCreateParams::TrialOverrideConfiguration] Trial period override settings
+        #
+        # @param unit_quantity [Float]
         #
         # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -47,11 +77,12 @@ module Stigg
           )
         end
 
-        # Get a single Subscription by id
+        # Get a single subscription by ID
         #
         # @overload retrieve(id, request_options: {})
         #
-        # @param id [String]
+        # @param id [String] The unique identifier of the entity
+        #
         # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [Stigg::Models::V1::SubscriptionRetrieveResponse]
@@ -66,26 +97,23 @@ module Stigg
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {Stigg::Models::V1::SubscriptionListParams} for more details.
-        #
-        # Get a list of Subscriptions
+        # Get a list of subscriptions
         #
-        # @overload list(customer_id: nil, ending_before: nil, limit: nil, starting_after: nil, status: nil, request_options: {})
+        # @overload list(after: nil, before: nil, customer_id: nil, limit: nil, status: nil, request_options: {})
         #
-        # @param customer_id [String] Filter by customer ID
+        # @param after [String] Return items that come after this cursor
         #
-        # @param ending_before [String] Ending before this UUID for pagination
+        # @param before [String] Return items that come before this cursor
         #
-        # @param limit [Integer] Items per page
+        # @param customer_id [String] Filter by customer ID
         #
-        # @param starting_after [String] Starting after this UUID for pagination
+        # @param limit [Integer] Maximum number of items to return
         #
-        # @param status [String] Filter by subscription status (comma-separated for multiple statuses, e.g., ACTI
+        # @param status [String] Filter by status (comma-separated)
         #
         # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
         #
-        # @return [Stigg::Models::V1::SubscriptionListResponse]
+        # @return [Stigg::Internal::MyCursorIDPage<Stigg::Models::V1::SubscriptionListResponse>]
         #
         # @see Stigg::Models::V1::SubscriptionListParams
         def list(params = {})
@@ -93,23 +121,23 @@ module Stigg
           @client.request(
             method: :get,
             path: "api/v1/subscriptions",
-            query: parsed.transform_keys(
-              customer_id: "customerId",
-              ending_before: "endingBefore",
-              starting_after: "startingAfter"
-            ),
+            query: parsed.transform_keys(customer_id: "customerId"),
+            page: Stigg::Internal::MyCursorIDPage,
             model: Stigg::Models::V1::SubscriptionListResponse,
             options: options
           )
         end
 
-        # Perform delegate on a Subscription
+        # Some parameter documentations has been truncated, see
+        # {Stigg::Models::V1::SubscriptionDelegateParams} for more details.
+        #
+        # Delegate subscription payment to customer
         #
         # @overload delegate(id, target_customer_id:, request_options: {})
         #
-        # @param id [String]
+        # @param id [String] The unique identifier of the entity
         #
-        # @param target_customer_id [String] The customer ID to delegate the subscription to
+        # @param target_customer_id [String] The unique identifier of the customer who will assume payment responsibility for
         #
         # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -127,13 +155,13 @@ module Stigg
           )
         end
 
-        # Perform migrate to latest plan version on a Subscription
+        # Migrate subscription to latest plan version
         #
         # @overload migrate(id, subscription_migration_time: nil, request_options: {})
         #
-        # @param id [String]
+        # @param id [String] The unique identifier of the entity
         #
-        # @param subscription_migration_time [Symbol, Stigg::Models::V1::SubscriptionMigrateParams::SubscriptionMigrationTime] When to migrate the subscription: IMMEDIATE or END_OF_BILLING_PERIOD
+        # @param subscription_migration_time [Symbol, Stigg::Models::V1::SubscriptionMigrateParams::SubscriptionMigrationTime] When to migrate (immediate or period end)
         #
         # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -151,7 +179,7 @@ module Stigg
           )
         end
 
-        # Create a new Subscription Preview
+        # Preview subscription
         #
         # @overload preview(customer_id:, plan_id:, addons: nil, applied_coupon: nil, billable_features: nil, billing_country_code: nil, billing_information: nil, billing_period: nil, charges: nil, paying_customer_id: nil, resource_id: nil, schedule_strategy: nil, start_date: nil, trial_override_configuration: nil, unit_quantity: nil, request_options: {})
         #
@@ -159,31 +187,31 @@ module Stigg
         #
         # @param plan_id [String] Plan ID
         #
-        # @param addons [Array<Stigg::Models::V1::SubscriptionPreviewParams::Addon>]
+        # @param addons [Array<Stigg::Models::V1::SubscriptionPreviewParams::Addon>] Addons to include
         #
-        # @param applied_coupon [Stigg::Models::V1::SubscriptionPreviewParams::AppliedCoupon]
+        # @param applied_coupon [Stigg::Models::V1::SubscriptionPreviewParams::AppliedCoupon] Coupon or discount to apply
         #
-        # @param billable_features [Array<Stigg::Models::V1::SubscriptionPreviewParams::BillableFeature>]
+        # @param billable_features [Array<Stigg::Models::V1::SubscriptionPreviewParams::BillableFeature>] Billable features with quantities
         #
-        # @param billing_country_code [String]
+        # @param billing_country_code [String] ISO 3166-1 country code for localization
         #
-        # @param billing_information [Stigg::Models::V1::SubscriptionPreviewParams::BillingInformation]
+        # @param billing_information [Stigg::Models::V1::SubscriptionPreviewParams::BillingInformation] Billing and tax configuration
         #
-        # @param billing_period [Symbol, Stigg::Models::V1::SubscriptionPreviewParams::BillingPeriod]
+        # @param billing_period [Symbol, Stigg::Models::V1::SubscriptionPreviewParams::BillingPeriod] Billing period (MONTHLY or ANNUALLY)
         #
-        # @param charges [Array<Stigg::Models::V1::SubscriptionPreviewParams::Charge>]
+        # @param charges [Array<Stigg::Models::V1::SubscriptionPreviewParams::Charge>] One-time or recurring charges
         #
-        # @param paying_customer_id [String]
+        # @param paying_customer_id [String] Paying customer ID for delegated billing
         #
-        # @param resource_id [String]
+        # @param resource_id [String] Resource ID for multi-instance subscriptions
         #
-        # @param schedule_strategy [Symbol, Stigg::Models::V1::SubscriptionPreviewParams::ScheduleStrategy]
+        # @param schedule_strategy [Symbol, Stigg::Models::V1::SubscriptionPreviewParams::ScheduleStrategy] When to apply subscription changes
         #
         # @param start_date [Time] Subscription start date
         #
-        # @param trial_override_configuration [Stigg::Models::V1::SubscriptionPreviewParams::TrialOverrideConfiguration]
+        # @param trial_override_configuration [Stigg::Models::V1::SubscriptionPreviewParams::TrialOverrideConfiguration] Trial period override settings
         #
-        # @param unit_quantity [Float]
+        # @param unit_quantity [Float] Unit quantity for per-unit pricing
         #
         # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -201,16 +229,13 @@ module Stigg
           )
         end
 
-        # Some parameter documentations has been truncated, see
-        # {Stigg::Models::V1::SubscriptionTransferParams} for more details.
-        #
-        # Perform transfer to resource on a Subscription
+        # Transfer subscription to resource
         #
         # @overload transfer(id, destination_resource_id:, request_options: {})
         #
-        # @param id [String]
+        # @param id [String] The unique identifier of the entity
         #
-        # @param destination_resource_id [String] The resource ID to transfer the subscription to. The destination resource must b
+        # @param destination_resource_id [String] Resource ID to transfer the subscription to
         #
         # @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}, nil]
         #

data/lib/stigg/resources/v1.rb

@@ -12,7 +12,7 @@ module Stigg
       # @return [Stigg::Resources::V1::Coupons]
       attr_reader :coupons
 
-      # Create events
+      # Report usage events
       #
       # @overload create_event(events:, request_options: {})
       #
@@ -34,7 +34,7 @@ module Stigg
         )
       end
 
-      # Create a new Usage
+      # Report usage measurements
       #
       # @overload create_usage(usages:, request_options: {})
       #

data/lib/stigg/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Stigg
-  VERSION = "0.1.0.pre.alpha.1"
+  VERSION = "0.1.0.pre.alpha.2"
 end

data/lib/stigg.rb

@@ -67,12 +67,6 @@ require_relative "stigg/models/v1/customer_response"
 require_relative "stigg/models/v1/customer_retrieve_params"
 require_relative "stigg/models/v1/customers/payment_method_attach_params"
 require_relative "stigg/models/v1/customers/payment_method_detach_params"
-require_relative "stigg/models/v1/customers/promotional_create_params"
-require_relative "stigg/models/v1/customers/promotional_create_response"
-require_relative "stigg/models/v1/customers/promotional_revoke_params"
-require_relative "stigg/models/v1/customers/promotional_revoke_response"
-require_relative "stigg/models/v1/customers/usage_retrieve_params"
-require_relative "stigg/models/v1/customers/usage_retrieve_response"
 require_relative "stigg/models/v1/customer_unarchive_params"
 require_relative "stigg/models/v1/customer_update_params"
 require_relative "stigg/models/v1/subscription_create_params"
@@ -102,7 +96,6 @@ require_relative "stigg/resources/v1"
 require_relative "stigg/resources/v1/coupons"
 require_relative "stigg/resources/v1/customers"
 require_relative "stigg/resources/v1/customers/payment_method"
-require_relative "stigg/resources/v1/customers/promotional"
 require_relative "stigg/resources/v1/customers/usage"
 require_relative "stigg/resources/v1/subscriptions"
 require_relative "stigg/resources/v1/subscriptions/future_update"

data/rbi/stigg/internal/my_cursor_id_page.rbi

@@ -10,10 +10,37 @@ module Stigg
       sig { returns(T.nilable(T::Array[Elem])) }
       attr_accessor :data
 
+      sig { returns(Pagination) }
+      attr_accessor :pagination
+
       # @api private
       sig { returns(String) }
       def inspect
       end
+
+      class Pagination < Stigg::Internal::Type::BaseModel
+        OrHash = T.type_alias { T.any(Pagination, Stigg::Internal::AnyHash) }
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :next_
+
+        sig { params(next_: String).void }
+        attr_writer :next_
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :prev
+
+        sig { params(prev: String).void }
+        attr_writer :prev
+
+        sig { params(next_: String, prev: String).returns(T.attached_class) }
+        def self.new(next_: nil, prev: nil)
+        end
+
+        sig { override.returns({ next_: String, prev: String }) }
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/stigg/models/v1/coupon_create_params.rbi

@@ -120,6 +120,7 @@ module Stigg
           end
           attr_accessor :currency
 
+          # Monetary amount with currency
           sig do
             params(
               amount: Float,

data/rbi/stigg/models/v1/coupon_create_response.rbi

@@ -12,6 +12,7 @@ module Stigg
             )
           end
 
+        # Discount instrument with percentage or fixed amount
         sig { returns(Stigg::Models::V1::CouponCreateResponse::Data) }
         attr_reader :data
 
@@ -22,12 +23,16 @@ module Stigg
         end
         attr_writer :data
 
+        # Response object
         sig do
           params(
             data: Stigg::Models::V1::CouponCreateResponse::Data::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(data:)
+        def self.new(
+          # Discount instrument with percentage or fixed amount
+          data:
+        )
         end
 
         sig do
@@ -121,6 +126,7 @@ module Stigg
           sig { returns(Time) }
           attr_accessor :updated_at
 
+          # Discount instrument with percentage or fixed amount
           sig do
             params(
               id: String,
@@ -226,20 +232,17 @@ module Stigg
             # The price currency
             sig do
               returns(
-                T.nilable(
-                  Stigg::Models::V1::CouponCreateResponse::Data::AmountsOff::Currency::TaggedSymbol
-                )
+                Stigg::Models::V1::CouponCreateResponse::Data::AmountsOff::Currency::TaggedSymbol
               )
             end
             attr_accessor :currency
 
+            # Monetary amount with currency
             sig do
               params(
                 amount: Float,
                 currency:
-                  T.nilable(
-                    Stigg::Models::V1::CouponCreateResponse::Data::AmountsOff::Currency::OrSymbol
-                  )
+                  Stigg::Models::V1::CouponCreateResponse::Data::AmountsOff::Currency::OrSymbol
               ).returns(T.attached_class)
             end
             def self.new(
@@ -255,9 +258,7 @@ module Stigg
                 {
                   amount: Float,
                   currency:
-                    T.nilable(
-                      Stigg::Models::V1::CouponCreateResponse::Data::AmountsOff::Currency::TaggedSymbol
-                    )
+                    Stigg::Models::V1::CouponCreateResponse::Data::AmountsOff::Currency::TaggedSymbol
                 }
               )
             end

data/rbi/stigg/models/v1/coupon_list_params.rbi

@@ -12,42 +12,42 @@ module Stigg
             T.any(Stigg::V1::CouponListParams, Stigg::Internal::AnyHash)
           end
 
-        # Ending before this UUID for pagination
+        # Return items that come after this cursor
         sig { returns(T.nilable(String)) }
-        attr_reader :ending_before
+        attr_reader :after
 
-        sig { params(ending_before: String).void }
-        attr_writer :ending_before
+        sig { params(after: String).void }
+        attr_writer :after
 
-        # Items per page
+        # Return items that come before this cursor
+        sig { returns(T.nilable(String)) }
+        attr_reader :before
+
+        sig { params(before: String).void }
+        attr_writer :before
+
+        # Maximum number of items to return
         sig { returns(T.nilable(Integer)) }
         attr_reader :limit
 
         sig { params(limit: Integer).void }
         attr_writer :limit
 
-        # Starting after this UUID for pagination
-        sig { returns(T.nilable(String)) }
-        attr_reader :starting_after
-
-        sig { params(starting_after: String).void }
-        attr_writer :starting_after
-
         sig do
           params(
-            ending_before: String,
+            after: String,
+            before: String,
             limit: Integer,
-            starting_after: String,
             request_options: Stigg::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
-          # Ending before this UUID for pagination
-          ending_before: nil,
-          # Items per page
+          # Return items that come after this cursor
+          after: nil,
+          # Return items that come before this cursor
+          before: nil,
+          # Maximum number of items to return
           limit: nil,
-          # Starting after this UUID for pagination
-          starting_after: nil,
           request_options: {}
         )
         end
@@ -55,9 +55,9 @@ module Stigg
         sig do
           override.returns(
             {
-              ending_before: String,
+              after: String,
+              before: String,
               limit: Integer,
-              starting_after: String,
               request_options: Stigg::RequestOptions
             }
           )