orb-billing 0.1.0.pre.alpha.33

data/lib/orb/models/amount_discount.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    class AmountDiscount < Orb::BaseModel
+      # @!attribute amount_discount
+      #   Only available if discount_type is `amount`.
+      #
+      #   @return [String]
+      required :amount_discount, String
+
+      # @!attribute applies_to_price_ids
+      #   List of price_ids that this discount applies to. For plan/plan phase discounts,
+      #     this can be a subset of prices.
+      #
+      #   @return [Array<String>]
+      required :applies_to_price_ids, Orb::ArrayOf[String]
+
+      # @!attribute discount_type
+      #
+      #   @return [Symbol, Orb::Models::AmountDiscount::DiscountType]
+      required :discount_type, enum: -> { Orb::Models::AmountDiscount::DiscountType }
+
+      # @!attribute reason
+      #
+      #   @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::BaseModel) -> void
+
+      # @see Orb::Models::AmountDiscount#discount_type
+      module DiscountType
+        extend Orb::Enum
+
+        AMOUNT = :amount
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/orb/models/billable_metric.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Metrics#create
+    class BillableMetric < Orb::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute description
+      #
+      #   @return [String, nil]
+      required :description, String, nil?: true
+
+      # @!attribute item
+      #   The Item resource represents a sellable product or good. Items are associated
+      #     with all line items, billable metrics, and prices and are used for defining
+      #     external sync behavior for invoices and tax calculation purposes.
+      #
+      #   @return [Orb::Models::Item]
+      required :item, -> { Orb::Models::Item }
+
+      # @!attribute metadata
+      #   User specified key-value pairs for the resource. If not present, this defaults
+      #     to an empty dictionary. Individual keys can be removed by setting the value to
+      #     `null`, and the entire metadata mapping can be cleared by setting `metadata` to
+      #     `null`.
+      #
+      #   @return [Hash{Symbol=>String}]
+      required :metadata, Orb::HashOf[String]
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute status
+      #
+      #   @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::BaseModel) -> void
+
+      # @see Orb::Models::BillableMetric#status
+      module Status
+        extend Orb::Enum
+
+        ACTIVE = :active
+        DRAFT = :draft
+        ARCHIVED = :archived
+
+        finalize!
+
+        # @!parse
+        #   # @return [Array<Symbol>]
+        #   def self.values; end
+      end
+    end
+  end
+end

data/lib/orb/models/billing_cycle_relative_date.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module BillingCycleRelativeDate
+      extend Orb::Enum
+
+      START_OF_TERM = :start_of_term
+      END_OF_TERM = :end_of_term
+
+      finalize!
+
+      # @!parse
+      #   # @return [Array<Symbol>]
+      #   def self.values; end
+    end
+  end
+end

data/lib/orb/models/coupon.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Coupons#create
+    class Coupon < Orb::BaseModel
+      # @!attribute id
+      #   Also referred to as coupon_id in this documentation.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute archived_at
+      #   An archived coupon can no longer be redeemed. Active coupons will have a value
+      #     of null for `archived_at`; this field will be non-null for archived coupons.
+      #
+      #   @return [Time, nil]
+      required :archived_at, Time, nil?: true
+
+      # @!attribute discount
+      #
+      #   @return [Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount]
+      required :discount, union: -> { Orb::Models::Coupon::Discount }
+
+      # @!attribute duration_in_months
+      #   This allows for a coupon's discount to apply for a limited time (determined in
+      #     months); a `null` value here means "unlimited time".
+      #
+      #   @return [Integer, nil]
+      required :duration_in_months, Integer, nil?: true
+
+      # @!attribute max_redemptions
+      #   The maximum number of redemptions allowed for this coupon before it is
+      #     exhausted; `null` here means "unlimited".
+      #
+      #   @return [Integer, nil]
+      required :max_redemptions, Integer, nil?: true
+
+      # @!attribute redemption_code
+      #   This string can be used to redeem this coupon for a given subscription.
+      #
+      #   @return [String]
+      required :redemption_code, String
+
+      # @!attribute times_redeemed
+      #   The number of times this coupon has been redeemed.
+      #
+      #   @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::BaseModel) -> void
+
+      # @see Orb::Models::Coupon#discount
+      module Discount
+        extend Orb::Union
+
+        discriminator :discount_type
+
+        variant :percentage, -> { Orb::Models::PercentageDiscount }
+
+        variant :amount, -> { Orb::Models::AmountDiscount }
+
+        # @!parse
+        #   # @return [Array(Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount)]
+        #   def self.variants; end
+      end
+    end
+  end
+end

data/lib/orb/models/coupon_archive_params.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Coupons#archive
+    class CouponArchiveParams < 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/coupon_create_params.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Coupons#create
+    class CouponCreateParams < Orb::BaseModel
+      # @!parse
+      #   extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      # @!attribute discount
+      #
+      #   @return [Orb::Models::CouponCreateParams::Discount::NewCouponPercentageDiscount, Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount]
+      required :discount, union: -> { Orb::Models::CouponCreateParams::Discount }
+
+      # @!attribute redemption_code
+      #   This string can be used to redeem this coupon for a given subscription.
+      #
+      #   @return [String]
+      required :redemption_code, String
+
+      # @!attribute duration_in_months
+      #   This allows for a coupon's discount to apply for a limited time (determined in
+      #     months); a `null` value here means "unlimited time".
+      #
+      #   @return [Integer, nil]
+      optional :duration_in_months, Integer, nil?: true
+
+      # @!attribute max_redemptions
+      #   The maximum number of redemptions allowed for this coupon before it is
+      #     exhausted;`null` here means "unlimited".
+      #
+      #   @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::BaseModel) -> void
+
+      module Discount
+        extend Orb::Union
+
+        discriminator :discount_type
+
+        variant :percentage, -> { Orb::Models::CouponCreateParams::Discount::NewCouponPercentageDiscount }
+
+        variant :amount, -> { Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount }
+
+        class NewCouponPercentageDiscount < Orb::BaseModel
+          # @!attribute discount_type
+          #
+          #   @return [Symbol, :percentage]
+          required :discount_type, const: :percentage
+
+          # @!attribute percentage_discount
+          #
+          #   @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::BaseModel) -> void
+        end
+
+        class NewCouponAmountDiscount < Orb::BaseModel
+          # @!attribute amount_discount
+          #
+          #   @return [String]
+          required :amount_discount, String
+
+          # @!attribute discount_type
+          #
+          #   @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::BaseModel) -> void
+        end
+
+        # @!parse
+        #   # @return [Array(Orb::Models::CouponCreateParams::Discount::NewCouponPercentageDiscount, Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount)]
+        #   def self.variants; end
+      end
+    end
+  end
+end

data/lib/orb/models/coupon_fetch_params.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Coupons#fetch
+    class CouponFetchParams < 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/coupon_list_params.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    # @see Orb::Resources::Coupons#list
+    class CouponListParams < 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 redemption_code
+      #   Filter to coupons matching this redemption code.
+      #
+      #   @return [String, nil]
+      optional :redemption_code, String, nil?: true
+
+      # @!attribute show_archived
+      #   Show archived coupons as well (by default, this endpoint only returns active
+      #     coupons).
+      #
+      #   @return [Boolean, nil]
+      optional :show_archived, Orb::BooleanModel, 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::BaseModel) -> void
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Orb
+  module Models
+    module Coupons
+      # @see Orb::Resources::Coupons::Subscriptions#list
+      class SubscriptionListParams < 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
+
+        # @!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::BaseModel) -> void
+      end
+    end
+  end
+end