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

data/lib/metronome_sdk/models/rate.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    class Rate < MetronomeSDK::Internal::Type::BaseModel
+      # @!attribute rate_type
+      #
+      #   @return [Symbol, MetronomeSDK::Models::Rate::RateType]
+      required :rate_type, enum: -> { MetronomeSDK::Rate::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 pricing_group_values
+      #   if pricing groups are used, this will contain the values used to calculate the
+      #   price
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]
+
+      # @!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] }
+
+      # @!attribute use_list_prices
+      #   Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
+      #   using list prices rather than the standard rates for this product on the
+      #   contract.
+      #
+      #   @return [Boolean, nil]
+      optional :use_list_prices, MetronomeSDK::Internal::Type::Boolean
+
+      # @!method initialize(rate_type:, credit_type: nil, custom_rate: nil, is_prorated: nil, price: nil, pricing_group_values: nil, quantity: nil, tiers: nil, use_list_prices: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {MetronomeSDK::Models::Rate} for more details.
+      #
+      #   @param rate_type [Symbol, MetronomeSDK::Models::Rate::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 pricing_group_values [Hash{Symbol=>String}] if pricing groups are used, this will contain the values used to calculate the p
+      #
+      #   @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.
+      #
+      #   @param use_list_prices [Boolean] Only set for PERCENTAGE rate_type. Defaults to false. If true, rate is computed
+
+      # @see MetronomeSDK::Models::Rate#rate_type
+      module RateType
+        extend MetronomeSDK::Internal::Type::Enum
+
+        FLAT = :FLAT
+        PERCENTAGE = :PERCENTAGE
+        SUBSCRIPTION = :SUBSCRIPTION
+        CUSTOM = :CUSTOM
+        TIERED = :TIERED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/schedule_duration.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    class ScheduleDuration < MetronomeSDK::Internal::Type::BaseModel
+      # @!attribute schedule_items
+      #
+      #   @return [Array<MetronomeSDK::Models::ScheduleDuration::ScheduleItem>]
+      required :schedule_items,
+               -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::ScheduleDuration::ScheduleItem] }
+
+      # @!attribute credit_type
+      #
+      #   @return [MetronomeSDK::Models::CreditTypeData, nil]
+      optional :credit_type, -> { MetronomeSDK::CreditTypeData }
+
+      # @!method initialize(schedule_items:, credit_type: nil)
+      #   @param schedule_items [Array<MetronomeSDK::Models::ScheduleDuration::ScheduleItem>]
+      #   @param credit_type [MetronomeSDK::Models::CreditTypeData]
+
+      class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute amount
+        #
+        #   @return [Float]
+        required :amount, Float
+
+        # @!attribute ending_before
+        #
+        #   @return [Time]
+        required :ending_before, Time
+
+        # @!attribute starting_at
+        #
+        #   @return [Time]
+        required :starting_at, Time
+
+        # @!method initialize(id:, amount:, ending_before:, starting_at:)
+        #   @param id [String]
+        #   @param amount [Float]
+        #   @param ending_before [Time]
+        #   @param starting_at [Time]
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/schedule_point_in_time.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    class SchedulePointInTime < MetronomeSDK::Internal::Type::BaseModel
+      # @!attribute credit_type
+      #
+      #   @return [MetronomeSDK::Models::CreditTypeData, nil]
+      optional :credit_type, -> { MetronomeSDK::CreditTypeData }
+
+      # @!attribute schedule_items
+      #
+      #   @return [Array<MetronomeSDK::Models::SchedulePointInTime::ScheduleItem>, nil]
+      optional :schedule_items,
+               -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::SchedulePointInTime::ScheduleItem] }
+
+      # @!method initialize(credit_type: nil, schedule_items: nil)
+      #   @param credit_type [MetronomeSDK::Models::CreditTypeData]
+      #   @param schedule_items [Array<MetronomeSDK::Models::SchedulePointInTime::ScheduleItem>]
+
+      class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute amount
+        #
+        #   @return [Float]
+        required :amount, Float
+
+        # @!attribute quantity
+        #
+        #   @return [Float]
+        required :quantity, Float
+
+        # @!attribute timestamp
+        #
+        #   @return [Time]
+        required :timestamp, Time
+
+        # @!attribute unit_price
+        #
+        #   @return [Float]
+        required :unit_price, Float
+
+        # @!attribute invoice_id
+        #
+        #   @return [String, nil]
+        optional :invoice_id, String, nil?: true
+
+        # @!method initialize(id:, amount:, quantity:, timestamp:, unit_price:, invoice_id: nil)
+        #   @param id [String]
+        #   @param amount [Float]
+        #   @param quantity [Float]
+        #   @param timestamp [Time]
+        #   @param unit_price [Float]
+        #   @param invoice_id [String, nil]
+      end
+    end
+  end
+end

