stigg 0.1.0.pre.alpha.1 → 0.1.0.pre.alpha.3

data/rbi/stigg/resources/v1/subscriptions.rbi

@@ -7,118 +7,193 @@ module Stigg
         sig { returns(Stigg::Resources::V1::Subscriptions::FutureUpdate) }
         attr_reader :future_update
 
-        # Create a new Subscription
+        # Get a single subscription by ID
         sig do
           params(
-            customer_id: String,
-            plan_id: String,
-            id: T.nilable(String),
-            await_payment_confirmation: T::Boolean,
-            billing_period:
-              Stigg::V1::SubscriptionCreateParams::BillingPeriod::OrSymbol,
-            checkout_options:
-              Stigg::V1::SubscriptionCreateParams::CheckoutOptions::OrHash,
-            metadata: T::Hash[Symbol, String],
-            paying_customer_id: T.nilable(String),
-            resource_id: T.nilable(String),
-            trial_override_configuration:
-              Stigg::V1::SubscriptionCreateParams::TrialOverrideConfiguration::OrHash,
+            id: String,
             request_options: Stigg::RequestOptions::OrHash
-          ).returns(Stigg::Models::V1::SubscriptionCreateResponse)
+          ).returns(Stigg::V1::Subscription)
         end
-        def create(
-          # Customer ID to provision the subscription for
-          customer_id:,
-          # Plan ID to provision
-          plan_id:,
-          # Unique identifier for the subscription
-          id: nil,
-          # Whether to wait for payment confirmation before returning the subscription
-          await_payment_confirmation: nil,
-          billing_period: nil,
-          checkout_options: nil,
-          # Additional metadata for the subscription
-          metadata: nil,
-          # Optional paying customer ID for split billing scenarios
-          paying_customer_id: nil,
-          # Optional resource ID for multi-instance subscriptions
-          resource_id: nil,
-          trial_override_configuration: nil,
+        def retrieve(
+          # The unique identifier of the entity
+          id,
           request_options: {}
         )
         end
 
-        # Get a single Subscription by id
+        # Update a subscription
         sig do
           params(
             id: String,
+            addons:
+              T::Array[Stigg::V1::SubscriptionUpdateParams::Addon::OrHash],
+            applied_coupon:
+              Stigg::V1::SubscriptionUpdateParams::AppliedCoupon::OrHash,
+            await_payment_confirmation: T::Boolean,
+            billing_information:
+              Stigg::V1::SubscriptionUpdateParams::BillingInformation::OrHash,
+            billing_period:
+              Stigg::V1::SubscriptionUpdateParams::BillingPeriod::OrSymbol,
+            budget:
+              T.nilable(Stigg::V1::SubscriptionUpdateParams::Budget::OrHash),
+            charges:
+              T::Array[Stigg::V1::SubscriptionUpdateParams::Charge::OrHash],
+            metadata: T::Hash[Symbol, String],
+            minimum_spend:
+              T.nilable(
+                Stigg::V1::SubscriptionUpdateParams::MinimumSpend::OrHash
+              ),
+            price_overrides:
+              T::Array[
+                Stigg::V1::SubscriptionUpdateParams::PriceOverride::OrHash
+              ],
+            promotion_code: String,
+            schedule_strategy:
+              Stigg::V1::SubscriptionUpdateParams::ScheduleStrategy::OrSymbol,
+            subscription_entitlements:
+              T::Array[
+                Stigg::V1::SubscriptionUpdateParams::SubscriptionEntitlement::OrHash
+              ],
+            trial_end_date: Time,
             request_options: Stigg::RequestOptions::OrHash
-          ).returns(Stigg::Models::V1::SubscriptionRetrieveResponse)
+          ).returns(Stigg::V1::Subscription)
         end
-        def retrieve(id, request_options: {})
+        def update(
+          # The unique identifier of the entity
+          id,
+          addons: nil,
+          applied_coupon: nil,
+          await_payment_confirmation: nil,
+          billing_information: nil,
+          billing_period: nil,
+          budget: nil,
+          charges: nil,
+          # Additional metadata for the subscription
+          metadata: nil,
+          minimum_spend: nil,
+          price_overrides: nil,
+          promotion_code: nil,
+          schedule_strategy: nil,
+          subscription_entitlements: nil,
+          # Subscription trial end date
+          trial_end_date: nil,
+          request_options: {}
+        )
         end
 
