metronome-sdk 3.1.0 → 3.2.0

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

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

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Packages#list_contracts_on_package
+      class PackageListContractsOnPackageParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        # @!attribute package_id
+        #
+        #   @return [String]
+        required :package_id, String
+
+        # @!attribute limit
+        #   Max number of results that should be returned
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!attribute next_page
+        #   Cursor that indicates where the next page of results should start.
+        #
+        #   @return [String, nil]
+        optional :next_page, String
+
+        # @!attribute covering_date
+        #   Optional RFC 3339 timestamp. Only include contracts active on the provided date.
+        #   This cannot be provided if starting_at filter is provided.
+        #
+        #   @return [Time, nil]
+        optional :covering_date, Time
+
+        # @!attribute include_archived
+        #   Default false. Determines whether to include archived contracts in the results
+        #
+        #   @return [Boolean, nil]
+        optional :include_archived, MetronomeSDK::Internal::Type::Boolean
+
+        # @!attribute starting_at
+        #   Optional RFC 3339 timestamp. Only include contracts that started on or after
+        #   this date. This cannot be provided if covering_date filter is provided.
+        #
+        #   @return [Time, nil]
+        optional :starting_at, Time
+
+        # @!method initialize(package_id:, limit: nil, next_page: nil, covering_date: nil, include_archived: nil, starting_at: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::V1::PackageListContractsOnPackageParams} for more
+        #   details.
+        #
+        #   @param package_id [String]
+        #
+        #   @param limit [Integer] Max number of results that should be returned
+        #
+        #   @param next_page [String] Cursor that indicates where the next page of results should start.
+        #
+        #   @param covering_date [Time] Optional RFC 3339 timestamp. Only include contracts active on the provided date.
+        #
+        #   @param include_archived [Boolean] Default false. Determines whether to include archived contracts in the results
+        #
+        #   @param starting_at [Time] Optional RFC 3339 timestamp. Only include contracts that started on or after thi
+        #
+        #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Packages#list_contracts_on_package
+      class PackageListContractsOnPackageResponse < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute contract_id
+        #
+        #   @return [String]
+        required :contract_id, String
+
+        # @!attribute customer_id
+        #
+        #   @return [String]
+        required :customer_id, String
+
+        # @!attribute starting_at
+        #
+        #   @return [Time]
+        required :starting_at, Time
+
+        # @!attribute archived_at
+        #
+        #   @return [Time, nil]
+        optional :archived_at, Time
+
+        # @!attribute ending_before
+        #
+        #   @return [Time, nil]
+        optional :ending_before, Time
+
+        # @!method initialize(contract_id:, customer_id:, starting_at:, archived_at: nil, ending_before: nil)
+        #   @param contract_id [String]
+        #   @param customer_id [String]
+        #   @param starting_at [Time]
+        #   @param archived_at [Time]
+        #   @param ending_before [Time]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Packages#list
+      class PackageListParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        # @!attribute limit
+        #   The maximum number of packages to return. Defaults to 10.
+        #
+        #   @return [Integer, nil]
+        optional :limit, Integer
+
+        # @!attribute next_page
+        #   Cursor that indicates where the next page of results should start.
+        #
+        #   @return [String, nil]
+        optional :next_page, String
+
+        # @!attribute archive_filter
+        #   Filter packages by archived status. Defaults to NOT_ARCHIVED.
+        #
+        #   @return [Symbol, MetronomeSDK::Models::V1::PackageListParams::ArchiveFilter, nil]
+        optional :archive_filter, enum: -> { MetronomeSDK::V1::PackageListParams::ArchiveFilter }
+
+        # @!method initialize(limit: nil, next_page: nil, archive_filter: nil, request_options: {})
+        #   @param limit [Integer] The maximum number of packages to return. Defaults to 10.
+        #
+        #   @param next_page [String] Cursor that indicates where the next page of results should start.
+        #
+        #   @param archive_filter [Symbol, MetronomeSDK::Models::V1::PackageListParams::ArchiveFilter] Filter packages by archived status. Defaults to NOT_ARCHIVED.
+        #
+        #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+
+        # Filter packages by archived status. Defaults to NOT_ARCHIVED.
+        module ArchiveFilter
+          extend MetronomeSDK::Internal::Type::Enum
+
+          ARCHIVED = :ARCHIVED
+          NOT_ARCHIVED = :NOT_ARCHIVED
+          ALL = :ALL
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end