orb-billing 0.1.0.pre.alpha.33

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

@@ -0,0 +1,63 @@
+module Orb
+  module Resources
+    class Customers
+      class Credits
+        class TopUps
+          def create: (
+            String customer_id,
+            amount: String,
+            currency: String,
+            invoice_settings: Orb::Models::Customers::Credits::TopUpCreateParams::InvoiceSettings,
+            per_unit_cost_basis: String,
+            threshold: String,
+            ?active_from: Time?,
+            ?expires_after: Integer?,
+            ?expires_after_unit: Orb::Models::Customers::Credits::TopUpCreateParams::expires_after_unit?,
+            ?request_options: Orb::request_opts
+          ) -> Orb::Models::Customers::Credits::TopUpCreateResponse
+
+          def list: (
+            String customer_id,
+            ?cursor: String?,
+            ?limit: Integer,
+            ?request_options: Orb::request_opts
+          ) -> Orb::Page[Orb::Models::Customers::Credits::TopUpListResponse]
+
+          def delete: (
+            String top_up_id,
+            customer_id: String,
+            ?request_options: Orb::request_opts
+          ) -> nil
+
+          def create_by_external_id: (
+            String external_customer_id,
+            amount: String,
+            currency: String,
+            invoice_settings: Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::InvoiceSettings,
+            per_unit_cost_basis: String,
+            threshold: String,
+            ?active_from: Time?,
+            ?expires_after: Integer?,
+            ?expires_after_unit: Orb::Models::Customers::Credits::TopUpCreateByExternalIDParams::expires_after_unit?,
+            ?request_options: Orb::request_opts
+          ) -> Orb::Models::Customers::Credits::TopUpCreateByExternalIDResponse
+
+          def delete_by_external_id: (
+            String top_up_id,
+            external_customer_id: String,
+            ?request_options: Orb::request_opts
+          ) -> nil
+
+          def list_by_external_id: (
+            String external_customer_id,
+            ?cursor: String?,
+            ?limit: Integer,
+            ?request_options: Orb::request_opts
+          ) -> Orb::Page[Orb::Models::Customers::Credits::TopUpListByExternalIDResponse]
+
+          def initialize: (client: Orb::Client) -> void
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+module Orb
+  module Resources
+    class Customers
+      class Credits
+        attr_reader ledger: Orb::Resources::Customers::Credits::Ledger
+
+        attr_reader top_ups: Orb::Resources::Customers::Credits::TopUps
+
+        def list: (
+          String customer_id,
+          ?currency: String?,
+          ?cursor: String?,
+          ?include_all_blocks: bool,
+          ?limit: Integer,
+          ?request_options: Orb::request_opts
+        ) -> Orb::Page[Orb::Models::Customers::CreditListResponse]
+
+        def list_by_external_id: (
+          String external_customer_id,
+          ?currency: String?,
+          ?cursor: String?,
+          ?include_all_blocks: bool,
+          ?limit: Integer,
+          ?request_options: Orb::request_opts
+        ) -> Orb::Page[Orb::Models::Customers::CreditListByExternalIDResponse]
+
+        def initialize: (client: Orb::Client) -> void
+      end
+    end
+  end
+end

data/sig/orb/resources/customers.rbs

