orb-billing 0.1.0.pre.alpha.33

data/lib/orb/models/subscription_fetch_costs_params.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Subscriptions#fetch_costs
+    class SubscriptionFetchCostsParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!attribute currency
+      #   The currency or custom pricing unit to use.
+      #
+      #   @return [String, nil]
+      optional :currency, String, nil?: true
+
+      # @!attribute timeframe_end
+      #   Costs returned are exclusive of `timeframe_end`.
+      #
+      #   @return [Time, nil]
+      optional :timeframe_end, Time, nil?: true
+
+      # @!attribute timeframe_start
+      #   Costs returned are inclusive of `timeframe_start`.
+      #
+      #   @return [Time, nil]
+      optional :timeframe_start, Time, nil?: true
+
+      # @!attribute view_mode
+      #   Controls whether Orb returns cumulative costs since the start of the billing
+      #     period, or incremental day-by-day costs. If your customer has minimums or
+      #     discounts, it's strongly recommended that you use the default cumulative
+      #     behavior.
+      #
+      #   @return [Symbol, Orb::Models::SubscriptionFetchCostsParams::ViewMode, nil]
+      optional :view_mode, enum: -> { Orb::Models::SubscriptionFetchCostsParams::ViewMode }, nil?: true
+
+      # @!parse
+      #   # @param currency [String, nil]
+      #   # @param timeframe_end [Time, nil]
+      #   # @param timeframe_start [Time, nil]
+      #   # @param view_mode [Symbol, Orb::Models::SubscriptionFetchCostsParams::ViewMode, nil]
+      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+
+      # Controls whether Orb returns cumulative costs since the start of the billing
+      #   period, or incremental day-by-day costs. If your customer has minimums or
+      #   discounts, it's strongly recommended that you use the default cumulative
+      #   behavior.
+      module ViewMode
+        extend Orb::Enum
+
+        PERIODIC = :periodic
+        CUMULATIVE = :cumulative
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/orb/models/subscription_fetch_costs_response.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Subscriptions#fetch_costs
+    class SubscriptionFetchCostsResponse < Orb::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<Orb::Models::SubscriptionFetchCostsResponse::Data>]
+      required :data, -> { Orb::ArrayOf[Orb::Models::SubscriptionFetchCostsResponse::Data] }
+
+      # @!parse
+      #   # @param data [Array<Orb::Models::SubscriptionFetchCostsResponse::Data>]
+      #   #
+      #   def initialize(data:, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+
+      class Data < Orb::BaseModel
+        # @!attribute per_price_costs
+        #
+        #   @return [Array<Orb::Models::SubscriptionFetchCostsResponse::Data::PerPriceCost>]
+        required :per_price_costs,
+                 -> { Orb::ArrayOf[Orb::Models::SubscriptionFetchCostsResponse::Data::PerPriceCost] }
+
+        # @!attribute subtotal
+        #   Total costs for the timeframe, excluding any minimums and discounts.
+        #
+        #   @return [String]
+        required :subtotal, String
+
+        # @!attribute timeframe_end
+        #
+        #   @return [Time]
+        required :timeframe_end, Time
+
+        # @!attribute timeframe_start
+        #
+        #   @return [Time]
+        required :timeframe_start, Time
+
+        # @!attribute total
+        #   Total costs for the timeframe, including any minimums and discounts.
+        #
+        #   @return [String]
+        required :total, String
+
+        # @!parse
+        #   # @param per_price_costs [Array<Orb::Models::SubscriptionFetchCostsResponse::Data::PerPriceCost>]
+        #   # @param subtotal [String]
+        #   # @param timeframe_end [Time]
+        #   # @param timeframe_start [Time]
+        #   # @param total [String]
+        #   #
+        #   def initialize(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:, **) = super
+
+        # def initialize: (Hash | Orb::BaseModel) -> void
+
+        class PerPriceCost < Orb::BaseModel
+          # @!attribute price
+          #   The price object
+          #
+          #   @return [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice]
+          required :price, union: -> { Orb::Models::Price }
+
+          # @!attribute price_id
+          #   The price the cost is associated with
+          #
+          #   @return [String]
+          required :price_id, String
+
+          # @!attribute subtotal
+          #   Price's contributions for the timeframe, excluding any minimums and discounts.
+          #
+          #   @return [String]
+          required :subtotal, String
+
+          # @!attribute total
+          #   Price's contributions for the timeframe, including minimums and discounts.
+          #
+          #   @return [String]
+          required :total, String
+
+          # @!attribute quantity
+          #   The price's quantity for the timeframe
+          #
+          #   @return [Float, nil]
+          optional :quantity, Float, nil?: true
+
+          # @!parse
+          #   # @param price [Orb::Models::Price::UnitPrice, Orb::Models::Price::PackagePrice, Orb::Models::Price::MatrixPrice, Orb::Models::Price::TieredPrice, Orb::Models::Price::TieredBpsPrice, Orb::Models::Price::BpsPrice, Orb::Models::Price::BulkBpsPrice, Orb::Models::Price::BulkPrice, Orb::Models::Price::ThresholdTotalAmountPrice, Orb::Models::Price::TieredPackagePrice, Orb::Models::Price::GroupedTieredPrice, Orb::Models::Price::TieredWithMinimumPrice, Orb::Models::Price::TieredPackageWithMinimumPrice, Orb::Models::Price::PackageWithAllocationPrice, Orb::Models::Price::UnitWithPercentPrice, Orb::Models::Price::MatrixWithAllocationPrice, Orb::Models::Price::TieredWithProrationPrice, Orb::Models::Price::UnitWithProrationPrice, Orb::Models::Price::GroupedAllocationPrice, Orb::Models::Price::GroupedWithProratedMinimumPrice, Orb::Models::Price::GroupedWithMeteredMinimumPrice, Orb::Models::Price::MatrixWithDisplayNamePrice, Orb::Models::Price::BulkWithProrationPrice, Orb::Models::Price::GroupedTieredPackagePrice, Orb::Models::Price::MaxGroupTieredPackagePrice, Orb::Models::Price::ScalableMatrixWithUnitPricingPrice, Orb::Models::Price::ScalableMatrixWithTieredPricingPrice, Orb::Models::Price::CumulativeGroupedBulkPrice]
+          #   # @param price_id [String]
+          #   # @param subtotal [String]
+          #   # @param total [String]
+          #   # @param quantity [Float, nil]
+          #   #
+          #   def initialize(price:, price_id:, subtotal:, total:, quantity: nil, **) = super
+
+          # def initialize: (Hash | Orb::BaseModel) -> void
+        end
+      end
+    end
+  end
+end

