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

data/lib/metronome_sdk/models/scheduled_charge.rb

@@ -1,76 +0,0 @@
-# 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::ScheduledCharge::Product]
-      required :product, -> { MetronomeSDK::ScheduledCharge::Product }
-
-      # @!attribute schedule
-      #
-      #   @return [MetronomeSDK::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::ScheduledCharge::Product]
-      #
-      #   @param schedule [MetronomeSDK::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::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

@@ -1,21 +0,0 @@
-# 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/contracts/product_list_item_state.rb

@@ -1,148 +0,0 @@
-# frozen_string_literal: true
-
-module MetronomeSDK
-  module Models
-    module V1
-      module Contracts
-        class ProductListItemState < MetronomeSDK::Internal::Type::BaseModel
-          # @!attribute created_at
-          #
-          #   @return [Time]
-          required :created_at, Time
-
-          # @!attribute created_by
-          #
-          #   @return [String]
-          required :created_by, String
-
-          # @!attribute name
-          #
-          #   @return [String]
-          required :name, String
-
-          # @!attribute billable_metric_id
-          #
-          #   @return [String, nil]
-          optional :billable_metric_id, String
-
-          # @!attribute composite_product_ids
-          #
-          #   @return [Array<String>, nil]
-          optional :composite_product_ids, MetronomeSDK::Internal::Type::ArrayOf[String]
-
-          # @!attribute composite_tags
-          #
-          #   @return [Array<String>, nil]
-          optional :composite_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
-
-          # @!attribute exclude_free_usage
-          #
-          #   @return [Boolean, nil]
-          optional :exclude_free_usage, MetronomeSDK::Internal::Type::Boolean
-
-          # @!attribute is_refundable
-          #   This field's availability is dependent on your client's configuration.
-          #
-          #   @return [Boolean, nil]
-          optional :is_refundable, MetronomeSDK::Internal::Type::Boolean
-
-          # @!attribute netsuite_internal_item_id
-          #   This field's availability is dependent on your client's configuration.
-          #
-          #   @return [String, nil]
-          optional :netsuite_internal_item_id, String
-
-          # @!attribute netsuite_overage_item_id
-          #   This field's availability is dependent on your client's configuration.
-          #
-          #   @return [String, nil]
-          optional :netsuite_overage_item_id, String
-
-          # @!attribute presentation_group_key
-          #   For USAGE products only. Groups usage line items on invoices. The superset of
-          #   values in the pricing group key and presentation group key must be set as one
-          #   compound group key on the billable metric.
-          #
-          #   @return [Array<String>, nil]
-          optional :presentation_group_key, MetronomeSDK::Internal::Type::ArrayOf[String]
-
-          # @!attribute pricing_group_key
-          #   For USAGE products only. If set, pricing for this product will be determined for
-          #   each pricing_group_key value, as opposed to the product as a whole. The superset
-          #   of values in the pricing group key and presentation group key must be set as one
-          #   compound group key on the billable metric.
-          #
-          #   @return [Array<String>, nil]
-          optional :pricing_group_key, MetronomeSDK::Internal::Type::ArrayOf[String]
-
-          # @!attribute quantity_conversion
-          #   Optional. Only valid for USAGE products. If provided, the quantity will be
-          #   converted using the provided conversion factor and operation. For example, if
-          #   the operation is "multiply" and the conversion factor is 100, then the quantity
-          #   will be multiplied by 100. This can be used in cases where data is sent in one
-          #   unit and priced in another. For example, data could be sent in MB and priced in
-          #   GB. In this case, the conversion factor would be 1024 and the operation would be
-          #   "divide".
-          #
-          #   @return [MetronomeSDK::V1::Contracts::QuantityConversion, nil]
-          optional :quantity_conversion, -> { MetronomeSDK::V1::Contracts::QuantityConversion }, nil?: true
-
-          # @!attribute quantity_rounding
-          #   Optional. Only valid for USAGE products. If provided, the quantity will be
-          #   rounded using the provided rounding method and decimal places. For example, if
-          #   the method is "round up" and the decimal places is 0, then the quantity will be
-          #   rounded up to the nearest integer.
-          #
-          #   @return [MetronomeSDK::V1::Contracts::QuantityRounding, nil]
-          optional :quantity_rounding, -> { MetronomeSDK::V1::Contracts::QuantityRounding }, nil?: true
-
-          # @!attribute starting_at
-          #
-          #   @return [Time, nil]
-          optional :starting_at, Time
-
-          # @!attribute tags
-          #
-          #   @return [Array<String>, nil]
-          optional :tags, MetronomeSDK::Internal::Type::ArrayOf[String]
-
-          # @!method initialize(created_at:, created_by:, name:, billable_metric_id: nil, composite_product_ids: nil, composite_tags: nil, exclude_free_usage: nil, is_refundable: nil, netsuite_internal_item_id: nil, netsuite_overage_item_id: nil, presentation_group_key: nil, pricing_group_key: nil, quantity_conversion: nil, quantity_rounding: nil, starting_at: nil, tags: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {MetronomeSDK::V1::Contracts::ProductListItemState} for more details.
-          #
-          #   @param created_at [Time]
-          #
-          #   @param created_by [String]
-          #
-          #   @param name [String]
-          #
-          #   @param billable_metric_id [String]
-          #
-          #   @param composite_product_ids [Array<String>]
-          #
-          #   @param composite_tags [Array<String>]
-          #
-          #   @param exclude_free_usage [Boolean]
-          #
-          #   @param is_refundable [Boolean] This field's availability is dependent on your client's configuration.
-          #
-          #   @param netsuite_internal_item_id [String] This field's availability is dependent on your client's configuration.
-          #
-          #   @param netsuite_overage_item_id [String] This field's availability is dependent on your client's configuration.
-          #
-          #   @param presentation_group_key [Array<String>] For USAGE products only. Groups usage line items on invoices. The superset of va
-          #
-          #   @param pricing_group_key [Array<String>] For USAGE products only. If set, pricing for this product will be determined for
-          #
-          #   @param quantity_conversion [MetronomeSDK::V1::Contracts::QuantityConversion, nil] Optional. Only valid for USAGE products. If provided, the quantity will be conve
-          #
-          #   @param quantity_rounding [MetronomeSDK::V1::Contracts::QuantityRounding, nil] Optional. Only valid for USAGE products. If provided, the quantity will be round
-          #
-          #   @param starting_at [Time]
-          #
-          #   @param tags [Array<String>]
-        end
-      end
-    end
-  end
-end

