metronome-sdk 0.1.0.pre.alpha.3 → 0.1.0

data/rbi/metronome_sdk/models/v1/credit_grant_list_response.rbi

@@ -39,13 +39,7 @@ module MetronomeSDK
         sig { returns(String) }
         attr_accessor :customer_id
 
-        sig do
-          returns(
-            T::Array[
-              MetronomeSDK::Models::V1::CreditGrantListResponse::Deduction
-            ]
-          )
-        end
+        sig { returns(T::Array[MetronomeSDK::V1::CreditLedgerEntry]) }
         attr_accessor :deductions
 
         sig { returns(Time) }
@@ -87,13 +81,7 @@ module MetronomeSDK
         end
         attr_writer :paid_amount
 
-        sig do
-          returns(
-            T::Array[
-              MetronomeSDK::Models::V1::CreditGrantListResponse::PendingDeduction
-            ]
-          )
-        end
+        sig { returns(T::Array[MetronomeSDK::V1::CreditLedgerEntry]) }
         attr_accessor :pending_deductions
 
         sig { returns(Float) }
@@ -146,10 +134,7 @@ module MetronomeSDK
               MetronomeSDK::Models::V1::CreditGrantListResponse::Balance::OrHash,
             custom_fields: T::Hash[Symbol, String],
             customer_id: String,
-            deductions:
-              T::Array[
-                MetronomeSDK::Models::V1::CreditGrantListResponse::Deduction::OrHash
-              ],
+            deductions: T::Array[MetronomeSDK::V1::CreditLedgerEntry::OrHash],
             effective_at: Time,
             expires_at: Time,
             grant_amount:
@@ -158,9 +143,7 @@ module MetronomeSDK
             paid_amount:
               MetronomeSDK::Models::V1::CreditGrantListResponse::PaidAmount::OrHash,
             pending_deductions:
-              T::Array[
-                MetronomeSDK::Models::V1::CreditGrantListResponse::PendingDeduction::OrHash
-              ],
+              T::Array[MetronomeSDK::V1::CreditLedgerEntry::OrHash],
             priority: Float,
             credit_grant_type: T.nilable(String),
             invoice_id: T.nilable(String),
@@ -215,10 +198,7 @@ module MetronomeSDK
                 MetronomeSDK::Models::V1::CreditGrantListResponse::Balance,
               custom_fields: T::Hash[Symbol, String],
               customer_id: String,
-              deductions:
-                T::Array[
-                  MetronomeSDK::Models::V1::CreditGrantListResponse::Deduction
-                ],
+              deductions: T::Array[MetronomeSDK::V1::CreditLedgerEntry],
               effective_at: Time,
               expires_at: Time,
               grant_amount:
@@ -226,10 +206,7 @@ module MetronomeSDK
               name: String,
               paid_amount:
                 MetronomeSDK::Models::V1::CreditGrantListResponse::PaidAmount,
-              pending_deductions:
-                T::Array[
-                  MetronomeSDK::Models::V1::CreditGrantListResponse::PendingDeduction
-                ],
+              pending_deductions: T::Array[MetronomeSDK::V1::CreditLedgerEntry],
               priority: Float,
               credit_grant_type: T.nilable(String),
               invoice_id: T.nilable(String),
@@ -305,89 +282,6 @@ module MetronomeSDK
           end
         end
 
