stigg 0.1.0.pre.alpha.1

data/lib/stigg/models/v1/customers/promotional_create_response.rb

@@ -0,0 +1,268 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      module Customers
+        # @see Stigg::Resources::V1::Customers::Promotional#create
+        class PromotionalCreateResponse < Stigg::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [Array<Stigg::Models::V1::Customers::PromotionalCreateResponse::Data>]
+          required :data,
+                   -> { Stigg::Internal::Type::ArrayOf[Stigg::Models::V1::Customers::PromotionalCreateResponse::Data] }
+
+          # @!method initialize(data:)
+          #   @param data [Array<Stigg::Models::V1::Customers::PromotionalCreateResponse::Data>]
+
+          class Data < Stigg::Internal::Type::BaseModel
+            # @!attribute id
+            #   Unique identifier for the entity
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute created_at
+            #   Timestamp of when the record was created
+            #
+            #   @return [Time]
+            required :created_at, Time, api_name: :createdAt
+
+            # @!attribute description
+            #   The description of the entitlement
+            #
+            #   @return [String, nil]
+            required :description, String, nil?: true
+
+            # @!attribute end_date
+            #   The end date of the promotional entitlement
+            #
+            #   @return [Time, nil]
+            required :end_date, Time, api_name: :endDate, nil?: true
+
+            # @!attribute enum_values
+            #   The enum values of the entitlement
+            #
+            #   @return [Array<String>, nil]
+            required :enum_values, Stigg::Internal::Type::ArrayOf[String], api_name: :enumValues, nil?: true
+
+            # @!attribute environment_id
+            #   The unique identifier for the environment
+            #
+            #   @return [String]
+            required :environment_id, String, api_name: :environmentId
+
+            # @!attribute feature_group_ids
+            #   Feature group IDs associated with this entitlement
+            #
+            #   @return [Array<String>, nil]
+            required :feature_group_ids,
+                     Stigg::Internal::Type::ArrayOf[String],
+                     api_name: :featureGroupIds,
+                     nil?: true
+
+            # @!attribute feature_id
+            #   The unique identifier of the entitlement feature
+            #
+            #   @return [String]
+            required :feature_id, String, api_name: :featureId
+
+            # @!attribute has_soft_limit
+            #   Whether the entitlement has a soft limit
+            #
+            #   @return [Boolean, nil]
+            required :has_soft_limit, Stigg::Internal::Type::Boolean, api_name: :hasSoftLimit, nil?: true
+
+            # @!attribute has_unlimited_usage
+            #   Whether the entitlement has an unlimited usage
+            #
+            #   @return [Boolean, nil]
+            required :has_unlimited_usage,
+                     Stigg::Internal::Type::Boolean,
+                     api_name: :hasUnlimitedUsage,
+                     nil?: true
+
+            # @!attribute is_visible
+            #   Whether the entitlement is visible
+            #
+            #   @return [Boolean]
+            required :is_visible, Stigg::Internal::Type::Boolean, api_name: :isVisible
+
+            # @!attribute period
+            #   The grant period of the promotional entitlement
+            #
+            #   @return [Symbol, Stigg::Models::V1::Customers::PromotionalCreateResponse::Data::Period]
+            required :period, enum: -> { Stigg::Models::V1::Customers::PromotionalCreateResponse::Data::Period }
+
+            # @!attribute reset_period
+            #   The reset period of the entitlement
+            #
+            #   @return [Symbol, Stigg::Models::V1::Customers::PromotionalCreateResponse::Data::ResetPeriod, nil]
+            required :reset_period,
+                     enum: -> { Stigg::Models::V1::Customers::PromotionalCreateResponse::Data::ResetPeriod },
+                     api_name: :resetPeriod,
+                     nil?: true
+
+            # @!attribute reset_period_configuration
+            #   The reset period configuration of the entitlement
+            #
+            #   @return [Stigg::Models::V1::Customers::PromotionalCreateResponse::Data::ResetPeriodConfiguration::AccordingTo, nil]
+            required :reset_period_configuration,
+                     union: -> { Stigg::Models::V1::Customers::PromotionalCreateResponse::Data::ResetPeriodConfiguration },
+                     api_name: :resetPeriodConfiguration,
+                     nil?: true
+
+            # @!attribute start_date
+            #   The start date of the entitlement
+            #
+            #   @return [Time]
+            required :start_date, Time, api_name: :startDate
+
+            # @!attribute status
+            #   The status of the entitlement
+            #
+            #   @return [Symbol, Stigg::Models::V1::Customers::PromotionalCreateResponse::Data::Status]
+            required :status, enum: -> { Stigg::Models::V1::Customers::PromotionalCreateResponse::Data::Status }
+
+            # @!attribute updated_at
+            #   Timestamp of when the record was last updated
+            #
+            #   @return [Time]
+            required :updated_at, Time, api_name: :updatedAt
+
+            # @!attribute usage_limit
+            #   The usage limit of the entitlement
+            #
+            #   @return [Float, nil]
+            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:)
+            #   @param id [String] Unique identifier for the entity
+            #
+            #   @param created_at [Time] Timestamp of when the record was created
+            #
+            #   @param description [String, nil] The description of the entitlement
+            #
+            #   @param end_date [Time, nil] The end date of the promotional entitlement
+            #
+            #   @param enum_values [Array<String>, nil] The enum values of the entitlement
+            #
+            #   @param environment_id [String] The unique identifier for the environment
+            #
+            #   @param feature_group_ids [Array<String>, nil] Feature group IDs associated with this entitlement
+            #
+            #   @param feature_id [String] The unique identifier of the entitlement feature
+            #
+            #   @param has_soft_limit [Boolean, nil] Whether the entitlement has a soft limit
+            #
+            #   @param has_unlimited_usage [Boolean, nil] Whether the entitlement has an unlimited usage
+            #
+            #   @param is_visible [Boolean] Whether the entitlement is visible
+            #
+            #   @param period [Symbol, Stigg::Models::V1::Customers::PromotionalCreateResponse::Data::Period] The grant period of the promotional entitlement
+            #
+            #   @param reset_period [Symbol, Stigg::Models::V1::Customers::PromotionalCreateResponse::Data::ResetPeriod, nil] The reset period of the entitlement
+            #
+            #   @param reset_period_configuration [Stigg::Models::V1::Customers::PromotionalCreateResponse::Data::ResetPeriodConfiguration::AccordingTo, 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::PromotionalCreateResponse::Data::Status] The status of the entitlement
+            #
+            #   @param updated_at [Time] Timestamp of when the record was last updated
+            #
+            #   @param usage_limit [Float, nil] The usage limit of the entitlement
+
+            # The grant period of the promotional entitlement
+            #
+            # @see Stigg::Models::V1::Customers::PromotionalCreateResponse::Data#period
+            module Period
+              extend Stigg::Internal::Type::Enum
+
+              PERIOD_1_WEEK = :"1 week"
+              PERIOD_1_MONTH = :"1 month"
+              PERIOD_6_MONTH = :"6 month"
+              PERIOD_1_YEAR = :"1 year"
+              LIFETIME = :lifetime
+              CUSTOM = :custom
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # The reset period of the entitlement
+            #
+            # @see Stigg::Models::V1::Customers::PromotionalCreateResponse::Data#reset_period
+            module ResetPeriod
+              extend Stigg::Internal::Type::Enum
+
+              YEAR = :YEAR
+              MONTH = :MONTH
+              WEEK = :WEEK
+              DAY = :DAY
+              HOUR = :HOUR
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # The reset period configuration of the entitlement
+            #
+            # @see Stigg::Models::V1::Customers::PromotionalCreateResponse::Data#reset_period_configuration
+            module ResetPeriodConfiguration
+              extend Stigg::Internal::Type::Union
+
+              variant -> { Stigg::Models::V1::Customers::PromotionalCreateResponse::Data::ResetPeriodConfiguration::AccordingTo }
+
+              variant -> { Stigg::Models::V1::Customers::PromotionalCreateResponse::Data::ResetPeriodConfiguration::AccordingTo }
+
+              variant -> { Stigg::Models::V1::Customers::PromotionalCreateResponse::Data::ResetPeriodConfiguration::AccordingTo }
+
+              class AccordingTo < Stigg::Internal::Type::BaseModel
+                # @!attribute according_to
+                #   Yearly reset period according to
+                #
+                #   @return [Symbol, Stigg::Models::V1::Customers::PromotionalCreateResponse::Data::ResetPeriodConfiguration::AccordingTo::AccordingTo]
+                required :according_to,
+                         enum: -> { Stigg::Models::V1::Customers::PromotionalCreateResponse::Data::ResetPeriodConfiguration::AccordingTo::AccordingTo },
+                         api_name: :accordingTo
+
+                # @!method initialize(according_to:)
+                #   @param according_to [Symbol, Stigg::Models::V1::Customers::PromotionalCreateResponse::Data::ResetPeriodConfiguration::AccordingTo::AccordingTo] Yearly reset period according to
+
+                # Yearly reset period according to
+                #
+                # @see Stigg::Models::V1::Customers::PromotionalCreateResponse::Data::ResetPeriodConfiguration::AccordingTo#according_to
+                module AccordingTo
+                  extend Stigg::Internal::Type::Enum
+
+                  SUBSCRIPTION_START = :SubscriptionStart
+
+                  # @!method self.values
+                  #   @return [Array<Symbol>]
+                end
+              end
+
+              # @!method self.variants
+              #   @return [Array(Stigg::Models::V1::Customers::PromotionalCreateResponse::Data::ResetPeriodConfiguration::AccordingTo, Stigg::Models::V1::Customers::PromotionalCreateResponse::Data::ResetPeriodConfiguration::AccordingTo, Stigg::Models::V1::Customers::PromotionalCreateResponse::Data::ResetPeriodConfiguration::AccordingTo)]
+            end
+
+            # The status of the entitlement
+            #
+            # @see Stigg::Models::V1::Customers::PromotionalCreateResponse::Data#status
+            module Status
+              extend Stigg::Internal::Type::Enum
+
+              ACTIVE = :Active
+              EXPIRED = :Expired
+              PAUSED = :Paused
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stigg/models/v1/customers/promotional_revoke_params.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      module Customers
+        # @see Stigg::Resources::V1::Customers::Promotional#revoke
+        class PromotionalRevokeParams < Stigg::Internal::Type::BaseModel
+          extend Stigg::Internal::Type::RequestParameters::Converter
+          include Stigg::Internal::Type::RequestParameters
+
+          # @!attribute customer_id
+          #
+          #   @return [String]
+          required :customer_id, String
+
+          # @!method initialize(customer_id:, request_options: {})
+          #   @param customer_id [String]
+          #   @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/stigg/models/v1/customers/promotional_revoke_response.rb

