metronome-sdk 0.1.0.pre.alpha.1

data/rbi/metronome_sdk/request_options.rbi

@@ -0,0 +1,48 @@
+# typed: strong
+
+module MetronomeSDK
+  RequestOpts = T.type_alias { T.any(MetronomeSDK::RequestOptions, MetronomeSDK::Internal::AnyHash) }
+
+  # 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
+    sig { params(opts: T.any(T.self_type, T::Hash[Symbol, T.anything])).void }
+    def self.validate!(opts); end
+
+    # Idempotency key to send with request and all associated retries. Will only be
+    # sent for write requests.
+    sig { returns(T.nilable(String)) }
+    attr_accessor :idempotency_key
+
+    # Extra query params to send with the request. These are `.merge`’d into any
+    # `query` given at the client level.
+    sig { returns(T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])) }
+    attr_accessor :extra_query
+
+    # Extra headers to send with the request. These are `.merged`’d into any
+    # `extra_headers` given at the client level.
+    sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) }
+    attr_accessor :extra_headers
+
+    # Extra data to send with the request. These are deep merged into any data
+    # generated as part of the normal request.
+    sig { returns(T.nilable(T.anything)) }
+    attr_accessor :extra_body
+
+    # Maximum number of retries to attempt after a failed initial request.
+    sig { returns(T.nilable(Integer)) }
+    attr_accessor :max_retries
+
+    # Request timeout in seconds.
+    sig { returns(T.nilable(Float)) }
+    attr_accessor :timeout
+
+    # Returns a new instance of RequestOptions.
+    sig { params(values: MetronomeSDK::Internal::AnyHash).returns(T.attached_class) }
+    def self.new(values = {}); end
+  end
+end

data/rbi/metronome_sdk/resources/v1/alerts.rbi

