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

data/lib/metronome_sdk/models/v1/credit_grant_create_params.rb

@@ -24,7 +24,7 @@ module MetronomeSDK
         #   the amount of credits granted
         #
         #   @return [MetronomeSDK::Models::V1::CreditGrantCreateParams::GrantAmount]
-        required :grant_amount, -> { MetronomeSDK::Models::V1::CreditGrantCreateParams::GrantAmount }
+        required :grant_amount, -> { MetronomeSDK::V1::CreditGrantCreateParams::GrantAmount }
 
         # @!attribute name
         #   the name of the credit grant as it will appear on invoices
@@ -36,7 +36,7 @@ module MetronomeSDK
         #   the amount paid for this credit grant
         #
         #   @return [MetronomeSDK::Models::V1::CreditGrantCreateParams::PaidAmount]
-        required :paid_amount, -> { MetronomeSDK::Models::V1::CreditGrantCreateParams::PaidAmount }
+        required :paid_amount, -> { MetronomeSDK::V1::CreditGrantCreateParams::PaidAmount }
 
         # @!attribute priority
         #
@@ -87,7 +87,7 @@ module MetronomeSDK
         #   Contact Metronome to be added to the beta.
         #
         #   @return [MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings, nil]
-        optional :rollover_settings, -> { MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings }
+        optional :rollover_settings, -> { MetronomeSDK::V1::CreditGrantCreateParams::RolloverSettings }
 
         # @!attribute uniqueness_key
         #   Prevents the creation of duplicates. If a request to create a record is made
@@ -104,7 +104,6 @@ module MetronomeSDK
         #   @param customer_id [String] the Metronome ID of the customer
         #
         #   @param expires_at [Time] The credit grant will only apply to usage or charges dated before this timestamp
-        #   ...
         #
         #   @param grant_amount [MetronomeSDK::Models::V1::CreditGrantCreateParams::GrantAmount] the amount of credits granted
         #
@@ -119,20 +118,16 @@ module MetronomeSDK
         #   @param custom_fields [Hash{Symbol=>String}] Custom fields to attach to the credit grant.
         #
         #   @param effective_at [Time] The credit grant will only apply to usage or charges dated on or after this time
-        #   ...
         #
         #   @param invoice_date [Time] The date to issue an invoice for the paid_amount.
         #
         #   @param product_ids [Array<String>] The product(s) which these credits will be applied to. (If unspecified, the cred
-        #   ...
         #
         #   @param reason [String]
         #
         #   @param rollover_settings [MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings] Configure a rollover for this credit grant so if it expires it rolls over a conf
-        #   ...
         #
         #   @param uniqueness_key [String] Prevents the creation of duplicates. If a request to create a record is made wit
-        #   ...
         #
         #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
 
@@ -193,9 +188,9 @@ module MetronomeSDK
           # @!attribute rollover_amount
           #   Specify how much to rollover to the rollover credit grant
           #
-          #   @return [MetronomeSDK::Models::V1::RolloverAmountMaxPercentage, MetronomeSDK::Models::V1::RolloverAmountMaxAmount]
+          #   @return [MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount::UnionMember0, MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount::UnionMember1]
           required :rollover_amount,
-                   union: -> { MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount }
+                   union: -> { MetronomeSDK::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount }
 
           # @!method initialize(expires_at:, priority:, rollover_amount:)
           #   Some parameter documentations has been truncated, see
@@ -209,9 +204,8 @@ module MetronomeSDK
           #   @param expires_at [Time] The date to expire the rollover credits.
           #
           #   @param priority [Float] The priority to give the rollover credit grant that gets created when a rollover
-          #   ...
           #
-          #   @param rollover_amount [MetronomeSDK::Models::V1::RolloverAmountMaxPercentage, MetronomeSDK::Models::V1::RolloverAmountMaxAmount] Specify how much to rollover to the rollover credit grant
+          #   @param rollover_amount [MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount::UnionMember0, MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount::UnionMember1] Specify how much to rollover to the rollover credit grant
 
           # Specify how much to rollover to the rollover credit grant
           #
@@ -219,12 +213,84 @@ module MetronomeSDK
           module RolloverAmount
             extend MetronomeSDK::Internal::Type::Union
 
