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

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

@@ -57,8 +57,9 @@ module MetronomeSDK
         # @!attribute event_type_filter
         #   An optional filtering rule to match the 'event_type' property of an event.
         #
-        #   @return [MetronomeSDK::Models::EventTypeFilter, nil]
-        optional :event_type_filter, -> { MetronomeSDK::Models::EventTypeFilter }
+        #   @return [MetronomeSDK::Models::V1::CustomerListBillableMetricsResponse::EventTypeFilter, nil]
+        optional :event_type_filter,
+                 -> { MetronomeSDK::Models::V1::CustomerListBillableMetricsResponse::EventTypeFilter }
 
         # @!attribute filter
         #   (DEPRECATED) use property_filters & event_type_filter instead
@@ -85,9 +86,9 @@ module MetronomeSDK
         #   rule on an event property. All rules must pass for the event to match the
         #   billable metric.
         #
-        #   @return [Array<MetronomeSDK::Models::PropertyFilter>, nil]
+        #   @return [Array<MetronomeSDK::Models::V1::CustomerListBillableMetricsResponse::PropertyFilter>, nil]
         optional :property_filters,
-                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::PropertyFilter] }
+                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::CustomerListBillableMetricsResponse::PropertyFilter] }
 
         # @!attribute sql
         #   The SQL query associated with the billable metric
@@ -109,26 +110,22 @@ module MetronomeSDK
         #   @param aggregate_keys [Array<String>] (DEPRECATED) use aggregation_key instead
         #
         #   @param aggregation_key [String] A key that specifies which property of the event is used to aggregate data. This
-        #   ...
         #
         #   @param aggregation_type [Symbol, MetronomeSDK::Models::V1::CustomerListBillableMetricsResponse::AggregationType] Specifies the type of aggregation performed on matching events.
         #
         #   @param archived_at [Time] RFC 3339 timestamp indicating when the billable metric was archived. If not prov
-        #   ...
         #
         #   @param custom_fields [Hash{Symbol=>String}]
         #
-        #   @param event_type_filter [MetronomeSDK::Models::EventTypeFilter] An optional filtering rule to match the 'event_type' property of an event.
+        #   @param event_type_filter [MetronomeSDK::Models::V1::CustomerListBillableMetricsResponse::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
         #
         #   @param group_by [Array<String>] (DEPRECATED) use group_keys instead
         #
         #   @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::PropertyFilter>] A list of filters to match events to this billable metric. Each filter defines a
-        #   ...
+        #   @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 sql [String] The SQL query associated with the billable metric
 
@@ -147,6 +144,84 @@ 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_list_params.rb

@@ -59,10 +59,8 @@ module MetronomeSDK
         #   @param next_page [String] Cursor that indicates where the next page of results should start.
         #
         #   @param only_archived [Boolean] Filter the customer list to only return archived customers. By default, only act
-        #   ...
         #
         #   @param salesforce_account_ids [Array<String>] Filter the customer list by salesforce_account_id. Up to 100 ids can be provide
-        #   ...
         #
         #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
       end

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

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

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

@@ -7,11 +7,134 @@ module MetronomeSDK
       class CustomerRetrieveResponse < MetronomeSDK::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [MetronomeSDK::Models::V1::CustomerDetail]
-        required :data, -> { MetronomeSDK::Models::V1::CustomerDetail }
+        #   @return [MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data]
+        required :data, -> { MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data }
 
         # @!method initialize(data:)