data/lib/orb/models/subscription_fetch_params.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Subscriptions#fetch
+    class SubscriptionFetchParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!parse
+      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+    end
+  end
+end

data/lib/orb/models/subscription_fetch_schedule_params.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Subscriptions#fetch_schedule
+    class SubscriptionFetchScheduleParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!attribute cursor
+      #   Cursor for pagination. This can be populated by the `next_cursor` value returned
+      #     from the initial request.
+      #
+      #   @return [String, nil]
+      optional :cursor, String, nil?: true
+
+      # @!attribute [r] limit
+      #   The number of items to fetch. Defaults to 20.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :limit
+
+      # @!attribute start_date_gt
+      #
+      #   @return [Time, nil]
+      optional :start_date_gt, Time, api_name: :"start_date[gt]", nil?: true
+
+      # @!attribute start_date_gte
+      #
+      #   @return [Time, nil]
+      optional :start_date_gte, Time, api_name: :"start_date[gte]", nil?: true
+
+      # @!attribute start_date_lt
+      #
+      #   @return [Time, nil]
+      optional :start_date_lt, Time, api_name: :"start_date[lt]", nil?: true
+
+      # @!attribute start_date_lte
+      #
+      #   @return [Time, nil]
+      optional :start_date_lte, Time, api_name: :"start_date[lte]", nil?: true
+
+      # @!parse
+      #   # @param cursor [String, nil]
+      #   # @param limit [Integer]
+      #   # @param start_date_gt [Time, nil]
+      #   # @param start_date_gte [Time, nil]
+      #   # @param start_date_lt [Time, nil]
+      #   # @param start_date_lte [Time, nil]
+      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     cursor: nil,
+      #     limit: nil,
+      #     start_date_gt: nil,
+      #     start_date_gte: nil,
+      #     start_date_lt: nil,
+      #     start_date_lte: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+    end
+  end
+end

