orb-billing 0.1.0.pre.alpha.33

data/sig/orb/models/alert_update_params.rbs

@@ -0,0 +1,31 @@
+module Orb
+  module Models
+    type alert_update_params =
+      { thresholds: ::Array[Orb::Models::AlertUpdateParams::Threshold] }
+      & Orb::request_parameters
+
+    class AlertUpdateParams < Orb::BaseModel
+      extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      attr_accessor thresholds: ::Array[Orb::Models::AlertUpdateParams::Threshold]
+
+      def initialize: (
+        thresholds: ::Array[Orb::Models::AlertUpdateParams::Threshold],
+        ?request_options: Orb::request_opts
+      ) -> void
+
+      def to_hash: -> Orb::Models::alert_update_params
+
+      type threshold = { value: Float }
+
+      class Threshold < Orb::BaseModel
+        attr_accessor value: Float
+
+        def initialize: (value: Float) -> void
+
+        def to_hash: -> Orb::Models::AlertUpdateParams::threshold
+      end
+    end
+  end
+end

data/sig/orb/models/amount_discount.rbs

@@ -0,0 +1,40 @@
+module Orb
+  module Models
+    type amount_discount =
+      {
+        amount_discount: String,
+        applies_to_price_ids: ::Array[String],
+        discount_type: Orb::Models::AmountDiscount::discount_type,
+        reason: String?
+      }
+
+    class AmountDiscount < Orb::BaseModel
+      attr_accessor amount_discount: String
+
+      attr_accessor applies_to_price_ids: ::Array[String]
+
+      attr_accessor discount_type: Orb::Models::AmountDiscount::discount_type
+
+      attr_accessor reason: String?
+
+      def initialize: (
+        amount_discount: String,
+        applies_to_price_ids: ::Array[String],
+        discount_type: Orb::Models::AmountDiscount::discount_type,
+        ?reason: String?
+      ) -> void
+
+      def to_hash: -> Orb::Models::amount_discount
+
+      type discount_type = :amount
+
+      module DiscountType
+        extend Orb::Enum
+
+        AMOUNT: :amount
+
+        def self?.values: -> ::Array[Orb::Models::AmountDiscount::discount_type]
+      end
+    end
+  end
+end

data/sig/orb/models/billable_metric.rbs

@@ -0,0 +1,50 @@
+module Orb
+  module Models
+    type billable_metric =
+      {
+        id: String,
+        description: String?,
+        item: Orb::Models::Item,
+        metadata: ::Hash[Symbol, String],
+        name: String,
+        status: Orb::Models::BillableMetric::status
+      }
+
+    class BillableMetric < Orb::BaseModel
+      attr_accessor id: String
+
+      attr_accessor description: String?
+
+      attr_accessor item: Orb::Models::Item
+
+      attr_accessor metadata: ::Hash[Symbol, String]
+
+      attr_accessor name: String
+
+      attr_accessor status: Orb::Models::BillableMetric::status
+
+      def initialize: (
+        id: String,
+        description: String?,
+        item: Orb::Models::Item,
+        metadata: ::Hash[Symbol, String],
+        name: String,
+        status: Orb::Models::BillableMetric::status
+      ) -> void
+
+      def to_hash: -> Orb::Models::billable_metric
+
+      type status = :active | :draft | :archived
+
+      module Status
+        extend Orb::Enum
+
+        ACTIVE: :active
+        DRAFT: :draft
+        ARCHIVED: :archived
+
+        def self?.values: -> ::Array[Orb::Models::BillableMetric::status]
+      end
+    end
+  end
+end

data/sig/orb/models/billing_cycle_relative_date.rbs

@@ -0,0 +1,14 @@
+module Orb
+  module Models
+    type billing_cycle_relative_date = :start_of_term | :end_of_term
+
+    module BillingCycleRelativeDate
+      extend Orb::Enum
+
+      START_OF_TERM: :start_of_term
+      END_OF_TERM: :end_of_term
+
+      def self?.values: -> ::Array[Orb::Models::billing_cycle_relative_date]
+    end
+  end
+end

data/sig/orb/models/coupon.rbs

