metronome-sdk 0.1.0.pre.alpha.1

data/lib/metronome_sdk/resources/v1/customers/plans.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Customers
+        class Plans
+          # List the given customer's plans in reverse-chronological order.
+          #
+          # @overload list(customer_id:, limit: nil, next_page: nil, request_options: {})
+          #
+          # @param customer_id [String] Path param:
+          #
+          # @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 request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [MetronomeSDK::Internal::CursorPage<MetronomeSDK::Models::V1::Customers::PlanListResponse>]
+          #
+          # @see MetronomeSDK::Models::V1::Customers::PlanListParams
+          def list(params)
+            parsed, options = MetronomeSDK::Models::V1::Customers::PlanListParams.dump_request(params)
+            customer_id =
+              parsed.delete(:customer_id) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              method: :get,
+              path: ["v1/customers/%1$s/plans", customer_id],
+              query: parsed,
+              page: MetronomeSDK::Internal::CursorPage,
+              model: MetronomeSDK::Models::V1::Customers::PlanListResponse,
+              options: options
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {MetronomeSDK::Models::V1::Customers::PlanAddParams} for more details.
+          #
+          # Associate an existing customer with a plan for a specified date range. See the
+          # [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments)
+          # for details on the price adjustments.
+          #
+          # @overload add(customer_id:, plan_id:, starting_on:, ending_before: nil, net_payment_terms_days: nil, overage_rate_adjustments: nil, price_adjustments: nil, trial_spec: nil, request_options: {})
+          #
+          # @param customer_id [String] Path param:
+          #
+          # @param plan_id [String] Body param:
+          #
+          # @param starting_on [Time] Body param: RFC 3339 timestamp for when the plan becomes active for this custome
+          # ...
+          #
+          # @param ending_before [Time] Body param: RFC 3339 timestamp for when the plan ends (exclusive) for this custo
+          # ...
+          #
+          # @param net_payment_terms_days [Float] Body param: Number of days after issuance of invoice after which the invoice is
+          # ...
+          #
+          # @param overage_rate_adjustments [Array<MetronomeSDK::Models::V1::Customers::PlanAddParams::OverageRateAdjustment>] Body param: An optional list of overage rates that override the rates of the ori
+          # ...
+          #
+          # @param price_adjustments [Array<MetronomeSDK::Models::V1::Customers::PlanAddParams::PriceAdjustment>] Body param: A list of price adjustments can be applied on top of the pricing in
+          # ...
+          #
+          # @param trial_spec [MetronomeSDK::Models::V1::Customers::PlanAddParams::TrialSpec] Body param: A custom trial can be set for the customer's plan. See the [trial co
+          # ...
+          #
+          # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [MetronomeSDK::Models::V1::Customers::PlanAddResponse]
+          #
+          # @see MetronomeSDK::Models::V1::Customers::PlanAddParams
+          def add(params)
+            parsed, options = MetronomeSDK::Models::V1::Customers::PlanAddParams.dump_request(params)
+            customer_id =
+              parsed.delete(:customer_id) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              method: :post,
+              path: ["v1/customers/%1$s/plans/add", customer_id],
+              body: parsed,
+              model: MetronomeSDK::Models::V1::Customers::PlanAddResponse,
+              options: options
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {MetronomeSDK::Models::V1::Customers::PlanEndParams} for more details.
+          #
+          # Change the end date of a customer's plan.
+          #
+          # @overload end_(customer_id:, customer_plan_id:, ending_before: nil, void_invoices: nil, void_stripe_invoices: nil, request_options: {})
+          #
+          # @param customer_id [String] Path param:
+          #
+          # @param customer_plan_id [String] Path param: the ID of a customer-plan relationship
+          #
+          # @param ending_before [Time] Body param: RFC 3339 timestamp for when the plan ends (exclusive) for this custo
+          # ...
+          #
+          # @param void_invoices [Boolean] Body param: If true, plan end date can be before the last finalized invoice date
+          # ...
+          #
+          # @param void_stripe_invoices [Boolean] Body param: Only applicable when void_invoices is set to true. If true, for ever
+          # ...
+          #
+          # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [MetronomeSDK::Models::V1::Customers::PlanEndResponse]
+          #
+          # @see MetronomeSDK::Models::V1::Customers::PlanEndParams
+          def end_(params)
+            parsed, options = MetronomeSDK::Models::V1::Customers::PlanEndParams.dump_request(params)
+            customer_id =
+              parsed.delete(:customer_id) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            customer_plan_id =
+              parsed.delete(:customer_plan_id) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              method: :post,
+              path: ["v1/customers/%1$s/plans/%2$s/end", customer_id, customer_plan_id],
+              body: parsed,
+              model: MetronomeSDK::Models::V1::Customers::PlanEndResponse,
+              options: options
+            )
+          end
+
+          # Lists a customer plans adjustments. See the
+          # [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments)
+          # for details.
+          #
+          # @overload list_price_adjustments(customer_id:, customer_plan_id:, limit: nil, next_page: nil, request_options: {})
+          #
+          # @param customer_id [String] Path param:
+          #
+          # @param customer_plan_id [String] Path param: the ID of a customer-plan relationship
+          #
+          # @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 request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [MetronomeSDK::Internal::CursorPage<MetronomeSDK::Models::V1::Customers::PlanListPriceAdjustmentsResponse>]
+          #
+          # @see MetronomeSDK::Models::V1::Customers::PlanListPriceAdjustmentsParams
+          def list_price_adjustments(params)
+            parsed, options =
+              MetronomeSDK::Models::V1::Customers::PlanListPriceAdjustmentsParams.dump_request(params)
+            customer_id =
+              parsed.delete(:customer_id) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            customer_plan_id =
+              parsed.delete(:customer_plan_id) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              method: :get,
+              path: ["v1/customers/%1$s/plans/%2$s/priceAdjustments", customer_id, customer_plan_id],
+              query: parsed,
+              page: MetronomeSDK::Internal::CursorPage,
+              model: MetronomeSDK::Models::V1::Customers::PlanListPriceAdjustmentsResponse,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [MetronomeSDK::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,336 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Customers
+        # @return [MetronomeSDK::Resources::V1::Customers::Alerts]
+        attr_reader :alerts
+
+        # @return [MetronomeSDK::Resources::V1::Customers::Plans]
+        attr_reader :plans
+
+        # @return [MetronomeSDK::Resources::V1::Customers::Invoices]
+        attr_reader :invoices
+
+        # @return [MetronomeSDK::Resources::V1::Customers::BillingConfig]
+        attr_reader :billing_config
+
+        # @return [MetronomeSDK::Resources::V1::Customers::Commits]
+        attr_reader :commits
+
+        # @return [MetronomeSDK::Resources::V1::Customers::Credits]
+        attr_reader :credits
+
+        # @return [MetronomeSDK::Resources::V1::Customers::NamedSchedules]
+        attr_reader :named_schedules
+
+        # Some parameter documentations has been truncated, see
+        # {MetronomeSDK::Models::V1::CustomerCreateParams} for more details.
+        #
+        # Create a new customer
+        #
+        # @overload create(name:, billing_config: nil, custom_fields: nil, customer_billing_provider_configurations: nil, external_id: nil, ingest_aliases: nil, request_options: {})
+        #
+        # @param name [String] This will be truncated to 160 characters if the provided name is longer.
+        #
+        # @param billing_config [MetronomeSDK::Models::V1::CustomerCreateParams::BillingConfig]
+        #
+        # @param custom_fields [Hash{Symbol=>String}]
+        #
+        # @param customer_billing_provider_configurations [Array<MetronomeSDK::Models::V1::CustomerCreateParams::CustomerBillingProviderConfiguration>]
+        #
+        # @param external_id [String] (deprecated, use ingest_aliases instead) an alias that can be used to refer to t
+        # ...
+        #
+        # @param ingest_aliases [Array<String>] Aliases that can be used to refer to this customer in usage events
+        #
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MetronomeSDK::Models::V1::CustomerCreateResponse]
+        #
+        # @see MetronomeSDK::Models::V1::CustomerCreateParams
+        def create(params)
+          parsed, options = MetronomeSDK::Models::V1::CustomerCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/customers",
+            body: parsed,
+            model: MetronomeSDK::Models::V1::CustomerCreateResponse,
+            options: options
+          )
+        end
+
+        # Get a customer by Metronome ID.
+        #
+        # @overload retrieve(customer_id:, request_options: {})
+        #
+        # @param customer_id [String]
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MetronomeSDK::Models::V1::CustomerRetrieveResponse]
+        #
+        # @see MetronomeSDK::Models::V1::CustomerRetrieveParams
+        def retrieve(params)
+          parsed, options = MetronomeSDK::Models::V1::CustomerRetrieveParams.dump_request(params)
+          customer_id =
+            parsed.delete(:customer_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["v1/customers/%1$s", customer_id],
+            model: MetronomeSDK::Models::V1::CustomerRetrieveResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {MetronomeSDK::Models::V1::CustomerListParams} for more details.
+        #
+        # List all customers.
+        #
+        # @overload list(customer_ids: nil, ingest_alias: nil, limit: nil, next_page: nil, only_archived: nil, salesforce_account_ids: nil, request_options: {})
+        #
+        # @param customer_ids [Array<String>] Filter the customer list by customer_id. Up to 100 ids can be provided.
+        #
+        # @param ingest_alias [String] Filter the customer list by ingest_alias
+        #
+        # @param limit [Integer] Max number of results that should be returned
+        #
+        # @param next_page [String] Cursor that indicates where the next page of results should start.
+        #
+        # @param only_archived [Boolean] Filter the customer list to only return archived customers. By default, only act
+        # ...
+        #
+        # @param salesforce_account_ids [Array<String>] Filter the customer list by salesforce_account_id. Up to 100 ids can be provide
+        # ...
+        #
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MetronomeSDK::Internal::CursorPage<MetronomeSDK::Models::V1::CustomerDetail>]
+        #
+        # @see MetronomeSDK::Models::V1::CustomerListParams
+        def list(params = {})
+          parsed, options = MetronomeSDK::Models::V1::CustomerListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: "v1/customers",
+            query: parsed,
+            page: MetronomeSDK::Internal::CursorPage,
+            model: MetronomeSDK::Models::V1::CustomerDetail,
+            options: options
+          )
+        end
+
+        # Archive a customer
+        #
+        # @overload archive(id:, request_options: {})
+        #
+        # @param id [String]
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MetronomeSDK::Models::V1::CustomerArchiveResponse]
+        #
+        # @see MetronomeSDK::Models::V1::CustomerArchiveParams
+        def archive(params)
+          parsed, options = MetronomeSDK::Models::V1::CustomerArchiveParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/customers/archive",
+            body: parsed,
+            model: MetronomeSDK::Models::V1::CustomerArchiveResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {MetronomeSDK::Models::V1::CustomerListBillableMetricsParams} for more details.
+        #
+        # Get all billable metrics for a given customer.
+        #
+        # @overload list_billable_metrics(customer_id:, include_archived: nil, limit: nil, next_page: nil, on_current_plan: nil, request_options: {})
+        #
+        # @param customer_id [String] Path param:
+        #
+        # @param include_archived [Boolean] Query param: If true, the list of returned metrics will include archived metrics
+        # ...
+        #
+        # @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 on_current_plan [Boolean] Query param: If true, the list of metrics will be filtered to just ones that are
+        # ...
+        #
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MetronomeSDK::Internal::CursorPage<MetronomeSDK::Models::V1::CustomerListBillableMetricsResponse>]
+        #
+        # @see MetronomeSDK::Models::V1::CustomerListBillableMetricsParams
+        def list_billable_metrics(params)
+          parsed, options = MetronomeSDK::Models::V1::CustomerListBillableMetricsParams.dump_request(params)
+          customer_id =
+            parsed.delete(:customer_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["v1/customers/%1$s/billable-metrics", customer_id],
+            query: parsed,
+            page: MetronomeSDK::Internal::CursorPage,
+            model: MetronomeSDK::Models::V1::CustomerListBillableMetricsResponse,
+            options: options
+          )
+        end
+
+        # Fetch daily pending costs for the specified customer, broken down by credit type
+        # and line items. Note: this is not supported for customers whose plan includes a
+        # UNIQUE-type billable metric.
+        #
+        # @overload list_costs(customer_id:, ending_before:, starting_on:, limit: nil, next_page: nil, request_options: {})
+        #
+        # @param customer_id [String] Path param:
+        #
+        # @param ending_before [Time] Query param: RFC 3339 timestamp (exclusive)
+        #
+        # @param starting_on [Time] Query param: RFC 3339 timestamp (inclusive)
+        #
+        # @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 request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MetronomeSDK::Internal::CursorPage<MetronomeSDK::Models::V1::CustomerListCostsResponse>]
+        #
+        # @see MetronomeSDK::Models::V1::CustomerListCostsParams
+        def list_costs(params)
+          parsed, options = MetronomeSDK::Models::V1::CustomerListCostsParams.dump_request(params)
+          customer_id =
+            parsed.delete(:customer_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["v1/customers/%1$s/costs", customer_id],
+            query: parsed,
+            page: MetronomeSDK::Internal::CursorPage,
+            model: MetronomeSDK::Models::V1::CustomerListCostsResponse,
+            options: options
+          )
+        end
+
+        # Sets the ingest aliases for a customer. Ingest aliases can be used in the
+        # `customer_id` field when sending usage events to Metronome. This call is
+        # idempotent. It fully replaces the set of ingest aliases for the given customer.
+        #
+        # @overload set_ingest_aliases(customer_id:, ingest_aliases:, request_options: {})
+        #
+        # @param customer_id [String] Path param:
+        #
+        # @param ingest_aliases [Array<String>] Body param:
+        #
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see MetronomeSDK::Models::V1::CustomerSetIngestAliasesParams
+        def set_ingest_aliases(params)
+          parsed, options = MetronomeSDK::Models::V1::CustomerSetIngestAliasesParams.dump_request(params)
+          customer_id =
+            parsed.delete(:customer_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :post,
+            path: ["v1/customers/%1$s/setIngestAliases", customer_id],
+            body: parsed,
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {MetronomeSDK::Models::V1::CustomerSetNameParams} for more details.
+        #
+        # Updates the specified customer's name.
+        #
+        # @overload set_name(customer_id:, name:, request_options: {})
+        #
+        # @param customer_id [String] Path param:
+        #
+        # @param name [String] Body param: The new name for the customer. This will be truncated to 160 charact
+        # ...
+        #
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MetronomeSDK::Models::V1::CustomerSetNameResponse]
+        #
+        # @see MetronomeSDK::Models::V1::CustomerSetNameParams
+        def set_name(params)
+          parsed, options = MetronomeSDK::Models::V1::CustomerSetNameParams.dump_request(params)
+          customer_id =
+            parsed.delete(:customer_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :post,
+            path: ["v1/customers/%1$s/setName", customer_id],
+            body: parsed,
+            model: MetronomeSDK::Models::V1::CustomerSetNameResponse,
+            options: options
+          )
+        end
+
+        # Some parameter documentations has been truncated, see
+        # {MetronomeSDK::Models::V1::CustomerUpdateConfigParams} for more details.
+        #
+        # Updates the specified customer's config.
+        #
+        # @overload update_config(customer_id:, leave_stripe_invoices_in_draft: nil, salesforce_account_id: nil, request_options: {})
+        #
+        # @param customer_id [String] Path param:
+        #
+        # @param leave_stripe_invoices_in_draft [Boolean, nil] Body param: Leave in draft or set to auto-advance on invoices sent to Stripe. Fa
+        # ...
+        #
+        # @param salesforce_account_id [String, nil] Body param: The Salesforce account ID for the customer
+        #
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [nil]
+        #
+        # @see MetronomeSDK::Models::V1::CustomerUpdateConfigParams
+        def update_config(params)
+          parsed, options = MetronomeSDK::Models::V1::CustomerUpdateConfigParams.dump_request(params)
+          customer_id =
+            parsed.delete(:customer_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :post,
+            path: ["v1/customers/%1$s/updateConfig", customer_id],
+            body: parsed,
+            model: NilClass,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [MetronomeSDK::Client]
+        def initialize(client:)
+          @client = client
+          @alerts = MetronomeSDK::Resources::V1::Customers::Alerts.new(client: client)
+          @plans = MetronomeSDK::Resources::V1::Customers::Plans.new(client: client)
+          @invoices = MetronomeSDK::Resources::V1::Customers::Invoices.new(client: client)
+          @billing_config = MetronomeSDK::Resources::V1::Customers::BillingConfig.new(client: client)
+          @commits = MetronomeSDK::Resources::V1::Customers::Commits.new(client: client)
+          @credits = MetronomeSDK::Resources::V1::Customers::Credits.new(client: client)
+          @named_schedules = MetronomeSDK::Resources::V1::Customers::NamedSchedules.new(client: client)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Dashboards
+        # Retrieve an embeddable dashboard url for a customer. The dashboard can be
+        # embedded using an iframe in a website. This will show information such as usage
+        # data and customer invoices.
+        #
+        # @overload get_embeddable_url(customer_id:, dashboard:, bm_group_key_overrides: nil, color_overrides: nil, dashboard_options: nil, request_options: {})
+        #
+        # @param customer_id [String]
+        #
+        # @param dashboard [Symbol, MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::Dashboard] The type of dashboard to retrieve.
+        #
+        # @param bm_group_key_overrides [Array<MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::BmGroupKeyOverride>] Optional list of billable metric group key overrides
+        #
+        # @param color_overrides [Array<MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::ColorOverride>] Optional list of colors to override
+        #
+        # @param dashboard_options [Array<MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::DashboardOption>] Optional dashboard specific options
+        #
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MetronomeSDK::Models::V1::DashboardGetEmbeddableURLResponse]
+        #
+        # @see MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams
+        def get_embeddable_url(params)
+          parsed, options = MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/dashboards/getEmbeddableUrl",
+            body: parsed,
+            model: MetronomeSDK::Models::V1::DashboardGetEmbeddableURLResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [MetronomeSDK::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Invoices
+        # Regenerate a voided contract invoice
+        #
+        # @overload regenerate(id:, request_options: {})
+        #
+        # @param id [String] The invoice id to regenerate
+        #
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MetronomeSDK::Models::V1::InvoiceRegenerateResponse]
+        #
+        # @see MetronomeSDK::Models::V1::InvoiceRegenerateParams
+        def regenerate(params)
+          parsed, options = MetronomeSDK::Models::V1::InvoiceRegenerateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/invoices/regenerate",
+            body: parsed,
+            model: MetronomeSDK::Models::V1::InvoiceRegenerateResponse,
+            options: options
+          )
+        end
+
+        # Void an invoice
+        #
+        # @overload void(id:, request_options: {})
+        #
+        # @param id [String] The invoice id to void
+        #
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MetronomeSDK::Models::V1::InvoiceVoidResponse]
+        #
+        # @see MetronomeSDK::Models::V1::InvoiceVoidParams
+        def void(params)
+          parsed, options = MetronomeSDK::Models::V1::InvoiceVoidParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/invoices/void",
+            body: parsed,
+            model: MetronomeSDK::Models::V1::InvoiceVoidResponse,
+            options: options
+          )
+        end
+
+        # @api private
+        #
+        # @param client [MetronomeSDK::Client]
+        def initialize(client:)
+          @client = client
+        end
+      end
+    end
+  end
+end