Skip to content

Commit e99472a

Browse files
stainless-app[bot]stainless-app[bot]
committed
chore(docs): add missing descriptions
1 parent c984acb commit e99472a

26 files changed

+232
-78
lines changed

‎src/Orb/Services/Beta/IExternalPlanIDService.cs‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,13 @@
99
namespace Orb.Services.Beta;
1010

1111
/// <summary>
12-
/// NOTE: Do not inherit from this type outside the SDK unless you're okay with breaking
13-
/// changes in non-major versions. We may add new methods in the future that cause
14-
/// existing derived classes to break.
12+
/// The [Plan](/core-concepts#plan-and-price) resource represents a plan that can
13+
/// be subscribed to by a customer. Plans define the billing behavior of the subscription.
14+
/// You can see more about how to configure prices in the [Price resource](/reference/price).
15+
///
16+
/// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
17+
/// breaking changes in non-major versions. We may add new methods in the future that
18+
/// cause existing derived classes to break.</para>
1519
/// </summary>
1620
public interface IExternalPlanIDService
1721
{

‎src/Orb/Services/Coupons/ISubscriptionService.cs‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,14 @@
77
namespace Orb.Services.Coupons;
88

99
/// <summary>
10-
/// NOTE: Do not inherit from this type outside the SDK unless you're okay with breaking
11-
/// changes in non-major versions. We may add new methods in the future that cause
12-
/// existing derived classes to break.
10+
/// A coupon represents a reusable discount configuration that can be applied either
11+
/// as a fixed or percentage amount to an invoice or subscription. Coupons are activated
12+
/// using a redemption code, which applies the discount to a subscription or invoice.
13+
/// The duration of a coupon determines how long it remains available for use by end users.
14+
///
15+
/// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
16+
/// breaking changes in non-major versions. We may add new methods in the future that
17+
/// cause existing derived classes to break.</para>
1318
/// </summary>
1419
public interface ISubscriptionService
1520
{

‎src/Orb/Services/Customers/Credits/ILedgerService.cs‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,12 @@
77
namespace Orb.Services.Customers.Credits;
88

99
/// <summary>
10-
/// NOTE: Do not inherit from this type outside the SDK unless you're okay with breaking
11-
/// changes in non-major versions. We may add new methods in the future that cause
12-
/// existing derived classes to break.
10+
/// The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
11+
/// credits within Orb.
12+
///
13+
/// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
14+
/// breaking changes in non-major versions. We may add new methods in the future that
15+
/// cause existing derived classes to break.</para>
1316
/// </summary>
1417
public interface ILedgerService
1518
{

‎src/Orb/Services/Customers/Credits/ITopUpService.cs‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,12 @@
77
namespace Orb.Services.Customers.Credits;
88

99
/// <summary>
10-
/// NOTE: Do not inherit from this type outside the SDK unless you're okay with breaking
11-
/// changes in non-major versions. We may add new methods in the future that cause
12-
/// existing derived classes to break.
10+
/// The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
11+
/// credits within Orb.
12+
///
13+
/// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
14+
/// breaking changes in non-major versions. We may add new methods in the future that
15+
/// cause existing derived classes to break.</para>
1316
/// </summary>
1417
public interface ITopUpService
1518
{

‎src/Orb/Services/Customers/IBalanceTransactionService.cs‎

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,25 @@
77
namespace Orb.Services.Customers;
88

99
/// <summary>
10-
/// NOTE: Do not inherit from this type outside the SDK unless you're okay with breaking
11-
/// changes in non-major versions. We may add new methods in the future that cause
12-
/// existing derived classes to break.
10+
/// A customer is a buyer of your products, and the other party to the billing relationship.
11+
///
12+
/// <para>In Orb, customers are assigned system generated identifiers automatically,
13+
/// but it's often desirable to have these match existing identifiers in your system.
14+
/// To avoid having to denormalize Orb ID information, you can pass in an `external_customer_id`
15+
/// with your own identifier. See [Customer ID Aliases](/events-and-metrics/customer-aliases)
16+
/// for further information about how these aliases work in Orb.</para>
17+
///
18+
/// <para>In addition to having an identifier in your system, a customer may exist
19+
/// in a payment provider solution like Stripe. Use the `payment_provider_id` and
20+
/// the `payment_provider` enum field to express this mapping.</para>
21+
///
22+
/// <para>A customer also has a timezone (from the standard [IANA timezone database](https://www.iana.org/time-zones)),
23+
/// which defaults to your account's timezone. See [Timezone localization](/essentials/timezones)
24+
/// for information on what this timezone parameter influences within Orb.</para>
25+
///
26+
/// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
27+
/// breaking changes in non-major versions. We may add new methods in the future that
28+
/// cause existing derived classes to break.</para>
1329
/// </summary>
1430
public interface IBalanceTransactionService
1531
{

‎src/Orb/Services/Customers/ICostService.cs‎

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,25 @@
77
namespace Orb.Services.Customers;
88

99
/// <summary>
10-
/// NOTE: Do not inherit from this type outside the SDK unless you're okay with breaking
11-
/// changes in non-major versions. We may add new methods in the future that cause
12-
/// existing derived classes to break.
10+
/// A customer is a buyer of your products, and the other party to the billing relationship.
11+
///
12+
/// <para>In Orb, customers are assigned system generated identifiers automatically,
13+
/// but it's often desirable to have these match existing identifiers in your system.
14+
/// To avoid having to denormalize Orb ID information, you can pass in an `external_customer_id`
15+
/// with your own identifier. See [Customer ID Aliases](/events-and-metrics/customer-aliases)
16+
/// for further information about how these aliases work in Orb.</para>
17+
///
18+
/// <para>In addition to having an identifier in your system, a customer may exist
19+
/// in a payment provider solution like Stripe. Use the `payment_provider_id` and
20+
/// the `payment_provider` enum field to express this mapping.</para>
21+
///
22+
/// <para>A customer also has a timezone (from the standard [IANA timezone database](https://www.iana.org/time-zones)),
23+
/// which defaults to your account's timezone. See [Timezone localization](/essentials/timezones)
24+
/// for information on what this timezone parameter influences within Orb.</para>
25+
///
26+
/// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
27+
/// breaking changes in non-major versions. We may add new methods in the future that
28+
/// cause existing derived classes to break.</para>
1329
/// </summary>
1430
public interface ICostService
1531
{

‎src/Orb/Services/Customers/ICreditService.cs‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,12 @@
88
namespace Orb.Services.Customers;
99

1010
/// <summary>
11-
/// NOTE: Do not inherit from this type outside the SDK unless you're okay with breaking
12-
/// changes in non-major versions. We may add new methods in the future that cause
13-
/// existing derived classes to break.
11+
/// The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid
12+
/// credits within Orb.
13+
///
14+
/// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
15+
/// breaking changes in non-major versions. We may add new methods in the future that
16+
/// cause existing derived classes to break.</para>
1417
/// </summary>
1518
public interface ICreditService
1619
{

‎src/Orb/Services/Events/IBackfillService.cs‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,13 @@
77
namespace Orb.Services.Events;
88

99
/// <summary>
10-
/// NOTE: Do not inherit from this type outside the SDK unless you're okay with breaking
11-
/// changes in non-major versions. We may add new methods in the future that cause
12-
/// existing derived classes to break.
10+
/// The [Event](/core-concepts#event) resource represents a usage event that has been
11+
/// created for a customer. Events are the core of Orb's usage-based billing model,
12+
/// and are used to calculate the usage charges for a given billing period.
13+
///
14+
/// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
15+
/// breaking changes in non-major versions. We may add new methods in the future that
16+
/// cause existing derived classes to break.</para>
1317
/// </summary>
1418
public interface IBackfillService
1519
{

‎src/Orb/Services/Events/IVolumeService.cs‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,13 @@
77
namespace Orb.Services.Events;
88

99
/// <summary>
10-
/// NOTE: Do not inherit from this type outside the SDK unless you're okay with breaking
11-
/// changes in non-major versions. We may add new methods in the future that cause
12-
/// existing derived classes to break.
10+
/// The [Event](/core-concepts#event) resource represents a usage event that has been
11+
/// created for a customer. Events are the core of Orb's usage-based billing model,
12+
/// and are used to calculate the usage charges for a given billing period.
13+
///
14+
/// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
15+
/// breaking changes in non-major versions. We may add new methods in the future that
16+
/// cause existing derived classes to break.</para>
1317
/// </summary>
1418
public interface IVolumeService
1519
{

‎src/Orb/Services/IAlertService.cs‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,14 @@
77
namespace Orb.Services;
88

99
/// <summary>
10-
/// NOTE: Do not inherit from this type outside the SDK unless you're okay with breaking
11-
/// changes in non-major versions. We may add new methods in the future that cause
12-
/// existing derived classes to break.
10+
/// [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending, usage,
11+
/// or credit balance and trigger webhooks when a threshold is exceeded.
12+
///
13+
/// <para>Alerts created through the API can be scoped to either customers or subscriptions.</para>
14+
///
15+
/// <para>NOTE: Do not inherit from this type outside the SDK unless you're okay with
16+
/// breaking changes in non-major versions. We may add new methods in the future that
17+
/// cause existing derived classes to break.</para>
1318
/// </summary>
1419
public interface IAlertService
1520
{

0 commit comments

Comments
 (0)