metronome-sdk 0.1.0.pre.alpha.1

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

@@ -0,0 +1,61 @@
+# typed: strong
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Customers
+        class NamedSchedules
+          # Get a named schedule for the given customer. This endpoint's availability is
+          # dependent on your client's configuration.
+          sig do
+            params(
+              customer_id: String,
+              schedule_name: String,
+              covering_date: Time,
+              request_options: MetronomeSDK::RequestOpts
+            )
+              .returns(MetronomeSDK::Models::V1::Customers::NamedScheduleRetrieveResponse)
+          end
+          def retrieve(
+            # 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 customer. This endpoint's availability is
+          # dependent on your client's configuration.
+          sig do
+            params(
+              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 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

data/rbi/metronome_sdk/resources/v1/customers/plans.rbi

@@ -0,0 +1,146 @@
+# typed: strong
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Customers
+        class Plans
+          # List the given customer's plans in reverse-chronological order.
+          sig do
+            params(
+              customer_id: String,
+              limit: Integer,
+              next_page: String,
+              request_options: MetronomeSDK::RequestOpts
+            )
+              .returns(MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::Customers::PlanListResponse])
+          end
+          def list(
+            # Path param:
+            customer_id:,
+            # 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,
+            request_options: {}
+          ); end
+          # 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.
+          sig do
+            params(
+              customer_id: String,
+              plan_id: String,
+              starting_on: Time,
+              ending_before: Time,
+              net_payment_terms_days: Float,
+              overage_rate_adjustments: T::Array[
+                T.any(
+                  MetronomeSDK::Models::V1::Customers::PlanAddParams::OverageRateAdjustment,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              ],
+              price_adjustments: T::Array[
+                T.any(
+                  MetronomeSDK::Models::V1::Customers::PlanAddParams::PriceAdjustment,
+                  MetronomeSDK::Internal::AnyHash
+                )
+              ],
+              trial_spec: T.any(MetronomeSDK::Models::V1::Customers::PlanAddParams::TrialSpec, MetronomeSDK::Internal::AnyHash),
+              request_options: MetronomeSDK::RequestOpts
+            )
+              .returns(MetronomeSDK::Models::V1::Customers::PlanAddResponse)
+          end
+          def add(
+            # Path param:
+            customer_id:,
+            # Body param:
+            plan_id:,
+            # Body param: RFC 3339 timestamp for when the plan becomes active for this
+            # customer. Must be at 0:00 UTC (midnight).
+            starting_on:,
+            # Body param: RFC 3339 timestamp for when the plan ends (exclusive) for this
+            # customer. Must be at 0:00 UTC (midnight).
+            ending_before: nil,
+            # Body param: Number of days after issuance of invoice after which the invoice is
+            # due (e.g. Net 30).
+            net_payment_terms_days: nil,
+            # Body param: An optional list of overage rates that override the rates of the
+            # original plan configuration. These new rates will apply to all pricing ramps.
+            overage_rate_adjustments: nil,
+            # Body param: A list of price adjustments can be applied on top of the pricing in
+            # the plans. See the
+            # [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments)
+            # for details.
+            price_adjustments: nil,
+            # Body param: A custom trial can be set for the customer's plan. See the
+            # [trial configuration documentation](https://docs.metronome.com/provisioning/configure-trials/)
+            # for details.
+            trial_spec: nil,
+            request_options: {}
+          ); end
+          # Change the end date of a customer's plan.
+          sig do
+            params(
+              customer_id: String,
+              customer_plan_id: String,
+              ending_before: Time,
+              void_invoices: T::Boolean,
+              void_stripe_invoices: T::Boolean,
+              request_options: MetronomeSDK::RequestOpts
+            )
+              .returns(MetronomeSDK::Models::V1::Customers::PlanEndResponse)
+          end
+          def end_(
+            # Path param:
+            customer_id:,
+            # Path param: the ID of a customer-plan relationship
+            customer_plan_id:,
+            # Body param: RFC 3339 timestamp for when the plan ends (exclusive) for this
+            # customer. Must be at 0:00 UTC (midnight). If not provided, the plan end date
+            # will be cleared.
+            ending_before: nil,
+            # Body param: If true, plan end date can be before the last finalized invoice
+            # date. Any invoices generated after the plan end date will be voided.
+            void_invoices: nil,
+            # Body param: Only applicable when void_invoices is set to true. If true, for
+            # every invoice that is voided we will also attempt to void/delete the stripe
+            # invoice (if any). Stripe invoices will be voided if finalized or deleted if
+            # still in draft state.
+            void_stripe_invoices: nil,
+            request_options: {}
+          ); end
+          # Lists a customer plans adjustments. See the
+          # [price adjustments documentation](https://plans-docs.metronome.com/pricing/managing-plans/#price-adjustments)
+          # for details.
+          sig do
+            params(
+              customer_id: String,
+              customer_plan_id: String,
+              limit: Integer,
+              next_page: String,
+              request_options: MetronomeSDK::RequestOpts
+            )
+              .returns(
+                MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::Customers::PlanListPriceAdjustmentsResponse]
+              )
+          end
+          def list_price_adjustments(
+            # Path param:
+            customer_id:,
+            # Path param: the ID of a customer-plan relationship
+            customer_plan_id:,
+            # 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,
+            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/customers.rbi

@@ -0,0 +1,213 @@
+# typed: strong
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Customers
+        sig { returns(MetronomeSDK::Resources::V1::Customers::Alerts) }
+        attr_reader :alerts
+
+        sig { returns(MetronomeSDK::Resources::V1::Customers::Plans) }
+        attr_reader :plans
+
+        sig { returns(MetronomeSDK::Resources::V1::Customers::Invoices) }
+        attr_reader :invoices
+
+        sig { returns(MetronomeSDK::Resources::V1::Customers::BillingConfig) }
+        attr_reader :billing_config
+
+        sig { returns(MetronomeSDK::Resources::V1::Customers::Commits) }
+        attr_reader :commits
+
+        sig { returns(MetronomeSDK::Resources::V1::Customers::Credits) }
+        attr_reader :credits
+
+        sig { returns(MetronomeSDK::Resources::V1::Customers::NamedSchedules) }
+        attr_reader :named_schedules
+
+        # Create a new customer
+        sig do
+          params(
+            name: String,
+            billing_config: T.any(MetronomeSDK::Models::V1::CustomerCreateParams::BillingConfig, MetronomeSDK::Internal::AnyHash),
+            custom_fields: T::Hash[Symbol, String],
+            customer_billing_provider_configurations: T::Array[
+              T.any(
+                MetronomeSDK::Models::V1::CustomerCreateParams::CustomerBillingProviderConfiguration,
+                MetronomeSDK::Internal::AnyHash
+              )
+            ],
+            external_id: String,
+            ingest_aliases: T::Array[String],
+            request_options: MetronomeSDK::RequestOpts
+          )
+            .returns(MetronomeSDK::Models::V1::CustomerCreateResponse)
+        end
+        def create(
+          # This will be truncated to 160 characters if the provided name is longer.
+          name:,
+          billing_config: nil,
+          custom_fields: nil,
+          customer_billing_provider_configurations: nil,
+          # (deprecated, use ingest_aliases instead) an alias that can be used to refer to
+          # this customer in usage events
+          external_id: nil,
+          # Aliases that can be used to refer to this customer in usage events
+          ingest_aliases: nil,
+          request_options: {}
+        ); end
+        # Get a customer by Metronome ID.
+        sig do
+          params(customer_id: String, request_options: MetronomeSDK::RequestOpts)
+            .returns(MetronomeSDK::Models::V1::CustomerRetrieveResponse)
+        end
+        def retrieve(customer_id:, request_options: {}); end
+
+        # List all customers.
+        sig do
+          params(
+            customer_ids: T::Array[String],
+            ingest_alias: String,
+            limit: Integer,
+            next_page: String,
+            only_archived: T::Boolean,
+            salesforce_account_ids: T::Array[String],
+            request_options: MetronomeSDK::RequestOpts
+          )
+            .returns(MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::CustomerDetail])
+        end
+        def list(
+          # Filter the customer list by customer_id. Up to 100 ids can be provided.
+          customer_ids: nil,
+          # Filter the customer list by ingest_alias
+          ingest_alias: 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,
+          # Filter the customer list to only return archived customers. By default, only
+          # active customers are returned.
+          only_archived: nil,
+          # Filter the customer list by salesforce_account_id. Up to 100 ids can be
+          # provided.
+          salesforce_account_ids: nil,
+          request_options: {}
+        ); end
+        # Archive a customer
+        sig do
+          params(id: String, request_options: MetronomeSDK::RequestOpts)
+            .returns(MetronomeSDK::Models::V1::CustomerArchiveResponse)
+        end
+        def archive(id:, request_options: {}); end
+
+        # Get all billable metrics for a given customer.
+        sig do
+          params(
+            customer_id: String,
+            include_archived: T::Boolean,
+            limit: Integer,
+            next_page: String,
+            on_current_plan: T::Boolean,
+            request_options: MetronomeSDK::RequestOpts
+          )
+            .returns(MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::CustomerListBillableMetricsResponse])
+        end
+        def list_billable_metrics(
+          # Path param:
+          customer_id:,
+          # Query param: If true, the list of returned metrics will include archived metrics
+          include_archived: nil,
+          # 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,
+          # Query param: If true, the list of metrics will be filtered to just ones that are
+          # on the customer's current plan
+          on_current_plan: nil,
+          request_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.
+        sig do
+          params(
+            customer_id: String,
+            ending_before: Time,
+            starting_on: Time,
+            limit: Integer,
+            next_page: String,
+            request_options: MetronomeSDK::RequestOpts
+          )
+            .returns(MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::CustomerListCostsResponse])
+        end
+        def list_costs(
+          # Path param:
+          customer_id:,
+          # Query param: RFC 3339 timestamp (exclusive)
+          ending_before:,
+          # Query param: RFC 3339 timestamp (inclusive)
+          starting_on:,
+          # 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,
+          request_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.
+        sig do
+          params(
+            customer_id: String,
+            ingest_aliases: T::Array[String],
+            request_options: MetronomeSDK::RequestOpts
+          )
+            .void
+        end
+        def set_ingest_aliases(
+          # Path param:
+          customer_id:,
+          # Body param:
+          ingest_aliases:,
+          request_options: {}
+        ); end
+        # Updates the specified customer's name.
+        sig do
+          params(customer_id: String, name: String, request_options: MetronomeSDK::RequestOpts)
+            .returns(MetronomeSDK::Models::V1::CustomerSetNameResponse)
+        end
+        def set_name(
+          # Path param:
+          customer_id:,
+          # Body param: The new name for the customer. This will be truncated to 160
+          # characters if the provided name is longer.
+          name:,
+          request_options: {}
+        ); end
+        # Updates the specified customer's config.
+        sig do
+          params(
+            customer_id: String,
+            leave_stripe_invoices_in_draft: T.nilable(T::Boolean),
+            salesforce_account_id: T.nilable(String),
+            request_options: MetronomeSDK::RequestOpts
+          )
+            .void
+        end
+        def update_config(
+          # Path param:
+          customer_id:,
+          # Body param: Leave in draft or set to auto-advance on invoices sent to Stripe.
+          # Falls back to the client-level config if unset, which defaults to true if unset.
+          leave_stripe_invoices_in_draft: nil,
+          # Body param: The Salesforce account ID for the customer
+          salesforce_account_id: 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/dashboards.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+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.
+        sig do
+          params(
+            customer_id: String,
+            dashboard: MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::Dashboard::OrSymbol,
+            bm_group_key_overrides: T::Array[
+              T.any(
+                MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::BmGroupKeyOverride,
+                MetronomeSDK::Internal::AnyHash
+              )
+            ],
+            color_overrides: T::Array[
+              T.any(
+                MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::ColorOverride,
+                MetronomeSDK::Internal::AnyHash
+              )
+            ],
+            dashboard_options: T::Array[
+              T.any(
+                MetronomeSDK::Models::V1::DashboardGetEmbeddableURLParams::DashboardOption,
+                MetronomeSDK::Internal::AnyHash
+              )
+            ],
+            request_options: MetronomeSDK::RequestOpts
+          )
+            .returns(MetronomeSDK::Models::V1::DashboardGetEmbeddableURLResponse)
+        end
+        def get_embeddable_url(
+          customer_id:,
+          # The type of dashboard to retrieve.
+          dashboard:,
+          # Optional list of billable metric group key overrides
+          bm_group_key_overrides: nil,
+          # Optional list of colors to override
+          color_overrides: nil,
+          # Optional dashboard specific options
+          dashboard_options: 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/invoices.rbi

@@ -0,0 +1,33 @@
+# typed: strong
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Invoices
+        # Regenerate a voided contract invoice
+        sig do
+          params(id: String, request_options: MetronomeSDK::RequestOpts)
+            .returns(MetronomeSDK::Models::V1::InvoiceRegenerateResponse)
+        end
+        def regenerate(
+          # The invoice id to regenerate
+          id:,
+          request_options: {}
+        ); end
+        # Void an invoice
+        sig do
+          params(id: String, request_options: MetronomeSDK::RequestOpts)
+            .returns(MetronomeSDK::Models::V1::InvoiceVoidResponse)
+        end
+        def void(
+          # The invoice id to void
+          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/plans.rbi

@@ -0,0 +1,82 @@
+# typed: strong
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Plans
+        # List all available plans.
+        sig do
+          params(limit: Integer, next_page: String, request_options: MetronomeSDK::RequestOpts)
+            .returns(MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::PlanListResponse])
+        end
+        def list(
+          # 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
+        # Fetch high level details of a specific plan.
+        sig do
+          params(plan_id: String, request_options: MetronomeSDK::RequestOpts)
+            .returns(MetronomeSDK::Models::V1::PlanGetDetailsResponse)
+        end
+        def get_details(plan_id:, request_options: {}); end
+
+        # Fetches a list of charges of a specific plan.
+        sig do
+          params(
+            plan_id: String,
+            limit: Integer,
+            next_page: String,
+            request_options: MetronomeSDK::RequestOpts
+          )
+            .returns(MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::PlanListChargesResponse])
+        end
+        def list_charges(
+          # Path param:
+          plan_id:,
+          # 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,
+          request_options: {}
+        ); end
+        # Fetches a list of customers on a specific plan (by default, only currently
+        # active plans are included)
+        sig do
+          params(
+            plan_id: String,
+            limit: Integer,
+            next_page: String,
+            status: MetronomeSDK::Models::V1::PlanListCustomersParams::Status::OrSymbol,
+            request_options: MetronomeSDK::RequestOpts
+          )
+            .returns(MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::PlanListCustomersResponse])
+        end
+        def list_customers(
+          # Path param:
+          plan_id:,
+          # 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,
+          # Query param: Status of customers on a given plan. Defaults to `active`.
+          #
+          # - `all` - Return current, past, and upcoming customers of the plan.
+          # - `active` - Return current customers of the plan.
+          # - `ended` - Return past customers of the plan.
+          # - `upcoming` - Return upcoming customers of the plan.
+          #
+          # Multiple statuses can be OR'd together using commas, e.g. `active,ended`.
+          # **Note:** `ended,upcoming` combination is not yet supported.
+          status: 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/pricing_units.rbi

@@ -0,0 +1,25 @@
+# typed: strong
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class PricingUnits
+        # List all pricing units (known in the API by the legacy term "credit types").
+        sig do
+          params(limit: Integer, next_page: String, request_options: MetronomeSDK::RequestOpts)
+            .returns(MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::PricingUnitListResponse])
+        end
+        def list(
+          # 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
+        # @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/services.rbi

@@ -0,0 +1,20 @@
+# typed: strong
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Services
+        # Fetches a list of services used by Metronome and the associated IP addresses. IP
+        # addresses are not necessarily unique between services. In most cases, IP
+        # addresses will appear in the list at least 30 days before they are used for the
+        # first time.
+        sig { params(request_options: MetronomeSDK::RequestOpts).returns(MetronomeSDK::Models::V1::ServiceListResponse) }
+        def list(request_options: {}); end
+
+        # @api private
+        sig { params(client: MetronomeSDK::Client).returns(T.attached_class) }
+        def self.new(client:); end
+      end
+    end
+  end
+end