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

data/lib/metronome_sdk/models/v1/customers/billing_config_retrieve_response.rb

@@ -79,19 +79,16 @@ module MetronomeSDK
             #   more details.
             #
             #   @param aws_expiration_date [Time] Contract expiration date for the customer. The expected format is RFC 3339 and c
-            #   ...
             #
             #   @param aws_product_code [String]
             #
             #   @param aws_region [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveResponse::Data::AwsRegion]
             #
             #   @param azure_expiration_date [Time] Subscription term start/end date for the customer. The expected format is RFC 33
-            #   ...
             #
             #   @param azure_plan_id [String]
             #
             #   @param azure_start_date [Time] Subscription term start/end date for the customer. The expected format is RFC 33
-            #   ...
             #
             #   @param azure_subscription_status [Symbol, MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveResponse::Data::AzureSubscriptionStatus]
             #

data/lib/metronome_sdk/models/v1/customers/commit_create_params.rb

@@ -14,7 +14,7 @@ module MetronomeSDK
           #   only one schedule item is allowed and amount must match invoice_schedule total.
           #
           #   @return [MetronomeSDK::Models::V1::Customers::CommitCreateParams::AccessSchedule]
-          required :access_schedule, -> { MetronomeSDK::Models::V1::Customers::CommitCreateParams::AccessSchedule }
+          required :access_schedule, -> { MetronomeSDK::V1::Customers::CommitCreateParams::AccessSchedule }
 
           # @!attribute customer_id
           #
@@ -38,7 +38,7 @@ module MetronomeSDK
           # @!attribute type
           #
           #   @return [Symbol, MetronomeSDK::Models::V1::Customers::CommitCreateParams::Type]
-          required :type, enum: -> { MetronomeSDK::Models::V1::Customers::CommitCreateParams::Type }
+          required :type, enum: -> { MetronomeSDK::V1::Customers::CommitCreateParams::Type }
 
           # @!attribute applicable_contract_ids
           #   Which contract the commit applies to. If not provided, the commit applies to all
@@ -87,8 +87,7 @@ module MetronomeSDK
           #   will be a "complimentary" commit with no invoice.
           #
           #   @return [MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule, nil]
-          optional :invoice_schedule,
-                   -> { MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule }
+          optional :invoice_schedule, -> { MetronomeSDK::V1::Customers::CommitCreateParams::InvoiceSchedule }
 
           # @!attribute name
           #   displayed on invoices
@@ -105,7 +104,7 @@ module MetronomeSDK
           # @!attribute rate_type
           #
           #   @return [Symbol, MetronomeSDK::Models::V1::Customers::CommitCreateParams::RateType, nil]
-          optional :rate_type, enum: -> { MetronomeSDK::Models::V1::Customers::CommitCreateParams::RateType }
+          optional :rate_type, enum: -> { MetronomeSDK::V1::Customers::CommitCreateParams::RateType }
 
           # @!attribute salesforce_opportunity_id
           #   This field's availability is dependent on your client's configuration.
@@ -113,6 +112,18 @@ module MetronomeSDK
           #   @return [String, nil]
           optional :salesforce_opportunity_id, String
 
+          # @!attribute specifiers
+          #   List of filters that determine what kind of customer usage draws down a commit
+          #   or credit. A customer's usage needs to meet the condition of at least one of the
+          #   specifiers to contribute to a commit's or credit's drawdown. This field cannot
+          #   be used together with `applicable_product_ids` or `applicable_product_tags`.
+          #
+          #   @return [Array<MetronomeSDK::Models::V1::Customers::CommitCreateParams::Specifier>, nil]
+          optional :specifiers,
+                   -> {
+                     MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CommitCreateParams::Specifier]
+                   }
+
           # @!attribute uniqueness_key
           #   Prevents the creation of duplicates. If a request to create a commit or credit
           #   is made with a uniqueness key that was previously used to create a commit or
@@ -122,41 +133,33 @@ module MetronomeSDK
           #   @return [String, nil]
           optional :uniqueness_key, String
 