data/lib/orb/models/subscription_fetch_schedule_response.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Subscriptions#fetch_schedule
+    class SubscriptionFetchScheduleResponse < Orb::BaseModel
+      # @!attribute created_at
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute end_date
+      #
+      #   @return [Time, nil]
+      required :end_date, Time, nil?: true
+
+      # @!attribute plan
+      #
+      #   @return [Orb::Models::SubscriptionFetchScheduleResponse::Plan]
+      required :plan, -> { Orb::Models::SubscriptionFetchScheduleResponse::Plan }
+
+      # @!attribute start_date
+      #
+      #   @return [Time]
+      required :start_date, Time
+
+      # @!parse
+      #   # @param created_at [Time]
+      #   # @param end_date [Time, nil]
+      #   # @param plan [Orb::Models::SubscriptionFetchScheduleResponse::Plan]
+      #   # @param start_date [Time]
+      #   #
+      #   def initialize(created_at:, end_date:, plan:, start_date:, **) = super
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+
+      # @see Orb::Models::SubscriptionFetchScheduleResponse#plan
+      class Plan < Orb::BaseModel
+        # @!attribute id
+        #
+        #   @return [String, nil]
+        required :id, String, nil?: true
+
+        # @!attribute external_plan_id
+        #   An optional user-defined ID for this plan resource, used throughout the system
+        #     as an alias for this Plan. Use this field to identify a plan by an existing
+        #     identifier in your system.
+        #
+        #   @return [String, nil]
+        required :external_plan_id, String, nil?: true
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        required :name, String, nil?: true
+
+        # @!parse
+        #   # @param id [String, nil]
+        #   # @param external_plan_id [String, nil]
+        #   # @param name [String, nil]
+        #   #
+        #   def initialize(id:, external_plan_id:, name:, **) = super
+
+        # def initialize: (Hash | Orb::BaseModel) -> void
+      end
+    end
+  end
+end