-        # Get a list of Subscriptions
+        # Get a list of subscriptions
         sig do
           params(
+            after: String,
+            before: String,
             customer_id: String,
-            ending_before: String,
             limit: Integer,
-            starting_after: String,
             status: String,
             request_options: Stigg::RequestOptions::OrHash
-          ).returns(Stigg::Models::V1::SubscriptionListResponse)
+          ).returns(
+            Stigg::Internal::MyCursorIDPage[
+              Stigg::Models::V1::SubscriptionListResponse
+            ]
+          )
         end
         def list(
+          # Return items that come after this cursor
+          after: nil,
+          # Return items that come before this cursor
+          before: nil,
           # Filter by customer ID
           customer_id: nil,
-          # Ending before this UUID for pagination
-          ending_before: nil,
-          # Items per page
+          # Maximum number of items to return
           limit: nil,
-          # Starting after this UUID for pagination
-          starting_after: nil,
-          # Filter by subscription status (comma-separated for multiple statuses, e.g.,
-          # ACTIVE,IN_TRIAL)
+          # Filter by status (comma-separated)
           status: nil,
           request_options: {}
         )
         end
 
-        # Perform delegate on a Subscription
+        # Cancel subscription
+        sig do
+          params(
+            id: String,
+            cancellation_action:
+              Stigg::V1::SubscriptionCancelParams::CancellationAction::OrSymbol,
+            cancellation_time:
+              Stigg::V1::SubscriptionCancelParams::CancellationTime::OrSymbol,
+            end_date: Time,
+            prorate: T::Boolean,
+            request_options: Stigg::RequestOptions::OrHash
+          ).returns(Stigg::V1::Subscription)
+        end
+        def cancel(
+          # The unique identifier of the entity
+          id,
+          # Action on cancellation (downgrade or revoke)
+          cancellation_action: nil,
+          # When to cancel (immediate, period end, or date)
+          cancellation_time: nil,
+          # Subscription end date
+          end_date: nil,
+          # If set, enables or disables prorating of credits on subscription cancellation.
+          prorate: nil,
+          request_options: {}
+        )
+        end
+
+        # Delegate subscription payment to customer
         sig do
           params(
             id: String,
             target_customer_id: String,
             request_options: Stigg::RequestOptions::OrHash
-          ).returns(Stigg::Models::V1::SubscriptionDelegateResponse)
+          ).returns(Stigg::V1::Subscription)
         end
         def delegate(
+          # The unique identifier of the entity
           id,
-          # The customer ID to delegate the subscription to
+          # The unique identifier of the customer who will assume payment responsibility for
+          # this subscription. This customer must already exist in your Stigg account and
+          # have a valid payment method if the subscription requires payment.
           target_customer_id:,
           request_options: {}
         )
         end
 
-        # Perform migrate to latest plan version on a Subscription
+        # Bulk import subscriptions
+        sig do
+          params(
+            subscriptions:
+              T::Array[
+                Stigg::V1::SubscriptionImportParams::Subscription::OrHash
+              ],
+            request_options: Stigg::RequestOptions::OrHash
+          ).returns(Stigg::Models::V1::SubscriptionImportResponse)
+        end
+        def import(
+          # List of subscription objects to import
+          subscriptions:,
+          request_options: {}
+        )
+        end
+
+        # Migrate subscription to latest plan version
         sig do
           params(
             id: String,
             subscription_migration_time:
               Stigg::V1::SubscriptionMigrateParams::SubscriptionMigrationTime::OrSymbol,
             request_options: Stigg::RequestOptions::OrHash
-          ).returns(Stigg::Models::V1::SubscriptionMigrateResponse)
+          ).returns(Stigg::V1::Subscription)
         end
         def migrate(
+          # The unique identifier of the entity
           id,
-          # When to migrate the subscription: IMMEDIATE or END_OF_BILLING_PERIOD
+          # When to migrate (immediate or period end)
           subscription_migration_time: nil,
           request_options: {}
         )
         end
 