data/lib/metronome_sdk/models/v1/contracts/quantity_conversion.rb

@@ -1,57 +0,0 @@
-# frozen_string_literal: true
-
-module MetronomeSDK
-  module Models
-    module V1
-      module Contracts
-        class QuantityConversion < MetronomeSDK::Internal::Type::BaseModel
-          # @!attribute conversion_factor
-          #   The factor to multiply or divide the quantity by.
-          #
-          #   @return [Float]
-          required :conversion_factor, Float
-
-          # @!attribute operation
-          #   The operation to perform on the quantity
-          #
-          #   @return [Symbol, MetronomeSDK::V1::Contracts::QuantityConversion::Operation]
-          required :operation, enum: -> { MetronomeSDK::V1::Contracts::QuantityConversion::Operation }
-
-          # @!attribute name
-          #   Optional name for this conversion.
-          #
-          #   @return [String, nil]
-          optional :name, String
-
-          # @!method initialize(conversion_factor:, operation:, name: nil)
-          #   Optional. Only valid for USAGE products. If provided, the quantity will be
-          #   converted using the provided conversion factor and operation. For example, if
-          #   the operation is "multiply" and the conversion factor is 100, then the quantity
-          #   will be multiplied by 100. This can be used in cases where data is sent in one
-          #   unit and priced in another. For example, data could be sent in MB and priced in
-          #   GB. In this case, the conversion factor would be 1024 and the operation would be
-          #   "divide".
-          #
-          #   @param conversion_factor [Float] The factor to multiply or divide the quantity by.
-          #
-          #   @param operation [Symbol, MetronomeSDK::V1::Contracts::QuantityConversion::Operation] The operation to perform on the quantity
-          #
-          #   @param name [String] Optional name for this conversion.
-
-          # The operation to perform on the quantity
-          #
-          # @see MetronomeSDK::V1::Contracts::QuantityConversion#operation
-          module Operation
-            extend MetronomeSDK::Internal::Type::Enum
-
-            MULTIPLY = :MULTIPLY
-            DIVIDE = :DIVIDE
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-        end
-      end
-    end
-  end
-end

