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

data/lib/stigg/models/v1/customers/{promotional_revoke_response.rb → promotional_entitlement_revoke_response.rb}

@@ -4,17 +4,20 @@ module Stigg
   module Models
     module V1
       module Customers
-        # @see Stigg::Resources::V1::Customers::Promotional#revoke
-        class PromotionalRevokeResponse < Stigg::Internal::Type::BaseModel
+        # @see Stigg::Resources::V1::Customers::PromotionalEntitlements#revoke
+        class PromotionalEntitlementRevokeResponse < Stigg::Internal::Type::BaseModel
           # @!attribute data
+          #   Granted feature entitlement
           #
-          #   @return [Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data]
-          required :data, -> { Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data }
+          #   @return [Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data]
+          required :data, -> { Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data }
 
           # @!method initialize(data:)
-          #   @param data [Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data]
+          #   Response object
+          #
+          #   @param data [Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data] Granted feature entitlement
 
-          # @see Stigg::Models::V1::Customers::PromotionalRevokeResponse#data
+          # @see Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse#data
           class Data < Stigg::Internal::Type::BaseModel
             # @!attribute id
             #   Unique identifier for the entity
@@ -91,24 +94,25 @@ module Stigg
             # @!attribute period
             #   The grant period of the promotional entitlement
             #
-            #   @return [Symbol, Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::Period]
-            required :period, enum: -> { Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::Period }
+            #   @return [Symbol, Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::Period]
+            required :period,
+                     enum: -> { Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::Period }
 
             # @!attribute reset_period
             #   The reset period of the entitlement
             #
-            #   @return [Symbol, Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::ResetPeriod, nil]
+            #   @return [Symbol, Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriod, nil]
             required :reset_period,
-                     enum: -> { Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::ResetPeriod },
+                     enum: -> { Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriod },
                      api_name: :resetPeriod,
                      nil?: true
 
             # @!attribute reset_period_configuration
             #   The reset period configuration of the entitlement
             #
-            #   @return [Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::ResetPeriodConfiguration::AccordingTo, nil]
+            #   @return [Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::YearlyResetPeriodConfig, Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::MonthlyResetPeriodConfig, Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::WeeklyResetPeriodConfig, nil]
             required :reset_period_configuration,
-                     union: -> { Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::ResetPeriodConfiguration },
+                     union: -> { Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration },
                      api_name: :resetPeriodConfiguration,
                      nil?: true
 
@@ -121,8 +125,9 @@ module Stigg
             # @!attribute status
             #   The status of the entitlement
             #
-            #   @return [Symbol, Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::Status]
-            required :status, enum: -> { Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::Status }
+            #   @return [Symbol, Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::Status]
+            required :status,
+                     enum: -> { Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::Status }
 
             # @!attribute updated_at
             #   Timestamp of when the record was last updated
@@ -137,6 +142,8 @@ module Stigg
             required :usage_limit, Float, api_name: :usageLimit, nil?: true
 
             # @!method initialize(id:, created_at:, description:, end_date:, enum_values:, environment_id:, feature_group_ids:, feature_id:, has_soft_limit:, has_unlimited_usage:, is_visible:, period:, reset_period:, reset_period_configuration:, start_date:, status:, updated_at:, usage_limit:)
+            #   Granted feature entitlement
+            #
             #   @param id [String] Unique identifier for the entity
             #
             #   @param created_at [Time] Timestamp of when the record was created
@@ -159,15 +166,15 @@ module Stigg
             #
             #   @param is_visible [Boolean] Whether the entitlement is visible
             #
-            #   @param period [Symbol, Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::Period] The grant period of the promotional entitlement
+            #   @param period [Symbol, Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::Period] The grant period of the promotional entitlement
             #
-            #   @param reset_period [Symbol, Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::ResetPeriod, nil] The reset period of the entitlement
+            #   @param reset_period [Symbol, Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriod, nil] The reset period of the entitlement
             #
