orb-billing 0.1.0.pre.alpha.33

data/lib/orb.rb

@@ -0,0 +1,247 @@
+# frozen_string_literal: true
+
+# Standard libraries.
+require "English"
+require "cgi"
+require "date"
+require "erb"
+require "etc"
+require "json"
+require "net/http"
+require "pathname"
+require "rbconfig"
+require "securerandom"
+require "set"
+require "stringio"
+require "time"
+require "uri"
+
+# We already ship the preferred sorbet manifests in the package itself.
+# `tapioca` currently does not offer us a way to opt out of unnecessary compilation.
+if Object.const_defined?(:Tapioca) && caller.chain([$PROGRAM_NAME]).chain(ARGV).grep(/tapioca/)
+  Warning.warn(
+    <<~WARN
+      \n
+      ⚠️ skipped loading of "orb" gem under `tapioca`.
+
+      This message is normal and expected if you are running a `tapioca` command, and does not impact `.rbi` generation.
+      \n
+    WARN
+  )
+  return
+end
+
+# Gems.
+require "connection_pool"
+
+# Package files.
+require_relative "orb/version"
+require_relative "orb/util"
+require_relative "orb/type/converter"
+require_relative "orb/type/unknown"
+require_relative "orb/type/boolean_model"
+require_relative "orb/type/enum"
+require_relative "orb/type/union"
+require_relative "orb/type/array_of"
+require_relative "orb/type/hash_of"
+require_relative "orb/type/base_model"
+require_relative "orb/type/base_page"
+require_relative "orb/type/request_parameters"
+require_relative "orb/type"
+require_relative "orb/request_options"
+require_relative "orb/errors"
+require_relative "orb/transport/base_client"
+require_relative "orb/transport/pooled_net_requester"
+require_relative "orb/client"
+require_relative "orb/page"
+require_relative "orb/models/alert"
+require_relative "orb/models/alert_create_for_customer_params"
+require_relative "orb/models/alert_create_for_external_customer_params"
+require_relative "orb/models/alert_create_for_subscription_params"
+require_relative "orb/models/alert_disable_params"
+require_relative "orb/models/alert_enable_params"
+require_relative "orb/models/alert_list_params"
+require_relative "orb/models/alert_retrieve_params"
+require_relative "orb/models/alert_update_params"
+require_relative "orb/models/amount_discount"
+require_relative "orb/models/billable_metric"
+require_relative "orb/models/billing_cycle_relative_date"
+require_relative "orb/models/coupon"
+require_relative "orb/models/coupon_archive_params"
+require_relative "orb/models/coupon_create_params"
+require_relative "orb/models/coupon_fetch_params"
+require_relative "orb/models/coupon_list_params"
+require_relative "orb/models/coupons/subscription_list_params"
+require_relative "orb/models/credit_note"
+require_relative "orb/models/credit_note_create_params"
+require_relative "orb/models/credit_note_fetch_params"
+require_relative "orb/models/credit_note_list_params"
+require_relative "orb/models/customer"
+require_relative "orb/models/customer_create_params"
+require_relative "orb/models/customer_delete_params"
+require_relative "orb/models/customer_fetch_by_external_id_params"
+require_relative "orb/models/customer_fetch_params"
+require_relative "orb/models/customer_list_params"
+require_relative "orb/models/customers/balance_transaction_create_params"
+require_relative "orb/models/customers/balance_transaction_create_response"
+require_relative "orb/models/customers/balance_transaction_list_params"
+require_relative "orb/models/customers/balance_transaction_list_response"
+require_relative "orb/models/customers/cost_list_by_external_id_params"
+require_relative "orb/models/customers/cost_list_by_external_id_response"
+require_relative "orb/models/customers/cost_list_params"
+require_relative "orb/models/customers/cost_list_response"
+require_relative "orb/models/customers/credit_list_by_external_id_params"
+require_relative "orb/models/customers/credit_list_by_external_id_response"
+require_relative "orb/models/customers/credit_list_params"
+require_relative "orb/models/customers/credit_list_response"
+require_relative "orb/models/customers/credits/ledger_create_entry_by_external_id_params"
+require_relative "orb/models/customers/credits/ledger_create_entry_by_external_id_response"
+require_relative "orb/models/customers/credits/ledger_create_entry_params"
+require_relative "orb/models/customers/credits/ledger_create_entry_response"
+require_relative "orb/models/customers/credits/ledger_list_by_external_id_params"
+require_relative "orb/models/customers/credits/ledger_list_by_external_id_response"
+require_relative "orb/models/customers/credits/ledger_list_params"
+require_relative "orb/models/customers/credits/ledger_list_response"
+require_relative "orb/models/customers/credits/top_up_create_by_external_id_params"
+require_relative "orb/models/customers/credits/top_up_create_by_external_id_response"
+require_relative "orb/models/customers/credits/top_up_create_params"
+require_relative "orb/models/customers/credits/top_up_create_response"
+require_relative "orb/models/customers/credits/top_up_delete_by_external_id_params"
+require_relative "orb/models/customers/credits/top_up_delete_params"
+require_relative "orb/models/customers/credits/top_up_list_by_external_id_params"
+require_relative "orb/models/customers/credits/top_up_list_by_external_id_response"
+require_relative "orb/models/customers/credits/top_up_list_params"
+require_relative "orb/models/customers/credits/top_up_list_response"
+require_relative "orb/models/customer_sync_payment_methods_from_gateway_by_external_customer_id_params"
+require_relative "orb/models/customer_sync_payment_methods_from_gateway_params"
+require_relative "orb/models/customer_update_by_external_id_params"
+require_relative "orb/models/customer_update_params"
+require_relative "orb/models/dimensional_price_group"
+require_relative "orb/models/dimensional_price_group_create_params"
+require_relative "orb/models/dimensional_price_group_list_params"
+require_relative "orb/models/dimensional_price_group_retrieve_params"
+require_relative "orb/models/dimensional_price_groups/external_dimensional_price_group_id_retrieve_params"
+require_relative "orb/models/dimensional_price_groups"
+require_relative "orb/models/discount"
+require_relative "orb/models/evaluate_price_group"
+require_relative "orb/models/event_deprecate_params"
+require_relative "orb/models/event_deprecate_response"
+require_relative "orb/models/event_ingest_params"
+require_relative "orb/models/event_ingest_response"
+require_relative "orb/models/events/backfill_close_params"
+require_relative "orb/models/events/backfill_close_response"
+require_relative "orb/models/events/backfill_create_params"
+require_relative "orb/models/events/backfill_create_response"
+require_relative "orb/models/events/backfill_fetch_params"
+require_relative "orb/models/events/backfill_fetch_response"
+require_relative "orb/models/events/backfill_list_params"
+require_relative "orb/models/events/backfill_list_response"
+require_relative "orb/models/events/backfill_revert_params"
+require_relative "orb/models/events/backfill_revert_response"
+require_relative "orb/models/events/event_volumes"
+require_relative "orb/models/events/volume_list_params"
+require_relative "orb/models/event_search_params"
+require_relative "orb/models/event_search_response"
+require_relative "orb/models/event_update_params"
+require_relative "orb/models/event_update_response"
+require_relative "orb/models/invoice"
+require_relative "orb/models/invoice_create_params"
+require_relative "orb/models/invoice_fetch_params"
+require_relative "orb/models/invoice_fetch_upcoming_params"
+require_relative "orb/models/invoice_fetch_upcoming_response"
+require_relative "orb/models/invoice_issue_params"
+require_relative "orb/models/invoice_level_discount"
+require_relative "orb/models/invoice_line_item_create_params"
+require_relative "orb/models/invoice_line_item_create_response"
+require_relative "orb/models/invoice_list_params"
+require_relative "orb/models/invoice_mark_paid_params"
+require_relative "orb/models/invoice_pay_params"
+require_relative "orb/models/invoice_update_params"
+require_relative "orb/models/invoice_void_params"
+require_relative "orb/models/item"
+require_relative "orb/models/item_create_params"
+require_relative "orb/models/item_fetch_params"
+require_relative "orb/models/item_list_params"
+require_relative "orb/models/item_update_params"
+require_relative "orb/models/metric_create_params"
+require_relative "orb/models/metric_fetch_params"
+require_relative "orb/models/metric_list_params"
+require_relative "orb/models/metric_update_params"
+require_relative "orb/models/pagination_metadata"
+require_relative "orb/models/percentage_discount"
+require_relative "orb/models/plan"
+require_relative "orb/models/plan_create_params"
+require_relative "orb/models/plan_fetch_params"
+require_relative "orb/models/plan_list_params"
+require_relative "orb/models/plans/external_plan_id_fetch_params"
+require_relative "orb/models/plans/external_plan_id_update_params"
+require_relative "orb/models/plan_update_params"
+require_relative "orb/models/price"
+require_relative "orb/models/price_create_params"
+require_relative "orb/models/price_evaluate_params"
+require_relative "orb/models/price_evaluate_response"
+require_relative "orb/models/price_fetch_params"
+require_relative "orb/models/price_list_params"
+require_relative "orb/models/prices/external_price_id_fetch_params"
+require_relative "orb/models/prices/external_price_id_update_params"
+require_relative "orb/models/price_update_params"
+require_relative "orb/models/subscription"
+require_relative "orb/models/subscription_cancel_params"
+require_relative "orb/models/subscription_cancel_response"
+require_relative "orb/models/subscription_create_params"
+require_relative "orb/models/subscription_create_response"
+require_relative "orb/models/subscription_fetch_costs_params"
+require_relative "orb/models/subscription_fetch_costs_response"
+require_relative "orb/models/subscription_fetch_params"
+require_relative "orb/models/subscription_fetch_schedule_params"
+require_relative "orb/models/subscription_fetch_schedule_response"
+require_relative "orb/models/subscription_fetch_usage_params"
+require_relative "orb/models/subscription_list_params"
+require_relative "orb/models/subscription_price_intervals_params"
+require_relative "orb/models/subscription_price_intervals_response"
+require_relative "orb/models/subscriptions"
+require_relative "orb/models/subscription_schedule_plan_change_params"
+require_relative "orb/models/subscription_schedule_plan_change_response"
+require_relative "orb/models/subscription_trigger_phase_params"
+require_relative "orb/models/subscription_trigger_phase_response"
+require_relative "orb/models/subscription_unschedule_cancellation_params"
+require_relative "orb/models/subscription_unschedule_cancellation_response"
+require_relative "orb/models/subscription_unschedule_fixed_fee_quantity_updates_params"
+require_relative "orb/models/subscription_unschedule_fixed_fee_quantity_updates_response"
+require_relative "orb/models/subscription_unschedule_pending_plan_changes_params"
+require_relative "orb/models/subscription_unschedule_pending_plan_changes_response"
+require_relative "orb/models/subscription_update_fixed_fee_quantity_params"
+require_relative "orb/models/subscription_update_fixed_fee_quantity_response"
+require_relative "orb/models/subscription_update_params"
+require_relative "orb/models/subscription_update_trial_params"
+require_relative "orb/models/subscription_update_trial_response"
+require_relative "orb/models/subscription_usage"
+require_relative "orb/models/top_level_ping_params"
+require_relative "orb/models/top_level_ping_response"
+require_relative "orb/models/trial_discount"
+require_relative "orb/models/usage_discount"
+require_relative "orb/resources/alerts"
+require_relative "orb/resources/coupons"
+require_relative "orb/resources/coupons/subscriptions"
+require_relative "orb/resources/credit_notes"
+require_relative "orb/resources/customers"
+require_relative "orb/resources/customers/balance_transactions"
+require_relative "orb/resources/customers/costs"
+require_relative "orb/resources/customers/credits"
+require_relative "orb/resources/customers/credits/ledger"
+require_relative "orb/resources/customers/credits/top_ups"
+require_relative "orb/resources/dimensional_price_groups"
+require_relative "orb/resources/dimensional_price_groups/external_dimensional_price_group_id"
+require_relative "orb/resources/events"
+require_relative "orb/resources/events/backfills"
+require_relative "orb/resources/events/volume"
+require_relative "orb/resources/invoice_line_items"
+require_relative "orb/resources/invoices"
+require_relative "orb/resources/items"
+require_relative "orb/resources/metrics"
+require_relative "orb/resources/plans"
+require_relative "orb/resources/plans/external_plan_id"
+require_relative "orb/resources/prices"
+require_relative "orb/resources/prices/external_price_id"
+require_relative "orb/resources/subscriptions"
+require_relative "orb/resources/top_level"