data/lib/metronome_sdk/models/scheduled_charge.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    class ScheduledCharge < MetronomeSDK::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute product
+      #
+      #   @return [MetronomeSDK::Models::ScheduledCharge::Product]
+      required :product, -> { MetronomeSDK::ScheduledCharge::Product }
+
+      # @!attribute schedule
+      #
+      #   @return [MetronomeSDK::Models::SchedulePointInTime]
+      required :schedule, -> { MetronomeSDK::SchedulePointInTime }
+
+      # @!attribute archived_at
+      #
+      #   @return [Time, nil]
+      optional :archived_at, Time
+
+      # @!attribute custom_fields
+      #
+      #   @return [Hash{Symbol=>String}, nil]
+      optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
+
+      # @!attribute name
+      #   displayed on invoices
+      #
+      #   @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:, archived_at: nil, custom_fields: nil, name: nil, netsuite_sales_order_id: nil)
+      #   @param id [String]
+      #
+      #   @param product [MetronomeSDK::Models::ScheduledCharge::Product]
+      #
+      #   @param schedule [MetronomeSDK::Models::SchedulePointInTime]
+      #
+      #   @param archived_at [Time]
+      #
+      #   @param custom_fields [Hash{Symbol=>String}]
+      #
+      #   @param name [String] displayed on invoices
+      #
+      #   @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
+
+      # @see MetronomeSDK::Models::ScheduledCharge#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/tier.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    class Tier < MetronomeSDK::Internal::Type::BaseModel
+      # @!attribute price
+      #
+      #   @return [Float]
+      required :price, Float
+
+      # @!attribute size
+      #
+      #   @return [Float, nil]
+      optional :size, Float
+
+      # @!method initialize(price:, size: nil)
+      #   @param price [Float]
+      #   @param size [Float]
+    end
+  end
+end

data/lib/metronome_sdk/models/v1/alert_archive_response.rb

@@ -7,22 +7,11 @@ module MetronomeSDK
       class AlertArchiveResponse < MetronomeSDK::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [MetronomeSDK::Models::V1::AlertArchiveResponse::Data]
-        required :data, -> { MetronomeSDK::Models::V1::AlertArchiveResponse::Data }
+        #   @return [MetronomeSDK::Models::ID]
+        required :data, -> { MetronomeSDK::ID }
 
         # @!method initialize(data:)
-        #   @param data [MetronomeSDK::Models::V1::AlertArchiveResponse::Data]
-
-        # @see MetronomeSDK::Models::V1::AlertArchiveResponse#data
-        class Data < MetronomeSDK::Internal::Type::BaseModel
-          # @!attribute id
-          #
-          #   @return [String]
-          required :id, String
-
-          # @!method initialize(id:)
-          #   @param id [String]
-        end
+        #   @param data [MetronomeSDK::Models::ID]
       end
     end
   end

data/lib/metronome_sdk/models/v1/alert_create_params.rb

@@ -43,6 +43,9 @@ module MetronomeSDK
         optional :credit_grant_type_filters, MetronomeSDK::Internal::Type::ArrayOf[String]
 
         # @!attribute credit_type_id
+        #   ID of the credit's currency, defaults to USD. If the specific alert type
+        #   requires a pricing unit/currency, find the ID in the
+        #   [Metronome app](https://app.metronome.com/offering/pricing-units).
         #
         #   @return [String, nil]
         optional :credit_type_id, String
@@ -115,7 +118,7 @@ module MetronomeSDK
         #
         #   @param credit_grant_type_filters [Array<String>] An array of strings, representing a way to filter the credit grant this alert ap
         #
-        #   @param credit_type_id [String]
+        #   @param credit_type_id [String] ID of the credit's currency, defaults to USD. If the specific alert type require
         #
         #   @param custom_field_filters [Array<MetronomeSDK::Models::V1::AlertCreateParams::CustomFieldFilter>] A list of custom field filters for alert types that support advanced filtering.
         #

data/lib/metronome_sdk/models/v1/alert_create_response.rb

@@ -7,22 +7,11 @@ module MetronomeSDK
       class AlertCreateResponse < MetronomeSDK::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [MetronomeSDK::Models::V1::AlertCreateResponse::Data]
-        required :data, -> { MetronomeSDK::Models::V1::AlertCreateResponse::Data }
+        #   @return [MetronomeSDK::Models::ID]
+        required :data, -> { MetronomeSDK::ID }
 
         # @!method initialize(data:)
-        #   @param data [MetronomeSDK::Models::V1::AlertCreateResponse::Data]
-
-        # @see MetronomeSDK::Models::V1::AlertCreateResponse#data
-        class Data < MetronomeSDK::Internal::Type::BaseModel
-          # @!attribute id
-          #
-          #   @return [String]
-          required :id, String
-
-          # @!method initialize(id:)
-          #   @param id [String]
-        end
+        #   @param data [MetronomeSDK::Models::ID]
       end
     end
   end

data/lib/metronome_sdk/models/v1/billable_metric_archive_params.rb

@@ -4,17 +4,11 @@ module MetronomeSDK
   module Models
     module V1
       # @see MetronomeSDK::Resources::V1::BillableMetrics#archive
-      class BillableMetricArchiveParams < MetronomeSDK::Internal::Type::BaseModel
+      class BillableMetricArchiveParams < MetronomeSDK::Models::ID
         extend MetronomeSDK::Internal::Type::RequestParameters::Converter
         include MetronomeSDK::Internal::Type::RequestParameters
 