-            #   @param reset_period_configuration [Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::ResetPeriodConfiguration::AccordingTo, nil] The reset period configuration of the entitlement
+            #   @param reset_period_configuration [Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::YearlyResetPeriodConfig, Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::MonthlyResetPeriodConfig, Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::WeeklyResetPeriodConfig, nil] The reset period configuration of the entitlement
             #
             #   @param start_date [Time] The start date of the entitlement
             #
-            #   @param status [Symbol, Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::Status] The status of the entitlement
+            #   @param status [Symbol, Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::Status] The status of the entitlement
             #
             #   @param updated_at [Time] Timestamp of when the record was last updated
             #
@@ -175,7 +182,7 @@ module Stigg
 
             # The grant period of the promotional entitlement
             #
-            # @see Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data#period
+            # @see Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data#period
             module Period
               extend Stigg::Internal::Type::Enum
 
@@ -192,7 +199,7 @@ module Stigg
 
             # The reset period of the entitlement
             #
-            # @see Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data#reset_period
+            # @see Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data#reset_period
             module ResetPeriod
               extend Stigg::Internal::Type::Enum
 
@@ -208,35 +215,102 @@ module Stigg
 
             # The reset period configuration of the entitlement
             #
-            # @see Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data#reset_period_configuration
+            # @see Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data#reset_period_configuration
             module ResetPeriodConfiguration
               extend Stigg::Internal::Type::Union
 
-              variant -> { Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::ResetPeriodConfiguration::AccordingTo }
+              # Yearly reset configuration
+              variant -> { Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::YearlyResetPeriodConfig }
+
+              # Monthly reset configuration
+              variant -> { Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::MonthlyResetPeriodConfig }
 
-              variant -> { Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::ResetPeriodConfiguration::AccordingTo }
+              # Weekly reset configuration
+              variant -> { Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::WeeklyResetPeriodConfig }
+
+              class YearlyResetPeriodConfig < Stigg::Internal::Type::BaseModel
+                # @!attribute according_to
+                #   Reset anchor (SubscriptionStart)
+                #
+                #   @return [Symbol, Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::YearlyResetPeriodConfig::AccordingTo]
+                required :according_to,
+                         enum: -> { Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::YearlyResetPeriodConfig::AccordingTo },
+                         api_name: :accordingTo
+
+                # @!method initialize(according_to:)
+                #   Yearly reset configuration
+                #
+                #   @param according_to [Symbol, Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::YearlyResetPeriodConfig::AccordingTo] Reset anchor (SubscriptionStart)
 
-              variant -> { Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::ResetPeriodConfiguration::AccordingTo }
+                # Reset anchor (SubscriptionStart)
+                #
+                # @see Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::YearlyResetPeriodConfig#according_to
+                module AccordingTo
+                  extend Stigg::Internal::Type::Enum
+
+                  SUBSCRIPTION_START = :SubscriptionStart
+
+                  # @!method self.values
+                  #   @return [Array<Symbol>]
+                end
+              end
 
-              class AccordingTo < Stigg::Internal::Type::BaseModel
+              class MonthlyResetPeriodConfig < Stigg::Internal::Type::BaseModel
                 # @!attribute according_to
-                #   Yearly reset period according to
+                #   Reset anchor (SubscriptionStart or StartOfTheMonth)
                 #
-                #   @return [Symbol, Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::ResetPeriodConfiguration::AccordingTo::AccordingTo]
+                #   @return [Symbol, Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::MonthlyResetPeriodConfig::AccordingTo]
                 required :according_to,
-                         enum: -> { Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::ResetPeriodConfiguration::AccordingTo::AccordingTo },
+                         enum: -> { Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::MonthlyResetPeriodConfig::AccordingTo },
                          api_name: :accordingTo
 
                 # @!method initialize(according_to:)
