orb-billing 0.2.0 → 0.3.1

data/lib/orb/models/amount_discount.rb

@@ -26,15 +26,18 @@ module Orb
       #   @return [String, nil]
       optional :reason, String, nil?: true
 
-      # @!parse
-      #   # @param amount_discount [String]
-      #   # @param applies_to_price_ids [Array<String>]
-      #   # @param discount_type [Symbol, Orb::Models::AmountDiscount::DiscountType]
-      #   # @param reason [String, nil]
-      #   #
-      #   def initialize(amount_discount:, applies_to_price_ids:, discount_type:, reason: nil, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(amount_discount:, applies_to_price_ids:, discount_type:, reason: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::AmountDiscount} for more details.
+      #
+      #   @param amount_discount [String] Only available if discount_type is `amount`.
+      #
+      #   @param applies_to_price_ids [Array<String>] List of price_ids that this discount applies to. For plan/plan phase discounts,
+      #   ...
+      #
+      #   @param discount_type [Symbol, Orb::Models::AmountDiscount::DiscountType]
+      #
+      #   @param reason [String, nil]
 
       # @see Orb::Models::AmountDiscount#discount_type
       module DiscountType
@@ -42,11 +45,8 @@ module Orb
 
         AMOUNT = :amount
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end

data/lib/orb/models/billable_metric.rb

@@ -41,21 +41,27 @@ module Orb
       #   @return [Symbol, Orb::Models::BillableMetric::Status]
       required :status, enum: -> { Orb::Models::BillableMetric::Status }
 
-      # @!parse
-      #   # The Metric resource represents a calculation of a quantity based on events.
-      #   # Metrics are defined by the query that transforms raw usage events into
-      #   # meaningful values for your customers.
-      #   #
-      #   # @param id [String]
-      #   # @param description [String, nil]
-      #   # @param item [Orb::Models::Item]
-      #   # @param metadata [Hash{Symbol=>String}]
-      #   # @param name [String]
-      #   # @param status [Symbol, Orb::Models::BillableMetric::Status]
-      #   #
-      #   def initialize(id:, description:, item:, metadata:, name:, status:, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(id:, description:, item:, metadata:, name:, status:)
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::BillableMetric} for more details.
+      #
+      #   The Metric resource represents a calculation of a quantity based on events.
+      #   Metrics are defined by the query that transforms raw usage events into
+      #   meaningful values for your customers.
+      #
+      #   @param id [String]
+      #
+      #   @param description [String, nil]
+      #
+      #   @param item [Orb::Models::Item] The Item resource represents a sellable product or good. Items are associated wi
+      #   ...
+      #
+      #   @param metadata [Hash{Symbol=>String}] User specified key-value pairs for the resource. If not present, this defaults t
+      #   ...
+      #
+      #   @param name [String]
+      #
+      #   @param status [Symbol, Orb::Models::BillableMetric::Status]
 
       # @see Orb::Models::BillableMetric#status
       module Status
@@ -65,11 +71,8 @@ module Orb
         DRAFT = :draft
         ARCHIVED = :archived
 
-        finalize!
-
-        # @!parse
-        #   # @return [Array<Symbol>]
-        #   def self.values; end
+        # @!method self.values
+        #   @return [Array<Symbol>]
       end
     end
   end

data/lib/orb/models/billing_cycle_relative_date.rb

@@ -8,11 +8,8 @@ module Orb
       START_OF_TERM = :start_of_term
       END_OF_TERM = :end_of_term
 
-      finalize!
-
-      # @!parse
-      #   # @return [Array<Symbol>]
-      #   def self.values; end
+      # @!method self.values
+      #   @return [Array<Symbol>]
     end
   end
 end

data/lib/orb/models/coupon.rb

@@ -48,24 +48,32 @@ module Orb
       #   @return [Integer]
       required :times_redeemed, Integer
 