-        class Deduction < MetronomeSDK::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                MetronomeSDK::Models::V1::CreditGrantListResponse::Deduction,
-                MetronomeSDK::Internal::AnyHash
-              )
-            end
-
-          # an amount representing the change to the customer's credit balance
-          sig { returns(Float) }
-          attr_accessor :amount
-
-          sig { returns(String) }
-          attr_accessor :created_by
-
-          # the credit grant this entry is related to
-          sig { returns(String) }
-          attr_accessor :credit_grant_id
-
-          sig { returns(Time) }
-          attr_accessor :effective_at
-
-          sig { returns(String) }
-          attr_accessor :reason
-
-          # the running balance for this credit type at the time of the ledger entry,
-          # including all preceding charges
-          sig { returns(Float) }
-          attr_accessor :running_balance
-
-          # if this entry is a deduction, the Metronome ID of the invoice where the credit
-          # deduction was consumed; if this entry is a grant, the Metronome ID of the
-          # invoice where the grant's paid_amount was charged
-          sig { returns(T.nilable(String)) }
-          attr_accessor :invoice_id
-
-          sig do
-            params(
-              amount: Float,
-              created_by: String,
-              credit_grant_id: String,
-              effective_at: Time,
-              reason: String,
-              running_balance: Float,
-              invoice_id: T.nilable(String)
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # an amount representing the change to the customer's credit balance
-            amount:,
-            created_by:,
-            # the credit grant this entry is related to
-            credit_grant_id:,
-            effective_at:,
-            reason:,
-            # the running balance for this credit type at the time of the ledger entry,
-            # including all preceding charges
-            running_balance:,
-            # if this entry is a deduction, the Metronome ID of the invoice where the credit
-            # deduction was consumed; if this entry is a grant, the Metronome ID of the
-            # invoice where the grant's paid_amount was charged
-            invoice_id: nil
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                amount: Float,
-                created_by: String,
-                credit_grant_id: String,
-                effective_at: Time,
-                reason: String,
-                running_balance: Float,
-                invoice_id: T.nilable(String)
-              }
-            )
-          end
-          def to_hash
-          end
-        end
-
         class GrantAmount < MetronomeSDK::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
@@ -401,27 +295,17 @@ module MetronomeSDK
           attr_accessor :amount
 
           # the credit type for the amount granted
-          sig do
-            returns(
-              MetronomeSDK::Models::V1::CreditGrantListResponse::GrantAmount::CreditType
-            )
-          end
+          sig { returns(MetronomeSDK::CreditTypeData) }
           attr_reader :credit_type
 
-          sig do
-            params(
-              credit_type:
-                MetronomeSDK::Models::V1::CreditGrantListResponse::GrantAmount::CreditType::OrHash
-            ).void
-          end
+          sig { params(credit_type: MetronomeSDK::CreditTypeData::OrHash).void }
           attr_writer :credit_type
 
           # the amount of credits initially granted
           sig do
             params(
               amount: Float,
-              credit_type:
-                MetronomeSDK::Models::V1::CreditGrantListResponse::GrantAmount::CreditType::OrHash
+              credit_type: MetronomeSDK::CreditTypeData::OrHash
             ).returns(T.attached_class)
           end
           def self.new(
@@ -433,40 +317,11 @@ module MetronomeSDK
 
           sig do
             override.returns(
-              {
-                amount: Float,
-                credit_type:
-                  MetronomeSDK::Models::V1::CreditGrantListResponse::GrantAmount::CreditType
-              }
+              { amount: Float, credit_type: MetronomeSDK::CreditTypeData }
             )
           end
           def to_hash
           end
-
-          class CreditType < MetronomeSDK::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  MetronomeSDK::Models::V1::CreditGrantListResponse::GrantAmount::CreditType,
-                  MetronomeSDK::Internal::AnyHash
-                )
-              end
-
-            sig { returns(String) }
-            attr_accessor :id
-
-            sig { returns(String) }
-            attr_accessor :name
-
-            # the credit type for the amount granted
-            sig { params(id: String, name: String).returns(T.attached_class) }
-            def self.new(id:, name:)
-            end
-
-            sig { override.returns({ id: String, name: String }) }
-            def to_hash
-            end
-          end
         end
 
         class PaidAmount < MetronomeSDK::Internal::Type::BaseModel
@@ -482,27 +337,17 @@ module MetronomeSDK
           attr_accessor :amount
 
           # the credit type for the amount paid
