metronome-sdk 0.1.0.pre.alpha.1

data/rbi/metronome_sdk/resources/v1/custom_fields.rbi

@@ -0,0 +1,83 @@
+# typed: strong
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class CustomFields
+        # Add a key to the allow list for a given entity. There is a 100 character limit
+        # on custom field keys.
+        sig do
+          params(
+            enforce_uniqueness: T::Boolean,
+            entity: MetronomeSDK::Models::V1::CustomFieldAddKeyParams::Entity::OrSymbol,
+            key: String,
+            request_options: MetronomeSDK::RequestOpts
+          )
+            .void
+        end
+        def add_key(enforce_uniqueness:, entity:, key:, request_options: {}); end
+
+        # Deletes one or more custom fields on an instance of a Metronome entity.
+        sig do
+          params(
+            entity: MetronomeSDK::Models::V1::CustomFieldDeleteValuesParams::Entity::OrSymbol,
+            entity_id: String,
+            keys: T::Array[String],
+            request_options: MetronomeSDK::RequestOpts
+          )
+            .void
+        end
+        def delete_values(entity:, entity_id:, keys:, request_options: {}); end
+
+        # List all active custom field keys, optionally filtered by entity type.
+        sig do
+          params(
+            next_page: String,
+            entities: T::Array[MetronomeSDK::Models::V1::CustomFieldListKeysParams::Entity::OrSymbol],
+            request_options: MetronomeSDK::RequestOpts
+          )
+            .returns(MetronomeSDK::Models::V1::CustomFieldListKeysResponse)
+        end
+        def list_keys(
+          # Query param: Cursor that indicates where the next page of results should start.
+          next_page: nil,
+          # Body param: Optional list of entity types to return keys for
+          entities: nil,
+          request_options: {}
+        ); end
+        # Remove a key from the allow list for a given entity.
+        sig do
+          params(
+            entity: MetronomeSDK::Models::V1::CustomFieldRemoveKeyParams::Entity::OrSymbol,
+            key: String,
+            request_options: MetronomeSDK::RequestOpts
+          )
+            .void
+        end
+        def remove_key(entity:, key:, request_options: {}); end
+
+        # Sets one or more custom fields on an instance of a Metronome entity. If a
+        # key/value pair passed in this request matches one already set on the entity, its
+        # value will be overwritten. Any key/value pairs that exist on the entity that do
+        # not match those passed in this request will remain untouched. This endpoint is
+        # transactional and will update all key/value pairs or no key/value pairs. Partial
+        # updates are not supported. There is a 200 character limit on custom field
+        # values.
+        sig do
+          params(
+            custom_fields: T::Hash[Symbol, String],
+            entity: MetronomeSDK::Models::V1::CustomFieldSetValuesParams::Entity::OrSymbol,
+            entity_id: String,
+            request_options: MetronomeSDK::RequestOpts
+          )
+            .void
+        end
+        def set_values(custom_fields:, entity:, entity_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/customers/alerts.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Customers
+        class Alerts
+          # Get the customer alert status and alert information for the specified customer
+          # and alert
+          sig do
+            params(alert_id: String, customer_id: String, request_options: MetronomeSDK::RequestOpts)
+              .returns(MetronomeSDK::Models::V1::Customers::AlertRetrieveResponse)
+          end
+          def retrieve(
+            # The Metronome ID of the alert
+            alert_id:,
+            # The Metronome ID of the customer
+            customer_id:,
+            request_options: {}
+          ); end
+          # Fetch all customer alert statuses and alert information for a customer
+          sig do
+            params(
+              customer_id: String,
+              next_page: String,
+              alert_statuses: T::Array[MetronomeSDK::Models::V1::Customers::AlertListParams::AlertStatus::OrSymbol],
+              request_options: MetronomeSDK::RequestOpts
+            )
+              .returns(MetronomeSDK::Models::V1::Customers::AlertListResponse)
+          end
+          def list(
+            # Body param: The Metronome ID of the customer
+            customer_id:,
+            # Query param: Cursor that indicates where the next page of results should start.
+            next_page: nil,
+            # Body param: Optionally filter by alert status. If absent, only enabled alerts
+            # will be returned.
+            alert_statuses: nil,
+            request_options: {}
+          ); end
+          # Reset state for an alert by customer id and force re-evaluation
+          sig do
+            params(alert_id: String, customer_id: String, request_options: MetronomeSDK::RequestOpts).void
+          end
+          def reset(
+            # The Metronome ID of the alert
+            alert_id:,
+            # The Metronome ID of the customer
+            customer_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/customers/billing_config.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Customers
+        class BillingConfig
+          # Set the billing configuration for a given customer.
+          sig do
+            params(
+              customer_id: String,
+              billing_provider_type: MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams::BillingProviderType::OrSymbol,
+              billing_provider_customer_id: String,
+              aws_product_code: String,
+              aws_region: MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams::AwsRegion::OrSymbol,
+              stripe_collection_method: MetronomeSDK::Models::V1::Customers::BillingConfigCreateParams::StripeCollectionMethod::OrSymbol,
+              request_options: MetronomeSDK::RequestOpts
+            )
+              .void
+          end
+          def create(
+            # Path param:
+            customer_id:,
+            # Path param: The billing provider (e.g. stripe)
+            billing_provider_type:,
+            # Body param: The customer ID in the billing provider's system. For Azure, this is
+            # the subscription ID.
+            billing_provider_customer_id:,
+            # Body param:
+            aws_product_code: nil,
+            # Body param:
+            aws_region: nil,
+            # Body param:
+            stripe_collection_method: nil,
+            request_options: {}
+          ); end
+          # Fetch the billing configuration for the given customer.
+          sig do
+            params(
+              customer_id: String,
+              billing_provider_type: MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveParams::BillingProviderType::OrSymbol,
+              request_options: MetronomeSDK::RequestOpts
+            )
+              .returns(MetronomeSDK::Models::V1::Customers::BillingConfigRetrieveResponse)
+          end
+          def retrieve(
+            customer_id:,
+            # The billing provider (e.g. stripe)
+            billing_provider_type:,
+            request_options: {}
+          ); end
+          # Delete the billing configuration for a given customer. Note: this is unsupported
+          # for Azure and AWS Marketplace customers.
+          sig do
+            params(
+              customer_id: String,
+              billing_provider_type: MetronomeSDK::Models::V1::Customers::BillingConfigDeleteParams::BillingProviderType::OrSymbol,
+              request_options: MetronomeSDK::RequestOpts
+            )
+              .void
+          end
+          def delete(
+            customer_id:,
+            # The billing provider (e.g. stripe)
+            billing_provider_type:,
+            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/commits.rbi

@@ -0,0 +1,159 @@
+# typed: strong
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Customers
+        class Commits
+          # Create a new commit at the customer level.
+          sig do
+            params(
+              access_schedule: T.any(
+                MetronomeSDK::Models::V1::Customers::CommitCreateParams::AccessSchedule,
+                MetronomeSDK::Internal::AnyHash
+              ),
+              customer_id: String,
+              priority: Float,
+              product_id: String,
+              type: MetronomeSDK::Models::V1::Customers::CommitCreateParams::Type::OrSymbol,
+              applicable_contract_ids: T::Array[String],
+              applicable_product_ids: T::Array[String],
+              applicable_product_tags: T::Array[String],
+              custom_fields: T::Hash[Symbol, String],
+              description: String,
+              invoice_contract_id: String,
+              invoice_schedule: T.any(
+                MetronomeSDK::Models::V1::Customers::CommitCreateParams::InvoiceSchedule,
+                MetronomeSDK::Internal::AnyHash
+              ),
+              name: String,
+              netsuite_sales_order_id: String,
+              rate_type: MetronomeSDK::Models::V1::Customers::CommitCreateParams::RateType::OrSymbol,
+              salesforce_opportunity_id: String,
+              uniqueness_key: String,
+              request_options: MetronomeSDK::RequestOpts
+            )
+              .returns(MetronomeSDK::Models::V1::Customers::CommitCreateResponse)
+          end
+          def create(
+            # Schedule for distributing the commit to the customer. For "POSTPAID" commits
+            # only one schedule item is allowed and amount must match invoice_schedule total.
+            access_schedule:,
+            customer_id:,
+            # If multiple credits or commits are applicable, the one with the lower priority
+            # will apply first.
+            priority:,
+            # ID of the fixed product associated with the commit. This is required because
+            # products are used to invoice the commit amount.
+            product_id:,
+            type:,
+            # Which contract the commit applies to. If not provided, the commit applies to all
+            # contracts.
+            applicable_contract_ids: nil,
+            # Which products the commit applies to. If both applicable_product_ids and
+            # applicable_product_tags are not provided, the commit applies to all products.
+            applicable_product_ids: nil,
+            # Which tags the commit applies to. If both applicable_product_ids and
+            # applicable_product_tags are not provided, the commit applies to all products.
+            applicable_product_tags: nil,
+            custom_fields: nil,
+            # Used only in UI/API. It is not exposed to end customers.
+            description: nil,
+            # The contract that this commit will be billed on. This is required for "POSTPAID"
+            # commits and for "PREPAID" commits unless there is no invoice schedule above
+            # (i.e., the commit is 'free').
+            invoice_contract_id: nil,
+            # Required for "POSTPAID" commits: the true up invoice will be generated at this
+            # time and only one schedule item is allowed; the total must match
+            # accesss_schedule amount. Optional for "PREPAID" commits: if not provided, this
+            # will be a "complimentary" commit with no invoice.
+            invoice_schedule: nil,
+            # displayed on invoices
+            name: nil,
+            # This field's availability is dependent on your client's configuration.
+            netsuite_sales_order_id: nil,
+            rate_type: nil,
+            # This field's availability is dependent on your client's configuration.
+            salesforce_opportunity_id: nil,
+            # Prevents the creation of duplicates. If a request to create a commit or credit
+            # is made with a uniqueness key that was previously used to create a commit or
+            # credit, a new record will not be created and the request will fail with a 409
+            # error.
+            uniqueness_key: nil,
+            request_options: {}
+          ); end
+          # List commits.
+          sig do
+            params(
+              customer_id: String,
+              commit_id: String,
+              covering_date: Time,
+              effective_before: Time,
+              include_archived: T::Boolean,
+              include_balance: T::Boolean,
+              include_contract_commits: T::Boolean,
+              include_ledgers: T::Boolean,
+              next_page: String,
+              starting_at: Time,
+              request_options: MetronomeSDK::RequestOpts
+            )
+              .returns(MetronomeSDK::Models::V1::Customers::CommitListResponse)
+          end
+          def list(
+            customer_id:,
+            commit_id: nil,
+            # Include only commits that have access schedules that "cover" the provided date
+            covering_date: nil,
+            # Include only commits that have any access before the provided date (exclusive)
+            effective_before: nil,
+            # Include archived commits and commits from archived contracts.
+            include_archived: nil,
+            # Include the balance in the response. Setting this flag may cause the query to be
+            # slower.
+            include_balance: nil,
+            # Include commits on the contract level.
+            include_contract_commits: nil,
+            # Include commit ledgers in the response. Setting this flag may cause the query to
+            # be slower.
+            include_ledgers: nil,
+            # The next page token from a previous response.
+            next_page: nil,
+            # Include only commits that have any access on or after the provided date
+            starting_at: nil,
+            request_options: {}
+          ); end
+          # 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.
+          sig do
+            params(
+              commit_id: String,
+              customer_id: String,
+              access_ending_before: Time,
+              invoices_ending_before: Time,
+              request_options: MetronomeSDK::RequestOpts
+            )
+              .returns(MetronomeSDK::Models::V1::Customers::CommitUpdateEndDateResponse)
+          end
+          def update_end_date(
+            # ID of the commit to update. Only supports "PREPAID" commits.
+            commit_id:,
+            # ID of the customer whose commit is to be updated
+            customer_id:,
+            # RFC 3339 timestamp indicating when access to the commit will end and it will no
+            # longer be possible to draw it down (exclusive). If not provided, the access will
+            # not be updated.
+            access_ending_before: nil,
+            # RFC 3339 timestamp indicating when the commit will stop being invoiced
+            # (exclusive). If not provided, the invoice schedule will not be updated.
+            invoices_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/credits.rbi

@@ -0,0 +1,134 @@
+# typed: strong
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Customers
+        class Credits
+          # Create a new credit at the customer level.
+          sig do
+            params(
+              access_schedule: T.any(
+                MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule,
+                MetronomeSDK::Internal::AnyHash
+              ),
+              customer_id: String,
+              priority: Float,
+              product_id: String,
+              applicable_contract_ids: T::Array[String],
+              applicable_product_ids: T::Array[String],
+              applicable_product_tags: T::Array[String],
+              custom_fields: T::Hash[Symbol, String],
+              description: String,
+              name: String,
+              netsuite_sales_order_id: String,
+              rate_type: MetronomeSDK::Models::V1::Customers::CreditCreateParams::RateType::OrSymbol,
+              salesforce_opportunity_id: String,
+              uniqueness_key: String,
+              request_options: MetronomeSDK::RequestOpts
+            )
+              .returns(MetronomeSDK::Models::V1::Customers::CreditCreateResponse)
+          end
+          def create(
+            # Schedule for distributing the credit to the customer.
+            access_schedule:,
+            customer_id:,
+            # If multiple credits or commits are applicable, the one with the lower priority
+            # will apply first.
+            priority:,
+            product_id:,
+            # Which contract the credit applies to. If not provided, the credit applies to all
+            # contracts.
+            applicable_contract_ids: nil,
+            # Which products the credit applies to. If both applicable_product_ids and
+            # applicable_product_tags are not provided, the credit applies to all products.
+            applicable_product_ids: nil,
+            # Which tags the credit applies to. If both applicable_product_ids and
+            # applicable_product_tags are not provided, the credit applies to all products.
+            applicable_product_tags: nil,
+            custom_fields: nil,
+            # Used only in UI/API. It is not exposed to end customers.
+            description: nil,
+            # displayed on invoices
+            name: nil,
+            # This field's availability is dependent on your client's configuration.
+            netsuite_sales_order_id: nil,
+            rate_type: nil,
+            # This field's availability is dependent on your client's configuration.
+            salesforce_opportunity_id: nil,
+            # Prevents the creation of duplicates. If a request to create a commit or credit
+            # is made with a uniqueness key that was previously used to create a commit or
+            # credit, a new record will not be created and the request will fail with a 409
+            # error.
+            uniqueness_key: nil,
+            request_options: {}
+          ); end
+          # List credits.
+          sig do
+            params(
+              customer_id: String,
+              covering_date: Time,
+              credit_id: String,
+              effective_before: Time,
+              include_archived: T::Boolean,
+              include_balance: T::Boolean,
+              include_contract_credits: T::Boolean,
+              include_ledgers: T::Boolean,
+              next_page: String,
+              starting_at: Time,
+              request_options: MetronomeSDK::RequestOpts
+            )
+              .returns(MetronomeSDK::Models::V1::Customers::CreditListResponse)
+          end
+          def list(
+            customer_id:,
+            # Return only credits that have access schedules that "cover" the provided date
+            covering_date: nil,
+            credit_id: nil,
+            # Include only credits that have any access before the provided date (exclusive)
+            effective_before: nil,
+            # Include archived credits and credits from archived contracts.
+            include_archived: nil,
+            # Include the balance in the response. Setting this flag may cause the query to be
+            # slower.
+            include_balance: nil,
+            # Include credits on the contract level.
+            include_contract_credits: nil,
+            # Include credit ledgers in the response. Setting this flag may cause the query to
+            # be slower.
+            include_ledgers: nil,
+            # The next page token from a previous response.
+            next_page: nil,
+            # Include only credits that have any access on or after the provided date
+            starting_at: nil,
+            request_options: {}
+          ); end
+          # 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.
+          sig do
+            params(
+              access_ending_before: Time,
+              credit_id: String,
+              customer_id: String,
+              request_options: MetronomeSDK::RequestOpts
+            )
+              .returns(MetronomeSDK::Models::V1::Customers::CreditUpdateEndDateResponse)
+          end
+          def update_end_date(
+            # RFC 3339 timestamp indicating when access to the credit will end and it will no
+            # longer be possible to draw it down (exclusive).
+            access_ending_before:,
+            # ID of the commit to update
+            credit_id:,
+            # ID of the customer whose credit is to be updated
+            customer_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/customers/invoices.rbi

@@ -0,0 +1,164 @@
+# typed: strong
+
+module MetronomeSDK
+  module Resources
+    class V1
+      class Customers
+        class Invoices
+          # Fetch a specific invoice for a given customer.
+          sig do
+            params(
+              customer_id: String,
+              invoice_id: String,
+              skip_zero_qty_line_items: T::Boolean,
+              request_options: MetronomeSDK::RequestOpts
+            )
+              .returns(MetronomeSDK::Models::V1::Customers::InvoiceRetrieveResponse)
+          end
+          def retrieve(
+            # Path param:
+            customer_id:,
+            # Path param:
+            invoice_id:,
+            # Query param: If set, all zero quantity line items will be filtered out of the
+            # response
+            skip_zero_qty_line_items: nil,
+            request_options: {}
+          ); end
+          # List all invoices for a given customer, optionally filtered by status, date
+          # range, and/or credit type.
+          sig do
+            params(
+              customer_id: String,
+              credit_type_id: String,
+              ending_before: Time,
+              limit: Integer,
+              next_page: String,
+              skip_zero_qty_line_items: T::Boolean,
+              sort: MetronomeSDK::Models::V1::Customers::InvoiceListParams::Sort::OrSymbol,
+              starting_on: Time,
+              status: String,
+              request_options: MetronomeSDK::RequestOpts
+            )
+              .returns(MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::Customers::Invoice])
+          end
+          def list(
+            # Path param:
+            customer_id:,
+            # Query param: Only return invoices for the specified credit type
+            credit_type_id: nil,
+            # Query param: RFC 3339 timestamp (exclusive). Invoices will only be returned for
+            # billing periods that end before this time.
+            ending_before: 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 set, all zero quantity line items will be filtered out of the
+            # response
+            skip_zero_qty_line_items: nil,
+            # Query param: Invoice sort order by issued_at, e.g. date_asc or date_desc.
+            # Defaults to date_asc.
+            sort: nil,
+            # Query param: RFC 3339 timestamp (inclusive). Invoices will only be returned for
+            # billing periods that start at or after this time.
+            starting_on: nil,
+            # Query param: Invoice status, e.g. DRAFT, FINALIZED, or VOID
+            status: nil,
+            request_options: {}
+          ); end
+          # Add a one time charge to the specified invoice
+          sig do
+            params(
+              customer_id: String,
+              charge_id: String,
+              customer_plan_id: String,
+              description: String,
+              invoice_start_timestamp: Time,
+              price: Float,
+              quantity: Float,
+              request_options: MetronomeSDK::RequestOpts
+            )
+              .returns(MetronomeSDK::Models::V1::Customers::InvoiceAddChargeResponse)
+          end
+          def add_charge(
+            # Path param:
+            customer_id:,
+            # Body param: The Metronome ID of the charge to add to the invoice. Note that the
+            # charge must be on a product that is not on the current plan, and the product
+            # must have only fixed charges.
+            charge_id:,
+            # Body param: The Metronome ID of the customer plan to add the charge to.
+            customer_plan_id:,
+            # Body param:
+            description:,
+            # Body param: The start_timestamp of the invoice to add the charge to.
+            invoice_start_timestamp:,
+            # Body param: The price of the charge. This price will match the currency on the
+            # invoice, e.g. USD cents.
+            price:,
+            # Body param:
+            quantity:,
+            request_options: {}
+          ); end
+          # 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.
+          sig do
+            params(
+              customer_id: String,
+              ending_before: Time,
+              starting_on: Time,
+              credit_type_id: String,
+              limit: Integer,
+              next_page: String,
+              skip_zero_qty_line_items: T::Boolean,
+              sort: MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsParams::Sort::OrSymbol,
+              status: String,
+              window_size: MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsParams::WindowSize::OrSymbol,
+              request_options: MetronomeSDK::RequestOpts
+            )
+              .returns(
+                MetronomeSDK::Internal::CursorPage[MetronomeSDK::Models::V1::Customers::InvoiceListBreakdownsResponse]
+              )
+          end
+          def list_breakdowns(
+            # Path param:
+            customer_id:,
+            # Query param: RFC 3339 timestamp. Breakdowns will only be returned for time
+            # windows that end on or before this time.
+            ending_before:,
+            # Query param: RFC 3339 timestamp. Breakdowns will only be returned for time
+            # windows that start on or after this time.
+            starting_on:,
+            # Query param: Only return invoices for the specified credit type
+            credit_type_id: nil,
+            # Query param: Max number of results that should be returned. For daily
+            # breakdowns, the response can return up to 35 days worth of breakdowns. For
+            # hourly breakdowns, the response can return up to 24 hours. If there are more
+            # results, a cursor to the next page is returned.
+            limit: nil,
+            # Query param: Cursor that indicates where the next page of results should start.
+            next_page: nil,
+            # Query param: If set, all zero quantity line items will be filtered out of the
+            # response
+            skip_zero_qty_line_items: nil,
+            # Query param: Invoice sort order by issued_at, e.g. date_asc or date_desc.
+            # Defaults to date_asc.
+            sort: nil,
+            # Query param: Invoice status, e.g. DRAFT or FINALIZED
+            status: nil,
+            # Query param: The granularity of the breakdowns to return. Defaults to day.
+            window_size: 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