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

data/rbi/stigg/models/v1/subscription_transfer_params.rbi

@@ -15,8 +15,7 @@ module Stigg
             )
           end
 
-        # The resource ID to transfer the subscription to. The destination resource must
-        # belong to the same customer.
+        # Resource ID to transfer the subscription to
         sig { returns(String) }
         attr_accessor :destination_resource_id
 
@@ -27,8 +26,7 @@ module Stigg
           ).returns(T.attached_class)
         end
         def self.new(
-          # 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/models/v1/subscription_transfer_response.rbi

@@ -12,6 +12,7 @@ module Stigg
             )
           end
 
+        # Customer subscription to a plan
         sig { returns(Stigg::Models::V1::SubscriptionTransferResponse::Data) }
         attr_reader :data
 
@@ -22,12 +23,16 @@ module Stigg
         end
         attr_writer :data
 
+        # Response object
         sig do
           params(
             data: Stigg::Models::V1::SubscriptionTransferResponse::Data::OrHash
           ).returns(T.attached_class)
         end
-        def self.new(data:)
+        def self.new(
+          # Customer subscription to a plan
+          data:
+        )
         end
 
         sig do
@@ -146,6 +151,27 @@ module Stigg
           end
           attr_accessor :payment_collection_method
 
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  Stigg::Models::V1::SubscriptionTransferResponse::Data::Price
+                ]
+              )
+            )
+          end
+          attr_reader :prices
+
+          sig do
+            params(
+              prices:
+                T::Array[
+                  Stigg::Models::V1::SubscriptionTransferResponse::Data::Price::OrHash
+                ]
+            ).void
+          end
+          attr_writer :prices
+
           # Resource ID
           sig { returns(T.nilable(String)) }
           attr_accessor :resource_id
@@ -154,6 +180,7 @@ module Stigg
           sig { returns(T.nilable(Time)) }
           attr_accessor :trial_end_date
 
+          # Customer subscription to a plan
           sig do
             params(
               id: String,
@@ -183,6 +210,10 @@ module Stigg
                 T.nilable(
                   Stigg::Models::V1::SubscriptionTransferResponse::Data::PaymentCollectionMethod::OrSymbol
                 ),
+              prices:
+                T::Array[
+                  Stigg::Models::V1::SubscriptionTransferResponse::Data::Price::OrHash
+                ],
               resource_id: T.nilable(String),
               trial_end_date: T.nilable(Time)
             ).returns(T.attached_class)
@@ -224,6 +255,7 @@ module Stigg
             paying_customer_id: nil,
             # The method used to collect payments for a subscription
             payment_collection_method: nil,
+            prices: nil,
             # Resource ID
             resource_id: nil,
             # Subscription trial end date
@@ -261,6 +293,10 @@ module Stigg
                   T.nilable(
                     Stigg::Models::V1::SubscriptionTransferResponse::Data::PaymentCollectionMethod::TaggedSymbol
                   ),
+                prices:
+                  T::Array[
+                    Stigg::Models::V1::SubscriptionTransferResponse::Data::Price
+                  ],
                 resource_id: T.nilable(String),
                 trial_end_date: T.nilable(Time)
               }
@@ -528,6 +564,53 @@ module Stigg
             def self.values
             end
           end
+
+          class Price < Stigg::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Stigg::Models::V1::SubscriptionTransferResponse::Data::Price,
+                  Stigg::Internal::AnyHash
+                )
+              end
+
+            # Price ID
+            sig { returns(String) }
+            attr_accessor :id
+
+            # Creation timestamp
+            sig { returns(String) }
+            attr_accessor :created_at
+
+            # Last update timestamp
+            sig { returns(String) }
+            attr_accessor :updated_at
+
+            sig do
+              params(
+                id: String,
+                created_at: String,
+                updated_at: String
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Price ID
+              id:,
+              # Creation timestamp
+              created_at:,
+              # Last update timestamp
+              updated_at:
+            )
+            end
+
+            sig do
+              override.returns(
+                { id: String, created_at: String, updated_at: String }
+              )
+            end
+            def to_hash
+            end
+          end
         end
       end
     end

data/rbi/stigg/models/v1/subscriptions/future_update_cancel_pending_payment_response.rbi

@@ -28,6 +28,7 @@ module Stigg
           end
           attr_writer :data
 
