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

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

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

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      class CreditLedgerEntry < 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::CreditLedgerEntry} 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
+    end
+  end
+end

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      class Customer < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #   the Metronome ID of the customer
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute external_id
+        #   (deprecated, use ingest_aliases instead) the first ID (Metronome or ingest
+        #   alias) that can be used in usage events
+        #
+        #   @return [String]
+        required :external_id, String
+
+        # @!attribute ingest_aliases
+        #   aliases for this customer that can be used instead of the Metronome customer ID
+        #   in usage events
+        #
+        #   @return [Array<String>]
+        required :ingest_aliases, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+        # @!attribute name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute custom_fields
+        #
+        #   @return [Hash{Symbol=>String}, nil]
+        optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
+
+        # @!method initialize(id:, external_id:, ingest_aliases:, name:, custom_fields: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::V1::Customer} for more details.
+        #
+        #   @param id [String] the Metronome ID of the customer
+        #
+        #   @param external_id [String] (deprecated, use ingest_aliases instead) the first ID (Metronome or ingest alias
+        #
+        #   @param ingest_aliases [Array<String>] aliases for this customer that can be used instead of the Metronome customer ID
+        #
+        #   @param name [String]
+        #
+        #   @param custom_fields [Hash{Symbol=>String}]
+      end
+    end
+  end
+end

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

@@ -4,17 +4,11 @@ module MetronomeSDK
   module Models
     module V1
       # @see MetronomeSDK::Resources::V1::Customers#archive
-      class CustomerArchiveParams < MetronomeSDK::Internal::Type::BaseModel
+      class CustomerArchiveParams < MetronomeSDK::Models::ID
         extend MetronomeSDK::Internal::Type::RequestParameters::Converter
         include MetronomeSDK::Internal::Type::RequestParameters
 
-        # @!attribute id
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!method initialize(id:, request_options: {})
-        #   @param id [String]
+        # @!method initialize(request_options: {})
         #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
       end
     end

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

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

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

@@ -7,58 +7,11 @@ module MetronomeSDK
       class CustomerCreateResponse < MetronomeSDK::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [MetronomeSDK::Models::V1::CustomerCreateResponse::Data]
-        required :data, -> { MetronomeSDK::Models::V1::CustomerCreateResponse::Data }
+        #   @return [MetronomeSDK::Models::V1::Customer]
+        required :data, -> { MetronomeSDK::V1::Customer }
 
         # @!method initialize(data:)
-        #   @param data [MetronomeSDK::Models::V1::CustomerCreateResponse::Data]
-
-        # @see MetronomeSDK::Models::V1::CustomerCreateResponse#data
-        class Data < MetronomeSDK::Internal::Type::BaseModel
-          # @!attribute id
-          #   the Metronome ID of the customer
-          #
-          #   @return [String]
-          required :id, String
-
-          # @!attribute external_id
-          #   (deprecated, use ingest_aliases instead) the first ID (Metronome or ingest
-          #   alias) that can be used in usage events
-          #
-          #   @return [String]
-          required :external_id, String
-
-          # @!attribute ingest_aliases
-          #   aliases for this customer that can be used instead of the Metronome customer ID
-          #   in usage events
-          #
-          #   @return [Array<String>]
-          required :ingest_aliases, MetronomeSDK::Internal::Type::ArrayOf[String]
-
-          # @!attribute name
-          #
-          #   @return [String]
-          required :name, String
-
-          # @!attribute custom_fields
-          #
-          #   @return [Hash{Symbol=>String}, nil]
-          optional :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
-
-          # @!method initialize(id:, external_id:, ingest_aliases:, name:, custom_fields: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {MetronomeSDK::Models::V1::CustomerCreateResponse::Data} for more details.
-          #
-          #   @param id [String] the Metronome ID of the customer
-          #
-          #   @param external_id [String] (deprecated, use ingest_aliases instead) the first ID (Metronome or ingest alias
-          #
-          #   @param ingest_aliases [Array<String>] aliases for this customer that can be used instead of the Metronome customer ID
-          #
-          #   @param name [String]
-          #
-          #   @param custom_fields [Hash{Symbol=>String}]
-        end
+        #   @param data [MetronomeSDK::Models::V1::Customer]
       end
     end
   end