-            variant -> { MetronomeSDK::Models::V1::RolloverAmountMaxPercentage }
+            variant -> {
+              MetronomeSDK::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount::UnionMember0
+            }
 
-            variant -> { MetronomeSDK::Models::V1::RolloverAmountMaxAmount }
+            variant -> {
+              MetronomeSDK::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount::UnionMember1
+            }
+
+            class UnionMember0 < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute type
+              #   Rollover up to a percentage of the original credit grant amount.
+              #
+              #   @return [Symbol, MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount::UnionMember0::Type]
+              required :type,
+                       enum: -> {
+                         MetronomeSDK::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount::UnionMember0::Type
+                       }
+
+              # @!attribute value
+              #   The maximum percentage (0-1) of the original credit grant to rollover.
+              #
+              #   @return [Float]
+              required :value, Float
+
+              # @!method initialize(type:, value:)
+              #   @param type [Symbol, MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount::UnionMember0::Type] Rollover up to a percentage of the original credit grant amount.
+              #
+              #   @param value [Float] The maximum percentage (0-1) of the original credit grant to rollover.
+
+              # Rollover up to a percentage of the original credit grant amount.
+              #
+              # @see MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount::UnionMember0#type
+              module Type
+                extend MetronomeSDK::Internal::Type::Enum
+
+                MAX_PERCENTAGE = :MAX_PERCENTAGE
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+
+            class UnionMember1 < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute type
+              #   Rollover up to a fixed amount of the original credit grant amount.
+              #
+              #   @return [Symbol, MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount::UnionMember1::Type]
+              required :type,
+                       enum: -> {
+                         MetronomeSDK::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount::UnionMember1::Type
+                       }
+
+              # @!attribute value
+              #   The maximum amount to rollover.
+              #
+              #   @return [Float]
+              required :value, Float
+
+              # @!method initialize(type:, value:)
+              #   @param type [Symbol, MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount::UnionMember1::Type] Rollover up to a fixed amount of the original credit grant amount.
+              #
+              #   @param value [Float] The maximum amount to rollover.
+
+              # Rollover up to a fixed amount of the original credit grant amount.
+              #
+              # @see MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount::UnionMember1#type
+              module Type
+                extend MetronomeSDK::Internal::Type::Enum
+
+                MAX_AMOUNT = :MAX_AMOUNT
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
 
             # @!method self.variants
-            #   @return [Array(MetronomeSDK::Models::V1::RolloverAmountMaxPercentage, MetronomeSDK::Models::V1::RolloverAmountMaxAmount)]
+            #   @return [Array(MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount::UnionMember0, MetronomeSDK::Models::V1::CreditGrantCreateParams::RolloverSettings::RolloverAmount::UnionMember1)]
           end
         end
       end

data/lib/metronome_sdk/models/v1/credit_grant_create_response.rb

@@ -7,11 +7,22 @@ module MetronomeSDK
       class CreditGrantCreateResponse < MetronomeSDK::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [MetronomeSDK::Models::ID]
-        required :data, -> { MetronomeSDK::Models::ID }
+        #   @return [MetronomeSDK::Models::V1::CreditGrantCreateResponse::Data]
+        required :data, -> { MetronomeSDK::Models::V1::CreditGrantCreateResponse::Data }
 
         # @!method initialize(data:)
-        #   @param data [MetronomeSDK::Models::ID]
+        #   @param data [MetronomeSDK::Models::V1::CreditGrantCreateResponse::Data]
+
+        # @see MetronomeSDK::Models::V1::CreditGrantCreateResponse#data
+        class Data < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!method initialize(id:)
+          #   @param id [String]
+        end
       end
     end
   end

data/lib/metronome_sdk/models/v1/credit_grant_edit_response.rb

@@ -7,11 +7,22 @@ module MetronomeSDK
       class CreditGrantEditResponse < MetronomeSDK::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [MetronomeSDK::Models::ID]
-        required :data, -> { MetronomeSDK::Models::ID }
+        #   @return [MetronomeSDK::Models::V1::CreditGrantEditResponse::Data]
+        required :data, -> { MetronomeSDK::Models::V1::CreditGrantEditResponse::Data }
 
         # @!method initialize(data:)
