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

data/rbi/stigg/models/v1/usage_report_response.rbi

@@ -0,0 +1,162 @@
+# typed: strong
+
+module Stigg
+  module Models
+    module V1
+      class UsageReportResponse < Stigg::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Stigg::Models::V1::UsageReportResponse,
+              Stigg::Internal::AnyHash
+            )
+          end
+
+        # Array of usage measurements with current values and period info
+        sig { returns(T::Array[Stigg::Models::V1::UsageReportResponse::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::V1::UsageReportResponse::Data::OrHash]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Array of usage measurements with current values and period info
+          data:
+        )
+        end
+
+        sig do
+          override.returns(
+            { data: T::Array[Stigg::Models::V1::UsageReportResponse::Data] }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < Stigg::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Stigg::Models::V1::UsageReportResponse::Data,
+                Stigg::Internal::AnyHash
+              )
+            end
+
+          # Unique identifier for the entity
+          sig { returns(String) }
+          attr_accessor :id
+
+          # Timestamp of when the record was created
+          sig { returns(Time) }
+          attr_accessor :created_at
+
+          # Customer id
+          sig { returns(String) }
+          attr_accessor :customer_id
+
+          # Feature id
+          sig { returns(String) }
+          attr_accessor :feature_id
+
+          # Timestamp
+          sig { returns(Time) }
+          attr_accessor :timestamp
+
+          # The usage measurement record
+          sig { returns(Float) }
+          attr_accessor :value
+
+          # The current measured usage value
+          sig { returns(T.nilable(Float)) }
+          attr_accessor :current_usage
+
+          # The date when the next usage reset will occur
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :next_reset_date
+
+          # Resource id
+          sig { returns(T.nilable(String)) }
+          attr_accessor :resource_id
+
+          # The end date of the usage period in which this measurement resides (for
+          # entitlements with a reset period)
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :usage_period_end
+
+          # The start date of the usage period in which this measurement resides (for
+          # entitlements with a reset period)
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :usage_period_start
+
+          # Recorded usage with period info
+          sig do
+            params(
+              id: String,
+              created_at: Time,
+              customer_id: String,
+              feature_id: String,
+              timestamp: Time,
+              value: Float,
+              current_usage: T.nilable(Float),
+              next_reset_date: T.nilable(Time),
+              resource_id: T.nilable(String),
+              usage_period_end: T.nilable(Time),
+              usage_period_start: T.nilable(Time)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Unique identifier for the entity
+            id:,
+            # Timestamp of when the record was created
+            created_at:,
+            # Customer id
+            customer_id:,
+            # Feature id
+            feature_id:,
+            # Timestamp
+            timestamp:,
+            # The usage measurement record
+            value:,
+            # The current measured usage value
+            current_usage: nil,
+            # The date when the next usage reset will occur
+            next_reset_date: nil,
+            # Resource id
+            resource_id: nil,
+            # The end date of the usage period in which this measurement resides (for
+            # entitlements with a reset period)
+            usage_period_end: nil,
+            # The start date of the usage period in which this measurement resides (for
+            # entitlements with a reset period)
+            usage_period_start: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                created_at: Time,
+                customer_id: String,
+                feature_id: String,
+                timestamp: Time,
+                value: Float,
+                current_usage: T.nilable(Float),
+                next_reset_date: T.nilable(Time),
+                resource_id: T.nilable(String),
+                usage_period_end: T.nilable(Time),
+                usage_period_start: T.nilable(Time)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/stigg/models.rbi

@@ -2,8 +2,4 @@
 
 module Stigg
   V1 = Stigg::Models::V1
-
-  V1CreateEventParams = Stigg::Models::V1CreateEventParams
-
-  V1CreateUsageParams = Stigg::Models::V1CreateUsageParams
 end

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,
@@ -18,7 +18,7 @@ module Stigg
             percent_off: T.nilable(Float),
             additional_meta_data: T.anything,
             request_options: Stigg::RequestOptions::OrHash
-          ).returns(Stigg::Models::V1::CouponCreateResponse)
+          ).returns(Stigg::V1::Coupon)
         end
         def create(
           # The unique identifier for the entity
@@ -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)
+          ).returns(Stigg::V1::Coupon)
         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/{promotional.rbi → promotional_entitlements.rbi}