data/lib/metronome_sdk/models/v1/{customer_list_response.rb → customer_detail.rb}

@@ -4,7 +4,7 @@ module MetronomeSDK
   module Models
     module V1
       # @see MetronomeSDK::Resources::V1::Customers#list
-      class CustomerListResponse < MetronomeSDK::Internal::Type::BaseModel
+      class CustomerDetail < MetronomeSDK::Internal::Type::BaseModel
         # @!attribute id
         #   the Metronome ID of the customer
         #
@@ -24,8 +24,8 @@ module MetronomeSDK
 
         # @!attribute customer_config
         #
-        #   @return [MetronomeSDK::Models::V1::CustomerListResponse::CustomerConfig]
-        required :customer_config, -> { MetronomeSDK::Models::V1::CustomerListResponse::CustomerConfig }
+        #   @return [MetronomeSDK::Models::V1::CustomerDetail::CustomerConfig]
+        required :customer_config, -> { MetronomeSDK::V1::CustomerDetail::CustomerConfig }
 
         # @!attribute external_id
         #   (deprecated, use ingest_aliases instead) the first ID (Metronome or ingest
@@ -56,13 +56,12 @@ module MetronomeSDK
         # @!attribute current_billable_status
         #   This field's availability is dependent on your client's configuration.
         #
-        #   @return [MetronomeSDK::Models::V1::CustomerListResponse::CurrentBillableStatus, nil]
-        optional :current_billable_status,
-                 -> { MetronomeSDK::Models::V1::CustomerListResponse::CurrentBillableStatus }
+        #   @return [MetronomeSDK::Models::V1::CustomerDetail::CurrentBillableStatus, nil]
+        optional :current_billable_status, -> { MetronomeSDK::V1::CustomerDetail::CurrentBillableStatus }
 
         # @!method initialize(id:, created_at:, custom_fields:, customer_config:, external_id:, ingest_aliases:, name:, archived_at: nil, current_billable_status: nil)
         #   Some parameter documentations has been truncated, see
-        #   {MetronomeSDK::Models::V1::CustomerListResponse} for more details.
+        #   {MetronomeSDK::Models::V1::CustomerDetail} for more details.
         #
         #   @param id [String] the Metronome ID of the customer
         #
@@ -70,7 +69,7 @@ module MetronomeSDK
         #
         #   @param custom_fields [Hash{Symbol=>String}]
         #
-        #   @param customer_config [MetronomeSDK::Models::V1::CustomerListResponse::CustomerConfig]
+        #   @param customer_config [MetronomeSDK::Models::V1::CustomerDetail::CustomerConfig]
         #
         #   @param external_id [String] (deprecated, use ingest_aliases instead) the first ID (Metronome or ingest alias
         #
@@ -80,9 +79,9 @@ module MetronomeSDK
         #
         #   @param archived_at [Time, nil] RFC 3339 timestamp indicating when the customer was archived. Null if the custom
         #
-        #   @param current_billable_status [MetronomeSDK::Models::V1::CustomerListResponse::CurrentBillableStatus] This field's availability is dependent on your client's configuration.
+        #   @param current_billable_status [MetronomeSDK::Models::V1::CustomerDetail::CurrentBillableStatus] This field's availability is dependent on your client's configuration.
 
-        # @see MetronomeSDK::Models::V1::CustomerListResponse#customer_config
+        # @see MetronomeSDK::Models::V1::CustomerDetail#customer_config
         class CustomerConfig < MetronomeSDK::Internal::Type::BaseModel
           # @!attribute salesforce_account_id
           #   The Salesforce account ID for the customer
@@ -94,12 +93,12 @@ module MetronomeSDK
           #   @param salesforce_account_id [String, nil] The Salesforce account ID for the customer
         end
 