-          sig do
-            returns(
-              MetronomeSDK::Models::V1::CreditGrantListResponse::PaidAmount::CreditType
-            )
-          end
+          sig { returns(MetronomeSDK::CreditTypeData) }
           attr_reader :credit_type
 
-          sig do
-            params(
-              credit_type:
-                MetronomeSDK::Models::V1::CreditGrantListResponse::PaidAmount::CreditType::OrHash
-            ).void
-          end
+          sig { params(credit_type: MetronomeSDK::CreditTypeData::OrHash).void }
           attr_writer :credit_type
 
           # the amount paid for this credit grant
           sig do
             params(
               amount: Float,
-              credit_type:
-                MetronomeSDK::Models::V1::CreditGrantListResponse::PaidAmount::CreditType::OrHash
+              credit_type: MetronomeSDK::CreditTypeData::OrHash
             ).returns(T.attached_class)
           end
           def self.new(
@@ -514,119 +359,7 @@ module MetronomeSDK
 
           sig do
             override.returns(
-              {
-                amount: Float,
-                credit_type:
-                  MetronomeSDK::Models::V1::CreditGrantListResponse::PaidAmount::CreditType
-              }
-            )
-          end
-          def to_hash
-          end
-
-          class CreditType < MetronomeSDK::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  MetronomeSDK::Models::V1::CreditGrantListResponse::PaidAmount::CreditType,
-                  MetronomeSDK::Internal::AnyHash
-                )
-              end
-
-            sig { returns(String) }
-            attr_accessor :id
-
-            sig { returns(String) }
-            attr_accessor :name
-
-            # the credit type for the amount paid
-            sig { params(id: String, name: String).returns(T.attached_class) }
-            def self.new(id:, name:)
-            end
-
-            sig { override.returns({ id: String, name: String }) }
-            def to_hash
-            end
-          end
-        end
-
-        class PendingDeduction < MetronomeSDK::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                MetronomeSDK::Models::V1::CreditGrantListResponse::PendingDeduction,
-                MetronomeSDK::Internal::AnyHash
-              )
-            end
-
-          # an amount representing the change to the customer's credit balance
-          sig { returns(Float) }
-          attr_accessor :amount
-
-          sig { returns(String) }
-          attr_accessor :created_by
-
-          # the credit grant this entry is related to
-          sig { returns(String) }
-          attr_accessor :credit_grant_id
-
-          sig { returns(Time) }
-          attr_accessor :effective_at
-
-          sig { returns(String) }
-          attr_accessor :reason
-
-          # the running balance for this credit type at the time of the ledger entry,
-          # including all preceding charges
-          sig { returns(Float) }
-          attr_accessor :running_balance
-
-          # if this entry is a deduction, the Metronome ID of the invoice where the credit
-          # deduction was consumed; if this entry is a grant, the Metronome ID of the
-          # invoice where the grant's paid_amount was charged
-          sig { returns(T.nilable(String)) }
-          attr_accessor :invoice_id
-
-          sig do
-            params(
-              amount: Float,
-              created_by: String,
-              credit_grant_id: String,
-              effective_at: Time,
-              reason: String,
-              running_balance: Float,
-              invoice_id: T.nilable(String)
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # an amount representing the change to the customer's credit balance
-            amount:,
-            created_by:,
-            # the credit grant this entry is related to
-            credit_grant_id:,
-            effective_at:,
-            reason:,
-            # the running balance for this credit type at the time of the ledger entry,
-            # including all preceding charges
-            running_balance:,
-            # if this entry is a deduction, the Metronome ID of the invoice where the credit
-            # deduction was consumed; if this entry is a grant, the Metronome ID of the
-            # invoice where the grant's paid_amount was charged
-            invoice_id: nil
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                amount: Float,
-                created_by: String,
-                credit_grant_id: String,
-                effective_at: Time,
-                reason: String,
-                running_balance: Float,
-                invoice_id: T.nilable(String)
-              }
+              { amount: Float, credit_type: MetronomeSDK::CreditTypeData }
             )
           end
           def to_hash