-        #   @param data [MetronomeSDK::Models::ID]
+        #   @param data [MetronomeSDK::Models::V1::CreditGrantEditResponse::Data]
+
+        # @see MetronomeSDK::Models::V1::CreditGrantEditResponse#data
+        class Data < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!method initialize(id:)
+          #   @param id [String]
+        end
       end
     end
   end

data/lib/metronome_sdk/models/v1/credit_grant_list_entries_params.rb

@@ -51,16 +51,12 @@ module MetronomeSDK
         #   @param next_page [String] Cursor that indicates where the next page of results should start.
         #
         #   @param credit_type_ids [Array<String>] A list of Metronome credit type IDs to fetch ledger entries for. If absent, ledg
-        #   ...
         #
         #   @param customer_ids [Array<String>] A list of Metronome customer IDs to fetch ledger entries for. If absent, ledger
-        #   ...
         #
         #   @param ending_before [Time] If supplied, ledger entries will only be returned with an effective_at before th
-        #   ...
         #
         #   @param starting_on [Time] If supplied, only ledger entries effective at or after this time will be returne
-        #   ...
         #
         #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/metronome_sdk/models/v1/credit_grant_list_entries_response.rb

@@ -39,8 +39,9 @@ module MetronomeSDK
           class Ledger < MetronomeSDK::Internal::Type::BaseModel
             # @!attribute credit_type
             #
-            #   @return [MetronomeSDK::Models::CreditTypeData]
-            required :credit_type, -> { MetronomeSDK::Models::CreditTypeData }
+            #   @return [MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::CreditType]
+            required :credit_type,
+                     -> { MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::CreditType }
 
             # @!attribute ending_balance
             #   the effective balances at the end of the specified time window
@@ -51,15 +52,15 @@ module MetronomeSDK
 
             # @!attribute entries
             #
-            #   @return [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
+            #   @return [Array<MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::Entry>]
             required :entries,
-                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::CreditLedgerEntry] }
+                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::Entry] }
 
             # @!attribute pending_entries
             #
-            #   @return [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
+            #   @return [Array<MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::PendingEntry>]
             required :pending_entries,
-                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::CreditLedgerEntry] }
+                     -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::PendingEntry] }
 
             # @!attribute starting_balance
             #
@@ -68,16 +69,33 @@ module MetronomeSDK
                      -> { MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::StartingBalance }
 
             # @!method initialize(credit_type:, ending_balance:, entries:, pending_entries:, starting_balance:)
-            #   @param credit_type [MetronomeSDK::Models::CreditTypeData]
+            #   @param credit_type [MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::CreditType]
             #
             #   @param ending_balance [MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::EndingBalance] the effective balances at the end of the specified time window
             #
-            #   @param entries [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
+            #   @param entries [Array<MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::Entry>]
             #
-            #   @param pending_entries [Array<MetronomeSDK::Models::V1::CreditLedgerEntry>]
+            #   @param pending_entries [Array<MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::PendingEntry>]
             #
             #   @param starting_balance [MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::StartingBalance]
 
+            # @see MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger#credit_type
+            class CreditType < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute id
+              #
+              #   @return [String]
+              required :id, String
+
+              # @!attribute name
+              #
+              #   @return [String]
+              required :name, String
+
+              # @!method initialize(id:, name:)
+              #   @param id [String]
+              #   @param name [String]
+            end
+
             # @see MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger#ending_balance
             class EndingBalance < MetronomeSDK::Internal::Type::BaseModel
               # @!attribute effective_at
@@ -110,13 +128,136 @@ module MetronomeSDK
               #   the effective balances at the end of the specified time window
               #
               #   @param effective_at [Time] the ending_before request parameter (if supplied) or the current billing period'
-              #   ...
               #
               #   @param excluding_pending [Float] the ending balance, including the balance of all grants that have not expired be
-              #   ...
               #
               #   @param including_pending [Float] the excluding_pending balance plus any pending invoice deductions and expiration