-        #   @param data [MetronomeSDK::Models::V1::CustomerDetail]
+        #   @param data [MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data]
+
+        # @see MetronomeSDK::Models::V1::CustomerRetrieveResponse#data
+        class Data < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #   the Metronome ID of the customer
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute created_at
+          #   RFC 3339 timestamp indicating when the customer was created.
+          #
+          #   @return [Time]
+          required :created_at, Time
+
+          # @!attribute custom_fields
+          #
+          #   @return [Hash{Symbol=>String}]
+          required :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
+
+          # @!attribute customer_config
+          #
+          #   @return [MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CustomerConfig]
+          required :customer_config, -> { MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CustomerConfig }
+
+          # @!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 archived_at
+          #   RFC 3339 timestamp indicating when the customer was archived. Null if the
+          #   customer is active.
+          #
+          #   @return [Time, nil]
+          optional :archived_at, Time, nil?: true
+
+          # @!attribute current_billable_status
+          #   This field's availability is dependent on your client's configuration.
+          #
+          #   @return [MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CurrentBillableStatus, nil]
+          optional :current_billable_status,
+                   -> { MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::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::CustomerRetrieveResponse::Data} for more details.
+          #
+          #   @param id [String] the Metronome ID of the customer
+          #
+          #   @param created_at [Time] RFC 3339 timestamp indicating when the customer was created.
+          #
+          #   @param custom_fields [Hash{Symbol=>String}]
+          #
+          #   @param customer_config [MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CustomerConfig]
+          #
+          #   @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 archived_at [Time, nil] RFC 3339 timestamp indicating when the customer was archived. Null if the custom
+          #
+          #   @param current_billable_status [MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CurrentBillableStatus] This field's availability is dependent on your client's configuration.
+
+          # @see MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data#customer_config
+          class CustomerConfig < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute salesforce_account_id
+            #   The Salesforce account ID for the customer
+            #
+            #   @return [String, nil]
+            required :salesforce_account_id, String, nil?: true
+
+            # @!method initialize(salesforce_account_id:)
+            #   @param salesforce_account_id [String, nil] The Salesforce account ID for the customer
+          end
+
+          # @see MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data#current_billable_status
+          class CurrentBillableStatus < MetronomeSDK::Internal::Type::BaseModel
+            # @!attribute value
+            #
+            #   @return [Symbol, MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CurrentBillableStatus::Value]
+            required :value,
+                     enum: -> { MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CurrentBillableStatus::Value }
+
+            # @!attribute effective_at
+            #
+            #   @return [Time, nil]
+            optional :effective_at, Time, nil?: true
+
+            # @!method initialize(value:, effective_at: nil)
+            #   This field's availability is dependent on your client's configuration.
+            #
+            #   @param value [Symbol, MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CurrentBillableStatus::Value]
+            #   @param effective_at [Time, nil]
+
+            # @see MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CurrentBillableStatus#value
+            module Value
+              extend MetronomeSDK::Internal::Type::Enum
+
+              BILLABLE = :billable
+              UNBILLABLE = :unbillable
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+        end
       end
     end
   end

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

@@ -27,7 +27,6 @@ module MetronomeSDK
         #   @param customer_id [String]
         #
         #   @param name [String] The new name for the customer. This will be truncated to 160 characters if the p
-        #   ...
         #
         #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
       end

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

@@ -7,11 +7,58 @@ module MetronomeSDK
       class CustomerSetNameResponse < MetronomeSDK::Internal::Type::BaseModel
         # @!attribute data
         #
-        #   @return [MetronomeSDK::Models::V1::Customer]
-        required :data, -> { MetronomeSDK::Models::V1::Customer }
+        #   @return [MetronomeSDK::Models::V1::CustomerSetNameResponse::Data]
+        required :data, -> { MetronomeSDK::Models::V1::CustomerSetNameResponse::Data }
 
         # @!method initialize(data:)
-        #   @param data [MetronomeSDK::Models::V1::Customer]
+        #   @param data [MetronomeSDK::Models::V1::CustomerSetNameResponse::Data]
+
+        # @see MetronomeSDK::Models::V1::CustomerSetNameResponse#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::CustomerSetNameResponse::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
       end
     end
   end

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

@@ -33,7 +33,6 @@ module MetronomeSDK
         #   @param customer_id [String]
         #
         #   @param leave_stripe_invoices_in_draft [Boolean, nil] Leave in draft or set to auto-advance on invoices sent to Stripe. Falls back to
-        #   ...
         #
         #   @param salesforce_account_id [String, nil] The Salesforce account ID for the customer
         #

data/lib/metronome_sdk/models/v1/customers/alert_list_params.rb

@@ -27,7 +27,9 @@ module MetronomeSDK
           #
           #   @return [Array<Symbol, MetronomeSDK::Models::V1::Customers::AlertListParams::AlertStatus>, nil]
           optional :alert_statuses,
-                   -> { MetronomeSDK::Internal::Type::ArrayOf[enum: MetronomeSDK::Models::V1::Customers::AlertListParams::AlertStatus] }
+                   -> {
+                     MetronomeSDK::Internal::Type::ArrayOf[enum: MetronomeSDK::V1::Customers::AlertListParams::AlertStatus]
+                   }
 
           # @!method initialize(customer_id:, next_page: nil, alert_statuses: nil, request_options: {})
           #   Some parameter documentations has been truncated, see
@@ -38,7 +40,6 @@ module MetronomeSDK
           #   @param next_page [String] Cursor that indicates where the next page of results should start.
           #
           #   @param alert_statuses [Array<Symbol, MetronomeSDK::Models::V1::Customers::AlertListParams::AlertStatus>] Optionally filter by alert status. If absent, only enabled alerts will be return
-          #   ...
           #
           #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]