@@ -0,0 +1,51 @@
+module Orb
+  module Models
+    type coupon =
+      {
+        id: String,
+        archived_at: Time?,
+        discount: Orb::Models::Coupon::discount,
+        duration_in_months: Integer?,
+        max_redemptions: Integer?,
+        redemption_code: String,
+        times_redeemed: Integer
+      }
+
+    class Coupon < Orb::BaseModel
+      attr_accessor id: String
+
+      attr_accessor archived_at: Time?
+
+      attr_accessor discount: Orb::Models::Coupon::discount
+
+      attr_accessor duration_in_months: Integer?
+
+      attr_accessor max_redemptions: Integer?
+
+      attr_accessor redemption_code: String
+
+      attr_accessor times_redeemed: Integer
+
+      def initialize: (
+        id: String,
+        archived_at: Time?,
+        discount: Orb::Models::Coupon::discount,
+        duration_in_months: Integer?,
+        max_redemptions: Integer?,
+        redemption_code: String,
+        times_redeemed: Integer
+      ) -> void
+
+      def to_hash: -> Orb::Models::coupon
+
+      type discount =
+        Orb::Models::PercentageDiscount | Orb::Models::AmountDiscount
+
+      module Discount
+        extend Orb::Union
+
+        def self?.variants: -> [Orb::Models::PercentageDiscount, Orb::Models::AmountDiscount]
+      end
+    end
+  end
+end

data/sig/orb/models/coupon_archive_params.rbs

@@ -0,0 +1,14 @@
+module Orb
+  module Models
+    type coupon_archive_params = {  } & Orb::request_parameters
+
+    class CouponArchiveParams < Orb::BaseModel
+      extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      def initialize: (?request_options: Orb::request_opts) -> void
+
+      def to_hash: -> Orb::Models::coupon_archive_params
+    end
+  end
+end

data/sig/orb/models/coupon_create_params.rbs

@@ -0,0 +1,77 @@
+module Orb
+  module Models
+    type coupon_create_params =
+      {
+        discount: Orb::Models::CouponCreateParams::discount,
+        redemption_code: String,
+        duration_in_months: Integer?,
+        max_redemptions: Integer?
+      }
+      & Orb::request_parameters
+
+    class CouponCreateParams < Orb::BaseModel
+      extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      attr_accessor discount: Orb::Models::CouponCreateParams::discount
+
+      attr_accessor redemption_code: String
+
+      attr_accessor duration_in_months: Integer?
+
+      attr_accessor max_redemptions: Integer?
+
+      def initialize: (
+        discount: Orb::Models::CouponCreateParams::discount,
+        redemption_code: String,
+        ?duration_in_months: Integer?,
+        ?max_redemptions: Integer?,
+        ?request_options: Orb::request_opts
+      ) -> void
+
+      def to_hash: -> Orb::Models::coupon_create_params
+
+      type discount =
+        Orb::Models::CouponCreateParams::Discount::NewCouponPercentageDiscount
+        | Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount
+
+      module Discount
+        extend Orb::Union
+
+        type new_coupon_percentage_discount =
+          { discount_type: :percentage, percentage_discount: Float }
+
+        class NewCouponPercentageDiscount < Orb::BaseModel
+          attr_accessor discount_type: :percentage
+
+          attr_accessor percentage_discount: Float
+
+          def initialize: (
+            percentage_discount: Float,
+            ?discount_type: :percentage
+          ) -> void
+
+          def to_hash: -> Orb::Models::CouponCreateParams::Discount::new_coupon_percentage_discount
+        end
+
+        type new_coupon_amount_discount =
+          { amount_discount: String, discount_type: :amount }
+
+        class NewCouponAmountDiscount < Orb::BaseModel
+          attr_accessor amount_discount: String
+
+          attr_accessor discount_type: :amount
+
+          def initialize: (
+            amount_discount: String,
+            ?discount_type: :amount
+          ) -> void
+
+          def to_hash: -> Orb::Models::CouponCreateParams::Discount::new_coupon_amount_discount
+        end
+
+        def self?.variants: -> [Orb::Models::CouponCreateParams::Discount::NewCouponPercentageDiscount, Orb::Models::CouponCreateParams::Discount::NewCouponAmountDiscount]
+      end
+    end
+  end
+end

data/sig/orb/models/coupon_fetch_params.rbs

@@ -0,0 +1,14 @@
+module Orb
+  module Models
+    type coupon_fetch_params = {  } & Orb::request_parameters
+
+    class CouponFetchParams < Orb::BaseModel
+      extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      def initialize: (?request_options: Orb::request_opts) -> void
+
+      def to_hash: -> Orb::Models::coupon_fetch_params
+    end
+  end
+end