-      # @!parse
-      #   # A coupon represents a reusable discount configuration that can be applied either
-      #   # as a fixed or percentage amount to an invoice or subscription. Coupons are
-      #   # activated using a redemption code, which applies the discount to a subscription
-      #   # or invoice. The duration of a coupon determines how long it remains available
-      #   # for use by end users.
-      #   #
-      #   # @param id [String]
-      #   # @param archived_at [Time, nil]
-      #   # @param discount [Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount]
-      #   # @param duration_in_months [Integer, nil]
-      #   # @param max_redemptions [Integer, nil]
-      #   # @param redemption_code [String]
-      #   # @param times_redeemed [Integer]
-      #   #
-      #   def initialize(id:, archived_at:, discount:, duration_in_months:, max_redemptions:, redemption_code:, times_redeemed:, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(id:, archived_at:, discount:, duration_in_months:, max_redemptions:, redemption_code:, times_redeemed:)
+      #   Some parameter documentations has been truncated, see {Orb::Models::Coupon} for
+      #   more details.
+      #
+      #   A coupon represents a reusable discount configuration that can be applied either
+      #   as a fixed or percentage amount to an invoice or subscription. Coupons are
+      #   activated using a redemption code, which applies the discount to a subscription
+      #   or invoice. The duration of a coupon determines how long it remains available
+      #   for use by end users.
+      #
+      #   @param id [String] Also referred to as coupon_id in this documentation.
+      #
+      #   @param archived_at [Time, nil] An archived coupon can no longer be redeemed. Active coupons will have a value o
+      #   ...
+      #
+      #   @param discount [Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount]
+      #
+      #   @param duration_in_months [Integer, nil] This allows for a coupon's discount to apply for a limited time (determined in m
+      #   ...
+      #
+      #   @param max_redemptions [Integer, nil] The maximum number of redemptions allowed for this coupon before it is exhausted
+      #   ...
+      #
+      #   @param redemption_code [String] This string can be used to redeem this coupon for a given subscription.
+      #
+      #   @param times_redeemed [Integer] The number of times this coupon has been redeemed.
 
       # @see Orb::Models::Coupon#discount
       module Discount
@@ -77,9 +85,8 @@ module Orb
 
         variant :amount, -> { Orb::Models::AmountDiscount }
 
-        # @!parse
-        #   # @return [Array(Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount)]
-        #   def self.variants; end
+        # @!method self.variants
+        #   @return [Array(Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount)]
       end
     end
   end

data/lib/orb/models/coupon_archive_params.rb

@@ -4,16 +4,11 @@ module Orb
   module Models
     # @see Orb::Resources::Coupons#archive
     class CouponArchiveParams < 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/coupon_create_params.rb

@@ -4,13 +4,12 @@ module Orb
   module Models
     # @see Orb::Resources::Coupons#create
     class CouponCreateParams < Orb::Internal::Type::BaseModel
-      # @!parse
-      #   extend Orb::Internal::Type::RequestParameters::Converter
+      extend Orb::Internal::Type::RequestParameters::Converter
       include Orb::Internal::Type::RequestParameters
 
       # @!attribute discount
       #
-      #   @return [Orb::Models::CouponCreateParams::Discount::NewCouponPercentageDiscount, Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount]
+      #   @return [Orb::Models::CouponCreateParams::Discount::Percentage, Orb::Models::CouponCreateParams::Discount::Amount]
       required :discount, union: -> { Orb::Models::CouponCreateParams::Discount }
 
       # @!attribute redemption_code
@@ -33,27 +32,32 @@ module Orb
       #   @return [Integer, nil]
       optional :max_redemptions, Integer, nil?: true
 