-          # @!method initialize(access_schedule:, customer_id:, priority:, product_id:, type:, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, custom_fields: nil, description: nil, invoice_contract_id: nil, invoice_schedule: nil, name: nil, netsuite_sales_order_id: nil, rate_type: nil, salesforce_opportunity_id: nil, uniqueness_key: nil, request_options: {})
+          # @!method initialize(access_schedule:, customer_id:, priority:, product_id:, type:, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, custom_fields: nil, description: nil, invoice_contract_id: nil, invoice_schedule: nil, name: nil, netsuite_sales_order_id: nil, rate_type: nil, salesforce_opportunity_id: nil, specifiers: nil, uniqueness_key: nil, request_options: {})
           #   Some parameter documentations has been truncated, see
           #   {MetronomeSDK::Models::V1::Customers::CommitCreateParams} for more details.
           #
           #   @param access_schedule [MetronomeSDK::Models::V1::Customers::CommitCreateParams::AccessSchedule] Schedule for distributing the commit to the customer. For "POSTPAID" commits onl
-          #   ...
           #
           #   @param customer_id [String]
           #
           #   @param priority [Float] If multiple credits or commits are applicable, the one with the lower priority w
-          #   ...
           #
           #   @param product_id [String] ID of the fixed product associated with the commit. This is required because pro
-          #   ...
           #
           #   @param type [Symbol, MetronomeSDK::Models::V1::Customers::CommitCreateParams::Type]
           #
           #   @param applicable_contract_ids [Array<String>] Which contract the commit applies to. If not provided, the commit applies to all
-          #   ...
           #
           #   @param applicable_product_ids [Array<String>] Which products the commit applies to. If both applicable_product_ids and applica
-          #   ...
           #
           #   @param applicable_product_tags [Array<String>] Which tags the commit applies to. If both applicable*product_ids and applicable*
-          #   ...
           #
           #   @param custom_fields [Hash{Symbol=>String}]
           #
           #   @param description [String] Used only in UI/API. It is not exposed to end customers.
           #
           #   @param invoice_contract_id [String] The contract that this commit will be billed on. This is required for "POSTPAID"
-          #   ...
           #
           #   @param invoice_schedule [MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule] Required for "POSTPAID" commits: the true up invoice will be generated at this t
-          #   ...
           #
           #   @param name [String] displayed on invoices
           #
@@ -166,8 +169,9 @@ module MetronomeSDK
           #
           #   @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
           #
+          #   @param specifiers [Array<MetronomeSDK::Models::V1::Customers::CommitCreateParams::Specifier>] List of filters that determine what kind of customer usage draws down a commit o
+          #
           #   @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a commit or credit i
-          #   ...
           #
           #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
 
@@ -176,7 +180,9 @@ module MetronomeSDK
             #
             #   @return [Array<MetronomeSDK::Models::V1::Customers::CommitCreateParams::AccessSchedule::ScheduleItem>]
             required :schedule_items,
-                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::Customers::CommitCreateParams::AccessSchedule::ScheduleItem] }
+                     -> {
+                       MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CommitCreateParams::AccessSchedule::ScheduleItem]
+                     }
 
             # @!attribute credit_type_id
             #   Defaults to USD (cents) if not passed
@@ -243,14 +249,18 @@ module MetronomeSDK
             #
             #   @return [MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule, nil]
             optional :recurring_schedule,
-                     -> { MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule }
+                     -> {
+                       MetronomeSDK::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule
+                     }
 
             # @!attribute schedule_items
             #   Either provide amount or provide both unit_price and quantity.
             #
             #   @return [Array<MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::ScheduleItem>, nil]
             optional :schedule_items,
-                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::ScheduleItem] }
+                     -> {
+                       MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::Customers::CommitCreateParams::InvoiceSchedule::ScheduleItem]
+                     }
 
             # @!method initialize(credit_type_id: nil, recurring_schedule: nil, schedule_items: nil)
             #   Some parameter documentations has been truncated, see