@@ -0,0 +1,86 @@
+# typed: strong
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Alerts
+        # Create a new alert
+        sig do
+          params(
+            alert_type: MetronomeSDK::Models::V1::AlertCreateParams::AlertType::OrSymbol,
+            name: String,
+            threshold: Float,
+            billable_metric_id: String,
+            credit_grant_type_filters: T::Array[String],
+            credit_type_id: String,
+            custom_field_filters: T::Array[T.any(MetronomeSDK::Models::V1::AlertCreateParams::CustomFieldFilter, MetronomeSDK::Internal::AnyHash)],
+            customer_id: String,
+            evaluate_on_create: T::Boolean,
+            group_key_filter: T.any(MetronomeSDK::Models::V1::AlertCreateParams::GroupKeyFilter, MetronomeSDK::Internal::AnyHash),
+            invoice_types_filter: T::Array[String],
+            plan_id: String,
+            uniqueness_key: String,
+            request_options: MetronomeSDK::RequestOpts
+          )
+            .returns(MetronomeSDK::Models::V1::AlertCreateResponse)
+        end
+        def create(
+          # Type of the alert
+          alert_type:,
+          # Name of the alert
+          name:,
+          # Threshold value of the alert policy. Depending upon the alert type, this number
+          # may represent a financial amount, the days remaining, or a percentage reached.
+          threshold:,
+          # For alerts of type `usage_threshold_reached`, specifies which billable metric to
+          # track the usage for.
+          billable_metric_id: nil,
+          # An array of strings, representing a way to filter the credit grant this alert
+          # applies to, by looking at the credit_grant_type field on the credit grant. This
+          # field is only defined for CreditPercentage and CreditBalance alerts
+          credit_grant_type_filters: nil,
+          credit_type_id: nil,
+          # A list of custom field filters for alert types that support advanced filtering.
+          # Only present for contract invoices.
+          custom_field_filters: nil,
+          # If provided, will create this alert for this specific customer. To create an
+          # alert for all customers, do not specify `customer_id` or `plan_id`.
+          customer_id: nil,
+          # If true, the alert will evaluate immediately on customers that already meet the
+          # alert threshold. If false, it will only evaluate on future customers that
+          # trigger the alert threshold. Defaults to true.
+          evaluate_on_create: nil,
+          # Scopes alert evaluation to a specific presentation group key on individual line
+          # items. Only present for spend alerts.
+          group_key_filter: nil,
+          # Only supported for invoice_total_reached alerts. A list of invoice types to
+          # evaluate.
+          invoice_types_filter: nil,
+          # If provided, will create this alert for this specific plan. To create an alert
+          # for all customers, do not specify `customer_id` or `plan_id`.
+          plan_id: nil,
+          # Prevents the creation of duplicates. If a request to create a record is made
+          # with a previously used uniqueness key, a new record will not be created and the
+          # request will fail with a 409 error.
+          uniqueness_key: nil,
+          request_options: {}
+        ); end
+        # Archive an existing alert
+        sig do
+          params(id: String, release_uniqueness_key: T::Boolean, request_options: MetronomeSDK::RequestOpts)
+            .returns(MetronomeSDK::Models::V1::AlertArchiveResponse)
+        end
+        def archive(
+          # The Metronome ID of the alert
+          id:,
+          # If true, resets the uniqueness key on this alert so it can be re-used
+          release_uniqueness_key: nil,
+          request_options: {}
+        ); end
+        # @api private
+        sig { params(client: MetronomeSDK::Client).returns(T.attached_class) }
+        def self.new(client:); end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/resources/v1/audit_logs.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class AuditLogs
+        # 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.
+        sig do
+          params(
+            ending_before: Time,
+            limit: Integer,
+            next_page: String,
+            resource_id: String,
+            resource_type: String,
+            sort: MetronomeSDK::Models::V1::AuditLogListParams::Sort::OrSymbol,
+            starting_on: Time,
+            request_options: MetronomeSDK::RequestOpts
+          )
+            .returns(MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::AuditLogListResponse])
+        end
+        def list(
+          # RFC 3339 timestamp (exclusive). Cannot be used with 'next_page'.
+          ending_before: nil,
+          # Max number of results that should be returned
+          limit: nil,
+          # Cursor that indicates where the next page of results should start.
+          next_page: nil,
+          # Optional parameter that can be used to filter which audit logs are returned. If
+          # you specify resource_id, you must also specify resource_type.
+          resource_id: nil,
+          # Optional parameter that can be used to filter which audit logs are returned. If
+          # you specify resource_type, you must also specify resource_id.
+          resource_type: nil,
+          # Sort order by timestamp, e.g. date_asc or date_desc. Defaults to date_asc.
+          sort: nil,
+          # RFC 3339 timestamp of the earliest audit log to return. Cannot be used with
+          # 'next_page'.
+          starting_on: nil,
+          request_options: {}
+        ); end
+        # @api private
+        sig { params(client: MetronomeSDK::Client).returns(T.attached_class) }
+        def self.new(client:); end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/resources/v1/billable_metrics.rbi