+          # Response object
           sig do
             params(
               data:

data/rbi/stigg/models/v1/subscriptions/future_update_cancel_schedule_response.rbi

@@ -28,6 +28,7 @@ module Stigg
           end
           attr_writer :data
 
+          # Response object
           sig do
             params(
               data:

data/rbi/stigg/models/v1_create_event_params.rbi

@@ -92,6 +92,7 @@ module Stigg
         sig { params(timestamp: Time).void }
         attr_writer :timestamp
 
+        # Raw usage event
         sig do
           params(
             customer_id: String,

data/rbi/stigg/models/v1_create_event_response.rbi

@@ -8,11 +8,18 @@ module Stigg
           T.any(Stigg::Models::V1CreateEventResponse, Stigg::Internal::AnyHash)
         end
 
+      # Empty success response confirming that events were successfully ingested and
+      # queued for processing by Stigg's metering system.
       sig { returns(T.anything) }
       attr_accessor :data
 
+      # Response object
       sig { params(data: T.anything).returns(T.attached_class) }
-      def self.new(data:)
+      def self.new(
+        # Empty success response confirming that events were successfully ingested and
+        # queued for processing by Stigg's metering system.
+        data:
+      )
       end
 
       sig { override.returns({ data: T.anything }) }

data/rbi/stigg/models/v1_create_usage_params.rbi

@@ -65,10 +65,27 @@ module Stigg
         attr_writer :created_at
 
         # Additional dimensions for the usage report
-        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        sig do
+          returns(
+            T.nilable(
+              T::Hash[
+                Symbol,
+                Stigg::V1CreateUsageParams::Usage::Dimension::Variants
+              ]
+            )
+          )
+        end
         attr_reader :dimensions
 
-        sig { params(dimensions: T::Hash[Symbol, String]).void }
+        sig do
+          params(
+            dimensions:
+              T::Hash[
+                Symbol,
+                Stigg::V1CreateUsageParams::Usage::Dimension::Variants
+              ]
+          ).void
+        end
         attr_writer :dimensions
 
         # Resource id
@@ -93,13 +110,18 @@ module Stigg
         end
         attr_writer :update_behavior
 
+        # Single usage measurement
         sig do
           params(
             customer_id: String,
             feature_id: String,
             value: Integer,
             created_at: Time,
-            dimensions: T::Hash[Symbol, String],
+            dimensions:
+              T::Hash[
+                Symbol,
+                Stigg::V1CreateUsageParams::Usage::Dimension::Variants
+              ],
             resource_id: T.nilable(String),
             update_behavior:
               Stigg::V1CreateUsageParams::Usage::UpdateBehavior::OrSymbol
@@ -130,7 +152,11 @@ module Stigg
               feature_id: String,
               value: Integer,
               created_at: Time,
-              dimensions: T::Hash[Symbol, String],
+              dimensions:
+                T::Hash[
+                  Symbol,
+                  Stigg::V1CreateUsageParams::Usage::Dimension::Variants
+                ],
               resource_id: T.nilable(String),
               update_behavior:
                 Stigg::V1CreateUsageParams::Usage::UpdateBehavior::OrSymbol
@@ -140,6 +166,20 @@ module Stigg
         def to_hash
         end
 
+        module Dimension
+          extend Stigg::Internal::Type::Union
+
+          Variants = T.type_alias { T.any(String, Float, T::Boolean) }
+
+          sig do
+            override.returns(
+              T::Array[Stigg::V1CreateUsageParams::Usage::Dimension::Variants]
+            )
+          end
+          def self.variants
+          end
+        end
+
         # The method by which the usage value should be updated
         module UpdateBehavior
           extend Stigg::Internal::Type::Enum

data/rbi/stigg/models/v1_create_usage_response.rbi

@@ -8,15 +8,21 @@ module Stigg
           T.any(Stigg::Models::V1CreateUsageResponse, Stigg::Internal::AnyHash)
         end
 
+      # Array of usage measurements with current values and period info
       sig { returns(T::Array[Stigg::Models::V1CreateUsageResponse::Data]) }
       attr_accessor :data
 
+      # Response containing reported usage measurements with current usage values,
+      # period information, and reset dates for each measurement.
       sig do
         params(
           data: T::Array[Stigg::Models::V1CreateUsageResponse::Data::OrHash]
         ).returns(T.attached_class)
       end
-      def self.new(data:)
+      def self.new(
+        # Array of usage measurements with current values and period info
+        data:
+      )
       end
 
       sig do
@@ -82,6 +88,7 @@ module Stigg
         sig { returns(T.nilable(Time)) }
         attr_accessor :usage_period_start
 
+        # Recorded usage with period info
         sig do
           params(
             id: String,

data/rbi/stigg/resources/v1/coupons.rbi

@@ -4,7 +4,7 @@ module Stigg
   module Resources
     class V1
       class Coupons
-        # Create a new Coupon
+        # Create coupon
         sig do
           params(
             id: String,
@@ -39,32 +39,40 @@ module Stigg
         )
         end
 
-        # Get a single Coupon by id
+        # Get a single coupon by ID
         sig do
           params(
             id: String,
             request_options: Stigg::RequestOptions::OrHash
           ).returns(Stigg::Models::V1::CouponRetrieveResponse)
         end
-        def retrieve(id, request_options: {})
+        def retrieve(
+          # The unique identifier of the entity
+          id,
+          request_options: {}
+        )
         end
 
-        # Get a list of Coupons
+        # Get a list of coupons
         sig do
           params(
-            ending_before: String,
+            after: String,
+            before: String,
             limit: Integer,
-            starting_after: String,
             request_options: Stigg::RequestOptions::OrHash
-          ).returns(Stigg::Models::V1::CouponListResponse)
+          ).returns(
+            Stigg::Internal::MyCursorIDPage[
+              Stigg::Models::V1::CouponListResponse
+            ]
+          )
         end
         def list(
-          # 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

data/rbi/stigg/resources/v1/customers/payment_method.rbi

@@ -5,7 +5,7 @@ module Stigg
     class V1
       class Customers
         class PaymentMethod
-          # Perform payment-method attachment on a Customer
+          # Attach payment method
           sig do
             params(
               id: String,
@@ -21,6 +21,7 @@ module Stigg
             ).returns(Stigg::V1::CustomerResponse)
           end
           def attach(
+            # The unique identifier of the entity
             id,
             # Integration details
             integration_id:,
@@ -28,19 +29,24 @@ module Stigg
             payment_method_id:,
             # The vendor identifier of integration
             vendor_identifier:,
+            # Customers selected currency
             billing_currency: nil,
             request_options: {}
           )
           end
 
-          # Perform payment-method detachment on a Customer
+          # Detach payment method
           sig do
             params(
               id: String,
               request_options: Stigg::RequestOptions::OrHash
             ).returns(Stigg::V1::CustomerResponse)
           end
-          def detach(id, request_options: {})
+          def detach(
+            # The unique identifier of the entity
+            id,
+            request_options: {}
+          )
           end
 
           # @api private

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

@@ -5,35 +5,6 @@ module Stigg
     class V1
       class Customers
         class Usage
-          # Perform retrieval on a 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::Customers::UsageRetrieveResponse)
-          end
-          def retrieve(
-            # 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
-
           # @api private
           sig { params(client: Stigg::Client).returns(T.attached_class) }
           def self.new(client:)

data/rbi/stigg/resources/v1/customers.rbi

@@ -10,10 +10,7 @@ module Stigg
         sig { returns(Stigg::Resources::V1::Customers::Usage) }
         attr_reader :usage
 
-        sig { returns(Stigg::Resources::V1::Customers::Promotional) }
-        attr_reader :promotional
-
-        # Create a new Customer
+        # Provision customer
         sig do
           params(
             id: String,
@@ -49,17 +46,21 @@ module Stigg
         )
         end
 
-        # Get a single Customer by id
+        # Get a single customer by ID
         sig do
           params(
             id: String,
             request_options: Stigg::RequestOptions::OrHash
           ).returns(Stigg::V1::CustomerResponse)
         end
-        def retrieve(id, request_options: {})
+        def retrieve(
+          # The unique identifier of the entity
+          id,
+          request_options: {}
+        )
         end
 
-        # Update an existing Customer
+        # Update a customer
         sig do
           params(
             id: String,
@@ -73,6 +74,7 @@ module Stigg
           ).returns(Stigg::V1::CustomerResponse)
         end
         def update(
+          # The unique identifier of the entity
           id,
           # Customer level coupon
           coupon_id: nil,
@@ -88,44 +90,56 @@ module Stigg
         )
         end
 
-        # Get a list of Customers
+        # Get a list of customers
         sig do
           params(
-            ending_before: String,
+            after: String,
+            before: String,
             limit: Integer,
-            starting_after: String,
             request_options: Stigg::RequestOptions::OrHash
-          ).returns(Stigg::Models::V1::CustomerListResponse)
+          ).returns(
+            Stigg::Internal::MyCursorIDPage[
+              Stigg::Models::V1::CustomerListResponse
+            ]
+          )
         end
         def list(
-          # 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
 
-        # Perform archive on a Customer
+        # Archive customer
         sig do
           params(
             id: String,
             request_options: Stigg::RequestOptions::OrHash
           ).returns(Stigg::V1::CustomerResponse)
         end
-        def archive(id, request_options: {})
+        def archive(
+          # The unique identifier of the entity
+          id,
+          request_options: {}
+        )
         end
 
-        # Perform unarchive on a Customer
+        # Unarchive customer
         sig do
           params(
             id: String,
             request_options: Stigg::RequestOptions::OrHash
           ).returns(Stigg::V1::CustomerResponse)
         end
-        def unarchive(id, request_options: {})
+        def unarchive(
+          # The unique identifier of the entity
+          id,
+          request_options: {}
+        )
         end
 
         # @api private

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

@@ -5,7 +5,7 @@ module Stigg
     class V1
       class Subscriptions
         class FutureUpdate
-          # Perform cancel future update on a Subscription
+          # Cancel pending payment update
           sig do
             params(
               id: String,
@@ -14,10 +14,14 @@ module Stigg
               Stigg::Models::V1::Subscriptions::FutureUpdateCancelPendingPaymentResponse
             )
           end
-          def cancel_pending_payment(id, request_options: {})
+          def cancel_pending_payment(
+            # The unique identifier of the entity
+            id,
+            request_options: {}
+          )
           end
 
-          # Perform cancel future update on a Subscription
+          # Cancel scheduled update
           sig do
             params(
               id: String,
@@ -26,7 +30,11 @@ module Stigg
               Stigg::Models::V1::Subscriptions::FutureUpdateCancelScheduleResponse
             )
           end
-          def cancel_schedule(id, request_options: {})
+          def cancel_schedule(
+            # The unique identifier of the entity
+            id,
+            request_options: {}
+          )
           end
 
           # @api private