metronome-sdk 3.1.0 → 3.2.0

data/rbi/metronome_sdk/models/v1/package_create_response.rbi

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

data/rbi/metronome_sdk/models/v1/package_list_contracts_on_package_params.rbi

@@ -0,0 +1,105 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class PackageListContractsOnPackageParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::V1::PackageListContractsOnPackageParams,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :package_id
+
+        # Max number of results that should be returned
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :limit
+
+        sig { params(limit: Integer).void }
+        attr_writer :limit
+
+        # Cursor that indicates where the next page of results should start.
+        sig { returns(T.nilable(String)) }
+        attr_reader :next_page
+
+        sig { params(next_page: String).void }
+        attr_writer :next_page
+
+        # Optional RFC 3339 timestamp. Only include contracts active on the provided date.
+        # This cannot be provided if starting_at filter is provided.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :covering_date
+
+        sig { params(covering_date: Time).void }
+        attr_writer :covering_date
+
+        # Default false. Determines whether to include archived contracts in the results
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :include_archived
+
+        sig { params(include_archived: T::Boolean).void }
+        attr_writer :include_archived
+
+        # Optional RFC 3339 timestamp. Only include contracts that started on or after
+        # this date. This cannot be provided if covering_date filter is provided.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :starting_at
+
+        sig { params(starting_at: Time).void }
+        attr_writer :starting_at
+
+        sig do
+          params(
+            package_id: String,
+            limit: Integer,
+            next_page: String,
+            covering_date: Time,
+            include_archived: T::Boolean,
+            starting_at: Time,
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          package_id:,
+          # Max number of results that should be returned
+          limit: nil,
+          # Cursor that indicates where the next page of results should start.
+          next_page: nil,
+          # Optional RFC 3339 timestamp. Only include contracts active on the provided date.
+          # This cannot be provided if starting_at filter is provided.
+          covering_date: nil,
+          # Default false. Determines whether to include archived contracts in the results
+          include_archived: nil,
+          # Optional RFC 3339 timestamp. Only include contracts that started on or after
+          # this date. This cannot be provided if covering_date filter is provided.
+          starting_at: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              package_id: String,
+              limit: Integer,
+              next_page: String,
+              covering_date: Time,
+              include_archived: T::Boolean,
+              starting_at: Time,
+              request_options: MetronomeSDK::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/package_list_contracts_on_package_response.rbi

@@ -0,0 +1,70 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class PackageListContractsOnPackageResponse < MetronomeSDK::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::Models::V1::PackageListContractsOnPackageResponse,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :contract_id
+
+        sig { returns(String) }
+        attr_accessor :customer_id
+
+        sig { returns(Time) }
+        attr_accessor :starting_at
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :archived_at
+
+        sig { params(archived_at: Time).void }
+        attr_writer :archived_at
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :ending_before
+
+        sig { params(ending_before: Time).void }
+        attr_writer :ending_before
+
+        sig do
+          params(
+            contract_id: String,
+            customer_id: String,
+            starting_at: Time,
+            archived_at: Time,
+            ending_before: Time
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          contract_id:,
+          customer_id:,
+          starting_at:,
+          archived_at: nil,
+          ending_before: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              contract_id: String,
+              customer_id: String,
+              starting_at: Time,
+              archived_at: Time,
+              ending_before: Time
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/metronome_sdk/models/v1/package_list_params.rbi

@@ -0,0 +1,123 @@
+# typed: strong
+
+module MetronomeSDK
+  module Models
+    module V1
+      class PackageListParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              MetronomeSDK::V1::PackageListParams,
+              MetronomeSDK::Internal::AnyHash
+            )
+          end
+
+        # The maximum number of packages to return. Defaults to 10.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :limit
+
+        sig { params(limit: Integer).void }
+        attr_writer :limit
+
+        # Cursor that indicates where the next page of results should start.
+        sig { returns(T.nilable(String)) }
+        attr_reader :next_page
+
+        sig { params(next_page: String).void }
+        attr_writer :next_page
+
+        # Filter packages by archived status. Defaults to NOT_ARCHIVED.
+        sig do
+          returns(
+            T.nilable(
+              MetronomeSDK::V1::PackageListParams::ArchiveFilter::OrSymbol
+            )
+          )
+        end
+        attr_reader :archive_filter
+
+        sig do
+          params(
+            archive_filter:
+              MetronomeSDK::V1::PackageListParams::ArchiveFilter::OrSymbol
+          ).void
+        end
+        attr_writer :archive_filter
+
+        sig do
+          params(
+            limit: Integer,
+            next_page: String,
+            archive_filter:
+              MetronomeSDK::V1::PackageListParams::ArchiveFilter::OrSymbol,
+            request_options: MetronomeSDK::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The maximum number of packages to return. Defaults to 10.
+          limit: nil,
+          # Cursor that indicates where the next page of results should start.
+          next_page: nil,
+          # Filter packages by archived status. Defaults to NOT_ARCHIVED.
+          archive_filter: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              limit: Integer,
+              next_page: String,
+              archive_filter:
+                MetronomeSDK::V1::PackageListParams::ArchiveFilter::OrSymbol,
+              request_options: MetronomeSDK::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Filter packages by archived status. Defaults to NOT_ARCHIVED.
+        module ArchiveFilter
+          extend MetronomeSDK::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, MetronomeSDK::V1::PackageListParams::ArchiveFilter)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ARCHIVED =
+            T.let(
+              :ARCHIVED,
+              MetronomeSDK::V1::PackageListParams::ArchiveFilter::TaggedSymbol
+            )
+          NOT_ARCHIVED =
+            T.let(
+              :NOT_ARCHIVED,
+              MetronomeSDK::V1::PackageListParams::ArchiveFilter::TaggedSymbol
+            )
+          ALL =
+            T.let(
+              :ALL,
+              MetronomeSDK::V1::PackageListParams::ArchiveFilter::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                MetronomeSDK::V1::PackageListParams::ArchiveFilter::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end