data/lib/orb/models/subscription_fetch_usage_params.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Subscriptions#fetch_usage
+    class SubscriptionFetchUsageParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!attribute billable_metric_id
+      #   When specified in conjunction with `group_by`, this parameter filters usage to a
+      #     single billable metric. Note that both `group_by` and `billable_metric_id` must
+      #     be specified together.
+      #
+      #   @return [String, nil]
+      optional :billable_metric_id, String, nil?: true
+
+      # @!attribute first_dimension_key
+      #
+      #   @return [String, nil]
+      optional :first_dimension_key, String, nil?: true
+
+      # @!attribute first_dimension_value
+      #
+      #   @return [String, nil]
+      optional :first_dimension_value, String, nil?: true
+
+      # @!attribute granularity
+      #   This determines the windowing of usage reporting.
+      #
+      #   @return [Symbol, Orb::Models::SubscriptionFetchUsageParams::Granularity, nil]
+      optional :granularity, enum: -> { Orb::Models::SubscriptionFetchUsageParams::Granularity }, nil?: true
+
+      # @!attribute group_by
+      #   Groups per-price usage by the key provided.
+      #
+      #   @return [String, nil]
+      optional :group_by, String, nil?: true
+
+      # @!attribute second_dimension_key
+      #
+      #   @return [String, nil]
+      optional :second_dimension_key, String, nil?: true
+
+      # @!attribute second_dimension_value
+      #
+      #   @return [String, nil]
+      optional :second_dimension_value, String, nil?: true
+
+      # @!attribute timeframe_end
+      #   Usage returned is exclusive of `timeframe_end`.
+      #
+      #   @return [Time, nil]
+      optional :timeframe_end, Time, nil?: true
+
+      # @!attribute timeframe_start
+      #   Usage returned is inclusive of `timeframe_start`.
+      #
+      #   @return [Time, nil]
+      optional :timeframe_start, Time, nil?: true
+
+      # @!attribute view_mode
+      #   Controls whether Orb returns cumulative usage since the start of the billing
+      #     period, or incremental day-by-day usage. If your customer has minimums or
+      #     discounts, it's strongly recommended that you use the default cumulative
+      #     behavior.
+      #
+      #   @return [Symbol, Orb::Models::SubscriptionFetchUsageParams::ViewMode, nil]
+      optional :view_mode, enum: -> { Orb::Models::SubscriptionFetchUsageParams::ViewMode }, nil?: true
+
+      # @!parse
+      #   # @param billable_metric_id [String, nil]
+      #   # @param first_dimension_key [String, nil]
+      #   # @param first_dimension_value [String, nil]
+      #   # @param granularity [Symbol, Orb::Models::SubscriptionFetchUsageParams::Granularity, nil]
+      #   # @param group_by [String, nil]
+      #   # @param second_dimension_key [String, nil]
+      #   # @param second_dimension_value [String, nil]
+      #   # @param timeframe_end [Time, nil]
+      #   # @param timeframe_start [Time, nil]
+      #   # @param view_mode [Symbol, Orb::Models::SubscriptionFetchUsageParams::ViewMode, nil]
+      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     billable_metric_id: nil,
+      #     first_dimension_key: nil,
+      #     first_dimension_value: nil,
+      #     granularity: nil,
+      #     group_by: nil,
+      #     second_dimension_key: nil,
+      #     second_dimension_value: nil,
+      #     timeframe_end: nil,
+      #     timeframe_start: nil,
+      #     view_mode: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+
+      # This determines the windowing of usage reporting.
+      module Granularity
+        extend Orb::Enum
+
+        DAY = :day
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+
+      # Controls whether Orb returns cumulative usage since the start of the billing
+      #   period, or incremental day-by-day usage. If your customer has minimums or
+      #   discounts, it's strongly recommended that you use the default cumulative
+      #   behavior.
+      module ViewMode
+        extend Orb::Enum
+
+        PERIODIC = :periodic
+        CUMULATIVE = :cumulative
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/orb/models/subscription_list_params.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Subscriptions#list
+    class SubscriptionListParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!attribute created_at_gt
+      #
+      #   @return [Time, nil]
+      optional :created_at_gt, Time, api_name: :"created_at[gt]", nil?: true
+
+      # @!attribute created_at_gte
+      #
+      #   @return [Time, nil]
+      optional :created_at_gte, Time, api_name: :"created_at[gte]", nil?: true
+
+      # @!attribute created_at_lt
+      #
+      #   @return [Time, nil]
+      optional :created_at_lt, Time, api_name: :"created_at[lt]", nil?: true
+
+      # @!attribute created_at_lte
+      #
+      #   @return [Time, nil]
+      optional :created_at_lte, Time, api_name: :"created_at[lte]", nil?: true
+
+      # @!attribute cursor
+      #   Cursor for pagination. This can be populated by the `next_cursor` value returned
+      #     from the initial request.
+      #
+      #   @return [String, nil]
+      optional :cursor, String, nil?: true
+
+      # @!attribute customer_id
+      #
+      #   @return [Array<String>, nil]
+      optional :customer_id, Orb::ArrayOf[String], nil?: true
+
+      # @!attribute external_customer_id
+      #
+      #   @return [Array<String>, nil]
+      optional :external_customer_id, Orb::ArrayOf[String], nil?: true
+
+      # @!attribute [r] limit
+      #   The number of items to fetch. Defaults to 20.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_writer :limit
+
+      # @!attribute status
+      #
+      #   @return [Symbol, Orb::Models::SubscriptionListParams::Status, nil]
+      optional :status, enum: -> { Orb::Models::SubscriptionListParams::Status }, nil?: true
+
+      # @!parse
+      #   # @param created_at_gt [Time, nil]
+      #   # @param created_at_gte [Time, nil]
+      #   # @param created_at_lt [Time, nil]
+      #   # @param created_at_lte [Time, nil]
+      #   # @param cursor [String, nil]
+      #   # @param customer_id [Array<String>, nil]
+      #   # @param external_customer_id [Array<String>, nil]
+      #   # @param limit [Integer]
+      #   # @param status [Symbol, Orb::Models::SubscriptionListParams::Status, nil]
+      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(
+      #     created_at_gt: nil,
+      #     created_at_gte: nil,
+      #     created_at_lt: nil,
+      #     created_at_lte: nil,
+      #     cursor: nil,
+      #     customer_id: nil,
+      #     external_customer_id: nil,
+      #     limit: nil,
+      #     status: nil,
+      #     request_options: {},
+      #     **
+      #   )
+      #     super
+      #   end
+
+      # def initialize: (Hash | Orb::BaseModel) -> void
+
+      module Status
+        extend Orb::Enum
+
+        ACTIVE = :active
+        ENDED = :ended
+        UPCOMING = :upcoming
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end