-                #   @param according_to [Symbol, Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::ResetPeriodConfiguration::AccordingTo::AccordingTo] Yearly reset period according to
+                #   Monthly reset configuration
+                #
+                #   @param according_to [Symbol, Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::MonthlyResetPeriodConfig::AccordingTo] Reset anchor (SubscriptionStart or StartOfTheMonth)
+
+                # Reset anchor (SubscriptionStart or StartOfTheMonth)
+                #
+                # @see Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::MonthlyResetPeriodConfig#according_to
+                module AccordingTo
+                  extend Stigg::Internal::Type::Enum
+
+                  SUBSCRIPTION_START = :SubscriptionStart
+                  START_OF_THE_MONTH = :StartOfTheMonth
+
+                  # @!method self.values
+                  #   @return [Array<Symbol>]
+                end
+              end
+
+              class WeeklyResetPeriodConfig < Stigg::Internal::Type::BaseModel
+                # @!attribute according_to
+                #   Reset anchor (SubscriptionStart or specific day)
+                #
+                #   @return [Symbol, Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::WeeklyResetPeriodConfig::AccordingTo]
+                required :according_to,
+                         enum: -> { Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::WeeklyResetPeriodConfig::AccordingTo },
+                         api_name: :accordingTo
+
+                # @!method initialize(according_to:)
+                #   Weekly reset configuration
+                #
+                #   @param according_to [Symbol, Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::WeeklyResetPeriodConfig::AccordingTo] Reset anchor (SubscriptionStart or specific day)
 
-                # Yearly reset period according to
+                # Reset anchor (SubscriptionStart or specific day)
                 #
-                # @see Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::ResetPeriodConfiguration::AccordingTo#according_to
+                # @see Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::WeeklyResetPeriodConfig#according_to
                 module AccordingTo
                   extend Stigg::Internal::Type::Enum
 
                   SUBSCRIPTION_START = :SubscriptionStart
+                  EVERY_SUNDAY = :EverySunday
+                  EVERY_MONDAY = :EveryMonday
+                  EVERY_TUESDAY = :EveryTuesday
+                  EVERY_WEDNESDAY = :EveryWednesday
+                  EVERY_THURSDAY = :EveryThursday
+                  EVERY_FRIDAY = :EveryFriday
+                  EVERY_SATURDAY = :EverySaturday
 
                   # @!method self.values
                   #   @return [Array<Symbol>]
@@ -244,12 +318,12 @@ module Stigg
               end
 
               # @!method self.variants
-              #   @return [Array(Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::ResetPeriodConfiguration::AccordingTo, Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::ResetPeriodConfiguration::AccordingTo, Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::ResetPeriodConfiguration::AccordingTo)]
+              #   @return [Array(Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::YearlyResetPeriodConfig, Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::MonthlyResetPeriodConfig, Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data::ResetPeriodConfiguration::WeeklyResetPeriodConfig)]
             end
 
             # The status of the entitlement
             #
-            # @see Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data#status
+            # @see Stigg::Models::V1::Customers::PromotionalEntitlementRevokeResponse::Data#status
             module Status
               extend Stigg::Internal::Type::Enum
 

