Skip to content

Commit 2f25f86

Browse files
feat(api): api update
1 parent 196c645 commit 2f25f86

11 files changed

Lines changed: 23 additions & 25 deletions

File tree

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 139
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-17c43dab26af75e1b9f7e61ac8da1219cea65c7d0666d98686b71a60183e458d.yml
3-
openapi_spec_hash: 7d7f4d41ccb2023153327ca685dcf942
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb%2Forb-1ca41c4b1d872cf2a198c8cf5edeeeddac012259a7cf211b102bf137c05b8240.yml
3+
openapi_spec_hash: 955066d4865fc42440cd81e40f5f79cd
44
config_hash: c01c1191b1cd696c7ca855ff6d28a8df

orb-kotlin-core/src/main/kotlin/com/withorb/api/models/CouponListParams.kt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import java.util.Objects
1212
*
1313
* The list of coupons is ordered starting from the most recently created coupon. The response also
1414
* includes `pagination_metadata`, which lets the caller retrieve the next page of results if they
15-
* exist. More information about pagination can be found in the Pagination-metadata schema.
15+
* exist.
1616
*/
1717
class CouponListParams
1818
private constructor(

orb-kotlin-core/src/main/kotlin/com/withorb/api/models/EventBackfillCreateParams.kt

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,8 @@ import java.util.Objects
2323
* Creating the backfill enables adding or replacing past events, even those that are older than the
2424
* ingestion grace period. Performing a backfill in Orb involves 3 steps:
2525
* 1. Create the backfill, specifying its parameters.
26-
* 2. [Ingest](ingest) usage events, referencing the backfill (query parameter `backfill_id`).
26+
* 2. [Ingest](/api-reference/event/ingest-events) usage events, referencing the backfill (query
27+
* parameter `backfill_id`).
2728
* 3. [Close](close-backfill) the backfill, propagating the update in past usage throughout Orb.
2829
*
2930
* Changes from a backfill are not reflected until the backfill is closed, so you won’t need to

orb-kotlin-core/src/main/kotlin/com/withorb/api/models/EventBackfillListParams.kt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,7 @@ import java.util.Objects
1212
*
1313
* The list of backfills is ordered starting from the most recently created backfill. The response
1414
* also includes [`pagination_metadata`](/api-reference/pagination), which lets the caller retrieve
15-
* the next page of results if they exist. More information about pagination can be found in the
16-
* [Pagination-metadata schema](pagination).
15+
* the next page of results if they exist.
1716
*/
1817
class EventBackfillListParams
1918
private constructor(

orb-kotlin-core/src/main/kotlin/com/withorb/api/models/SubscriptionFetchCostsParams.kt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ import java.util.Objects
2020
* rather than a currency).
2121
*
2222
* The semantics of this endpoint exactly mirror those of
23-
* [fetching a customer's costs](fetch-customer-costs). Use this endpoint to limit your analysis of
24-
* costs to a specific subscription for the customer (e.g. to de-aggregate costs when a customer's
25-
* subscription has started and stopped on the same day).
23+
* [fetching a customer's costs](/api-reference/customer/fetch-customer-costs). Use this endpoint to
24+
* limit your analysis of costs to a specific subscription for the customer (e.g. to de-aggregate
25+
* costs when a customer's subscription has started and stopped on the same day).
2626
*/
2727
class SubscriptionFetchCostsParams
2828
private constructor(

orb-kotlin-core/src/main/kotlin/com/withorb/api/services/async/CouponServiceAsync.kt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,7 @@ interface CouponServiceAsync {
5656
*
5757
* The list of coupons is ordered starting from the most recently created coupon. The response
5858
* also includes `pagination_metadata`, which lets the caller retrieve the next page of results
59-
* if they exist. More information about pagination can be found in the Pagination-metadata
60-
* schema.
59+
* if they exist.
6160
*/
6261
suspend fun list(
6362
params: CouponListParams = CouponListParams.none(),

orb-kotlin-core/src/main/kotlin/com/withorb/api/services/async/SubscriptionServiceAsync.kt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -425,9 +425,9 @@ interface SubscriptionServiceAsync {
425425
* units rather than a currency).
426426
*
427427
* The semantics of this endpoint exactly mirror those of
428-
* [fetching a customer's costs](fetch-customer-costs). Use this endpoint to limit your analysis
429-
* of costs to a specific subscription for the customer (e.g. to de-aggregate costs when a
430-
* customer's subscription has started and stopped on the same day).
428+
* [fetching a customer's costs](/api-reference/customer/fetch-customer-costs). Use this
429+
* endpoint to limit your analysis of costs to a specific subscription for the customer (e.g. to
430+
* de-aggregate costs when a customer's subscription has started and stopped on the same day).
431431
*/
432432
suspend fun fetchCosts(
433433
subscriptionId: String,

orb-kotlin-core/src/main/kotlin/com/withorb/api/services/async/events/BackfillServiceAsync.kt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,8 @@ interface BackfillServiceAsync {
4040
* Creating the backfill enables adding or replacing past events, even those that are older than
4141
* the ingestion grace period. Performing a backfill in Orb involves 3 steps:
4242
* 1. Create the backfill, specifying its parameters.
43-
* 2. [Ingest](ingest) usage events, referencing the backfill (query parameter `backfill_id`).
43+
* 2. [Ingest](/api-reference/event/ingest-events) usage events, referencing the backfill (query
44+
* parameter `backfill_id`).
4445
* 3. [Close](close-backfill) the backfill, propagating the update in past usage throughout Orb.
4546
*
4647
* Changes from a backfill are not reflected until the backfill is closed, so you won’t need to
@@ -79,8 +80,7 @@ interface BackfillServiceAsync {
7980
*
8081
* The list of backfills is ordered starting from the most recently created backfill. The
8182
* response also includes [`pagination_metadata`](/api-reference/pagination), which lets the
82-
* caller retrieve the next page of results if they exist. More information about pagination can
83-
* be found in the [Pagination-metadata schema](pagination).
83+
* caller retrieve the next page of results if they exist.
8484
*/
8585
suspend fun list(
8686
params: EventBackfillListParams = EventBackfillListParams.none(),

orb-kotlin-core/src/main/kotlin/com/withorb/api/services/blocking/CouponService.kt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,8 +56,7 @@ interface CouponService {
5656
*
5757
* The list of coupons is ordered starting from the most recently created coupon. The response
5858
* also includes `pagination_metadata`, which lets the caller retrieve the next page of results
59-
* if they exist. More information about pagination can be found in the Pagination-metadata
60-
* schema.
59+
* if they exist.
6160
*/
6261
fun list(
6362
params: CouponListParams = CouponListParams.none(),

orb-kotlin-core/src/main/kotlin/com/withorb/api/services/blocking/SubscriptionService.kt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -425,9 +425,9 @@ interface SubscriptionService {
425425
* units rather than a currency).
426426
*
427427
* The semantics of this endpoint exactly mirror those of
428-
* [fetching a customer's costs](fetch-customer-costs). Use this endpoint to limit your analysis
429-
* of costs to a specific subscription for the customer (e.g. to de-aggregate costs when a
430-
* customer's subscription has started and stopped on the same day).
428+
* [fetching a customer's costs](/api-reference/customer/fetch-customer-costs). Use this
429+
* endpoint to limit your analysis of costs to a specific subscription for the customer (e.g. to
430+
* de-aggregate costs when a customer's subscription has started and stopped on the same day).
431431
*/
432432
fun fetchCosts(
433433
subscriptionId: String,

0 commit comments

Comments
 (0)