@@ -0,0 +1,114 @@
+module Orb
+  module Resources
+    class Customers
+      attr_reader costs: Orb::Resources::Customers::Costs
+
+      attr_reader credits: Orb::Resources::Customers::Credits
+
+      attr_reader balance_transactions: Orb::Resources::Customers::BalanceTransactions
+
+      def create: (
+        email: String,
+        name: String,
+        ?accounting_sync_configuration: Orb::Models::CustomerCreateParams::AccountingSyncConfiguration?,
+        ?additional_emails: ::Array[String]?,
+        ?auto_collection: bool?,
+        ?billing_address: Orb::Models::CustomerCreateParams::BillingAddress?,
+        ?currency: String?,
+        ?email_delivery: bool?,
+        ?external_customer_id: String?,
+        ?hierarchy: Orb::Models::CustomerCreateParams::Hierarchy?,
+        ?metadata: ::Hash[Symbol, String?]?,
+        ?payment_provider: Orb::Models::CustomerCreateParams::payment_provider?,
+        ?payment_provider_id: String?,
+        ?reporting_configuration: Orb::Models::CustomerCreateParams::ReportingConfiguration?,
+        ?shipping_address: Orb::Models::CustomerCreateParams::ShippingAddress?,
+        ?tax_configuration: Orb::Models::CustomerCreateParams::tax_configuration?,
+        ?tax_id: Orb::Models::CustomerCreateParams::TaxID?,
+        ?timezone: String?,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Customer
+
+      def update: (
+        String customer_id,
+        ?accounting_sync_configuration: Orb::Models::CustomerUpdateParams::AccountingSyncConfiguration?,
+        ?additional_emails: ::Array[String]?,
+        ?auto_collection: bool?,
+        ?billing_address: Orb::Models::CustomerUpdateParams::BillingAddress?,
+        ?currency: String?,
+        ?email: String?,
+        ?email_delivery: bool?,
+        ?external_customer_id: String?,
+        ?hierarchy: Orb::Models::CustomerUpdateParams::Hierarchy?,
+        ?metadata: ::Hash[Symbol, String?]?,
+        ?name: String?,
+        ?payment_provider: Orb::Models::CustomerUpdateParams::payment_provider?,
+        ?payment_provider_id: String?,
+        ?reporting_configuration: Orb::Models::CustomerUpdateParams::ReportingConfiguration?,
+        ?shipping_address: Orb::Models::CustomerUpdateParams::ShippingAddress?,
+        ?tax_configuration: Orb::Models::CustomerUpdateParams::tax_configuration?,
+        ?tax_id: Orb::Models::CustomerUpdateParams::TaxID?,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Customer
+
+      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::Customer]
+
+      def delete: (
+        String customer_id,
+        ?request_options: Orb::request_opts
+      ) -> nil
+
+      def fetch: (
+        String customer_id,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Customer
+
+      def fetch_by_external_id: (
+        String external_customer_id,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Customer
+
+      def sync_payment_methods_from_gateway: (
+        String external_customer_id,
+        ?request_options: Orb::request_opts
+      ) -> nil
+
+      def sync_payment_methods_from_gateway_by_external_customer_id: (
+        String customer_id,
+        ?request_options: Orb::request_opts
+      ) -> nil
+
+      def update_by_external_id: (
+        String id,
+        ?accounting_sync_configuration: Orb::Models::CustomerUpdateByExternalIDParams::AccountingSyncConfiguration?,
+        ?additional_emails: ::Array[String]?,
+        ?auto_collection: bool?,
+        ?billing_address: Orb::Models::CustomerUpdateByExternalIDParams::BillingAddress?,
+        ?currency: String?,
+        ?email: String?,
+        ?email_delivery: bool?,
+        ?external_customer_id: String?,
+        ?hierarchy: Orb::Models::CustomerUpdateByExternalIDParams::Hierarchy?,
+        ?metadata: ::Hash[Symbol, String?]?,
+        ?name: String?,
+        ?payment_provider: Orb::Models::CustomerUpdateByExternalIDParams::payment_provider?,
+        ?payment_provider_id: String?,
+        ?reporting_configuration: Orb::Models::CustomerUpdateByExternalIDParams::ReportingConfiguration?,
+        ?shipping_address: Orb::Models::CustomerUpdateByExternalIDParams::ShippingAddress?,
+        ?tax_configuration: Orb::Models::CustomerUpdateByExternalIDParams::tax_configuration?,
+        ?tax_id: Orb::Models::CustomerUpdateByExternalIDParams::TaxID?,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Customer
+
+      def initialize: (client: Orb::Client) -> void
+    end
+  end
+end

data/sig/orb/resources/dimensional_price_groups/external_dimensional_price_group_id.rbs

@@ -0,0 +1,14 @@
+module Orb
+  module Resources
+    class DimensionalPriceGroups
+      class ExternalDimensionalPriceGroupID
+        def retrieve: (
+          String external_dimensional_price_group_id,
+          ?request_options: Orb::request_opts
+        ) -> Orb::Models::DimensionalPriceGroup
+
+        def initialize: (client: Orb::Client) -> void
+      end
+    end
+  end
+end

data/sig/orb/resources/dimensional_price_groups.rbs

@@ -0,0 +1,29 @@
+module Orb
+  module Resources
+    class DimensionalPriceGroups
+      attr_reader external_dimensional_price_group_id: Orb::Resources::DimensionalPriceGroups::ExternalDimensionalPriceGroupID
+
+      def create: (
+        billable_metric_id: String,
+        dimensions: ::Array[String],
+        name: String,
+        ?external_dimensional_price_group_id: String?,
+        ?metadata: ::Hash[Symbol, String?]?,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::DimensionalPriceGroup
+
+      def retrieve: (
+        String dimensional_price_group_id,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::DimensionalPriceGroup
+
+      def list: (
+        ?cursor: String?,
+        ?limit: Integer,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Page[Orb::Models::DimensionalPriceGroup]
+
+      def initialize: (client: Orb::Client) -> void
+    end
+  end
+end

data/sig/orb/resources/events/backfills.rbs

@@ -0,0 +1,41 @@
+module Orb
+  module Resources
+    class Events
+      class Backfills
+        def create: (
+          timeframe_end: Time,
+          timeframe_start: Time,
+          ?close_time: Time?,
+          ?customer_id: String?,
+          ?deprecation_filter: String?,
+          ?external_customer_id: String?,
+          ?replace_existing_events: bool,
+          ?request_options: Orb::request_opts
+        ) -> Orb::Models::Events::BackfillCreateResponse
+
+        def list: (
+          ?cursor: String?,
+          ?limit: Integer,
+          ?request_options: Orb::request_opts
+        ) -> Orb::Page[Orb::Models::Events::BackfillListResponse]
+
+        def close: (
+          String backfill_id,
+          ?request_options: Orb::request_opts
+        ) -> Orb::Models::Events::BackfillCloseResponse
+
+        def fetch: (
+          String backfill_id,
+          ?request_options: Orb::request_opts
+        ) -> Orb::Models::Events::BackfillFetchResponse
+
+        def revert: (
+          String backfill_id,
+          ?request_options: Orb::request_opts
+        ) -> Orb::Models::Events::BackfillRevertResponse
+
+        def initialize: (client: Orb::Client) -> void
+      end
+    end
+  end
+end

data/sig/orb/resources/events/volume.rbs

@@ -0,0 +1,17 @@
+module Orb
+  module Resources
+    class Events
+      class Volume
+        def list: (
+          timeframe_start: Time,
+          ?cursor: String?,
+          ?limit: Integer,
+          ?timeframe_end: Time,
+          ?request_options: Orb::request_opts
+        ) -> Orb::Models::Events::EventVolumes
+
+        def initialize: (client: Orb::Client) -> void
+      end
+    end
+  end
+end

data/sig/orb/resources/events.rbs

@@ -0,0 +1,40 @@
+module Orb
+  module Resources
+    class Events
+      attr_reader backfills: Orb::Resources::Events::Backfills
+
+      attr_reader volume: Orb::Resources::Events::Volume
+
+      def update: (
+        String event_id,
+        event_name: String,
+        properties: top,
+        timestamp: Time,
+        ?customer_id: String?,
+        ?external_customer_id: String?,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::EventUpdateResponse
+
+      def deprecate: (
+        String event_id,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::EventDeprecateResponse
+
+      def ingest: (
+        events: ::Array[Orb::Models::EventIngestParams::Event],
+        ?backfill_id: String?,
+        ?debug: bool,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::EventIngestResponse
+
+      def search: (
+        event_ids: ::Array[String],
+        ?timeframe_end: Time?,
+        ?timeframe_start: Time?,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::EventSearchResponse
+
+      def initialize: (client: Orb::Client) -> void
+    end
+  end
+end

data/sig/orb/resources/invoice_line_items.rbs

@@ -0,0 +1,17 @@
+module Orb
+  module Resources
+    class InvoiceLineItems
+      def create: (
+        amount: String,
+        end_date: Date,
+        invoice_id: String,
+        name: String,
+        quantity: Float,
+        start_date: Date,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::InvoiceLineItemCreateResponse
+
+      def initialize: (client: Orb::Client) -> void
+    end
+  end
+end

data/sig/orb/resources/invoices.rbs

@@ -0,0 +1,84 @@
+module Orb
+  module Resources
+    class Invoices
+      def create: (
+        currency: String,
+        invoice_date: Time,
+        line_items: ::Array[Orb::Models::InvoiceCreateParams::LineItem],
+        net_terms: Integer,
+        ?customer_id: String?,
+        ?discount: Orb::Models::discount?,
+        ?external_customer_id: String?,
+        ?memo: String?,
+        ?metadata: ::Hash[Symbol, String?]?,
+        ?will_auto_issue: bool,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Invoice
+
+      def update: (
+        String invoice_id,
+        ?metadata: ::Hash[Symbol, String?]?,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Invoice
+
+      def list: (
+        ?amount: String?,
+        ?amount_gt: String?,
+        ?amount_lt: String?,
+        ?cursor: String?,
+        ?customer_id: String?,
+        ?date_type: Orb::Models::InvoiceListParams::date_type?,
+        ?due_date: Date?,
+        ?due_date_window: String?,
+        ?due_date_gt: Date?,
+        ?due_date_lt: Date?,
+        ?external_customer_id: String?,
+        ?invoice_date_gt: Time?,
+        ?invoice_date_gte: Time?,
+        ?invoice_date_lt: Time?,
+        ?invoice_date_lte: Time?,
+        ?is_recurring: bool?,
+        ?limit: Integer,
+        ?status: ::Array[Orb::Models::InvoiceListParams::status]?,
+        ?subscription_id: String?,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Page[Orb::Models::Invoice]
+
+      def fetch: (
+        String invoice_id,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Invoice
+
+      def fetch_upcoming: (
+        subscription_id: String,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::InvoiceFetchUpcomingResponse
+
+      def issue: (
+        String invoice_id,
+        ?synchronous: bool,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Invoice
+
+      def mark_paid: (
+        String invoice_id,
+        payment_received_date: Date,
+        ?external_id: String?,
+        ?notes: String?,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Invoice
+
+      def pay: (
+        String invoice_id,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Invoice
+
+      def `void`: (
+        String invoice_id,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Invoice
+
+      def initialize: (client: Orb::Client) -> void
+    end
+  end
+end

data/sig/orb/resources/items.rbs

@@ -0,0 +1,30 @@
+module Orb
+  module Resources
+    class Items
+      def create: (
+        name: String,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Item
+
+      def update: (
+        String item_id,
+        ?external_connections: ::Array[Orb::Models::ItemUpdateParams::ExternalConnection]?,
+        ?name: String?,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Item
+
+      def list: (
+        ?cursor: String?,
+        ?limit: Integer,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Page[Orb::Models::Item]
+
+      def fetch: (
+        String item_id,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Item
+
+      def initialize: (client: Orb::Client) -> void
+    end
+  end
+end

data/sig/orb/resources/metrics.rbs

@@ -0,0 +1,37 @@
+module Orb
+  module Resources
+    class Metrics
+      def create: (
+        description: String?,
+        item_id: String,
+        name: String,
+        sql: String,
+        ?metadata: ::Hash[Symbol, String?]?,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::BillableMetric
+
+      def update: (
+        String metric_id,
+        ?metadata: ::Hash[Symbol, String?]?,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::BillableMetric
+
+      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::BillableMetric]
+
+      def fetch: (
+        String metric_id,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::BillableMetric
+
+      def initialize: (client: Orb::Client) -> void
+    end
+  end
+end

data/sig/orb/resources/plans/external_plan_id.rbs

@@ -0,0 +1,21 @@
+module Orb
+  module Resources
+    class Plans
+      class ExternalPlanID
+        def update: (
+          String other_external_plan_id,
+          ?external_plan_id: String?,
+          ?metadata: ::Hash[Symbol, String?]?,
+          ?request_options: Orb::request_opts
+        ) -> Orb::Models::Plan
+
+        def fetch: (
+          String external_plan_id,
+          ?request_options: Orb::request_opts
+        ) -> Orb::Models::Plan
+
+        def initialize: (client: Orb::Client) -> void
+      end
+    end
+  end
+end

data/sig/orb/resources/plans.rbs

@@ -0,0 +1,44 @@
+module Orb
+  module Resources
+    class Plans
+      attr_reader external_plan_id: Orb::Resources::Plans::ExternalPlanID
+
+      def create: (
+        currency: String,
+        name: String,
+        prices: ::Array[Orb::Models::PlanCreateParams::price],
+        ?default_invoice_memo: String?,
+        ?external_plan_id: String?,
+        ?metadata: ::Hash[Symbol, String?]?,
+        ?net_terms: Integer?,
+        ?status: Orb::Models::PlanCreateParams::status,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Plan
+
+      def update: (
+        String plan_id,
+        ?external_plan_id: String?,
+        ?metadata: ::Hash[Symbol, String?]?,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Plan
+
+      def list: (
+        ?created_at_gt: Time?,
+        ?created_at_gte: Time?,
+        ?created_at_lt: Time?,
+        ?created_at_lte: Time?,
+        ?cursor: String?,
+        ?limit: Integer,
+        ?status: Orb::Models::PlanListParams::status,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Page[Orb::Models::Plan]
+
+      def fetch: (
+        String plan_id,
+        ?request_options: Orb::request_opts
+      ) -> Orb::Models::Plan
+
+      def initialize: (client: Orb::Client) -> void
+    end
+  end
+end

data/sig/orb/resources/prices/external_price_id.rbs

@@ -0,0 +1,20 @@
+module Orb
+  module Resources
+    class Prices
+      class ExternalPriceID
+        def update: (
+          String external_price_id,
+          ?metadata: ::Hash[Symbol, String?]?,
+          ?request_options: Orb::request_opts
+        ) -> Orb::Models::price
+
+        def fetch: (
+          String external_price_id,
+          ?request_options: Orb::request_opts
+        ) -> Orb::Models::price
+
+        def initialize: (client: Orb::Client) -> void
+      end
+    end
+  end
+end