data/lib/stigg/models/v1/event_report_params.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      # @see Stigg::Resources::V1::Events#report
+      class EventReportParams < Stigg::Internal::Type::BaseModel
+        extend Stigg::Internal::Type::RequestParameters::Converter
+        include Stigg::Internal::Type::RequestParameters
+
+        # @!attribute events
+        #   A list of usage events to report
+        #
+        #   @return [Array<Stigg::Models::V1::EventReportParams::Event>]
+        required :events, -> { Stigg::Internal::Type::ArrayOf[Stigg::V1::EventReportParams::Event] }
+
+        # @!method initialize(events:, request_options: {})
+        #   @param events [Array<Stigg::Models::V1::EventReportParams::Event>] A list of usage events to report
+        #
+        #   @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
+
+        class Event < Stigg::Internal::Type::BaseModel
+          # @!attribute customer_id
+          #   Customer id
+          #
+          #   @return [String]
+          required :customer_id, String, api_name: :customerId
+
+          # @!attribute event_name
+          #   The name of the usage event
+          #
+          #   @return [String]
+          required :event_name, String, api_name: :eventName
+
+          # @!attribute idempotency_key
+          #   Idempotency key
+          #
+          #   @return [String]
+          required :idempotency_key, String, api_name: :idempotencyKey
+
+          # @!attribute dimensions
+          #   Dimensions associated with the usage event
+          #
+          #   @return [Hash{Symbol=>String, Float, Boolean}, nil]
+          optional :dimensions,
+                   -> { Stigg::Internal::Type::HashOf[union: Stigg::V1::EventReportParams::Event::Dimension] }
+
+          # @!attribute resource_id
+          #   Resource id
+          #
+          #   @return [String, nil]
+          optional :resource_id, String, api_name: :resourceId, nil?: true
+
+          # @!attribute timestamp
+          #   Timestamp
+          #
+          #   @return [Time, nil]
+          optional :timestamp, Time
+
+          # @!method initialize(customer_id:, event_name:, idempotency_key:, dimensions: nil, resource_id: nil, timestamp: nil)
+          #   Raw usage event
+          #
+          #   @param customer_id [String] Customer id
+          #
+          #   @param event_name [String] The name of the usage event
+          #
+          #   @param idempotency_key [String] Idempotency key
+          #
+          #   @param dimensions [Hash{Symbol=>String, Float, Boolean}] Dimensions associated with the usage event
+          #
+          #   @param resource_id [String, nil] Resource id
+          #
+          #   @param timestamp [Time] Timestamp
+
+          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/event_report_response.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      # @see Stigg::Resources::V1::Events#report
+      class EventReportResponse < Stigg::Internal::Type::BaseModel
+        # @!attribute data
+        #   Empty success response confirming that events were successfully ingested and
+        #   queued for processing by Stigg's metering system.
+        #
+        #   @return [Object]
+        required :data, Stigg::Internal::Type::Unknown
+
+        # @!method initialize(data:)
+        #   Some parameter documentations has been truncated, see
+        #   {Stigg::Models::V1::EventReportResponse} for more details.
+        #
+        #   Response object
+        #
+        #   @param data [Object] Empty success response confirming that events were successfully ingested and que
+      end
+    end
+  end
+end

data/lib/stigg/models/v1/{subscription_retrieve_response.rb → subscription.rb}

@@ -4,16 +4,19 @@ module Stigg
   module Models
     module V1
       # @see Stigg::Resources::V1::Subscriptions#retrieve
-      class SubscriptionRetrieveResponse < Stigg::Internal::Type::BaseModel
+      class Subscription < Stigg::Internal::Type::BaseModel
         # @!attribute data
+        #   Customer subscription to a plan
         #
-        #   @return [Stigg::Models::V1::SubscriptionRetrieveResponse::Data]
-        required :data, -> { Stigg::Models::V1::SubscriptionRetrieveResponse::Data }
+        #   @return [Stigg::Models::V1::Subscription::Data]
+        required :data, -> { Stigg::V1::Subscription::Data }
 
         # @!method initialize(data:)
-        #   @param data [Stigg::Models::V1::SubscriptionRetrieveResponse::Data]
+        #   Response object
+        #
+        #   @param data [Stigg::Models::V1::Subscription::Data] Customer subscription to a plan
 
-        # @see Stigg::Models::V1::SubscriptionRetrieveResponse#data
+        # @see Stigg::Models::V1::Subscription#data
         class Data < Stigg::Internal::Type::BaseModel
           # @!attribute id
           #   Subscription ID
@@ -42,9 +45,9 @@ module Stigg
           # @!attribute payment_collection
           #   Payment collection
           #
-          #   @return [Symbol, Stigg::Models::V1::SubscriptionRetrieveResponse::Data::PaymentCollection]
+          #   @return [Symbol, Stigg::Models::V1::Subscription::Data::PaymentCollection]
           required :payment_collection,
