metronome-sdk 0.1.0.pre.alpha.1

data/lib/metronome_sdk/request_options.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < MetronomeSDK::Internal::Type::BaseModel
+    # @api private
+    #
+    # @param opts [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+    #
+    # @raise [ArgumentError]
+    def self.validate!(opts)
+      case opts
+      in MetronomeSDK::RequestOptions | Hash
+        opts.to_h.each_key do |k|
+          unless fields.include?(k)
+            raise ArgumentError.new("Request `opts` keys must be one of #{fields.keys}, got #{k.inspect}")
+          end
+        end
+      else
+        raise ArgumentError.new("Request `opts` must be a Hash or RequestOptions, got #{opts.inspect}")
+      end
+    end
+
+    # @!attribute idempotency_key
+    #   Idempotency key to send with request and all associated retries. Will only be
+    #   sent for write requests.
+    #
+    #   @return [String, nil]
+    optional :idempotency_key, String
+
+    # @!attribute extra_query
+    #   Extra query params to send with the request. These are `.merge`’d into any
+    #   `query` given at the client level.
+    #
+    #   @return [Hash{String=>Array<String>, String, nil}, nil]
+    optional :extra_query, MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::ArrayOf[String]]
+
+    # @!attribute extra_headers
+    #   Extra headers to send with the request. These are `.merged`’d into any
+    #   `extra_headers` given at the client level.
+    #
+    #   @return [Hash{String=>String, nil}, nil]
+    optional :extra_headers, MetronomeSDK::Internal::Type::HashOf[String, nil?: true]
+
+    # @!attribute extra_body
+    #   Extra data to send with the request. These are deep merged into any data
+    #   generated as part of the normal request.
+    #
+    #   @return [Object, nil]
+    optional :extra_body, MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]
+
+    # @!attribute max_retries
+    #   Maximum number of retries to attempt after a failed initial request.
+    #
+    #   @return [Integer, nil]
+    optional :max_retries, Integer
+
+    # @!attribute timeout
+    #   Request timeout in seconds.
+    #
+    #   @return [Float, nil]
+    optional :timeout, Float
+
+    # @!method initialize(values = {})
+    #   Returns a new instance of RequestOptions.
+    #
+    #   @param values [Hash{Symbol=>Object}]
+  end
+end

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

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Alerts
+        # Some parameter documentations has been truncated, see
+        # {MetronomeSDK::Models::V1::AlertCreateParams} for more details.
+        #
+        # Create a new alert
+        #
+        # @overload create(alert_type:, name:, threshold:, billable_metric_id: nil, credit_grant_type_filters: nil, credit_type_id: nil, custom_field_filters: nil, customer_id: nil, evaluate_on_create: nil, group_key_filter: nil, invoice_types_filter: nil, plan_id: nil, uniqueness_key: nil, request_options: {})
+        #
+        # @param alert_type [Symbol, MetronomeSDK::Models::V1::AlertCreateParams::AlertType] Type of the alert
+        #
+        # @param name [String] Name of the alert
+        #
+        # @param threshold [Float] Threshold value of the alert policy. Depending upon the alert type, this number
+        # ...
+        #
+        # @param billable_metric_id [String] For alerts of type `usage_threshold_reached`, specifies which billable metric to
+        # ...
+        #
+        # @param credit_grant_type_filters [Array<String>] An array of strings, representing a way to filter the credit grant this alert ap
+        # ...
+        #
+        # @param credit_type_id [String]
+        #
+        # @param custom_field_filters [Array<MetronomeSDK::Models::V1::AlertCreateParams::CustomFieldFilter>] A list of custom field filters for alert types that support advanced filtering.
+        # ...
+        #
+        # @param customer_id [String] If provided, will create this alert for this specific customer. To create an ale
+        # ...
+        #
+        # @param evaluate_on_create [Boolean] If true, the alert will evaluate immediately on customers that already meet the
+        # ...
+        #
+        # @param group_key_filter [MetronomeSDK::Models::V1::AlertCreateParams::GroupKeyFilter] Scopes alert evaluation to a specific presentation group key on individual line
+        # ...
+        #
+        # @param invoice_types_filter [Array<String>] Only supported for invoice_total_reached alerts. A list of invoice types to eval
+        # ...
+        #
+        # @param plan_id [String] If provided, will create this alert for this specific plan. To create an alert f
+        # ...
+        #
+        # @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
+        # ...
+        #
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MetronomeSDK::Models::V1::AlertCreateResponse]
+        #
+        # @see MetronomeSDK::Models::V1::AlertCreateParams
+        def create(params)
+          parsed, options = MetronomeSDK::Models::V1::AlertCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/alerts/create",
+            body: parsed,
+            model: MetronomeSDK::Models::V1::AlertCreateResponse,
+            options: options
+          )
+        end
+
+        # Archive an existing alert
+        #
+        # @overload archive(id:, release_uniqueness_key: nil, request_options: {})
+        #
+        # @param id [String] The Metronome ID of the alert
+        #
+        # @param release_uniqueness_key [Boolean] If true, resets the uniqueness key on this alert so it can be re-used
+        #
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MetronomeSDK::Models::V1::AlertArchiveResponse]
+        #
+        # @see MetronomeSDK::Models::V1::AlertArchiveParams
+        def archive(params)
+          parsed, options = MetronomeSDK::Models::V1::AlertArchiveParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/alerts/archive",
+            body: parsed,
+            model: MetronomeSDK::Models::V1::AlertArchiveResponse,
+            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/audit_logs.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class AuditLogs
+        # Some parameter documentations has been truncated, see
+        # {MetronomeSDK::Models::V1::AuditLogListParams} for more details.
+        #
+        # Retrieves a range of audit logs. If no further audit logs are currently
+        # available, the data array will be empty. As new audit logs are created,
+        # subsequent requests using the same next_page value will be in the returned data
+        # array, ensuring a continuous and uninterrupted reading of audit logs.
+        #
+        # @overload list(ending_before: nil, limit: nil, next_page: nil, resource_id: nil, resource_type: nil, sort: nil, starting_on: nil, request_options: {})
+        #
+        # @param ending_before [Time] RFC 3339 timestamp (exclusive). Cannot be used with 'next_page'.
+        #
+        # @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 resource_id [String] Optional parameter that can be used to filter which audit logs are returned. If
+        # ...
+        #
+        # @param resource_type [String] Optional parameter that can be used to filter which audit logs are returned. If
+        # ...
+        #
+        # @param sort [Symbol, MetronomeSDK::Models::V1::AuditLogListParams::Sort] Sort order by timestamp, e.g. date_asc or date_desc. Defaults to date_asc.
+        #
+        # @param starting_on [Time] RFC 3339 timestamp of the earliest audit log to return. Cannot be used with 'nex
+        # ...
+        #
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MetronomeSDK::Internal::CursorPage<MetronomeSDK::Models::V1::AuditLogListResponse>]
+        #
+        # @see MetronomeSDK::Models::V1::AuditLogListParams
+        def list(params = {})
+          parsed, options = MetronomeSDK::Models::V1::AuditLogListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: "v1/auditLogs",
+            query: parsed,
+            page: MetronomeSDK::Internal::CursorPage,
+            model: MetronomeSDK::Models::V1::AuditLogListResponse,
+            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/billable_metrics.rb