data/rbi/metronome_sdk/models/v1/credit_grant_void_response.rbi

@@ -12,54 +12,19 @@ module MetronomeSDK
             )
           end
 
-        sig { returns(MetronomeSDK::Models::V1::CreditGrantVoidResponse::Data) }
+        sig { returns(MetronomeSDK::ID) }
         attr_reader :data
 
-        sig do
-          params(
-            data:
-              MetronomeSDK::Models::V1::CreditGrantVoidResponse::Data::OrHash
-          ).void
-        end
+        sig { params(data: MetronomeSDK::ID::OrHash).void }
         attr_writer :data
 
-        sig do
-          params(
-            data:
-              MetronomeSDK::Models::V1::CreditGrantVoidResponse::Data::OrHash
-          ).returns(T.attached_class)
-        end
+        sig { params(data: MetronomeSDK::ID::OrHash).returns(T.attached_class) }
         def self.new(data:)
         end
 
-        sig do
-          override.returns(
-            { data: MetronomeSDK::Models::V1::CreditGrantVoidResponse::Data }
-          )
-        end
+        sig { override.returns({ data: MetronomeSDK::ID }) }
         def to_hash
         end
-
-        class Data < MetronomeSDK::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                MetronomeSDK::Models::V1::CreditGrantVoidResponse::Data,
-                MetronomeSDK::Internal::AnyHash
-              )
-            end
-
-          sig { returns(String) }
-          attr_accessor :id
-
-          sig { params(id: String).returns(T.attached_class) }
-          def self.new(id:)
-          end
-
-          sig { override.returns({ id: String }) }
-          def to_hash
-          end
-        end
       end
     end
   end

data/rbi/metronome_sdk/models/v1/credit_ledger_entry.rbi