-      # @!parse
-      #   # @param discount [Orb::Models::CouponCreateParams::Discount::NewCouponPercentageDiscount, Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount]
-      #   # @param redemption_code [String]
-      #   # @param duration_in_months [Integer, nil]
-      #   # @param max_redemptions [Integer, nil]
-      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(discount:, redemption_code:, duration_in_months: nil, max_redemptions: nil, request_options: {}, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(discount:, redemption_code:, duration_in_months: nil, max_redemptions: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::CouponCreateParams} for more details.
+      #
+      #   @param discount [Orb::Models::CouponCreateParams::Discount::Percentage, Orb::Models::CouponCreateParams::Discount::Amount]
+      #
+      #   @param redemption_code [String] This string can be used to redeem this coupon for a given subscription.
+      #
+      #   @param duration_in_months [Integer, nil] This allows for a coupon's discount to apply for a limited time (determined in m
+      #   ...
+      #
+      #   @param max_redemptions [Integer, nil] The maximum number of redemptions allowed for this coupon before it is exhausted
+      #   ...
+      #
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
 
       module Discount
         extend Orb::Internal::Type::Union
 
         discriminator :discount_type
 
-        variant :percentage, -> { Orb::Models::CouponCreateParams::Discount::NewCouponPercentageDiscount }
+        variant :percentage, -> { Orb::Models::CouponCreateParams::Discount::Percentage }
 
-        variant :amount, -> { Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount }
+        variant :amount, -> { Orb::Models::CouponCreateParams::Discount::Amount }
 
-        class NewCouponPercentageDiscount < Orb::Internal::Type::BaseModel
+        class Percentage < Orb::Internal::Type::BaseModel
           # @!attribute discount_type
           #
           #   @return [Symbol, :percentage]
@@ -64,16 +68,12 @@ module Orb
           #   @return [Float]
           required :percentage_discount, Float
 
-          # @!parse
-          #   # @param percentage_discount [Float]
-          #   # @param discount_type [Symbol, :percentage]
-          #   #
-          #   def initialize(percentage_discount:, discount_type: :percentage, **) = super
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(percentage_discount:, discount_type: :percentage)
+          #   @param percentage_discount [Float]
+          #   @param discount_type [Symbol, :percentage]
         end
 
-        class NewCouponAmountDiscount < Orb::Internal::Type::BaseModel
+        class Amount < Orb::Internal::Type::BaseModel
           # @!attribute amount_discount
           #
           #   @return [String]
@@ -84,18 +84,13 @@ module Orb
           #   @return [Symbol, :amount]
           required :discount_type, const: :amount
 
-          # @!parse
-          #   # @param amount_discount [String]
-          #   # @param discount_type [Symbol, :amount]
-          #   #
-          #   def initialize(amount_discount:, discount_type: :amount, **) = super
-
-          # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+          # @!method initialize(amount_discount:, discount_type: :amount)
+          #   @param amount_discount [String]
+          #   @param discount_type [Symbol, :amount]
         end
 
-        # @!parse
-        #   # @return [Array(Orb::Models::CouponCreateParams::Discount::NewCouponPercentageDiscount, Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount)]
-        #   def self.variants; end
+        # @!method self.variants
+        #   @return [Array(Orb::Models::CouponCreateParams::Discount::Percentage, Orb::Models::CouponCreateParams::Discount::Amount)]
       end
     end
   end

data/lib/orb/models/coupon_fetch_params.rb

@@ -4,16 +4,11 @@ module Orb
   module Models
     # @see Orb::Resources::Coupons#fetch
     class CouponFetchParams < 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/coupon_list_params.rb

@@ -4,8 +4,7 @@ module Orb
   module Models
     # @see Orb::Resources::Coupons#list
     class CouponListParams < 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 redemption_code
       #   Filter to coupons matching this redemption code.
       #
@@ -38,16 +33,21 @@ module Orb
       #   @return [Boolean, nil]
       optional :show_archived, Orb::Internal::Type::Boolean, nil?: true
 
-      # @!parse
-      #   # @param cursor [String, nil]
-      #   # @param limit [Integer]
-      #   # @param redemption_code [String, nil]
-      #   # @param show_archived [Boolean, nil]
-      #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-      #   #
-      #   def initialize(cursor: nil, limit: nil, redemption_code: nil, show_archived: nil, request_options: {}, **) = super
-
-      # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+      # @!method initialize(cursor: nil, limit: nil, redemption_code: nil, show_archived: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Orb::Models::CouponListParams} 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 redemption_code [String, nil] Filter to coupons matching this redemption code.
+      #
+      #   @param show_archived [Boolean, nil] Show archived coupons as well (by default, this endpoint only returns active cou
+      #   ...
+      #
+      #   @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
     end
   end
 end

data/lib/orb/models/coupons/subscription_list_params.rb

@@ -5,8 +5,7 @@ module Orb
     module Coupons
       # @see Orb::Resources::Coupons::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 cursor
@@ -16,24 +15,22 @@ 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
-
-        # @!parse
-        #   # @param cursor [String, nil]
-        #   # @param limit [Integer]
-        #   # @param request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
-        #   #
-        #   def initialize(cursor: nil, limit: nil, request_options: {}, **) = super
-
-        # def initialize: (Hash | Orb::Internal::Type::BaseModel) -> void
+        # @!method initialize(cursor: nil, limit: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Orb::Models::Coupons::SubscriptionListParams} 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 request_options [Orb::RequestOptions, Hash{Symbol=>Object}]
       end
     end
   end