data/manifest.yaml

@@ -0,0 +1,15 @@
+dependencies:
+  - English
+  - cgi
+  - date
+  - erb
+  - etc
+  - json
+  - net/http
+  - pathname
+  - rbconfig
+  - securerandom
+  - set
+  - stringio
+  - time
+  - uri

data/rbi/lib/orb/client.rbi

@@ -0,0 +1,90 @@
+# typed: strong
+
+module Orb
+  class Client < Orb::Transport::BaseClient
+    DEFAULT_MAX_RETRIES = 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS = T.let(60.0, Float)
+
+    DEFAULT_INITIAL_RETRY_DELAY = T.let(0.5, Float)
+
+    DEFAULT_MAX_RETRY_DELAY = T.let(8.0, Float)
+
+    sig { returns(String) }
+    attr_reader :api_key
+
+    sig { returns(Orb::Resources::TopLevel) }
+    attr_reader :top_level
+
+    sig { returns(Orb::Resources::Coupons) }
+    attr_reader :coupons
+
+    sig { returns(Orb::Resources::CreditNotes) }
+    attr_reader :credit_notes
+
+    sig { returns(Orb::Resources::Customers) }
+    attr_reader :customers
+
+    sig { returns(Orb::Resources::Events) }
+    attr_reader :events
+
+    sig { returns(Orb::Resources::InvoiceLineItems) }
+    attr_reader :invoice_line_items
+
+    sig { returns(Orb::Resources::Invoices) }
+    attr_reader :invoices
+
+    sig { returns(Orb::Resources::Items) }
+    attr_reader :items
+
+    sig { returns(Orb::Resources::Metrics) }
+    attr_reader :metrics
+
+    sig { returns(Orb::Resources::Plans) }
+    attr_reader :plans
+
+    sig { returns(Orb::Resources::Prices) }
+    attr_reader :prices
+
+    sig { returns(Orb::Resources::Subscriptions) }
+    attr_reader :subscriptions
+
+    sig { returns(Orb::Resources::Alerts) }
+    attr_reader :alerts
+
+    sig { returns(Orb::Resources::DimensionalPriceGroups) }
+    attr_reader :dimensional_price_groups
+
+    # @api private
+    sig { override.returns(T::Hash[String, String]) }
+    private def auth_headers
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    sig do
+      params(
+        api_key: T.nilable(String),
+        base_url: T.nilable(String),
+        max_retries: Integer,
+        timeout: Float,
+        initial_retry_delay: Float,
+        max_retry_delay: Float,
+        idempotency_header: String
+      )
+        .returns(T.attached_class)
+    end
+    def self.new(
+      # Defaults to `ENV["ORB_API_KEY"]`
+      api_key: ENV["ORB_API_KEY"],
+      # Override the default base URL for the API, e.g., `"https://api.example.com/v2/"`
+      base_url: nil,
+      # Max number of retries to attempt after a failed retryable request.
+      max_retries: DEFAULT_MAX_RETRIES,
+      timeout: DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: DEFAULT_MAX_RETRY_DELAY,
+      idempotency_header: "Idempotency-Key"
+    )
+    end
+  end
+end