@@ -0,0 +1,87 @@
+# typed: strong
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class BillableMetrics
+        # Creates a new Billable Metric.
+        sig do
+          params(
+            name: String,
+            aggregation_key: String,
+            aggregation_type: MetronomeSDK::Models::V1::BillableMetricCreateParams::AggregationType::OrSymbol,
+            custom_fields: T::Hash[Symbol, String],
+            event_type_filter: T.any(MetronomeSDK::Models::EventTypeFilter, MetronomeSDK::Internal::AnyHash),
+            group_keys: T::Array[T::Array[String]],
+            property_filters: T::Array[T.any(MetronomeSDK::Models::PropertyFilter, MetronomeSDK::Internal::AnyHash)],
+            sql: String,
+            request_options: MetronomeSDK::RequestOpts
+          )
+            .returns(MetronomeSDK::Models::V1::BillableMetricCreateResponse)
+        end
+        def create(
+          # The display name of the billable metric.
+          name:,
+          # Specifies the type of aggregation performed on matching events. Required if
+          # `sql` is not provided.
+          aggregation_key: nil,
+          # Specifies the type of aggregation performed on matching events.
+          aggregation_type: nil,
+          # Custom fields to attach to the billable metric.
+          custom_fields: nil,
+          # An optional filtering rule to match the 'event_type' property of an event.
+          event_type_filter: nil,
+          # Property names that are used to group usage costs on an invoice. Each entry
+          # represents a set of properties used to slice events into distinct buckets.
+          group_keys: nil,
+          # A list of filters to match events to this billable metric. Each filter defines a
+          # rule on an event property. All rules must pass for the event to match the
+          # billable metric.
+          property_filters: nil,
+          # The SQL query associated with the billable metric. This field is mutually
+          # exclusive with aggregation_type, event_type_filter, property_filters,
+          # aggregation_key, and group_keys. If provided, these other fields must be
+          # omitted.
+          sql: nil,
+          request_options: {}
+        ); end
+        # Get a billable metric.
+        sig do
+          params(billable_metric_id: String, request_options: MetronomeSDK::RequestOpts)
+            .returns(MetronomeSDK::Models::V1::BillableMetricRetrieveResponse)
+        end
+        def retrieve(billable_metric_id:, request_options: {}); end
+
+        # List all billable metrics.
+        sig do
+          params(
+            include_archived: T::Boolean,
+            limit: Integer,
+            next_page: String,
+            request_options: MetronomeSDK::RequestOpts
+          )
+            .returns(MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::BillableMetricListResponse])
+        end
+        def list(
+          # If true, the list of returned metrics will include archived metrics
+          include_archived: nil,
+          # Max number of results that should be returned
+          limit: nil,
+          # Cursor that indicates where the next page of results should start.
+          next_page: nil,
+          request_options: {}
+        ); end
+        # Archive an existing billable metric.
+        sig do
+          params(id: String, request_options: MetronomeSDK::RequestOpts)
+            .returns(MetronomeSDK::Models::V1::BillableMetricArchiveResponse)
+        end
+        def archive(id:, request_options: {}); end
+
+        # @api private
+        sig { params(client: MetronomeSDK::Client).returns(T.attached_class) }
+        def self.new(client:); end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/resources/v1/contracts/named_schedules.rbi

@@ -0,0 +1,61 @@
+# typed: strong
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Contracts
+        class NamedSchedules
+          # Get a named schedule for the given rate card. This endpoint's availability is
+          # dependent on your client's configuration.
+          sig do
+            params(
+              rate_card_id: String,
+              schedule_name: String,
+              covering_date: Time,
+              request_options: MetronomeSDK::RequestOpts
+            )
+              .returns(MetronomeSDK::Models::V1::Contracts::NamedScheduleRetrieveResponse)
+          end
+          def retrieve(
+            # ID of the rate card whose named schedule is to be retrieved
+            rate_card_id:,
+            # The identifier for the schedule to be retrieved
+            schedule_name:,
+            # If provided, at most one schedule segment will be returned (the one that covers
+            # this date). If not provided, all segments will be returned.
+            covering_date: nil,
+            request_options: {}
+          ); end
+          # Update a named schedule for the given rate card. This endpoint's availability is
+          # dependent on your client's configuration.
+          sig do
+            params(
+              rate_card_id: String,
+              schedule_name: String,
+              starting_at: Time,
+              value: T.anything,
+              ending_before: Time,
+              request_options: MetronomeSDK::RequestOpts
+            )
+              .void
+          end
+          def update(
+            # ID of the rate card whose named schedule is to be updated
+            rate_card_id:,
+            # The identifier for the schedule to be updated
+            schedule_name:,
+            starting_at:,
+            # The value to set for the named schedule. The structure of this object is
+            # specific to the named schedule.
+            value:,
+            ending_before: nil,
+            request_options: {}
+          ); end
+          # @api private
+          sig { params(client: MetronomeSDK::Client).returns(T.attached_class) }
+          def self.new(client:); end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/resources/v1/contracts/products.rbi

