orb-billing 0.1.0.pre.alpha.33

data/sig/orb/models/subscription_usage.rbs

@@ -0,0 +1,196 @@
+module Orb
+  module Models
+    type subscription_usage =
+      Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage
+      | Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage
+
+    module SubscriptionUsage
+      extend Orb::Union
+
+      type ungrouped_subscription_usage =
+        {
+          data: ::Array[Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data]
+        }
+
+      class UngroupedSubscriptionUsage < Orb::BaseModel
+        attr_accessor data: ::Array[Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data]
+
+        def initialize: (
+          data: ::Array[Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data]
+        ) -> void
+
+        def to_hash: -> Orb::Models::SubscriptionUsage::ungrouped_subscription_usage
+
+        type data =
+          {
+            billable_metric: Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::BillableMetric,
+            usage: ::Array[Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::Usage],
+            view_mode: Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::view_mode
+          }
+
+        class Data < Orb::BaseModel
+          attr_accessor billable_metric: Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::BillableMetric
+
+          attr_accessor usage: ::Array[Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::Usage]
+
+          attr_accessor view_mode: Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::view_mode
+
+          def initialize: (
+            billable_metric: Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::BillableMetric,
+            usage: ::Array[Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::Usage],
+            view_mode: Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::view_mode
+          ) -> void
+
+          def to_hash: -> Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::data
+
+          type billable_metric = { id: String, name: String }
+
+          class BillableMetric < Orb::BaseModel
+            attr_accessor id: String
+
+            attr_accessor name: String
+
+            def initialize: (id: String, name: String) -> void
+
+            def to_hash: -> Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::billable_metric
+          end
+
+          type usage =
+            { quantity: Float, timeframe_end: Time, timeframe_start: Time }
+
+          class Usage < Orb::BaseModel
+            attr_accessor quantity: Float
+
+            attr_accessor timeframe_end: Time
+
+            attr_accessor timeframe_start: Time
+
+            def initialize: (
+              quantity: Float,
+              timeframe_end: Time,
+              timeframe_start: Time
+            ) -> void
+
+            def to_hash: -> Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::usage
+          end
+
+          type view_mode = :periodic | :cumulative
+
+          module ViewMode
+            extend Orb::Enum
+
+            PERIODIC: :periodic
+            CUMULATIVE: :cumulative
+
+            def self?.values: -> ::Array[Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage::Data::view_mode]
+          end
+        end
+      end
+
+      type grouped_subscription_usage =
+        {
+          data: ::Array[Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data],
+          pagination_metadata: Orb::Models::PaginationMetadata?
+        }
+
+      class GroupedSubscriptionUsage < Orb::BaseModel
+        attr_accessor data: ::Array[Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data]
+
+        attr_accessor pagination_metadata: Orb::Models::PaginationMetadata?
+
+        def initialize: (
+          data: ::Array[Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data],
+          ?pagination_metadata: Orb::Models::PaginationMetadata?
+        ) -> void
+
+        def to_hash: -> Orb::Models::SubscriptionUsage::grouped_subscription_usage
+
+        type data =
+          {
+            billable_metric: Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::BillableMetric,
+            metric_group: Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::MetricGroup,
+            usage: ::Array[Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::Usage],
+            view_mode: Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::view_mode
+          }
+
+        class Data < Orb::BaseModel
+          attr_accessor billable_metric: Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::BillableMetric
+
+          attr_accessor metric_group: Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::MetricGroup
+
+          attr_accessor usage: ::Array[Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::Usage]
+
+          attr_accessor view_mode: Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::view_mode
+
+          def initialize: (
+            billable_metric: Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::BillableMetric,
+            metric_group: Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::MetricGroup,
+            usage: ::Array[Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::Usage],
+            view_mode: Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::view_mode
+          ) -> void
+
+          def to_hash: -> Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::data
+
+          type billable_metric = { id: String, name: String }
+
+          class BillableMetric < Orb::BaseModel
+            attr_accessor id: String
+
+            attr_accessor name: String
+
+            def initialize: (id: String, name: String) -> void
+
+            def to_hash: -> Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::billable_metric
+          end
+
+          type metric_group = { property_key: String, property_value: String }
+
+          class MetricGroup < Orb::BaseModel
+            attr_accessor property_key: String
+
+            attr_accessor property_value: String
+
+            def initialize: (
+              property_key: String,
+              property_value: String
+            ) -> void
+
+            def to_hash: -> Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::metric_group
+          end
+
+          type usage =
+            { quantity: Float, timeframe_end: Time, timeframe_start: Time }
+
+          class Usage < Orb::BaseModel
+            attr_accessor quantity: Float
+
+            attr_accessor timeframe_end: Time
+
+            attr_accessor timeframe_start: Time
+
+            def initialize: (
+              quantity: Float,
+              timeframe_end: Time,
+              timeframe_start: Time
+            ) -> void
+
+            def to_hash: -> Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::usage
+          end
+
+          type view_mode = :periodic | :cumulative
+
+          module ViewMode
+            extend Orb::Enum
+
+            PERIODIC: :periodic
+            CUMULATIVE: :cumulative
+
+            def self?.values: -> ::Array[Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage::Data::view_mode]
+          end
+        end
+      end
+
+      def self?.variants: -> [Orb::Models::SubscriptionUsage::UngroupedSubscriptionUsage, Orb::Models::SubscriptionUsage::GroupedSubscriptionUsage]
+    end
+  end
+end