@@ -265,7 +275,6 @@ module MetronomeSDK
             #   @param credit_type_id [String] Defaults to USD (cents) if not passed.
             #
             #   @param recurring_schedule [MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule] Enter the unit price and quantity for the charge or instead only send the amount
-            #   ...
             #
             #   @param schedule_items [Array<MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::ScheduleItem>] Either provide amount or provide both unit_price and quantity.
 
@@ -275,7 +284,9 @@ module MetronomeSDK
               #
               #   @return [Symbol, MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule::AmountDistribution]
               required :amount_distribution,
-                       enum: -> { MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule::AmountDistribution }
+                       enum: -> {
+                         MetronomeSDK::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule::AmountDistribution
+                       }
 
               # @!attribute ending_before
               #   RFC 3339 timestamp (exclusive).
@@ -287,7 +298,9 @@ module MetronomeSDK
               #
               #   @return [Symbol, MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule::Frequency]
               required :frequency,
-                       enum: -> { MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule::Frequency }
+                       enum: -> {
+                         MetronomeSDK::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule::Frequency
+                       }
 
               # @!attribute starting_at
               #   RFC 3339 timestamp (inclusive).
@@ -337,13 +350,10 @@ module MetronomeSDK
               #   @param starting_at [Time] RFC 3339 timestamp (inclusive).
               #
               #   @param amount [Float] Amount for the charge. Can be provided instead of unit_price and quantity. If am
-              #   ...
               #
               #   @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
-              #   ...
 
               # @see MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule::RecurringSchedule#amount_distribution
               module AmountDistribution
@@ -410,13 +420,10 @@ module MetronomeSDK
               #   @param timestamp [Time] timestamp of the scheduled event
               #
               #   @param amount [Float] Amount for the charge. Can be provided instead of unit_price and quantity. If am
-              #   ...
               #
               #   @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
-              #   ...
             end
           end
 
@@ -429,6 +436,44 @@ module MetronomeSDK
             # @!method self.values
             #   @return [Array<Symbol>]
           end
+
+          class Specifier < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute presentation_group_values
+            #
+            #   @return [Hash{Symbol=>String}, nil]
+            optional :presentation_group_values, MetronomeSDK::Internal::Type::HashOf[String]
+
+            # @!attribute pricing_group_values
+            #
+            #   @return [Hash{Symbol=>String}, nil]
+            optional :pricing_group_values, MetronomeSDK::Internal::Type::HashOf[String]
+
+            # @!attribute product_id
+            #   If provided, the specifier will only apply to the product with the specified ID.
+            #
+            #   @return [String, nil]
+            optional :product_id, String
+
+            # @!attribute product_tags
+            #   If provided, the specifier will only apply to products with all the specified
+            #   tags.
+            #
+            #   @return [Array<String>, nil]
+            optional :product_tags, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+            # @!method initialize(presentation_group_values: nil, pricing_group_values: nil, product_id: nil, product_tags: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {MetronomeSDK::Models::V1::Customers::CommitCreateParams::Specifier} for more
+            #   details.
+            #
+            #   @param presentation_group_values [Hash{Symbol=>String}]
+            #
+            #   @param pricing_group_values [Hash{Symbol=>String}]
+            #
+            #   @param product_id [String] If provided, the specifier will only apply to the product with the specified ID.
+            #
+            #   @param product_tags [Array<String>] If provided, the specifier will only apply to products with all the specified ta
+          end
         end
       end
     end

data/lib/metronome_sdk/models/v1/customers/commit_create_response.rb

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

data/lib/metronome_sdk/models/v1/customers/commit_list_params.rb

@@ -84,12 +84,10 @@ module MetronomeSDK
           #   @param include_archived [Boolean] Include archived commits and commits from archived contracts.
           #
           #   @param include_balance [Boolean] Include the balance in the response. Setting this flag may cause the query to be
-          #   ...
           #
           #   @param include_contract_commits [Boolean] Include commits on the contract level.
           #
           #   @param include_ledgers [Boolean] Include commit ledgers in the response. Setting this flag may cause the query to
-          #   ...
           #
           #   @param next_page [String] The next page token from a previous response.
           #