-        # Create a new Subscription Preview
+        # Preview subscription
         sig do
           params(
             customer_id: String,
@@ -154,36 +229,145 @@ module Stigg
           customer_id:,
           # Plan ID
           plan_id:,
+          # Addons to include
           addons: nil,
+          # Coupon or discount to apply
           applied_coupon: nil,
+          # Billable features with quantities
           billable_features: nil,
+          # ISO 3166-1 country code for localization
           billing_country_code: nil,
+          # Billing and tax configuration
           billing_information: nil,
+          # Billing period (MONTHLY or ANNUALLY)
           billing_period: nil,
+          # One-time or recurring charges
           charges: nil,
+          # Paying customer ID for delegated billing
           paying_customer_id: nil,
+          # Resource ID for multi-instance subscriptions
+          resource_id: nil,
+          # When to apply subscription changes
+          schedule_strategy: nil,
+          # Subscription start date
+          start_date: nil,
+          # Trial period override settings
+          trial_override_configuration: nil,
+          # Unit quantity for per-unit pricing
+          unit_quantity: nil,
+          request_options: {}
+        )
+        end
+
+        # Provision subscription
+        sig do
+          params(
+            customer_id: String,
+            plan_id: String,
+            id: String,
+            addons:
+              T::Array[Stigg::V1::SubscriptionProvisionParams::Addon::OrHash],
+            applied_coupon:
+              Stigg::V1::SubscriptionProvisionParams::AppliedCoupon::OrHash,
+            await_payment_confirmation: T::Boolean,
+            billing_country_code: T.nilable(String),
+            billing_id: T.nilable(String),
+            billing_information:
+              Stigg::V1::SubscriptionProvisionParams::BillingInformation::OrHash,
+            billing_period:
+              Stigg::V1::SubscriptionProvisionParams::BillingPeriod::OrSymbol,
+            budget:
+              T.nilable(Stigg::V1::SubscriptionProvisionParams::Budget::OrHash),
+            charges:
+              T::Array[Stigg::V1::SubscriptionProvisionParams::Charge::OrHash],
+            checkout_options:
+              Stigg::V1::SubscriptionProvisionParams::CheckoutOptions::OrHash,
+            metadata: T::Hash[Symbol, String],
+            minimum_spend:
+              T.nilable(
+                Stigg::V1::SubscriptionProvisionParams::MinimumSpend::OrHash
+              ),
+            paying_customer_id: T.nilable(String),
+            payment_collection_method:
+              Stigg::V1::SubscriptionProvisionParams::PaymentCollectionMethod::OrSymbol,
+            price_overrides:
+              T::Array[
+                Stigg::V1::SubscriptionProvisionParams::PriceOverride::OrHash
+              ],
+            resource_id: T.nilable(String),
+            salesforce_id: T.nilable(String),
+            schedule_strategy:
+              Stigg::V1::SubscriptionProvisionParams::ScheduleStrategy::OrSymbol,
+            start_date: Time,
+            subscription_entitlements:
+              T::Array[
+                Stigg::V1::SubscriptionProvisionParams::SubscriptionEntitlement::OrHash
+              ],
+            trial_override_configuration:
+              Stigg::V1::SubscriptionProvisionParams::TrialOverrideConfiguration::OrHash,
+            unit_quantity: Float,
+            request_options: Stigg::RequestOptions::OrHash
+          ).returns(Stigg::Models::V1::SubscriptionProvisionResponse)
+        end
+        def provision(
+          # Customer ID to provision the subscription for
+          customer_id:,
+          # Plan ID to provision
+          plan_id:,
+          # Unique identifier for the subscription
+          id: nil,
+          addons: nil,
+          # Coupon configuration
+          applied_coupon: nil,
+          # Whether to wait for payment confirmation before returning the subscription
+          await_payment_confirmation: nil,
+          # The ISO 3166-1 alpha-2 country code for billing
+          billing_country_code: nil,
+          # External billing system identifier
+          billing_id: nil,
+          billing_information: nil,
+          # Billing period (MONTHLY or ANNUALLY)
+          billing_period: nil,
+          budget: nil,
+          charges: nil,
+          # Checkout page configuration for payment collection
+          checkout_options: nil,
+          # Additional metadata for the subscription
+          metadata: nil,
+          minimum_spend: nil,
+          # Optional paying customer ID for split billing scenarios
+          paying_customer_id: nil,
+          # How payments should be collected for this subscription
+          payment_collection_method: nil,
+          price_overrides: nil,
+          # Optional resource ID for multi-instance subscriptions
           resource_id: nil,
+          # Salesforce ID
+          salesforce_id: nil,
+          # Strategy for scheduling subscription changes
           schedule_strategy: nil,
           # Subscription start date
           start_date: nil,
+          subscription_entitlements: nil,
+          # Trial period override settings
           trial_override_configuration: nil,
           unit_quantity: nil,
           request_options: {}
         )
         end
 
