metronome-sdk 0.1.0.pre.alpha.3 → 0.1.0

data/lib/metronome_sdk/models/discount.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    class Discount < MetronomeSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute product
+      #
+      #   @return [MetronomeSDK::Models::Discount::Product]
+      required :product, -> { MetronomeSDK::Discount::Product }
+
+      # @!attribute schedule
+      #
+      #   @return [MetronomeSDK::Models::SchedulePointInTime]
+      required :schedule, -> { MetronomeSDK::SchedulePointInTime }
+
+      # @!attribute custom_fields
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!attribute netsuite_sales_order_id
+      #   This field's availability is dependent on your client's configuration.
+      #
+      #   @return [String, nil]
+      optional :netsuite_sales_order_id, String
+
+      # @!method initialize(id:, product:, schedule:, custom_fields: nil, name: nil, netsuite_sales_order_id: nil)
+      #   @param id [String]
+      #
+      #   @param product [MetronomeSDK::Models::Discount::Product]
+      #
+      #   @param schedule [MetronomeSDK::Models::SchedulePointInTime]
+      #
+      #   @param custom_fields [Hash{Symbol=>String}]
+      #
+      #   @param name [String]
+      #
+      #   @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
+
+      # @see MetronomeSDK::Models::Discount#product
+      class Product < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!method initialize(id:, name:)
+        #   @param id [String]
+        #   @param name [String]
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/event_type_filter.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    class EventTypeFilter < MetronomeSDK::Internal::Type::BaseModel
+      # @!attribute in_values
+      #   A list of event types that are explicitly included in the billable metric. If
+      #   specified, only events of these types will match the billable metric. Must be
+      #   non-empty if present.
+      #
+      #   @return [Array<String>, nil]
+      optional :in_values, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+      # @!attribute not_in_values
+      #   A list of event types that are explicitly excluded from the billable metric. If
+      #   specified, events of these types will not match the billable metric. Must be
+      #   non-empty if present.
+      #
+      #   @return [Array<String>, nil]
+      optional :not_in_values, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(in_values: nil, not_in_values: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {MetronomeSDK::Models::EventTypeFilter} for more details.
+      #
+      #   An optional filtering rule to match the 'event_type' property of an event.
+      #
+      #   @param in_values [Array<String>] A list of event types that are explicitly included in the billable metric. If sp
+      #
+      #   @param not_in_values [Array<String>] A list of event types that are explicitly excluded from the billable metric. If
+    end
+  end
+end

data/lib/metronome_sdk/models/id.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    class ID < MetronomeSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:)
+      #   @param id [String]
+    end
+  end
+end

data/lib/metronome_sdk/models/override.rb