data/rbi/lib/orb/errors.rbi

@@ -0,0 +1,246 @@
+# typed: strong
+
+module Orb
+  module Errors
+    class Error < StandardError
+      sig { returns(T.nilable(StandardError)) }
+      attr_accessor :cause
+    end
+
+    class ConversionError < Orb::Errors::Error
+    end
+
+    class APIError < Orb::Errors::Error
+      sig { returns(URI::Generic) }
+      attr_accessor :url
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :status
+
+      sig { returns(T.nilable(T.anything)) }
+      attr_accessor :body
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: T.nilable(Integer),
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: nil)
+      end
+    end
+
+    class APIConnectionError < Orb::Errors::APIError
+      sig { void }
+      attr_accessor :status
+
+      sig { void }
+      attr_accessor :body
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: NilClass,
+          body: NilClass,
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Connection error.")
+      end
+    end
+
+    class APITimeoutError < Orb::Errors::APIConnectionError
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: NilClass,
+          body: NilClass,
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(url:, status: nil, body: nil, request: nil, response: nil, message: "Request timed out.")
+      end
+    end
+
+    class APIStatusError < Orb::Errors::APIError
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: Integer,
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        )
+          .returns(T.attached_class)
+      end
+      def self.for(url:, status:, body:, request:, response:, message: nil)
+      end
+
+      sig { returns(Integer) }
+      attr_accessor :status
+
+      # @api private
+      sig do
+        params(
+          url: URI::Generic,
+          status: Integer,
+          body: T.nilable(Object),
+          request: NilClass,
+          response: NilClass,
+          message: T.nilable(String)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(url:, status:, body:, request:, response:, message: nil)
+      end
+    end
+
+    class BadRequestError < Orb::Errors::APIStatusError
+      HTTP_STATUS = 400
+    end
+
+    class AuthenticationError < Orb::Errors::APIStatusError
+      HTTP_STATUS = 401
+    end
+
+    class PermissionDeniedError < Orb::Errors::APIStatusError
+      HTTP_STATUS = 403
+    end
+
+    class NotFoundError < Orb::Errors::APIStatusError
+      HTTP_STATUS = 404
+    end
+
+    class ConflictError < Orb::Errors::APIStatusError
+      HTTP_STATUS = 409
+    end
+
+    class UnprocessableEntityError < Orb::Errors::APIStatusError
+      HTTP_STATUS = 422
+    end
+
+    class RateLimitError < Orb::Errors::APIStatusError
+      HTTP_STATUS = 429
+    end
+
+    class InternalServerError < Orb::Errors::APIStatusError
+      HTTP_STATUS = T.let((500..), T::Range[Integer])
+    end
+
+    class ConstraintViolation < Orb::Errors::BadRequestError
+      TYPE = "https://docs.withorb.com/reference/error-responses#400-constraint-violation"
+    end
+
+    class DuplicateResourceCreation < Orb::Errors::BadRequestError
+      TYPE = "https://docs.withorb.com/reference/error-responses#400-duplicate-resource-creation"
+    end
+
+    class FeatureNotAvailable < Orb::Errors::BadRequestError
+      TYPE = "https://docs.withorb.com/reference/error-responses#404-feature-not-available"
+    end
+
+    class RequestValidationError < Orb::Errors::BadRequestError
+      TYPE = "https://docs.withorb.com/reference/error-responses#400-request-validation-errors"
+    end
+
+    class OrbAuthenticationError < Orb::Errors::AuthenticationError
+      TYPE = "https://docs.withorb.com/reference/error-responses#401-authentication-error"
+    end
+
+    class ResourceNotFound < Orb::Errors::NotFoundError
+      TYPE = "https://docs.withorb.com/reference/error-responses#404-resource-not-found"
+    end
+
+    class URLNotFound < Orb::Errors::NotFoundError
+      TYPE = "https://docs.withorb.com/reference/error-responses#404-url-not-found"
+    end
+
+    class ResourceConflict < Orb::Errors::ConflictError
+      TYPE = "https://docs.withorb.com/reference/error-responses#409-resource-conflict"
+    end
+
+    class RequestTooLarge < Orb::Errors::APIStatusError
+      TYPE = "https://docs.withorb.com/reference/error-responses#413-request-too-large"
+    end
+
+    class ResourceTooLarge < Orb::Errors::APIStatusError
+      TYPE = "https://docs.withorb.com/reference/error-responses#413-resource-too-large"
+    end
+
+    class TooManyRequests < Orb::Errors::RateLimitError
+      TYPE = "https://docs.withorb.com/reference/error-responses#429-too-many-requests"
+    end
+
+    class OrbInternalServerError < Orb::Errors::InternalServerError
+      TYPE = "https://docs.withorb.com/reference/error-responses#500-internal-server-error"
+    end
+  end
+
+  Error = Orb::Errors::Error
+
+  ConversionError = Orb::Errors::ConversionError
+
+  APIError = Orb::Errors::APIError
+
+  APIStatusError = Orb::Errors::APIStatusError
+
+  APIConnectionError = Orb::Errors::APIConnectionError
+
+  APITimeoutError = Orb::Errors::APITimeoutError
+
+  BadRequestError = Orb::Errors::BadRequestError
+
+  AuthenticationError = Orb::Errors::AuthenticationError
+
+  PermissionDeniedError = Orb::Errors::PermissionDeniedError
+
+  NotFoundError = Orb::Errors::NotFoundError
+
+  ConflictError = Orb::Errors::ConflictError
+
+  UnprocessableEntityError = Orb::Errors::UnprocessableEntityError
+
+  RateLimitError = Orb::Errors::RateLimitError
+
+  InternalServerError = Orb::Errors::InternalServerError
+
+  ConstraintViolation = Orb::Errors::ConstraintViolation
+
+  DuplicateResourceCreation = Orb::Errors::DuplicateResourceCreation
+
+  FeatureNotAvailable = Orb::Errors::FeatureNotAvailable
+
+  RequestValidationError = Orb::Errors::RequestValidationError
+
+  OrbAuthenticationError = Orb::Errors::OrbAuthenticationError
+
+  ResourceNotFound = Orb::Errors::ResourceNotFound
+
+  URLNotFound = Orb::Errors::URLNotFound
+
+  ResourceConflict = Orb::Errors::ResourceConflict
+
+  RequestTooLarge = Orb::Errors::RequestTooLarge
+
+  ResourceTooLarge = Orb::Errors::ResourceTooLarge
+
+  TooManyRequests = Orb::Errors::TooManyRequests
+
+  OrbInternalServerError = Orb::Errors::OrbInternalServerError
+end