metronome-sdk 0.1.0.pre.alpha.1

data/rbi/metronome_sdk/models/v1/customers/commit_create_response.rbi

@@ -0,0 +1,23 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        class CommitCreateResponse < MetronomeSDK::Internal::Type::BaseModel
+          sig { returns(MetronomeSDK::Models::ID) }
+          attr_reader :data
+
+          sig { params(data: T.any(MetronomeSDK::Models::ID, MetronomeSDK::Internal::AnyHash)).void }
+          attr_writer :data
+
+          sig { params(data: T.any(MetronomeSDK::Models::ID, MetronomeSDK::Internal::AnyHash)).returns(T.attached_class) }
+          def self.new(data:); end
+
+          sig { override.returns({data: MetronomeSDK::Models::ID}) }
+          def to_hash; end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/customers/commit_list_params.rbi

@@ -0,0 +1,140 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        class CommitListParams < MetronomeSDK::Internal::Type::BaseModel
+          extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+          include MetronomeSDK::Internal::Type::RequestParameters
+
+          sig { returns(String) }
+          attr_accessor :customer_id
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :commit_id
+
+          sig { params(commit_id: String).void }
+          attr_writer :commit_id
+
+          # Include only commits that have access schedules that "cover" the provided date
+          sig { returns(T.nilable(Time)) }
+          attr_reader :covering_date
+
+          sig { params(covering_date: Time).void }
+          attr_writer :covering_date
+
+          # Include only commits that have any access before the provided date (exclusive)
+          sig { returns(T.nilable(Time)) }
+          attr_reader :effective_before
+
+          sig { params(effective_before: Time).void }
+          attr_writer :effective_before
+
+          # Include archived commits and commits from archived contracts.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :include_archived
+
+          sig { params(include_archived: T::Boolean).void }
+          attr_writer :include_archived
+
+          # Include the balance in the response. Setting this flag may cause the query to be
+          # slower.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :include_balance
+
+          sig { params(include_balance: T::Boolean).void }
+          attr_writer :include_balance
+
+          # Include commits on the contract level.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :include_contract_commits
+
+          sig { params(include_contract_commits: T::Boolean).void }
+          attr_writer :include_contract_commits
+
+          # Include commit ledgers in the response. Setting this flag may cause the query to
+          # be slower.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :include_ledgers
+
+          sig { params(include_ledgers: T::Boolean).void }
+          attr_writer :include_ledgers
+
+          # The next page token from a previous response.
+          sig { returns(T.nilable(String)) }
+          attr_reader :next_page
+
+          sig { params(next_page: String).void }
+          attr_writer :next_page
+
+          # Include only commits that have any access on or after the provided date
+          sig { returns(T.nilable(Time)) }
+          attr_reader :starting_at
+
+          sig { params(starting_at: Time).void }
+          attr_writer :starting_at
+
+          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: T.any(MetronomeSDK::RequestOptions, MetronomeSDK::Internal::AnyHash)
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+            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
+          sig do
+            override
+              .returns(
+                {
+                  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::RequestOptions
+                }
+              )
+          end
+          def to_hash; end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/customers/commit_list_response.rbi