@@ -0,0 +1,381 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    class Override < MetronomeSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute starting_at
+      #
+      #   @return [Time]
+      required :starting_at, Time
+
+      # @!attribute applicable_product_tags
+      #
+      #   @return [Array<String>, nil]
+      optional :applicable_product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+      # @!attribute credit_type
+      #
+      #   @return [MetronomeSDK::Models::CreditTypeData, nil]
+      optional :credit_type, -> { MetronomeSDK::CreditTypeData }
+
+      # @!attribute ending_before
+      #
+      #   @return [Time, nil]
+      optional :ending_before, Time
+
+      # @!attribute entitled
+      #
+      #   @return [Boolean, nil]
+      optional :entitled, MetronomeSDK::Internal::Type::Boolean
+
+      # @!attribute is_commit_specific
+      #
+      #   @return [Boolean, nil]
+      optional :is_commit_specific, MetronomeSDK::Internal::Type::Boolean
+
+      # @!attribute is_prorated
+      #   Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
+      #   set to true.
+      #
+      #   @return [Boolean, nil]
+      optional :is_prorated, MetronomeSDK::Internal::Type::Boolean
+
+      # @!attribute multiplier
+      #
+      #   @return [Float, nil]
+      optional :multiplier, Float
+
+      # @!attribute override_specifiers
+      #
+      #   @return [Array<MetronomeSDK::Models::Override::OverrideSpecifier>, nil]
+      optional :override_specifiers,
+               -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Override::OverrideSpecifier] }
+
+      # @!attribute override_tiers
+      #
+      #   @return [Array<MetronomeSDK::Models::Override::OverrideTier>, nil]
+      optional :override_tiers,
+               -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Override::OverrideTier] }
+
+      # @!attribute overwrite_rate
+      #
+      #   @return [MetronomeSDK::Models::Override::OverwriteRate, nil]
+      optional :overwrite_rate, -> { MetronomeSDK::Override::OverwriteRate }
+
+      # @!attribute price
+      #   Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type,
+      #   this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.
+      #
+      #   @return [Float, nil]
+      optional :price, Float
+
+      # @!attribute priority
+      #
+      #   @return [Float, nil]
+      optional :priority, Float
+
+      # @!attribute product
+      #
+      #   @return [MetronomeSDK::Models::Override::Product, nil]
+      optional :product, -> { MetronomeSDK::Override::Product }
+
+      # @!attribute quantity
+      #   Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
+      #
+      #   @return [Float, nil]
+      optional :quantity, Float
+
+      # @!attribute rate_type
+      #
+      #   @return [Symbol, MetronomeSDK::Models::Override::RateType, nil]
+      optional :rate_type, enum: -> { MetronomeSDK::Override::RateType }
+
+      # @!attribute target
+      #
+      #   @return [Symbol, MetronomeSDK::Models::Override::Target, nil]
+      optional :target, enum: -> { MetronomeSDK::Override::Target }
+
+      # @!attribute tiers
+      #   Only set for TIERED rate_type.
+      #
+      #   @return [Array<MetronomeSDK::Models::Tier>, nil]
+      optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Tier] }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, MetronomeSDK::Models::Override::Type, nil]
+      optional :type, enum: -> { MetronomeSDK::Override::Type }
+
+      # @!attribute value
+      #   Only set for CUSTOM rate_type. This field is interpreted by custom rate
+      #   processors.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :value, MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]
+
+      # @!method initialize(id:, starting_at:, applicable_product_tags: nil, credit_type: nil, ending_before: nil, entitled: nil, is_commit_specific: nil, is_prorated: nil, multiplier: nil, override_specifiers: nil, override_tiers: nil, overwrite_rate: nil, price: nil, priority: nil, product: nil, quantity: nil, rate_type: nil, target: nil, tiers: nil, type: nil, value: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {MetronomeSDK::Models::Override} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param starting_at [Time]
+      #
+      #   @param applicable_product_tags [Array<String>]
+      #
+      #   @param credit_type [MetronomeSDK::Models::CreditTypeData]
+      #
+      #   @param ending_before [Time]
+      #
+      #   @param entitled [Boolean]
+      #
+      #   @param is_commit_specific [Boolean]
+      #
+      #   @param is_prorated [Boolean] Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
+      #
+      #   @param multiplier [Float]
+      #
+      #   @param override_specifiers [Array<MetronomeSDK::Models::Override::OverrideSpecifier>]
+      #
+      #   @param override_tiers [Array<MetronomeSDK::Models::Override::OverrideTier>]
+      #
+      #   @param overwrite_rate [MetronomeSDK::Models::Override::OverwriteRate]
+      #
+      #   @param price [Float] Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type, t
+      #
+      #   @param priority [Float]
+      #
+      #   @param product [MetronomeSDK::Models::Override::Product]
+      #
+      #   @param quantity [Float] Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
+      #
+      #   @param rate_type [Symbol, MetronomeSDK::Models::Override::RateType]
+      #
+      #   @param target [Symbol, MetronomeSDK::Models::Override::Target]
+      #
+      #   @param tiers [Array<MetronomeSDK::Models::Tier>] Only set for TIERED rate_type.
+      #
+      #   @param type [Symbol, MetronomeSDK::Models::Override::Type]
+      #
+      #   @param value [Hash{Symbol=>Object}] Only set for CUSTOM rate_type. This field is interpreted by custom rate processo
+
+      class OverrideSpecifier < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute billing_frequency
+        #
+        #   @return [Symbol, MetronomeSDK::Models::Override::OverrideSpecifier::BillingFrequency, nil]
+        optional :billing_frequency, enum: -> { MetronomeSDK::Override::OverrideSpecifier::BillingFrequency }
+
+        # @!attribute commit_ids
+        #
+        #   @return [Array<String>, nil]
+        optional :commit_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+        # @!attribute presentation_group_values
+        #
+        #   @return [Hash{Symbol=>String, nil}, nil]
+        optional :presentation_group_values, MetronomeSDK::Internal::Type::HashOf[String, nil?: true]
+
+        # @!attribute pricing_group_values
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]
+
+        # @!attribute product_id
+        #
+        #   @return [String, nil]
+        optional :product_id, String
+
+        # @!attribute product_tags
+        #
+        #   @return [Array<String>, nil]
+        optional :product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+        # @!attribute recurring_commit_ids
+        #
+        #   @return [Array<String>, nil]
+        optional :recurring_commit_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+        # @!attribute recurring_credit_ids
+        #
+        #   @return [Array<String>, nil]
+        optional :recurring_credit_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(billing_frequency: nil, commit_ids: nil, presentation_group_values: nil, pricing_group_values: nil, product_id: nil, product_tags: nil, recurring_commit_ids: nil, recurring_credit_ids: nil)
+        #   @param billing_frequency [Symbol, MetronomeSDK::Models::Override::OverrideSpecifier::BillingFrequency]
+        #   @param commit_ids [Array<String>]
+        #   @param presentation_group_values [Hash{Symbol=>String, nil}]
+        #   @param pricing_group_values [Hash{Symbol=>String}]
+        #   @param product_id [String]
+        #   @param product_tags [Array<String>]
+        #   @param recurring_commit_ids [Array<String>]
+        #   @param recurring_credit_ids [Array<String>]
+
+        # @see MetronomeSDK::Models::Override::OverrideSpecifier#billing_frequency
+        module BillingFrequency
+          extend MetronomeSDK::Internal::Type::Enum
+
+          MONTHLY = :MONTHLY
+          QUARTERLY = :QUARTERLY
+          ANNUAL = :ANNUAL
+          WEEKLY = :WEEKLY
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      class OverrideTier < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute multiplier
+        #
+        #   @return [Float]
+        required :multiplier, Float
+
+        # @!attribute size
+        #
+        #   @return [Float, nil]
+        optional :size, Float
+
+        # @!method initialize(multiplier:, size: nil)
+        #   @param multiplier [Float]
+        #   @param size [Float]
+      end
+
+      # @see MetronomeSDK::Models::Override#overwrite_rate
+      class OverwriteRate < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute rate_type
+        #
+        #   @return [Symbol, MetronomeSDK::Models::Override::OverwriteRate::RateType]
+        required :rate_type, enum: -> { MetronomeSDK::Override::OverwriteRate::RateType }
+
+        # @!attribute credit_type
+        #
+        #   @return [MetronomeSDK::Models::CreditTypeData, nil]
+        optional :credit_type, -> { MetronomeSDK::CreditTypeData }
+
+        # @!attribute custom_rate
+        #   Only set for CUSTOM rate_type. This field is interpreted by custom rate
+        #   processors.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :custom_rate, MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]
+
+        # @!attribute is_prorated
+        #   Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
+        #   set to true.
+        #
+        #   @return [Boolean, nil]
+        optional :is_prorated, MetronomeSDK::Internal::Type::Boolean
+
+        # @!attribute price
+        #   Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type,
+        #   this is a decimal fraction, e.g. use 0.1 for 10%; this must be >=0 and <=1.
+        #
+        #   @return [Float, nil]
+        optional :price, Float
+
+        # @!attribute quantity
+        #   Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
+        #
+        #   @return [Float, nil]
+        optional :quantity, Float
+
+        # @!attribute tiers
+        #   Only set for TIERED rate_type.
+        #
+        #   @return [Array<MetronomeSDK::Models::Tier>, nil]
+        optional :tiers, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Tier] }
+
+        # @!method initialize(rate_type:, credit_type: nil, custom_rate: nil, is_prorated: nil, price: nil, quantity: nil, tiers: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::Override::OverwriteRate} for more details.
+        #
+        #   @param rate_type [Symbol, MetronomeSDK::Models::Override::OverwriteRate::RateType]
+        #
+        #   @param credit_type [MetronomeSDK::Models::CreditTypeData]
+        #
+        #   @param custom_rate [Hash{Symbol=>Object}] Only set for CUSTOM rate_type. This field is interpreted by custom rate processo
+        #
+        #   @param is_prorated [Boolean] Default proration configuration. Only valid for SUBSCRIPTION rate_type. Must be
+        #
+        #   @param price [Float] Default price. For FLAT rate_type, this must be >=0. For PERCENTAGE rate_type, t
+        #
+        #   @param quantity [Float] Default quantity. For SUBSCRIPTION rate_type, this must be >=0.
+        #
+        #   @param tiers [Array<MetronomeSDK::Models::Tier>] Only set for TIERED rate_type.
+
+        # @see MetronomeSDK::Models::Override::OverwriteRate#rate_type
+        module RateType
+          extend MetronomeSDK::Internal::Type::Enum
+
+          FLAT = :FLAT
+          PERCENTAGE = :PERCENTAGE
+          SUBSCRIPTION = :SUBSCRIPTION
+          TIERED = :TIERED
+          CUSTOM = :CUSTOM
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # @see MetronomeSDK::Models::Override#product
+      class Product < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!method initialize(id:, name:)
+        #   @param id [String]
+        #   @param name [String]
+      end
+
+      # @see MetronomeSDK::Models::Override#rate_type
+      module RateType
+        extend MetronomeSDK::Internal::Type::Enum
+
+        FLAT = :FLAT
+        PERCENTAGE = :PERCENTAGE
+        SUBSCRIPTION = :SUBSCRIPTION
+        TIERED = :TIERED
+        CUSTOM = :CUSTOM
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see MetronomeSDK::Models::Override#target
+      module Target
+        extend MetronomeSDK::Internal::Type::Enum
+
+        COMMIT_RATE = :COMMIT_RATE
+        LIST_RATE = :LIST_RATE
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see MetronomeSDK::Models::Override#type
+      module Type
+        extend MetronomeSDK::Internal::Type::Enum
+
+        OVERWRITE = :OVERWRITE
+        MULTIPLIER = :MULTIPLIER
+        TIERED = :TIERED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/pro_service.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    class ProService < MetronomeSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute max_amount
+      #   Maximum amount for the term.
+      #
+      #   @return [Float]
+      required :max_amount, Float
+
+      # @!attribute product_id
+      #
+      #   @return [String]
+      required :product_id, String
+
+      # @!attribute quantity
+      #   Quantity for the charge. Will be multiplied by unit_price to determine the
+      #   amount.
+      #
+      #   @return [Float]
+      required :quantity, Float
+
+      # @!attribute unit_price
+      #   Unit price for the charge. Will be multiplied by quantity to determine the
+      #   amount and must be specified.
+      #
+      #   @return [Float]
+      required :unit_price, Float
+
+      # @!attribute custom_fields
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
+
+      # @!attribute description
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute netsuite_sales_order_id
+      #   This field's availability is dependent on your client's configuration.
+      #
+      #   @return [String, nil]
+      optional :netsuite_sales_order_id, String
+
+      # @!method initialize(id:, max_amount:, product_id:, quantity:, unit_price:, custom_fields: nil, description: nil, netsuite_sales_order_id: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {MetronomeSDK::Models::ProService} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param max_amount [Float] Maximum amount for the term.
+      #
+      #   @param product_id [String]
+      #
+      #   @param quantity [Float] Quantity for the charge. Will be multiplied by unit_price to determine the amoun
+      #
+      #   @param unit_price [Float] Unit price for the charge. Will be multiplied by quantity to determine the amoun
+      #
+      #   @param custom_fields [Hash{Symbol=>String}]
+      #
+      #   @param description [String]
+      #
+      #   @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
+    end
+  end
+end