@@ -4,20 +4,22 @@ module Stigg
   module Resources
     class V1
       class Customers
-        class Promotional
-          # Create a new Promotional Entitlements
+        class PromotionalEntitlements
+          # Create a promotional entitlements
           sig do
             params(
               customer_id: String,
               promotional_entitlements:
                 T::Array[
-                  Stigg::V1::Customers::PromotionalCreateParams::PromotionalEntitlement::OrHash
+                  Stigg::V1::Customers::PromotionalEntitlementGrantParams::PromotionalEntitlement::OrHash
                 ],
               request_options: Stigg::RequestOptions::OrHash
-            ).returns(Stigg::Models::V1::Customers::PromotionalCreateResponse)
+            ).returns(
+              Stigg::Models::V1::Customers::PromotionalEntitlementGrantResponse
+            )
           end
-          def create(
-            # The unique identifier of the entitlement customer
+          def grant(
+            # The unique identifier of the customer
             customer_id,
             # Promotional entitlements to grant
             promotional_entitlements:,
@@ -25,18 +27,20 @@ module Stigg
           )
           end
 
-          # Perform revocation on a Promotional Entitlement
+          # Revoke promotional entitlement
           sig do
             params(
               feature_id: String,
               customer_id: String,
               request_options: Stigg::RequestOptions::OrHash
-            ).returns(Stigg::Models::V1::Customers::PromotionalRevokeResponse)
+            ).returns(
+              Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse
+            )
           end
           def revoke(
             # The unique identifier of the entitlement feature
             feature_id,
-            # The unique identifier of the entitlement customer
+            # The unique identifier of the customer
             customer_id:,
             request_options: {}
           )

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

@@ -7,36 +7,43 @@ module Stigg
         sig { returns(Stigg::Resources::V1::Customers::PaymentMethod) }
         attr_reader :payment_method
 
-        sig { returns(Stigg::Resources::V1::Customers::Usage) }
-        attr_reader :usage
+        sig do
+          returns(Stigg::Resources::V1::Customers::PromotionalEntitlements)
+        end
+        attr_reader :promotional_entitlements
 
-        sig { returns(Stigg::Resources::V1::Customers::Promotional) }
-        attr_reader :promotional
+        # Get a single customer by ID
+        sig do
+          params(
+            id: String,
+            request_options: Stigg::RequestOptions::OrHash
+          ).returns(Stigg::V1::CustomerResponse)
+        end
+        def retrieve(
+          # The unique identifier of the entity
+          id,
+          request_options: {}
+        )
+        end
 
-        # Create a new Customer
+        # Update a customer
         sig do
           params(
             id: String,
             coupon_id: T.nilable(String),
-            default_payment_method:
-              T.nilable(
-                Stigg::V1::CustomerCreateParams::DefaultPaymentMethod::OrHash
-              ),
             email: T.nilable(String),
             integrations:
-              T::Array[Stigg::V1::CustomerCreateParams::Integration::OrHash],
+              T::Array[Stigg::V1::CustomerUpdateParams::Integration::OrHash],
             metadata: T::Hash[Symbol, String],
             name: T.nilable(String),
             request_options: Stigg::RequestOptions::OrHash
           ).returns(Stigg::V1::CustomerResponse)
         end
-        def create(
-          # Customer slug
-          id:,
+        def update(
+          # The unique identifier of the entity
+          id,
           # Customer level coupon
           coupon_id: nil,
-          # The default payment method details
-          default_payment_method: nil,
           # The email of the customer
           email: nil,
           # List of integrations
@@ -49,83 +56,107 @@ module Stigg
         )
         end
 
-        # Get a single Customer by id
+        # Get a list of customers
         sig do
           params(
-            id: String,
+            after: String,
+            before: String,
+            limit: Integer,
             request_options: Stigg::RequestOptions::OrHash
-          ).returns(Stigg::V1::CustomerResponse)
+          ).returns(
+            Stigg::Internal::MyCursorIDPage[
+              Stigg::Models::V1::CustomerListResponse
+            ]
+          )
         end