-        # @see MetronomeSDK::Models::V1::CustomerListResponse#current_billable_status
+        # @see MetronomeSDK::Models::V1::CustomerDetail#current_billable_status
         class CurrentBillableStatus < MetronomeSDK::Internal::Type::BaseModel
           # @!attribute value
           #
-          #   @return [Symbol, MetronomeSDK::Models::V1::CustomerListResponse::CurrentBillableStatus::Value]
-          required :value, enum: -> { MetronomeSDK::Models::V1::CustomerListResponse::CurrentBillableStatus::Value }
+          #   @return [Symbol, MetronomeSDK::Models::V1::CustomerDetail::CurrentBillableStatus::Value]
+          required :value, enum: -> { MetronomeSDK::V1::CustomerDetail::CurrentBillableStatus::Value }
 
           # @!attribute effective_at
           #
@@ -109,10 +108,10 @@ module MetronomeSDK
           # @!method initialize(value:, effective_at: nil)
           #   This field's availability is dependent on your client's configuration.
           #
-          #   @param value [Symbol, MetronomeSDK::Models::V1::CustomerListResponse::CurrentBillableStatus::Value]
+          #   @param value [Symbol, MetronomeSDK::Models::V1::CustomerDetail::CurrentBillableStatus::Value]
           #   @param effective_at [Time, nil]
 
-          # @see MetronomeSDK::Models::V1::CustomerListResponse::CurrentBillableStatus#value
+          # @see MetronomeSDK::Models::V1::CustomerDetail::CurrentBillableStatus#value
           module Value
             extend MetronomeSDK::Internal::Type::Enum
 

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

@@ -57,9 +57,8 @@ module MetronomeSDK
         # @!attribute event_type_filter
         #   An optional filtering rule to match the 'event_type' property of an event.
         #
-        #   @return [MetronomeSDK::Models::V1::CustomerListBillableMetricsResponse::EventTypeFilter, nil]
-        optional :event_type_filter,
-                 -> { MetronomeSDK::Models::V1::CustomerListBillableMetricsResponse::EventTypeFilter }
+        #   @return [MetronomeSDK::Models::EventTypeFilter, nil]
+        optional :event_type_filter, -> { MetronomeSDK::EventTypeFilter }
 
         # @!attribute filter
         #   (DEPRECATED) use property_filters & event_type_filter instead
@@ -86,9 +85,8 @@ module MetronomeSDK
         #   rule on an event property. All rules must pass for the event to match the
         #   billable metric.
         #
-        #   @return [Array<MetronomeSDK::Models::V1::CustomerListBillableMetricsResponse::PropertyFilter>, nil]
-        optional :property_filters,
-                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::CustomerListBillableMetricsResponse::PropertyFilter] }
+        #   @return [Array<MetronomeSDK::Models::PropertyFilter>, nil]
+        optional :property_filters, -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::PropertyFilter] }
 
         # @!attribute sql
         #   The SQL query associated with the billable metric
@@ -117,7 +115,7 @@ module MetronomeSDK
         #
         #   @param custom_fields [Hash{Symbol=>String}]
         #
-        #   @param event_type_filter [MetronomeSDK::Models::V1::CustomerListBillableMetricsResponse::EventTypeFilter] An optional filtering rule to match the 'event_type' property of an event.
+        #   @param event_type_filter [MetronomeSDK::Models::EventTypeFilter] An optional filtering rule to match the 'event_type' property of an event.
         #
         #   @param filter [Hash{Symbol=>Object}] (DEPRECATED) use property_filters & event_type_filter instead
         #
@@ -125,7 +123,7 @@ module MetronomeSDK
         #
         #   @param group_keys [Array<Array<String>>] Property names that are used to group usage costs on an invoice. Each entry repr
         #
