@transcodely/sdk 0.3.6 → 0.3.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +8 -0
- package/dist/index.cjs +1166 -22
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1010 -19
- package/dist/index.d.ts +1010 -19
- package/dist/index.mjs +1163 -23
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -381,6 +381,135 @@ declare enum BillingStanding {
|
|
|
381
381
|
*/
|
|
382
382
|
DELINQUENT = 4
|
|
383
383
|
}
|
|
384
|
+
/**
|
|
385
|
+
* How AUTOMATION is allowed to treat an organization.
|
|
386
|
+
*
|
|
387
|
+
* Orthogonal to BillingStanding, and the distinction is the whole point.
|
|
388
|
+
* Standing is a derived FACT about payment health. Treatment is a commercial
|
|
389
|
+
* DECISION about whether a cron may act on that fact — email the customer,
|
|
390
|
+
* block their creates, suspend them. An account can be in dunning and
|
|
391
|
+
* untouchable at the same time.
|
|
392
|
+
*
|
|
393
|
+
* ASSIGNED, never derived: an operator says what a relationship is, through the
|
|
394
|
+
* audited admin RPC. Admin surfaces only; a customer does not learn from an API
|
|
395
|
+
* field how patiently we treat them.
|
|
396
|
+
*
|
|
397
|
+
* @generated from enum transcodely.v1.BillingTreatment
|
|
398
|
+
*/
|
|
399
|
+
declare enum BillingTreatment {
|
|
400
|
+
/**
|
|
401
|
+
* @generated from enum value: BILLING_TREATMENT_UNSPECIFIED = 0;
|
|
402
|
+
*/
|
|
403
|
+
UNSPECIFIED = 0,
|
|
404
|
+
/**
|
|
405
|
+
* The default and the full lifecycle: the dunning ladder, the soft limit,
|
|
406
|
+
* suspension, every customer email, and the dispute posture.
|
|
407
|
+
*
|
|
408
|
+
* @generated from enum value: BILLING_TREATMENT_NORMAL = 1;
|
|
409
|
+
*/
|
|
410
|
+
NORMAL = 1,
|
|
411
|
+
/**
|
|
412
|
+
* Billed COMPLETELY NORMALLY — payment method on file, monthly statements,
|
|
413
|
+
* real charges — and exempt from every automated interruption. A failed
|
|
414
|
+
* payment or a dispute on one of these routes to the founder instead of to
|
|
415
|
+
* the customer, so it becomes a conversation rather than a cutoff.
|
|
416
|
+
*
|
|
417
|
+
* Requires a payment method on file: this is a promise not to interrupt
|
|
418
|
+
* someone who pays, not a way to run an account with no card.
|
|
419
|
+
*
|
|
420
|
+
* @generated from enum value: BILLING_TREATMENT_TRUSTED = 2;
|
|
421
|
+
*/
|
|
422
|
+
TRUSTED = 2,
|
|
423
|
+
/**
|
|
424
|
+
* Grandfather / comp semantics: not billed, not enforced. Internal, dogfood
|
|
425
|
+
* and legacy accounts. Selecting it also maintains payment_method_required
|
|
426
|
+
* and billing_exempt, in the same transaction, so the standing derivation and
|
|
427
|
+
* this value can never describe different postures.
|
|
428
|
+
*
|
|
429
|
+
* @generated from enum value: BILLING_TREATMENT_EXEMPT = 3;
|
|
430
|
+
*/
|
|
431
|
+
EXEMPT = 3
|
|
432
|
+
}
|
|
433
|
+
/**
|
|
434
|
+
* How far the CONSEQUENCES of an unpaid statement have progressed.
|
|
435
|
+
*
|
|
436
|
+
* Deliberately NOT a fifth BillingStanding. Standing is payment HEALTH, derived
|
|
437
|
+
* from facts. This is what we have DONE about it, and it needs states standing
|
|
438
|
+
* cannot express: "new jobs refused but playback still serving" and "suspended"
|
|
439
|
+
* are consequences, not healths, and an account can be delinquent for weeks at
|
|
440
|
+
* any of them.
|
|
441
|
+
*
|
|
442
|
+
* Every rung's timing derives from the episode's own start, and the schedule is
|
|
443
|
+
* a set of Go constants (domain.DunningStage) rather than configuration — the
|
|
444
|
+
* day counts below are documentation of that policy, not a second copy of it.
|
|
445
|
+
*
|
|
446
|
+
* ADMIN SURFACES ONLY in this release. A customer is told what is happening to
|
|
447
|
+
* their account in the email that accompanies each rung; they do not read the
|
|
448
|
+
* ladder's internal vocabulary out of an API.
|
|
449
|
+
*
|
|
450
|
+
* @generated from enum transcodely.v1.DunningStage
|
|
451
|
+
*/
|
|
452
|
+
declare enum DunningStage {
|
|
453
|
+
/**
|
|
454
|
+
* @generated from enum value: DUNNING_STAGE_UNSPECIFIED = 0;
|
|
455
|
+
*/
|
|
456
|
+
UNSPECIFIED = 0,
|
|
457
|
+
/**
|
|
458
|
+
* The resting state: no episode, or one that a payment closed.
|
|
459
|
+
*
|
|
460
|
+
* @generated from enum value: DUNNING_STAGE_NONE = 1;
|
|
461
|
+
*/
|
|
462
|
+
NONE = 1,
|
|
463
|
+
/**
|
|
464
|
+
* Day 0 — the provider's charge failed and it is retrying on its own
|
|
465
|
+
* schedule. Full service continues; the customer is told, and nothing else
|
|
466
|
+
* happens.
|
|
467
|
+
*
|
|
468
|
+
* @generated from enum value: DUNNING_STAGE_PAST_DUE = 2;
|
|
469
|
+
*/
|
|
470
|
+
PAST_DUE = 2,
|
|
471
|
+
/**
|
|
472
|
+
* Day 3 — still unpaid, and the mail now names the date service will be
|
|
473
|
+
* limited. Full service continues.
|
|
474
|
+
*
|
|
475
|
+
* @generated from enum value: DUNNING_STAGE_WARNED = 3;
|
|
476
|
+
*/
|
|
477
|
+
WARNED = 3,
|
|
478
|
+
/**
|
|
479
|
+
* Day 7 — NEW jobs are refused. Everything already queued or running
|
|
480
|
+
* finishes, playback keeps serving, and the dashboard stays fully readable.
|
|
481
|
+
*
|
|
482
|
+
* @generated from enum value: DUNNING_STAGE_SOFT_LIMITED = 4;
|
|
483
|
+
*/
|
|
484
|
+
SOFT_LIMITED = 4,
|
|
485
|
+
/**
|
|
486
|
+
* Day 14 — the organization is suspended: API keys refused, public playback
|
|
487
|
+
* stopped. Dashboard reads stay open and Cancel stays allowed, so a suspended
|
|
488
|
+
* customer can still see what they owe, pay it, and stop their own meter.
|
|
489
|
+
*
|
|
490
|
+
* @generated from enum value: DUNNING_STAGE_SUSPENDED = 5;
|
|
491
|
+
*/
|
|
492
|
+
SUSPENDED = 5,
|
|
493
|
+
/**
|
|
494
|
+
* Day 45 — the T-14 notice naming the exact date stored media goes. Nothing
|
|
495
|
+
* new is enforced here; the mail IS the event.
|
|
496
|
+
*
|
|
497
|
+
* @generated from enum value: DUNNING_STAGE_DELETION_WARNED = 6;
|
|
498
|
+
*/
|
|
499
|
+
DELETION_WARNED = 6,
|
|
500
|
+
/**
|
|
501
|
+
* Day 60 — statements marked uncollectible, ledger entries flagged, stored
|
|
502
|
+
* media eligible for deletion. The organization stays suspended. Terminal for
|
|
503
|
+
* this episode.
|
|
504
|
+
*
|
|
505
|
+
* Also the state an operator's manual write-off produces: the same end state,
|
|
506
|
+
* reached earlier and by a human. Which of the two happened is answered by
|
|
507
|
+
* the audit log, not by this field.
|
|
508
|
+
*
|
|
509
|
+
* @generated from enum value: DUNNING_STAGE_WRITTEN_OFF = 7;
|
|
510
|
+
*/
|
|
511
|
+
WRITTEN_OFF = 7
|
|
512
|
+
}
|
|
384
513
|
/**
|
|
385
514
|
* Pagination request parameters.
|
|
386
515
|
*
|
|
@@ -1182,6 +1311,14 @@ declare class App extends Message<App> {
|
|
|
1182
1311
|
* @generated from field: optional double monthly_spend_limit_eur = 15;
|
|
1183
1312
|
*/
|
|
1184
1313
|
monthlySpendLimitEur?: number;
|
|
1314
|
+
/**
|
|
1315
|
+
* Player configuration for the app's hosted player and embeds. Unset when
|
|
1316
|
+
* never configured (the player uses its built-in defaults). Update via
|
|
1317
|
+
* AppService.UpdatePlayerConfig.
|
|
1318
|
+
*
|
|
1319
|
+
* @generated from field: optional transcodely.v1.PlayerConfig player_config = 16;
|
|
1320
|
+
*/
|
|
1321
|
+
playerConfig?: PlayerConfig;
|
|
1185
1322
|
constructor(data?: PartialMessage<App>);
|
|
1186
1323
|
static readonly runtime: typeof proto3;
|
|
1187
1324
|
static readonly typeName = "transcodely.v1.App";
|
|
@@ -1191,6 +1328,122 @@ declare class App extends Message<App> {
|
|
|
1191
1328
|
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): App;
|
|
1192
1329
|
static equals(a: App | PlainMessage<App> | undefined, b: App | PlainMessage<App> | undefined): boolean;
|
|
1193
1330
|
}
|
|
1331
|
+
/**
|
|
1332
|
+
* Player configuration: how the hosted player and embeds present every video
|
|
1333
|
+
* in the app. All fields are optional; an unset field keeps the player's
|
|
1334
|
+
* built-in default.
|
|
1335
|
+
*
|
|
1336
|
+
* @generated from message transcodely.v1.PlayerConfig
|
|
1337
|
+
*/
|
|
1338
|
+
declare class PlayerConfig extends Message<PlayerConfig> {
|
|
1339
|
+
/**
|
|
1340
|
+
* Caption (subtitle) rendering style.
|
|
1341
|
+
*
|
|
1342
|
+
* @generated from field: optional transcodely.v1.CaptionStyle captions = 1;
|
|
1343
|
+
*/
|
|
1344
|
+
captions?: CaptionStyle;
|
|
1345
|
+
constructor(data?: PartialMessage<PlayerConfig>);
|
|
1346
|
+
static readonly runtime: typeof proto3;
|
|
1347
|
+
static readonly typeName = "transcodely.v1.PlayerConfig";
|
|
1348
|
+
static readonly fields: FieldList;
|
|
1349
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): PlayerConfig;
|
|
1350
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): PlayerConfig;
|
|
1351
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): PlayerConfig;
|
|
1352
|
+
static equals(a: PlayerConfig | PlainMessage<PlayerConfig> | undefined, b: PlayerConfig | PlainMessage<PlayerConfig> | undefined): boolean;
|
|
1353
|
+
}
|
|
1354
|
+
/**
|
|
1355
|
+
* Caption rendering style for the hosted player. Colors are 6-digit hex with
|
|
1356
|
+
* a leading '#' (e.g. "#0a0a0a"). On update: an unset field keeps its stored
|
|
1357
|
+
* value, an empty string clears a color back to the player default, and a
|
|
1358
|
+
* numeric field returns to default when set to the documented default value.
|
|
1359
|
+
*
|
|
1360
|
+
* @generated from message transcodely.v1.CaptionStyle
|
|
1361
|
+
*/
|
|
1362
|
+
declare class CaptionStyle extends Message<CaptionStyle> {
|
|
1363
|
+
/**
|
|
1364
|
+
* Cue box background color. Player default: "#0a0a0a". Empty string clears.
|
|
1365
|
+
*
|
|
1366
|
+
* @generated from field: optional string background_color = 1;
|
|
1367
|
+
*/
|
|
1368
|
+
backgroundColor?: string;
|
|
1369
|
+
/**
|
|
1370
|
+
* Cue box background opacity, 0 (fully transparent) to 1 (solid).
|
|
1371
|
+
* Player default: 0.7.
|
|
1372
|
+
*
|
|
1373
|
+
* @generated from field: optional double background_opacity = 2;
|
|
1374
|
+
*/
|
|
1375
|
+
backgroundOpacity?: number;
|
|
1376
|
+
/**
|
|
1377
|
+
* Caption text color. Player default: "#ffffff". Empty string clears.
|
|
1378
|
+
*
|
|
1379
|
+
* @generated from field: optional string text_color = 3;
|
|
1380
|
+
*/
|
|
1381
|
+
textColor?: string;
|
|
1382
|
+
/**
|
|
1383
|
+
* Caption text size multiplier applied to the player's responsive base
|
|
1384
|
+
* size: 0.5 (half) to 2 (double). Player default: 1.
|
|
1385
|
+
*
|
|
1386
|
+
* @generated from field: optional double font_scale = 4;
|
|
1387
|
+
*/
|
|
1388
|
+
fontScale?: number;
|
|
1389
|
+
constructor(data?: PartialMessage<CaptionStyle>);
|
|
1390
|
+
static readonly runtime: typeof proto3;
|
|
1391
|
+
static readonly typeName = "transcodely.v1.CaptionStyle";
|
|
1392
|
+
static readonly fields: FieldList;
|
|
1393
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): CaptionStyle;
|
|
1394
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): CaptionStyle;
|
|
1395
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): CaptionStyle;
|
|
1396
|
+
static equals(a: CaptionStyle | PlainMessage<CaptionStyle> | undefined, b: CaptionStyle | PlainMessage<CaptionStyle> | undefined): boolean;
|
|
1397
|
+
}
|
|
1398
|
+
/**
|
|
1399
|
+
* Request to update player configuration for an app.
|
|
1400
|
+
*
|
|
1401
|
+
* @generated from message transcodely.v1.UpdatePlayerConfigRequest
|
|
1402
|
+
*/
|
|
1403
|
+
declare class UpdatePlayerConfigRequest extends Message<UpdatePlayerConfigRequest> {
|
|
1404
|
+
/**
|
|
1405
|
+
* App ID.
|
|
1406
|
+
*
|
|
1407
|
+
* @generated from field: string id = 1;
|
|
1408
|
+
*/
|
|
1409
|
+
id: string;
|
|
1410
|
+
/**
|
|
1411
|
+
* Player configuration to merge. Fields present here overwrite the stored
|
|
1412
|
+
* value; absent fields are left unchanged.
|
|
1413
|
+
*
|
|
1414
|
+
* @generated from field: transcodely.v1.PlayerConfig player_config = 2;
|
|
1415
|
+
*/
|
|
1416
|
+
playerConfig?: PlayerConfig;
|
|
1417
|
+
constructor(data?: PartialMessage<UpdatePlayerConfigRequest>);
|
|
1418
|
+
static readonly runtime: typeof proto3;
|
|
1419
|
+
static readonly typeName = "transcodely.v1.UpdatePlayerConfigRequest";
|
|
1420
|
+
static readonly fields: FieldList;
|
|
1421
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): UpdatePlayerConfigRequest;
|
|
1422
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): UpdatePlayerConfigRequest;
|
|
1423
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): UpdatePlayerConfigRequest;
|
|
1424
|
+
static equals(a: UpdatePlayerConfigRequest | PlainMessage<UpdatePlayerConfigRequest> | undefined, b: UpdatePlayerConfigRequest | PlainMessage<UpdatePlayerConfigRequest> | undefined): boolean;
|
|
1425
|
+
}
|
|
1426
|
+
/**
|
|
1427
|
+
* Response from updating player configuration.
|
|
1428
|
+
*
|
|
1429
|
+
* @generated from message transcodely.v1.UpdatePlayerConfigResponse
|
|
1430
|
+
*/
|
|
1431
|
+
declare class UpdatePlayerConfigResponse extends Message<UpdatePlayerConfigResponse> {
|
|
1432
|
+
/**
|
|
1433
|
+
* The updated app with merged player config.
|
|
1434
|
+
*
|
|
1435
|
+
* @generated from field: transcodely.v1.App app = 1;
|
|
1436
|
+
*/
|
|
1437
|
+
app?: App;
|
|
1438
|
+
constructor(data?: PartialMessage<UpdatePlayerConfigResponse>);
|
|
1439
|
+
static readonly runtime: typeof proto3;
|
|
1440
|
+
static readonly typeName = "transcodely.v1.UpdatePlayerConfigResponse";
|
|
1441
|
+
static readonly fields: FieldList;
|
|
1442
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): UpdatePlayerConfigResponse;
|
|
1443
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): UpdatePlayerConfigResponse;
|
|
1444
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): UpdatePlayerConfigResponse;
|
|
1445
|
+
static equals(a: UpdatePlayerConfigResponse | PlainMessage<UpdatePlayerConfigResponse> | undefined, b: UpdatePlayerConfigResponse | PlainMessage<UpdatePlayerConfigResponse> | undefined): boolean;
|
|
1446
|
+
}
|
|
1194
1447
|
/**
|
|
1195
1448
|
* Request to create a new app.
|
|
1196
1449
|
*
|
|
@@ -1875,7 +2128,105 @@ declare enum InvoiceLineType {
|
|
|
1875
2128
|
*
|
|
1876
2129
|
* @generated from enum value: INVOICE_LINE_TYPE_ADJUSTMENT = 4;
|
|
1877
2130
|
*/
|
|
1878
|
-
ADJUSTMENT = 4
|
|
2131
|
+
ADJUSTMENT = 4,
|
|
2132
|
+
/**
|
|
2133
|
+
* Metered hosting: managed storage (GB, averaged over the covered days) and
|
|
2134
|
+
* CDN delivery (GB egressed), one line per app and service. dimensions
|
|
2135
|
+
* carries {"app_id", "service": "storage"|"egress", "covered_from",
|
|
2136
|
+
* "covered_through"} — the coverage window rolls with the meter, so the last
|
|
2137
|
+
* day or so of a period appears on the next statement rather than this one.
|
|
2138
|
+
*
|
|
2139
|
+
* @generated from enum value: INVOICE_LINE_TYPE_HOSTING = 5;
|
|
2140
|
+
*/
|
|
2141
|
+
HOSTING = 5
|
|
2142
|
+
}
|
|
2143
|
+
/**
|
|
2144
|
+
* How much unbilled usage an organization's payment history earns it.
|
|
2145
|
+
*
|
|
2146
|
+
* Derived from the number of statements it has paid, never stored, and it only
|
|
2147
|
+
* ever moves upward as payments land. It is not a customer segment, a plan, or
|
|
2148
|
+
* anything anyone is told about beyond the billing page: its single job is to
|
|
2149
|
+
* answer "how much work should we run for this account before asking to be
|
|
2150
|
+
* paid".
|
|
2151
|
+
*
|
|
2152
|
+
* @generated from enum transcodely.v1.TrustTier
|
|
2153
|
+
*/
|
|
2154
|
+
declare enum TrustTier {
|
|
2155
|
+
/**
|
|
2156
|
+
* @generated from enum value: TRUST_TIER_UNSPECIFIED = 0;
|
|
2157
|
+
*/
|
|
2158
|
+
UNSPECIFIED = 0,
|
|
2159
|
+
/**
|
|
2160
|
+
* No settled payments yet. Every account starts here, including the ones that
|
|
2161
|
+
* go on to spend thousands.
|
|
2162
|
+
*
|
|
2163
|
+
* @generated from enum value: TRUST_TIER_NEW = 1;
|
|
2164
|
+
*/
|
|
2165
|
+
NEW = 1,
|
|
2166
|
+
/**
|
|
2167
|
+
* One or two settled payments.
|
|
2168
|
+
*
|
|
2169
|
+
* @generated from enum value: TRUST_TIER_ESTABLISHED = 2;
|
|
2170
|
+
*/
|
|
2171
|
+
ESTABLISHED = 2,
|
|
2172
|
+
/**
|
|
2173
|
+
* Three or more settled payments. The tier imposes NO threshold of its own —
|
|
2174
|
+
* the account falls through to whatever ceiling its plan sets, which for most
|
|
2175
|
+
* accounts is none. This is where the ladder is meant to end up.
|
|
2176
|
+
*
|
|
2177
|
+
* @generated from enum value: TRUST_TIER_PROVEN = 3;
|
|
2178
|
+
*/
|
|
2179
|
+
PROVEN = 3
|
|
2180
|
+
}
|
|
2181
|
+
/**
|
|
2182
|
+
* Which rung supplied an organization's outstanding-balance threshold.
|
|
2183
|
+
*
|
|
2184
|
+
* Same purpose as LimitSource on the usage ladder: "€50" reads very differently
|
|
2185
|
+
* depending on whether changing it means an operator editing this organization,
|
|
2186
|
+
* editing its plan, or the account simply paying an invoice.
|
|
2187
|
+
*
|
|
2188
|
+
* @generated from enum transcodely.v1.ExposureThresholdSource
|
|
2189
|
+
*/
|
|
2190
|
+
declare enum ExposureThresholdSource {
|
|
2191
|
+
/**
|
|
2192
|
+
* @generated from enum value: EXPOSURE_THRESHOLD_SOURCE_UNSPECIFIED = 0;
|
|
2193
|
+
*/
|
|
2194
|
+
UNSPECIFIED = 0,
|
|
2195
|
+
/**
|
|
2196
|
+
* An operator set this organization's threshold by hand. Audited, and the
|
|
2197
|
+
* only rung that can RAISE a threshold above what the tier would give.
|
|
2198
|
+
*
|
|
2199
|
+
* @generated from enum value: EXPOSURE_THRESHOLD_SOURCE_OVERRIDE = 1;
|
|
2200
|
+
*/
|
|
2201
|
+
OVERRIDE = 1,
|
|
2202
|
+
/**
|
|
2203
|
+
* The trust tier's own number — the everyday answer.
|
|
2204
|
+
*
|
|
2205
|
+
* @generated from enum value: EXPOSURE_THRESHOLD_SOURCE_TRUST_TIER = 2;
|
|
2206
|
+
*/
|
|
2207
|
+
TRUST_TIER = 2,
|
|
2208
|
+
/**
|
|
2209
|
+
* The monthly spend ceiling on the organization's plan. It joins by MINIMUM,
|
|
2210
|
+
* so a plan can only ever tighten what the tier or an operator allowed:
|
|
2211
|
+
* carrying more unbilled usage than an account is permitted to spend in a
|
|
2212
|
+
* month would be extending credit past the amount it may run up at all.
|
|
2213
|
+
*
|
|
2214
|
+
* @generated from enum value: EXPOSURE_THRESHOLD_SOURCE_ORG_PLAN = 3;
|
|
2215
|
+
*/
|
|
2216
|
+
ORG_PLAN = 3,
|
|
2217
|
+
/**
|
|
2218
|
+
* The platform-wide default ceiling.
|
|
2219
|
+
*
|
|
2220
|
+
* @generated from enum value: EXPOSURE_THRESHOLD_SOURCE_PLATFORM_DEFAULT = 4;
|
|
2221
|
+
*/
|
|
2222
|
+
PLATFORM_DEFAULT = 4,
|
|
2223
|
+
/**
|
|
2224
|
+
* Every rung declined: no threshold applies, no reminders are sent and
|
|
2225
|
+
* admission is never refused for this reason.
|
|
2226
|
+
*
|
|
2227
|
+
* @generated from enum value: EXPOSURE_THRESHOLD_SOURCE_UNBOUNDED = 5;
|
|
2228
|
+
*/
|
|
2229
|
+
UNBOUNDED = 5
|
|
1879
2230
|
}
|
|
1880
2231
|
/**
|
|
1881
2232
|
* Whether an organization has a payment method the provider can charge.
|
|
@@ -2276,15 +2627,35 @@ declare class BillingPortalSession extends Message<BillingPortalSession> {
|
|
|
2276
2627
|
* Where to send the browser. Single-use and short-lived; request a new
|
|
2277
2628
|
* session rather than storing this.
|
|
2278
2629
|
*
|
|
2630
|
+
* Points at the portal's settings section, where payment methods are managed,
|
|
2631
|
+
* rather than at its landing page.
|
|
2632
|
+
*
|
|
2279
2633
|
* @generated from field: string url = 2;
|
|
2280
2634
|
*/
|
|
2281
2635
|
url: string;
|
|
2282
2636
|
/**
|
|
2283
|
-
* When the session stops working.
|
|
2637
|
+
* When the session stops working. Applies to url and session_token alike —
|
|
2638
|
+
* they are two ways into the same session.
|
|
2284
2639
|
*
|
|
2285
2640
|
* @generated from field: google.protobuf.Timestamp expires_at = 3;
|
|
2286
2641
|
*/
|
|
2287
2642
|
expiresAt?: Timestamp;
|
|
2643
|
+
/**
|
|
2644
|
+
* Short-lived (~1h), single-customer-scoped token for the provider's embedded
|
|
2645
|
+
* payment-method form, so a card can be added in place instead of by
|
|
2646
|
+
* redirecting to the hosted portal.
|
|
2647
|
+
*
|
|
2648
|
+
* Same trust level as `url`, which reaches the same portal as the same
|
|
2649
|
+
* customer with no further authentication. It is still a bare credential:
|
|
2650
|
+
* hand it to the embed, never log or store it, and request a new session
|
|
2651
|
+
* instead of reusing one.
|
|
2652
|
+
*
|
|
2653
|
+
* Empty when the configured provider exposes no such token; fall back to
|
|
2654
|
+
* opening `url`.
|
|
2655
|
+
*
|
|
2656
|
+
* @generated from field: string session_token = 4;
|
|
2657
|
+
*/
|
|
2658
|
+
sessionToken: string;
|
|
2288
2659
|
constructor(data?: PartialMessage<BillingPortalSession>);
|
|
2289
2660
|
static readonly runtime: typeof proto3;
|
|
2290
2661
|
static readonly typeName = "transcodely.v1.BillingPortalSession";
|
|
@@ -2294,6 +2665,299 @@ declare class BillingPortalSession extends Message<BillingPortalSession> {
|
|
|
2294
2665
|
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): BillingPortalSession;
|
|
2295
2666
|
static equals(a: BillingPortalSession | PlainMessage<BillingPortalSession> | undefined, b: BillingPortalSession | PlainMessage<BillingPortalSession> | undefined): boolean;
|
|
2296
2667
|
}
|
|
2668
|
+
/**
|
|
2669
|
+
* An organization's monthly budget and the spend it is measured against.
|
|
2670
|
+
*
|
|
2671
|
+
* A budget is the customer's OWN telemetry: it exists so an account can be told
|
|
2672
|
+
* it is spending more than it meant to. It NEVER enforces anything. Crossing
|
|
2673
|
+
* 100% of a budget sends an email and changes nothing else — no job is
|
|
2674
|
+
* rejected, no video stops playing, no limit is applied.
|
|
2675
|
+
*
|
|
2676
|
+
* It is not the per-app spend LIMIT (App.monthly_spend_limit_eur, set via
|
|
2677
|
+
* AppService.UpdateSpendLimit), which IS a hard cap: at 100% of a spend limit,
|
|
2678
|
+
* new jobs are refused. Limits block; budgets notify. An organization can use
|
|
2679
|
+
* either, both, or neither.
|
|
2680
|
+
*
|
|
2681
|
+
* @generated from message transcodely.v1.Budget
|
|
2682
|
+
*/
|
|
2683
|
+
declare class Budget extends Message<Budget> {
|
|
2684
|
+
/**
|
|
2685
|
+
* Object type, always "budget".
|
|
2686
|
+
*
|
|
2687
|
+
* @generated from field: string object = 1;
|
|
2688
|
+
*/
|
|
2689
|
+
object: string;
|
|
2690
|
+
/**
|
|
2691
|
+
* Organization this budget belongs to.
|
|
2692
|
+
*
|
|
2693
|
+
* @generated from field: string org_id = 2;
|
|
2694
|
+
*/
|
|
2695
|
+
orgId: string;
|
|
2696
|
+
/**
|
|
2697
|
+
* The monthly budget in EUR. Absent when no budget is set, which is the
|
|
2698
|
+
* default and means no alerts are sent.
|
|
2699
|
+
*
|
|
2700
|
+
* @generated from field: optional double amount_eur = 3;
|
|
2701
|
+
*/
|
|
2702
|
+
amountEur?: number;
|
|
2703
|
+
/**
|
|
2704
|
+
* Spend so far in the current billing period, in EUR.
|
|
2705
|
+
*
|
|
2706
|
+
* This is the same ledger, over the same window, that GetUpcomingInvoice
|
|
2707
|
+
* reports — it covers transcoding AND hosting for every app in the
|
|
2708
|
+
* organization, and it excludes usage that will never be billed. It is
|
|
2709
|
+
* therefore NOT the same number as AppService.GetSpend, which is scoped to
|
|
2710
|
+
* one app, counts estimates for jobs still running, and knows nothing about
|
|
2711
|
+
* hosting.
|
|
2712
|
+
*
|
|
2713
|
+
* @generated from field: double spent_eur = 4;
|
|
2714
|
+
*/
|
|
2715
|
+
spentEur: number;
|
|
2716
|
+
/**
|
|
2717
|
+
* spent_eur as a percentage of amount_eur. Absent when no budget is set.
|
|
2718
|
+
* Not capped at 100: an organization at 240% of its budget is shown 240.
|
|
2719
|
+
*
|
|
2720
|
+
* @generated from field: optional double used_percent = 5;
|
|
2721
|
+
*/
|
|
2722
|
+
usedPercent?: number;
|
|
2723
|
+
/**
|
|
2724
|
+
* Start of the current billing period (inclusive), UTC.
|
|
2725
|
+
*
|
|
2726
|
+
* @generated from field: google.protobuf.Timestamp period_start = 6;
|
|
2727
|
+
*/
|
|
2728
|
+
periodStart?: Timestamp;
|
|
2729
|
+
/**
|
|
2730
|
+
* End of the current billing period (exclusive), UTC. Spend resets here.
|
|
2731
|
+
*
|
|
2732
|
+
* @generated from field: google.protobuf.Timestamp period_end = 7;
|
|
2733
|
+
*/
|
|
2734
|
+
periodEnd?: Timestamp;
|
|
2735
|
+
/**
|
|
2736
|
+
* The percentage steps that send an alert email, ascending. Fixed at
|
|
2737
|
+
* 50, 80 and 100 today; new steps may be added.
|
|
2738
|
+
*
|
|
2739
|
+
* @generated from field: repeated int32 alert_steps = 8;
|
|
2740
|
+
*/
|
|
2741
|
+
alertSteps: number[];
|
|
2742
|
+
/**
|
|
2743
|
+
* The steps already emailed this billing period, ascending. Fire-once per
|
|
2744
|
+
* period: a step listed here does not send again, and changing the budget
|
|
2745
|
+
* mid-period does not re-arm it. Empty at the start of every period.
|
|
2746
|
+
*
|
|
2747
|
+
* @generated from field: repeated int32 notified_steps = 9;
|
|
2748
|
+
*/
|
|
2749
|
+
notifiedSteps: number[];
|
|
2750
|
+
/**
|
|
2751
|
+
* ISO 4217 currency code for every amount here. Always "EUR" today.
|
|
2752
|
+
*
|
|
2753
|
+
* @generated from field: string currency = 10;
|
|
2754
|
+
*/
|
|
2755
|
+
currency: string;
|
|
2756
|
+
constructor(data?: PartialMessage<Budget>);
|
|
2757
|
+
static readonly runtime: typeof proto3;
|
|
2758
|
+
static readonly typeName = "transcodely.v1.Budget";
|
|
2759
|
+
static readonly fields: FieldList;
|
|
2760
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Budget;
|
|
2761
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Budget;
|
|
2762
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Budget;
|
|
2763
|
+
static equals(a: Budget | PlainMessage<Budget> | undefined, b: Budget | PlainMessage<Budget> | undefined): boolean;
|
|
2764
|
+
}
|
|
2765
|
+
/**
|
|
2766
|
+
* An organization's unsettled balance and the threshold it is measured against.
|
|
2767
|
+
*
|
|
2768
|
+
* # What the number is
|
|
2769
|
+
*
|
|
2770
|
+
* Usage that has been accrued and NOT yet captured onto a statement —
|
|
2771
|
+
* transcoding and hosting, across every app in the organization. Paying a
|
|
2772
|
+
* statement, or settling mid-cycle, resets it to zero.
|
|
2773
|
+
*
|
|
2774
|
+
* It is a different number from all three of its neighbours, and the
|
|
2775
|
+
* differences matter:
|
|
2776
|
+
*
|
|
2777
|
+
* - GetUpcomingInvoice shows what THIS PERIOD has accrued. This shows what is
|
|
2778
|
+
* UNSETTLED, which also carries anything an earlier period left uncaptured.
|
|
2779
|
+
* - Budget.spent_eur keeps counting after an invoice is issued, because spend
|
|
2780
|
+
* does not un-happen when it is billed. This drops to zero when it is.
|
|
2781
|
+
* - App.monthly_spend_limit_eur is a cap the customer sets on one app for
|
|
2782
|
+
* themselves. This is the platform's own exposure control over the whole
|
|
2783
|
+
* organization, and no calendar clears it — only payment does.
|
|
2784
|
+
*
|
|
2785
|
+
* # What happens as it climbs
|
|
2786
|
+
*
|
|
2787
|
+
* Nothing, for a long time. Reminder emails go out at 80%, 100%, 125%, 150% and
|
|
2788
|
+
* 175% of the threshold and NOTHING is restricted at any of them: service
|
|
2789
|
+
* continues past the threshold on purpose, so that a busy month never stops a
|
|
2790
|
+
* pipeline without warning. Only at `hard_stop_cents` — twice the threshold —
|
|
2791
|
+
* are new jobs refused, with error code "outstanding_balance_exceeded".
|
|
2792
|
+
*
|
|
2793
|
+
* Even then, work already queued or running finishes, outputs are delivered,
|
|
2794
|
+
* videos keep playing, uploads keep working and jobs can still be canceled.
|
|
2795
|
+
* Paying lifts the block on the very next request.
|
|
2796
|
+
*
|
|
2797
|
+
* @generated from message transcodely.v1.OutstandingBalance
|
|
2798
|
+
*/
|
|
2799
|
+
declare class OutstandingBalance extends Message<OutstandingBalance> {
|
|
2800
|
+
/**
|
|
2801
|
+
* Object type, always "outstanding_balance".
|
|
2802
|
+
*
|
|
2803
|
+
* @generated from field: string object = 1;
|
|
2804
|
+
*/
|
|
2805
|
+
object: string;
|
|
2806
|
+
/**
|
|
2807
|
+
* Organization this balance belongs to.
|
|
2808
|
+
*
|
|
2809
|
+
* @generated from field: string org_id = 2;
|
|
2810
|
+
*/
|
|
2811
|
+
orgId: string;
|
|
2812
|
+
/**
|
|
2813
|
+
* The unsettled amount, in integer minor units (cents) of `currency`.
|
|
2814
|
+
* Rendered as a JSON string per the protobuf 64-bit integer mapping.
|
|
2815
|
+
*
|
|
2816
|
+
* @generated from field: int64 outstanding_cents = 3;
|
|
2817
|
+
*/
|
|
2818
|
+
outstandingCents: bigint;
|
|
2819
|
+
/**
|
|
2820
|
+
* The trust tier the organization's payment history puts it on, which is what
|
|
2821
|
+
* sets the threshold unless an operator or a plan overrides it.
|
|
2822
|
+
*
|
|
2823
|
+
* @generated from field: transcodely.v1.TrustTier tier = 4;
|
|
2824
|
+
*/
|
|
2825
|
+
tier: TrustTier;
|
|
2826
|
+
/**
|
|
2827
|
+
* How many statements this organization has PAID. The input behind `tier`,
|
|
2828
|
+
* surfaced so the path to a higher threshold is visible rather than implied.
|
|
2829
|
+
* A mid-cycle settlement counts once it is paid, like any other statement.
|
|
2830
|
+
*
|
|
2831
|
+
* @generated from field: int64 settled_payments = 5;
|
|
2832
|
+
*/
|
|
2833
|
+
settledPayments: bigint;
|
|
2834
|
+
/**
|
|
2835
|
+
* The threshold, in cents. Absent when no threshold applies at all — a
|
|
2836
|
+
* long-standing account with no plan ceiling has none, which is the intended
|
|
2837
|
+
* destination of the whole ladder.
|
|
2838
|
+
*
|
|
2839
|
+
* @generated from field: optional int64 threshold_cents = 6;
|
|
2840
|
+
*/
|
|
2841
|
+
thresholdCents?: bigint;
|
|
2842
|
+
/**
|
|
2843
|
+
* Which rung supplied `threshold_cents`.
|
|
2844
|
+
*
|
|
2845
|
+
* @generated from field: transcodely.v1.ExposureThresholdSource threshold_source = 7;
|
|
2846
|
+
*/
|
|
2847
|
+
thresholdSource: ExposureThresholdSource;
|
|
2848
|
+
/**
|
|
2849
|
+
* The amount at which new-job admission stops: twice `threshold_cents`.
|
|
2850
|
+
* Absent exactly when `threshold_cents` is.
|
|
2851
|
+
*
|
|
2852
|
+
* @generated from field: optional int64 hard_stop_cents = 8;
|
|
2853
|
+
*/
|
|
2854
|
+
hardStopCents?: bigint;
|
|
2855
|
+
/**
|
|
2856
|
+
* Whether new jobs are being refused right now. Reads the same numbers the
|
|
2857
|
+
* admission gate reads, so a card showing false cannot coexist with a create
|
|
2858
|
+
* being rejected for this reason.
|
|
2859
|
+
*
|
|
2860
|
+
* @generated from field: bool blocked = 9;
|
|
2861
|
+
*/
|
|
2862
|
+
blocked: boolean;
|
|
2863
|
+
/**
|
|
2864
|
+
* `outstanding_cents` as a percentage of `threshold_cents`. Absent when no
|
|
2865
|
+
* threshold applies. Not capped at 100: an organization at 180% is shown 180.
|
|
2866
|
+
*
|
|
2867
|
+
* @generated from field: optional double used_percent = 10;
|
|
2868
|
+
*/
|
|
2869
|
+
usedPercent?: number;
|
|
2870
|
+
/**
|
|
2871
|
+
* The percentage steps that send a reminder email, ascending. 80, 100, 125,
|
|
2872
|
+
* 150, 175 and 200 today; the last one is where admission stops.
|
|
2873
|
+
*
|
|
2874
|
+
* @generated from field: repeated int32 alert_steps = 11;
|
|
2875
|
+
*/
|
|
2876
|
+
alertSteps: number[];
|
|
2877
|
+
/**
|
|
2878
|
+
* The steps already emailed for the current accrual window, ascending.
|
|
2879
|
+
* Fire-once: a step listed here does not send again until the balance is
|
|
2880
|
+
* settled or the billing period rolls.
|
|
2881
|
+
*
|
|
2882
|
+
* @generated from field: repeated int32 notified_steps = 12;
|
|
2883
|
+
*/
|
|
2884
|
+
notifiedSteps: number[];
|
|
2885
|
+
/**
|
|
2886
|
+
* ISO 4217 currency code for every amount here. Always "EUR" today.
|
|
2887
|
+
*
|
|
2888
|
+
* @generated from field: string currency = 13;
|
|
2889
|
+
*/
|
|
2890
|
+
currency: string;
|
|
2891
|
+
/**
|
|
2892
|
+
* Whether SettleOutstandingBalance is available on this deployment. False
|
|
2893
|
+
* while the settlement rail is disabled — a billing page should not render a
|
|
2894
|
+
* "pay now" action that can only fail.
|
|
2895
|
+
*
|
|
2896
|
+
* @generated from field: bool settlement_available = 14;
|
|
2897
|
+
*/
|
|
2898
|
+
settlementAvailable: boolean;
|
|
2899
|
+
constructor(data?: PartialMessage<OutstandingBalance>);
|
|
2900
|
+
static readonly runtime: typeof proto3;
|
|
2901
|
+
static readonly typeName = "transcodely.v1.OutstandingBalance";
|
|
2902
|
+
static readonly fields: FieldList;
|
|
2903
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): OutstandingBalance;
|
|
2904
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): OutstandingBalance;
|
|
2905
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): OutstandingBalance;
|
|
2906
|
+
static equals(a: OutstandingBalance | PlainMessage<OutstandingBalance> | undefined, b: OutstandingBalance | PlainMessage<OutstandingBalance> | undefined): boolean;
|
|
2907
|
+
}
|
|
2908
|
+
/**
|
|
2909
|
+
* A statement produced by paying an outstanding balance mid-cycle.
|
|
2910
|
+
*
|
|
2911
|
+
* @generated from message transcodely.v1.Settlement
|
|
2912
|
+
*/
|
|
2913
|
+
declare class Settlement extends Message<Settlement> {
|
|
2914
|
+
/**
|
|
2915
|
+
* Object type, always "settlement".
|
|
2916
|
+
*
|
|
2917
|
+
* @generated from field: string object = 1;
|
|
2918
|
+
*/
|
|
2919
|
+
object: string;
|
|
2920
|
+
/**
|
|
2921
|
+
* The statement the balance was captured onto. It is an ordinary invoice —
|
|
2922
|
+
* readable through GetInvoice, listed by ListInvoices, and paid through the
|
|
2923
|
+
* same provider flow as any other.
|
|
2924
|
+
*
|
|
2925
|
+
* @generated from field: string invoice_id = 2;
|
|
2926
|
+
*/
|
|
2927
|
+
invoiceId: string;
|
|
2928
|
+
/**
|
|
2929
|
+
* What it came to, in integer minor units (cents).
|
|
2930
|
+
*
|
|
2931
|
+
* @generated from field: int64 amount_cents = 3;
|
|
2932
|
+
*/
|
|
2933
|
+
amountCents: bigint;
|
|
2934
|
+
/**
|
|
2935
|
+
* The window the statement covers, UTC. It starts where the previous
|
|
2936
|
+
* statement ended (or at the period start) and ends at the settlement
|
|
2937
|
+
* instant.
|
|
2938
|
+
*
|
|
2939
|
+
* @generated from field: google.protobuf.Timestamp period_start = 4;
|
|
2940
|
+
*/
|
|
2941
|
+
periodStart?: Timestamp;
|
|
2942
|
+
/**
|
|
2943
|
+
* @generated from field: google.protobuf.Timestamp period_end = 5;
|
|
2944
|
+
*/
|
|
2945
|
+
periodEnd?: Timestamp;
|
|
2946
|
+
/**
|
|
2947
|
+
* ISO 4217 currency code. Always "EUR" today.
|
|
2948
|
+
*
|
|
2949
|
+
* @generated from field: string currency = 6;
|
|
2950
|
+
*/
|
|
2951
|
+
currency: string;
|
|
2952
|
+
constructor(data?: PartialMessage<Settlement>);
|
|
2953
|
+
static readonly runtime: typeof proto3;
|
|
2954
|
+
static readonly typeName = "transcodely.v1.Settlement";
|
|
2955
|
+
static readonly fields: FieldList;
|
|
2956
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): Settlement;
|
|
2957
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): Settlement;
|
|
2958
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): Settlement;
|
|
2959
|
+
static equals(a: Settlement | PlainMessage<Settlement> | undefined, b: Settlement | PlainMessage<Settlement> | undefined): boolean;
|
|
2960
|
+
}
|
|
2297
2961
|
/**
|
|
2298
2962
|
* Request to list the organization's invoices.
|
|
2299
2963
|
*
|
|
@@ -2497,9 +3161,185 @@ declare class CreateBillingPortalSessionResponse extends Message<CreateBillingPo
|
|
|
2497
3161
|
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): CreateBillingPortalSessionResponse;
|
|
2498
3162
|
static equals(a: CreateBillingPortalSessionResponse | PlainMessage<CreateBillingPortalSessionResponse> | undefined, b: CreateBillingPortalSessionResponse | PlainMessage<CreateBillingPortalSessionResponse> | undefined): boolean;
|
|
2499
3163
|
}
|
|
3164
|
+
/**
|
|
3165
|
+
* Request to read the organization's monthly budget. The organization is taken
|
|
3166
|
+
* from the X-Organization-ID header.
|
|
3167
|
+
*
|
|
3168
|
+
* @generated from message transcodely.v1.GetBudgetRequest
|
|
3169
|
+
*/
|
|
3170
|
+
declare class GetBudgetRequest extends Message<GetBudgetRequest> {
|
|
3171
|
+
constructor(data?: PartialMessage<GetBudgetRequest>);
|
|
3172
|
+
static readonly runtime: typeof proto3;
|
|
3173
|
+
static readonly typeName = "transcodely.v1.GetBudgetRequest";
|
|
3174
|
+
static readonly fields: FieldList;
|
|
3175
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): GetBudgetRequest;
|
|
3176
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): GetBudgetRequest;
|
|
3177
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): GetBudgetRequest;
|
|
3178
|
+
static equals(a: GetBudgetRequest | PlainMessage<GetBudgetRequest> | undefined, b: GetBudgetRequest | PlainMessage<GetBudgetRequest> | undefined): boolean;
|
|
3179
|
+
}
|
|
3180
|
+
/**
|
|
3181
|
+
* Response carrying the budget and the spend it is measured against.
|
|
3182
|
+
*
|
|
3183
|
+
* @generated from message transcodely.v1.GetBudgetResponse
|
|
3184
|
+
*/
|
|
3185
|
+
declare class GetBudgetResponse extends Message<GetBudgetResponse> {
|
|
3186
|
+
/**
|
|
3187
|
+
* The budget. Always present: an organization with no budget set gets one
|
|
3188
|
+
* with amount_eur absent and spent_eur still populated, so the current
|
|
3189
|
+
* period's spend can be shown before a budget exists.
|
|
3190
|
+
*
|
|
3191
|
+
* @generated from field: transcodely.v1.Budget budget = 1;
|
|
3192
|
+
*/
|
|
3193
|
+
budget?: Budget;
|
|
3194
|
+
constructor(data?: PartialMessage<GetBudgetResponse>);
|
|
3195
|
+
static readonly runtime: typeof proto3;
|
|
3196
|
+
static readonly typeName = "transcodely.v1.GetBudgetResponse";
|
|
3197
|
+
static readonly fields: FieldList;
|
|
3198
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): GetBudgetResponse;
|
|
3199
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): GetBudgetResponse;
|
|
3200
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): GetBudgetResponse;
|
|
3201
|
+
static equals(a: GetBudgetResponse | PlainMessage<GetBudgetResponse> | undefined, b: GetBudgetResponse | PlainMessage<GetBudgetResponse> | undefined): boolean;
|
|
3202
|
+
}
|
|
3203
|
+
/**
|
|
3204
|
+
* Request to set or clear the organization's monthly budget. The organization
|
|
3205
|
+
* is taken from the X-Organization-ID header.
|
|
3206
|
+
*
|
|
3207
|
+
* @generated from message transcodely.v1.UpdateBudgetRequest
|
|
3208
|
+
*/
|
|
3209
|
+
declare class UpdateBudgetRequest extends Message<UpdateBudgetRequest> {
|
|
3210
|
+
/**
|
|
3211
|
+
* Monthly budget in EUR. When present, sets the budget (must be > 0). When
|
|
3212
|
+
* ABSENT, the budget is cleared and no further alerts are sent — that is the
|
|
3213
|
+
* only way to turn them off. The upper bound matches the NUMERIC(12,2)
|
|
3214
|
+
* storage column.
|
|
3215
|
+
*
|
|
3216
|
+
* @generated from field: optional double amount_eur = 1;
|
|
3217
|
+
*/
|
|
3218
|
+
amountEur?: number;
|
|
3219
|
+
constructor(data?: PartialMessage<UpdateBudgetRequest>);
|
|
3220
|
+
static readonly runtime: typeof proto3;
|
|
3221
|
+
static readonly typeName = "transcodely.v1.UpdateBudgetRequest";
|
|
3222
|
+
static readonly fields: FieldList;
|
|
3223
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): UpdateBudgetRequest;
|
|
3224
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): UpdateBudgetRequest;
|
|
3225
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): UpdateBudgetRequest;
|
|
3226
|
+
static equals(a: UpdateBudgetRequest | PlainMessage<UpdateBudgetRequest> | undefined, b: UpdateBudgetRequest | PlainMessage<UpdateBudgetRequest> | undefined): boolean;
|
|
3227
|
+
}
|
|
3228
|
+
/**
|
|
3229
|
+
* Response from setting or clearing a budget.
|
|
3230
|
+
*
|
|
3231
|
+
* @generated from message transcodely.v1.UpdateBudgetResponse
|
|
3232
|
+
*/
|
|
3233
|
+
declare class UpdateBudgetResponse extends Message<UpdateBudgetResponse> {
|
|
3234
|
+
/**
|
|
3235
|
+
* The budget as it now stands, with current-period spend recomputed, so a
|
|
3236
|
+
* caller that just moved the number can render the new bar without a second
|
|
3237
|
+
* request. amount_eur is absent when the budget was cleared.
|
|
3238
|
+
*
|
|
3239
|
+
* @generated from field: transcodely.v1.Budget budget = 1;
|
|
3240
|
+
*/
|
|
3241
|
+
budget?: Budget;
|
|
3242
|
+
constructor(data?: PartialMessage<UpdateBudgetResponse>);
|
|
3243
|
+
static readonly runtime: typeof proto3;
|
|
3244
|
+
static readonly typeName = "transcodely.v1.UpdateBudgetResponse";
|
|
3245
|
+
static readonly fields: FieldList;
|
|
3246
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): UpdateBudgetResponse;
|
|
3247
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): UpdateBudgetResponse;
|
|
3248
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): UpdateBudgetResponse;
|
|
3249
|
+
static equals(a: UpdateBudgetResponse | PlainMessage<UpdateBudgetResponse> | undefined, b: UpdateBudgetResponse | PlainMessage<UpdateBudgetResponse> | undefined): boolean;
|
|
3250
|
+
}
|
|
3251
|
+
/**
|
|
3252
|
+
* Request to read the organization's outstanding balance. The organization is
|
|
3253
|
+
* taken from the X-Organization-ID header.
|
|
3254
|
+
*
|
|
3255
|
+
* @generated from message transcodely.v1.GetOutstandingBalanceRequest
|
|
3256
|
+
*/
|
|
3257
|
+
declare class GetOutstandingBalanceRequest extends Message<GetOutstandingBalanceRequest> {
|
|
3258
|
+
constructor(data?: PartialMessage<GetOutstandingBalanceRequest>);
|
|
3259
|
+
static readonly runtime: typeof proto3;
|
|
3260
|
+
static readonly typeName = "transcodely.v1.GetOutstandingBalanceRequest";
|
|
3261
|
+
static readonly fields: FieldList;
|
|
3262
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): GetOutstandingBalanceRequest;
|
|
3263
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): GetOutstandingBalanceRequest;
|
|
3264
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): GetOutstandingBalanceRequest;
|
|
3265
|
+
static equals(a: GetOutstandingBalanceRequest | PlainMessage<GetOutstandingBalanceRequest> | undefined, b: GetOutstandingBalanceRequest | PlainMessage<GetOutstandingBalanceRequest> | undefined): boolean;
|
|
3266
|
+
}
|
|
3267
|
+
/**
|
|
3268
|
+
* Response carrying the outstanding balance and its threshold.
|
|
3269
|
+
*
|
|
3270
|
+
* @generated from message transcodely.v1.GetOutstandingBalanceResponse
|
|
3271
|
+
*/
|
|
3272
|
+
declare class GetOutstandingBalanceResponse extends Message<GetOutstandingBalanceResponse> {
|
|
3273
|
+
/**
|
|
3274
|
+
* Always present. An organization that owes nothing gets one with
|
|
3275
|
+
* outstanding_cents 0 and its threshold still populated, so a card can show
|
|
3276
|
+
* the headroom before anything has been spent.
|
|
3277
|
+
*
|
|
3278
|
+
* @generated from field: transcodely.v1.OutstandingBalance balance = 1;
|
|
3279
|
+
*/
|
|
3280
|
+
balance?: OutstandingBalance;
|
|
3281
|
+
constructor(data?: PartialMessage<GetOutstandingBalanceResponse>);
|
|
3282
|
+
static readonly runtime: typeof proto3;
|
|
3283
|
+
static readonly typeName = "transcodely.v1.GetOutstandingBalanceResponse";
|
|
3284
|
+
static readonly fields: FieldList;
|
|
3285
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): GetOutstandingBalanceResponse;
|
|
3286
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): GetOutstandingBalanceResponse;
|
|
3287
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): GetOutstandingBalanceResponse;
|
|
3288
|
+
static equals(a: GetOutstandingBalanceResponse | PlainMessage<GetOutstandingBalanceResponse> | undefined, b: GetOutstandingBalanceResponse | PlainMessage<GetOutstandingBalanceResponse> | undefined): boolean;
|
|
3289
|
+
}
|
|
3290
|
+
/**
|
|
3291
|
+
* Request to settle the outstanding balance now. The organization is taken from
|
|
3292
|
+
* the X-Organization-ID header.
|
|
3293
|
+
*
|
|
3294
|
+
* It carries no amount ON PURPOSE. The figure is whatever the ledger says at the
|
|
3295
|
+
* instant the settlement runs, and letting a caller name its own number would
|
|
3296
|
+
* let a stale page pay less than is owed and leave the difference looking
|
|
3297
|
+
* settled.
|
|
3298
|
+
*
|
|
3299
|
+
* @generated from message transcodely.v1.SettleOutstandingBalanceRequest
|
|
3300
|
+
*/
|
|
3301
|
+
declare class SettleOutstandingBalanceRequest extends Message<SettleOutstandingBalanceRequest> {
|
|
3302
|
+
constructor(data?: PartialMessage<SettleOutstandingBalanceRequest>);
|
|
3303
|
+
static readonly runtime: typeof proto3;
|
|
3304
|
+
static readonly typeName = "transcodely.v1.SettleOutstandingBalanceRequest";
|
|
3305
|
+
static readonly fields: FieldList;
|
|
3306
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): SettleOutstandingBalanceRequest;
|
|
3307
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): SettleOutstandingBalanceRequest;
|
|
3308
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): SettleOutstandingBalanceRequest;
|
|
3309
|
+
static equals(a: SettleOutstandingBalanceRequest | PlainMessage<SettleOutstandingBalanceRequest> | undefined, b: SettleOutstandingBalanceRequest | PlainMessage<SettleOutstandingBalanceRequest> | undefined): boolean;
|
|
3310
|
+
}
|
|
3311
|
+
/**
|
|
3312
|
+
* Response from settling an outstanding balance.
|
|
3313
|
+
*
|
|
3314
|
+
* @generated from message transcodely.v1.SettleOutstandingBalanceResponse
|
|
3315
|
+
*/
|
|
3316
|
+
declare class SettleOutstandingBalanceResponse extends Message<SettleOutstandingBalanceResponse> {
|
|
3317
|
+
/**
|
|
3318
|
+
* The statement that was produced.
|
|
3319
|
+
*
|
|
3320
|
+
* @generated from field: transcodely.v1.Settlement settlement = 1;
|
|
3321
|
+
*/
|
|
3322
|
+
settlement?: Settlement;
|
|
3323
|
+
/**
|
|
3324
|
+
* The balance as it now stands — zero, with the block lifted and the steps
|
|
3325
|
+
* re-armed — so a caller that just paid can render the new state without a
|
|
3326
|
+
* second request.
|
|
3327
|
+
*
|
|
3328
|
+
* @generated from field: transcodely.v1.OutstandingBalance balance = 2;
|
|
3329
|
+
*/
|
|
3330
|
+
balance?: OutstandingBalance;
|
|
3331
|
+
constructor(data?: PartialMessage<SettleOutstandingBalanceResponse>);
|
|
3332
|
+
static readonly runtime: typeof proto3;
|
|
3333
|
+
static readonly typeName = "transcodely.v1.SettleOutstandingBalanceResponse";
|
|
3334
|
+
static readonly fields: FieldList;
|
|
3335
|
+
static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): SettleOutstandingBalanceResponse;
|
|
3336
|
+
static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): SettleOutstandingBalanceResponse;
|
|
3337
|
+
static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): SettleOutstandingBalanceResponse;
|
|
3338
|
+
static equals(a: SettleOutstandingBalanceResponse | PlainMessage<SettleOutstandingBalanceResponse> | undefined, b: SettleOutstandingBalanceResponse | PlainMessage<SettleOutstandingBalanceResponse> | undefined): boolean;
|
|
3339
|
+
}
|
|
2500
3340
|
|
|
2501
3341
|
/**
|
|
2502
|
-
* An organization's
|
|
3342
|
+
* An organization's money: statements, budget, and outstanding balance.
|
|
2503
3343
|
*
|
|
2504
3344
|
* Unlike every other namespace, billing settles a whole organization rather
|
|
2505
3345
|
* than a single app, so it is **not** available to API-key callers: a key is
|
|
@@ -2518,7 +3358,10 @@ declare class CreateBillingPortalSessionResponse extends Message<CreateBillingPo
|
|
|
2518
3358
|
* ```
|
|
2519
3359
|
*
|
|
2520
3360
|
* Invoices are generated automatically when a period closes. There is no API to
|
|
2521
|
-
* create, edit, or delete one — a statement records what happened.
|
|
3361
|
+
* create, edit, or delete one — a statement records what happened. The two
|
|
3362
|
+
* writes here do not contradict that: {@link updateBudget} moves the customer's
|
|
3363
|
+
* own alert threshold, and {@link settleOutstandingBalance} closes the period
|
|
3364
|
+
* early rather than editing anything already recorded.
|
|
2522
3365
|
*/
|
|
2523
3366
|
declare class Billing {
|
|
2524
3367
|
private readonly transport;
|
|
@@ -2570,6 +3413,78 @@ declare class Billing {
|
|
|
2570
3413
|
* than storing the URL.
|
|
2571
3414
|
*/
|
|
2572
3415
|
createPortalSession(opts?: CallOptions): Promise<BillingPortalSession>;
|
|
3416
|
+
/**
|
|
3417
|
+
* Retrieve the organization's monthly budget together with the spend it is
|
|
3418
|
+
* measured against — everything a budget card needs, in one call.
|
|
3419
|
+
*
|
|
3420
|
+
* A budget only ever **notifies**: crossing 100% sends an email and changes
|
|
3421
|
+
* nothing else. The hard cap is the per-app spend limit
|
|
3422
|
+
* (`client.apps.setSpendLimit`), which rejects new jobs at 100%.
|
|
3423
|
+
*
|
|
3424
|
+
* Always returns a budget. An organization with none set gets one with
|
|
3425
|
+
* `amountEur` and `usedPercent` absent and `spentEur` still populated, so the
|
|
3426
|
+
* current period's spend renders before a budget exists.
|
|
3427
|
+
*/
|
|
3428
|
+
retrieveBudget(opts?: CallOptions): Promise<Budget>;
|
|
3429
|
+
/**
|
|
3430
|
+
* Set or clear the organization's monthly budget. Provide `amountEur` (must
|
|
3431
|
+
* be > 0) to set it; omit it to clear the budget and stop the alert emails.
|
|
3432
|
+
* {@link setBudget} and {@link clearBudget} are the ergonomic shorthands.
|
|
3433
|
+
*
|
|
3434
|
+
* The returned budget has current-period spend recomputed, so a caller that
|
|
3435
|
+
* just moved the number can re-render without a second request.
|
|
3436
|
+
*/
|
|
3437
|
+
updateBudget(req?: PartialMessage<UpdateBudgetRequest>, opts?: CallOptions): Promise<Budget>;
|
|
3438
|
+
/**
|
|
3439
|
+
* Set the organization's monthly budget in EUR (must be > 0).
|
|
3440
|
+
*
|
|
3441
|
+
* Alert emails fire once per billing period at each of `budget.alertSteps`
|
|
3442
|
+
* (50%, 80%, 100% today). Raising or lowering the amount mid-period never
|
|
3443
|
+
* re-arms a step already listed in `budget.notifiedSteps`.
|
|
3444
|
+
*/
|
|
3445
|
+
setBudget(amountEur: number, opts?: CallOptions): Promise<Budget>;
|
|
3446
|
+
/**
|
|
3447
|
+
* Clear the organization's monthly budget, turning the alert emails off —
|
|
3448
|
+
* omitting the optional amount is the only way to switch them off.
|
|
3449
|
+
*/
|
|
3450
|
+
clearBudget(opts?: CallOptions): Promise<Budget>;
|
|
3451
|
+
/**
|
|
3452
|
+
* Retrieve the organization's outstanding balance — usage accrued but not yet
|
|
3453
|
+
* captured onto a statement — together with the threshold it is measured
|
|
3454
|
+
* against.
|
|
3455
|
+
*
|
|
3456
|
+
* Distinct from {@link retrieveUpcoming}, which reports what the **current
|
|
3457
|
+
* period** has accrued: this is what is **unsettled**, so it also carries
|
|
3458
|
+
* anything an earlier period left uncaptured, and it is the number that
|
|
3459
|
+
* decides whether new jobs are admitted.
|
|
3460
|
+
*
|
|
3461
|
+
* Nothing is restricted as it climbs — reminder emails go out at 80%, 100%,
|
|
3462
|
+
* 125%, 150% and 175% and service continues past the threshold on purpose.
|
|
3463
|
+
* Only at `hardStopCents` (twice the threshold) are new jobs refused, with
|
|
3464
|
+
* error code `outstanding_balance_exceeded`; queued and running work still
|
|
3465
|
+
* finishes and playback keeps serving. Branch on `blocked`, which reads the
|
|
3466
|
+
* same numbers the admission gate reads.
|
|
3467
|
+
*/
|
|
3468
|
+
retrieveOutstandingBalance(opts?: CallOptions): Promise<OutstandingBalance>;
|
|
3469
|
+
/**
|
|
3470
|
+
* Pay the outstanding balance now, without waiting for the period to end.
|
|
3471
|
+
*
|
|
3472
|
+
* Closes the current period at this instant and produces a real statement —
|
|
3473
|
+
* an ordinary invoice, readable through {@link retrieve} — which the payment
|
|
3474
|
+
* provider then charges. On success the balance is zero and any admission
|
|
3475
|
+
* block is lifted immediately; the response carries the refreshed balance too,
|
|
3476
|
+
* so no follow-up read is needed.
|
|
3477
|
+
*
|
|
3478
|
+
* Takes no amount on purpose: the figure is whatever the ledger says at the
|
|
3479
|
+
* instant it runs, so a stale page cannot underpay and leave the difference
|
|
3480
|
+
* looking settled.
|
|
3481
|
+
*
|
|
3482
|
+
* Throws {@link PreconditionError} with code `settlement_unavailable` when the
|
|
3483
|
+
* deployment has mid-cycle settlement switched off — check
|
|
3484
|
+
* `balance.settlementAvailable` before offering a "pay now" action — and with
|
|
3485
|
+
* `nothing_outstanding` when there is nothing to pay.
|
|
3486
|
+
*/
|
|
3487
|
+
settleOutstandingBalance(opts?: CallOptions): Promise<SettleOutstandingBalanceResponse>;
|
|
2573
3488
|
}
|
|
2574
3489
|
|
|
2575
3490
|
/**
|
|
@@ -4688,6 +5603,11 @@ declare class StreamingConfig extends Message<StreamingConfig> {
|
|
|
4688
5603
|
* Example: "video_{resolution}" produces "video_1080p.m3u8"
|
|
4689
5604
|
* Default: "{codec}_{resolution}" produces "h264_1080p.m3u8"
|
|
4690
5605
|
*
|
|
5606
|
+
* The rendered value becomes a filename and is also carried through the
|
|
5607
|
+
* packager's stream descriptors, so the accepted charset is deliberately
|
|
5608
|
+
* narrow: letters, digits, `_`, `-`, `.` and the `{}` that delimit template
|
|
5609
|
+
* variables. No path separators, no `..`, and none of `, : ; ' " \`.
|
|
5610
|
+
*
|
|
4691
5611
|
* @generated from field: optional string hls_variant_pattern = 12;
|
|
4692
5612
|
*/
|
|
4693
5613
|
hlsVariantPattern?: string;
|
|
@@ -4779,6 +5699,12 @@ declare class BurnInStyle extends Message<BurnInStyle> {
|
|
|
4779
5699
|
/**
|
|
4780
5700
|
* Font family name. Default: "Arial".
|
|
4781
5701
|
*
|
|
5702
|
+
* Letters, digits, spaces, `_` and `-` only. The value is embedded in the
|
|
5703
|
+
* renderer's style string, where a quote, comma or semicolon would terminate
|
|
5704
|
+
* it and let whatever follows parse as further styling arguments.
|
|
5705
|
+
*
|
|
5706
|
+
* Example: "DejaVu Sans"
|
|
5707
|
+
*
|
|
4782
5708
|
* @generated from field: optional string font_family = 1;
|
|
4783
5709
|
*/
|
|
4784
5710
|
fontFamily?: string;
|
|
@@ -7651,6 +8577,11 @@ declare class HLSConfig extends Message<HLSConfig> {
|
|
|
7651
8577
|
* Variables: {codec}, {resolution}, {bitrate}, {index}
|
|
7652
8578
|
* Default: "{codec}_{resolution}"
|
|
7653
8579
|
*
|
|
8580
|
+
* The rendered value becomes a filename and is also carried through the
|
|
8581
|
+
* packager's stream descriptors, so the accepted charset is deliberately
|
|
8582
|
+
* narrow: letters, digits, `_`, `-`, `.` and the `{}` that delimit template
|
|
8583
|
+
* variables. No path separators, no `..`, and none of `, : ; ' " \`.
|
|
8584
|
+
*
|
|
7654
8585
|
* @generated from field: optional string variant_pattern = 4;
|
|
7655
8586
|
*/
|
|
7656
8587
|
variantPattern?: string;
|
|
@@ -9846,6 +10777,18 @@ declare class Video extends Message<Video> {
|
|
|
9846
10777
|
*/
|
|
9847
10778
|
outputSizeBytes: bigint;
|
|
9848
10779
|
/**
|
|
10780
|
+
* Total billed by the transcode job that produced this video, in EUR.
|
|
10781
|
+
*
|
|
10782
|
+
* Despite the name this is the job's WHOLE total, not encoding alone: a
|
|
10783
|
+
* job's total already includes every fee billed on it, so for a video
|
|
10784
|
+
* captioned inline (the auto_captions upload flag) the captions fee is part
|
|
10785
|
+
* of this number, as is the flat per-job processing fee. Absent until the
|
|
10786
|
+
* job settles.
|
|
10787
|
+
*
|
|
10788
|
+
* Prefer total_cost. This field covers one job, so it misses the cost of
|
|
10789
|
+
* later jobs run against the video, and adding captions_cost to it
|
|
10790
|
+
* double-counts inline captions.
|
|
10791
|
+
*
|
|
9849
10792
|
* @generated from field: optional double encoding_cost = 31;
|
|
9850
10793
|
*/
|
|
9851
10794
|
encodingCost?: number;
|
|
@@ -9857,11 +10800,35 @@ declare class Video extends Message<Video> {
|
|
|
9857
10800
|
* confirmed only when a caption artifact is actually delivered, so voided
|
|
9858
10801
|
* and still-estimated fees are never counted. This is a per-feature
|
|
9859
10802
|
* breakdown of already-billed job totals, not an extra charge on top of
|
|
9860
|
-
* them.
|
|
10803
|
+
* them: it is contained in total_cost, never added to it.
|
|
9861
10804
|
*
|
|
9862
10805
|
* @generated from field: optional double captions_cost = 50;
|
|
9863
10806
|
*/
|
|
9864
10807
|
captionsCost?: number;
|
|
10808
|
+
/**
|
|
10809
|
+
* Everything this video has cost, in EUR: the sum of the settled totals of
|
|
10810
|
+
* every job billed for it — the transcode that produced it plus any later
|
|
10811
|
+
* job that took it as input (retro captions, for example).
|
|
10812
|
+
*
|
|
10813
|
+
* This is the authoritative per-video figure and the one to display. It is
|
|
10814
|
+
* built from the same job totals the billing ledger is written from, so it
|
|
10815
|
+
* reconciles with the invoice; captions_cost is a breakdown inside it.
|
|
10816
|
+
* Absent while no linked job has settled yet.
|
|
10817
|
+
*
|
|
10818
|
+
* @generated from field: optional double total_cost = 52;
|
|
10819
|
+
*/
|
|
10820
|
+
totalCost?: number;
|
|
10821
|
+
/**
|
|
10822
|
+
* Why this video failed, in one sentence a customer can act on. Present only
|
|
10823
|
+
* when status is "error"; absent for every other status.
|
|
10824
|
+
*
|
|
10825
|
+
* This is curated copy, never raw failure text — it will not contain
|
|
10826
|
+
* encoder output, storage-provider responses, or internal identifiers. When
|
|
10827
|
+
* the video has a linked job, that job's error_message says the same thing.
|
|
10828
|
+
*
|
|
10829
|
+
* @generated from field: optional string error_message = 51;
|
|
10830
|
+
*/
|
|
10831
|
+
errorMessage?: string;
|
|
9865
10832
|
/**
|
|
9866
10833
|
* Timestamps.
|
|
9867
10834
|
*
|
|
@@ -12204,10 +13171,14 @@ declare class Organization extends Message<Organization> {
|
|
|
12204
13171
|
*/
|
|
12205
13172
|
planName?: string;
|
|
12206
13173
|
/**
|
|
12207
|
-
* Whether this org must have a payment method on file.
|
|
12208
|
-
*
|
|
12209
|
-
*
|
|
12210
|
-
*
|
|
13174
|
+
* Whether this org must have a payment method on file. ENFORCED: with no
|
|
13175
|
+
* usable payment method a required org derives a restricting
|
|
13176
|
+
* billing_standing, and its jobs resolve to the free tier's limits rather
|
|
13177
|
+
* than to its plan.
|
|
13178
|
+
*
|
|
13179
|
+
* Organizations created before the enforcement release carry false and are
|
|
13180
|
+
* the grandfathered population — unaffected until an operator turns it on.
|
|
13181
|
+
* A comped org (billing_exempt) is off the hook whatever this says.
|
|
12211
13182
|
*
|
|
12212
13183
|
* @generated from field: bool payment_method_required = 11;
|
|
12213
13184
|
*/
|
|
@@ -12226,19 +13197,24 @@ declare class Organization extends Message<Organization> {
|
|
|
12226
13197
|
* Derived payment health. Always BILLING_STANDING_ACTIVE when
|
|
12227
13198
|
* payment_method_required is false, whatever the facts below say.
|
|
12228
13199
|
*
|
|
13200
|
+
* Filled on admin reads, and on OrganizationService.Get for a member of the
|
|
13201
|
+
* org (JWT/portal actors). Absent on the API-key read path, which gets a
|
|
13202
|
+
* refusal code on the create instead, and on List.
|
|
13203
|
+
*
|
|
12229
13204
|
* @generated from field: transcodely.v1.BillingStanding billing_standing = 13;
|
|
12230
13205
|
*/
|
|
12231
13206
|
billingStanding: BillingStanding;
|
|
12232
13207
|
/**
|
|
12233
13208
|
* When the current grace window closes, present only while billing_standing
|
|
12234
|
-
* is BILLING_STANDING_GRACE.
|
|
13209
|
+
* is BILLING_STANDING_GRACE. Filled wherever billing_standing is.
|
|
12235
13210
|
*
|
|
12236
13211
|
* @generated from field: optional google.protobuf.Timestamp grace_until = 14;
|
|
12237
13212
|
*/
|
|
12238
13213
|
graceUntil?: Timestamp;
|
|
12239
13214
|
/**
|
|
12240
13215
|
* Stable token explaining billing_standing; same vocabulary as
|
|
12241
|
-
* BillingProfile.standing_reason.
|
|
13216
|
+
* BillingProfile.standing_reason. ADMIN reads only — tokens like
|
|
13217
|
+
* card_expired are payment-method detail, which a plain member never sees.
|
|
12242
13218
|
*
|
|
12243
13219
|
* @generated from field: string standing_reason = 15;
|
|
12244
13220
|
*/
|
|
@@ -12262,6 +13238,20 @@ declare class Organization extends Message<Organization> {
|
|
|
12262
13238
|
* @generated from field: int32 consecutive_dunned_cycles = 17;
|
|
12263
13239
|
*/
|
|
12264
13240
|
consecutiveDunnedCycles: number;
|
|
13241
|
+
/**
|
|
13242
|
+
* How automation may treat this organization — see BillingTreatment.
|
|
13243
|
+
*
|
|
13244
|
+
* ADMIN reads only, like standing_reason above: it is a statement about a
|
|
13245
|
+
* commercial relationship, and a customer does not learn from an API field
|
|
13246
|
+
* that we have decided never to interrupt them.
|
|
13247
|
+
*
|
|
13248
|
+
* Orthogonal to billing_standing. A trusted org can report
|
|
13249
|
+
* BILLING_STANDING_DELINQUENT and still be untouched by every automated
|
|
13250
|
+
* path — the founder gets an email instead.
|
|
13251
|
+
*
|
|
13252
|
+
* @generated from field: transcodely.v1.BillingTreatment billing_treatment = 18;
|
|
13253
|
+
*/
|
|
13254
|
+
billingTreatment: BillingTreatment;
|
|
12265
13255
|
constructor(data?: PartialMessage<Organization>);
|
|
12266
13256
|
static readonly runtime: typeof proto3;
|
|
12267
13257
|
static readonly typeName = "transcodely.v1.Organization";
|
|
@@ -13549,9 +14539,10 @@ declare enum UserStatus {
|
|
|
13549
14539
|
DELETED = 3
|
|
13550
14540
|
}
|
|
13551
14541
|
/**
|
|
13552
|
-
*
|
|
13553
|
-
*
|
|
13554
|
-
*
|
|
14542
|
+
* Dashboard access review status. New sign-ups are approved automatically
|
|
14543
|
+
* unless the platform is operating in manual-review mode, in which case they
|
|
14544
|
+
* stay PENDING until a staff member approves them. Staff can reject a user at
|
|
14545
|
+
* any time to revoke dashboard access.
|
|
13555
14546
|
*
|
|
13556
14547
|
* @generated from enum transcodely.v1.UserApprovalStatus
|
|
13557
14548
|
*/
|
|
@@ -13641,8 +14632,7 @@ declare class User extends Message<User> {
|
|
|
13641
14632
|
*/
|
|
13642
14633
|
updatedAt?: Timestamp;
|
|
13643
14634
|
/**
|
|
13644
|
-
* Whether this user
|
|
13645
|
-
* New sign-ups default to PENDING.
|
|
14635
|
+
* Whether this user may use the dashboard.
|
|
13646
14636
|
*
|
|
13647
14637
|
* @generated from field: transcodely.v1.UserApprovalStatus approval_status = 11;
|
|
13648
14638
|
*/
|
|
@@ -13654,7 +14644,8 @@ declare class User extends Message<User> {
|
|
|
13654
14644
|
*/
|
|
13655
14645
|
approvalDecidedAt?: Timestamp;
|
|
13656
14646
|
/**
|
|
13657
|
-
* The staff member's user_id who decided approval.
|
|
14647
|
+
* The staff member's user_id who decided approval. Absent when the user was
|
|
14648
|
+
* approved automatically rather than by a person.
|
|
13658
14649
|
*
|
|
13659
14650
|
* @generated from field: optional string approval_decided_by_user_id = 13;
|
|
13660
14651
|
*/
|
|
@@ -14116,7 +15107,7 @@ declare class Transcodely {
|
|
|
14116
15107
|
}
|
|
14117
15108
|
|
|
14118
15109
|
/** SDK version. Bumped by release-please from package.json on each tag. */
|
|
14119
|
-
declare const SDK_VERSION = "0.3.
|
|
15110
|
+
declare const SDK_VERSION = "0.3.7";
|
|
14120
15111
|
/**
|
|
14121
15112
|
* API version this SDK release is pinned to. Sent on every request as
|
|
14122
15113
|
* `Transcodely-Version`. Customers can override per-client via the
|
|
@@ -14126,4 +15117,4 @@ declare const API_VERSION = "2026-05-03";
|
|
|
14126
15117
|
/** Default base URL for the production Transcodely API. */
|
|
14127
15118
|
declare const DEFAULT_BASE_URL = "https://api.transcodely.com";
|
|
14128
15119
|
|
|
14129
|
-
export { APIConnectionError, APIError, Event as APIEvent, APIKey, API_VERSION, AV1Options, AbortMultipartUploadRequest, App, AppStatus, ArchiveAppRequest, ArchiveOriginRequest, ArchivePresetRequest, AudioCodec, AudioSettings, AudioStreamInfo, AudioTrackConfig, AuthenticationError, AutoABRConfig, AutoProfileDefaults, BYOKConfig, BillingPaymentMethod, BillingPortalSession, BillingProfile, BillingStanding, BitrateMode, BurnInStyle, type CallOptions, CancelJobRequest, CancelJobResponse, ChapterPoint, ChapterResult, CheckSlugRequest, CheckSlugResponse, ClipConfig, CompleteMultipartUploadRequest, CompleteMultipartUploadResponse, CompleteUploadRequest, CompleteUploadResponse, CompletedPart, ConfirmJobRequest, ConfirmJobResponse, ConflictError, Container, ContentAnalysis, ContentAwareConfig, ContentAwareMode, ContentType, CreateAPIKeyRequest, CreateAPIKeyResponse, CreateAppRequest, CreateAppResponse, CreateBillingPortalSessionRequest, CreateBillingPortalSessionResponse, CreateFromUrlRequest, CreateFromUrlResponse, CreateJobRequest, CreateJobResponse, CreateMultipartUploadRequest, CreateMultipartUploadResponse, CreateOrganizationRequest, CreateOrganizationResponse, CreateOriginRequest, CreateOriginResponse, CreatePresetRequest, CreatePresetResponse, CreateUploadRequest, CreateUploadResponse, CreateWebhookEndpointRequest, CreateWebhookEndpointResponse, DASHConfig, DEFAULT_BASE_URL, DEFAULT_TOLERANCE_SECONDS, DRMConfig, DRMSystem, DailyUsage, DeleteVideoRequest, DeleteWebhookEndpointRequest, DeleteWebhookEndpointResponse, DeliveryFormat, DuplicatePresetRequest, DuplicatePresetResponse, EVENT_ID_HEADER, EnableHostingRequest, EnableHostingResponse, EncryptionScheme, EndpointHealthSummary, ErrorDetails, type EventBase, ExecutionTiming, type FieldViolation, GOPAlignmentMode, GcsCredentials, GcsOriginConfig, GetAPIKeyRequest, GetAPIKeyResponse, GetAppRequest, GetAppResponse, GetBillingProfileRequest, GetBillingProfileResponse, GetEndpointHealthRequest, GetEndpointHealthResponse, GetInvoiceRequest, GetInvoiceResponse, GetJobRequest, GetJobResponse, GetMeRequest, GetMeResponse, GetMembershipRequest, GetMembershipResponse, GetOrganizationRequest, GetOrganizationResponse, GetOriginRequest, GetOriginResponse, GetPresetBySlugRequest, GetPresetBySlugResponse, GetPresetRequest, GetPresetResponse, GetSpendRequest, GetSpendResponse, GetStatsRequest, GetStatsResponse, GetUpcomingInvoiceRequest, GetUpcomingInvoiceResponse, GetUploadPartUrlsRequest, GetUploadPartUrlsResponse, GetUsageRequest, GetUsageResponse, GetUserRequest, GetUserResponse, GetVideoRequest, GetVideoResponse, H264Options, H265Options, HDRConfig, HDRFormat, HDRMode, HLSConfig, HLSPlaylistType, HLSSegmentFormat, HealthBucket, HostingConfig, HttpCredentials, HttpOriginConfig, InputMetadata, InvalidRequestError, Invoice, InvoiceLineItem, InvoiceLineType, InvoiceStatus, Job, JobCostBreakdown, JobCostLine, JobCostLineType, JobFee, JobOutput, JobPriority, JobStatus, KeyServerConfig, type KnownWebhookEvent, ListAPIKeysRequest, ListAPIKeysResponse, ListAppsRequest, ListAppsResponse, ListEventsRequest, ListEventsResponse, ListInvoicesRequest, ListInvoicesResponse, ListJobsRequest, ListJobsResponse, ListMembershipsRequest, ListMembershipsResponse, ListOrganizationsRequest, ListOrganizationsResponse, ListOriginsRequest, ListOriginsResponse, ListPresetsRequest, ListPresetsResponse, ListTopVideosRequest, ListTopVideosResponse, ListUsersRequest, ListUsersResponse, ListVideosRequest, ListVideosResponse, ListWebhookDeliveriesRequest, ListWebhookDeliveriesResponse, ListWebhookEndpointsRequest, ListWebhookEndpointsResponse, type LogEvent, Membership, MembershipRole, MembershipStatus, MembershipWithUser, NotFoundError, Organization, OrganizationStatus, Origin, OriginPermission, OriginProvider, OriginRef, OriginStatus, OutputFormat, OutputSpec, OutputStatus, OutputVariantResult, Page, PaginationRequest, PaginationResponse, PaymentMethodState, PermissionError, PreconditionError, Preset, PresetVariant, PricingSnapshot, QualityTier, R2Jurisdiction, R2OriginConfig, RateLimitError, RemoveMembershipRequest, ResendEventRequest, ResendEventResponse, Resolution, RetrieveEventRequest, RetrieveEventResponse, RetrieveWebhookEndpointRequest, RetrieveWebhookEndpointResponse, RevokeAPIKeyRequest, RotateWebhookSecretRequest, RotateWebhookSecretResponse, S3Credentials, S3OriginConfig, SDK_VERSION, SIGNATURE_HEADER, SegmentConfig, SendTestWebhookRequest, SendTestWebhookResponse, type SpendLimitNotification, StreamingConfig, SubtitleFormat, SubtitleOperation, SubtitleResult, SubtitleStreamInfo, SubtitleTrack, ThumbnailFormat, ThumbnailMode, ThumbnailResult, ThumbnailSpec, ToneMapping, TopVideo, Transcodely, type TranscodelyConfig, TranscodelyError, type UnknownWebhookEvent, UpdateAppRequest, UpdateAppResponse, UpdateHostingConfigRequest, UpdateHostingConfigResponse, UpdateMeRequest, UpdateMeResponse, UpdateMembershipRoleRequest, UpdateMembershipRoleResponse, UpdateOrganizationRequest, UpdateOrganizationResponse, UpdateOriginRequest, UpdateOriginResponse, UpdatePresetRequest, UpdatePresetResponse, UpdateSpendLimitRequest, UpdateSpendLimitResponse, UpdateVideoRequest, UpdateVideoResponse, UpdateWebhookEndpointRequest, UpdateWebhookEndpointResponse, UploadPart, UsageSummary, User, UserApprovalStatus, UserOrganization, UserStatus, UserWithOrganizations, VP9Options, ValidateOriginRequest, ValidateOriginResponse, ValidationResult, VariantPricingSnapshot, type VerifyOptions, Video, VideoCodec, VideoRendition, VideoSettings, VideoStatsDay, VideoStatsTotals, VideoStatus, VideoStreamInfo, VideoTextTrack, VideoVariant, VideoVisibility, WEBHOOK_EVENT_TYPES, WatchEventType, WatchJobRequest, WatchJobResponse, WatchVideoRequest, WatchVideoResponse, WatermarkAnchor, WatermarkConfig, WatermarkPixelPlacement, WebhookDelivery, WebhookEndpoint, WebhookError, type WebhookEvent, type WebhookEventType, WebhookPayloadError, WebhookSignatureError, WebhookTimestampError, Webhooks, constructEvent, isEventType, isKnownEvent, verifySignature };
|
|
15120
|
+
export { APIConnectionError, APIError, Event as APIEvent, APIKey, API_VERSION, AV1Options, AbortMultipartUploadRequest, App, AppStatus, ArchiveAppRequest, ArchiveOriginRequest, ArchivePresetRequest, AudioCodec, AudioSettings, AudioStreamInfo, AudioTrackConfig, AuthenticationError, AutoABRConfig, AutoProfileDefaults, BYOKConfig, BillingPaymentMethod, BillingPortalSession, BillingProfile, BillingStanding, BillingTreatment, BitrateMode, Budget, BurnInStyle, type CallOptions, CancelJobRequest, CancelJobResponse, CaptionStyle, ChapterPoint, ChapterResult, CheckSlugRequest, CheckSlugResponse, ClipConfig, CompleteMultipartUploadRequest, CompleteMultipartUploadResponse, CompleteUploadRequest, CompleteUploadResponse, CompletedPart, ConfirmJobRequest, ConfirmJobResponse, ConflictError, Container, ContentAnalysis, ContentAwareConfig, ContentAwareMode, ContentType, CreateAPIKeyRequest, CreateAPIKeyResponse, CreateAppRequest, CreateAppResponse, CreateBillingPortalSessionRequest, CreateBillingPortalSessionResponse, CreateFromUrlRequest, CreateFromUrlResponse, CreateJobRequest, CreateJobResponse, CreateMultipartUploadRequest, CreateMultipartUploadResponse, CreateOrganizationRequest, CreateOrganizationResponse, CreateOriginRequest, CreateOriginResponse, CreatePresetRequest, CreatePresetResponse, CreateUploadRequest, CreateUploadResponse, CreateWebhookEndpointRequest, CreateWebhookEndpointResponse, DASHConfig, DEFAULT_BASE_URL, DEFAULT_TOLERANCE_SECONDS, DRMConfig, DRMSystem, DailyUsage, DeleteVideoRequest, DeleteWebhookEndpointRequest, DeleteWebhookEndpointResponse, DeliveryFormat, DunningStage, DuplicatePresetRequest, DuplicatePresetResponse, EVENT_ID_HEADER, EnableHostingRequest, EnableHostingResponse, EncryptionScheme, EndpointHealthSummary, ErrorDetails, type EventBase, ExecutionTiming, ExposureThresholdSource, type FieldViolation, GOPAlignmentMode, GcsCredentials, GcsOriginConfig, GetAPIKeyRequest, GetAPIKeyResponse, GetAppRequest, GetAppResponse, GetBillingProfileRequest, GetBillingProfileResponse, GetBudgetRequest, GetBudgetResponse, GetEndpointHealthRequest, GetEndpointHealthResponse, GetInvoiceRequest, GetInvoiceResponse, GetJobRequest, GetJobResponse, GetMeRequest, GetMeResponse, GetMembershipRequest, GetMembershipResponse, GetOrganizationRequest, GetOrganizationResponse, GetOriginRequest, GetOriginResponse, GetOutstandingBalanceRequest, GetOutstandingBalanceResponse, GetPresetBySlugRequest, GetPresetBySlugResponse, GetPresetRequest, GetPresetResponse, GetSpendRequest, GetSpendResponse, GetStatsRequest, GetStatsResponse, GetUpcomingInvoiceRequest, GetUpcomingInvoiceResponse, GetUploadPartUrlsRequest, GetUploadPartUrlsResponse, GetUsageRequest, GetUsageResponse, GetUserRequest, GetUserResponse, GetVideoRequest, GetVideoResponse, H264Options, H265Options, HDRConfig, HDRFormat, HDRMode, HLSConfig, HLSPlaylistType, HLSSegmentFormat, HealthBucket, HostingConfig, HttpCredentials, HttpOriginConfig, InputMetadata, InvalidRequestError, Invoice, InvoiceLineItem, InvoiceLineType, InvoiceStatus, Job, JobCostBreakdown, JobCostLine, JobCostLineType, JobFee, JobOutput, JobPriority, JobStatus, KeyServerConfig, type KnownWebhookEvent, ListAPIKeysRequest, ListAPIKeysResponse, ListAppsRequest, ListAppsResponse, ListEventsRequest, ListEventsResponse, ListInvoicesRequest, ListInvoicesResponse, ListJobsRequest, ListJobsResponse, ListMembershipsRequest, ListMembershipsResponse, ListOrganizationsRequest, ListOrganizationsResponse, ListOriginsRequest, ListOriginsResponse, ListPresetsRequest, ListPresetsResponse, ListTopVideosRequest, ListTopVideosResponse, ListUsersRequest, ListUsersResponse, ListVideosRequest, ListVideosResponse, ListWebhookDeliveriesRequest, ListWebhookDeliveriesResponse, ListWebhookEndpointsRequest, ListWebhookEndpointsResponse, type LogEvent, Membership, MembershipRole, MembershipStatus, MembershipWithUser, NotFoundError, Organization, OrganizationStatus, Origin, OriginPermission, OriginProvider, OriginRef, OriginStatus, OutputFormat, OutputSpec, OutputStatus, OutputVariantResult, OutstandingBalance, Page, PaginationRequest, PaginationResponse, PaymentMethodState, PermissionError, PlayerConfig, PreconditionError, Preset, PresetVariant, PricingSnapshot, QualityTier, R2Jurisdiction, R2OriginConfig, RateLimitError, RemoveMembershipRequest, ResendEventRequest, ResendEventResponse, Resolution, RetrieveEventRequest, RetrieveEventResponse, RetrieveWebhookEndpointRequest, RetrieveWebhookEndpointResponse, RevokeAPIKeyRequest, RotateWebhookSecretRequest, RotateWebhookSecretResponse, S3Credentials, S3OriginConfig, SDK_VERSION, SIGNATURE_HEADER, SegmentConfig, SendTestWebhookRequest, SendTestWebhookResponse, SettleOutstandingBalanceRequest, SettleOutstandingBalanceResponse, Settlement, type SpendLimitNotification, StreamingConfig, SubtitleFormat, SubtitleOperation, SubtitleResult, SubtitleStreamInfo, SubtitleTrack, ThumbnailFormat, ThumbnailMode, ThumbnailResult, ThumbnailSpec, ToneMapping, TopVideo, Transcodely, type TranscodelyConfig, TranscodelyError, TrustTier, type UnknownWebhookEvent, UpdateAppRequest, UpdateAppResponse, UpdateBudgetRequest, UpdateBudgetResponse, UpdateHostingConfigRequest, UpdateHostingConfigResponse, UpdateMeRequest, UpdateMeResponse, UpdateMembershipRoleRequest, UpdateMembershipRoleResponse, UpdateOrganizationRequest, UpdateOrganizationResponse, UpdateOriginRequest, UpdateOriginResponse, UpdatePlayerConfigRequest, UpdatePlayerConfigResponse, UpdatePresetRequest, UpdatePresetResponse, UpdateSpendLimitRequest, UpdateSpendLimitResponse, UpdateVideoRequest, UpdateVideoResponse, UpdateWebhookEndpointRequest, UpdateWebhookEndpointResponse, UploadPart, UsageSummary, User, UserApprovalStatus, UserOrganization, UserStatus, UserWithOrganizations, VP9Options, ValidateOriginRequest, ValidateOriginResponse, ValidationResult, VariantPricingSnapshot, type VerifyOptions, Video, VideoCodec, VideoRendition, VideoSettings, VideoStatsDay, VideoStatsTotals, VideoStatus, VideoStreamInfo, VideoTextTrack, VideoVariant, VideoVisibility, WEBHOOK_EVENT_TYPES, WatchEventType, WatchJobRequest, WatchJobResponse, WatchVideoRequest, WatchVideoResponse, WatermarkAnchor, WatermarkConfig, WatermarkPixelPlacement, WebhookDelivery, WebhookEndpoint, WebhookError, type WebhookEvent, type WebhookEventType, WebhookPayloadError, WebhookSignatureError, WebhookTimestampError, Webhooks, constructEvent, isEventType, isKnownEvent, verifySignature };
|