orb-billing 0.1.0.pre.alpha.33

data/sig/orb/client.rbs

@@ -0,0 +1,53 @@
+module Orb
+  class Client < Orb::Transport::BaseClient
+    DEFAULT_MAX_RETRIES: 2
+
+    DEFAULT_TIMEOUT_IN_SECONDS: Float
+
+    DEFAULT_INITIAL_RETRY_DELAY: Float
+
+    DEFAULT_MAX_RETRY_DELAY: Float
+
+    attr_reader api_key: String
+
+    attr_reader top_level: Orb::Resources::TopLevel
+
+    attr_reader coupons: Orb::Resources::Coupons
+
+    attr_reader credit_notes: Orb::Resources::CreditNotes
+
+    attr_reader customers: Orb::Resources::Customers
+
+    attr_reader events: Orb::Resources::Events
+
+    attr_reader invoice_line_items: Orb::Resources::InvoiceLineItems
+
+    attr_reader invoices: Orb::Resources::Invoices
+
+    attr_reader items: Orb::Resources::Items
+
+    attr_reader metrics: Orb::Resources::Metrics
+
+    attr_reader plans: Orb::Resources::Plans
+
+    attr_reader prices: Orb::Resources::Prices
+
+    attr_reader subscriptions: Orb::Resources::Subscriptions
+
+    attr_reader alerts: Orb::Resources::Alerts
+
+    attr_reader dimensional_price_groups: Orb::Resources::DimensionalPriceGroups
+
+    private def auth_headers: -> ::Hash[String, String]
+
+    def initialize: (
+      ?api_key: String?,
+      ?base_url: String?,
+      ?max_retries: Integer,
+      ?timeout: Float,
+      ?initial_retry_delay: Float,
+      ?max_retry_delay: Float,
+      ?idempotency_header: String
+    ) -> void
+  end
+end

data/sig/orb/errors.rbs

