Skip to content

Commit 2add056

Browse files
stainless-app[bot]stainless-app[bot]
committed
feat(api): api update
1 parent 03dcb31 commit 2add056

8 files changed

Lines changed: 21 additions & 54 deletions

‎.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/orb-0b931ef1842e244faf237ea9dd3f8be2cadf24410a1cbb0bdae6f1f03fd1067d.yml
3-
openapi_spec_hash: b704b2673cb93856fd500e61301c661c
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/orb/orb-98255c02d4a36a27ac910643efec03f942cb7cbea60e99ff91c00f14d3d73308.yml
3+
openapi_spec_hash: 045b84f5baaed0b67907e86ffc833f2c
44
config_hash: c01c1191b1cd696c7ca855ff6d28a8df

‎src/Orb/Models/ChangedSubscriptionResources.cs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -459,8 +459,9 @@ public required IReadOnlyList<InvoiceLevelDiscount> Discounts
459459
}
460460

461461
/// <summary>
462-
/// A URL for the customer-facing invoice portal. This URL expires 30 days after
463-
/// the invoice's due date, or 60 days after being re-generated through the UI.
462+
/// A URL for the customer-facing invoice portal. This URL expires 60 days after
463+
/// the link is generated, or 30 days after the invoice's due date — whichever
464+
/// is later.
464465
/// </summary>
465466
public required string? HostedInvoiceUrl
466467
{

‎src/Orb/Models/Events/EventIngestParams.cs‎

Lines changed: 3 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -153,26 +153,7 @@ namespace Orb.Models.Events;
153153
/// request payload size, but please give us a heads up if you’re changing either
154154
/// of these factors by an order of magnitude from initial setup.</para>
155155
///
156-
/// <para>## Testing in debug mode The ingestion API supports a debug mode, which
157-
/// returns additional verbose output to indicate which event idempotency keys were
158-
/// newly ingested or duplicates from previous requests. To enable this mode, mark
159-
/// `debug=true` as a query parameter.</para>
160-
///
161-
/// <para>If `debug=true` is not specified, the response will only contain `validation_failed`.
162-
/// Orb will still honor the idempotency guarantees set [here](/events-and-metrics/event-ingestion#event-volume-and-concurrency)
163-
/// in all cases.</para>
164-
///
165-
/// <para>We strongly recommend that you only use debug mode as part of testing your
166-
/// initial Orb integration. Once you're ready to switch to production, disable debug
167-
/// mode to take advantage of improved performance and maximal throughput.</para>
168-
///
169-
/// <para>#### Example: ingestion response with `debug=true`</para>
170-
///
171-
/// <para>```json { "debug": { "duplicate": [], "ingested": [ "B7E83HDMfJPAunXW",
172-
/// "SJs5DQJ3TnwSqEZE", "8SivfDsNKwCeAXim" ] }, "validation_failed":
173-
/// [] } ```</para>
174-
///
175-
/// <para>#### Example: ingestion response with `debug=false`</para>
156+
/// <para>#### Example: ingestion response</para>
176157
///
177158
/// <para>```json { "validation_failed": [] } ```</para>
178159
///
@@ -219,8 +200,9 @@ public string? BackfillID
219200
}
220201

221202
/// <summary>
222-
/// Flag to enable additional debug information in the endpoint response
203+
/// Pending Deprecation: Flag to enable additional debug information in the endpoint response
223204
/// </summary>
205+
[Obsolete("deprecated")]
224206
public bool? Debug
225207
{
226208
get

‎src/Orb/Models/Invoice.cs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -322,8 +322,9 @@ public required IReadOnlyList<InvoiceLevelDiscount> Discounts
322322
}
323323

