metronome-sdk 0.1.0.pre.alpha.1

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Contracts#create
+      class ContractCreateResponse < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [MetronomeSDK::Models::ID]
+        required :data, -> { MetronomeSDK::Models::ID }
+
+        # @!method initialize(data:)
+        #   @param data [MetronomeSDK::Models::ID]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Contracts#list_balances
+      class ContractListBalancesParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        # @!attribute customer_id
+        #
+        #   @return [String]
+        required :customer_id, String
+
+        # @!attribute id
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute covering_date
+        #   Return only balances that have access schedules that "cover" the provided date
+        #
+        #   @return [Time, nil]
+        optional :covering_date, Time
+
+        # @!attribute effective_before
+        #   Include only balances that have any access before the provided date (exclusive)
+        #
+        #   @return [Time, nil]
+        optional :effective_before, Time
+
+        # @!attribute include_archived
+        #   Include archived credits and credits from archived contracts.
+        #
+        #   @return [Boolean, nil]
+        optional :include_archived, MetronomeSDK::Internal::Type::Boolean
+
+        # @!attribute include_balance
+        #   Include the balance of credits and commits in the response. Setting this flag
+        #   may cause the query to be slower.
+        #
+        #   @return [Boolean, nil]
+        optional :include_balance, MetronomeSDK::Internal::Type::Boolean
+
+        # @!attribute include_contract_balances
+        #   Include balances on the contract level.
+        #
+        #   @return [Boolean, nil]
+        optional :include_contract_balances, MetronomeSDK::Internal::Type::Boolean
+
+        # @!attribute include_ledgers
+        #   Include ledgers in the response. Setting this flag may cause the query to be
+        #   slower.
+        #
+        #   @return [Boolean, nil]
+        optional :include_ledgers, MetronomeSDK::Internal::Type::Boolean
+
+        # @!attribute next_page
+        #   The next page token from a previous response.
+        #
+        #   @return [String, nil]
+        optional :next_page, String
+
+        # @!attribute starting_at
+        #   Include only balances that have any access on or after the provided date
+        #
+        #   @return [Time, nil]
+        optional :starting_at, Time
+
+        # @!method initialize(customer_id:, id: nil, covering_date: nil, effective_before: nil, include_archived: nil, include_balance: nil, include_contract_balances: nil, include_ledgers: nil, next_page: nil, starting_at: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::V1::ContractListBalancesParams} for more details.
+        #
+        #   @param customer_id [String]
+        #
+        #   @param id [String]
+        #
+        #   @param covering_date [Time] Return only balances that have access schedules that "cover" the provided date
+        #
+        #   @param effective_before [Time] Include only balances that have any access before the provided date (exclusive)
+        #
+        #   @param include_archived [Boolean] Include archived credits and credits from archived contracts.
+        #
+        #   @param include_balance [Boolean] Include the balance of credits and commits in the response. Setting this flag ma
+        #   ...
+        #
+        #   @param include_contract_balances [Boolean] Include balances on the contract level.
+        #
+        #   @param include_ledgers [Boolean] Include ledgers in the response. Setting this flag may cause the query to be slo
+        #   ...
+        #
+        #   @param next_page [String] The next page token from a previous response.
+        #
+        #   @param starting_at [Time] Include only balances that have any access on or after the provided date
+        #
+        #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Contracts#list_balances
+      class ContractListBalancesResponse < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Array<MetronomeSDK::Models::Commit, MetronomeSDK::Models::Credit>]
+        required :data,
+                 -> { MetronomeSDK::Internal::Type::ArrayOf[union: MetronomeSDK::Models::V1::ContractListBalancesResponse::Data] }
+
+        # @!attribute next_page
+        #
+        #   @return [String, nil]
+        required :next_page, String, nil?: true
+
+        # @!method initialize(data:, next_page:)
+        #   @param data [Array<MetronomeSDK::Models::Commit, MetronomeSDK::Models::Credit>]
+        #   @param next_page [String, nil]
+
+        module Data
+          extend MetronomeSDK::Internal::Type::Union
+
+          variant -> { MetronomeSDK::Models::Commit }
+
+          variant -> { MetronomeSDK::Models::Credit }
+
+          # @!method self.variants
+          #   @return [Array(MetronomeSDK::Models::Commit, MetronomeSDK::Models::Credit)]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Contracts#list
+      class ContractListParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        # @!attribute customer_id
+        #
+        #   @return [String]
+        required :customer_id, String
+
+        # @!attribute covering_date
+        #   Optional RFC 3339 timestamp. If provided, the response will include only
+        #   contracts effective on the provided date. This cannot be provided if the
+        #   starting_at filter is provided.
+        #
+        #   @return [Time, nil]
+        optional :covering_date, Time
+
+        # @!attribute include_archived
+        #   Include archived contracts in the response
+        #
+        #   @return [Boolean, nil]
+        optional :include_archived, MetronomeSDK::Internal::Type::Boolean
+
+        # @!attribute include_balance
+        #   Include the balance of credits and commits in the response. Setting this flag
+        #   may cause the query to be slower.
+        #
+        #   @return [Boolean, nil]
+        optional :include_balance, MetronomeSDK::Internal::Type::Boolean
+
+        # @!attribute include_ledgers
+        #   Include commit ledgers in the response. Setting this flag may cause the query to
+        #   be slower.
+        #
+        #   @return [Boolean, nil]
+        optional :include_ledgers, MetronomeSDK::Internal::Type::Boolean
+
+        # @!attribute starting_at
+        #   Optional RFC 3339 timestamp. If provided, the response will include only
+        #   contracts where effective_at is on or after the provided date. This cannot be
+        #   provided if the covering_date filter is provided.
+        #
+        #   @return [Time, nil]
+        optional :starting_at, Time
+
+        # @!method initialize(customer_id:, covering_date: nil, include_archived: nil, include_balance: nil, include_ledgers: nil, starting_at: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::V1::ContractListParams} for more details.
+        #
+        #   @param customer_id [String]
+        #
+        #   @param covering_date [Time] Optional RFC 3339 timestamp. If provided, the response will include only contrac
+        #   ...
+        #
+        #   @param include_archived [Boolean] Include archived contracts in the response
+        #
+        #   @param include_balance [Boolean] Include the balance of credits and commits in the response. Setting this flag ma
+        #   ...
+        #
+        #   @param include_ledgers [Boolean] Include commit ledgers in the response. Setting this flag may cause the query to
+        #   ...
+        #
+        #   @param starting_at [Time] Optional RFC 3339 timestamp. If provided, the response will include only contrac
+        #   ...
+        #
+        #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,388 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Contracts#list
+      class ContractListResponse < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Array<MetronomeSDK::Models::V1::ContractListResponse::Data>]
+        required :data,
+                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractListResponse::Data] }
+
+        # @!method initialize(data:)
+        #   @param data [Array<MetronomeSDK::Models::V1::ContractListResponse::Data>]
+
+        class Data < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute amendments
+          #
+          #   @return [Array<MetronomeSDK::Models::V1::ContractListResponse::Data::Amendment>]
+          required :amendments,
+                   -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractListResponse::Data::Amendment] }
+
+          # @!attribute current
+          #
+          #   @return [MetronomeSDK::Models::ContractWithoutAmendments]
+          required :current, -> { MetronomeSDK::Models::ContractWithoutAmendments }
+
+          # @!attribute customer_id
+          #
+          #   @return [String]
+          required :customer_id, String
+
+          # @!attribute initial
+          #
+          #   @return [MetronomeSDK::Models::ContractWithoutAmendments]
+          required :initial, -> { MetronomeSDK::Models::ContractWithoutAmendments }
+
+          # @!attribute archived_at
+          #   RFC 3339 timestamp indicating when the contract was archived. If not returned,
+          #   the contract is not archived.
+          #
+          #   @return [Time, nil]
+          optional :archived_at, Time
+
+          # @!attribute custom_fields
+          #
+          #   @return [Hash{Symbol=>String}, nil]
+          optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
+
+          # @!attribute customer_billing_provider_configuration
+          #   The billing provider configuration associated with a contract.
+          #
+          #   @return [MetronomeSDK::Models::V1::ContractListResponse::Data::CustomerBillingProviderConfiguration, nil]
+          optional :customer_billing_provider_configuration,
+                   -> { MetronomeSDK::Models::V1::ContractListResponse::Data::CustomerBillingProviderConfiguration }
+
+          # @!attribute scheduled_charges_on_usage_invoices
+          #   Determines which scheduled and commit charges to consolidate onto the Contract's
+          #   usage invoice. The charge's `timestamp` must match the usage invoice's
+          #   `ending_before` date for consolidation to occur. This field cannot be modified
+          #   after a Contract has been created. If this field is omitted, charges will appear
+          #   on a separate invoice from usage charges.
+          #
+          #   @return [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::ScheduledChargesOnUsageInvoices, nil]
+          optional :scheduled_charges_on_usage_invoices,
+                   enum: -> { MetronomeSDK::Models::V1::ContractListResponse::Data::ScheduledChargesOnUsageInvoices }
+
+          # @!attribute uniqueness_key
+          #   Prevents the creation of duplicates. If a request to create a record is made
+          #   with a previously used uniqueness key, a new record will not be created and the
+          #   request will fail with a 409 error.
+          #
+          #   @return [String, nil]
+          optional :uniqueness_key, String
+
+          # @!method initialize(id:, amendments:, current:, customer_id:, initial:, archived_at: nil, custom_fields: nil, customer_billing_provider_configuration: nil, scheduled_charges_on_usage_invoices: nil, uniqueness_key: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V1::ContractListResponse::Data} for more details.
+          #
+          #   @param id [String]
+          #
+          #   @param amendments [Array<MetronomeSDK::Models::V1::ContractListResponse::Data::Amendment>]
+          #
+          #   @param current [MetronomeSDK::Models::ContractWithoutAmendments]
+          #
+          #   @param customer_id [String]
+          #
+          #   @param initial [MetronomeSDK::Models::ContractWithoutAmendments]
+          #
+          #   @param archived_at [Time] RFC 3339 timestamp indicating when the contract was archived. If not returned, t
+          #   ...
+          #
+          #   @param custom_fields [Hash{Symbol=>String}]
+          #
+          #   @param customer_billing_provider_configuration [MetronomeSDK::Models::V1::ContractListResponse::Data::CustomerBillingProviderConfiguration] The billing provider configuration associated with a contract.
+          #
+          #   @param scheduled_charges_on_usage_invoices [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::ScheduledChargesOnUsageInvoices] Determines which scheduled and commit charges to consolidate onto the Contract's
+          #   ...
+          #
+          #   @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
+          #   ...
+
+          class Amendment < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute id
+            #
+            #   @return [String]
+            required :id, String
+
+            # @!attribute commits
+            #
+            #   @return [Array<MetronomeSDK::Models::Commit>]
+            required :commits, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::Commit] }
+
+            # @!attribute created_at
+            #
+            #   @return [Time]
+            required :created_at, Time
+
+            # @!attribute created_by
+            #
+            #   @return [String]
+            required :created_by, String
+
+            # @!attribute overrides
+            #
+            #   @return [Array<MetronomeSDK::Models::Override>]
+            required :overrides, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::Override] }
+
+            # @!attribute scheduled_charges
+            #
+            #   @return [Array<MetronomeSDK::Models::ScheduledCharge>]
+            required :scheduled_charges,
+                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::ScheduledCharge] }
+
+            # @!attribute starting_at
+            #
+            #   @return [Time]
+            required :starting_at, Time
+
+            # @!attribute credits
+            #
+            #   @return [Array<MetronomeSDK::Models::Credit>, nil]
+            optional :credits, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::Credit] }
+
+            # @!attribute discounts
+            #   This field's availability is dependent on your client's configuration.
+            #
+            #   @return [Array<MetronomeSDK::Models::Discount>, nil]
+            optional :discounts, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::Discount] }
+
+            # @!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
+
+            # @!attribute professional_services
+            #   This field's availability is dependent on your client's configuration.
+            #
+            #   @return [Array<MetronomeSDK::Models::ProService>, nil]
+            optional :professional_services,
+                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::ProService] }
+
+            # @!attribute reseller_royalties
+            #   This field's availability is dependent on your client's configuration.
+            #
+            #   @return [Array<MetronomeSDK::Models::V1::ContractListResponse::Data::Amendment::ResellerRoyalty>, nil]
+            optional :reseller_royalties,
+                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ContractListResponse::Data::Amendment::ResellerRoyalty] }
+
+            # @!attribute salesforce_opportunity_id
+            #   This field's availability is dependent on your client's configuration.
+            #
+            #   @return [String, nil]
+            optional :salesforce_opportunity_id, String
+
+            # @!method initialize(id:, commits:, created_at:, created_by:, overrides:, scheduled_charges:, starting_at:, credits: nil, discounts: nil, netsuite_sales_order_id: nil, professional_services: nil, reseller_royalties: nil, salesforce_opportunity_id: nil)
+            #   @param id [String]
+            #
+            #   @param commits [Array<MetronomeSDK::Models::Commit>]
+            #
+            #   @param created_at [Time]
+            #
+            #   @param created_by [String]
+            #
+            #   @param overrides [Array<MetronomeSDK::Models::Override>]
+            #
+            #   @param scheduled_charges [Array<MetronomeSDK::Models::ScheduledCharge>]
+            #
+            #   @param starting_at [Time]
+            #
+            #   @param credits [Array<MetronomeSDK::Models::Credit>]
+            #
+            #   @param discounts [Array<MetronomeSDK::Models::Discount>] This field's availability is dependent on your client's configuration.
+            #
+            #   @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
+            #
+            #   @param professional_services [Array<MetronomeSDK::Models::ProService>] This field's availability is dependent on your client's configuration.
+            #
+            #   @param reseller_royalties [Array<MetronomeSDK::Models::V1::ContractListResponse::Data::Amendment::ResellerRoyalty>] This field's availability is dependent on your client's configuration.
+            #
+            #   @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
+
+            class ResellerRoyalty < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute reseller_type
+              #
+              #   @return [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::Amendment::ResellerRoyalty::ResellerType]
+              required :reseller_type,
+                       enum: -> { MetronomeSDK::Models::V1::ContractListResponse::Data::Amendment::ResellerRoyalty::ResellerType }
+
+              # @!attribute aws_account_number
+              #
+              #   @return [String, nil]
+              optional :aws_account_number, String
+
+              # @!attribute aws_offer_id
+              #
+              #   @return [String, nil]
+              optional :aws_offer_id, String
+
+              # @!attribute aws_payer_reference_id
+              #
+              #   @return [String, nil]
+              optional :aws_payer_reference_id, String
+
+              # @!attribute ending_before
+              #
+              #   @return [Time, nil]
+              optional :ending_before, Time, nil?: true
+
+              # @!attribute fraction
+              #
+              #   @return [Float, nil]
+              optional :fraction, Float
+
+              # @!attribute gcp_account_id
+              #
+              #   @return [String, nil]
+              optional :gcp_account_id, String
+
+              # @!attribute gcp_offer_id
+              #
+              #   @return [String, nil]
+              optional :gcp_offer_id, String
+
+              # @!attribute netsuite_reseller_id
+              #
+              #   @return [String, nil]
+              optional :netsuite_reseller_id, String
+
+              # @!attribute reseller_contract_value
+              #
+              #   @return [Float, nil]
+              optional :reseller_contract_value, Float
+
+              # @!attribute starting_at
+              #
+              #   @return [Time, nil]
+              optional :starting_at, Time
+
+              # @!method initialize(reseller_type:, aws_account_number: nil, aws_offer_id: nil, aws_payer_reference_id: nil, ending_before: nil, fraction: nil, gcp_account_id: nil, gcp_offer_id: nil, netsuite_reseller_id: nil, reseller_contract_value: nil, starting_at: nil)
+              #   @param reseller_type [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::Amendment::ResellerRoyalty::ResellerType]
+              #   @param aws_account_number [String]
+              #   @param aws_offer_id [String]
+              #   @param aws_payer_reference_id [String]
+              #   @param ending_before [Time, nil]
+              #   @param fraction [Float]
+              #   @param gcp_account_id [String]
+              #   @param gcp_offer_id [String]
+              #   @param netsuite_reseller_id [String]
+              #   @param reseller_contract_value [Float]
+              #   @param starting_at [Time]
+
+              # @see MetronomeSDK::Models::V1::ContractListResponse::Data::Amendment::ResellerRoyalty#reseller_type
+              module ResellerType
+                extend MetronomeSDK::Internal::Type::Enum
+
+                AWS = :AWS
+                AWS_PRO_SERVICE = :AWS_PRO_SERVICE
+                GCP = :GCP
+                GCP_PRO_SERVICE = :GCP_PRO_SERVICE
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+          end
+
+          # @see MetronomeSDK::Models::V1::ContractListResponse::Data#customer_billing_provider_configuration
+          class CustomerBillingProviderConfiguration < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute billing_provider
+            #
+            #   @return [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::CustomerBillingProviderConfiguration::BillingProvider]
+            required :billing_provider,
+                     enum: -> { MetronomeSDK::Models::V1::ContractListResponse::Data::CustomerBillingProviderConfiguration::BillingProvider }
+
+            # @!attribute delivery_method
+            #
+            #   @return [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::CustomerBillingProviderConfiguration::DeliveryMethod]
+            required :delivery_method,
+                     enum: -> { MetronomeSDK::Models::V1::ContractListResponse::Data::CustomerBillingProviderConfiguration::DeliveryMethod }
+
+            # @!attribute id
+            #
+            #   @return [String, nil]
+            optional :id, String
+
+            # @!attribute configuration
+            #   Configuration for the billing provider. The structure of this object is specific
+            #   to the billing provider.
+            #
+            #   @return [Hash{Symbol=>Object}, nil]
+            optional :configuration,
+                     MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]
+
+            # @!method initialize(billing_provider:, delivery_method:, id: nil, configuration: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {MetronomeSDK::Models::V1::ContractListResponse::Data::CustomerBillingProviderConfiguration}
+            #   for more details.
+            #
+            #   The billing provider configuration associated with a contract.
+            #
+            #   @param billing_provider [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::CustomerBillingProviderConfiguration::BillingProvider]
+            #
+            #   @param delivery_method [Symbol, MetronomeSDK::Models::V1::ContractListResponse::Data::CustomerBillingProviderConfiguration::DeliveryMethod]
+            #
+            #   @param id [String]
+            #
+            #   @param configuration [Hash{Symbol=>Object}] Configuration for the billing provider. The structure of this object is specific
+            #   ...
+
+            # @see MetronomeSDK::Models::V1::ContractListResponse::Data::CustomerBillingProviderConfiguration#billing_provider
+            module BillingProvider
+              extend MetronomeSDK::Internal::Type::Enum
+
+              AWS_MARKETPLACE = :aws_marketplace
+              STRIPE = :stripe
+              NETSUITE = :netsuite
+              CUSTOM = :custom
+              AZURE_MARKETPLACE = :azure_marketplace
+              QUICKBOOKS_ONLINE = :quickbooks_online
+              WORKDAY = :workday
+              GCP_MARKETPLACE = :gcp_marketplace
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # @see MetronomeSDK::Models::V1::ContractListResponse::Data::CustomerBillingProviderConfiguration#delivery_method
+            module DeliveryMethod
+              extend MetronomeSDK::Internal::Type::Enum
+
+              DIRECT_TO_BILLING_PROVIDER = :direct_to_billing_provider
+              AWS_SQS = :aws_sqs
+              TACKLE = :tackle
+              AWS_SNS = :aws_sns
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # Determines which scheduled and commit charges to consolidate onto the Contract's
+          # usage invoice. The charge's `timestamp` must match the usage invoice's
+          # `ending_before` date for consolidation to occur. This field cannot be modified
+          # after a Contract has been created. If this field is omitted, charges will appear
+          # on a separate invoice from usage charges.
+          #
+          # @see MetronomeSDK::Models::V1::ContractListResponse::Data#scheduled_charges_on_usage_invoices
+          module ScheduledChargesOnUsageInvoices
+            extend MetronomeSDK::Internal::Type::Enum
+
+            ALL = :ALL
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Contracts#retrieve
+      class ContractRetrieveParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        # @!attribute contract_id
+        #
+        #   @return [String]
+        required :contract_id, String
+
+        # @!attribute customer_id
+        #
+        #   @return [String]
+        required :customer_id, String
+
+        # @!attribute include_balance
+        #   Include the balance of credits and commits in the response. Setting this flag
+        #   may cause the query to be slower.
+        #
+        #   @return [Boolean, nil]
+        optional :include_balance, MetronomeSDK::Internal::Type::Boolean
+
+        # @!attribute include_ledgers
+        #   Include commit ledgers in the response. Setting this flag may cause the query to
+        #   be slower.
+        #
+        #   @return [Boolean, nil]
+        optional :include_ledgers, MetronomeSDK::Internal::Type::Boolean
+
+        # @!method initialize(contract_id:, customer_id:, include_balance: nil, include_ledgers: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::V1::ContractRetrieveParams} for more details.
+        #
+        #   @param contract_id [String]
+        #
+        #   @param customer_id [String]
+        #
+        #   @param include_balance [Boolean] Include the balance of credits and commits in the response. Setting this flag ma
+        #   ...
+        #
+        #   @param include_ledgers [Boolean] Include commit ledgers in the response. Setting this flag may cause the query to
+        #   ...
+        #
+        #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end