-        #   @param property_filters [Array<MetronomeSDK::Models::V1::CustomerListBillableMetricsResponse::PropertyFilter>] A list of filters to match events to this billable metric. Each filter defines a
+        #   @param property_filters [Array<MetronomeSDK::Models::PropertyFilter>] A list of filters to match events to this billable metric. Each filter defines a
         #
         #   @param sql [String] The SQL query associated with the billable metric
 
@@ -144,84 +142,6 @@ module MetronomeSDK
           # @!method self.values
           #   @return [Array<Symbol>]
         end
-
-        # @see MetronomeSDK::Models::V1::CustomerListBillableMetricsResponse#event_type_filter
-        class EventTypeFilter < MetronomeSDK::Internal::Type::BaseModel
-          # @!attribute in_values
-          #   A list of event types that are explicitly included in the billable metric. If
-          #   specified, only events of these types will match the billable metric. Must be
-          #   non-empty if present.
-          #
-          #   @return [Array<String>, nil]
-          optional :in_values, MetronomeSDK::Internal::Type::ArrayOf[String]
-
-          # @!attribute not_in_values
-          #   A list of event types that are explicitly excluded from the billable metric. If
-          #   specified, events of these types will not match the billable metric. Must be
-          #   non-empty if present.
-          #
-          #   @return [Array<String>, nil]
-          optional :not_in_values, MetronomeSDK::Internal::Type::ArrayOf[String]
-
-          # @!method initialize(in_values: nil, not_in_values: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {MetronomeSDK::Models::V1::CustomerListBillableMetricsResponse::EventTypeFilter}
-          #   for more details.
-          #
-          #   An optional filtering rule to match the 'event_type' property of an event.
-          #
-          #   @param in_values [Array<String>] A list of event types that are explicitly included in the billable metric. If sp
-          #
-          #   @param not_in_values [Array<String>] A list of event types that are explicitly excluded from the billable metric. If
-        end
-
-        class PropertyFilter < MetronomeSDK::Internal::Type::BaseModel
-          # @!attribute name
-          #   The name of the event property.
-          #
-          #   @return [String]
-          required :name, String
-
-          # @!attribute exists
-          #   Determines whether the property must exist in the event. If true, only events
-          #   with this property will pass the filter. If false, only events without this
-          #   property will pass the filter. If null or omitted, the existence of the property
-          #   is optional.
-          #
-          #   @return [Boolean, nil]
-          optional :exists, MetronomeSDK::Internal::Type::Boolean
-
-          # @!attribute in_values
-          #   Specifies the allowed values for the property to match an event. An event will
-          #   pass the filter only if its property value is included in this list. If
-          #   undefined, all property values will pass the filter. Must be non-empty if
-          #   present.
-          #
-          #   @return [Array<String>, nil]
-          optional :in_values, MetronomeSDK::Internal::Type::ArrayOf[String]
-
-          # @!attribute not_in_values
-          #   Specifies the values that prevent an event from matching the filter. An event
-          #   will not pass the filter if its property value is included in this list. If null
-          #   or empty, all property values will pass the filter. Must be non-empty if
-          #   present.
-          #
-          #   @return [Array<String>, nil]
-          optional :not_in_values, MetronomeSDK::Internal::Type::ArrayOf[String]
-
-          # @!method initialize(name:, exists: nil, in_values: nil, not_in_values: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {MetronomeSDK::Models::V1::CustomerListBillableMetricsResponse::PropertyFilter}
-          #   for more details.
-          #
-          #   @param name [String] The name of the event property.
-          #
-          #   @param exists [Boolean] Determines whether the property must exist in the event. If true, only events wi
-          #
-          #   @param in_values [Array<String>] Specifies the allowed values for the property to match an event. An event will p
-          #
-          #   @param not_in_values [Array<String>] Specifies the values that prevent an event from matching the filter. An event wi
-        end
       end
     end
   end

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

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Customers#preview_events
+      class CustomerPreviewEventsParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        # @!attribute customer_id
+        #
+        #   @return [String]
+        required :customer_id, String
+
+        # @!attribute events
+        #
+        #   @return [Array<MetronomeSDK::Models::V1::CustomerPreviewEventsParams::Event>]
+        required :events,
+                 -> {
+                   MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::V1::CustomerPreviewEventsParams::Event]
+                 }
+
+        # @!attribute mode
+        #   If set to "replace", the preview will be generated as if those were the only
+        #   events for the specified customer. If set to "merge", the events will be merged
+        #   with any existing events for the specified customer. Defaults to "replace".
+        #
+        #   @return [Symbol, MetronomeSDK::Models::V1::CustomerPreviewEventsParams::Mode, nil]
+        optional :mode, enum: -> { MetronomeSDK::V1::CustomerPreviewEventsParams::Mode }
+
+        # @!attribute skip_zero_qty_line_items
+        #   If set, all zero quantity line items will be filtered out of the response.
+        #
+        #   @return [Boolean, nil]
+        optional :skip_zero_qty_line_items, MetronomeSDK::Internal::Type::Boolean
+
+        # @!method initialize(customer_id:, events:, mode: nil, skip_zero_qty_line_items: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::V1::CustomerPreviewEventsParams} for more details.
+        #
+        #   @param customer_id [String]
+        #
+        #   @param events [Array<MetronomeSDK::Models::V1::CustomerPreviewEventsParams::Event>]
+        #
+        #   @param mode [Symbol, MetronomeSDK::Models::V1::CustomerPreviewEventsParams::Mode] If set to "replace", the preview will be generated as if those were the only eve
+        #
+        #   @param skip_zero_qty_line_items [Boolean] If set, all zero quantity line items will be filtered out of the response.
+        #
+        #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+
+        class Event < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute event_type
+          #
+          #   @return [String]
+          required :event_type, String
+
+          # @!attribute customer_id
+          #   This has no effect for preview events, but may be set for consistency with Event
+          #   objects. They will be processed even if they do not match the customer's ID or
+          #   ingest aliases.
+          #
+          #   @return [String, nil]
+          optional :customer_id, String
+
+          # @!attribute properties
+          #
+          #   @return [Hash{Symbol=>Object}, nil]
+          optional :properties, MetronomeSDK::Internal::Type::HashOf[MetronomeSDK::Internal::Type::Unknown]
+
+          # @!attribute timestamp
+          #   RFC 3339 formatted. If not provided, the current time will be used.
+          #
+          #   @return [String, nil]
+          optional :timestamp, String
+
+          # @!attribute transaction_id
+          #   This has no effect for preview events, but may be set for consistency with Event
+          #   objects. Duplicate transaction_ids are NOT filtered out, even within the same
+          #   request.
+          #
+          #   @return [String, nil]
+          optional :transaction_id, String
+
+          # @!method initialize(event_type:, customer_id: nil, properties: nil, timestamp: nil, transaction_id: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V1::CustomerPreviewEventsParams::Event} for more details.
+          #
+          #   @param event_type [String]
+          #
+          #   @param customer_id [String] This has no effect for preview events, but may be set for consistency with Event
+          #
+          #   @param properties [Hash{Symbol=>Object}]
+          #
+          #   @param timestamp [String] RFC 3339 formatted. If not provided, the current time will be used.
+          #
+          #   @param transaction_id [String] This has no effect for preview events, but may be set for consistency with Event
+        end
+
+        # If set to "replace", the preview will be generated as if those were the only
+        # events for the specified customer. If set to "merge", the events will be merged
+        # with any existing events for the specified customer. Defaults to "replace".
+        module Mode
+          extend MetronomeSDK::Internal::Type::Enum
+
+          REPLACE = :replace
+          MERGE = :merge
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Customers#preview_events
+      class CustomerPreviewEventsResponse < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [MetronomeSDK::Models::V1::Customers::Invoice]
+        required :data, -> { MetronomeSDK::V1::Customers::Invoice }
+
+        # @!method initialize(data:)
+        #   @param data [MetronomeSDK::Models::V1::Customers::Invoice]
+      end
+    end
+  end
+end