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

data/rbi/metronome_sdk/models/v1/customer_preview_events_params.rbi

@@ -0,0 +1,214 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class CustomerPreviewEventsParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::V1::CustomerPreviewEventsParams,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :customer_id
+
+        sig do
+          returns(
+            T::Array[MetronomeSDK::V1::CustomerPreviewEventsParams::Event]
+          )
+        end
+        attr_accessor :events
+
+        # 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".
+        sig do
+          returns(
+            T.nilable(
+              MetronomeSDK::V1::CustomerPreviewEventsParams::Mode::OrSymbol
+            )
+          )
+        end
+        attr_reader :mode
+
+        sig do
+          params(
+            mode: MetronomeSDK::V1::CustomerPreviewEventsParams::Mode::OrSymbol
+          ).void
+        end
+        attr_writer :mode
+
+        # If set, all zero quantity line items will be filtered out of the response.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :skip_zero_qty_line_items
+
+        sig { params(skip_zero_qty_line_items: T::Boolean).void }
+        attr_writer :skip_zero_qty_line_items
+
+        sig do
+          params(
+            customer_id: String,
+            events:
+              T::Array[
+                MetronomeSDK::V1::CustomerPreviewEventsParams::Event::OrHash
+              ],
+            mode: MetronomeSDK::V1::CustomerPreviewEventsParams::Mode::OrSymbol,
+            skip_zero_qty_line_items: T::Boolean,
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          customer_id:,
+          events:,
+          # 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".
+          mode: nil,
+          # If set, all zero quantity line items will be filtered out of the response.
+          skip_zero_qty_line_items: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              customer_id: String,
+              events:
+                T::Array[MetronomeSDK::V1::CustomerPreviewEventsParams::Event],
+              mode:
+                MetronomeSDK::V1::CustomerPreviewEventsParams::Mode::OrSymbol,
+              skip_zero_qty_line_items: T::Boolean,
+              request_options: MetronomeSDK::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Event < MetronomeSDK::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                MetronomeSDK::V1::CustomerPreviewEventsParams::Event,
+                MetronomeSDK::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :event_type
+
+          # 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.
+          sig { returns(T.nilable(String)) }
+          attr_reader :customer_id
+
+          sig { params(customer_id: String).void }
+          attr_writer :customer_id
+
+          sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+          attr_reader :properties
+
+          sig { params(properties: T::Hash[Symbol, T.anything]).void }
+          attr_writer :properties
+
+          # RFC 3339 formatted. If not provided, the current time will be used.
+          sig { returns(T.nilable(String)) }
+          attr_reader :timestamp
+
+          sig { params(timestamp: String).void }
+          attr_writer :timestamp
+
+          # 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.
+          sig { returns(T.nilable(String)) }
+          attr_reader :transaction_id
+
+          sig { params(transaction_id: String).void }
+          attr_writer :transaction_id
+
+          sig do
+            params(
+              event_type: String,
+              customer_id: String,
+              properties: T::Hash[Symbol, T.anything],
+              timestamp: String,
+              transaction_id: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            event_type:,
+            # 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.
+            customer_id: nil,
+            properties: nil,
+            # RFC 3339 formatted. If not provided, the current time will be used.
+            timestamp: nil,
+            # 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.
+            transaction_id: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                event_type: String,
+                customer_id: String,
+                properties: T::Hash[Symbol, T.anything],
+                timestamp: String,
+                transaction_id: String
+              }
+            )
+          end
+          def to_hash
+          end
+        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
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, MetronomeSDK::V1::CustomerPreviewEventsParams::Mode)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          REPLACE =
+            T.let(
+              :replace,
+              MetronomeSDK::V1::CustomerPreviewEventsParams::Mode::TaggedSymbol
+            )
+          MERGE =
+            T.let(
+              :merge,
+              MetronomeSDK::V1::CustomerPreviewEventsParams::Mode::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                MetronomeSDK::V1::CustomerPreviewEventsParams::Mode::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/customer_preview_events_response.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class CustomerPreviewEventsResponse < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::Models::V1::CustomerPreviewEventsResponse,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        sig { returns(MetronomeSDK::V1::Customers::Invoice) }
+        attr_reader :data
+
+        sig { params(data: MetronomeSDK::V1::Customers::Invoice::OrHash).void }
+        attr_writer :data
+
+        sig do
+          params(data: MetronomeSDK::V1::Customers::Invoice::OrHash).returns(
+            T.attached_class
+          )
+        end
+        def self.new(data:)
+        end
+
+        sig { override.returns({ data: MetronomeSDK::V1::Customers::Invoice }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/customer_retrieve_response.rbi

@@ -12,272 +12,23 @@ module MetronomeSDK
             )
           end
 
-        sig do
-          returns(MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data)
-        end
+        sig { returns(MetronomeSDK::V1::CustomerDetail) }
         attr_reader :data
 
-        sig do
-          params(
-            data:
-              MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::OrHash
-          ).void
-        end
+        sig { params(data: MetronomeSDK::V1::CustomerDetail::OrHash).void }
         attr_writer :data
 
         sig do
-          params(
-            data:
-              MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::OrHash
-          ).returns(T.attached_class)
+          params(data: MetronomeSDK::V1::CustomerDetail::OrHash).returns(
+            T.attached_class
+          )
         end
         def self.new(data:)
         end
 
-        sig do
-          override.returns(
-            { data: MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data }
-          )
-        end
+        sig { override.returns({ data: MetronomeSDK::V1::CustomerDetail }) }
         def to_hash
         end
-
-        class Data < MetronomeSDK::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data,
-                MetronomeSDK::Internal::AnyHash
-              )
-            end
-
-          # the Metronome ID of the customer
-          sig { returns(String) }
-          attr_accessor :id
-
-          # RFC 3339 timestamp indicating when the customer was created.
-          sig { returns(Time) }
-          attr_accessor :created_at
-
-          sig { returns(T::Hash[Symbol, String]) }
-          attr_accessor :custom_fields
-
-          sig do
-            returns(
-              MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CustomerConfig
-            )
-          end
-          attr_reader :customer_config
-
-          sig do
-            params(
-              customer_config:
-                MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CustomerConfig::OrHash
-            ).void
-          end
-          attr_writer :customer_config
-
-          # (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
-
-          # RFC 3339 timestamp indicating when the customer was archived. Null if the
-          # customer is active.
-          sig { returns(T.nilable(Time)) }
-          attr_accessor :archived_at
-
-          # This field's availability is dependent on your client's configuration.
-          sig do
-            returns(
-              T.nilable(
-                MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CurrentBillableStatus
-              )
-            )
-          end
-          attr_reader :current_billable_status
-
-          sig do
-            params(
-              current_billable_status:
-                MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CurrentBillableStatus::OrHash
-            ).void
-          end
-          attr_writer :current_billable_status
-
-          sig do
-            params(
-              id: String,
-              created_at: Time,
-              custom_fields: T::Hash[Symbol, String],
-              customer_config:
-                MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CustomerConfig::OrHash,
-              external_id: String,
-              ingest_aliases: T::Array[String],
-              name: String,
-              archived_at: T.nilable(Time),
-              current_billable_status:
-                MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CurrentBillableStatus::OrHash
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # the Metronome ID of the customer
-            id:,
-            # RFC 3339 timestamp indicating when the customer was created.
-            created_at:,
-            custom_fields:,
-            customer_config:,
-            # (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:,
-            # RFC 3339 timestamp indicating when the customer was archived. Null if the
-            # customer is active.
-            archived_at: nil,
-            # This field's availability is dependent on your client's configuration.
-            current_billable_status: nil
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                id: String,
-                created_at: Time,
-                custom_fields: T::Hash[Symbol, String],
-                customer_config:
-                  MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CustomerConfig,
-                external_id: String,
-                ingest_aliases: T::Array[String],
-                name: String,
-                archived_at: T.nilable(Time),
-                current_billable_status:
-                  MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CurrentBillableStatus
-              }
-            )
-          end
-          def to_hash
-          end
-
-          class CustomerConfig < MetronomeSDK::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CustomerConfig,
-                  MetronomeSDK::Internal::AnyHash
-                )
-              end
-
-            # The Salesforce account ID for the customer
-            sig { returns(T.nilable(String)) }
-            attr_accessor :salesforce_account_id
-
-            sig do
-              params(salesforce_account_id: T.nilable(String)).returns(
-                T.attached_class
-              )
-            end
-            def self.new(
-              # The Salesforce account ID for the customer
-              salesforce_account_id:
-            )
-            end
-
-            sig do
-              override.returns({ salesforce_account_id: T.nilable(String) })
-            end
-            def to_hash
-            end
-          end
-
-          class CurrentBillableStatus < MetronomeSDK::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CurrentBillableStatus,
-                  MetronomeSDK::Internal::AnyHash
-                )
-              end
-
-            sig do
-              returns(
-                MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CurrentBillableStatus::Value::TaggedSymbol
-              )
-            end
-            attr_accessor :value
-
-            sig { returns(T.nilable(Time)) }
-            attr_accessor :effective_at
-
-            # This field's availability is dependent on your client's configuration.
-            sig do
-              params(
-                value:
-                  MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CurrentBillableStatus::Value::OrSymbol,
-                effective_at: T.nilable(Time)
-              ).returns(T.attached_class)
-            end
-            def self.new(value:, effective_at: nil)
-            end
-
-            sig do
-              override.returns(
-                {
-                  value:
-                    MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CurrentBillableStatus::Value::TaggedSymbol,
-                  effective_at: T.nilable(Time)
-                }
-              )
-            end
-            def to_hash
-            end
-
-            module Value
-              extend MetronomeSDK::Internal::Type::Enum
-
-              TaggedSymbol =
-                T.type_alias do
-                  T.all(
-                    Symbol,
-                    MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CurrentBillableStatus::Value
-                  )
-                end
-              OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-              BILLABLE =
-                T.let(
-                  :billable,
-                  MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CurrentBillableStatus::Value::TaggedSymbol
-                )
-              UNBILLABLE =
-                T.let(
-                  :unbillable,
-                  MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CurrentBillableStatus::Value::TaggedSymbol
-                )
-
-              sig do
-                override.returns(
-                  T::Array[
-                    MetronomeSDK::Models::V1::CustomerRetrieveResponse::Data::CurrentBillableStatus::Value::TaggedSymbol
-                  ]
-                )
-              end
-              def self.values
-              end
-            end
-          end
-        end
       end
     end
   end