@@ -0,0 +1,131 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class BillableMetrics
+        # Some parameter documentations has been truncated, see
+        # {MetronomeSDK::Models::V1::BillableMetricCreateParams} for more details.
+        #
+        # Creates a new Billable Metric.
+        #
+        # @overload create(name:, aggregation_key: nil, aggregation_type: nil, custom_fields: nil, event_type_filter: nil, group_keys: nil, property_filters: nil, sql: nil, request_options: {})
+        #
+        # @param name [String] The display name of the billable metric.
+        #
+        # @param aggregation_key [String] Specifies the type of aggregation performed on matching events. Required if `sql
+        # ...
+        #
+        # @param aggregation_type [Symbol, MetronomeSDK::Models::V1::BillableMetricCreateParams::AggregationType] Specifies the type of aggregation performed on matching events.
+        #
+        # @param custom_fields [Hash{Symbol=>String}] Custom fields to attach to the billable metric.
+        #
+        # @param event_type_filter [MetronomeSDK::Models::EventTypeFilter] An optional filtering rule to match the 'event_type' property of an event.
+        #
+        # @param group_keys [Array<Array<String>>] Property names that are used to group usage costs on an invoice. Each entry repr
+        # ...
+        #
+        # @param property_filters [Array<MetronomeSDK::Models::PropertyFilter>] A list of filters to match events to this billable metric. Each filter defines a
+        # ...
+        #
+        # @param sql [String] The SQL query associated with the billable metric. This field is mutually exclus
+        # ...
+        #
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MetronomeSDK::Models::V1::BillableMetricCreateResponse]
+        #
+        # @see MetronomeSDK::Models::V1::BillableMetricCreateParams
+        def create(params)
+          parsed, options = MetronomeSDK::Models::V1::BillableMetricCreateParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/billable-metrics/create",
+            body: parsed,
+            model: MetronomeSDK::Models::V1::BillableMetricCreateResponse,
+            options: options
+          )
+        end
+
+        # Get a billable metric.
+        #
+        # @overload retrieve(billable_metric_id:, request_options: {})
+        #
+        # @param billable_metric_id [String]
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MetronomeSDK::Models::V1::BillableMetricRetrieveResponse]
+        #
+        # @see MetronomeSDK::Models::V1::BillableMetricRetrieveParams
+        def retrieve(params)
+          parsed, options = MetronomeSDK::Models::V1::BillableMetricRetrieveParams.dump_request(params)
+          billable_metric_id =
+            parsed.delete(:billable_metric_id) do
+              raise ArgumentError.new("missing required path argument #{_1}")
+            end
+          @client.request(
+            method: :get,
+            path: ["v1/billable-metrics/%1$s", billable_metric_id],
+            model: MetronomeSDK::Models::V1::BillableMetricRetrieveResponse,
+            options: options
+          )
+        end
+
+        # List all billable metrics.
+        #
+        # @overload list(include_archived: nil, limit: nil, next_page: nil, request_options: {})
+        #
+        # @param include_archived [Boolean] If true, the list of returned metrics will include archived metrics
+        #
+        # @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 request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MetronomeSDK::Internal::CursorPage<MetronomeSDK::Models::V1::BillableMetricListResponse>]
+        #
+        # @see MetronomeSDK::Models::V1::BillableMetricListParams
+        def list(params = {})
+          parsed, options = MetronomeSDK::Models::V1::BillableMetricListParams.dump_request(params)
+          @client.request(
+            method: :get,
+            path: "v1/billable-metrics",
+            query: parsed,
+            page: MetronomeSDK::Internal::CursorPage,
+            model: MetronomeSDK::Models::V1::BillableMetricListResponse,
+            options: options
+          )
+        end
+
+        # Archive an existing billable metric.
+        #
+        # @overload archive(id:, request_options: {})
+        #
+        # @param id [String]
+        # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+        #
+        # @return [MetronomeSDK::Models::V1::BillableMetricArchiveResponse]
+        #
+        # @see MetronomeSDK::Models::V1::BillableMetricArchiveParams
+        def archive(params)
+          parsed, options = MetronomeSDK::Models::V1::BillableMetricArchiveParams.dump_request(params)
+          @client.request(
+            method: :post,
+            path: "v1/billable-metrics/archive",
+            body: parsed,
+            model: MetronomeSDK::Models::V1::BillableMetricArchiveResponse,
+            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/contracts/named_schedules.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Contracts
+        class NamedSchedules
+          # Some parameter documentations has been truncated, see
+          # {MetronomeSDK::Models::V1::Contracts::NamedScheduleRetrieveParams} for more
+          # details.
+          #
+          # Get a named schedule for the given rate card. This endpoint's availability is
+          # dependent on your client's configuration.
+          #
+          # @overload retrieve(rate_card_id:, schedule_name:, covering_date: nil, request_options: {})
+          #
+          # @param rate_card_id [String] ID of the rate card 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::Contracts::NamedScheduleRetrieveResponse]
+          #
+          # @see MetronomeSDK::Models::V1::Contracts::NamedScheduleRetrieveParams
+          def retrieve(params)
+            parsed, options = MetronomeSDK::Models::V1::Contracts::NamedScheduleRetrieveParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "v1/contract-pricing/rate-cards/getNamedSchedule",
+              body: parsed,
+              model: MetronomeSDK::Models::V1::Contracts::NamedScheduleRetrieveResponse,
+              options: options
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {MetronomeSDK::Models::V1::Contracts::NamedScheduleUpdateParams} for more
+          # details.
+          #
+          # Update a named schedule for the given rate card. This endpoint's availability is
+          # dependent on your client's configuration.
+          #
+          # @overload update(rate_card_id:, schedule_name:, starting_at:, value:, ending_before: nil, request_options: {})
+          #
+          # @param rate_card_id [String] ID of the rate card 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::Contracts::NamedScheduleUpdateParams
+          def update(params)
+            parsed, options = MetronomeSDK::Models::V1::Contracts::NamedScheduleUpdateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "v1/contract-pricing/rate-cards/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

data/lib/metronome_sdk/resources/v1/contracts/products.rb

@@ -0,0 +1,212 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Contracts
+        class Products
+          # Some parameter documentations has been truncated, see
+          # {MetronomeSDK::Models::V1::Contracts::ProductCreateParams} for more details.
+          #
+          # Create a new product
+          #
+          # @overload create(name:, type:, billable_metric_id: nil, composite_product_ids: nil, composite_tags: nil, exclude_free_usage: nil, is_refundable: nil, netsuite_internal_item_id: nil, netsuite_overage_item_id: nil, presentation_group_key: nil, pricing_group_key: nil, quantity_conversion: nil, quantity_rounding: nil, tags: nil, request_options: {})
+          #
+          # @param name [String] displayed on invoices
+          #
+          # @param type [Symbol, MetronomeSDK::Models::V1::Contracts::ProductCreateParams::Type]
+          #
+          # @param billable_metric_id [String] Required for USAGE products
+          #
+          # @param composite_product_ids [Array<String>] Required for COMPOSITE products
+          #
+          # @param composite_tags [Array<String>] Required for COMPOSITE products
+          #
+          # @param exclude_free_usage [Boolean] Beta feature only available for composite products. If true, products with $0 wi
+          # ...
+          #
+          # @param is_refundable [Boolean] This field's availability is dependent on your client's configuration. Defaults
+          # ...
+          #
+          # @param netsuite_internal_item_id [String] This field's availability is dependent on your client's configuration.
+          #
+          # @param netsuite_overage_item_id [String] This field's availability is dependent on your client's configuration.
+          #
+          # @param presentation_group_key [Array<String>] For USAGE products only. Groups usage line items on invoices. The superset of va
+          # ...
+          #
+          # @param pricing_group_key [Array<String>] For USAGE products only. If set, pricing for this product will be determined for
+          # ...
+          #
+          # @param quantity_conversion [MetronomeSDK::Models::V1::Contracts::QuantityConversion, nil] Optional. Only valid for USAGE products. If provided, the quantity will be conve
+          # ...
+          #
+          # @param quantity_rounding [MetronomeSDK::Models::V1::Contracts::QuantityRounding, nil] Optional. Only valid for USAGE products. If provided, the quantity will be round
+          # ...
+          #
+          # @param tags [Array<String>]
+          #
+          # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [MetronomeSDK::Models::V1::Contracts::ProductCreateResponse]
+          #
+          # @see MetronomeSDK::Models::V1::Contracts::ProductCreateParams
+          def create(params)
+            parsed, options = MetronomeSDK::Models::V1::Contracts::ProductCreateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "v1/contract-pricing/products/create",
+              body: parsed,
+              model: MetronomeSDK::Models::V1::Contracts::ProductCreateResponse,
+              options: options
+            )
+          end
+
+          # Get a specific product
+          #
+          # @overload retrieve(id:, request_options: {})
+          #
+          # @param id [String]
+          # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [MetronomeSDK::Models::V1::Contracts::ProductRetrieveResponse]
+          #
+          # @see MetronomeSDK::Models::V1::Contracts::ProductRetrieveParams
+          def retrieve(params)
+            parsed, options = MetronomeSDK::Models::V1::Contracts::ProductRetrieveParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "v1/contract-pricing/products/get",
+              body: parsed,
+              model: MetronomeSDK::Models::V1::Contracts::ProductRetrieveResponse,
+              options: options
+            )
+          end
+
+          # Some parameter documentations has been truncated, see
+          # {MetronomeSDK::Models::V1::Contracts::ProductUpdateParams} for more details.
+          #
+          # Update a product
+          #
+          # @overload update(product_id:, starting_at:, billable_metric_id: nil, composite_product_ids: nil, composite_tags: nil, exclude_free_usage: nil, is_refundable: nil, name: nil, netsuite_internal_item_id: nil, netsuite_overage_item_id: nil, presentation_group_key: nil, pricing_group_key: nil, quantity_conversion: nil, quantity_rounding: nil, tags: nil, request_options: {})
+          #
+          # @param product_id [String] ID of the product to update
+          #
+          # @param starting_at [Time] Timestamp representing when the update should go into effect. It must be on an h
+          # ...
+          #
+          # @param billable_metric_id [String] Available for USAGE products only. If not provided, defaults to product's curren
+          # ...
+          #
+          # @param composite_product_ids [Array<String>] Available for COMPOSITE products only. If not provided, defaults to product's cu
+          # ...
+          #
+          # @param composite_tags [Array<String>] Available for COMPOSITE products only. If not provided, defaults to product's cu
+          # ...
+          #
+          # @param exclude_free_usage [Boolean] Beta feature only available for composite products. If true, products with $0 wi
+          # ...
+          #
+          # @param is_refundable [Boolean] Defaults to product's current refundability status. This field's availability is
+          # ...
+          #
+          # @param name [String] displayed on invoices. If not provided, defaults to product's current name.
+          #
+          # @param netsuite_internal_item_id [String] If not provided, defaults to product's current netsuite_internal_item_id. This f
+          # ...
+          #
+          # @param netsuite_overage_item_id [String] Available for USAGE and COMPOSITE products only. If not provided, defaults to pr
+          # ...
+          #
+          # @param presentation_group_key [Array<String>] For USAGE products only. Groups usage line items on invoices. The superset of va
+          # ...
+          #
+          # @param pricing_group_key [Array<String>] For USAGE products only. If set, pricing for this product will be determined for
+          # ...
+          #
+          # @param quantity_conversion [MetronomeSDK::Models::V1::Contracts::QuantityConversion, nil] Optional. Only valid for USAGE products. If provided, the quantity will be conve
+          # ...
+          #
+          # @param quantity_rounding [MetronomeSDK::Models::V1::Contracts::QuantityRounding, nil] Optional. Only valid for USAGE products. If provided, the quantity will be round
+          # ...
+          #
+          # @param tags [Array<String>] If not provided, defaults to product's current tags
+          #
+          # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [MetronomeSDK::Models::V1::Contracts::ProductUpdateResponse]
+          #
+          # @see MetronomeSDK::Models::V1::Contracts::ProductUpdateParams
+          def update(params)
+            parsed, options = MetronomeSDK::Models::V1::Contracts::ProductUpdateParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "v1/contract-pricing/products/update",
+              body: parsed,
+              model: MetronomeSDK::Models::V1::Contracts::ProductUpdateResponse,
+              options: options
+            )
+          end
+
+          # List products
+          #
+          # @overload list(limit: nil, next_page: nil, archive_filter: nil, request_options: {})
+          #
+          # @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 archive_filter [Symbol, MetronomeSDK::Models::V1::Contracts::ProductListParams::ArchiveFilter] Body param: Filter options for the product list
+          #
+          # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [MetronomeSDK::Internal::CursorPage<MetronomeSDK::Models::V1::Contracts::ProductListResponse>]
+          #
+          # @see MetronomeSDK::Models::V1::Contracts::ProductListParams
+          def list(params = {})
+            parsed, options = MetronomeSDK::Models::V1::Contracts::ProductListParams.dump_request(params)
+            query_params = [:limit, :next_page]
+            @client.request(
+              method: :post,
+              path: "v1/contract-pricing/products/list",
+              query: parsed.slice(*query_params),
+              body: parsed.except(*query_params),
+              page: MetronomeSDK::Internal::CursorPage,
+              model: MetronomeSDK::Models::V1::Contracts::ProductListResponse,
+              options: options
+            )
+          end
+
+          # Archive a product
+          #
+          # @overload archive(product_id:, request_options: {})
+          #
+          # @param product_id [String] ID of the product to be archived
+          #
+          # @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}, nil]
+          #
+          # @return [MetronomeSDK::Models::V1::Contracts::ProductArchiveResponse]
+          #
+          # @see MetronomeSDK::Models::V1::Contracts::ProductArchiveParams
+          def archive(params)
+            parsed, options = MetronomeSDK::Models::V1::Contracts::ProductArchiveParams.dump_request(params)
+            @client.request(
+              method: :post,
+              path: "v1/contract-pricing/products/archive",
+              body: parsed,
+              model: MetronomeSDK::Models::V1::Contracts::ProductArchiveResponse,
+              options: options
+            )
+          end
+
+          # @api private
+          #
+          # @param client [MetronomeSDK::Client]
+          def initialize(client:)
+            @client = client
+          end
+        end
+      end
+    end
+  end
+end