-        def retrieve(id, request_options: {})
+        def list(
+          # 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,
+          request_options: {}
+        )
         end
 
-        # Update an existing Customer
+        # Archive customer
         sig do
           params(
             id: String,
-            coupon_id: T.nilable(String),
-            email: T.nilable(String),
-            integrations:
-              T::Array[Stigg::V1::CustomerUpdateParams::Integration::OrHash],
-            metadata: T::Hash[Symbol, String],
-            name: T.nilable(String),
             request_options: Stigg::RequestOptions::OrHash
           ).returns(Stigg::V1::CustomerResponse)
         end
-        def update(
+        def archive(
+          # The unique identifier of the entity
           id,
-          # Customer level coupon
-          coupon_id: nil,
-          # The email of the customer
-          email: nil,
-          # List of integrations
-          integrations: nil,
-          # Additional metadata
-          metadata: nil,
-          # The name of the customer
-          name: nil,
           request_options: {}
         )
         end
 
-        # Get a list of Customers
+        # Bulk import customers
         sig do
           params(
-            ending_before: String,
-            limit: Integer,
-            starting_after: String,
+            customers:
+              T::Array[Stigg::V1::CustomerImportParams::Customer::OrHash],
             request_options: Stigg::RequestOptions::OrHash
-          ).returns(Stigg::Models::V1::CustomerListResponse)
+          ).returns(Stigg::Models::V1::CustomerImportResponse)
         end
-        def list(
-          # Ending before this UUID for pagination
-          ending_before: nil,
-          # Items per page
-          limit: nil,
-          # Starting after this UUID for pagination
-          starting_after: nil,
+        def import(
+          # List of customer objects to import
+          customers:,
           request_options: {}
         )
         end
 
-        # Perform archive on a Customer
+        # Provision customer
         sig do
           params(
             id: String,
+            coupon_id: T.nilable(String),
+            default_payment_method:
+              T.nilable(
+                Stigg::V1::CustomerProvisionParams::DefaultPaymentMethod::OrHash
+              ),
+            email: T.nilable(String),
+            integrations:
+              T::Array[Stigg::V1::CustomerProvisionParams::Integration::OrHash],
+            metadata: T::Hash[Symbol, String],
+            name: T.nilable(String),
             request_options: Stigg::RequestOptions::OrHash
           ).returns(Stigg::V1::CustomerResponse)
         end
-        def archive(id, request_options: {})
+        def provision(
+          # Customer slug
+          id:,
+          # Customer level coupon
+          coupon_id: nil,
+          # The default payment method details
+          default_payment_method: nil,
+          # The email of the customer
+          email: nil,
+          # List of integrations
+          integrations: nil,
+          # Additional metadata
+          metadata: nil,
+          # The name of the customer
+          name: nil,
+          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/events.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Stigg
+  module Resources
+    class V1
+      class Events
+        # Report usage events
+        sig do
+          params(
+            events: T::Array[Stigg::V1::EventReportParams::Event::OrHash],
+            request_options: Stigg::RequestOptions::OrHash
+          ).returns(Stigg::Models::V1::EventReportResponse)
+        end
+        def report(
+          # A list of usage events to report
+          events:,
+          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/subscriptions/future_update.rbi

@@ -5,28 +5,32 @@ module Stigg
     class V1
       class Subscriptions
         class FutureUpdate
-          # Perform cancel future update on a Subscription
+          # Cancel pending payment update
           sig do
             params(
               id: String,
               request_options: Stigg::RequestOptions::OrHash
-            ).returns(
-              Stigg::Models::V1::Subscriptions::FutureUpdateCancelPendingPaymentResponse
-            )
+            ).returns(Stigg::V1::Subscriptions::CancelSubscription)
           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,
               request_options: Stigg::RequestOptions::OrHash
-            ).returns(
-              Stigg::Models::V1::Subscriptions::FutureUpdateCancelScheduleResponse
-            )
+            ).returns(Stigg::V1::Subscriptions::CancelSubscription)
           end
-          def cancel_schedule(id, request_options: {})
+          def cancel_schedule(
+            # The unique identifier of the entity
+            id,
+            request_options: {}
+          )
           end
 
           # @api private