data/lib/metronome_sdk/models/v1/contracts/quantity_rounding.rb

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-module MetronomeSDK
-  module Models
-    module V1
-      module Contracts
-        class QuantityRounding < MetronomeSDK::Internal::Type::BaseModel
-          # @!attribute decimal_places
-          #
-          #   @return [Float]
-          required :decimal_places, Float
-
-          # @!attribute rounding_method
-          #
-          #   @return [Symbol, MetronomeSDK::V1::Contracts::QuantityRounding::RoundingMethod]
-          required :rounding_method,
-                   enum: -> {
-                     MetronomeSDK::V1::Contracts::QuantityRounding::RoundingMethod
-                   }
-
-          # @!method initialize(decimal_places:, rounding_method:)
-          #   Optional. Only valid for USAGE products. If provided, the quantity will be
-          #   rounded using the provided rounding method and decimal places. For example, if
-          #   the method is "round up" and the decimal places is 0, then the quantity will be
-          #   rounded up to the nearest integer.
-          #
-          #   @param decimal_places [Float]
-          #   @param rounding_method [Symbol, MetronomeSDK::V1::Contracts::QuantityRounding::RoundingMethod]
-
-          # @see MetronomeSDK::V1::Contracts::QuantityRounding#rounding_method
-          module RoundingMethod
-            extend MetronomeSDK::Internal::Type::Enum
-
-            ROUND_UP = :ROUND_UP
-            ROUND_DOWN = :ROUND_DOWN
-            ROUND_HALF_UP = :ROUND_HALF_UP
-
-            # @!method self.values
-            #   @return [Array<Symbol>]
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,69 +0,0 @@
-# frozen_string_literal: true
-
-module MetronomeSDK
-  module Models
-    module V1
-      class CreditLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
-        # @!attribute amount
-        #   an amount representing the change to the customer's credit balance
-        #
-        #   @return [Float]
-        required :amount, Float
-
-        # @!attribute created_by
-        #
-        #   @return [String]
-        required :created_by, String
-
-        # @!attribute credit_grant_id
-        #   the credit grant this entry is related to
-        #
-        #   @return [String]
-        required :credit_grant_id, String
-
-        # @!attribute effective_at
-        #
-        #   @return [Time]
-        required :effective_at, Time
-
-        # @!attribute reason
-        #
-        #   @return [String]
-        required :reason, String
-
-        # @!attribute running_balance
-        #   the running balance for this credit type at the time of the ledger entry,
-        #   including all preceding charges
-        #
-        #   @return [Float]
-        required :running_balance, Float
-
-        # @!attribute invoice_id
-        #   if this entry is a deduction, the Metronome ID of the invoice where the credit
-        #   deduction was consumed; if this entry is a grant, the Metronome ID of the
-        #   invoice where the grant's paid_amount was charged
-        #
-        #   @return [String, nil]
-        optional :invoice_id, String, nil?: true
-
-        # @!method initialize(amount:, created_by:, credit_grant_id:, effective_at:, reason:, running_balance:, invoice_id: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {MetronomeSDK::V1::CreditLedgerEntry} for more details.
-        #
-        #   @param amount [Float] an amount representing the change to the customer's credit balance
-        #
-        #   @param created_by [String]
-        #
-        #   @param credit_grant_id [String] the credit grant this entry is related to
-        #
-        #   @param effective_at [Time]
-        #
-        #   @param reason [String]
-        #
-        #   @param running_balance [Float] the running balance for this credit type at the time of the ledger entry, includ
-        #
-        #   @param invoice_id [String, nil] if this entry is a deduction, the Metronome ID of the invoice where the credit d
-      end
-    end
-  end
-end

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

@@ -1,53 +0,0 @@
-# frozen_string_literal: true
-
-module MetronomeSDK
-  module Models
-    module V1
-      class Customer < MetronomeSDK::Internal::Type::BaseModel
-        # @!attribute id
-        #   the Metronome ID of the customer
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute external_id
-        #   (deprecated, use ingest_aliases instead) the first ID (Metronome or ingest
-        #   alias) that can be used in usage events
-        #
-        #   @return [String]
-        required :external_id, String
-
-        # @!attribute ingest_aliases
-        #   aliases for this customer that can be used instead of the Metronome customer ID
-        #   in usage events
-        #
-        #   @return [Array<String>]
-        required :ingest_aliases, MetronomeSDK::Internal::Type::ArrayOf[String]
-
-        # @!attribute name
-        #
-        #   @return [String]
-        required :name, String
-
-        # @!attribute custom_fields
-        #
-        #   @return [Hash{Symbol=>String}, nil]
-        optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
-
-        # @!method initialize(id:, external_id:, ingest_aliases:, name:, custom_fields: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {MetronomeSDK::V1::Customer} for more details.
-        #
-        #   @param id [String] the Metronome ID of the customer
-        #
-        #   @param external_id [String] (deprecated, use ingest_aliases instead) the first ID (Metronome or ingest alias
-        #
-        #   @param ingest_aliases [Array<String>] aliases for this customer that can be used instead of the Metronome customer ID
-        #
-        #   @param name [String]
-        #
-        #   @param custom_fields [Hash{Symbol=>String}]
-      end
-    end
-  end
-end