data/rbi/metronome_sdk/models/v1/customer_set_name_response.rbi

@@ -12,103 +12,23 @@ module MetronomeSDK
             )
           end
 
-        sig { returns(MetronomeSDK::Models::V1::CustomerSetNameResponse::Data) }
+        sig { returns(MetronomeSDK::V1::Customer) }
         attr_reader :data
 
-        sig do
-          params(
-            data:
-              MetronomeSDK::Models::V1::CustomerSetNameResponse::Data::OrHash
-          ).void
-        end
+        sig { params(data: MetronomeSDK::V1::Customer::OrHash).void }
         attr_writer :data
 
         sig do
-          params(
-            data:
-              MetronomeSDK::Models::V1::CustomerSetNameResponse::Data::OrHash
-          ).returns(T.attached_class)
+          params(data: MetronomeSDK::V1::Customer::OrHash).returns(
+            T.attached_class
+          )
         end
         def self.new(data:)
         end
 
-        sig do
-          override.returns(
-            { data: MetronomeSDK::Models::V1::CustomerSetNameResponse::Data }
-          )
-        end
+        sig { override.returns({ data: MetronomeSDK::V1::Customer }) }
         def to_hash
         end
-
-        class Data < MetronomeSDK::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                MetronomeSDK::Models::V1::CustomerSetNameResponse::Data,
-                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