metronome-sdk 0.1.0.pre.alpha.1

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

@@ -0,0 +1,202 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Plans#list_charges
+      class PlanListChargesResponse < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute charge_type
+        #
+        #   @return [Symbol, MetronomeSDK::Models::V1::PlanListChargesResponse::ChargeType]
+        required :charge_type, enum: -> { MetronomeSDK::Models::V1::PlanListChargesResponse::ChargeType }
+
+        # @!attribute credit_type
+        #
+        #   @return [MetronomeSDK::Models::CreditTypeData]
+        required :credit_type, -> { MetronomeSDK::Models::CreditTypeData }
+
+        # @!attribute custom_fields
+        #
+        #   @return [Hash{Symbol=>String}]
+        required :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
+
+        # @!attribute name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute prices
+        #
+        #   @return [Array<MetronomeSDK::Models::V1::PlanListChargesResponse::Price>]
+        required :prices,
+                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::PlanListChargesResponse::Price] }
+
+        # @!attribute product_id
+        #
+        #   @return [String]
+        required :product_id, String
+
+        # @!attribute product_name
+        #
+        #   @return [String]
+        required :product_name, String
+
+        # @!attribute quantity
+        #
+        #   @return [Float, nil]
+        optional :quantity, Float
+
+        # @!attribute start_period
+        #   Used in price ramps. Indicates how many billing periods pass before the charge
+        #   applies.
+        #
+        #   @return [Float, nil]
+        optional :start_period, Float
+
+        # @!attribute tier_reset_frequency
+        #   Used in pricing tiers. Indicates how often the tier resets. Default is 1 - the
+        #   tier count resets every billing period.
+        #
+        #   @return [Float, nil]
+        optional :tier_reset_frequency, Float
+
+        # @!attribute unit_conversion
+        #   Specifies how quantities for usage based charges will be converted.
+        #
+        #   @return [MetronomeSDK::Models::V1::PlanListChargesResponse::UnitConversion, nil]
+        optional :unit_conversion, -> { MetronomeSDK::Models::V1::PlanListChargesResponse::UnitConversion }
+
+        # @!method initialize(id:, charge_type:, credit_type:, custom_fields:, name:, prices:, product_id:, product_name:, quantity: nil, start_period: nil, tier_reset_frequency: nil, unit_conversion: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::V1::PlanListChargesResponse} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param charge_type [Symbol, MetronomeSDK::Models::V1::PlanListChargesResponse::ChargeType]
+        #
+        #   @param credit_type [MetronomeSDK::Models::CreditTypeData]
+        #
+        #   @param custom_fields [Hash{Symbol=>String}]
+        #
+        #   @param name [String]
+        #
+        #   @param prices [Array<MetronomeSDK::Models::V1::PlanListChargesResponse::Price>]
+        #
+        #   @param product_id [String]
+        #
+        #   @param product_name [String]
+        #
+        #   @param quantity [Float]
+        #
+        #   @param start_period [Float] Used in price ramps. Indicates how many billing periods pass before the charge
+        #   ...
+        #
+        #   @param tier_reset_frequency [Float] Used in pricing tiers. Indicates how often the tier resets. Default is 1 - the
+        #   ...
+        #
+        #   @param unit_conversion [MetronomeSDK::Models::V1::PlanListChargesResponse::UnitConversion] Specifies how quantities for usage based charges will be converted.
+
+        # @see MetronomeSDK::Models::V1::PlanListChargesResponse#charge_type
+        module ChargeType
+          extend MetronomeSDK::Internal::Type::Enum
+
+          USAGE = :usage
+          FIXED = :fixed
+          COMPOSITE = :composite
+          MINIMUM = :minimum
+          SEAT = :seat
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        class Price < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute tier
+          #   Used in pricing tiers. Indicates at what metric value the price applies.
+          #
+          #   @return [Float]
+          required :tier, Float
+
+          # @!attribute value
+          #
+          #   @return [Float]
+          required :value, Float
+
+          # @!attribute collection_interval
+          #
+          #   @return [Float, nil]
+          optional :collection_interval, Float
+
+          # @!attribute collection_schedule
+          #
+          #   @return [String, nil]
+          optional :collection_schedule, String
+
+          # @!attribute quantity
+          #
+          #   @return [Float, nil]
+          optional :quantity, Float
+
+          # @!method initialize(tier:, value:, collection_interval: nil, collection_schedule: nil, quantity: nil)
+          #   @param tier [Float] Used in pricing tiers. Indicates at what metric value the price applies.
+          #
+          #   @param value [Float]
+          #
+          #   @param collection_interval [Float]
+          #
+          #   @param collection_schedule [String]
+          #
+          #   @param quantity [Float]
+        end
+
+        # @see MetronomeSDK::Models::V1::PlanListChargesResponse#unit_conversion
+        class UnitConversion < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute division_factor
+          #   The conversion factor
+          #
+          #   @return [Float]
+          required :division_factor, Float
+
+          # @!attribute rounding_behavior
+          #   Whether usage should be rounded down or up to the nearest whole number. If null,
+          #   quantity will be rounded to 20 decimal places.
+          #
+          #   @return [Symbol, MetronomeSDK::Models::V1::PlanListChargesResponse::UnitConversion::RoundingBehavior, nil]
+          optional :rounding_behavior,
+                   enum: -> { MetronomeSDK::Models::V1::PlanListChargesResponse::UnitConversion::RoundingBehavior }
+
+          # @!method initialize(division_factor:, rounding_behavior: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {MetronomeSDK::Models::V1::PlanListChargesResponse::UnitConversion} for more
+          #   details.
+          #
+          #   Specifies how quantities for usage based charges will be converted.
+          #
+          #   @param division_factor [Float] The conversion factor
+          #
+          #   @param rounding_behavior [Symbol, MetronomeSDK::Models::V1::PlanListChargesResponse::UnitConversion::RoundingBehavior] Whether usage should be rounded down or up to the nearest whole number. If null,
+          #   ...
+
+          # Whether usage should be rounded down or up to the nearest whole number. If null,
+          # quantity will be rounded to 20 decimal places.
+          #
+          # @see MetronomeSDK::Models::V1::PlanListChargesResponse::UnitConversion#rounding_behavior
+          module RoundingBehavior
+            extend MetronomeSDK::Internal::Type::Enum
+
+            FLOOR = :floor
+            CEILING = :ceiling
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Plans#list_customers
+      class PlanListCustomersParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        # @!attribute plan_id
+        #
+        #   @return [String]
+        required :plan_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 status
+        #   Status of customers on a given plan. Defaults to `active`.
+        #
+        #   - `all` - Return current, past, and upcoming customers of the plan.
+        #   - `active` - Return current customers of the plan.
+        #   - `ended` - Return past customers of the plan.
+        #   - `upcoming` - Return upcoming customers of the plan.
+        #
+        #   Multiple statuses can be OR'd together using commas, e.g. `active,ended`.
+        #   **Note:** `ended,upcoming` combination is not yet supported.
+        #
+        #   @return [Symbol, MetronomeSDK::Models::V1::PlanListCustomersParams::Status, nil]
+        optional :status, enum: -> { MetronomeSDK::Models::V1::PlanListCustomersParams::Status }
+
+        # @!method initialize(plan_id:, limit: nil, next_page: nil, status: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {MetronomeSDK::Models::V1::PlanListCustomersParams} for more details.
+        #
+        #   @param plan_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 status [Symbol, MetronomeSDK::Models::V1::PlanListCustomersParams::Status] Status of customers on a given plan. Defaults to `active`. ...
+        #
+        #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+
+        # Status of customers on a given plan. Defaults to `active`.
+        #
+        # - `all` - Return current, past, and upcoming customers of the plan.
+        # - `active` - Return current customers of the plan.
+        # - `ended` - Return past customers of the plan.
+        # - `upcoming` - Return upcoming customers of the plan.
+        #
+        # Multiple statuses can be OR'd together using commas, e.g. `active,ended`.
+        # **Note:** `ended,upcoming` combination is not yet supported.
+        module Status
+          extend MetronomeSDK::Internal::Type::Enum
+
+          ALL = :all
+          ACTIVE = :active
+          ENDED = :ended
+          UPCOMING = :upcoming
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Plans#list_customers
+      class PlanListCustomersResponse < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute customer_details
+        #
+        #   @return [MetronomeSDK::Models::V1::CustomerDetail]
+        required :customer_details, -> { MetronomeSDK::Models::V1::CustomerDetail }
+
+        # @!attribute plan_details
+        #
+        #   @return [MetronomeSDK::Models::V1::PlanListCustomersResponse::PlanDetails]
+        required :plan_details, -> { MetronomeSDK::Models::V1::PlanListCustomersResponse::PlanDetails }
+
+        # @!method initialize(customer_details:, plan_details:)
+        #   @param customer_details [MetronomeSDK::Models::V1::CustomerDetail]
+        #   @param plan_details [MetronomeSDK::Models::V1::PlanListCustomersResponse::PlanDetails]
+
+        # @see MetronomeSDK::Models::V1::PlanListCustomersResponse#plan_details
+        class PlanDetails < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute custom_fields
+          #
+          #   @return [Hash{Symbol=>String}]
+          required :custom_fields, MetronomeSDK::Internal::Type::HashOf[String]
+
+          # @!attribute customer_plan_id
+          #
+          #   @return [String]
+          required :customer_plan_id, String
+
+          # @!attribute name
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute starting_on
+          #   The start date of the plan
+          #
+          #   @return [Time]
+          required :starting_on, Time
+
+          # @!attribute ending_before
+          #   The end date of the plan
+          #
+          #   @return [Time, nil]
+          optional :ending_before, Time, nil?: true
+
+          # @!method initialize(id:, custom_fields:, customer_plan_id:, name:, starting_on:, ending_before: nil)
+          #   @param id [String]
+          #
+          #   @param custom_fields [Hash{Symbol=>String}]
+          #
+          #   @param customer_plan_id [String]
+          #
+          #   @param name [String]
+          #
+          #   @param starting_on [Time] The start date of the plan
+          #
+          #   @param ending_before [Time, nil] The end date of the plan
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Plans#list
+      class PlanListParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        # @!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
+
+        # @!method initialize(limit: nil, next_page: nil, request_options: {})
+        #   @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 request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Plans#list
+      class PlanListResponse < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute description
+        #
+        #   @return [String]
+        required :description, 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:, description:, name:, custom_fields: nil)
+        #   @param id [String]
+        #   @param description [String]
+        #   @param name [String]
+        #   @param custom_fields [Hash{Symbol=>String}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::PricingUnits#list
+      class PricingUnitListParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        # @!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
+
+        # @!method initialize(limit: nil, next_page: nil, request_options: {})
+        #   @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 request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::PricingUnits#list
+      class PricingUnitListResponse < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute is_currency
+        #
+        #   @return [Boolean, nil]
+        optional :is_currency, MetronomeSDK::Internal::Type::Boolean
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!method initialize(id: nil, is_currency: nil, name: nil)
+        #   @param id [String]
+        #   @param is_currency [Boolean]
+        #   @param name [String]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      class RolloverAmountMaxAmount < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute type
+        #   Rollover up to a fixed amount of the original credit grant amount.
+        #
+        #   @return [Symbol, MetronomeSDK::Models::V1::RolloverAmountMaxAmount::Type]
+        required :type, enum: -> { MetronomeSDK::Models::V1::RolloverAmountMaxAmount::Type }
+
+        # @!attribute value
+        #   The maximum amount to rollover.
+        #
+        #   @return [Float]
+        required :value, Float
+
+        # @!method initialize(type:, value:)
+        #   @param type [Symbol, MetronomeSDK::Models::V1::RolloverAmountMaxAmount::Type] Rollover up to a fixed amount of the original credit grant amount.
+        #
+        #   @param value [Float] The maximum amount to rollover.
+
+        # Rollover up to a fixed amount of the original credit grant amount.
+        #
+        # @see MetronomeSDK::Models::V1::RolloverAmountMaxAmount#type
+        module Type
+          extend MetronomeSDK::Internal::Type::Enum
+
+          MAX_AMOUNT = :MAX_AMOUNT
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      class RolloverAmountMaxPercentage < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute type
+        #   Rollover up to a percentage of the original credit grant amount.
+        #
+        #   @return [Symbol, MetronomeSDK::Models::V1::RolloverAmountMaxPercentage::Type]
+        required :type, enum: -> { MetronomeSDK::Models::V1::RolloverAmountMaxPercentage::Type }
+
+        # @!attribute value
+        #   The maximum percentage (0-1) of the original credit grant to rollover.
+        #
+        #   @return [Float]
+        required :value, Float
+
+        # @!method initialize(type:, value:)
+        #   @param type [Symbol, MetronomeSDK::Models::V1::RolloverAmountMaxPercentage::Type] Rollover up to a percentage of the original credit grant amount.
+        #
+        #   @param value [Float] The maximum percentage (0-1) of the original credit grant to rollover.
+
+        # Rollover up to a percentage of the original credit grant amount.
+        #
+        # @see MetronomeSDK::Models::V1::RolloverAmountMaxPercentage#type
+        module Type
+          extend MetronomeSDK::Internal::Type::Enum
+
+          MAX_PERCENTAGE = :MAX_PERCENTAGE
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Services#list
+      class ServiceListParams < MetronomeSDK::Internal::Type::BaseModel
+        extend MetronomeSDK::Internal::Type::RequestParameters::Converter
+        include MetronomeSDK::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [MetronomeSDK::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module MetronomeSDK
+  module Models
+    module V1
+      # @see MetronomeSDK::Resources::V1::Services#list
+      class ServiceListResponse < MetronomeSDK::Internal::Type::BaseModel
+        # @!attribute services
+        #
+        #   @return [Array<MetronomeSDK::Models::V1::ServiceListResponse::Service>]
+        required :services,
+                 -> { MetronomeSDK::Internal::Type::ArrayOf[MetronomeSDK::Models::V1::ServiceListResponse::Service] }
+
+        # @!method initialize(services:)
+        #   @param services [Array<MetronomeSDK::Models::V1::ServiceListResponse::Service>]
+
+        class Service < MetronomeSDK::Internal::Type::BaseModel
+          # @!attribute ips
+          #
+          #   @return [Array<String>]
+          required :ips, MetronomeSDK::Internal::Type::ArrayOf[String]
+
+          # @!attribute name
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute usage
+          #
+          #   @return [Symbol, MetronomeSDK::Models::V1::ServiceListResponse::Service::Usage]
+          required :usage, enum: -> { MetronomeSDK::Models::V1::ServiceListResponse::Service::Usage }
+
+          # @!method initialize(ips:, name:, usage:)
+          #   @param ips [Array<String>]
+          #   @param name [String]
+          #   @param usage [Symbol, MetronomeSDK::Models::V1::ServiceListResponse::Service::Usage]
+
+          # @see MetronomeSDK::Models::V1::ServiceListResponse::Service#usage
+          module Usage
+            extend MetronomeSDK::Internal::Type::Enum
+
+            MAKES_CONNECTIONS_FROM = :makes_connections_from
+            ACCEPTS_CONNECTIONS_AT = :accepts_connections_at
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end