@@ -0,0 +1,201 @@
+module Orb
+  module Errors
+    class Error < StandardError
+      attr_accessor cause: StandardError?
+    end
+
+    class ConversionError < Orb::Errors::Error
+    end
+
+    class APIError < Orb::Errors::Error
+      attr_accessor url: URI::Generic
+
+      attr_accessor status: Integer?
+
+      attr_accessor body: top?
+
+      def initialize: (
+        url: URI::Generic,
+        ?status: Integer?,
+        ?body: Object?,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APIConnectionError < Orb::Errors::APIError
+      def initialize: (
+        url: URI::Generic,
+        ?status: nil,
+        ?body: nil,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APITimeoutError < Orb::Errors::APIConnectionError
+      def initialize: (
+        url: URI::Generic,
+        ?status: nil,
+        ?body: nil,
+        ?request: nil,
+        ?response: nil,
+        ?message: String?
+      ) -> void
+    end
+
+    class APIStatusError < Orb::Errors::APIError
+      def self.for: (
+        url: URI::Generic,
+        status: Integer,
+        body: Object?,
+        request: nil,
+        response: nil,
+        ?message: String?
+      ) -> instance
+
+      def initialize: (
+        url: URI::Generic,
+        status: Integer,
+        body: Object?,
+        request: nil,
+        response: nil,
+        ?message: String?
+      ) -> void
+    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: 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
+
+  class Error = Orb::Errors::Error
+
+  class ConversionError = Orb::Errors::ConversionError
+
+  class APIError = Orb::Errors::APIError
+
+  class APIStatusError = Orb::Errors::APIStatusError
+
+  class APIConnectionError = Orb::Errors::APIConnectionError
+
+  class APITimeoutError = Orb::Errors::APITimeoutError
+
+  class BadRequestError = Orb::Errors::BadRequestError
+
+  class AuthenticationError = Orb::Errors::AuthenticationError
+
+  class PermissionDeniedError = Orb::Errors::PermissionDeniedError
+
+  class NotFoundError = Orb::Errors::NotFoundError
+
+  class ConflictError = Orb::Errors::ConflictError
+
+  class UnprocessableEntityError = Orb::Errors::UnprocessableEntityError
+
+  class RateLimitError = Orb::Errors::RateLimitError
+
+  class InternalServerError = Orb::Errors::InternalServerError
+
+  class ConstraintViolation = Orb::Errors::ConstraintViolation
+
+  class DuplicateResourceCreation = Orb::Errors::DuplicateResourceCreation
+
+  class FeatureNotAvailable = Orb::Errors::FeatureNotAvailable
+
+  class RequestValidationError = Orb::Errors::RequestValidationError
+
+  class OrbAuthenticationError = Orb::Errors::OrbAuthenticationError
+
+  class ResourceNotFound = Orb::Errors::ResourceNotFound
+
+  class URLNotFound = Orb::Errors::URLNotFound
+
+  class ResourceConflict = Orb::Errors::ResourceConflict
+
+  class RequestTooLarge = Orb::Errors::RequestTooLarge
+
+  class ResourceTooLarge = Orb::Errors::ResourceTooLarge
+
+  class TooManyRequests = Orb::Errors::TooManyRequests
+
+  class OrbInternalServerError = Orb::Errors::OrbInternalServerError
+end

data/sig/orb/models/alert.rbs

@@ -0,0 +1,142 @@
+module Orb
+  module Models
+    type alert =
+      {
+        id: String,
+        created_at: Time,
+        currency: String?,
+        customer: Orb::Models::Alert::Customer?,
+        enabled: bool,
+        metric: Orb::Models::Alert::Metric?,
+        plan: Orb::Models::Alert::Plan?,
+        subscription: Orb::Models::Alert::Subscription?,
+        thresholds: ::Array[Orb::Models::Alert::Threshold]?,
+        type: Orb::Models::Alert::type_
+      }
+
+    class Alert < Orb::BaseModel
+      attr_accessor id: String
+
+      attr_accessor created_at: Time
+
+      attr_accessor currency: String?
+
+      attr_accessor customer: Orb::Models::Alert::Customer?
+
+      attr_accessor enabled: bool
+
+      attr_accessor metric: Orb::Models::Alert::Metric?
+
+      attr_accessor plan: Orb::Models::Alert::Plan?
+
+      attr_accessor subscription: Orb::Models::Alert::Subscription?
+
+      attr_accessor thresholds: ::Array[Orb::Models::Alert::Threshold]?
+
+      attr_accessor type: Orb::Models::Alert::type_
+
+      def initialize: (
+        id: String,
+        created_at: Time,
+        currency: String?,
+        customer: Orb::Models::Alert::Customer?,
+        enabled: bool,
+        metric: Orb::Models::Alert::Metric?,
+        plan: Orb::Models::Alert::Plan?,
+        subscription: Orb::Models::Alert::Subscription?,
+        thresholds: ::Array[Orb::Models::Alert::Threshold]?,
+        type: Orb::Models::Alert::type_
+      ) -> void
+
+      def to_hash: -> Orb::Models::alert
+
+      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::Alert::customer
+      end
+
+      type metric = { id: String }
+
+      class Metric < Orb::BaseModel
+        attr_accessor id: String
+
+        def initialize: (id: String) -> void
+
+        def to_hash: -> Orb::Models::Alert::metric
+      end
+
+      type plan =
+        {
+          id: String?,
+          external_plan_id: String?,
+          name: String?,
+          plan_version: String
+        }
+
+      class Plan < Orb::BaseModel
+        attr_accessor id: String?
+
+        attr_accessor external_plan_id: String?
+
+        attr_accessor name: String?
+
+        attr_accessor plan_version: String
+
+        def initialize: (
+          id: String?,
+          external_plan_id: String?,
+          name: String?,
+          plan_version: String
+        ) -> void
+
+        def to_hash: -> Orb::Models::Alert::plan
+      end
+
+      type subscription = { id: String }
+
+      class Subscription < Orb::BaseModel
+        attr_accessor id: String
+
+        def initialize: (id: String) -> void
+
+        def to_hash: -> Orb::Models::Alert::subscription
+      end
+
+      type threshold = { value: Float }
+
+      class Threshold < Orb::BaseModel
+        attr_accessor value: Float
+
+        def initialize: (value: Float) -> void
+
+        def to_hash: -> Orb::Models::Alert::threshold
+      end
+
+      type type_ =
+        :credit_balance_depleted
+        | :credit_balance_dropped
+        | :credit_balance_recovered
+        | :usage_exceeded
+        | :cost_exceeded
+
+      module Type
+        extend Orb::Enum
+
+        CREDIT_BALANCE_DEPLETED: :credit_balance_depleted
+        CREDIT_BALANCE_DROPPED: :credit_balance_dropped
+        CREDIT_BALANCE_RECOVERED: :credit_balance_recovered
+        USAGE_EXCEEDED: :usage_exceeded
+        COST_EXCEEDED: :cost_exceeded
+
+        def self?.values: -> ::Array[Orb::Models::Alert::type_]
+      end
+    end
+  end
+end

data/sig/orb/models/alert_create_for_customer_params.rbs

@@ -0,0 +1,56 @@
+module Orb
+  module Models
+    type alert_create_for_customer_params =
+      {
+        currency: String,
+        type: Orb::Models::AlertCreateForCustomerParams::type_,
+        thresholds: ::Array[Orb::Models::AlertCreateForCustomerParams::Threshold]?
+      }
+      & Orb::request_parameters
+
+    class AlertCreateForCustomerParams < Orb::BaseModel
+      extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      attr_accessor currency: String
+
+      attr_accessor type: Orb::Models::AlertCreateForCustomerParams::type_
+
+      attr_accessor thresholds: ::Array[Orb::Models::AlertCreateForCustomerParams::Threshold]?
+
+      def initialize: (
+        currency: String,
+        type: Orb::Models::AlertCreateForCustomerParams::type_,
+        ?thresholds: ::Array[Orb::Models::AlertCreateForCustomerParams::Threshold]?,
+        ?request_options: Orb::request_opts
+      ) -> void
+
+      def to_hash: -> Orb::Models::alert_create_for_customer_params
+
+      type type_ =
+        :credit_balance_depleted
+        | :credit_balance_dropped
+        | :credit_balance_recovered
+
+      module Type
+        extend Orb::Enum
+
+        CREDIT_BALANCE_DEPLETED: :credit_balance_depleted
+        CREDIT_BALANCE_DROPPED: :credit_balance_dropped
+        CREDIT_BALANCE_RECOVERED: :credit_balance_recovered
+
+        def self?.values: -> ::Array[Orb::Models::AlertCreateForCustomerParams::type_]
+      end
+
+      type threshold = { value: Float }
+
+      class Threshold < Orb::BaseModel
+        attr_accessor value: Float
+
+        def initialize: (value: Float) -> void
+
+        def to_hash: -> Orb::Models::AlertCreateForCustomerParams::threshold
+      end
+    end
+  end
+end

data/sig/orb/models/alert_create_for_external_customer_params.rbs

@@ -0,0 +1,56 @@
+module Orb
+  module Models
+    type alert_create_for_external_customer_params =
+      {
+        currency: String,
+        type: Orb::Models::AlertCreateForExternalCustomerParams::type_,
+        thresholds: ::Array[Orb::Models::AlertCreateForExternalCustomerParams::Threshold]?
+      }
+      & Orb::request_parameters
+
+    class AlertCreateForExternalCustomerParams < Orb::BaseModel
+      extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      attr_accessor currency: String
+
+      attr_accessor type: Orb::Models::AlertCreateForExternalCustomerParams::type_
+
+      attr_accessor thresholds: ::Array[Orb::Models::AlertCreateForExternalCustomerParams::Threshold]?
+
+      def initialize: (
+        currency: String,
+        type: Orb::Models::AlertCreateForExternalCustomerParams::type_,
+        ?thresholds: ::Array[Orb::Models::AlertCreateForExternalCustomerParams::Threshold]?,
+        ?request_options: Orb::request_opts
+      ) -> void
+
+      def to_hash: -> Orb::Models::alert_create_for_external_customer_params
+
+      type type_ =
+        :credit_balance_depleted
+        | :credit_balance_dropped
+        | :credit_balance_recovered
+
+      module Type
+        extend Orb::Enum
+
+        CREDIT_BALANCE_DEPLETED: :credit_balance_depleted
+        CREDIT_BALANCE_DROPPED: :credit_balance_dropped
+        CREDIT_BALANCE_RECOVERED: :credit_balance_recovered
+
+        def self?.values: -> ::Array[Orb::Models::AlertCreateForExternalCustomerParams::type_]
+      end
+
+      type threshold = { value: Float }
+
+      class Threshold < Orb::BaseModel
+        attr_accessor value: Float
+
+        def initialize: (value: Float) -> void
+
+        def to_hash: -> Orb::Models::AlertCreateForExternalCustomerParams::threshold
+      end
+    end
+  end
+end

data/sig/orb/models/alert_create_for_subscription_params.rbs

@@ -0,0 +1,52 @@
+module Orb
+  module Models
+    type alert_create_for_subscription_params =
+      {
+        thresholds: ::Array[Orb::Models::AlertCreateForSubscriptionParams::Threshold],
+        type: Orb::Models::AlertCreateForSubscriptionParams::type_,
+        metric_id: String?
+      }
+      & Orb::request_parameters
+
+    class AlertCreateForSubscriptionParams < Orb::BaseModel
+      extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      attr_accessor thresholds: ::Array[Orb::Models::AlertCreateForSubscriptionParams::Threshold]
+
+      attr_accessor type: Orb::Models::AlertCreateForSubscriptionParams::type_
+
+      attr_accessor metric_id: String?
+
+      def initialize: (
+        thresholds: ::Array[Orb::Models::AlertCreateForSubscriptionParams::Threshold],
+        type: Orb::Models::AlertCreateForSubscriptionParams::type_,
+        ?metric_id: String?,
+        ?request_options: Orb::request_opts
+      ) -> void
+
+      def to_hash: -> Orb::Models::alert_create_for_subscription_params
+
+      type threshold = { value: Float }
+
+      class Threshold < Orb::BaseModel
+        attr_accessor value: Float
+
+        def initialize: (value: Float) -> void
+
+        def to_hash: -> Orb::Models::AlertCreateForSubscriptionParams::threshold
+      end
+
+      type type_ = :usage_exceeded | :cost_exceeded
+
+      module Type
+        extend Orb::Enum
+
+        USAGE_EXCEEDED: :usage_exceeded
+        COST_EXCEEDED: :cost_exceeded
+
+        def self?.values: -> ::Array[Orb::Models::AlertCreateForSubscriptionParams::type_]
+      end
+    end
+  end
+end

data/sig/orb/models/alert_disable_params.rbs

@@ -0,0 +1,20 @@
+module Orb
+  module Models
+    type alert_disable_params =
+      { subscription_id: String? } & Orb::request_parameters
+
+    class AlertDisableParams < Orb::BaseModel
+      extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      attr_accessor subscription_id: String?
+
+      def initialize: (
+        ?subscription_id: String?,
+        ?request_options: Orb::request_opts
+      ) -> void
+
+      def to_hash: -> Orb::Models::alert_disable_params
+    end
+  end
+end

data/sig/orb/models/alert_enable_params.rbs

@@ -0,0 +1,20 @@
+module Orb
+  module Models
+    type alert_enable_params =
+      { subscription_id: String? } & Orb::request_parameters
+
+    class AlertEnableParams < Orb::BaseModel
+      extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      attr_accessor subscription_id: String?
+
+      def initialize: (
+        ?subscription_id: String?,
+        ?request_options: Orb::request_opts
+      ) -> void
+
+      def to_hash: -> Orb::Models::alert_enable_params
+    end
+  end
+end

data/sig/orb/models/alert_list_params.rbs

@@ -0,0 +1,57 @@
+module Orb
+  module Models
+    type alert_list_params =
+      {
+        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?
+      }
+      & Orb::request_parameters
+
+    class AlertListParams < Orb::BaseModel
+      extend Orb::Type::RequestParameters::Converter
+      include Orb::RequestParameters
+
+      attr_accessor created_at_gt: Time?
+
+      attr_accessor created_at_gte: Time?
+
+      attr_accessor created_at_lt: Time?
+
+      attr_accessor created_at_lte: Time?
+
+      attr_accessor cursor: String?
+
+      attr_accessor customer_id: String?
+
+      attr_accessor external_customer_id: String?
+
+      attr_reader limit: Integer?
+
+      def limit=: (Integer) -> Integer
+
+      attr_accessor subscription_id: String?
+
+      def initialize: (
+        ?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
+      ) -> void
+
+      def to_hash: -> Orb::Models::alert_list_params
+    end
+  end
+end

data/sig/orb/models/alert_retrieve_params.rbs

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