@@ -0,0 +1,195 @@
+# typed: strong
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Contracts
+        class Products
+          # Create a new product
+          sig do
+            params(
+              name: String,
+              type: MetronomeSDK::Models::V1::Contracts::ProductCreateParams::Type::OrSymbol,
+              billable_metric_id: String,
+              composite_product_ids: T::Array[String],
+              composite_tags: T::Array[String],
+              exclude_free_usage: T::Boolean,
+              is_refundable: T::Boolean,
+              netsuite_internal_item_id: String,
+              netsuite_overage_item_id: String,
+              presentation_group_key: T::Array[String],
+              pricing_group_key: T::Array[String],
+              quantity_conversion: T.nilable(T.any(MetronomeSDK::Models::V1::Contracts::QuantityConversion, MetronomeSDK::Internal::AnyHash)),
+              quantity_rounding: T.nilable(T.any(MetronomeSDK::Models::V1::Contracts::QuantityRounding, MetronomeSDK::Internal::AnyHash)),
+              tags: T::Array[String],
+              request_options: MetronomeSDK::RequestOpts
+            )
+              .returns(MetronomeSDK::Models::V1::Contracts::ProductCreateResponse)
+          end
+          def create(
+            # displayed on invoices
+            name:,
+            type:,
+            # Required for USAGE products
+            billable_metric_id: nil,
+            # Required for COMPOSITE products
+            composite_product_ids: nil,
+            # Required for COMPOSITE products
+            composite_tags: nil,
+            # Beta feature only available for composite products. If true, products with $0
+            # will not be included when computing composite usage. Defaults to false
+            exclude_free_usage: nil,
+            # This field's availability is dependent on your client's configuration. Defaults
+            # to true.
+            is_refundable: nil,
+            # This field's availability is dependent on your client's configuration.
+            netsuite_internal_item_id: nil,
+            # This field's availability is dependent on your client's configuration.
+            netsuite_overage_item_id: nil,
+            # For USAGE products only. Groups usage line items on invoices. The superset of
+            # values in the pricing group key and presentation group key must be set as one
+            # compound group key on the billable metric.
+            presentation_group_key: nil,
+            # For USAGE products only. If set, pricing for this product will be determined for
+            # each pricing_group_key value, as opposed to the product as a whole. The superset
+            # of values in the pricing group key and presentation group key must be set as one
+            # compound group key on the billable metric.
+            pricing_group_key: nil,
+            # Optional. Only valid for USAGE products. If provided, the quantity will be
+            # converted using the provided conversion factor and operation. For example, if
+            # the operation is "multiply" and the conversion factor is 100, then the quantity
+            # will be multiplied by 100. This can be used in cases where data is sent in one
+            # unit and priced in another. For example, data could be sent in MB and priced in
+            # GB. In this case, the conversion factor would be 1024 and the operation would be
+            # "divide".
+            quantity_conversion: nil,
+            # Optional. Only valid for USAGE products. If provided, the quantity will be
+            # rounded using the provided rounding method and decimal places. For example, if
+            # the method is "round up" and the decimal places is 0, then the quantity will be
+            # rounded up to the nearest integer.
+            quantity_rounding: nil,
+            tags: nil,
+            request_options: {}
+          ); end
+          # Get a specific product
+          sig do
+            params(id: String, request_options: MetronomeSDK::RequestOpts)
+              .returns(MetronomeSDK::Models::V1::Contracts::ProductRetrieveResponse)
+          end
+          def retrieve(id:, request_options: {}); end
+
+          # Update a product
+          sig do
+            params(
+              product_id: String,
+              starting_at: Time,
+              billable_metric_id: String,
+              composite_product_ids: T::Array[String],
+              composite_tags: T::Array[String],
+              exclude_free_usage: T::Boolean,
+              is_refundable: T::Boolean,
+              name: String,
+              netsuite_internal_item_id: String,
+              netsuite_overage_item_id: String,
+              presentation_group_key: T::Array[String],
+              pricing_group_key: T::Array[String],
+              quantity_conversion: T.nilable(T.any(MetronomeSDK::Models::V1::Contracts::QuantityConversion, MetronomeSDK::Internal::AnyHash)),
+              quantity_rounding: T.nilable(T.any(MetronomeSDK::Models::V1::Contracts::QuantityRounding, MetronomeSDK::Internal::AnyHash)),
+              tags: T::Array[String],
+              request_options: MetronomeSDK::RequestOpts
+            )
+              .returns(MetronomeSDK::Models::V1::Contracts::ProductUpdateResponse)
+          end
+          def update(
+            # ID of the product to update
+            product_id:,
+            # Timestamp representing when the update should go into effect. It must be on an
+            # hour boundary (e.g. 1:00, not 1:30).
+            starting_at:,
+            # Available for USAGE products only. If not provided, defaults to product's
+            # current billable metric.
+            billable_metric_id: nil,
+            # Available for COMPOSITE products only. If not provided, defaults to product's
+            # current composite_product_ids.
+            composite_product_ids: nil,
+            # Available for COMPOSITE products only. If not provided, defaults to product's
+            # current composite_tags.
+            composite_tags: nil,
+            # Beta feature only available for composite products. If true, products with $0
+            # will not be included when computing composite usage. Defaults to false
+            exclude_free_usage: nil,
+            # Defaults to product's current refundability status. This field's availability is
+            # dependent on your client's configuration.
+            is_refundable: nil,
+            # displayed on invoices. If not provided, defaults to product's current name.
+            name: nil,
+            # If not provided, defaults to product's current netsuite_internal_item_id. This
+            # field's availability is dependent on your client's configuration.
+            netsuite_internal_item_id: nil,
+            # Available for USAGE and COMPOSITE products only. If not provided, defaults to
+            # product's current netsuite_overage_item_id. This field's availability is
+            # dependent on your client's configuration.
+            netsuite_overage_item_id: nil,
+            # For USAGE products only. Groups usage line items on invoices. The superset of
+            # values in the pricing group key and presentation group key must be set as one
+            # compound group key on the billable metric.
+            presentation_group_key: nil,
+            # For USAGE products only. If set, pricing for this product will be determined for
+            # each pricing_group_key value, as opposed to the product as a whole. The superset
+            # of values in the pricing group key and presentation group key must be set as one
+            # compound group key on the billable metric.
+            pricing_group_key: nil,
+            # Optional. Only valid for USAGE products. If provided, the quantity will be
+            # converted using the provided conversion factor and operation. For example, if
+            # the operation is "multiply" and the conversion factor is 100, then the quantity
+            # will be multiplied by 100. This can be used in cases where data is sent in one
+            # unit and priced in another. For example, data could be sent in MB and priced in
+            # GB. In this case, the conversion factor would be 1024 and the operation would be
+            # "divide".
+            quantity_conversion: nil,
+            # Optional. Only valid for USAGE products. If provided, the quantity will be
+            # rounded using the provided rounding method and decimal places. For example, if
+            # the method is "round up" and the decimal places is 0, then the quantity will be
+            # rounded up to the nearest integer.
+            quantity_rounding: nil,
+            # If not provided, defaults to product's current tags
+            tags: nil,
+            request_options: {}
+          ); end
+          # List products
+          sig do
+            params(
+              limit: Integer,
+              next_page: String,
+              archive_filter: MetronomeSDK::Models::V1::Contracts::ProductListParams::ArchiveFilter::OrSymbol,
+              request_options: MetronomeSDK::RequestOpts
+            )
+              .returns(MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::Contracts::ProductListResponse])
+          end
+          def list(
+            # Query param: Max number of results that should be returned
+            limit: nil,
+            # Query param: Cursor that indicates where the next page of results should start.
+            next_page: nil,
+            # Body param: Filter options for the product list
+            archive_filter: nil,
+            request_options: {}
+          ); end
+          # Archive a product
+          sig do
+            params(product_id: String, request_options: MetronomeSDK::RequestOpts)
+              .returns(MetronomeSDK::Models::V1::Contracts::ProductArchiveResponse)
+          end
+          def archive(
+            # ID of the product to be archived
+            product_id:,
+            request_options: {}
+          ); end
+          # @api private
+          sig { params(client: MetronomeSDK::Client).returns(T.attached_class) }
+          def self.new(client:); end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/named_schedules.rbi