data/lib/metronome_sdk/models/property_filter.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    class PropertyFilter < MetronomeSDK::Internal::Type::BaseModel
+      # @!attribute name
+      #   The name of the event property.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute exists
+      #   Determines whether the property must exist in the event. If true, only events
+      #   with this property will pass the filter. If false, only events without this
+      #   property will pass the filter. If null or omitted, the existence of the property
+      #   is optional.
+      #
+      #   @return [Boolean, nil]
+      optional :exists, MetronomeSDK::Internal::Type::Boolean
+
+      # @!attribute in_values
+      #   Specifies the allowed values for the property to match an event. An event will
+      #   pass the filter only if its property value is included in this list. If
+      #   undefined, all property values will pass the filter. Must be non-empty if
+      #   present.
+      #
+      #   @return [Array<String>, nil]
+      optional :in_values, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+      # @!attribute not_in_values
+      #   Specifies the values that prevent an event from matching the filter. An event
+      #   will not pass the filter if its property value is included in this list. If null
+      #   or empty, all property values will pass the filter. Must be non-empty if
+      #   present.
+      #
+      #   @return [Array<String>, nil]
+      optional :not_in_values, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(name:, exists: nil, in_values: nil, not_in_values: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {MetronomeSDK::Models::PropertyFilter} for more details.
+      #
+      #   @param name [String] The name of the event property.
+      #
+      #   @param exists [Boolean] Determines whether the property must exist in the event. If true, only events wi
+      #
+      #   @param in_values [Array<String>] Specifies the allowed values for the property to match an event. An event will p
+      #
+      #   @param not_in_values [Array<String>] Specifies the values that prevent an event from matching the filter. An event wi
+    end
+  end
+end