data/sig/orb/models/coupon_list_params.rbs

@@ -0,0 +1,37 @@
+module Orb
+  module Models
+    type coupon_list_params =
+      {
+        cursor: String?,
+        limit: Integer,
+        redemption_code: String?,
+        show_archived: bool?
+      }
+      & Orb::request_parameters
+
+    class CouponListParams < Orb::BaseModel
+      extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      attr_accessor cursor: String?
+
+      attr_reader limit: Integer?
+
+      def limit=: (Integer) -> Integer
+
+      attr_accessor redemption_code: String?
+
+      attr_accessor show_archived: bool?
+
+      def initialize: (
+        ?cursor: String?,
+        ?limit: Integer,
+        ?redemption_code: String?,
+        ?show_archived: bool?,
+        ?request_options: Orb::request_opts
+      ) -> void
+
+      def to_hash: -> Orb::Models::coupon_list_params
+    end
+  end
+end

data/sig/orb/models/coupons/subscription_list_params.rbs

@@ -0,0 +1,27 @@
+module Orb
+  module Models
+    module Coupons
+      type subscription_list_params =
+        { cursor: String?, limit: Integer } & Orb::request_parameters
+
+      class SubscriptionListParams < Orb::BaseModel
+        extend Orb::Type::RequestParameters::Converter
+        include Orb::RequestParameters
+
+        attr_accessor cursor: String?
+
+        attr_reader limit: Integer?
+
+        def limit=: (Integer) -> Integer
+
+        def initialize: (
+          ?cursor: String?,
+          ?limit: Integer,
+          ?request_options: Orb::request_opts
+        ) -> void
+
+        def to_hash: -> Orb::Models::Coupons::subscription_list_params
+      end
+    end
+  end
+end

data/sig/orb/models/credit_note.rbs