@@ -0,0 +1,90 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class CreditLedgerEntry < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::V1::CreditLedgerEntry,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        # an amount representing the change to the customer's credit balance
+        sig { returns(Float) }
+        attr_accessor :amount
+
+        sig { returns(String) }
+        attr_accessor :created_by
+
+        # the credit grant this entry is related to
+        sig { returns(String) }
+        attr_accessor :credit_grant_id
+
+        sig { returns(Time) }
+        attr_accessor :effective_at
+
+        sig { returns(String) }
+        attr_accessor :reason
+
+        # the running balance for this credit type at the time of the ledger entry,
+        # including all preceding charges
+        sig { returns(Float) }
+        attr_accessor :running_balance
+
+        # if this entry is a deduction, the Metronome ID of the invoice where the credit
+        # deduction was consumed; if this entry is a grant, the Metronome ID of the
+        # invoice where the grant's paid_amount was charged
+        sig { returns(T.nilable(String)) }
+        attr_accessor :invoice_id
+
+        sig do
+          params(
+            amount: Float,
+            created_by: String,
+            credit_grant_id: String,
+            effective_at: Time,
+            reason: String,
+            running_balance: Float,
+            invoice_id: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # an amount representing the change to the customer's credit balance
+          amount:,
+          created_by:,
+          # the credit grant this entry is related to
+          credit_grant_id:,
+          effective_at:,
+          reason:,
+          # the running balance for this credit type at the time of the ledger entry,
+          # including all preceding charges
+          running_balance:,
+          # if this entry is a deduction, the Metronome ID of the invoice where the credit
+          # deduction was consumed; if this entry is a grant, the Metronome ID of the
+          # invoice where the grant's paid_amount was charged
+          invoice_id: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              amount: Float,
+              created_by: String,
+              credit_grant_id: String,
+              effective_at: Time,
+              reason: String,
+              running_balance: Float,
+              invoice_id: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/customer.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class Customer < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(MetronomeSDK::V1::Customer, MetronomeSDK::Internal::AnyHash)
+          end
+
+        # the Metronome ID of the customer
+        sig { returns(String) }
+        attr_accessor :id
+
+        # (deprecated, use ingest_aliases instead) the first ID (Metronome or ingest
+        # alias) that can be used in usage events
+        sig { returns(String) }
+        attr_accessor :external_id
+
+        # aliases for this customer that can be used instead of the Metronome customer ID
+        # in usage events
+        sig { returns(T::Array[String]) }
+        attr_accessor :ingest_aliases
+
+        sig { returns(String) }
+        attr_accessor :name
+
+        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
+
+        sig do
+          params(
+            id: String,
+            external_id: String,
+            ingest_aliases: T::Array[String],
+            name: String,
+            custom_fields: T::Hash[Symbol, String]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # the Metronome ID of the customer
+          id:,
+          # (deprecated, use ingest_aliases instead) the first ID (Metronome or ingest
+          # alias) that can be used in usage events
+          external_id:,
+          # aliases for this customer that can be used instead of the Metronome customer ID
+          # in usage events
+          ingest_aliases:,
+          name:,
+          custom_fields: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              external_id: String,
+              ingest_aliases: T::Array[String],
+              name: String,
+              custom_fields: T::Hash[Symbol, String]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/customer_archive_params.rbi

@@ -3,7 +3,7 @@
 module MetronomeSDK
   module Models
     module V1
-      class CustomerArchiveParams < MetronomeSDK::Internal::Type::BaseModel
+      class CustomerArchiveParams < MetronomeSDK::Models::ID
         extend MetronomeSDK::Internal::Type::RequestParameters::Converter
         include MetronomeSDK::Internal::Type::RequestParameters
 
@@ -15,22 +15,16 @@ module MetronomeSDK
             )
           end
 
-        sig { returns(String) }
-        attr_accessor :id
-
         sig do
-          params(
-            id: String,
-            request_options: MetronomeSDK::RequestOptions::OrHash
-          ).returns(T.attached_class)
+          params(request_options: MetronomeSDK::RequestOptions::OrHash).returns(
+            T.attached_class
+          )
         end
-        def self.new(id:, request_options: {})
+        def self.new(request_options: {})
         end
 
         sig do
-          override.returns(
-            { id: String, request_options: MetronomeSDK::RequestOptions }
-          )
+          override.returns({ request_options: MetronomeSDK::RequestOptions })
         end
         def to_hash
         end

data/rbi/metronome_sdk/models/v1/customer_archive_response.rbi

@@ -12,54 +12,19 @@ module MetronomeSDK
             )
           end
 
-        sig { returns(MetronomeSDK::Models::V1::CustomerArchiveResponse::Data) }
+        sig { returns(MetronomeSDK::ID) }
         attr_reader :data
 
-        sig do
-          params(
-            data:
-              MetronomeSDK::Models::V1::CustomerArchiveResponse::Data::OrHash
-          ).void
-        end
+        sig { params(data: MetronomeSDK::ID::OrHash).void }
         attr_writer :data
 
-        sig do
-          params(
-            data:
-              MetronomeSDK::Models::V1::CustomerArchiveResponse::Data::OrHash
-          ).returns(T.attached_class)
-        end
+        sig { params(data: MetronomeSDK::ID::OrHash).returns(T.attached_class) }
         def self.new(data:)
         end
 
-        sig do
-          override.returns(
-            { data: MetronomeSDK::Models::V1::CustomerArchiveResponse::Data }
-          )
-        end
+        sig { override.returns({ data: MetronomeSDK::ID }) }
         def to_hash
         end
-
-        class Data < MetronomeSDK::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                MetronomeSDK::Models::V1::CustomerArchiveResponse::Data,
-                MetronomeSDK::Internal::AnyHash
-              )
-            end
-
-          sig { returns(String) }
-          attr_accessor :id
-
-          sig { params(id: String).returns(T.attached_class) }
-          def self.new(id:)
-          end
-
-          sig { override.returns({ id: String }) }
-          def to_hash
-          end
-        end
       end
     end
   end