-                   enum: -> { Stigg::Models::V1::SubscriptionRetrieveResponse::Data::PaymentCollection },
+                   enum: -> { Stigg::V1::Subscription::Data::PaymentCollection },
                    api_name: :paymentCollection
 
           # @!attribute plan_id
@@ -56,9 +59,11 @@ module Stigg
           # @!attribute pricing_type
           #   Pricing type
           #
-          #   @return [Symbol, Stigg::Models::V1::SubscriptionRetrieveResponse::Data::PricingType]
+          #   @return [Symbol, Stigg::Models::V1::Subscription::Data::PricingType]
           required :pricing_type,
-                   enum: -> { Stigg::Models::V1::SubscriptionRetrieveResponse::Data::PricingType },
+                   enum: -> {
+                     Stigg::V1::Subscription::Data::PricingType
+                   },
                    api_name: :pricingType
 
           # @!attribute start_date
@@ -70,8 +75,8 @@ module Stigg
           # @!attribute status
           #   Subscription status
           #
-          #   @return [Symbol, Stigg::Models::V1::SubscriptionRetrieveResponse::Data::Status]
-          required :status, enum: -> { Stigg::Models::V1::SubscriptionRetrieveResponse::Data::Status }
+          #   @return [Symbol, Stigg::Models::V1::Subscription::Data::Status]
+          required :status, enum: -> { Stigg::V1::Subscription::Data::Status }
 
           # @!attribute cancellation_date
           #   Subscription cancellation date
@@ -82,9 +87,9 @@ module Stigg
           # @!attribute cancel_reason
           #   Subscription cancel reason
           #
-          #   @return [Symbol, Stigg::Models::V1::SubscriptionRetrieveResponse::Data::CancelReason, nil]
+          #   @return [Symbol, Stigg::Models::V1::Subscription::Data::CancelReason, nil]
           optional :cancel_reason,
-                   enum: -> { Stigg::Models::V1::SubscriptionRetrieveResponse::Data::CancelReason },
+                   enum: -> { Stigg::V1::Subscription::Data::CancelReason },
                    api_name: :cancelReason,
                    nil?: true
 
@@ -127,12 +132,17 @@ module Stigg
           # @!attribute payment_collection_method
           #   The method used to collect payments for a subscription
           #
-          #   @return [Symbol, Stigg::Models::V1::SubscriptionRetrieveResponse::Data::PaymentCollectionMethod, nil]
+          #   @return [Symbol, Stigg::Models::V1::Subscription::Data::PaymentCollectionMethod, nil]
           optional :payment_collection_method,
-                   enum: -> { Stigg::Models::V1::SubscriptionRetrieveResponse::Data::PaymentCollectionMethod },
+                   enum: -> { Stigg::V1::Subscription::Data::PaymentCollectionMethod },
                    api_name: :paymentCollectionMethod,
                    nil?: true
 
+          # @!attribute prices
+          #
+          #   @return [Array<Stigg::Models::V1::Subscription::Data::Price>, nil]
+          optional :prices, -> { Stigg::Internal::Type::ArrayOf[Stigg::V1::Subscription::Data::Price] }
+
           # @!attribute resource_id
           #   Resource ID
           #
@@ -145,7 +155,9 @@ module Stigg
           #   @return [Time, nil]
           optional :trial_end_date, Time, api_name: :trialEndDate, nil?: true
 
-          # @!method initialize(id:, billing_id:, created_at:, customer_id:, payment_collection:, plan_id:, pricing_type:, start_date:, status:, cancellation_date: nil, cancel_reason: nil, current_billing_period_end: nil, current_billing_period_start: nil, effective_end_date: nil, end_date: nil, metadata: nil, paying_customer_id: nil, payment_collection_method: nil, resource_id: nil, trial_end_date: nil)
+          # @!method initialize(id:, billing_id:, created_at:, customer_id:, payment_collection:, plan_id:, pricing_type:, start_date:, status:, cancellation_date: nil, cancel_reason: nil, current_billing_period_end: nil, current_billing_period_start: nil, effective_end_date: nil, end_date: nil, metadata: nil, paying_customer_id: nil, payment_collection_method: nil, prices: nil, resource_id: nil, trial_end_date: nil)
+          #   Customer subscription to a plan
+          #
           #   @param id [String] Subscription ID
           #
           #   @param billing_id [String, nil] Billing ID