324324
/// <summary>
325-
/// A URL for the customer-facing invoice portal. This URL expires 30 days after
326-
/// the invoice's due date, or 60 days after being re-generated through the UI.
325+
/// A URL for the customer-facing invoice portal. This URL expires 60 days after
326+
/// the link is generated, or 30 days after the invoice's due date — whichever
327+
/// is later.
327328
/// </summary>
328329
public required string? HostedInvoiceUrl
329330
{

‎src/Orb/Models/Invoices/InvoiceFetchUpcomingResponse.cs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -315,8 +315,9 @@ public required IReadOnlyList<InvoiceLevelDiscount> Discounts
315315
}
316316

317317
/// <summary>
318-
/// A URL for the customer-facing invoice portal. This URL expires 30 days after
319-
/// the invoice's due date, or 60 days after being re-generated through the UI.
318+
/// A URL for the customer-facing invoice portal. This URL expires 60 days after
319+
/// the link is generated, or 30 days after the invoice's due date — whichever
320+
/// is later.
320321
/// </summary>
321322
public required string? HostedInvoiceUrl
322323
{

‎src/Orb/Models/Invoices/InvoiceIssueSummaryResponse.cs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -287,8 +287,9 @@ public required CustomerTaxID? CustomerTaxID
287287
}
288288

289289
/// <summary>
290-
/// A URL for the customer-facing invoice portal. This URL expires 30 days after
291-
/// the invoice's due date, or 60 days after being re-generated through the UI.
290+
/// A URL for the customer-facing invoice portal. This URL expires 60 days after
291+
/// the link is generated, or 30 days after the invoice's due date — whichever
292+
/// is later.
292293
/// </summary>
293294
public required string? HostedInvoiceUrl
294295
{

‎src/Orb/Models/Invoices/InvoiceListSummaryResponse.cs‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -288,8 +288,9 @@ public required CustomerTaxID? CustomerTaxID
288288
}
289289

290290
/// <summary>
291-
/// A URL for the customer-facing invoice portal. This URL expires 30 days after
292-
/// the invoice's due date, or 60 days after being re-generated through the UI.
291+
/// A URL for the customer-facing invoice portal. This URL expires 60 days after
292+
/// the link is generated, or 30 days after the invoice's due date — whichever
293+
/// is later.
293294
/// </summary>
294295
public required string? HostedInvoiceUrl
295296
{

‎src/Orb/Services/IEventService.cs‎

Lines changed: 1 addition & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -289,27 +289,7 @@ Task<EventDeprecateResponse> Deprecate(
289289
/// maximum request payload size, but please give us a heads up if you’re changing
290290
/// either of these factors by an order of magnitude from initial setup.</para>
291291
///
292-
/// <para>## Testing in debug mode The ingestion API supports a debug mode, which
293-
/// returns additional verbose output to indicate which event idempotency keys were
294-
/// newly ingested or duplicates from previous requests. To enable this mode, mark
295-
/// `debug=true` as a query parameter.</para>
296-
///
297-
/// <para>If `debug=true` is not specified, the response will only contain
298-
/// `validation_failed`. Orb will still honor the idempotency guarantees set
299-
/// [here](/events-and-metrics/event-ingestion#event-volume-and-concurrency) in all
300-
/// cases.</para>
301-
///
302-
/// <para>We strongly recommend that you only use debug mode as part of testing your
303-
/// initial Orb integration. Once you're ready to switch to production, disable
304-
/// debug mode to take advantage of improved performance and maximal throughput.</para>
305-
///
306-
/// <para>#### Example: ingestion response with `debug=true`</para>
307-
///
308-
/// <para>```json { "debug": { "duplicate": [], "ingested": [
309-
/// "B7E83HDMfJPAunXW", "SJs5DQJ3TnwSqEZE", "8SivfDsNKwCeAXim" ]
310-
/// }, "validation_failed": [] } ```</para>
311-
///
312-
/// <para>#### Example: ingestion response with `debug=false`</para>
292+
/// <para>#### Example: ingestion response</para>
313293
///
314294
/// <para>```json { "validation_failed": [] } ```</para>
315295
/// </summary>

0 commit comments

Comments
 (0)