orb-billing 0.2.0 → 0.3.0

data/lib/orb/models/subscription_fetch_costs_params.rb

@@ -4,8 +4,7 @@ module Orb
   module Models
     # @see Orb::Resources::Subscriptions#fetch_costs
     class SubscriptionFetchCostsParams < Orb::Internal::Type::BaseModel
-      # @!parse
-      #   extend Orb::Internal::Type::RequestParameters::Converter
+      extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
       # @!attribute currency
@@ -35,16 +34,20 @@ module Orb
       #   @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::Internal::Type::BaseModel) -> void
+      # @!method initialize(currency: nil, timeframe_end: nil, timeframe_start: nil, view_mode: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::SubscriptionFetchCostsParams} for more details.
+      #
+      #   @param currency [String, nil] The currency or custom pricing unit to use.
+      #
+      #   @param timeframe_end [Time, nil] Costs returned are exclusive of `timeframe_end`.
+      #
+      #   @param timeframe_start [Time, nil] Costs returned are inclusive of `timeframe_start`.
+      #
+      #   @param view_mode [Symbol, Orb::Models::SubscriptionFetchCostsParams::ViewMode, nil] Controls whether Orb returns cumulative costs since the start of the billing per
+      #   ...
+      #
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
       # 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
@@ -56,11 +59,8 @@ module Orb
         PERIODIC = :periodic
         CUMULATIVE = :cumulative
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end

data/lib/orb/models/subscription_fetch_costs_response.rb

@@ -9,12 +9,8 @@ module Orb
       #   @return [Array<Orb::Models::SubscriptionFetchCostsResponse::Data>]
       required :data, -> { Orb::Internal::Type::ArrayOf[Orb::Models::SubscriptionFetchCostsResponse::Data] }
 
-      # @!parse
-      #   # @param data [Array<Orb::Models::SubscriptionFetchCostsResponse::Data>]
-      #   #
-      #   def initialize(data:, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(data:)
+      #   @param data [Array<Orb::Models::SubscriptionFetchCostsResponse::Data>]
 
       class Data < Orb::Internal::Type::BaseModel
         # @!attribute per_price_costs
@@ -45,16 +41,16 @@ module Orb
         #   @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::Internal::Type::BaseModel) -> void
+        # @!method initialize(per_price_costs:, subtotal:, timeframe_end:, timeframe_start:, total:)
+        #   @param per_price_costs [Array<Orb::Models::SubscriptionFetchCostsResponse::Data::PerPriceCost>]
+        #
+        #   @param subtotal [String] Total costs for the timeframe, excluding any minimums and discounts.
+        #
+        #   @param timeframe_end [Time]
+        #
+        #   @param timeframe_start [Time]
+        #
+        #   @param total [String] Total costs for the timeframe, including any minimums and discounts.
 
         class PerPriceCost < Orb::Internal::Type::BaseModel
           # @!attribute price
@@ -87,16 +83,16 @@ module Orb
           #   @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::Internal::Type::BaseModel) -> void
+          # @!method initialize(price:, price_id:, subtotal:, total:, quantity: nil)
+          #   @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] The price object
+          #
+          #   @param price_id [String] The price the cost is associated with
+          #
+          #   @param subtotal [String] Price's contributions for the timeframe, excluding any minimums and discounts.
+          #
+          #   @param total [String] Price's contributions for the timeframe, including minimums and discounts.
+          #
+          #   @param quantity [Float, nil] The price's quantity for the timeframe
         end
       end
     end

data/lib/orb/models/subscription_fetch_params.rb

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

data/lib/orb/models/subscription_fetch_schedule_params.rb

@@ -4,8 +4,7 @@ module Orb
   module Models
     # @see Orb::Resources::Subscriptions#fetch_schedule
     class SubscriptionFetchScheduleParams < Orb::Internal::Type::BaseModel
-      # @!parse
-      #   extend Orb::Internal::Type::RequestParameters::Converter
+      extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
       # @!attribute cursor
@@ -15,16 +14,12 @@ module Orb
       #   @return [String, nil]
       optional :cursor, String, nil?: true
 
-      # @!attribute [r] limit
+      # @!attribute 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]
@@ -45,29 +40,24 @@ module Orb
       #   @return [Time, nil]
       optional :start_date_lte, Time, 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::Internal::Type::BaseModel) -> void
+      # @!method initialize(cursor: nil, limit: nil, start_date_gt: nil, start_date_gte: nil, start_date_lt: nil, start_date_lte: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::SubscriptionFetchScheduleParams} for more details.
+      #
+      #   @param cursor [String, nil] Cursor for pagination. This can be populated by the `next_cursor` value returned
+      #   ...
+      #
+      #   @param limit [Integer] The number of items to fetch. Defaults to 20.
+      #
+      #   @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}]
     end
   end
 end