data/sig/orb/models/subscriptions.rbs

@@ -0,0 +1,22 @@
+module Orb
+  module Models
+    type subscriptions_api =
+      {
+        data: ::Array[Orb::Models::Subscription],
+        pagination_metadata: Orb::Models::PaginationMetadata
+      }
+
+    class SubscriptionsAPI < Orb::BaseModel
+      attr_accessor data: ::Array[Orb::Models::Subscription]
+
+      attr_accessor pagination_metadata: Orb::Models::PaginationMetadata
+
+      def initialize: (
+        data: ::Array[Orb::Models::Subscription],
+        pagination_metadata: Orb::Models::PaginationMetadata
+      ) -> void
+
+      def to_hash: -> Orb::Models::subscriptions_api
+    end
+  end
+end

data/sig/orb/models/top_level_ping_params.rbs

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

data/sig/orb/models/top_level_ping_response.rbs

@@ -0,0 +1,13 @@
+module Orb
+  module Models
+    type top_level_ping_response = { response: String }
+
+    class TopLevelPingResponse < Orb::BaseModel
+      attr_accessor response: String
+
+      def initialize: (response: String) -> void
+
+      def to_hash: -> Orb::Models::top_level_ping_response
+    end
+  end
+end

data/sig/orb/models/trial_discount.rbs

@@ -0,0 +1,44 @@
+module Orb
+  module Models
+    type trial_discount =
+      {
+        applies_to_price_ids: ::Array[String],
+        discount_type: Orb::Models::TrialDiscount::discount_type,
+        reason: String?,
+        trial_amount_discount: String?,
+        trial_percentage_discount: Float?
+      }
+
+    class TrialDiscount < Orb::BaseModel
+      attr_accessor applies_to_price_ids: ::Array[String]
+
+      attr_accessor discount_type: Orb::Models::TrialDiscount::discount_type
+
+      attr_accessor reason: String?
+
+      attr_accessor trial_amount_discount: String?
+
+      attr_accessor trial_percentage_discount: Float?
+
+      def initialize: (
+        applies_to_price_ids: ::Array[String],
+        discount_type: Orb::Models::TrialDiscount::discount_type,
+        ?reason: String?,
+        ?trial_amount_discount: String?,
+        ?trial_percentage_discount: Float?
+      ) -> void
+
+      def to_hash: -> Orb::Models::trial_discount
+
+      type discount_type = :trial
+
+      module DiscountType
+        extend Orb::Enum
+
+        TRIAL: :trial
+
+        def self?.values: -> ::Array[Orb::Models::TrialDiscount::discount_type]
+      end
+    end
+  end
+end

data/sig/orb/models/usage_discount.rbs

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

data/sig/orb/page.rbs

@@ -0,0 +1,22 @@
+module Orb
+  class Page[Elem]
+    include Orb::Type::BasePage[Elem]
+
+    attr_accessor data: ::Array[Elem]?
+
+    attr_accessor pagination_metadata: PaginationMetadata
+
+    def inspect: -> String
+
+    type pagination_metadata = { has_more: bool, next_cursor: String? }
+    class PaginationMetadata < Orb::BaseModel
+      attr_accessor has_more: bool
+
+      attr_accessor next_cursor: String?
+
+      def initialize: (has_more: bool, next_cursor: String?) -> void
+
+      def to_hash: -> pagination_metadata
+    end
+  end
+end

data/sig/orb/request_options.rbs

@@ -0,0 +1,32 @@
+module Orb
+  type request_opts =
+    Orb::RequestOptions | Orb::request_options | ::Hash[Symbol, top]
+
+  type request_options =
+    {
+      idempotency_key: String?,
+      extra_query: ::Hash[String, (::Array[String] | String)?]?,
+      extra_headers: ::Hash[String, String?]?,
+      extra_body: top?,
+      max_retries: Integer?,
+      timeout: Float?
+    }
+
+  class RequestOptions < Orb::BaseModel
+    def self.validate!: (self | ::Hash[Symbol, top] opts) -> void
+
+    attr_accessor idempotency_key: String?
+
+    attr_accessor extra_query: ::Hash[String, (::Array[String] | String)?]?
+
+    attr_accessor extra_headers: ::Hash[String, String?]?
+
+    attr_accessor extra_body: top?
+
+    attr_accessor max_retries: Integer?
+
+    attr_accessor timeout: Float?
+
+    def initialize: (?Orb::request_options | ::Hash[Symbol, top] values) -> void
+  end
+end