@@ -154,19 +166,19 @@ module Stigg
           #
           #   @param customer_id [String] Customer ID
           #
-          #   @param payment_collection [Symbol, Stigg::Models::V1::SubscriptionRetrieveResponse::Data::PaymentCollection] Payment collection
+          #   @param payment_collection [Symbol, Stigg::Models::V1::Subscription::Data::PaymentCollection] Payment collection
           #
           #   @param plan_id [String] Plan ID
           #
-          #   @param pricing_type [Symbol, Stigg::Models::V1::SubscriptionRetrieveResponse::Data::PricingType] Pricing type
+          #   @param pricing_type [Symbol, Stigg::Models::V1::Subscription::Data::PricingType] Pricing type
           #
           #   @param start_date [Time] Subscription start date
           #
-          #   @param status [Symbol, Stigg::Models::V1::SubscriptionRetrieveResponse::Data::Status] Subscription status
+          #   @param status [Symbol, Stigg::Models::V1::Subscription::Data::Status] Subscription status
           #
           #   @param cancellation_date [Time, nil] Subscription cancellation date
           #
-          #   @param cancel_reason [Symbol, Stigg::Models::V1::SubscriptionRetrieveResponse::Data::CancelReason, nil] Subscription cancel reason
+          #   @param cancel_reason [Symbol, Stigg::Models::V1::Subscription::Data::CancelReason, nil] Subscription cancel reason
           #
           #   @param current_billing_period_end [Time, nil] End of the current billing period
           #
@@ -180,7 +192,9 @@ module Stigg
           #
           #   @param paying_customer_id [String, nil] Paying customer ID for delegated billing
           #
-          #   @param payment_collection_method [Symbol, Stigg::Models::V1::SubscriptionRetrieveResponse::Data::PaymentCollectionMethod, nil] The method used to collect payments for a subscription
+          #   @param payment_collection_method [Symbol, Stigg::Models::V1::Subscription::Data::PaymentCollectionMethod, nil] The method used to collect payments for a subscription
+          #
+          #   @param prices [Array<Stigg::Models::V1::Subscription::Data::Price>]
           #
           #   @param resource_id [String, nil] Resource ID
           #
@@ -188,7 +202,7 @@ module Stigg
 
           # Payment collection
           #
-          # @see Stigg::Models::V1::SubscriptionRetrieveResponse::Data#payment_collection
+          # @see Stigg::Models::V1::Subscription::Data#payment_collection
           module PaymentCollection
             extend Stigg::Internal::Type::Enum
 
@@ -203,7 +217,7 @@ module Stigg
 
           # Pricing type
           #
-          # @see Stigg::Models::V1::SubscriptionRetrieveResponse::Data#pricing_type
+          # @see Stigg::Models::V1::Subscription::Data#pricing_type
           module PricingType
             extend Stigg::Internal::Type::Enum
 
@@ -217,7 +231,7 @@ module Stigg
 
           # Subscription status
           #
-          # @see Stigg::Models::V1::SubscriptionRetrieveResponse::Data#status
+          # @see Stigg::Models::V1::Subscription::Data#status
           module Status
             extend Stigg::Internal::Type::Enum
 
@@ -234,7 +248,7 @@ module Stigg
 
           # Subscription cancel reason
           #
-          # @see Stigg::Models::V1::SubscriptionRetrieveResponse::Data#cancel_reason
+          # @see Stigg::Models::V1::Subscription::Data#cancel_reason
           module CancelReason
             extend Stigg::Internal::Type::Enum
 