@@ -0,0 +1,29 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        class CommitListResponse < MetronomeSDK::Internal::Type::BaseModel
+          sig { returns(T::Array[MetronomeSDK::Models::Commit]) }
+          attr_accessor :data
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :next_page
+
+          sig do
+            params(
+              data: T::Array[T.any(MetronomeSDK::Models::Commit, MetronomeSDK::Internal::AnyHash)],
+              next_page: T.nilable(String)
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(data:, next_page:); end
+
+          sig { override.returns({data: T::Array[MetronomeSDK::Models::Commit], next_page: T.nilable(String)}) }
+          def to_hash; end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/customers/commit_update_end_date_params.rbi

@@ -0,0 +1,77 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        class CommitUpdateEndDateParams < MetronomeSDK::Internal::Type::BaseModel
+          extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+          include MetronomeSDK::Internal::Type::RequestParameters
+
+          # ID of the commit to update. Only supports "PREPAID" commits.
+          sig { returns(String) }
+          attr_accessor :commit_id
+
+          # ID of the customer whose commit is to be updated
+          sig { returns(String) }
+          attr_accessor :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.
+          sig { returns(T.nilable(Time)) }
+          attr_reader :access_ending_before
+
+          sig { params(access_ending_before: Time).void }
+          attr_writer :access_ending_before
+
+          # RFC 3339 timestamp indicating when the commit will stop being invoiced
+          # (exclusive). If not provided, the invoice schedule will not be updated.
+          sig { returns(T.nilable(Time)) }
+          attr_reader :invoices_ending_before
+
+          sig { params(invoices_ending_before: Time).void }
+          attr_writer :invoices_ending_before
+
+          sig do
+            params(
+              commit_id: String,
+              customer_id: String,
+              access_ending_before: Time,
+              invoices_ending_before: Time,
+              request_options: T.any(MetronomeSDK::RequestOptions, MetronomeSDK::Internal::AnyHash)
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+            # 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
+          sig do
+            override
+              .returns(
+                {
+                  commit_id: String,
+                  customer_id: String,
+                  access_ending_before: Time,
+                  invoices_ending_before: Time,
+                  request_options: MetronomeSDK::RequestOptions
+                }
+              )
+          end
+          def to_hash; end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/customers/commit_update_end_date_response.rbi

@@ -0,0 +1,23 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        class CommitUpdateEndDateResponse < MetronomeSDK::Internal::Type::BaseModel
+          sig { returns(MetronomeSDK::Models::ID) }
+          attr_reader :data
+
+          sig { params(data: T.any(MetronomeSDK::Models::ID, MetronomeSDK::Internal::AnyHash)).void }
+          attr_writer :data
+
+          sig { params(data: T.any(MetronomeSDK::Models::ID, MetronomeSDK::Internal::AnyHash)).returns(T.attached_class) }
+          def self.new(data:); end
+
+          sig { override.returns({data: MetronomeSDK::Models::ID}) }
+          def to_hash; end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/customers/credit_create_params.rbi

@@ -0,0 +1,278 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        class CreditCreateParams < MetronomeSDK::Internal::Type::BaseModel
+          extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+          include MetronomeSDK::Internal::Type::RequestParameters
+
+          # Schedule for distributing the credit to the customer.
+          sig { returns(MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule) }
+          attr_reader :access_schedule
+
+          sig do
+            params(
+              access_schedule: T.any(
+                MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule,
+                MetronomeSDK::Internal::AnyHash
+              )
+            )
+              .void
+          end
+          attr_writer :access_schedule
+
+          sig { returns(String) }
+          attr_accessor :customer_id
+
+          # If multiple credits or commits are applicable, the one with the lower priority
+          # will apply first.
+          sig { returns(Float) }
+          attr_accessor :priority
+
+          sig { returns(String) }
+          attr_accessor :product_id
+
+          # Which contract the credit applies to. If not provided, the credit applies to all
+          # contracts.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :applicable_contract_ids
+
+          sig { params(applicable_contract_ids: T::Array[String]).void }
+          attr_writer :applicable_contract_ids
+
+          # Which products the credit applies to. If both applicable_product_ids and
+          # applicable_product_tags are not provided, the credit applies to all products.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :applicable_product_ids
+
+          sig { params(applicable_product_ids: T::Array[String]).void }
+          attr_writer :applicable_product_ids
+
+          # Which tags the credit applies to. If both applicable_product_ids and
+          # applicable_product_tags are not provided, the credit applies to all products.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :applicable_product_tags
+
+          sig { params(applicable_product_tags: T::Array[String]).void }
+          attr_writer :applicable_product_tags
+
+          sig { returns(T.nilable(T::Hash[Symbol, String])) }
+          attr_reader :custom_fields
+
+          sig { params(custom_fields: T::Hash[Symbol, String]).void }
+          attr_writer :custom_fields
+
+          # Used only in UI/API. It is not exposed to end customers.
+          sig { returns(T.nilable(String)) }
+          attr_reader :description
+
+          sig { params(description: String).void }
+          attr_writer :description
+
+          # displayed on invoices
+          sig { returns(T.nilable(String)) }
+          attr_reader :name
+
+          sig { params(name: String).void }
+          attr_writer :name
+
+          # This field's availability is dependent on your client's configuration.
+          sig { returns(T.nilable(String)) }
+          attr_reader :netsuite_sales_order_id
+
+          sig { params(netsuite_sales_order_id: String).void }
+          attr_writer :netsuite_sales_order_id
+
+          sig { returns(T.nilable(MetronomeSDK::Models::V1::Customers::CreditCreateParams::RateType::OrSymbol)) }
+          attr_reader :rate_type
+
+          sig { params(rate_type: MetronomeSDK::Models::V1::Customers::CreditCreateParams::RateType::OrSymbol).void }
+          attr_writer :rate_type
+
+          # This field's availability is dependent on your client's configuration.
+          sig { returns(T.nilable(String)) }
+          attr_reader :salesforce_opportunity_id
+
+          sig { params(salesforce_opportunity_id: String).void }
+          attr_writer :salesforce_opportunity_id
+
+          # 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.
+          sig { returns(T.nilable(String)) }
+          attr_reader :uniqueness_key
+
+          sig { params(uniqueness_key: String).void }
+          attr_writer :uniqueness_key
+
+          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: T.any(MetronomeSDK::RequestOptions, MetronomeSDK::Internal::AnyHash)
+            )
+              .returns(T.attached_class)
+          end
+          def self.new(
+            # 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
+          sig do
+            override
+              .returns(
+                {
+                  access_schedule: MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule,
+                  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::RequestOptions
+                }
+              )
+          end
+          def to_hash; end
+
+          class AccessSchedule < MetronomeSDK::Internal::Type::BaseModel
+            sig { returns(T::Array[MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule::ScheduleItem]) }
+            attr_accessor :schedule_items
+
+            # Defaults to USD (cents) if not passed
+            sig { returns(T.nilable(String)) }
+            attr_reader :credit_type_id
+
+            sig { params(credit_type_id: String).void }
+            attr_writer :credit_type_id
+
+            # Schedule for distributing the credit to the customer.
+            sig do
+              params(
+                schedule_items: T::Array[
+                  T.any(
+                    MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule::ScheduleItem,
+                    MetronomeSDK::Internal::AnyHash
+                  )
+                ],
+                credit_type_id: String
+              )
+                .returns(T.attached_class)
+            end
+            def self.new(
+              schedule_items:,
+              # Defaults to USD (cents) if not passed
+              credit_type_id: nil
+            ); end
+            sig do
+              override
+                .returns(
+                  {
+                    schedule_items: T::Array[MetronomeSDK::Models::V1::Customers::CreditCreateParams::AccessSchedule::ScheduleItem],
+                    credit_type_id: String
+                  }
+                )
+            end
+            def to_hash; end
+
+            class ScheduleItem < MetronomeSDK::Internal::Type::BaseModel
+              sig { returns(Float) }
+              attr_accessor :amount
+
+              # RFC 3339 timestamp (exclusive)
+              sig { returns(Time) }
+              attr_accessor :ending_before
+
+              # RFC 3339 timestamp (inclusive)
+              sig { returns(Time) }
+              attr_accessor :starting_at
+
+              sig { params(amount: Float, ending_before: Time, starting_at: Time).returns(T.attached_class) }
+              def self.new(
+                amount:,
+                # RFC 3339 timestamp (exclusive)
+                ending_before:,
+                # RFC 3339 timestamp (inclusive)
+                starting_at:
+              ); end
+              sig { override.returns({amount: Float, ending_before: Time, starting_at: Time}) }
+              def to_hash; end
+            end
+          end
+
+          module RateType
+            extend MetronomeSDK::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias { T.all(Symbol, MetronomeSDK::Models::V1::Customers::CreditCreateParams::RateType) }
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            COMMIT_RATE =
+              T.let(:COMMIT_RATE, MetronomeSDK::Models::V1::Customers::CreditCreateParams::RateType::TaggedSymbol)
+            LIST_RATE =
+              T.let(:LIST_RATE, MetronomeSDK::Models::V1::Customers::CreditCreateParams::RateType::TaggedSymbol)
+
+            sig do
+              override.returns(T::Array[MetronomeSDK::Models::V1::Customers::CreditCreateParams::RateType::TaggedSymbol])
+            end
+            def self.values; end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/customers/credit_create_response.rbi

@@ -0,0 +1,23 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      module Customers
+        class CreditCreateResponse < MetronomeSDK::Internal::Type::BaseModel
+          sig { returns(MetronomeSDK::Models::ID) }
+          attr_reader :data
+
+          sig { params(data: T.any(MetronomeSDK::Models::ID, MetronomeSDK::Internal::AnyHash)).void }
+          attr_writer :data
+
+          sig { params(data: T.any(MetronomeSDK::Models::ID, MetronomeSDK::Internal::AnyHash)).returns(T.attached_class) }
+          def self.new(data:); end
+
+          sig { override.returns({data: MetronomeSDK::Models::ID}) }
+          def to_hash; end
+        end
+      end
+    end
+  end
+end