data/lib/orb/models/subscription_fetch_schedule_response.rb

@@ -24,15 +24,11 @@ module Orb
       #   @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::Internal::Type::BaseModel) -> void
+      # @!method initialize(created_at:, end_date:, plan:, start_date:)
+      #   @param created_at [Time]
+      #   @param end_date [Time, nil]
+      #   @param plan [Orb::Models::SubscriptionFetchScheduleResponse::Plan]
+      #   @param start_date [Time]
 
       # @see Orb::Models::SubscriptionFetchScheduleResponse#plan
       class Plan < Orb::Internal::Type::BaseModel
@@ -54,14 +50,16 @@ module Orb
         #   @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::Internal::Type::BaseModel) -> void
+        # @!method initialize(id:, external_plan_id:, name:)
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::SubscriptionFetchScheduleResponse::Plan} for more details.
+        #
+        #   @param id [String, nil]
+        #
+        #   @param external_plan_id [String, nil] An optional user-defined ID for this plan resource, used throughout the system a
+        #   ...
+        #
+        #   @param name [String, nil]
       end
     end
   end

data/lib/orb/models/subscription_fetch_usage_params.rb

@@ -4,8 +4,7 @@ module Orb
   module Models
     # @see Orb::Resources::Subscriptions#fetch_usage
     class SubscriptionFetchUsageParams < Orb::Internal::Type::BaseModel
-      # @!parse
-      #   extend Orb::Internal::Type::RequestParameters::Converter
+      extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
       # @!attribute billable_metric_id
@@ -69,37 +68,33 @@ module Orb
       #   @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::Internal::Type::BaseModel) -> void
+      # @!method 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: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::SubscriptionFetchUsageParams} for more details.
+      #
+      #   @param billable_metric_id [String, nil] When specified in conjunction with `group_by`, this parameter filters usage to a
+      #   ...
+      #
+      #   @param first_dimension_key [String, nil]
+      #
+      #   @param first_dimension_value [String, nil]
+      #
+      #   @param granularity [Symbol, Orb::Models::SubscriptionFetchUsageParams::Granularity, nil] This determines the windowing of usage reporting.
+      #
+      #   @param group_by [String, nil] Groups per-price usage by the key provided.
+      #
+      #   @param second_dimension_key [String, nil]
+      #
+      #   @param second_dimension_value [String, nil]
+      #
+      #   @param timeframe_end [Time, nil] Usage returned is exclusive of `timeframe_end`.
+      #
+      #   @param timeframe_start [Time, nil] Usage returned is inclusive of `timeframe_start`.
+      #
+      #   @param view_mode [Symbol, Orb::Models::SubscriptionFetchUsageParams::ViewMode, nil] Controls whether Orb returns cumulative usage since the start of the billing per
+      #   ...
+      #
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
       # This determines the windowing of usage reporting.
       module Granularity
@@ -107,11 +102,8 @@ module Orb
 
         DAY = :day
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
 
       # Controls whether Orb returns cumulative usage since the start of the billing
@@ -124,11 +116,8 @@ module Orb
         PERIODIC = :periodic
         CUMULATIVE = :cumulative
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end

data/lib/orb/models/subscription_list_params.rb

@@ -4,8 +4,7 @@ module Orb
   module Models
     # @see Orb::Resources::Subscriptions#list
     class SubscriptionListParams < Orb::Internal::Type::BaseModel
-      # @!parse
-      #   extend Orb::Internal::Type::RequestParameters::Converter
+      extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
       # @!attribute created_at_gt
@@ -45,50 +44,41 @@ module Orb
       #   @return [Array<String>, nil]
       optional :external_customer_id, Orb::Internal::Type::ArrayOf[String], nil?: true
 
-      # @!attribute [r] limit
+      # @!attribute 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::Internal::Type::BaseModel) -> void
+      # @!method 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: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::SubscriptionListParams} for more details.
+      #
+      #   @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] Cursor for pagination. This can be populated by the `next_cursor` value returned
+      #   ...
+      #
+      #   @param customer_id [Array<String>, nil]
+      #
+      #   @param external_customer_id [Array<String>, nil]
+      #
+      #   @param limit [Integer] The number of items to fetch. Defaults to 20.
+      #
+      #   @param status [Symbol, Orb::Models::SubscriptionListParams::Status, nil]
+      #
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
       module Status
         extend Orb::Internal::Type::Enum
@@ -97,11 +87,8 @@ module Orb
         ENDED = :ended
         UPCOMING = :upcoming
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end