metronome-sdk 0.1.0.pre.alpha.1

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

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Customers
+        class Commits
+          # Some parameter documentations has been truncated, see
+          # {MetronomeSDK::Models::V1::Customers::CommitCreateParams} for more details.
+          #
+          # Create a new commit at the customer level.
+          #
+          # @overload create(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: {})
+          #
+          # @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
+          #
+          # @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
+          #
+          # @param rate_type [Symbol, MetronomeSDK::Models::V1::Customers::CommitCreateParams::RateType]
+          #
+          # @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
+          #
+          # @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}, nil]
+          #
+          # @return [MetronomeSDK::Models::V1::Customers::CommitCreateResponse]
+          #
+          # @see MetronomeSDK::Models::V1::Customers::CommitCreateParams
+          def create(params)
+            parsed, options = MetronomeSDK::Models::V1::Customers::CommitCreateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "v1/contracts/customerCommits/create",
+              body: parsed,
+              model: MetronomeSDK::Models::V1::Customers::CommitCreateResponse,
+              options: options
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {MetronomeSDK::Models::V1::Customers::CommitListParams} for more details.
+          #
+          # List commits.
+          #
+          # @overload list(customer_id:, commit_id: nil, covering_date: nil, effective_before: nil, include_archived: nil, include_balance: nil, include_contract_commits: nil, include_ledgers: nil, next_page: nil, starting_at: nil, request_options: {})
+          #
+          # @param customer_id [String]
+          #
+          # @param commit_id [String]
+          #
+          # @param covering_date [Time] Include only commits that have access schedules that "cover" the provided date
+          #
+          # @param effective_before [Time] Include only commits that have any access before the provided date (exclusive)
+          #
+          # @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.
+          #
+          # @param starting_at [Time] Include only commits that have any access on or after the provided date
+          #
+          # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [MetronomeSDK::Models::V1::Customers::CommitListResponse]
+          #
+          # @see MetronomeSDK::Models::V1::Customers::CommitListParams
+          def list(params)
+            parsed, options = MetronomeSDK::Models::V1::Customers::CommitListParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "v1/contracts/customerCommits/list",
+              body: parsed,
+              model: MetronomeSDK::Models::V1::Customers::CommitListResponse,
+              options: options
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {MetronomeSDK::Models::V1::Customers::CommitUpdateEndDateParams} for more
+          # details.
+          #
+          # Pull forward the end date of a prepaid commit. Use the "edit a commit" endpoint
+          # to extend the end date of a prepaid commit, or to make other edits to the
+          # commit.
+          #
+          # @overload update_end_date(commit_id:, customer_id:, access_ending_before: nil, invoices_ending_before: nil, request_options: {})
+          #
+          # @param commit_id [String] ID of the commit to update. Only supports "PREPAID" commits.
+          #
+          # @param customer_id [String] ID of the customer whose commit is to be updated
+          #
+          # @param access_ending_before [Time] RFC 3339 timestamp indicating when access to the commit will end and it will no
+          # ...
+          #
+          # @param invoices_ending_before [Time] RFC 3339 timestamp indicating when the commit will stop being invoiced (exclusiv
+          # ...
+          #
+          # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [MetronomeSDK::Models::V1::Customers::CommitUpdateEndDateResponse]
+          #
+          # @see MetronomeSDK::Models::V1::Customers::CommitUpdateEndDateParams
+          def update_end_date(params)
+            parsed, options = MetronomeSDK::Models::V1::Customers::CommitUpdateEndDateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "v1/contracts/customerCommits/updateEndDate",
+              body: parsed,
+              model: MetronomeSDK::Models::V1::Customers::CommitUpdateEndDateResponse,
+              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/credits.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Customers
+        class Credits
+          # Some parameter documentations has been truncated, see
+          # {MetronomeSDK::Models::V1::Customers::CreditCreateParams} for more details.
+          #
+          # Create a new credit at the customer level.
+          #
+          # @overload create(access_schedule:, customer_id:, priority:, product_id:, applicable_contract_ids: nil, applicable_product_ids: nil, applicable_product_tags: nil, custom_fields: nil, description: nil, name: nil, netsuite_sales_order_id: nil, rate_type: nil, salesforce_opportunity_id: nil, uniqueness_key: nil, request_options: {})
+          #
+          # @param access_schedule [MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule] Schedule for distributing the credit to the customer.
+          #
+          # @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]
+          #
+          # @param applicable_contract_ids [Array<String>] Which contract the credit applies to. If not provided, the credit applies to all
+          # ...
+          #
+          # @param applicable_product_ids [Array<String>] Which products the credit applies to. If both applicable_product_ids and applica
+          # ...
+          #
+          # @param applicable_product_tags [Array<String>] Which tags the credit 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 name [String] displayed on invoices
+          #
+          # @param netsuite_sales_order_id [String] This field's availability is dependent on your client's configuration.
+          #
+          # @param rate_type [Symbol, MetronomeSDK::Models::V1::Customers::CreditCreateParams::RateType]
+          #
+          # @param salesforce_opportunity_id [String] This field's availability is dependent on your client's configuration.
+          #
+          # @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}, nil]
+          #
+          # @return [MetronomeSDK::Models::V1::Customers::CreditCreateResponse]
+          #
+          # @see MetronomeSDK::Models::V1::Customers::CreditCreateParams
+          def create(params)
+            parsed, options = MetronomeSDK::Models::V1::Customers::CreditCreateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "v1/contracts/customerCredits/create",
+              body: parsed,
+              model: MetronomeSDK::Models::V1::Customers::CreditCreateResponse,
+              options: options
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {MetronomeSDK::Models::V1::Customers::CreditListParams} for more details.
+          #
+          # List credits.
+          #
+          # @overload list(customer_id:, covering_date: nil, credit_id: nil, effective_before: nil, include_archived: nil, include_balance: nil, include_contract_credits: nil, include_ledgers: nil, next_page: nil, starting_at: nil, request_options: {})
+          #
+          # @param customer_id [String]
+          #
+          # @param covering_date [Time] Return only credits that have access schedules that "cover" the provided date
+          #
+          # @param credit_id [String]
+          #
+          # @param effective_before [Time] Include only credits 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 in the response. Setting this flag may cause the query to be
+          # ...
+          #
+          # @param include_contract_credits [Boolean] Include credits on the contract level.
+          #
+          # @param include_ledgers [Boolean] Include credit ledgers in the response. Setting this flag may cause the query to
+          # ...
+          #
+          # @param next_page [String] The next page token from a previous response.
+          #
+          # @param starting_at [Time] Include only credits that have any access on or after the provided date
+          #
+          # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [MetronomeSDK::Models::V1::Customers::CreditListResponse]
+          #
+          # @see MetronomeSDK::Models::V1::Customers::CreditListParams
+          def list(params)
+            parsed, options = MetronomeSDK::Models::V1::Customers::CreditListParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "v1/contracts/customerCredits/list",
+              body: parsed,
+              model: MetronomeSDK::Models::V1::Customers::CreditListResponse,
+              options: options
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {MetronomeSDK::Models::V1::Customers::CreditUpdateEndDateParams} for more
+          # details.
+          #
+          # Pull forward the end date of a credit. Use the "edit a credit" endpoint to
+          # extend the end date of a credit, or to make other edits to the credit.
+          #
+          # @overload update_end_date(access_ending_before:, credit_id:, customer_id:, request_options: {})
+          #
+          # @param access_ending_before [Time] RFC 3339 timestamp indicating when access to the credit will end and it will no
+          # ...
+          #
+          # @param credit_id [String] ID of the commit to update
+          #
+          # @param customer_id [String] ID of the customer whose credit is to be updated
+          #
+          # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [MetronomeSDK::Models::V1::Customers::CreditUpdateEndDateResponse]
+          #
+          # @see MetronomeSDK::Models::V1::Customers::CreditUpdateEndDateParams
+          def update_end_date(params)
+            parsed, options = MetronomeSDK::Models::V1::Customers::CreditUpdateEndDateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "v1/contracts/customerCredits/updateEndDate",
+              body: parsed,
+              model: MetronomeSDK::Models::V1::Customers::CreditUpdateEndDateResponse,
+              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/invoices.rb

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Customers
+        class Invoices
+          # Some parameter documentations has been truncated, see
+          # {MetronomeSDK::Models::V1::Customers::InvoiceRetrieveParams} for more details.
+          #
+          # Fetch a specific invoice for a given customer.
+          #
+          # @overload retrieve(customer_id:, invoice_id:, skip_zero_qty_line_items: nil, request_options: {})
+          #
+          # @param customer_id [String] Path param:
+          #
+          # @param invoice_id [String] Path param:
+          #
+          # @param skip_zero_qty_line_items [Boolean] Query param: If set, all zero quantity line items will be filtered out of the re
+          # ...
+          #
+          # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [MetronomeSDK::Models::V1::Customers::InvoiceRetrieveResponse]
+          #
+          # @see MetronomeSDK::Models::V1::Customers::InvoiceRetrieveParams
+          def retrieve(params)
+            parsed, options = MetronomeSDK::Models::V1::Customers::InvoiceRetrieveParams.dump_request(params)
+            customer_id =
+              parsed.delete(:customer_id) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            invoice_id =
+              parsed.delete(:invoice_id) do
+                raise ArgumentError.new("missing required path argument #{_1}")
+              end
+            @client.request(
+              method: :get,
+              path: ["v1/customers/%1$s/invoices/%2$s", customer_id, invoice_id],
+              query: parsed,
+              model: MetronomeSDK::Models::V1::Customers::InvoiceRetrieveResponse,
+              options: options
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {MetronomeSDK::Models::V1::Customers::InvoiceListParams} for more details.
+          #
+          # List all invoices for a given customer, optionally filtered by status, date
+          # range, and/or credit type.
+          #
+          # @overload list(customer_id:, credit_type_id: nil, ending_before: nil, limit: nil, next_page: nil, skip_zero_qty_line_items: nil, sort: nil, starting_on: nil, status: nil, request_options: {})
+          #
+          # @param customer_id [String] Path param:
+          #
+          # @param credit_type_id [String] Query param: Only return invoices for the specified credit type
+          #
+          # @param ending_before [Time] Query param: RFC 3339 timestamp (exclusive). Invoices will only be returned for
+          # ...
+          #
+          # @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 skip_zero_qty_line_items [Boolean] Query param: If set, all zero quantity line items will be filtered out of the re
+          # ...
+          #
+          # @param sort [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListParams::Sort] Query param: Invoice sort order by issued_at, e.g. date_asc or date_desc. Defau
+          # ...
+          #
+          # @param starting_on [Time] Query param: RFC 3339 timestamp (inclusive). Invoices will only be returned for
+          # ...
+          #
+          # @param status [String] Query param: Invoice status, e.g. DRAFT, FINALIZED, or VOID
+          #
+          # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [MetronomeSDK::Internal::CursorPage<MetronomeSDK::Models::V1::Customers::Invoice>]
+          #
+          # @see MetronomeSDK::Models::V1::Customers::InvoiceListParams
+          def list(params)
+            parsed, options = MetronomeSDK::Models::V1::Customers::InvoiceListParams.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/invoices", customer_id],
+              query: parsed,
+              page: MetronomeSDK::Internal::CursorPage,
+              model: MetronomeSDK::Models::V1::Customers::Invoice,
+              options: options
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {MetronomeSDK::Models::V1::Customers::InvoiceAddChargeParams} for more details.
+          #
+          # Add a one time charge to the specified invoice
+          #
+          # @overload add_charge(customer_id:, charge_id:, customer_plan_id:, description:, invoice_start_timestamp:, price:, quantity:, request_options: {})
+          #
+          # @param customer_id [String] Path param:
+          #
+          # @param charge_id [String] Body param: The Metronome ID of the charge to add to the invoice. Note that the
+          # ...
+          #
+          # @param customer_plan_id [String] Body param: The Metronome ID of the customer plan to add the charge to.
+          #
+          # @param description [String] Body param:
+          #
+          # @param invoice_start_timestamp [Time] Body param: The start_timestamp of the invoice to add the charge to.
+          #
+          # @param price [Float] Body param: The price of the charge. This price will match the currency on the i
+          # ...
+          #
+          # @param quantity [Float] Body param:
+          #
+          # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [MetronomeSDK::Models::V1::Customers::InvoiceAddChargeResponse]
+          #
+          # @see MetronomeSDK::Models::V1::Customers::InvoiceAddChargeParams
+          def add_charge(params)
+            parsed, options = MetronomeSDK::Models::V1::Customers::InvoiceAddChargeParams.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/addCharge", customer_id],
+              body: parsed,
+              model: MetronomeSDK::Models::V1::Customers::InvoiceAddChargeResponse,
+              options: options
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsParams} for more
+          # details.
+          #
+          # List daily or hourly invoice breakdowns for a given customer, optionally
+          # filtered by status, date range, and/or credit type. Important considerations:
+          #
+          # - If we receive backdated usage after an invoice has been finalized, the
+          #   backdated usage will be included in the response and usage numbers may differ.
+          #
+          # @overload list_breakdowns(customer_id:, ending_before:, starting_on:, credit_type_id: nil, limit: nil, next_page: nil, skip_zero_qty_line_items: nil, sort: nil, status: nil, window_size: nil, request_options: {})
+          #
+          # @param customer_id [String] Path param:
+          #
+          # @param ending_before [Time] Query param: RFC 3339 timestamp. Breakdowns will only be returned for time windo
+          # ...
+          #
+          # @param starting_on [Time] Query param: RFC 3339 timestamp. Breakdowns will only be returned for time windo
+          # ...
+          #
+          # @param credit_type_id [String] Query param: Only return invoices for the specified credit type
+          #
+          # @param limit [Integer] Query param: Max number of results that should be returned. For daily breakdowns
+          # ...
+          #
+          # @param next_page [String] Query param: Cursor that indicates where the next page of results should start.
+          #
+          # @param skip_zero_qty_line_items [Boolean] Query param: If set, all zero quantity line items will be filtered out of the re
+          # ...
+          #
+          # @param sort [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsParams::Sort] Query param: Invoice sort order by issued_at, e.g. date_asc or date_desc. Defau
+          # ...
+          #
+          # @param status [String] Query param: Invoice status, e.g. DRAFT or FINALIZED
+          #
+          # @param window_size [Symbol, MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsParams::WindowSize] Query param: The granularity of the breakdowns to return. Defaults to day.
+          #
+          # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [MetronomeSDK::Internal::CursorPage<MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse>]
+          #
+          # @see MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsParams
+          def list_breakdowns(params)
+            parsed, options = MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsParams.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/invoices/breakdowns", customer_id],
+              query: parsed,
+              page: MetronomeSDK::Internal::CursorPage,
+              model: MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse,
+              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/named_schedules.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Customers
+        class NamedSchedules
+          # Some parameter documentations has been truncated, see
+          # {MetronomeSDK::Models::V1::Customers::NamedScheduleRetrieveParams} for more
+          # details.
+          #
+          # Get a named schedule for the given customer. This endpoint's availability is
+          # dependent on your client's configuration.
+          #
+          # @overload retrieve(customer_id:, schedule_name:, covering_date: nil, request_options: {})
+          #
+          # @param customer_id [String] ID of the customer whose named schedule is to be retrieved
+          #
+          # @param schedule_name [String] The identifier for the schedule to be retrieved
+          #
+          # @param covering_date [Time] If provided, at most one schedule segment will be returned (the one that covers
+          # ...
+          #
+          # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [MetronomeSDK::Models::V1::Customers::NamedScheduleRetrieveResponse]
+          #
+          # @see MetronomeSDK::Models::V1::Customers::NamedScheduleRetrieveParams
+          def retrieve(params)
+            parsed, options = MetronomeSDK::Models::V1::Customers::NamedScheduleRetrieveParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "v1/customers/getNamedSchedule",
+              body: parsed,
+              model: MetronomeSDK::Models::V1::Customers::NamedScheduleRetrieveResponse,
+              options: options
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {MetronomeSDK::Models::V1::Customers::NamedScheduleUpdateParams} for more
+          # details.
+          #
+          # Update a named schedule for the given customer. This endpoint's availability is
+          # dependent on your client's configuration.
+          #
+          # @overload update(customer_id:, schedule_name:, starting_at:, value:, ending_before: nil, request_options: {})
+          #
+          # @param customer_id [String] ID of the customer whose named schedule is to be updated
+          #
+          # @param schedule_name [String] The identifier for the schedule to be updated
+          #
+          # @param starting_at [Time]
+          #
+          # @param value [Object] The value to set for the named schedule. The structure of this object is specifi
+          # ...
+          #
+          # @param ending_before [Time]
+          #
+          # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [nil]
+          #
+          # @see MetronomeSDK::Models::V1::Customers::NamedScheduleUpdateParams
+          def update(params)
+            parsed, options = MetronomeSDK::Models::V1::Customers::NamedScheduleUpdateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "v1/customers/updateNamedSchedule",
+              body: parsed,
+              model: NilClass,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [MetronomeSDK::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end