-              #   ...
+            end
+
+            class Entry < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute amount
+              #   an amount representing the change to the customer's credit balance
+              #
+              #   @return [Float]
+              required :amount, Float
+
+              # @!attribute created_by
+              #
+              #   @return [String]
+              required :created_by, String
+
+              # @!attribute credit_grant_id
+              #   the credit grant this entry is related to
+              #
+              #   @return [String]
+              required :credit_grant_id, String
+
+              # @!attribute effective_at
+              #
+              #   @return [Time]
+              required :effective_at, Time
+
+              # @!attribute reason
+              #
+              #   @return [String]
+              required :reason, String
+
+              # @!attribute running_balance
+              #   the running balance for this credit type at the time of the ledger entry,
+              #   including all preceding charges
+              #
+              #   @return [Float]
+              required :running_balance, Float
+
+              # @!attribute invoice_id
+              #   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
+              #
+              #   @return [String, nil]
+              optional :invoice_id, String, nil?: true
+
+              # @!method initialize(amount:, created_by:, credit_grant_id:, effective_at:, reason:, running_balance:, invoice_id: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::Entry}
+              #   for more details.
+              #
+              #   @param amount [Float] an amount representing the change to the customer's credit balance
+              #
+              #   @param created_by [String]
+              #
+              #   @param credit_grant_id [String] the credit grant this entry is related to
+              #
+              #   @param effective_at [Time]
+              #
+              #   @param reason [String]
+              #
+              #   @param running_balance [Float] the running balance for this credit type at the time of the ledger entry, includ
+              #
+              #   @param invoice_id [String, nil] if this entry is a deduction, the Metronome ID of the invoice where the credit d
+            end
+
+            class PendingEntry < MetronomeSDK::Internal::Type::BaseModel
+              # @!attribute amount
+              #   an amount representing the change to the customer's credit balance
+              #
+              #   @return [Float]
+              required :amount, Float
+
+              # @!attribute created_by
+              #
+              #   @return [String]
+              required :created_by, String
+
+              # @!attribute credit_grant_id
+              #   the credit grant this entry is related to
+              #
+              #   @return [String]
+              required :credit_grant_id, String
+
+              # @!attribute effective_at
+              #
+              #   @return [Time]
+              required :effective_at, Time
+
+              # @!attribute reason
+              #
+              #   @return [String]
+              required :reason, String
+
+              # @!attribute running_balance
+              #   the running balance for this credit type at the time of the ledger entry,
+              #   including all preceding charges
+              #
+              #   @return [Float]
+              required :running_balance, Float
+
+              # @!attribute invoice_id
+              #   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
+              #
+              #   @return [String, nil]
+              optional :invoice_id, String, nil?: true
+
+              # @!method initialize(amount:, created_by:, credit_grant_id:, effective_at:, reason:, running_balance:, invoice_id: nil)
+              #   Some parameter documentations has been truncated, see
+              #   {MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger::PendingEntry}
+              #   for more details.
+              #
+              #   @param amount [Float] an amount representing the change to the customer's credit balance
+              #
+              #   @param created_by [String]
+              #
+              #   @param credit_grant_id [String] the credit grant this entry is related to
+              #
+              #   @param effective_at [Time]
+              #
+              #   @param reason [String]
+              #
+              #   @param running_balance [Float] the running balance for this credit type at the time of the ledger entry, includ
+              #
+              #   @param invoice_id [String, nil] if this entry is a deduction, the Metronome ID of the invoice where the credit d
             end
 
             # @see MetronomeSDK::Models::V1::CreditGrantListEntriesResponse::Data::Ledger#starting_balance
@@ -148,13 +289,10 @@ module MetronomeSDK
               #   for more details.
               #
               #   @param effective_at [Time] the starting_on request parameter (if supplied) or the first credit grant's effe
-              #   ...
               #
               #   @param excluding_pending [Float] the starting balance, including all posted grants, deductions, and expirations t
-              #   ...
               #
               #   @param including_pending [Float] the excluding_pending balance plus any pending activity that has not been posted
-              #   ...
             end
           end
         end

data/lib/metronome_sdk/models/v1/credit_grant_list_params.rb

@@ -62,13 +62,10 @@ module MetronomeSDK
         #   @param next_page [String] Cursor that indicates where the next page of results should start.
         #
         #   @param credit_grant_ids [Array<String>] An array of credit grant IDs. If this is specified, neither credit_type_ids nor
-        #   ...
         #
         #   @param credit_type_ids [Array<String>] An array of credit type IDs. This must not be specified if credit_grant_ids is s
-        #   ...
         #
         #   @param customer_ids [Array<String>] An array of Metronome customer IDs. This must not be specified if credit_grant_i
-        #   ...
         #
         #   @param effective_before [Time] Only return credit grants that are effective before this timestamp (exclusive).
         #