@@ -0,0 +1,69 @@
+# typed: strong
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Contracts
+        class RateCards
+          class NamedSchedules
+            # Get a named schedule for the given contract. This endpoint's availability is
+            # dependent on your client's configuration.
+            sig do
+              params(
+                contract_id: String,
+                customer_id: String,
+                schedule_name: String,
+                covering_date: Time,
+                request_options: MetronomeSDK::RequestOpts
+              )
+                .returns(MetronomeSDK::Models::V1::Contracts::RateCards::NamedScheduleRetrieveResponse)
+            end
+            def retrieve(
+              # ID of the contract whose named schedule is to be retrieved
+              contract_id:,
+              # ID of the customer whose named schedule is to be retrieved
+              customer_id:,
+              # The identifier for the schedule to be retrieved
+              schedule_name:,
+              # If provided, at most one schedule segment will be returned (the one that covers
+              # this date). If not provided, all segments will be returned.
+              covering_date: nil,
+              request_options: {}
+            ); end
+            # Update a named schedule for the given contract. This endpoint's availability is
+            # dependent on your client's configuration.
+            sig do
+              params(
+                contract_id: String,
+                customer_id: String,
+                schedule_name: String,
+                starting_at: Time,
+                value: T.anything,
+                ending_before: Time,
+                request_options: MetronomeSDK::RequestOpts
+              )
+                .void
+            end
+            def update(
+              # ID of the contract whose named schedule is to be updated
+              contract_id:,
+              # ID of the customer whose named schedule is to be updated
+              customer_id:,
+              # The identifier for the schedule to be updated
+              schedule_name:,
+              starting_at:,
+              # The value to set for the named schedule. The structure of this object is
+              # specific to the named schedule.
+              value:,
+              ending_before: nil,
+              request_options: {}
+            ); end
+            # @api private
+            sig { params(client: MetronomeSDK::Client).returns(T.attached_class) }
+            def self.new(client:); end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/resources/v1/contracts/rate_cards/product_orders.rbi