data/sig/orb/resources/alerts.rbs

@@ -0,0 +1,67 @@
+module Orb
+  module Resources
+    class Alerts
+      def retrieve: (
+        String alert_id,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Alert
+
+      def update: (
+        String alert_configuration_id,
+        thresholds: ::Array[Orb::Models::AlertUpdateParams::Threshold],
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Alert
+
+      def list: (
+        ?created_at_gt: Time?,
+        ?created_at_gte: Time?,
+        ?created_at_lt: Time?,
+        ?created_at_lte: Time?,
+        ?cursor: String?,
+        ?customer_id: String?,
+        ?external_customer_id: String?,
+        ?limit: Integer,
+        ?subscription_id: String?,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Page[Orb::Models::Alert]
+
+      def create_for_customer: (
+        String customer_id,
+        currency: String,
+        type: Orb::Models::AlertCreateForCustomerParams::type_,
+        ?thresholds: ::Array[Orb::Models::AlertCreateForCustomerParams::Threshold]?,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Alert
+
+      def create_for_external_customer: (
+        String external_customer_id,
+        currency: String,
+        type: Orb::Models::AlertCreateForExternalCustomerParams::type_,
+        ?thresholds: ::Array[Orb::Models::AlertCreateForExternalCustomerParams::Threshold]?,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Alert
+
+      def create_for_subscription: (
+        String subscription_id,
+        thresholds: ::Array[Orb::Models::AlertCreateForSubscriptionParams::Threshold],
+        type: Orb::Models::AlertCreateForSubscriptionParams::type_,
+        ?metric_id: String?,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Alert
+
+      def disable: (
+        String alert_configuration_id,
+        ?subscription_id: String?,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Alert
+
+      def enable: (
+        String alert_configuration_id,
+        ?subscription_id: String?,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Alert
+
+      def initialize: (client: Orb::Client) -> void
+    end
+  end
+end

data/sig/orb/resources/coupons/subscriptions.rbs

@@ -0,0 +1,16 @@
+module Orb
+  module Resources
+    class Coupons
+      class Subscriptions
+        def list: (
+          String coupon_id,
+          ?cursor: String?,
+          ?limit: Integer,
+          ?request_options: Orb::request_opts
+        ) -> Orb::Page[Orb::Models::Subscription]
+
+        def initialize: (client: Orb::Client) -> void
+      end
+    end
+  end
+end

data/sig/orb/resources/coupons.rbs

@@ -0,0 +1,35 @@
+module Orb
+  module Resources
+    class Coupons
+      attr_reader subscriptions: Orb::Resources::Coupons::Subscriptions
+
+      def create: (
+        discount: Orb::Models::CouponCreateParams::discount,
+        redemption_code: String,
+        ?duration_in_months: Integer?,
+        ?max_redemptions: Integer?,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Coupon
+
+      def list: (
+        ?cursor: String?,
+        ?limit: Integer,
+        ?redemption_code: String?,
+        ?show_archived: bool?,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Page[Orb::Models::Coupon]
+
+      def archive: (
+        String coupon_id,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Coupon
+
+      def fetch: (
+        String coupon_id,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Coupon
+
+      def initialize: (client: Orb::Client) -> void
+    end
+  end
+end

data/sig/orb/resources/credit_notes.rbs

@@ -0,0 +1,29 @@
+module Orb
+  module Resources
+    class CreditNotes
+      def create: (
+        line_items: ::Array[Orb::Models::CreditNoteCreateParams::LineItem],
+        ?memo: String?,
+        ?reason: Orb::Models::CreditNoteCreateParams::reason?,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::CreditNote
+
+      def list: (
+        ?created_at_gt: Time?,
+        ?created_at_gte: Time?,
+        ?created_at_lt: Time?,
+        ?created_at_lte: Time?,
+        ?cursor: String?,
+        ?limit: Integer,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Page[Orb::Models::CreditNote]
+
+      def fetch: (
+        String credit_note_id,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::CreditNote
+
+      def initialize: (client: Orb::Client) -> void
+    end
+  end
+end

data/sig/orb/resources/customers/balance_transactions.rbs

@@ -0,0 +1,28 @@
+module Orb
+  module Resources
+    class Customers
+      class BalanceTransactions
+        def create: (
+          String customer_id,
+          amount: String,
+          type: Orb::Models::Customers::BalanceTransactionCreateParams::type_,
+          ?description: String?,
+          ?request_options: Orb::request_opts
+        ) -> Orb::Models::Customers::BalanceTransactionCreateResponse
+
+        def list: (
+          String customer_id,
+          ?cursor: String?,
+          ?limit: Integer,
+          ?operation_time_gt: Time?,
+          ?operation_time_gte: Time?,
+          ?operation_time_lt: Time?,
+          ?operation_time_lte: Time?,
+          ?request_options: Orb::request_opts
+        ) -> Orb::Page[Orb::Models::Customers::BalanceTransactionListResponse]
+
+        def initialize: (client: Orb::Client) -> void
+      end
+    end
+  end
+end

data/sig/orb/resources/customers/costs.rbs

@@ -0,0 +1,27 @@
+module Orb
+  module Resources
+    class Customers
+      class Costs
+        def list: (
+          String customer_id,
+          ?currency: String?,
+          ?timeframe_end: Time?,
+          ?timeframe_start: Time?,
+          ?view_mode: Orb::Models::Customers::CostListParams::view_mode?,
+          ?request_options: Orb::request_opts
+        ) -> Orb::Models::Customers::CostListResponse
+
+        def list_by_external_id: (
+          String external_customer_id,
+          ?currency: String?,
+          ?timeframe_end: Time?,
+          ?timeframe_start: Time?,
+          ?view_mode: Orb::Models::Customers::CostListByExternalIDParams::view_mode?,
+          ?request_options: Orb::request_opts
+        ) -> Orb::Models::Customers::CostListByExternalIDResponse
+
+        def initialize: (client: Orb::Client) -> void
+      end
+    end
+  end
+end

data/sig/orb/resources/customers/credits/ledger.rbs

@@ -0,0 +1,75 @@
+module Orb
+  module Resources
+    class Customers
+      class Credits
+        class Ledger
+          def list: (
+            String customer_id,
+            ?created_at_gt: Time?,
+            ?created_at_gte: Time?,
+            ?created_at_lt: Time?,
+            ?created_at_lte: Time?,
+            ?currency: String?,
+            ?cursor: String?,
+            ?entry_status: Orb::Models::Customers::Credits::LedgerListParams::entry_status?,
+            ?entry_type: Orb::Models::Customers::Credits::LedgerListParams::entry_type?,
+            ?limit: Integer,
+            ?minimum_amount: String?,
+            ?request_options: Orb::request_opts
+          ) -> Orb::Page[Orb::Models::Customers::Credits::ledger_list_response]
+
+          def create_entry: (
+            String customer_id,
+            amount: Float,
+            entry_type: Orb::Models::Customers::Credits::LedgerCreateEntryParams::entry_type,
+            expiry_date: Time?,
+            target_expiry_date: Date,
+            block_id: String,
+            ?currency: String?,
+            ?description: String?,
+            ?effective_date: Time?,
+            ?invoice_settings: Orb::Models::Customers::Credits::LedgerCreateEntryParams::InvoiceSettings?,
+            ?metadata: ::Hash[Symbol, String?]?,
+            ?per_unit_cost_basis: String?,
+            ?void_reason: Orb::Models::Customers::Credits::LedgerCreateEntryParams::void_reason?,
+            ?request_options: Orb::request_opts
+          ) -> Orb::Models::Customers::Credits::ledger_create_entry_response
+
+          def create_entry_by_external_id: (
+            String external_customer_id,
+            amount: Float,
+            entry_type: Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::entry_type,
+            expiry_date: Time?,
+            target_expiry_date: Date,
+            block_id: String,
+            ?currency: String?,
+            ?description: String?,
+            ?effective_date: Time?,
+            ?invoice_settings: Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::InvoiceSettings?,
+            ?metadata: ::Hash[Symbol, String?]?,
+            ?per_unit_cost_basis: String?,
+            ?void_reason: Orb::Models::Customers::Credits::LedgerCreateEntryByExternalIDParams::void_reason?,
+            ?request_options: Orb::request_opts
+          ) -> Orb::Models::Customers::Credits::ledger_create_entry_by_external_id_response
+
+          def list_by_external_id: (
+            String external_customer_id,
+            ?created_at_gt: Time?,
+            ?created_at_gte: Time?,
+            ?created_at_lt: Time?,
+            ?created_at_lte: Time?,
+            ?currency: String?,
+            ?cursor: String?,
+            ?entry_status: Orb::Models::Customers::Credits::LedgerListByExternalIDParams::entry_status?,
+            ?entry_type: Orb::Models::Customers::Credits::LedgerListByExternalIDParams::entry_type?,
+            ?limit: Integer,
+            ?minimum_amount: String?,
+            ?request_options: Orb::request_opts
+          ) -> Orb::Page[Orb::Models::Customers::Credits::ledger_list_by_external_id_response]
+
+          def initialize: (client: Orb::Client) -> void
+        end
+      end
+    end
+  end
+end