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

data/lib/metronome_sdk/resources/v1/pricing_units.rb

@@ -18,7 +18,7 @@ module MetronomeSDK
         #
         # @see MetronomeSDK::Models::V1::PricingUnitListParams
         def list(params = {})
-          parsed, options = MetronomeSDK::Models::V1::PricingUnitListParams.dump_request(params)
+          parsed, options = MetronomeSDK::V1::PricingUnitListParams.dump_request(params)
           @client.request(
             method: :get,
             path: "v1/credit-types/list",

data/lib/metronome_sdk/resources/v1/usage.rb

@@ -16,16 +16,13 @@ module MetronomeSDK
         #
         # @param starting_on [Time] Body param:
         #
-        # @param window_size [Symbol, MetronomeSDK::Models::V1::UsageListParams::WindowSize] Body param: A window_size of "day" or "hour" will return the usage for the speci
-        # ...
+        # @param window_size [Symbol, MetronomeSDK::V1::UsageListParams::WindowSize] Body param: A window_size of "day" or "hour" will return the usage for the speci
         #
         # @param next_page [String] Query param: Cursor that indicates where the next page of results should start.
         #
-        # @param billable_metrics [Array<MetronomeSDK::Models::V1::UsageListParams::BillableMetric>] Body param: A list of billable metrics to fetch usage for. If absent, all billab
-        # ...
+        # @param billable_metrics [Array<MetronomeSDK::V1::UsageListParams::BillableMetric>] Body param: A list of billable metrics to fetch usage for. If absent, all billab
         #
         # @param customer_ids [Array<String>] Body param: A list of Metronome customer IDs to fetch usage for. If absent, usag
-        # ...
         #
         # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -33,7 +30,7 @@ module MetronomeSDK
         #
         # @see MetronomeSDK::Models::V1::UsageListParams
         def list(params)
-          parsed, options = MetronomeSDK::Models::V1::UsageListParams.dump_request(params)
+          parsed, options = MetronomeSDK::V1::UsageListParams.dump_request(params)
           query_params = [:next_page]
           @client.request(
             method: :post,
@@ -53,14 +50,14 @@ module MetronomeSDK
         #
         # @overload ingest(usage: nil, request_options: {})
         #
-        # @param usage [Array<MetronomeSDK::Models::V1::UsageIngestParams::Usage>]
+        # @param usage [Array<MetronomeSDK::V1::UsageIngestParams::Usage>]
         # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [nil]
         #
         # @see MetronomeSDK::Models::V1::UsageIngestParams
         def ingest(params = {})
-          parsed, options = MetronomeSDK::Models::V1::UsageIngestParams.dump_request(params)
+          parsed, options = MetronomeSDK::V1::UsageIngestParams.dump_request(params)
           @client.request(
             method: :post,
             path: "v1/ingest",
@@ -82,19 +79,17 @@ module MetronomeSDK
         #
         # @param customer_id [String] Body param:
         #
-        # @param window_size [Symbol, MetronomeSDK::Models::V1::UsageListWithGroupsParams::WindowSize] Body param: A window_size of "day" or "hour" will return the usage for the speci
-        # ...
+        # @param window_size [Symbol, MetronomeSDK::V1::UsageListWithGroupsParams::WindowSize] Body param: A window_size of "day" or "hour" will return the usage for the speci
         #
         # @param limit [Integer] Query param: Max number of results that should be returned
         #
         # @param next_page [String] Query param: Cursor that indicates where the next page of results should start.
         #
         # @param current_period [Boolean] Body param: If true, will return the usage for the current billing period. Will
-        # ...
         #
         # @param ending_before [Time] Body param:
         #
-        # @param group_by [MetronomeSDK::Models::V1::UsageListWithGroupsParams::GroupBy] Body param:
+        # @param group_by [MetronomeSDK::V1::UsageListWithGroupsParams::GroupBy] Body param:
         #
         # @param starting_on [Time] Body param:
         #
@@ -104,7 +99,7 @@ module MetronomeSDK
         #
         # @see MetronomeSDK::Models::V1::UsageListWithGroupsParams
         def list_with_groups(params)
-          parsed, options = MetronomeSDK::Models::V1::UsageListWithGroupsParams.dump_request(params)
+          parsed, options = MetronomeSDK::V1::UsageListWithGroupsParams.dump_request(params)
           query_params = [:limit, :next_page]
           @client.request(
             method: :post,

data/lib/metronome_sdk/resources/v2/contracts.rb

@@ -17,13 +17,10 @@ module MetronomeSDK
         # @param customer_id [String]
         #
         # @param as_of_date [Time] Optional RFC 3339 timestamp. Return the contract as of this date. Cannot be used
-        # ...
         #
         # @param include_balance [Boolean] Include the balance of credits and commits in the response. Setting this flag ma
-        # ...
         #
         # @param include_ledgers [Boolean] Include commit/credit ledgers in the response. Setting this flag may cause the q
-        # ...
         #
         # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -31,7 +28,7 @@ module MetronomeSDK
         #
         # @see MetronomeSDK::Models::V2::ContractRetrieveParams
         def retrieve(params)
-          parsed, options = MetronomeSDK::Models::V2::ContractRetrieveParams.dump_request(params)
+          parsed, options = MetronomeSDK::V2::ContractRetrieveParams.dump_request(params)
           @client.request(
             method: :post,
             path: "v2/contracts/get",
@@ -52,18 +49,14 @@ module MetronomeSDK
         # @param customer_id [String]
         #
         # @param covering_date [Time] Optional RFC 3339 timestamp. Only include contracts active on the provided date.
-        # ...
         #
         # @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/credit ledgers in the response. Setting this flag may cause the r
-        # ...
         #
         # @param starting_at [Time] Optional RFC 3339 timestamp. Only include contracts that started on or after thi
-        # ...
         #
         # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -71,7 +64,7 @@ module MetronomeSDK
         #
         # @see MetronomeSDK::Models::V2::ContractListParams
         def list(params)
-          parsed, options = MetronomeSDK::Models::V2::ContractListParams.dump_request(params)
+          parsed, options = MetronomeSDK::V2::ContractListParams.dump_request(params)
           @client.request(
             method: :post,
             path: "v2/contracts/list",
@@ -81,49 +74,60 @@ module MetronomeSDK
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {MetronomeSDK::Models::V2::ContractEditParams} for more details.
+        #
         # Edit a contract. Contract editing must be enabled to use this endpoint.
         #
-        # @overload edit(contract_id:, customer_id:, add_commits: nil, add_credits: nil, add_discounts: nil, add_overrides: nil, add_professional_services: nil, add_recurring_commits: nil, add_recurring_credits: nil, add_reseller_royalties: nil, add_scheduled_charges: nil, add_spend_threshold_configuration: nil, archive_commits: nil, archive_credits: nil, archive_scheduled_charges: nil, remove_overrides: nil, update_commits: nil, update_credits: nil, update_scheduled_charges: nil, update_spend_threshold_configuration: nil, request_options: {})
+        # @overload edit(contract_id:, customer_id:, add_commits: nil, add_credits: nil, add_discounts: nil, add_overrides: nil, add_prepaid_balance_threshold_configuration: nil, add_professional_services: nil, add_recurring_commits: nil, add_recurring_credits: nil, add_reseller_royalties: nil, add_scheduled_charges: nil, add_spend_threshold_configuration: nil, allow_contract_ending_before_finalized_invoice: nil, archive_commits: nil, archive_credits: nil, archive_scheduled_charges: nil, remove_overrides: nil, update_commits: nil, update_contract_end_date: nil, update_credits: nil, update_prepaid_balance_threshold_configuration: nil, update_scheduled_charges: nil, update_spend_threshold_configuration: nil, request_options: {})
         #
         # @param contract_id [String] ID of the contract being edited
         #
         # @param customer_id [String] ID of the customer whose contract is being edited
         #
-        # @param add_commits [Array<MetronomeSDK::Models::V2::ContractEditParams::AddCommit>]
+        # @param add_commits [Array<MetronomeSDK::V2::ContractEditParams::AddCommit>]
+        #
+        # @param add_credits [Array<MetronomeSDK::V2::ContractEditParams::AddCredit>]
+        #
+        # @param add_discounts [Array<MetronomeSDK::V2::ContractEditParams::AddDiscount>]
+        #
+        # @param add_overrides [Array<MetronomeSDK::V2::ContractEditParams::AddOverride>]
+        #
+        # @param add_prepaid_balance_threshold_configuration [MetronomeSDK::V2::ContractEditParams::AddPrepaidBalanceThresholdConfiguration]
         #
-        # @param add_credits [Array<MetronomeSDK::Models::V2::ContractEditParams::AddCredit>]
+        # @param add_professional_services [Array<MetronomeSDK::V2::ContractEditParams::AddProfessionalService>] This field's availability is dependent on your client's configuration.
         #
-        # @param add_discounts [Array<MetronomeSDK::Models::V2::ContractEditParams::AddDiscount>]
+        # @param add_recurring_commits [Array<MetronomeSDK::V2::ContractEditParams::AddRecurringCommit>]
         #
-        # @param add_overrides [Array<MetronomeSDK::Models::V2::ContractEditParams::AddOverride>]
+        # @param add_recurring_credits [Array<MetronomeSDK::V2::ContractEditParams::AddRecurringCredit>]
         #
-        # @param add_professional_services [Array<MetronomeSDK::Models::V2::ContractEditParams::AddProfessionalService>] This field's availability is dependent on your client's configuration.
+        # @param add_reseller_royalties [Array<MetronomeSDK::V2::ContractEditParams::AddResellerRoyalty>]
         #
-        # @param add_recurring_commits [Array<MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCommit>]
+        # @param add_scheduled_charges [Array<MetronomeSDK::V2::ContractEditParams::AddScheduledCharge>]
         #
-        # @param add_recurring_credits [Array<MetronomeSDK::Models::V2::ContractEditParams::AddRecurringCredit>]
+        # @param add_spend_threshold_configuration [MetronomeSDK::V2::ContractEditParams::AddSpendThresholdConfiguration]
         #
-        # @param add_reseller_royalties [Array<MetronomeSDK::Models::V2::ContractEditParams::AddResellerRoyalty>]
+        # @param allow_contract_ending_before_finalized_invoice [Boolean] If true, allows setting the contract end date earlier than the end_timestamp of
         #
-        # @param add_scheduled_charges [Array<MetronomeSDK::Models::V2::ContractEditParams::AddScheduledCharge>]
+        # @param archive_commits [Array<MetronomeSDK::V2::ContractEditParams::ArchiveCommit>] IDs of commits to archive
         #
-        # @param add_spend_threshold_configuration [MetronomeSDK::Models::V2::ContractEditParams::AddSpendThresholdConfiguration]
+        # @param archive_credits [Array<MetronomeSDK::V2::ContractEditParams::ArchiveCredit>] IDs of credits to archive
         #
-        # @param archive_commits [Array<MetronomeSDK::Models::V2::ContractEditParams::ArchiveCommit>] IDs of commits to archive
+        # @param archive_scheduled_charges [Array<MetronomeSDK::V2::ContractEditParams::ArchiveScheduledCharge>] IDs of scheduled charges to archive
         #
-        # @param archive_credits [Array<MetronomeSDK::Models::V2::ContractEditParams::ArchiveCredit>] IDs of credits to archive
+        # @param remove_overrides [Array<MetronomeSDK::V2::ContractEditParams::RemoveOverride>] IDs of overrides to remove
         #
-        # @param archive_scheduled_charges [Array<MetronomeSDK::Models::V2::ContractEditParams::ArchiveScheduledCharge>] IDs of scheduled charges to archive
+        # @param update_commits [Array<MetronomeSDK::V2::ContractEditParams::UpdateCommit>]
         #
-        # @param remove_overrides [Array<MetronomeSDK::Models::V2::ContractEditParams::RemoveOverride>] IDs of overrides to remove
+        # @param update_contract_end_date [Time] RFC 3339 timestamp indicating when the contract will end (exclusive).
         #
-        # @param update_commits [Array<MetronomeSDK::Models::V2::ContractEditParams::UpdateCommit>]
+        # @param update_credits [Array<MetronomeSDK::V2::ContractEditParams::UpdateCredit>]
         #
-        # @param update_credits [Array<MetronomeSDK::Models::V2::ContractEditParams::UpdateCredit>]
+        # @param update_prepaid_balance_threshold_configuration [MetronomeSDK::V2::ContractEditParams::UpdatePrepaidBalanceThresholdConfiguration]
         #
-        # @param update_scheduled_charges [Array<MetronomeSDK::Models::V2::ContractEditParams::UpdateScheduledCharge>]
+        # @param update_scheduled_charges [Array<MetronomeSDK::V2::ContractEditParams::UpdateScheduledCharge>]
         #
-        # @param update_spend_threshold_configuration [MetronomeSDK::Models::V2::ContractEditParams::UpdateSpendThresholdConfiguration]
+        # @param update_spend_threshold_configuration [MetronomeSDK::V2::ContractEditParams::UpdateSpendThresholdConfiguration]
         #
         # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
         #
@@ -131,7 +135,7 @@ module MetronomeSDK
         #
         # @see MetronomeSDK::Models::V2::ContractEditParams
         def edit(params)
-          parsed, options = MetronomeSDK::Models::V2::ContractEditParams.dump_request(params)
+          parsed, options = MetronomeSDK::V2::ContractEditParams.dump_request(params)
           @client.request(
             method: :post,
             path: "v2/contracts/edit",
@@ -153,17 +157,15 @@ module MetronomeSDK
         #
         # @param customer_id [String] ID of the customer whose commit is being edited
         #
-        # @param access_schedule [MetronomeSDK::Models::V2::ContractEditCommitParams::AccessSchedule]
+        # @param access_schedule [MetronomeSDK::V2::ContractEditCommitParams::AccessSchedule]
         #
         # @param applicable_product_ids [Array<String>, nil] Which products the commit applies to. If both applicable_product_ids and applica
-        # ...
         #
         # @param applicable_product_tags [Array<String>, nil] Which tags the commit applies to. If both applicable*product_ids and applicable*
-        # ...
         #
         # @param invoice_contract_id [String] ID of contract to use for invoicing
         #
-        # @param invoice_schedule [MetronomeSDK::Models::V2::ContractEditCommitParams::InvoiceSchedule]
+        # @param invoice_schedule [MetronomeSDK::V2::ContractEditCommitParams::InvoiceSchedule]
         #
         # @param product_id [String]
         #
@@ -173,7 +175,7 @@ module MetronomeSDK
         #
         # @see MetronomeSDK::Models::V2::ContractEditCommitParams
         def edit_commit(params)
-          parsed, options = MetronomeSDK::Models::V2::ContractEditCommitParams.dump_request(params)
+          parsed, options = MetronomeSDK::V2::ContractEditCommitParams.dump_request(params)
           @client.request(
             method: :post,
             path: "v2/contracts/commits/edit",
@@ -195,13 +197,11 @@ module MetronomeSDK
         #
         # @param customer_id [String] ID of the customer whose credit is being edited
         #
-        # @param access_schedule [MetronomeSDK::Models::V2::ContractEditCreditParams::AccessSchedule]
+        # @param access_schedule [MetronomeSDK::V2::ContractEditCreditParams::AccessSchedule]
         #
         # @param applicable_product_ids [Array<String>, nil] Which products the credit applies to. If both applicable_product_ids and applica
-        # ...
         #
         # @param applicable_product_tags [Array<String>, nil] Which tags the credit applies to. If both applicable*product_ids and applicable*
-        # ...
         #
         # @param product_id [String]
         #
@@ -211,7 +211,7 @@ module MetronomeSDK
         #
         # @see MetronomeSDK::Models::V2::ContractEditCreditParams
         def edit_credit(params)
-          parsed, options = MetronomeSDK::Models::V2::ContractEditCreditParams.dump_request(params)
+          parsed, options = MetronomeSDK::V2::ContractEditCreditParams.dump_request(params)
           @client.request(
             method: :post,
             path: "v2/contracts/credits/edit",
@@ -234,7 +234,7 @@ module MetronomeSDK
         #
         # @see MetronomeSDK::Models::V2::ContractGetEditHistoryParams
         def get_edit_history(params)
-          parsed, options = MetronomeSDK::Models::V2::ContractGetEditHistoryParams.dump_request(params)
+          parsed, options = MetronomeSDK::V2::ContractGetEditHistoryParams.dump_request(params)
           @client.request(
             method: :post,
             path: "v2/contracts/getEditHistory",

data/lib/metronome_sdk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module MetronomeSDK
-  VERSION = "0.1.0.pre.alpha.1"
+  VERSION = "0.1.0.pre.alpha.2"
 end

data/lib/metronome_sdk.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 # Standard libraries.
+# rubocop:disable Lint/RedundantRequireStatement
 require "English"
 require "cgi"
 require "date"
@@ -15,6 +16,7 @@ require "set"
 require "stringio"
 require "time"
 require "uri"
+# rubocop:enable Lint/RedundantRequireStatement
 
 # We already ship the preferred sorbet manifests in the package itself.
 # `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
@@ -111,6 +113,8 @@ require_relative "metronome_sdk/models/v1/contracts/product_update_params"
 require_relative "metronome_sdk/models/v1/contracts/product_update_response"
 require_relative "metronome_sdk/models/v1/contracts/quantity_conversion"
 require_relative "metronome_sdk/models/v1/contracts/quantity_rounding"
+require_relative "metronome_sdk/models/v1/contracts/rate_card_archive_params"
+require_relative "metronome_sdk/models/v1/contracts/rate_card_archive_response"
 require_relative "metronome_sdk/models/v1/contracts/rate_card_create_params"
 require_relative "metronome_sdk/models/v1/contracts/rate_card_create_response"
 require_relative "metronome_sdk/models/v1/contracts/rate_card_list_params"
@@ -251,6 +255,7 @@ require_relative "metronome_sdk/models/v2/contract_list_params"
 require_relative "metronome_sdk/models/v2/contract_list_response"
 require_relative "metronome_sdk/models/v2/contract_retrieve_params"
 require_relative "metronome_sdk/models/v2/contract_retrieve_response"
+require_relative "metronome_sdk/models"
 require_relative "metronome_sdk/resources/v1"
 require_relative "metronome_sdk/resources/v1/alerts"
 require_relative "metronome_sdk/resources/v1/audit_logs"

data/rbi/metronome_sdk/client.rbi

@@ -21,7 +21,8 @@ module MetronomeSDK
 
     # @api private
     sig { override.returns(T::Hash[String, String]) }
-    private def auth_headers; end
+    private def auth_headers
+    end
 
     # Creates and returns a new client for interacting with the API.
     sig do
@@ -32,8 +33,7 @@ module MetronomeSDK
         timeout: Float,
         initial_retry_delay: Float,
         max_retry_delay: Float
-      )
-        .returns(T.attached_class)
+      ).returns(T.attached_class)
     end
     def self.new(
       # Defaults to `ENV["METRONOME_BEARER_TOKEN"]`
@@ -46,6 +46,7 @@ module MetronomeSDK
       timeout: MetronomeSDK::Client::DEFAULT_TIMEOUT_IN_SECONDS,
       initial_retry_delay: MetronomeSDK::Client::DEFAULT_INITIAL_RETRY_DELAY,
       max_retry_delay: MetronomeSDK::Client::DEFAULT_MAX_RETRY_DELAY
-    ); end
+    )
+    end
   end
 end

data/rbi/metronome_sdk/errors.rbi

@@ -29,10 +29,17 @@ module MetronomeSDK
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: nil
+      )
       end
-      def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: nil); end
     end
 
     class APIConnectionError < MetronomeSDK::Errors::APIError
@@ -51,10 +58,16 @@ module MetronomeSDK
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
       end
-      def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Connection error.")
+      def self.new(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Connection error."
+      )
       end
     end
 
@@ -68,10 +81,16 @@ module MetronomeSDK
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
       end
-      def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Request timed out.")
+      def self.new(
+        url:,
+        status: nil,
+        body: nil,
+        request: nil,
+        response: nil,
+        message: "Request timed out."
+      )
       end
     end
 
@@ -85,10 +104,10 @@ module MetronomeSDK
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
+      end
+      def self.for(url:, status:, body:, request:, response:, message: nil)
       end
-      def self.for(url:, status:, body:, request:, response:, message: nil); end
 
       sig { returns(Integer) }
       attr_accessor :status
@@ -102,10 +121,10 @@ module MetronomeSDK
           request: NilClass,
           response: NilClass,
           message: T.nilable(String)
-        )
-          .returns(T.attached_class)
+        ).returns(T.attached_class)
+      end
+      def self.new(url:, status:, body:, request:, response:, message: nil)
       end
-      def self.new(url:, status:, body:, request:, response:, message: nil); end
     end
 
     class BadRequestError < MetronomeSDK::Errors::APIStatusError

data/rbi/metronome_sdk/file_part.rbi

@@ -13,22 +13,25 @@ module MetronomeSDK
 
     # @api private
     sig { returns(String) }
-    private def read; end
+    private def read
+    end
 
     sig { params(a: T.anything).returns(String) }
-    def to_json(*a); end
+    def to_json(*a)
+    end
 
     sig { params(a: T.anything).returns(String) }
-    def to_yaml(*a); end
+    def to_yaml(*a)
+    end
 
     sig do
       params(
         content: T.any(Pathname, StringIO, IO, String),
         filename: T.nilable(String),
         content_type: T.nilable(String)
-      )
-        .returns(T.attached_class)
+      ).returns(T.attached_class)
+    end
+    def self.new(content, filename: nil, content_type: nil)
     end
-    def self.new(content, filename: nil, content_type: nil); end
   end
 end

data/rbi/metronome_sdk/internal/cursor_page.rbi

@@ -15,7 +15,8 @@ module MetronomeSDK
 
       # @api private
       sig { returns(String) }
-      def inspect; end
+      def inspect
+      end
     end
   end
 end