@@ -0,0 +1,345 @@
+module Orb
+  module Models
+    type credit_note =
+      {
+        id: String,
+        created_at: Time,
+        credit_note_number: String,
+        credit_note_pdf: String?,
+        customer: Orb::Models::CreditNote::Customer,
+        invoice_id: String,
+        line_items: ::Array[Orb::Models::CreditNote::LineItem],
+        maximum_amount_adjustment: Orb::Models::CreditNote::MaximumAmountAdjustment?,
+        memo: String?,
+        minimum_amount_refunded: String?,
+        reason: Orb::Models::CreditNote::reason?,
+        subtotal: String,
+        total: String,
+        type: Orb::Models::CreditNote::type_,
+        voided_at: Time?,
+        discounts: ::Array[Orb::Models::CreditNote::Discount]
+      }
+
+    class CreditNote < Orb::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor credit_note_number: String
+
+      attr_accessor credit_note_pdf: String?
+
+      attr_accessor customer: Orb::Models::CreditNote::Customer
+
+      attr_accessor invoice_id: String
+
+      attr_accessor line_items: ::Array[Orb::Models::CreditNote::LineItem]
+
+      attr_accessor maximum_amount_adjustment: Orb::Models::CreditNote::MaximumAmountAdjustment?
+
+      attr_accessor memo: String?
+
+      attr_accessor minimum_amount_refunded: String?
+
+      attr_accessor reason: Orb::Models::CreditNote::reason?
+
+      attr_accessor subtotal: String
+
+      attr_accessor total: String
+
+      attr_accessor type: Orb::Models::CreditNote::type_
+
+      attr_accessor voided_at: Time?
+
+      attr_reader discounts: ::Array[Orb::Models::CreditNote::Discount]?
+
+      def discounts=: (
+        ::Array[Orb::Models::CreditNote::Discount]
+      ) -> ::Array[Orb::Models::CreditNote::Discount]
+
+      def initialize: (
+        id: String,
+        created_at: Time,
+        credit_note_number: String,
+        credit_note_pdf: String?,
+        customer: Orb::Models::CreditNote::Customer,
+        invoice_id: String,
+        line_items: ::Array[Orb::Models::CreditNote::LineItem],
+        maximum_amount_adjustment: Orb::Models::CreditNote::MaximumAmountAdjustment?,
+        memo: String?,
+        minimum_amount_refunded: String?,
+        reason: Orb::Models::CreditNote::reason?,
+        subtotal: String,
+        total: String,
+        type: Orb::Models::CreditNote::type_,
+        voided_at: Time?,
+        ?discounts: ::Array[Orb::Models::CreditNote::Discount]
+      ) -> void
+
+      def to_hash: -> Orb::Models::credit_note
+
+      type customer = { id: String, external_customer_id: String? }
+
+      class Customer < Orb::BaseModel
+        attr_accessor id: String
+
+        attr_accessor external_customer_id: String?
+
+        def initialize: (id: String, external_customer_id: String?) -> void
+
+        def to_hash: -> Orb::Models::CreditNote::customer
+      end
+
+      type line_item =
+        {
+          id: String,
+          amount: String,
+          item_id: String,
+          name: String,
+          quantity: Float?,
+          subtotal: String,
+          tax_amounts: ::Array[Orb::Models::CreditNote::LineItem::TaxAmount],
+          discounts: ::Array[Orb::Models::CreditNote::LineItem::Discount]
+        }
+
+      class LineItem < Orb::BaseModel
+        attr_accessor id: String
+
+        attr_accessor amount: String
+
+        attr_accessor item_id: String
+
+        attr_accessor name: String
+
+        attr_accessor quantity: Float?
+
+        attr_accessor subtotal: String
+
+        attr_accessor tax_amounts: ::Array[Orb::Models::CreditNote::LineItem::TaxAmount]
+
+        attr_reader discounts: ::Array[Orb::Models::CreditNote::LineItem::Discount]?
+
+        def discounts=: (
+          ::Array[Orb::Models::CreditNote::LineItem::Discount]
+        ) -> ::Array[Orb::Models::CreditNote::LineItem::Discount]
+
+        def initialize: (
+          id: String,
+          amount: String,
+          item_id: String,
+          name: String,
+          quantity: Float?,
+          subtotal: String,
+          tax_amounts: ::Array[Orb::Models::CreditNote::LineItem::TaxAmount],
+          ?discounts: ::Array[Orb::Models::CreditNote::LineItem::Discount]
+        ) -> void
+
+        def to_hash: -> Orb::Models::CreditNote::line_item
+
+        type tax_amount =
+          {
+            amount: String,
+            tax_rate_description: String,
+            tax_rate_percentage: String?
+          }
+
+        class TaxAmount < Orb::BaseModel
+          attr_accessor amount: String
+
+          attr_accessor tax_rate_description: String
+
+          attr_accessor tax_rate_percentage: String?
+
+          def initialize: (
+            amount: String,
+            tax_rate_description: String,
+            tax_rate_percentage: String?
+          ) -> void
+
+          def to_hash: -> Orb::Models::CreditNote::LineItem::tax_amount
+        end
+
+        type discount =
+          {
+            id: String,
+            amount_applied: String,
+            applies_to_price_ids: ::Array[String],
+            discount_type: Orb::Models::CreditNote::LineItem::Discount::discount_type,
+            percentage_discount: Float,
+            amount_discount: String?,
+            reason: String?
+          }
+
+        class Discount < Orb::BaseModel
+          attr_accessor id: String
+
+          attr_accessor amount_applied: String
+
+          attr_accessor applies_to_price_ids: ::Array[String]
+
+          attr_accessor discount_type: Orb::Models::CreditNote::LineItem::Discount::discount_type
+
+          attr_accessor percentage_discount: Float
+
+          attr_accessor amount_discount: String?
+
+          attr_accessor reason: String?
+
+          def initialize: (
+            id: String,
+            amount_applied: String,
+            applies_to_price_ids: ::Array[String],
+            discount_type: Orb::Models::CreditNote::LineItem::Discount::discount_type,
+            percentage_discount: Float,
+            ?amount_discount: String?,
+            ?reason: String?
+          ) -> void
+
+          def to_hash: -> Orb::Models::CreditNote::LineItem::discount
+
+          type discount_type = :percentage | :amount
+
+          module DiscountType
+            extend Orb::Enum
+
+            PERCENTAGE: :percentage
+            AMOUNT: :amount
+
+            def self?.values: -> ::Array[Orb::Models::CreditNote::LineItem::Discount::discount_type]
+          end
+        end
+      end
+
+      type maximum_amount_adjustment =
+        {
+          amount_applied: String,
+          discount_type: Orb::Models::CreditNote::MaximumAmountAdjustment::discount_type,
+          percentage_discount: Float,
+          applies_to_prices: ::Array[Orb::Models::CreditNote::MaximumAmountAdjustment::AppliesToPrice]?,
+          reason: String?
+        }
+
+      class MaximumAmountAdjustment < Orb::BaseModel
+        attr_accessor amount_applied: String
+
+        attr_accessor discount_type: Orb::Models::CreditNote::MaximumAmountAdjustment::discount_type
+
+        attr_accessor percentage_discount: Float
+
+        attr_accessor applies_to_prices: ::Array[Orb::Models::CreditNote::MaximumAmountAdjustment::AppliesToPrice]?
+
+        attr_accessor reason: String?
+
+        def initialize: (
+          amount_applied: String,
+          discount_type: Orb::Models::CreditNote::MaximumAmountAdjustment::discount_type,
+          percentage_discount: Float,
+          ?applies_to_prices: ::Array[Orb::Models::CreditNote::MaximumAmountAdjustment::AppliesToPrice]?,
+          ?reason: String?
+        ) -> void
+
+        def to_hash: -> Orb::Models::CreditNote::maximum_amount_adjustment
+
+        type discount_type = :percentage
+
+        module DiscountType
+          extend Orb::Enum
+
+          PERCENTAGE: :percentage
+
+          def self?.values: -> ::Array[Orb::Models::CreditNote::MaximumAmountAdjustment::discount_type]
+        end
+
+        type applies_to_price = { id: String, name: String }
+
+        class AppliesToPrice < Orb::BaseModel
+          attr_accessor id: String
+
+          attr_accessor name: String
+
+          def initialize: (id: String, name: String) -> void
+
+          def to_hash: -> Orb::Models::CreditNote::MaximumAmountAdjustment::applies_to_price
+        end
+      end
+
+      type reason =
+        :Duplicate | :Fraudulent | :"Order change" | :"Product unsatisfactory"
+
+      module Reason
+        extend Orb::Enum
+
+        DUPLICATE: :Duplicate
+        FRAUDULENT: :Fraudulent
+        ORDER_CHANGE: :"Order change"
+        PRODUCT_UNSATISFACTORY: :"Product unsatisfactory"
+
+        def self?.values: -> ::Array[Orb::Models::CreditNote::reason]
+      end
+
+      type type_ = :refund | :adjustment
+
+      module Type
+        extend Orb::Enum
+
+        REFUND: :refund
+        ADJUSTMENT: :adjustment
+
+        def self?.values: -> ::Array[Orb::Models::CreditNote::type_]
+      end
+
+      type discount =
+        {
+          amount_applied: String,
+          discount_type: Orb::Models::CreditNote::Discount::discount_type,
+          percentage_discount: Float,
+          applies_to_prices: ::Array[Orb::Models::CreditNote::Discount::AppliesToPrice]?,
+          reason: String?
+        }
+
+      class Discount < Orb::BaseModel
+        attr_accessor amount_applied: String
+
+        attr_accessor discount_type: Orb::Models::CreditNote::Discount::discount_type
+
+        attr_accessor percentage_discount: Float
+
+        attr_accessor applies_to_prices: ::Array[Orb::Models::CreditNote::Discount::AppliesToPrice]?
+
+        attr_accessor reason: String?
+
+        def initialize: (
+          amount_applied: String,
+          discount_type: Orb::Models::CreditNote::Discount::discount_type,
+          percentage_discount: Float,
+          ?applies_to_prices: ::Array[Orb::Models::CreditNote::Discount::AppliesToPrice]?,
+          ?reason: String?
+        ) -> void
+
+        def to_hash: -> Orb::Models::CreditNote::discount
+
+        type discount_type = :percentage
+
+        module DiscountType
+          extend Orb::Enum
+
+          PERCENTAGE: :percentage
+
+          def self?.values: -> ::Array[Orb::Models::CreditNote::Discount::discount_type]
+        end
+
+        type applies_to_price = { id: String, name: String }
+
+        class AppliesToPrice < Orb::BaseModel
+          attr_accessor id: String
+
+          attr_accessor name: String
+
+          def initialize: (id: String, name: String) -> void
+
+          def to_hash: -> Orb::Models::CreditNote::Discount::applies_to_price
+        end
+      end
+    end
+  end
+end