@@ -0,0 +1,52 @@
+# typed: strong
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Contracts
+        class RateCards
+          class ProductOrders
+            # Updates ordering of specified products
+            sig do
+              params(
+                product_moves: T::Array[
+                  T.any(
+                    MetronomeSDK::Models::V1::Contracts::RateCards::ProductOrderUpdateParams::ProductMove,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                ],
+                rate_card_id: String,
+                request_options: MetronomeSDK::RequestOpts
+              )
+                .returns(MetronomeSDK::Models::V1::Contracts::RateCards::ProductOrderUpdateResponse)
+            end
+            def update(
+              product_moves:,
+              # ID of the rate card to update
+              rate_card_id:,
+              request_options: {}
+            ); end
+            # Sets the ordering of products within a rate card
+            sig do
+              params(
+                product_order: T::Array[String],
+                rate_card_id: String,
+                request_options: MetronomeSDK::RequestOpts
+              )
+                .returns(MetronomeSDK::Models::V1::Contracts::RateCards::ProductOrderSetResponse)
+            end
+            def set(
+              product_order:,
+              # ID of the rate card to update
+              rate_card_id:,
+              request_options: {}
+            ); end
+            # @api private
+            sig { params(client: MetronomeSDK::Client).returns(T.attached_class) }
+            def self.new(client:); end
+          end
+        end
+      end
+    end
+  end
+end