@@ -0,0 +1,268 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      module Customers
+        # @see Stigg::Resources::V1::Customers::Promotional#revoke
+        class PromotionalRevokeResponse < Stigg::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data]
+          required :data, -> { Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data }
+
+          # @!method initialize(data:)
+          #   @param data [Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data]
+
+          # @see Stigg::Models::V1::Customers::PromotionalRevokeResponse#data
+          class Data < Stigg::Internal::Type::BaseModel
+            # @!attribute id
+            #   Unique identifier for the entity
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute created_at
+            #   Timestamp of when the record was created
+            #
+            #   @return [Time]
+            required :created_at, Time, api_name: :createdAt
+
+            # @!attribute description
+            #   The description of the entitlement
+            #
+            #   @return [String, nil]
+            required :description, String, nil?: true
+
+            # @!attribute end_date
+            #   The end date of the promotional entitlement
+            #
+            #   @return [Time, nil]
+            required :end_date, Time, api_name: :endDate, nil?: true
+
+            # @!attribute enum_values
+            #   The enum values of the entitlement
+            #
+            #   @return [Array<String>, nil]
+            required :enum_values, Stigg::Internal::Type::ArrayOf[String], api_name: :enumValues, nil?: true
+
+            # @!attribute environment_id
+            #   The unique identifier for the environment
+            #
+            #   @return [String]
+            required :environment_id, String, api_name: :environmentId
+
+            # @!attribute feature_group_ids
+            #   Feature group IDs associated with this entitlement
+            #
+            #   @return [Array<String>, nil]
+            required :feature_group_ids,
+                     Stigg::Internal::Type::ArrayOf[String],
+                     api_name: :featureGroupIds,
+                     nil?: true
+
+            # @!attribute feature_id
+            #   The unique identifier of the entitlement feature
+            #
+            #   @return [String]
+            required :feature_id, String, api_name: :featureId
+
+            # @!attribute has_soft_limit
+            #   Whether the entitlement has a soft limit
+            #
+            #   @return [Boolean, nil]
+            required :has_soft_limit, Stigg::Internal::Type::Boolean, api_name: :hasSoftLimit, nil?: true
+
+            # @!attribute has_unlimited_usage
+            #   Whether the entitlement has an unlimited usage
+            #
+            #   @return [Boolean, nil]
+            required :has_unlimited_usage,
+                     Stigg::Internal::Type::Boolean,
+                     api_name: :hasUnlimitedUsage,
+                     nil?: true
+
+            # @!attribute is_visible
+            #   Whether the entitlement is visible
+            #
+            #   @return [Boolean]
+            required :is_visible, Stigg::Internal::Type::Boolean, api_name: :isVisible
+
+            # @!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 }
+
+            # @!attribute reset_period
+            #   The reset period of the entitlement
+            #
+            #   @return [Symbol, Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::ResetPeriod, nil]
+            required :reset_period,
+                     enum: -> { Stigg::Models::V1::Customers::PromotionalRevokeResponse::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]
+            required :reset_period_configuration,
+                     union: -> { Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::ResetPeriodConfiguration },
+                     api_name: :resetPeriodConfiguration,
+                     nil?: true
+
+            # @!attribute start_date
+            #   The start date of the entitlement
+            #
+            #   @return [Time]
+            required :start_date, Time, api_name: :startDate
+
+            # @!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 }
+
+            # @!attribute updated_at
+            #   Timestamp of when the record was last updated
+            #
+            #   @return [Time]
+            required :updated_at, Time, api_name: :updatedAt
+
+            # @!attribute usage_limit
+            #   The usage limit of the entitlement
+            #
+            #   @return [Float, nil]
+            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:)
+            #   @param id [String] Unique identifier for the entity
+            #
+            #   @param created_at [Time] Timestamp of when the record was created
+            #
+            #   @param description [String, nil] The description of the entitlement
+            #
+            #   @param end_date [Time, nil] The end date of the promotional entitlement
+            #
+            #   @param enum_values [Array<String>, nil] The enum values of the entitlement
+            #
+            #   @param environment_id [String] The unique identifier for the environment
+            #
+            #   @param feature_group_ids [Array<String>, nil] Feature group IDs associated with this entitlement
+            #
+            #   @param feature_id [String] The unique identifier of the entitlement feature
+            #
+            #   @param has_soft_limit [Boolean, nil] Whether the entitlement has a soft limit
+            #
+            #   @param has_unlimited_usage [Boolean, nil] Whether the entitlement has an unlimited usage
+            #
+            #   @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 reset_period [Symbol, Stigg::Models::V1::Customers::PromotionalRevokeResponse::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 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 updated_at [Time] Timestamp of when the record was last updated
+            #
+            #   @param usage_limit [Float, nil] The usage limit of the entitlement
+
+            # The grant period of the promotional entitlement
+            #
+            # @see Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data#period
+            module Period
+              extend Stigg::Internal::Type::Enum
+
+              PERIOD_1_WEEK = :"1 week"
+              PERIOD_1_MONTH = :"1 month"
+              PERIOD_6_MONTH = :"6 month"
+              PERIOD_1_YEAR = :"1 year"
+              LIFETIME = :lifetime
+              CUSTOM = :custom
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # The reset period of the entitlement
+            #
+            # @see Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data#reset_period
+            module ResetPeriod
+              extend Stigg::Internal::Type::Enum
+
+              YEAR = :YEAR
+              MONTH = :MONTH
+              WEEK = :WEEK
+              DAY = :DAY
+              HOUR = :HOUR
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # The reset period configuration of the entitlement
+            #
+            # @see Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data#reset_period_configuration
+            module ResetPeriodConfiguration
+              extend Stigg::Internal::Type::Union
+
+              variant -> { Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::ResetPeriodConfiguration::AccordingTo }
+
+              variant -> { Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::ResetPeriodConfiguration::AccordingTo }
+
+              variant -> { Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::ResetPeriodConfiguration::AccordingTo }
+
+              class AccordingTo < Stigg::Internal::Type::BaseModel
+                # @!attribute according_to
+                #   Yearly reset period according to
+                #
+                #   @return [Symbol, Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::ResetPeriodConfiguration::AccordingTo::AccordingTo]
+                required :according_to,
+                         enum: -> { Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::ResetPeriodConfiguration::AccordingTo::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
+
+                # Yearly reset period according to
+                #
+                # @see Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data::ResetPeriodConfiguration::AccordingTo#according_to
+                module AccordingTo
+                  extend Stigg::Internal::Type::Enum
+
+                  SUBSCRIPTION_START = :SubscriptionStart
+
+                  # @!method self.values
+                  #   @return [Array<Symbol>]
+                end
+              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)]
+            end
+
+            # The status of the entitlement
+            #
+            # @see Stigg::Models::V1::Customers::PromotionalRevokeResponse::Data#status
+            module Status
+              extend Stigg::Internal::Type::Enum
+
+              ACTIVE = :Active
+              EXPIRED = :Expired
+              PAUSED = :Paused
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/stigg/models/v1/customers/usage_retrieve_params.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Stigg
+  module Models
+    module V1
+      module Customers
+        # @see Stigg::Resources::V1::Customers::Usage#retrieve
+        class UsageRetrieveParams < Stigg::Internal::Type::BaseModel
+          extend Stigg::Internal::Type::RequestParameters::Converter
+          include Stigg::Internal::Type::RequestParameters
+
+          # @!attribute customer_id
+          #
+          #   @return [String]
+          required :customer_id, String
+
+          # @!attribute start_date
+          #   The start date of the range
+          #
+          #   @return [Time]
+          required :start_date, Time
+
+          # @!attribute end_date
+          #   The end date of the range
+          #
+          #   @return [Time, nil]
+          optional :end_date, Time
+
+          # @!attribute group_by
+          #
+          #   @return [String, nil]
+          optional :group_by, String
+
+          # @!attribute resource_id
+          #   Resource id
+          #
+          #   @return [String, nil]
+          optional :resource_id, String, nil?: true
+
+          # @!method initialize(customer_id:, start_date:, end_date: nil, group_by: nil, resource_id: nil, request_options: {})
+          #   @param customer_id [String]
+          #
+          #   @param start_date [Time] The start date of the range
+          #
+          #   @param end_date [Time] The end date of the range
+          #
+          #   @param group_by [String]
+          #
+          #   @param resource_id [String, nil] Resource id
+          #
+          #   @param request_options [Stigg::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end