Skip to content

Commit d101825

Browse files
chore(docs): add missing descriptions
1 parent c1195af commit d101825

File tree

108 files changed

+2204
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

108 files changed

+2204
-0
lines changed

orb-java-core/src/main/kotlin/com/withorb/api/client/OrbClient.kt

Lines changed: 186 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,40 +63,133 @@ interface OrbClient {
6363

6464
fun topLevel(): TopLevelService
6565

66+
/**
67+
* The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be subscribed
68+
* to by a customer. Plans define the billing behavior of the subscription. You can see more
69+
* about how to configure prices in the [Price resource](/reference/price).
70+
*/
6671
fun beta(): BetaService
6772

73+
/**
74+
* A coupon represents a reusable discount configuration that can be applied either as a fixed
75+
* or percentage amount to an invoice or subscription. Coupons are activated using a redemption
76+
* code, which applies the discount to a subscription or invoice. The duration of a coupon
77+
* determines how long it remains available for use by end users.
78+
*/
6879
fun coupons(): CouponService
6980

81+
/**
82+
* The [Credit Note](/invoicing/credit-notes) resource represents a credit that has been applied
83+
* to a particular invoice.
84+
*/
7085
fun creditNotes(): CreditNoteService
7186

87+
/**
88+
* A customer is a buyer of your products, and the other party to the billing relationship.
89+
*
90+
* In Orb, customers are assigned system generated identifiers automatically, but it's often
91+
* desirable to have these match existing identifiers in your system. To avoid having to
92+
* denormalize Orb ID information, you can pass in an `external_customer_id` with your own
93+
* identifier. See [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
94+
* information about how these aliases work in Orb.
95+
*
96+
* In addition to having an identifier in your system, a customer may exist in a payment
97+
* provider solution like Stripe. Use the `payment_provider_id` and the `payment_provider` enum
98+
* field to express this mapping.
99+
*
100+
* A customer also has a timezone (from the standard
101+
* [IANA timezone database](https://www.iana.org/time-zones)), which defaults to your account's
102+
* timezone. See [Timezone localization](/essentials/timezones) for information on what this
103+
* timezone parameter influences within Orb.
104+
*/
72105
fun customers(): CustomerService
73106

107+
/**
108+
* The [Event](/core-concepts#event) resource represents a usage event that has been created for
109+
* a customer. Events are the core of Orb's usage-based billing model, and are used to calculate
110+
* the usage charges for a given billing period.
111+
*/
74112
fun events(): EventService
75113

114+
/**
115+
* An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, representing the
116+
* request for payment for a single subscription. This includes a set of line items, which
117+
* correspond to prices in the subscription's plan and can represent fixed recurring fees or
118+
* usage-based fees. They are generated at the end of a billing period, or as the result of an
119+
* action, such as a cancellation.
120+
*/
76121
fun invoiceLineItems(): InvoiceLineItemService
77122

123+
/**
124+
* An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, representing the
125+
* request for payment for a single subscription. This includes a set of line items, which
126+
* correspond to prices in the subscription's plan and can represent fixed recurring fees or
127+
* usage-based fees. They are generated at the end of a billing period, or as the result of an
128+
* action, such as a cancellation.
129+
*/
78130
fun invoices(): InvoiceService
79131

132+
/**
133+
* The Item resource represents a sellable product or good. Items are associated with all line
134+
* items, billable metrics, and prices and are used for defining external sync behavior for
135+
* invoices and tax calculation purposes.
136+
*/
80137
fun items(): ItemService
81138

139+
/**
140+
* The Metric resource represents a calculation of a quantity based on events. Metrics are
141+
* defined by the query that transforms raw usage events into meaningful values for your
142+
* customers.
143+
*/
82144
fun metrics(): MetricService
83145

146+
/**
147+
* The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be subscribed
148+
* to by a customer. Plans define the billing behavior of the subscription. You can see more
149+
* about how to configure prices in the [Price resource](/reference/price).
150+
*/
84151
fun plans(): PlanService
85152

153+
/**
154+
* The Price resource represents a price that can be billed on a subscription, resulting in a
155+
* charge on an invoice in the form of an invoice line item. Prices take a quantity and
156+
* determine an amount to bill.
157+
*
158+
* Orb supports a few different pricing models out of the box. Each of these models is
159+
* serialized differently in a given Price object. The model_type field determines the key for
160+
* the configuration object that is present.
161+
*
162+
* For more on the types of prices, see
163+
* [the core concepts documentation](/core-concepts#plan-and-price)
164+
*/
86165
fun prices(): PriceService
87166

88167
fun subscriptions(): SubscriptionService
89168

90169
fun webhooks(): WebhookService
91170

171+
/**
172+
* [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending, usage, or credit
173+
* balance and trigger webhooks when a threshold is exceeded.
174+
*
175+
* Alerts created through the API can be scoped to either customers or subscriptions.
176+
*/
92177
fun alerts(): AlertService
93178

94179
fun dimensionalPriceGroups(): DimensionalPriceGroupService
95180

96181
fun subscriptionChanges(): SubscriptionChangeService
97182

183+
/**
184+
* The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid credits
185+
* within Orb.
186+
*/
98187
fun creditBlocks(): CreditBlockService
99188

189+
/**
190+
* The LicenseType resource represents a type of license that can be assigned to users. License
191+
* types are used during billing by grouping metrics on the configured grouping key.
192+
*/
100193
fun licenseTypes(): LicenseTypeService
101194

102195
fun licenses(): LicenseService
@@ -126,38 +219,131 @@ interface OrbClient {
126219

127220
fun topLevel(): TopLevelService.WithRawResponse
128221

222+
/**
223+
* The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
224+
* subscribed to by a customer. Plans define the billing behavior of the subscription. You
225+
* can see more about how to configure prices in the [Price resource](/reference/price).
226+
*/
129227
fun beta(): BetaService.WithRawResponse
130228

229+
/**
230+
* A coupon represents a reusable discount configuration that can be applied either as a
231+
* fixed or percentage amount to an invoice or subscription. Coupons are activated using a
232+
* redemption code, which applies the discount to a subscription or invoice. The duration of
233+
* a coupon determines how long it remains available for use by end users.
234+
*/
131235
fun coupons(): CouponService.WithRawResponse
132236

237+
/**
238+
* The [Credit Note](/invoicing/credit-notes) resource represents a credit that has been
239+
* applied to a particular invoice.
240+
*/
133241
fun creditNotes(): CreditNoteService.WithRawResponse
134242

243+
/**
244+
* A customer is a buyer of your products, and the other party to the billing relationship.
245+
*
246+
* In Orb, customers are assigned system generated identifiers automatically, but it's often
247+
* desirable to have these match existing identifiers in your system. To avoid having to
248+
* denormalize Orb ID information, you can pass in an `external_customer_id` with your own
249+
* identifier. See [Customer ID Aliases](/events-and-metrics/customer-aliases) for further
250+
* information about how these aliases work in Orb.
251+
*
252+
* In addition to having an identifier in your system, a customer may exist in a payment
253+
* provider solution like Stripe. Use the `payment_provider_id` and the `payment_provider`
254+
* enum field to express this mapping.
255+
*
256+
* A customer also has a timezone (from the standard
257+
* [IANA timezone database](https://www.iana.org/time-zones)), which defaults to your
258+
* account's timezone. See [Timezone localization](/essentials/timezones) for information on
259+
* what this timezone parameter influences within Orb.
260+
*/
135261
fun customers(): CustomerService.WithRawResponse
136262

263+
/**
264+
* The [Event](/core-concepts#event) resource represents a usage event that has been created
265+
* for a customer. Events are the core of Orb's usage-based billing model, and are used to
266+
* calculate the usage charges for a given billing period.
267+
*/
137268
fun events(): EventService.WithRawResponse
138269

270+
/**
271+
* An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, representing the
272+
* request for payment for a single subscription. This includes a set of line items, which
273+
* correspond to prices in the subscription's plan and can represent fixed recurring fees or
274+
* usage-based fees. They are generated at the end of a billing period, or as the result of
275+
* an action, such as a cancellation.
276+
*/
139277
fun invoiceLineItems(): InvoiceLineItemService.WithRawResponse
140278

279+
/**
280+
* An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, representing the
281+
* request for payment for a single subscription. This includes a set of line items, which
282+
* correspond to prices in the subscription's plan and can represent fixed recurring fees or
283+
* usage-based fees. They are generated at the end of a billing period, or as the result of
284+
* an action, such as a cancellation.
285+
*/
141286
fun invoices(): InvoiceService.WithRawResponse
142287

288+
/**
289+
* The Item resource represents a sellable product or good. Items are associated with all
290+
* line items, billable metrics, and prices and are used for defining external sync behavior
291+
* for invoices and tax calculation purposes.
292+
*/
143293
fun items(): ItemService.WithRawResponse
144294

295+
/**
296+
* The Metric resource represents a calculation of a quantity based on events. Metrics are
297+
* defined by the query that transforms raw usage events into meaningful values for your
298+
* customers.
299+
*/
145300
fun metrics(): MetricService.WithRawResponse
146301

302+
/**
303+
* The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be
304+
* subscribed to by a customer. Plans define the billing behavior of the subscription. You
305+
* can see more about how to configure prices in the [Price resource](/reference/price).
306+
*/
147307
fun plans(): PlanService.WithRawResponse
148308

309+
/**
310+
* The Price resource represents a price that can be billed on a subscription, resulting in
311+
* a charge on an invoice in the form of an invoice line item. Prices take a quantity and
312+
* determine an amount to bill.
313+
*
314+
* Orb supports a few different pricing models out of the box. Each of these models is
315+
* serialized differently in a given Price object. The model_type field determines the key
316+
* for the configuration object that is present.
317+
*
318+
* For more on the types of prices, see
319+
* [the core concepts documentation](/core-concepts#plan-and-price)
320+
*/
149321
fun prices(): PriceService.WithRawResponse
150322

151323
fun subscriptions(): SubscriptionService.WithRawResponse
152324

325+
/**
326+
* [Alerts within Orb](/product-catalog/configuring-alerts) monitor spending, usage, or
327+
* credit balance and trigger webhooks when a threshold is exceeded.
328+
*
329+
* Alerts created through the API can be scoped to either customers or subscriptions.
330+
*/
153331
fun alerts(): AlertService.WithRawResponse
154332

155333
fun dimensionalPriceGroups(): DimensionalPriceGroupService.WithRawResponse
156334

157335
fun subscriptionChanges(): SubscriptionChangeService.WithRawResponse
158336

337+
/**
338+
* The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid credits
339+
* within Orb.
340+
*/
159341
fun creditBlocks(): CreditBlockService.WithRawResponse
160342

343+
/**
344+
* The LicenseType resource represents a type of license that can be assigned to users.
345+
* License types are used during billing by grouping metrics on the configured grouping key.
346+
*/
161347
fun licenseTypes(): LicenseTypeService.WithRawResponse
162348

163349
fun licenses(): LicenseService.WithRawResponse

0 commit comments

Comments
 (0)