-        # @!attribute id
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!method initialize(id:, request_options: {})
-        #   @param id [String]
+        # @!method initialize(request_options: {})
         #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/metronome_sdk/models/v1/billable_metric_archive_response.rb

@@ -7,22 +7,11 @@ module MetronomeSDK
       class BillableMetricArchiveResponse < MetronomeSDK::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [MetronomeSDK::Models::V1::BillableMetricArchiveResponse::Data]
-        required :data, -> { MetronomeSDK::Models::V1::BillableMetricArchiveResponse::Data }
+        #   @return [MetronomeSDK::Models::ID]
+        required :data, -> { MetronomeSDK::ID }
 
         # @!method initialize(data:)
-        #   @param data [MetronomeSDK::Models::V1::BillableMetricArchiveResponse::Data]
-
-        # @see MetronomeSDK::Models::V1::BillableMetricArchiveResponse#data
-        class Data < MetronomeSDK::Internal::Type::BaseModel
-          # @!attribute id
-          #
-          #   @return [String]
-          required :id, String
-
-          # @!method initialize(id:)
-          #   @param id [String]
-        end
+        #   @param data [MetronomeSDK::Models::ID]
       end
     end
   end

data/lib/metronome_sdk/models/v1/billable_metric_create_params.rb

@@ -36,8 +36,8 @@ module MetronomeSDK
         # @!attribute event_type_filter
         #   An optional filtering rule to match the 'event_type' property of an event.
         #
-        #   @return [MetronomeSDK::Models::V1::BillableMetricCreateParams::EventTypeFilter, nil]
-        optional :event_type_filter, -> { MetronomeSDK::V1::BillableMetricCreateParams::EventTypeFilter }
+        #   @return [MetronomeSDK::Models::EventTypeFilter, nil]
+        optional :event_type_filter, -> { MetronomeSDK::EventTypeFilter }
 
         # @!attribute group_keys
         #   Property names that are used to group usage costs on an invoice. Each entry
@@ -52,11 +52,8 @@ module MetronomeSDK
         #   rule on an event property. All rules must pass for the event to match the
         #   billable metric.
         #
-        #   @return [Array<MetronomeSDK::Models::V1::BillableMetricCreateParams::PropertyFilter>, nil]
-        optional :property_filters,
-                 -> {
-                   MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::BillableMetricCreateParams::PropertyFilter]
-                 }
+        #   @return [Array<MetronomeSDK::Models::PropertyFilter>, nil]
+        optional :property_filters, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::PropertyFilter] }
 
         # @!attribute sql
         #   The SQL query associated with the billable metric. This field is mutually
@@ -79,11 +76,11 @@ module MetronomeSDK
         #
         #   @param custom_fields [Hash{Symbol=>String}] Custom fields to attach to the billable metric.
         #
-        #   @param event_type_filter [MetronomeSDK::Models::V1::BillableMetricCreateParams::EventTypeFilter] An optional filtering rule to match the 'event_type' property of an event.
+        #   @param event_type_filter [MetronomeSDK::Models::EventTypeFilter] An optional filtering rule to match the 'event_type' property of an event.
         #
         #   @param group_keys [Array<Array<String>>] Property names that are used to group usage costs on an invoice. Each entry repr
         #
-        #   @param property_filters [Array<MetronomeSDK::Models::V1::BillableMetricCreateParams::PropertyFilter>] A list of filters to match events to this billable metric. Each filter defines a
+        #   @param property_filters [Array<MetronomeSDK::Models::PropertyFilter>] A list of filters to match events to this billable metric. Each filter defines a
         #
         #   @param sql [String] The SQL query associated with the billable metric. This field is mutually exclus
         #
@@ -102,83 +99,6 @@ module MetronomeSDK
           # @!method self.values
           #   @return [Array<Symbol>]
         end
-
-        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::V1::BillableMetricCreateParams::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
-
-        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::V1::BillableMetricCreateParams::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
   end

data/lib/metronome_sdk/models/v1/billable_metric_create_response.rb

@@ -7,22 +7,11 @@ module MetronomeSDK
       class BillableMetricCreateResponse < MetronomeSDK::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [MetronomeSDK::Models::V1::BillableMetricCreateResponse::Data]
-        required :data, -> { MetronomeSDK::Models::V1::BillableMetricCreateResponse::Data }
+        #   @return [MetronomeSDK::Models::ID]
+        required :data, -> { MetronomeSDK::ID }
 
         # @!method initialize(data:)
-        #   @param data [MetronomeSDK::Models::V1::BillableMetricCreateResponse::Data]
-
-        # @see MetronomeSDK::Models::V1::BillableMetricCreateResponse#data
-        class Data < MetronomeSDK::Internal::Type::BaseModel
-          # @!attribute id
-          #
-          #   @return [String]
-          required :id, String
-
-          # @!method initialize(id:)
-          #   @param id [String]
-        end
+        #   @param data [MetronomeSDK::Models::ID]
       end
     end
   end