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

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

@@ -7,22 +7,11 @@ module MetronomeSDK
       class ContractUpdateEndDateResponse < MetronomeSDK::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [MetronomeSDK::Models::V1::ContractUpdateEndDateResponse::Data]
-        required :data, -> { MetronomeSDK::Models::V1::ContractUpdateEndDateResponse::Data }
+        #   @return [MetronomeSDK::Models::ID]
+        required :data, -> { MetronomeSDK::ID }
 
         # @!method initialize(data:)
-        #   @param data [MetronomeSDK::Models::V1::ContractUpdateEndDateResponse::Data]
-
-        # @see MetronomeSDK::Models::V1::ContractUpdateEndDateResponse#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/contracts/product_archive_response.rb

@@ -8,22 +8,11 @@ module MetronomeSDK
         class ProductArchiveResponse < MetronomeSDK::Internal::Type::BaseModel
           # @!attribute data
           #
-          #   @return [MetronomeSDK::Models::V1::Contracts::ProductArchiveResponse::Data]
-          required :data, -> { MetronomeSDK::Models::V1::Contracts::ProductArchiveResponse::Data }
+          #   @return [MetronomeSDK::Models::ID]
+          required :data, -> { MetronomeSDK::ID }
 
           # @!method initialize(data:)
-          #   @param data [MetronomeSDK::Models::V1::Contracts::ProductArchiveResponse::Data]
-
-          # @see MetronomeSDK::Models::V1::Contracts::ProductArchiveResponse#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/contracts/product_create_params.rb

@@ -90,10 +90,8 @@ module MetronomeSDK
           #   GB. In this case, the conversion factor would be 1024 and the operation would be
           #   "divide".
           #
-          #   @return [MetronomeSDK::Models::V1::Contracts::ProductCreateParams::QuantityConversion, nil]
-          optional :quantity_conversion,
-                   -> { MetronomeSDK::V1::Contracts::ProductCreateParams::QuantityConversion },
-                   nil?: true
+          #   @return [MetronomeSDK::Models::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
@@ -101,10 +99,8 @@ module MetronomeSDK
           #   the method is "round up" and the decimal places is 0, then the quantity will be
           #   rounded up to the nearest integer.
           #
-          #   @return [MetronomeSDK::Models::V1::Contracts::ProductCreateParams::QuantityRounding, nil]
-          optional :quantity_rounding,
-                   -> { MetronomeSDK::V1::Contracts::ProductCreateParams::QuantityRounding },
-                   nil?: true
+          #   @return [MetronomeSDK::Models::V1::Contracts::QuantityRounding, nil]
+          optional :quantity_rounding, -> { MetronomeSDK::V1::Contracts::QuantityRounding }, nil?: true
 
           # @!attribute tags
           #
@@ -137,9 +133,9 @@ module MetronomeSDK
           #
           #   @param pricing_group_key [Array<String>] For USAGE products only. If set, pricing for this product will be determined for
           #
-          #   @param quantity_conversion [MetronomeSDK::Models::V1::Contracts::ProductCreateParams::QuantityConversion, nil] Optional. Only valid for USAGE products. If provided, the quantity will be conve
+          #   @param quantity_conversion [MetronomeSDK::Models::V1::Contracts::QuantityConversion, nil] Optional. Only valid for USAGE products. If provided, the quantity will be conve
           #
-          #   @param quantity_rounding [MetronomeSDK::Models::V1::Contracts::ProductCreateParams::QuantityRounding, nil] Optional. Only valid for USAGE products. If provided, the quantity will be round
+          #   @param quantity_rounding [MetronomeSDK::Models::V1::Contracts::QuantityRounding, nil] Optional. Only valid for USAGE products. If provided, the quantity will be round
           #
           #   @param tags [Array<String>]
           #
@@ -158,93 +154,6 @@ module MetronomeSDK
             # @!method self.values
             #   @return [Array<Symbol>]
           end
-
-          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::Models::V1::Contracts::ProductCreateParams::QuantityConversion::Operation]
-            required :operation,
-                     enum: -> {
-                       MetronomeSDK::V1::Contracts::ProductCreateParams::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::Models::V1::Contracts::ProductCreateParams::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::Models::V1::Contracts::ProductCreateParams::QuantityConversion#operation
-            module Operation
-              extend MetronomeSDK::Internal::Type::Enum
-
-              MULTIPLY = :MULTIPLY
-              DIVIDE = :DIVIDE
-
-              # @!method self.values
-              #   @return [Array<Symbol>]
-            end
-          end
-
-          class QuantityRounding < MetronomeSDK::Internal::Type::BaseModel
-            # @!attribute decimal_places
-            #
-            #   @return [Float]
-            required :decimal_places, Float
-
-            # @!attribute rounding_method
-            #
-            #   @return [Symbol, MetronomeSDK::Models::V1::Contracts::ProductCreateParams::QuantityRounding::RoundingMethod]
-            required :rounding_method,
-                     enum: -> {
-                       MetronomeSDK::V1::Contracts::ProductCreateParams::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::Models::V1::Contracts::ProductCreateParams::QuantityRounding::RoundingMethod]
-
-            # @see MetronomeSDK::Models::V1::Contracts::ProductCreateParams::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

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

@@ -8,22 +8,11 @@ module MetronomeSDK
         class ProductCreateResponse < MetronomeSDK::Internal::Type::BaseModel
           # @!attribute data
           #
-          #   @return [MetronomeSDK::Models::V1::Contracts::ProductCreateResponse::Data]
-          required :data, -> { MetronomeSDK::Models::V1::Contracts::ProductCreateResponse::Data }
+          #   @return [MetronomeSDK::Models::ID]
+          required :data, -> { MetronomeSDK::ID }
 
           # @!method initialize(data:)
-          #   @param data [MetronomeSDK::Models::V1::Contracts::ProductCreateResponse::Data]
-
-          # @see MetronomeSDK::Models::V1::Contracts::ProductCreateResponse#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/contracts/product_list_item_state.rb

@@ -0,0 +1,148 @@
+# 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::Models::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::Models::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::Models::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::Models::V1::Contracts::QuantityConversion, nil] Optional. Only valid for USAGE products. If provided, the quantity will be conve
+          #
+          #   @param quantity_rounding [MetronomeSDK::Models::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