-        # Perform transfer to resource on a Subscription
+        # Transfer subscription to resource
         sig do
           params(
             id: String,
             destination_resource_id: String,
             request_options: Stigg::RequestOptions::OrHash
-          ).returns(Stigg::Models::V1::SubscriptionTransferResponse)
+          ).returns(Stigg::V1::Subscription)
         end
         def transfer(
+          # The unique identifier of the entity
           id,
-          # The resource ID to transfer the subscription to. The destination resource must
-          # belong to the same customer.
+          # Resource ID to transfer the subscription to
           destination_resource_id:,
           request_options: {}
         )

data/rbi/stigg/resources/v1/usage.rbi

@@ -0,0 +1,57 @@
+# typed: strong
+
+module Stigg
+  module Resources
+    class V1
+      class Usage
+        # Get usage history
+        sig do
+          params(
+            feature_id: String,
+            customer_id: String,
+            start_date: Time,
+            end_date: Time,
+            group_by: String,
+            resource_id: T.nilable(String),
+            request_options: Stigg::RequestOptions::OrHash
+          ).returns(Stigg::Models::V1::UsageHistoryResponse)
+        end
+        def history(
+          # Path param: Feature id
+          feature_id,
+          # Path param: Customer id
+          customer_id:,
+          # Query param: The start date of the range
+          start_date:,
+          # Query param: The end date of the range
+          end_date: nil,
+          # Query param
+          group_by: nil,
+          # Query param: Resource id
+          resource_id: nil,
+          request_options: {}
+        )
+        end
+
+        # Report usage measurements
+        sig do
+          params(
+            usages: T::Array[Stigg::V1::UsageReportParams::Usage::OrHash],
+            request_options: Stigg::RequestOptions::OrHash
+          ).returns(Stigg::Models::V1::UsageReportResponse)
+        end
+        def report(
+          # A list of usage reports to be submitted in bulk
+          usages:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Stigg::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/stigg/resources/v1.rbi

@@ -12,33 +12,11 @@ module Stigg
       sig { returns(Stigg::Resources::V1::Coupons) }
       attr_reader :coupons
 
-      # Create events
-      sig do
-        params(
-          events: T::Array[Stigg::V1CreateEventParams::Event::OrHash],
-          request_options: Stigg::RequestOptions::OrHash
-        ).returns(Stigg::Models::V1CreateEventResponse)
-      end
-      def create_event(
-        # A list of usage events to report
-        events:,
-        request_options: {}
-      )
-      end
+      sig { returns(Stigg::Resources::V1::Events) }
+      attr_reader :events
 
-      # Create a new Usage
-      sig do
-        params(
-          usages: T::Array[Stigg::V1CreateUsageParams::Usage::OrHash],
-          request_options: Stigg::RequestOptions::OrHash
-        ).returns(Stigg::Models::V1CreateUsageResponse)
-      end
-      def create_usage(
-        # A list of usage reports to be submitted in bulk
-        usages:,
-        request_options: {}
-      )
-      end
+      sig { returns(Stigg::Resources::V1::Usage) }
+      attr_reader :usage
 
       # @api private
       sig { params(client: Stigg::Client).returns(T.attached_class) }

data/sig/stigg/internal/my_cursor_id_page.rbs

@@ -5,7 +5,24 @@ module Stigg
 
       attr_accessor data: ::Array[Elem]?
 
+      attr_accessor pagination: Pagination
+
       def inspect: -> String
+
+      type pagination = { next_: String, prev: String }
+      class Pagination < Stigg::Internal::Type::BaseModel
+        attr_reader next_: String?
+
+        def next_=: (String) -> String
+
+        attr_reader prev: String?
+
+        def prev=: (String) -> String
+
+        def initialize: (?next_: String, ?prev: String) -> void
+
+        def to_hash: -> { next_: String, prev: String }
+      end
     end
   end
 end

data/sig/stigg/models/v1/{coupon_create_response.rbs → coupon.rbs}

@@ -1,22 +1,19 @@
 module Stigg
   module Models
     module V1
-      type coupon_create_response =
-        { data: Stigg::Models::V1::CouponCreateResponse::Data }
+      type coupon = { data: Stigg::V1::Coupon::Data }
 
-      class CouponCreateResponse < Stigg::Internal::Type::BaseModel
-        attr_accessor data: Stigg::Models::V1::CouponCreateResponse::Data
+      class Coupon < Stigg::Internal::Type::BaseModel
+        attr_accessor data: Stigg::V1::Coupon::Data
 
-        def initialize: (
-          data: Stigg::Models::V1::CouponCreateResponse::Data
-        ) -> void
+        def initialize: (data: Stigg::V1::Coupon::Data) -> void
 
-        def to_hash: -> { data: Stigg::Models::V1::CouponCreateResponse::Data }
+        def to_hash: -> { data: Stigg::V1::Coupon::Data }
 
         type data =
           {
             id: String,
-            amounts_off: ::Array[Stigg::Models::V1::CouponCreateResponse::Data::AmountsOff]?,
+            amounts_off: ::Array[Stigg::V1::Coupon::Data::AmountsOff]?,
             billing_id: String?,
             billing_link_url: String?,
             created_at: Time,
@@ -24,16 +21,16 @@ module Stigg
             duration_in_months: Float?,
             name: String,
             percent_off: Float?,
-            source: Stigg::Models::V1::CouponCreateResponse::Data::source?,
-            status: Stigg::Models::V1::CouponCreateResponse::Data::status,
-            type: Stigg::Models::V1::CouponCreateResponse::Data::type_,
+            source: Stigg::Models::V1::Coupon::Data::source?,
+            status: Stigg::Models::V1::Coupon::Data::status,
+            type: Stigg::Models::V1::Coupon::Data::type_,
             updated_at: Time
           }
 
         class Data < Stigg::Internal::Type::BaseModel
           attr_accessor id: String
 
-          attr_accessor amounts_off: ::Array[Stigg::Models::V1::CouponCreateResponse::Data::AmountsOff]?
+          attr_accessor amounts_off: ::Array[Stigg::V1::Coupon::Data::AmountsOff]?
 
           attr_accessor billing_id: String?
 
@@ -49,17 +46,17 @@ module Stigg
 
           attr_accessor percent_off: Float?
 
-          attr_accessor source: Stigg::Models::V1::CouponCreateResponse::Data::source?
+          attr_accessor source: Stigg::Models::V1::Coupon::Data::source?
 
-          attr_accessor status: Stigg::Models::V1::CouponCreateResponse::Data::status
+          attr_accessor status: Stigg::Models::V1::Coupon::Data::status
 
-          attr_accessor type: Stigg::Models::V1::CouponCreateResponse::Data::type_
+          attr_accessor type: Stigg::Models::V1::Coupon::Data::type_
 
           attr_accessor updated_at: Time
 
           def initialize: (
             id: String,
-            amounts_off: ::Array[Stigg::Models::V1::CouponCreateResponse::Data::AmountsOff]?,
+            amounts_off: ::Array[Stigg::V1::Coupon::Data::AmountsOff]?,
             billing_id: String?,
             billing_link_url: String?,
             created_at: Time,
@@ -67,15 +64,15 @@ module Stigg
             duration_in_months: Float?,
             name: String,
             percent_off: Float?,
-            source: Stigg::Models::V1::CouponCreateResponse::Data::source?,
-            status: Stigg::Models::V1::CouponCreateResponse::Data::status,
-            type: Stigg::Models::V1::CouponCreateResponse::Data::type_,
+            source: Stigg::Models::V1::Coupon::Data::source?,
+            status: Stigg::Models::V1::Coupon::Data::status,
+            type: Stigg::Models::V1::Coupon::Data::type_,
             updated_at: Time
           ) -> void
 
           def to_hash: -> {
             id: String,
-            amounts_off: ::Array[Stigg::Models::V1::CouponCreateResponse::Data::AmountsOff]?,
+            amounts_off: ::Array[Stigg::V1::Coupon::Data::AmountsOff]?,
             billing_id: String?,
             billing_link_url: String?,
             created_at: Time,
@@ -83,31 +80,31 @@ module Stigg
             duration_in_months: Float?,
             name: String,
             percent_off: Float?,
-            source: Stigg::Models::V1::CouponCreateResponse::Data::source?,
-            status: Stigg::Models::V1::CouponCreateResponse::Data::status,
-            type: Stigg::Models::V1::CouponCreateResponse::Data::type_,
+            source: Stigg::Models::V1::Coupon::Data::source?,
+            status: Stigg::Models::V1::Coupon::Data::status,
+            type: Stigg::Models::V1::Coupon::Data::type_,
             updated_at: Time
           }
 
           type amounts_off =
             {
               amount: Float,
-              currency: Stigg::Models::V1::CouponCreateResponse::Data::AmountsOff::currency?
+              currency: Stigg::Models::V1::Coupon::Data::AmountsOff::currency
             }
 
           class AmountsOff < Stigg::Internal::Type::BaseModel
             attr_accessor amount: Float
 
-            attr_accessor currency: Stigg::Models::V1::CouponCreateResponse::Data::AmountsOff::currency?
+            attr_accessor currency: Stigg::Models::V1::Coupon::Data::AmountsOff::currency
 
             def initialize: (
               amount: Float,
-              currency: Stigg::Models::V1::CouponCreateResponse::Data::AmountsOff::currency?
+              currency: Stigg::Models::V1::Coupon::Data::AmountsOff::currency
             ) -> void
 
             def to_hash: -> {
               amount: Float,
-              currency: Stigg::Models::V1::CouponCreateResponse::Data::AmountsOff::currency?
+              currency: Stigg::Models::V1::Coupon::Data::AmountsOff::currency
             }
 
             type currency =
@@ -348,7 +345,7 @@ module Stigg
               XOF: :xof
               XPF: :xpf
 
-              def self?.values: -> ::Array[Stigg::Models::V1::CouponCreateResponse::Data::AmountsOff::currency]
+              def self?.values: -> ::Array[Stigg::Models::V1::Coupon::Data::AmountsOff::currency]
             end
           end
 
@@ -361,7 +358,7 @@ module Stigg
             STIGG_ADHOC: :STIGG_ADHOC
             STRIPE: :STRIPE
 
-            def self?.values: -> ::Array[Stigg::Models::V1::CouponCreateResponse::Data::source]
+            def self?.values: -> ::Array[Stigg::Models::V1::Coupon::Data::source]
           end
 
           type status = :ACTIVE | :ARCHIVED
@@ -372,7 +369,7 @@ module Stigg
             ACTIVE: :ACTIVE
             ARCHIVED: :ARCHIVED
 
-            def self?.values: -> ::Array[Stigg::Models::V1::CouponCreateResponse::Data::status]
+            def self?.values: -> ::Array[Stigg::Models::V1::Coupon::Data::status]
           end
 
           type type_ = :FIXED | :PERCENTAGE
@@ -383,7 +380,7 @@ module Stigg
             FIXED: :FIXED
             PERCENTAGE: :PERCENTAGE
 
-            def self?.values: -> ::Array[Stigg::Models::V1::CouponCreateResponse::Data::type_]
+            def self?.values: -> ::Array[Stigg::Models::V1::Coupon::Data::type_]
           end
         end
       end