@@ -256,7 +270,7 @@ module Stigg
 
           # The method used to collect payments for a subscription
           #
-          # @see Stigg::Models::V1::SubscriptionRetrieveResponse::Data#payment_collection_method
+          # @see Stigg::Models::V1::Subscription::Data#payment_collection_method
           module PaymentCollectionMethod
             extend Stigg::Internal::Type::Enum
 
@@ -267,6 +281,33 @@ module Stigg
             # @!method self.values
             #   @return [Array<Symbol>]
           end
+
+          class Price < Stigg::Internal::Type::BaseModel
+            # @!attribute id
+            #   Price ID
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute created_at
+            #   Creation timestamp
+            #
+            #   @return [String]
+            required :created_at, String, api_name: :createdAt
+
+            # @!attribute updated_at
+            #   Last update timestamp
+            #
+            #   @return [String]
+            required :updated_at, String, api_name: :updatedAt
+
+            # @!method initialize(id:, created_at:, updated_at:)
+            #   @param id [String] Price ID
+            #
+            #   @param created_at [String] Creation timestamp
+            #
+            #   @param updated_at [String] Last update timestamp
+          end
         end
       end
     end

data/lib/stigg/models/v1/subscription_cancel_params.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      # @see Stigg::Resources::V1::Subscriptions#cancel
+      class SubscriptionCancelParams < Stigg::Internal::Type::BaseModel
+        extend Stigg::Internal::Type::RequestParameters::Converter
+        include Stigg::Internal::Type::RequestParameters
+
+        # @!attribute cancellation_action
+        #   Action on cancellation (downgrade or revoke)
+        #
+        #   @return [Symbol, Stigg::Models::V1::SubscriptionCancelParams::CancellationAction, nil]
+        optional :cancellation_action,
+                 enum: -> { Stigg::V1::SubscriptionCancelParams::CancellationAction },
+                 api_name: :cancellationAction
+
+        # @!attribute cancellation_time
+        #   When to cancel (immediate, period end, or date)
+        #
+        #   @return [Symbol, Stigg::Models::V1::SubscriptionCancelParams::CancellationTime, nil]
+        optional :cancellation_time,
+                 enum: -> { Stigg::V1::SubscriptionCancelParams::CancellationTime },
+                 api_name: :cancellationTime
+
+        # @!attribute end_date
+        #   Subscription end date
+        #
+        #   @return [Time, nil]
+        optional :end_date, Time, api_name: :endDate
+
+        # @!attribute prorate
+        #   If set, enables or disables prorating of credits on subscription cancellation.
+        #
+        #   @return [Boolean, nil]
+        optional :prorate, Stigg::Internal::Type::Boolean
+
+        # @!method initialize(cancellation_action: nil, cancellation_time: nil, end_date: nil, prorate: nil, request_options: {})
+        #   @param cancellation_action [Symbol, Stigg::Models::V1::SubscriptionCancelParams::CancellationAction] Action on cancellation (downgrade or revoke)
+        #
+        #   @param cancellation_time [Symbol, Stigg::Models::V1::SubscriptionCancelParams::CancellationTime] When to cancel (immediate, period end, or date)
+        #
+        #   @param end_date [Time] Subscription end date
+        #
+        #   @param prorate [Boolean] If set, enables or disables prorating of credits on subscription cancellation.
+        #
+        #   @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
+
+        # Action on cancellation (downgrade or revoke)
+        module CancellationAction
+          extend Stigg::Internal::Type::Enum
+
+          DEFAULT = :DEFAULT
+          REVOKE_ENTITLEMENTS = :REVOKE_ENTITLEMENTS
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # When to cancel (immediate, period end, or date)
+        module CancellationTime
+          extend Stigg::Internal::Type::Enum
+
+          END_OF_BILLING_PERIOD = :END_OF_BILLING_PERIOD
+          IMMEDIATE = :IMMEDIATE
+          SPECIFIC_DATE = :SPECIFIC_DATE
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end