@axivoy/api 1.34.0 → 1.36.0
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/dist/generated/schema.d.ts +1716 -240
- package/package.json +1 -1
|
@@ -17163,6 +17163,226 @@ export interface paths {
|
|
|
17163
17163
|
patch?: never;
|
|
17164
17164
|
trace?: never;
|
|
17165
17165
|
};
|
|
17166
|
+
"/ops/voice.account.provision": {
|
|
17167
|
+
parameters: {
|
|
17168
|
+
query?: never;
|
|
17169
|
+
header?: never;
|
|
17170
|
+
path?: never;
|
|
17171
|
+
cookie?: never;
|
|
17172
|
+
};
|
|
17173
|
+
get?: never;
|
|
17174
|
+
put?: never;
|
|
17175
|
+
/**
|
|
17176
|
+
* Set up calling
|
|
17177
|
+
* @description Sets up the company's calling account in the background, or resumes a setup that did not finish. Does nothing once calling is set up.
|
|
17178
|
+
*
|
|
17179
|
+
* Kind: `mutate`. Errors use the envelope `{error: {code, reason, message, fields}}`.
|
|
17180
|
+
*/
|
|
17181
|
+
post: operations["ops.voice.account.provision"];
|
|
17182
|
+
delete?: never;
|
|
17183
|
+
options?: never;
|
|
17184
|
+
head?: never;
|
|
17185
|
+
patch?: never;
|
|
17186
|
+
trace?: never;
|
|
17187
|
+
};
|
|
17188
|
+
"/ops/voice.numbers.enable": {
|
|
17189
|
+
parameters: {
|
|
17190
|
+
query?: never;
|
|
17191
|
+
header?: never;
|
|
17192
|
+
path?: never;
|
|
17193
|
+
cookie?: never;
|
|
17194
|
+
};
|
|
17195
|
+
get?: never;
|
|
17196
|
+
put?: never;
|
|
17197
|
+
/**
|
|
17198
|
+
* Turn on calls for a phone number
|
|
17199
|
+
* @description Sends calls for one of the company's phone numbers to Axivoy. A number at another provider is marked as needing manual setup.
|
|
17200
|
+
*
|
|
17201
|
+
* Kind: `mutate`. Errors use the envelope `{error: {code, reason, message, fields}}`.
|
|
17202
|
+
*/
|
|
17203
|
+
post: operations["ops.voice.numbers.enable"];
|
|
17204
|
+
delete?: never;
|
|
17205
|
+
options?: never;
|
|
17206
|
+
head?: never;
|
|
17207
|
+
patch?: never;
|
|
17208
|
+
trace?: never;
|
|
17209
|
+
};
|
|
17210
|
+
"/ops/voice.numbers.list": {
|
|
17211
|
+
parameters: {
|
|
17212
|
+
query?: never;
|
|
17213
|
+
header?: never;
|
|
17214
|
+
path?: never;
|
|
17215
|
+
cookie?: never;
|
|
17216
|
+
};
|
|
17217
|
+
get?: never;
|
|
17218
|
+
put?: never;
|
|
17219
|
+
/**
|
|
17220
|
+
* Phone numbers
|
|
17221
|
+
* @description The company's phone numbers for calls, with where each came from (texting number, rented, transferred in, added manually), its status and whether it is the main number callers see.
|
|
17222
|
+
*
|
|
17223
|
+
* Kind: `read`. Errors use the envelope `{error: {code, reason, message, fields}}`.
|
|
17224
|
+
*/
|
|
17225
|
+
post: operations["ops.voice.numbers.list"];
|
|
17226
|
+
delete?: never;
|
|
17227
|
+
options?: never;
|
|
17228
|
+
head?: never;
|
|
17229
|
+
patch?: never;
|
|
17230
|
+
trace?: never;
|
|
17231
|
+
};
|
|
17232
|
+
"/ops/voice.numbers.search": {
|
|
17233
|
+
parameters: {
|
|
17234
|
+
query?: never;
|
|
17235
|
+
header?: never;
|
|
17236
|
+
path?: never;
|
|
17237
|
+
cookie?: never;
|
|
17238
|
+
};
|
|
17239
|
+
get?: never;
|
|
17240
|
+
put?: never;
|
|
17241
|
+
/**
|
|
17242
|
+
* Find a phone number
|
|
17243
|
+
* @description Lists US phone numbers the company could rent for calls, optionally in one three-digit area code.
|
|
17244
|
+
*
|
|
17245
|
+
* Kind: `read`. Errors use the envelope `{error: {code, reason, message, fields}}`.
|
|
17246
|
+
*/
|
|
17247
|
+
post: operations["ops.voice.numbers.search"];
|
|
17248
|
+
delete?: never;
|
|
17249
|
+
options?: never;
|
|
17250
|
+
head?: never;
|
|
17251
|
+
patch?: never;
|
|
17252
|
+
trace?: never;
|
|
17253
|
+
};
|
|
17254
|
+
"/ops/voice.numbers.set_default": {
|
|
17255
|
+
parameters: {
|
|
17256
|
+
query?: never;
|
|
17257
|
+
header?: never;
|
|
17258
|
+
path?: never;
|
|
17259
|
+
cookie?: never;
|
|
17260
|
+
};
|
|
17261
|
+
get?: never;
|
|
17262
|
+
put?: never;
|
|
17263
|
+
/**
|
|
17264
|
+
* Set the main phone number
|
|
17265
|
+
* @description Makes an active phone number the main number, the one people see when the company calls them from Axivoy.
|
|
17266
|
+
*
|
|
17267
|
+
* Kind: `mutate`. Errors use the envelope `{error: {code, reason, message, fields}}`.
|
|
17268
|
+
*/
|
|
17269
|
+
post: operations["ops.voice.numbers.set_default"];
|
|
17270
|
+
delete?: never;
|
|
17271
|
+
options?: never;
|
|
17272
|
+
head?: never;
|
|
17273
|
+
patch?: never;
|
|
17274
|
+
trace?: never;
|
|
17275
|
+
};
|
|
17276
|
+
"/ops/voice.port_in.cancel": {
|
|
17277
|
+
parameters: {
|
|
17278
|
+
query?: never;
|
|
17279
|
+
header?: never;
|
|
17280
|
+
path?: never;
|
|
17281
|
+
cookie?: never;
|
|
17282
|
+
};
|
|
17283
|
+
get?: never;
|
|
17284
|
+
put?: never;
|
|
17285
|
+
/**
|
|
17286
|
+
* Cancel a number transfer
|
|
17287
|
+
* @description Stops a transfer in that is not finished. Not possible within 72 hours of the transfer date. The number stays with its current provider.
|
|
17288
|
+
*
|
|
17289
|
+
* Kind: `mutate`. Errors use the envelope `{error: {code, reason, message, fields}}`.
|
|
17290
|
+
*/
|
|
17291
|
+
post: operations["ops.voice.port_in.cancel"];
|
|
17292
|
+
delete?: never;
|
|
17293
|
+
options?: never;
|
|
17294
|
+
head?: never;
|
|
17295
|
+
patch?: never;
|
|
17296
|
+
trace?: never;
|
|
17297
|
+
};
|
|
17298
|
+
"/ops/voice.port_in.check": {
|
|
17299
|
+
parameters: {
|
|
17300
|
+
query?: never;
|
|
17301
|
+
header?: never;
|
|
17302
|
+
path?: never;
|
|
17303
|
+
cookie?: never;
|
|
17304
|
+
};
|
|
17305
|
+
get?: never;
|
|
17306
|
+
put?: never;
|
|
17307
|
+
/**
|
|
17308
|
+
* Check a number for transfer
|
|
17309
|
+
* @description Checks whether a US phone number the company already has can be transferred to Axivoy and whether its current provider needs a transfer PIN. Starts a draft transfer.
|
|
17310
|
+
*
|
|
17311
|
+
* Kind: `mutate`. Errors use the envelope `{error: {code, reason, message, fields}}`.
|
|
17312
|
+
*/
|
|
17313
|
+
post: operations["ops.voice.port_in.check"];
|
|
17314
|
+
delete?: never;
|
|
17315
|
+
options?: never;
|
|
17316
|
+
head?: never;
|
|
17317
|
+
patch?: never;
|
|
17318
|
+
trace?: never;
|
|
17319
|
+
};
|
|
17320
|
+
"/ops/voice.port_in.documents.add": {
|
|
17321
|
+
parameters: {
|
|
17322
|
+
query?: never;
|
|
17323
|
+
header?: never;
|
|
17324
|
+
path?: never;
|
|
17325
|
+
cookie?: never;
|
|
17326
|
+
};
|
|
17327
|
+
get?: never;
|
|
17328
|
+
put?: never;
|
|
17329
|
+
/**
|
|
17330
|
+
* Add a bill to a number transfer
|
|
17331
|
+
* @description Attaches a recent bill from the current provider (PDF, JPG or PNG, up to 10 MB) to a transfer in that is not finished.
|
|
17332
|
+
*
|
|
17333
|
+
* Kind: `mutate`. Errors use the envelope `{error: {code, reason, message, fields}}`.
|
|
17334
|
+
*/
|
|
17335
|
+
post: operations["ops.voice.port_in.documents.add"];
|
|
17336
|
+
delete?: never;
|
|
17337
|
+
options?: never;
|
|
17338
|
+
head?: never;
|
|
17339
|
+
patch?: never;
|
|
17340
|
+
trace?: never;
|
|
17341
|
+
};
|
|
17342
|
+
"/ops/voice.port_in.resubmit": {
|
|
17343
|
+
parameters: {
|
|
17344
|
+
query?: never;
|
|
17345
|
+
header?: never;
|
|
17346
|
+
path?: never;
|
|
17347
|
+
cookie?: never;
|
|
17348
|
+
};
|
|
17349
|
+
get?: never;
|
|
17350
|
+
put?: never;
|
|
17351
|
+
/**
|
|
17352
|
+
* Resubmit a number transfer
|
|
17353
|
+
* @description Sends a transfer that needs attention or was rejected again, with corrected details. Fields left out keep their submitted values.
|
|
17354
|
+
*
|
|
17355
|
+
* Kind: `mutate`. Errors use the envelope `{error: {code, reason, message, fields}}`.
|
|
17356
|
+
*/
|
|
17357
|
+
post: operations["ops.voice.port_in.resubmit"];
|
|
17358
|
+
delete?: never;
|
|
17359
|
+
options?: never;
|
|
17360
|
+
head?: never;
|
|
17361
|
+
patch?: never;
|
|
17362
|
+
trace?: never;
|
|
17363
|
+
};
|
|
17364
|
+
"/ops/voice.port_requests.get": {
|
|
17365
|
+
parameters: {
|
|
17366
|
+
query?: never;
|
|
17367
|
+
header?: never;
|
|
17368
|
+
path?: never;
|
|
17369
|
+
cookie?: never;
|
|
17370
|
+
};
|
|
17371
|
+
get?: never;
|
|
17372
|
+
put?: never;
|
|
17373
|
+
/**
|
|
17374
|
+
* Number transfer
|
|
17375
|
+
* @description One phone number transfer to Axivoy: its status, the transfer date once set, and whether it can be cancelled or resubmitted.
|
|
17376
|
+
*
|
|
17377
|
+
* Kind: `read`. Errors use the envelope `{error: {code, reason, message, fields}}`.
|
|
17378
|
+
*/
|
|
17379
|
+
post: operations["ops.voice.port_requests.get"];
|
|
17380
|
+
delete?: never;
|
|
17381
|
+
options?: never;
|
|
17382
|
+
head?: never;
|
|
17383
|
+
patch?: never;
|
|
17384
|
+
trace?: never;
|
|
17385
|
+
};
|
|
17166
17386
|
"/ops/webhooks.deliveries.list": {
|
|
17167
17387
|
parameters: {
|
|
17168
17388
|
query?: never;
|
|
@@ -103223,7 +103443,7 @@ export interface operations {
|
|
|
103223
103443
|
/** @enum {string} */
|
|
103224
103444
|
category: "schedule" | "maintenance" | "compliance" | "detention" | "load" | "payroll" | "receivables" | "ai_agent" | "system";
|
|
103225
103445
|
/** @enum {string} */
|
|
103226
|
-
channel: "email" | "sms" | "push" | "in_app";
|
|
103446
|
+
channel: "email" | "sms" | "push" | "in_app" | "voice";
|
|
103227
103447
|
enabled?: boolean | null;
|
|
103228
103448
|
}[];
|
|
103229
103449
|
};
|
|
@@ -134614,7 +134834,7 @@ export interface operations {
|
|
|
134614
134834
|
* @description Only messages on this channel
|
|
134615
134835
|
* @enum {string|null}
|
|
134616
134836
|
*/
|
|
134617
|
-
channel?: "email" | "sms" | "push" | "in_app" | null;
|
|
134837
|
+
channel?: "email" | "sms" | "push" | "in_app" | "voice" | null;
|
|
134618
134838
|
/** @description Cursor from the previous page's next_cursor. */
|
|
134619
134839
|
cursor?: string | null;
|
|
134620
134840
|
/** @description Rows per page (default 25). */
|
|
@@ -145166,7 +145386,1395 @@ export interface operations {
|
|
|
145166
145386
|
};
|
|
145167
145387
|
};
|
|
145168
145388
|
};
|
|
145169
|
-
"ops.trucks.specs.apply": {
|
|
145389
|
+
"ops.trucks.specs.apply": {
|
|
145390
|
+
parameters: {
|
|
145391
|
+
query?: never;
|
|
145392
|
+
header?: {
|
|
145393
|
+
/** @description Replays the first result when the same call is retried. Send one per user intent on writes. */
|
|
145394
|
+
"Idempotency-Key"?: string;
|
|
145395
|
+
/** @description Send `true` to run every check without changing anything. The answer is `{"dry_run": {"outcome": "would_run" | "would_propose", "input": {...}}}`. */
|
|
145396
|
+
"Axivoy-Dry-Run"?: "true" | "false";
|
|
145397
|
+
};
|
|
145398
|
+
path?: never;
|
|
145399
|
+
cookie?: never;
|
|
145400
|
+
};
|
|
145401
|
+
requestBody?: {
|
|
145402
|
+
content: {
|
|
145403
|
+
/**
|
|
145404
|
+
* @example {
|
|
145405
|
+
* "truck_id": 1,
|
|
145406
|
+
* "columns": [
|
|
145407
|
+
* "model",
|
|
145408
|
+
* "year"
|
|
145409
|
+
* ]
|
|
145410
|
+
* }
|
|
145411
|
+
*/
|
|
145412
|
+
"application/json": {
|
|
145413
|
+
/** @description The truck id */
|
|
145414
|
+
truck_id: number;
|
|
145415
|
+
/** @description Spec columns to overwrite: make, model, year, manufacturer, series, trim, vehicle_type, body_class, gvwr_class, gvwr_from_lbs, gvwr_to_lbs, axles, axle_configuration, engine_model, engine_manufacturer, engine_cylinders, engine_displacement_l, engine_hp, fuel_type_primary, fuel_type_secondary, drive_type, brake_system, brake_system_desc, transmission_style, transmission_speeds, cab_type, bed_type, wheelbase_in_from, wheelbase_in_to, wheels, curb_weight_lbs, plant_city, plant_state, plant_country, plant_company, trailer_type, trailer_body_type, trailer_length_ft, trailer_notes */
|
|
145416
|
+
columns: string[] | null;
|
|
145417
|
+
};
|
|
145418
|
+
};
|
|
145419
|
+
};
|
|
145420
|
+
responses: {
|
|
145421
|
+
/** @description The operation ran. */
|
|
145422
|
+
200: {
|
|
145423
|
+
headers: {
|
|
145424
|
+
[name: string]: unknown;
|
|
145425
|
+
};
|
|
145426
|
+
content: {
|
|
145427
|
+
/**
|
|
145428
|
+
* @example {
|
|
145429
|
+
* "result": {
|
|
145430
|
+
* "id": 1,
|
|
145431
|
+
* "written_count": 2,
|
|
145432
|
+
* "message": "Applied 2 decoded values.",
|
|
145433
|
+
* "warning": null
|
|
145434
|
+
* }
|
|
145435
|
+
* }
|
|
145436
|
+
*/
|
|
145437
|
+
"application/json": {
|
|
145438
|
+
result: {
|
|
145439
|
+
/** @description The truck id */
|
|
145440
|
+
id: number;
|
|
145441
|
+
/** @description Spec fields written */
|
|
145442
|
+
written_count: number;
|
|
145443
|
+
/** @description What was saved, in the operator's words */
|
|
145444
|
+
message?: string | null;
|
|
145445
|
+
/** @description Why nothing was saved, or what to review */
|
|
145446
|
+
warning?: string | null;
|
|
145447
|
+
};
|
|
145448
|
+
};
|
|
145449
|
+
};
|
|
145450
|
+
};
|
|
145451
|
+
202: components["responses"]["Proposal"];
|
|
145452
|
+
/** @description Refused: credits_exhausted. */
|
|
145453
|
+
402: {
|
|
145454
|
+
headers: {
|
|
145455
|
+
[name: string]: unknown;
|
|
145456
|
+
};
|
|
145457
|
+
content: {
|
|
145458
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145459
|
+
};
|
|
145460
|
+
};
|
|
145461
|
+
/** @description Refused: not_permitted, not_available, authority_off, data_class_blocked. */
|
|
145462
|
+
403: {
|
|
145463
|
+
headers: {
|
|
145464
|
+
[name: string]: unknown;
|
|
145465
|
+
};
|
|
145466
|
+
content: {
|
|
145467
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145468
|
+
};
|
|
145469
|
+
};
|
|
145470
|
+
/** @description Refused: not_found. */
|
|
145471
|
+
404: {
|
|
145472
|
+
headers: {
|
|
145473
|
+
[name: string]: unknown;
|
|
145474
|
+
};
|
|
145475
|
+
content: {
|
|
145476
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145477
|
+
};
|
|
145478
|
+
};
|
|
145479
|
+
/** @description Refused: idempotency_conflict, stale_state. */
|
|
145480
|
+
409: {
|
|
145481
|
+
headers: {
|
|
145482
|
+
[name: string]: unknown;
|
|
145483
|
+
};
|
|
145484
|
+
content: {
|
|
145485
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145486
|
+
};
|
|
145487
|
+
};
|
|
145488
|
+
/** @description Refused: operation_retired. */
|
|
145489
|
+
410: {
|
|
145490
|
+
headers: {
|
|
145491
|
+
[name: string]: unknown;
|
|
145492
|
+
};
|
|
145493
|
+
content: {
|
|
145494
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145495
|
+
};
|
|
145496
|
+
};
|
|
145497
|
+
/** @description Refused: invalid_input, domain_rule. */
|
|
145498
|
+
422: {
|
|
145499
|
+
headers: {
|
|
145500
|
+
[name: string]: unknown;
|
|
145501
|
+
};
|
|
145502
|
+
content: {
|
|
145503
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145504
|
+
};
|
|
145505
|
+
};
|
|
145506
|
+
/** @description Refused: rate_limited. */
|
|
145507
|
+
429: {
|
|
145508
|
+
headers: {
|
|
145509
|
+
[name: string]: unknown;
|
|
145510
|
+
};
|
|
145511
|
+
content: {
|
|
145512
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145513
|
+
};
|
|
145514
|
+
};
|
|
145515
|
+
};
|
|
145516
|
+
};
|
|
145517
|
+
"ops.trucks.specs.decode": {
|
|
145518
|
+
parameters: {
|
|
145519
|
+
query?: never;
|
|
145520
|
+
header?: {
|
|
145521
|
+
/** @description Replays the first result when the same call is retried. Send one per user intent on writes. */
|
|
145522
|
+
"Idempotency-Key"?: string;
|
|
145523
|
+
/** @description Send `true` to run every check without changing anything. The answer is `{"dry_run": {"outcome": "would_run" | "would_propose", "input": {...}}}`. */
|
|
145524
|
+
"Axivoy-Dry-Run"?: "true" | "false";
|
|
145525
|
+
};
|
|
145526
|
+
path?: never;
|
|
145527
|
+
cookie?: never;
|
|
145528
|
+
};
|
|
145529
|
+
requestBody?: {
|
|
145530
|
+
content: {
|
|
145531
|
+
/**
|
|
145532
|
+
* @example {
|
|
145533
|
+
* "truck_id": 1
|
|
145534
|
+
* }
|
|
145535
|
+
*/
|
|
145536
|
+
"application/json": {
|
|
145537
|
+
/** @description The truck id */
|
|
145538
|
+
truck_id: number;
|
|
145539
|
+
};
|
|
145540
|
+
};
|
|
145541
|
+
};
|
|
145542
|
+
responses: {
|
|
145543
|
+
/** @description The operation ran. */
|
|
145544
|
+
200: {
|
|
145545
|
+
headers: {
|
|
145546
|
+
[name: string]: unknown;
|
|
145547
|
+
};
|
|
145548
|
+
content: {
|
|
145549
|
+
/**
|
|
145550
|
+
* @example {
|
|
145551
|
+
* "result": {
|
|
145552
|
+
* "id": 1,
|
|
145553
|
+
* "written_count": 0,
|
|
145554
|
+
* "message": null,
|
|
145555
|
+
* "warning": "VIN decoding is unavailable right now. Try again in a minute."
|
|
145556
|
+
* }
|
|
145557
|
+
* }
|
|
145558
|
+
*/
|
|
145559
|
+
"application/json": {
|
|
145560
|
+
result: {
|
|
145561
|
+
/** @description The truck id */
|
|
145562
|
+
id: number;
|
|
145563
|
+
/** @description Spec fields written */
|
|
145564
|
+
written_count: number;
|
|
145565
|
+
/** @description What was saved, in the operator's words */
|
|
145566
|
+
message?: string | null;
|
|
145567
|
+
/** @description Why nothing was saved, or what to review */
|
|
145568
|
+
warning?: string | null;
|
|
145569
|
+
};
|
|
145570
|
+
};
|
|
145571
|
+
};
|
|
145572
|
+
};
|
|
145573
|
+
202: components["responses"]["Proposal"];
|
|
145574
|
+
/** @description Refused: credits_exhausted. */
|
|
145575
|
+
402: {
|
|
145576
|
+
headers: {
|
|
145577
|
+
[name: string]: unknown;
|
|
145578
|
+
};
|
|
145579
|
+
content: {
|
|
145580
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145581
|
+
};
|
|
145582
|
+
};
|
|
145583
|
+
/** @description Refused: not_permitted, not_available, authority_off, data_class_blocked. */
|
|
145584
|
+
403: {
|
|
145585
|
+
headers: {
|
|
145586
|
+
[name: string]: unknown;
|
|
145587
|
+
};
|
|
145588
|
+
content: {
|
|
145589
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145590
|
+
};
|
|
145591
|
+
};
|
|
145592
|
+
/** @description Refused: not_found. */
|
|
145593
|
+
404: {
|
|
145594
|
+
headers: {
|
|
145595
|
+
[name: string]: unknown;
|
|
145596
|
+
};
|
|
145597
|
+
content: {
|
|
145598
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145599
|
+
};
|
|
145600
|
+
};
|
|
145601
|
+
/** @description Refused: idempotency_conflict, stale_state. */
|
|
145602
|
+
409: {
|
|
145603
|
+
headers: {
|
|
145604
|
+
[name: string]: unknown;
|
|
145605
|
+
};
|
|
145606
|
+
content: {
|
|
145607
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145608
|
+
};
|
|
145609
|
+
};
|
|
145610
|
+
/** @description Refused: operation_retired. */
|
|
145611
|
+
410: {
|
|
145612
|
+
headers: {
|
|
145613
|
+
[name: string]: unknown;
|
|
145614
|
+
};
|
|
145615
|
+
content: {
|
|
145616
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145617
|
+
};
|
|
145618
|
+
};
|
|
145619
|
+
/** @description Refused: invalid_input, domain_rule. */
|
|
145620
|
+
422: {
|
|
145621
|
+
headers: {
|
|
145622
|
+
[name: string]: unknown;
|
|
145623
|
+
};
|
|
145624
|
+
content: {
|
|
145625
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145626
|
+
};
|
|
145627
|
+
};
|
|
145628
|
+
/** @description Refused: rate_limited. */
|
|
145629
|
+
429: {
|
|
145630
|
+
headers: {
|
|
145631
|
+
[name: string]: unknown;
|
|
145632
|
+
};
|
|
145633
|
+
content: {
|
|
145634
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145635
|
+
};
|
|
145636
|
+
};
|
|
145637
|
+
};
|
|
145638
|
+
};
|
|
145639
|
+
"ops.trucks.unlink_alvys": {
|
|
145640
|
+
parameters: {
|
|
145641
|
+
query?: never;
|
|
145642
|
+
header?: {
|
|
145643
|
+
/** @description Replays the first result when the same call is retried. Send one per user intent on writes. */
|
|
145644
|
+
"Idempotency-Key"?: string;
|
|
145645
|
+
/** @description Send `true` to run every check without changing anything. The answer is `{"dry_run": {"outcome": "would_run" | "would_propose", "input": {...}}}`. */
|
|
145646
|
+
"Axivoy-Dry-Run"?: "true" | "false";
|
|
145647
|
+
};
|
|
145648
|
+
path?: never;
|
|
145649
|
+
cookie?: never;
|
|
145650
|
+
};
|
|
145651
|
+
requestBody?: {
|
|
145652
|
+
content: {
|
|
145653
|
+
/**
|
|
145654
|
+
* @example {
|
|
145655
|
+
* "truck_id": 1
|
|
145656
|
+
* }
|
|
145657
|
+
*/
|
|
145658
|
+
"application/json": {
|
|
145659
|
+
/** @description The truck id */
|
|
145660
|
+
truck_id: number;
|
|
145661
|
+
};
|
|
145662
|
+
};
|
|
145663
|
+
};
|
|
145664
|
+
responses: {
|
|
145665
|
+
/** @description The operation ran. */
|
|
145666
|
+
200: {
|
|
145667
|
+
headers: {
|
|
145668
|
+
[name: string]: unknown;
|
|
145669
|
+
};
|
|
145670
|
+
content: {
|
|
145671
|
+
/**
|
|
145672
|
+
* @example {
|
|
145673
|
+
* "result": {
|
|
145674
|
+
* "id": 1,
|
|
145675
|
+
* "message": "Alvys link removed."
|
|
145676
|
+
* }
|
|
145677
|
+
* }
|
|
145678
|
+
*/
|
|
145679
|
+
"application/json": {
|
|
145680
|
+
result: {
|
|
145681
|
+
/** @description The truck id */
|
|
145682
|
+
id?: number | null;
|
|
145683
|
+
/** @description What happened, in the operator's words */
|
|
145684
|
+
message: string;
|
|
145685
|
+
};
|
|
145686
|
+
};
|
|
145687
|
+
};
|
|
145688
|
+
};
|
|
145689
|
+
202: components["responses"]["Proposal"];
|
|
145690
|
+
/** @description Refused: credits_exhausted. */
|
|
145691
|
+
402: {
|
|
145692
|
+
headers: {
|
|
145693
|
+
[name: string]: unknown;
|
|
145694
|
+
};
|
|
145695
|
+
content: {
|
|
145696
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145697
|
+
};
|
|
145698
|
+
};
|
|
145699
|
+
/** @description Refused: not_permitted, not_available, authority_off, data_class_blocked. */
|
|
145700
|
+
403: {
|
|
145701
|
+
headers: {
|
|
145702
|
+
[name: string]: unknown;
|
|
145703
|
+
};
|
|
145704
|
+
content: {
|
|
145705
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145706
|
+
};
|
|
145707
|
+
};
|
|
145708
|
+
/** @description Refused: not_found. */
|
|
145709
|
+
404: {
|
|
145710
|
+
headers: {
|
|
145711
|
+
[name: string]: unknown;
|
|
145712
|
+
};
|
|
145713
|
+
content: {
|
|
145714
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145715
|
+
};
|
|
145716
|
+
};
|
|
145717
|
+
/** @description Refused: idempotency_conflict, stale_state. */
|
|
145718
|
+
409: {
|
|
145719
|
+
headers: {
|
|
145720
|
+
[name: string]: unknown;
|
|
145721
|
+
};
|
|
145722
|
+
content: {
|
|
145723
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145724
|
+
};
|
|
145725
|
+
};
|
|
145726
|
+
/** @description Refused: operation_retired. */
|
|
145727
|
+
410: {
|
|
145728
|
+
headers: {
|
|
145729
|
+
[name: string]: unknown;
|
|
145730
|
+
};
|
|
145731
|
+
content: {
|
|
145732
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145733
|
+
};
|
|
145734
|
+
};
|
|
145735
|
+
/** @description Refused: invalid_input, domain_rule. */
|
|
145736
|
+
422: {
|
|
145737
|
+
headers: {
|
|
145738
|
+
[name: string]: unknown;
|
|
145739
|
+
};
|
|
145740
|
+
content: {
|
|
145741
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145742
|
+
};
|
|
145743
|
+
};
|
|
145744
|
+
/** @description Refused: rate_limited. */
|
|
145745
|
+
429: {
|
|
145746
|
+
headers: {
|
|
145747
|
+
[name: string]: unknown;
|
|
145748
|
+
};
|
|
145749
|
+
content: {
|
|
145750
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145751
|
+
};
|
|
145752
|
+
};
|
|
145753
|
+
};
|
|
145754
|
+
};
|
|
145755
|
+
"ops.trucks.update": {
|
|
145756
|
+
parameters: {
|
|
145757
|
+
query?: never;
|
|
145758
|
+
header?: {
|
|
145759
|
+
/** @description Replays the first result when the same call is retried. Send one per user intent on writes. */
|
|
145760
|
+
"Idempotency-Key"?: string;
|
|
145761
|
+
/** @description Send `true` to run every check without changing anything. The answer is `{"dry_run": {"outcome": "would_run" | "would_propose", "input": {...}}}`. */
|
|
145762
|
+
"Axivoy-Dry-Run"?: "true" | "false";
|
|
145763
|
+
};
|
|
145764
|
+
path?: never;
|
|
145765
|
+
cookie?: never;
|
|
145766
|
+
};
|
|
145767
|
+
requestBody?: {
|
|
145768
|
+
content: {
|
|
145769
|
+
/**
|
|
145770
|
+
* @example {
|
|
145771
|
+
* "truck_id": 1,
|
|
145772
|
+
* "make": "Freightliner",
|
|
145773
|
+
* "model": "Cascadia",
|
|
145774
|
+
* "license_plate": "ABC123"
|
|
145775
|
+
* }
|
|
145776
|
+
*/
|
|
145777
|
+
"application/json": {
|
|
145778
|
+
/** @description The truck id */
|
|
145779
|
+
truck_id: number;
|
|
145780
|
+
/** @description Truck (unit) number people use, max 64 */
|
|
145781
|
+
truck_number?: string | null;
|
|
145782
|
+
/** @description VIN; one that fails the check digit saves with a warning */
|
|
145783
|
+
vin?: string | null;
|
|
145784
|
+
/** @description Make, max 64 */
|
|
145785
|
+
make?: string | null;
|
|
145786
|
+
/** @description Model, max 64 */
|
|
145787
|
+
model?: string | null;
|
|
145788
|
+
/** @description Model year, 1900 to 2100 */
|
|
145789
|
+
year?: number | string | null;
|
|
145790
|
+
/** @description License plate, max 32 */
|
|
145791
|
+
license_plate?: string | null;
|
|
145792
|
+
/** @description Plate state: two-letter code or the state name */
|
|
145793
|
+
license_state?: string | null;
|
|
145794
|
+
/** @description Serial number, max 64 */
|
|
145795
|
+
serial?: string | null;
|
|
145796
|
+
/** @description Equipment category for power units (equipment_categories.list) */
|
|
145797
|
+
equipment_category_id?: number | string | null;
|
|
145798
|
+
/** @description In the active fleet */
|
|
145799
|
+
is_active?: boolean | string | null;
|
|
145800
|
+
/** @description Keep Samsara from overwriting the profile */
|
|
145801
|
+
locks_samsara_profile?: boolean | string | null;
|
|
145802
|
+
/** @description company, owner_operator or third_party_lease; absent keeps it */
|
|
145803
|
+
ownership?: string | null;
|
|
145804
|
+
/** @description Owner-operator who owns the unit (owner_operator only) */
|
|
145805
|
+
owner_user_id?: number | string | null;
|
|
145806
|
+
/** @description Person who answers for its compliance papers */
|
|
145807
|
+
regulatory_contact_user_id?: number | string | null;
|
|
145808
|
+
/** @description Person who answers for its repairs */
|
|
145809
|
+
maintenance_contact_user_id?: number | string | null;
|
|
145810
|
+
/** @description Spec: Manufacturer */
|
|
145811
|
+
manufacturer?: string | null;
|
|
145812
|
+
/** @description Spec: Series */
|
|
145813
|
+
series?: string | null;
|
|
145814
|
+
/** @description Spec: Trim */
|
|
145815
|
+
trim?: string | null;
|
|
145816
|
+
/** @description Spec: Vehicle type */
|
|
145817
|
+
vehicle_type?: string | null;
|
|
145818
|
+
/** @description Spec: Body class */
|
|
145819
|
+
body_class?: string | null;
|
|
145820
|
+
/** @description Spec: GVWR class */
|
|
145821
|
+
gvwr_class?: string | null;
|
|
145822
|
+
/** @description Spec: GVWR from (lb) */
|
|
145823
|
+
gvwr_from_lbs?: number | string | null;
|
|
145824
|
+
/** @description Spec: GVWR to (lb) */
|
|
145825
|
+
gvwr_to_lbs?: number | string | null;
|
|
145826
|
+
/** @description Spec: Axles */
|
|
145827
|
+
axles?: number | string | null;
|
|
145828
|
+
/** @description Spec: Axle configuration */
|
|
145829
|
+
axle_configuration?: string | null;
|
|
145830
|
+
/** @description Spec: Engine */
|
|
145831
|
+
engine_model?: string | null;
|
|
145832
|
+
/** @description Spec: Engine maker */
|
|
145833
|
+
engine_manufacturer?: string | null;
|
|
145834
|
+
/** @description Spec: Cylinders */
|
|
145835
|
+
engine_cylinders?: number | string | null;
|
|
145836
|
+
/** @description Spec: Displacement */
|
|
145837
|
+
engine_displacement_l?: number | string | null;
|
|
145838
|
+
/** @description Spec: Horsepower */
|
|
145839
|
+
engine_hp?: number | string | null;
|
|
145840
|
+
/** @description Spec: Fuel */
|
|
145841
|
+
fuel_type_primary?: string | null;
|
|
145842
|
+
/** @description Spec: Secondary fuel */
|
|
145843
|
+
fuel_type_secondary?: string | null;
|
|
145844
|
+
/** @description Spec: Drive */
|
|
145845
|
+
drive_type?: string | null;
|
|
145846
|
+
/** @description Spec: Brake system */
|
|
145847
|
+
brake_system?: string | null;
|
|
145848
|
+
/** @description Spec: Description */
|
|
145849
|
+
brake_system_desc?: string | null;
|
|
145850
|
+
/** @description Spec: Transmission */
|
|
145851
|
+
transmission_style?: string | null;
|
|
145852
|
+
/** @description Spec: Speeds */
|
|
145853
|
+
transmission_speeds?: number | string | null;
|
|
145854
|
+
/** @description Spec: Cab type */
|
|
145855
|
+
cab_type?: string | null;
|
|
145856
|
+
/** @description Spec: Bed type */
|
|
145857
|
+
bed_type?: string | null;
|
|
145858
|
+
/** @description Spec: Wheelbase from (in) */
|
|
145859
|
+
wheelbase_in_from?: number | string | null;
|
|
145860
|
+
/** @description Spec: Wheelbase to (in) */
|
|
145861
|
+
wheelbase_in_to?: number | string | null;
|
|
145862
|
+
/** @description Spec: Wheels */
|
|
145863
|
+
wheels?: number | string | null;
|
|
145864
|
+
/** @description Spec: Curb weight */
|
|
145865
|
+
curb_weight_lbs?: number | string | null;
|
|
145866
|
+
/** @description Spec: City */
|
|
145867
|
+
plant_city?: string | null;
|
|
145868
|
+
/** @description Spec: State */
|
|
145869
|
+
plant_state?: string | null;
|
|
145870
|
+
/** @description Spec: Country */
|
|
145871
|
+
plant_country?: string | null;
|
|
145872
|
+
/** @description Spec: Plant */
|
|
145873
|
+
plant_company?: string | null;
|
|
145874
|
+
/** @description Spec: Trailer type */
|
|
145875
|
+
trailer_type?: string | null;
|
|
145876
|
+
/** @description Spec: Body type */
|
|
145877
|
+
trailer_body_type?: string | null;
|
|
145878
|
+
/** @description Spec: Length */
|
|
145879
|
+
trailer_length_ft?: number | string | null;
|
|
145880
|
+
/** @description Spec: Notes */
|
|
145881
|
+
trailer_notes?: string | null;
|
|
145882
|
+
};
|
|
145883
|
+
};
|
|
145884
|
+
};
|
|
145885
|
+
responses: {
|
|
145886
|
+
/** @description The operation ran. */
|
|
145887
|
+
200: {
|
|
145888
|
+
headers: {
|
|
145889
|
+
[name: string]: unknown;
|
|
145890
|
+
};
|
|
145891
|
+
content: {
|
|
145892
|
+
/**
|
|
145893
|
+
* @example {
|
|
145894
|
+
* "result": {
|
|
145895
|
+
* "id": 1,
|
|
145896
|
+
* "message": "Truck updated.",
|
|
145897
|
+
* "warning": null
|
|
145898
|
+
* }
|
|
145899
|
+
* }
|
|
145900
|
+
*/
|
|
145901
|
+
"application/json": {
|
|
145902
|
+
result: {
|
|
145903
|
+
/** @description The truck id */
|
|
145904
|
+
id?: number | null;
|
|
145905
|
+
/** @description What happened, in the operator's words */
|
|
145906
|
+
message: string;
|
|
145907
|
+
/** @description The VIN check-digit warning, when the VIN looks wrong */
|
|
145908
|
+
warning?: string | null;
|
|
145909
|
+
};
|
|
145910
|
+
};
|
|
145911
|
+
};
|
|
145912
|
+
};
|
|
145913
|
+
202: components["responses"]["Proposal"];
|
|
145914
|
+
/** @description Refused: credits_exhausted. */
|
|
145915
|
+
402: {
|
|
145916
|
+
headers: {
|
|
145917
|
+
[name: string]: unknown;
|
|
145918
|
+
};
|
|
145919
|
+
content: {
|
|
145920
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145921
|
+
};
|
|
145922
|
+
};
|
|
145923
|
+
/** @description Refused: not_permitted, not_available, authority_off, data_class_blocked. */
|
|
145924
|
+
403: {
|
|
145925
|
+
headers: {
|
|
145926
|
+
[name: string]: unknown;
|
|
145927
|
+
};
|
|
145928
|
+
content: {
|
|
145929
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145930
|
+
};
|
|
145931
|
+
};
|
|
145932
|
+
/** @description Refused: not_found. */
|
|
145933
|
+
404: {
|
|
145934
|
+
headers: {
|
|
145935
|
+
[name: string]: unknown;
|
|
145936
|
+
};
|
|
145937
|
+
content: {
|
|
145938
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145939
|
+
};
|
|
145940
|
+
};
|
|
145941
|
+
/** @description Refused: idempotency_conflict, stale_state. */
|
|
145942
|
+
409: {
|
|
145943
|
+
headers: {
|
|
145944
|
+
[name: string]: unknown;
|
|
145945
|
+
};
|
|
145946
|
+
content: {
|
|
145947
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145948
|
+
};
|
|
145949
|
+
};
|
|
145950
|
+
/** @description Refused: operation_retired. */
|
|
145951
|
+
410: {
|
|
145952
|
+
headers: {
|
|
145953
|
+
[name: string]: unknown;
|
|
145954
|
+
};
|
|
145955
|
+
content: {
|
|
145956
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145957
|
+
};
|
|
145958
|
+
};
|
|
145959
|
+
/** @description Refused: invalid_input, domain_rule. */
|
|
145960
|
+
422: {
|
|
145961
|
+
headers: {
|
|
145962
|
+
[name: string]: unknown;
|
|
145963
|
+
};
|
|
145964
|
+
content: {
|
|
145965
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145966
|
+
};
|
|
145967
|
+
};
|
|
145968
|
+
/** @description Refused: rate_limited. */
|
|
145969
|
+
429: {
|
|
145970
|
+
headers: {
|
|
145971
|
+
[name: string]: unknown;
|
|
145972
|
+
};
|
|
145973
|
+
content: {
|
|
145974
|
+
"application/json": components["schemas"]["OperationError"];
|
|
145975
|
+
};
|
|
145976
|
+
};
|
|
145977
|
+
};
|
|
145978
|
+
};
|
|
145979
|
+
"ops.users.list": {
|
|
145980
|
+
parameters: {
|
|
145981
|
+
query?: never;
|
|
145982
|
+
header?: {
|
|
145983
|
+
/** @description Replays the first result when the same call is retried. Send one per user intent on writes. */
|
|
145984
|
+
"Idempotency-Key"?: string;
|
|
145985
|
+
/** @description Send `true` to run every check without changing anything. The answer is `{"dry_run": {"outcome": "would_run" | "would_propose", "input": {...}}}`. */
|
|
145986
|
+
"Axivoy-Dry-Run"?: "true" | "false";
|
|
145987
|
+
};
|
|
145988
|
+
path?: never;
|
|
145989
|
+
cookie?: never;
|
|
145990
|
+
};
|
|
145991
|
+
requestBody?: {
|
|
145992
|
+
content: {
|
|
145993
|
+
/** @example {} */
|
|
145994
|
+
"application/json": {
|
|
145995
|
+
/** @description Name or email containing this text */
|
|
145996
|
+
search?: string | null;
|
|
145997
|
+
/**
|
|
145998
|
+
* @description Only people holding this portal role
|
|
145999
|
+
* @enum {string|null}
|
|
146000
|
+
*/
|
|
146001
|
+
portal?: "admin" | "accountant" | "ar_specialist" | "hr" | "safety" | "maintenance" | "driver" | "dispatcher" | "combined" | null;
|
|
146002
|
+
/** @description Cursor from the previous page's next_cursor. */
|
|
146003
|
+
cursor?: string | null;
|
|
146004
|
+
/** @description Rows per page (default 25). */
|
|
146005
|
+
limit?: number | null;
|
|
146006
|
+
/**
|
|
146007
|
+
* Format: date-time
|
|
146008
|
+
* @description Only rows changed at or after this instant, oldest change first, with deleted rows as tombstones.
|
|
146009
|
+
*/
|
|
146010
|
+
updated_since?: string | null;
|
|
146011
|
+
};
|
|
146012
|
+
};
|
|
146013
|
+
};
|
|
146014
|
+
responses: {
|
|
146015
|
+
/** @description The operation ran. */
|
|
146016
|
+
200: {
|
|
146017
|
+
headers: {
|
|
146018
|
+
[name: string]: unknown;
|
|
146019
|
+
};
|
|
146020
|
+
content: {
|
|
146021
|
+
/**
|
|
146022
|
+
* @example {
|
|
146023
|
+
* "result": {
|
|
146024
|
+
* "items": [
|
|
146025
|
+
* {
|
|
146026
|
+
* "id": 2,
|
|
146027
|
+
* "deleted": null,
|
|
146028
|
+
* "name": "Dana Driver",
|
|
146029
|
+
* "email": "dana@example.test",
|
|
146030
|
+
* "phone": null,
|
|
146031
|
+
* "portals": [
|
|
146032
|
+
* {
|
|
146033
|
+
* "portal_kind": "driver"
|
|
146034
|
+
* }
|
|
146035
|
+
* ],
|
|
146036
|
+
* "employment_status": "active",
|
|
146037
|
+
* "updated_at": "2026-10-20T05:27:30Z"
|
|
146038
|
+
* },
|
|
146039
|
+
* {
|
|
146040
|
+
* "id": 1,
|
|
146041
|
+
* "deleted": null,
|
|
146042
|
+
* "name": "Lisandro Romaguera",
|
|
146043
|
+
* "email": "anthony66@example.org",
|
|
146044
|
+
* "phone": null,
|
|
146045
|
+
* "portals": [
|
|
146046
|
+
* {
|
|
146047
|
+
* "portal_kind": "admin"
|
|
146048
|
+
* }
|
|
146049
|
+
* ],
|
|
146050
|
+
* "employment_status": "not_set",
|
|
146051
|
+
* "updated_at": "2026-10-20T05:27:30Z"
|
|
146052
|
+
* }
|
|
146053
|
+
* ],
|
|
146054
|
+
* "next_cursor": null
|
|
146055
|
+
* }
|
|
146056
|
+
* }
|
|
146057
|
+
*/
|
|
146058
|
+
"application/json": {
|
|
146059
|
+
result: {
|
|
146060
|
+
/** @description One page of rows. */
|
|
146061
|
+
items: {
|
|
146062
|
+
/** @description The row's id. */
|
|
146063
|
+
id: number;
|
|
146064
|
+
/** @description Full name */
|
|
146065
|
+
name: string;
|
|
146066
|
+
/** @description Email */
|
|
146067
|
+
email?: string | null;
|
|
146068
|
+
/** @description Phone */
|
|
146069
|
+
phone?: string | null;
|
|
146070
|
+
/** @description Portal roles the person holds */
|
|
146071
|
+
portals: {
|
|
146072
|
+
/** @description admin, dispatcher, driver and the others */
|
|
146073
|
+
portal_kind: string;
|
|
146074
|
+
}[];
|
|
146075
|
+
/** @description active, terminated and the other directory statuses */
|
|
146076
|
+
employment_status: string;
|
|
146077
|
+
/**
|
|
146078
|
+
* Format: date-time
|
|
146079
|
+
* @description Last change
|
|
146080
|
+
*/
|
|
146081
|
+
updated_at?: string | null;
|
|
146082
|
+
/** @description True on a tombstone (the row was deleted or recycled); other fields are absent. */
|
|
146083
|
+
deleted?: boolean | null;
|
|
146084
|
+
}[];
|
|
146085
|
+
/** @description Pass as cursor for the next page; null on the last page. */
|
|
146086
|
+
next_cursor?: string | null;
|
|
146087
|
+
};
|
|
146088
|
+
};
|
|
146089
|
+
};
|
|
146090
|
+
};
|
|
146091
|
+
202: components["responses"]["Proposal"];
|
|
146092
|
+
/** @description Refused: credits_exhausted. */
|
|
146093
|
+
402: {
|
|
146094
|
+
headers: {
|
|
146095
|
+
[name: string]: unknown;
|
|
146096
|
+
};
|
|
146097
|
+
content: {
|
|
146098
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146099
|
+
};
|
|
146100
|
+
};
|
|
146101
|
+
/** @description Refused: not_permitted, not_available, authority_off, data_class_blocked. */
|
|
146102
|
+
403: {
|
|
146103
|
+
headers: {
|
|
146104
|
+
[name: string]: unknown;
|
|
146105
|
+
};
|
|
146106
|
+
content: {
|
|
146107
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146108
|
+
};
|
|
146109
|
+
};
|
|
146110
|
+
/** @description Refused: not_found. */
|
|
146111
|
+
404: {
|
|
146112
|
+
headers: {
|
|
146113
|
+
[name: string]: unknown;
|
|
146114
|
+
};
|
|
146115
|
+
content: {
|
|
146116
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146117
|
+
};
|
|
146118
|
+
};
|
|
146119
|
+
/** @description Refused: idempotency_conflict, stale_state. */
|
|
146120
|
+
409: {
|
|
146121
|
+
headers: {
|
|
146122
|
+
[name: string]: unknown;
|
|
146123
|
+
};
|
|
146124
|
+
content: {
|
|
146125
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146126
|
+
};
|
|
146127
|
+
};
|
|
146128
|
+
/** @description Refused: operation_retired. */
|
|
146129
|
+
410: {
|
|
146130
|
+
headers: {
|
|
146131
|
+
[name: string]: unknown;
|
|
146132
|
+
};
|
|
146133
|
+
content: {
|
|
146134
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146135
|
+
};
|
|
146136
|
+
};
|
|
146137
|
+
/** @description Refused: invalid_input, domain_rule. */
|
|
146138
|
+
422: {
|
|
146139
|
+
headers: {
|
|
146140
|
+
[name: string]: unknown;
|
|
146141
|
+
};
|
|
146142
|
+
content: {
|
|
146143
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146144
|
+
};
|
|
146145
|
+
};
|
|
146146
|
+
/** @description Refused: rate_limited. */
|
|
146147
|
+
429: {
|
|
146148
|
+
headers: {
|
|
146149
|
+
[name: string]: unknown;
|
|
146150
|
+
};
|
|
146151
|
+
content: {
|
|
146152
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146153
|
+
};
|
|
146154
|
+
};
|
|
146155
|
+
};
|
|
146156
|
+
};
|
|
146157
|
+
"ops.voice.account.provision": {
|
|
146158
|
+
parameters: {
|
|
146159
|
+
query?: never;
|
|
146160
|
+
header?: {
|
|
146161
|
+
/** @description Replays the first result when the same call is retried. Send one per user intent on writes. */
|
|
146162
|
+
"Idempotency-Key"?: string;
|
|
146163
|
+
/** @description Send `true` to run every check without changing anything. The answer is `{"dry_run": {"outcome": "would_run" | "would_propose", "input": {...}}}`. */
|
|
146164
|
+
"Axivoy-Dry-Run"?: "true" | "false";
|
|
146165
|
+
};
|
|
146166
|
+
path?: never;
|
|
146167
|
+
cookie?: never;
|
|
146168
|
+
};
|
|
146169
|
+
requestBody?: {
|
|
146170
|
+
content: {
|
|
146171
|
+
/** @example {} */
|
|
146172
|
+
"application/json": Record<string, never>;
|
|
146173
|
+
};
|
|
146174
|
+
};
|
|
146175
|
+
responses: {
|
|
146176
|
+
/** @description The operation ran. */
|
|
146177
|
+
200: {
|
|
146178
|
+
headers: {
|
|
146179
|
+
[name: string]: unknown;
|
|
146180
|
+
};
|
|
146181
|
+
content: {
|
|
146182
|
+
/**
|
|
146183
|
+
* @example {
|
|
146184
|
+
* "result": {
|
|
146185
|
+
* "status": "active",
|
|
146186
|
+
* "queued": false
|
|
146187
|
+
* }
|
|
146188
|
+
* }
|
|
146189
|
+
*/
|
|
146190
|
+
"application/json": {
|
|
146191
|
+
result: {
|
|
146192
|
+
/** @description none, provisioning, active, failed or unavailable */
|
|
146193
|
+
status: string;
|
|
146194
|
+
/** @description Whether setup was started */
|
|
146195
|
+
queued: boolean;
|
|
146196
|
+
};
|
|
146197
|
+
};
|
|
146198
|
+
};
|
|
146199
|
+
};
|
|
146200
|
+
202: components["responses"]["Proposal"];
|
|
146201
|
+
/** @description Refused: credits_exhausted. */
|
|
146202
|
+
402: {
|
|
146203
|
+
headers: {
|
|
146204
|
+
[name: string]: unknown;
|
|
146205
|
+
};
|
|
146206
|
+
content: {
|
|
146207
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146208
|
+
};
|
|
146209
|
+
};
|
|
146210
|
+
/** @description Refused: not_permitted, not_available, authority_off, data_class_blocked. */
|
|
146211
|
+
403: {
|
|
146212
|
+
headers: {
|
|
146213
|
+
[name: string]: unknown;
|
|
146214
|
+
};
|
|
146215
|
+
content: {
|
|
146216
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146217
|
+
};
|
|
146218
|
+
};
|
|
146219
|
+
/** @description Refused: not_found. */
|
|
146220
|
+
404: {
|
|
146221
|
+
headers: {
|
|
146222
|
+
[name: string]: unknown;
|
|
146223
|
+
};
|
|
146224
|
+
content: {
|
|
146225
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146226
|
+
};
|
|
146227
|
+
};
|
|
146228
|
+
/** @description Refused: idempotency_conflict, stale_state. */
|
|
146229
|
+
409: {
|
|
146230
|
+
headers: {
|
|
146231
|
+
[name: string]: unknown;
|
|
146232
|
+
};
|
|
146233
|
+
content: {
|
|
146234
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146235
|
+
};
|
|
146236
|
+
};
|
|
146237
|
+
/** @description Refused: operation_retired. */
|
|
146238
|
+
410: {
|
|
146239
|
+
headers: {
|
|
146240
|
+
[name: string]: unknown;
|
|
146241
|
+
};
|
|
146242
|
+
content: {
|
|
146243
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146244
|
+
};
|
|
146245
|
+
};
|
|
146246
|
+
/** @description Refused: invalid_input, domain_rule. */
|
|
146247
|
+
422: {
|
|
146248
|
+
headers: {
|
|
146249
|
+
[name: string]: unknown;
|
|
146250
|
+
};
|
|
146251
|
+
content: {
|
|
146252
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146253
|
+
};
|
|
146254
|
+
};
|
|
146255
|
+
/** @description Refused: rate_limited. */
|
|
146256
|
+
429: {
|
|
146257
|
+
headers: {
|
|
146258
|
+
[name: string]: unknown;
|
|
146259
|
+
};
|
|
146260
|
+
content: {
|
|
146261
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146262
|
+
};
|
|
146263
|
+
};
|
|
146264
|
+
};
|
|
146265
|
+
};
|
|
146266
|
+
"ops.voice.numbers.enable": {
|
|
146267
|
+
parameters: {
|
|
146268
|
+
query?: never;
|
|
146269
|
+
header?: {
|
|
146270
|
+
/** @description Replays the first result when the same call is retried. Send one per user intent on writes. */
|
|
146271
|
+
"Idempotency-Key"?: string;
|
|
146272
|
+
/** @description Send `true` to run every check without changing anything. The answer is `{"dry_run": {"outcome": "would_run" | "would_propose", "input": {...}}}`. */
|
|
146273
|
+
"Axivoy-Dry-Run"?: "true" | "false";
|
|
146274
|
+
};
|
|
146275
|
+
path?: never;
|
|
146276
|
+
cookie?: never;
|
|
146277
|
+
};
|
|
146278
|
+
requestBody?: {
|
|
146279
|
+
content: {
|
|
146280
|
+
/**
|
|
146281
|
+
* @example {
|
|
146282
|
+
* "number_id": 1
|
|
146283
|
+
* }
|
|
146284
|
+
*/
|
|
146285
|
+
"application/json": {
|
|
146286
|
+
/** @description The phone number (from voice.numbers.list) */
|
|
146287
|
+
number_id: number;
|
|
146288
|
+
};
|
|
146289
|
+
};
|
|
146290
|
+
};
|
|
146291
|
+
responses: {
|
|
146292
|
+
/** @description The operation ran. */
|
|
146293
|
+
200: {
|
|
146294
|
+
headers: {
|
|
146295
|
+
[name: string]: unknown;
|
|
146296
|
+
};
|
|
146297
|
+
content: {
|
|
146298
|
+
/**
|
|
146299
|
+
* @example {
|
|
146300
|
+
* "result": {
|
|
146301
|
+
* "number_id": 1,
|
|
146302
|
+
* "needs_setup": false,
|
|
146303
|
+
* "message": "Calls to (312) 555-1505 now come to Axivoy."
|
|
146304
|
+
* }
|
|
146305
|
+
* }
|
|
146306
|
+
*/
|
|
146307
|
+
"application/json": {
|
|
146308
|
+
result: {
|
|
146309
|
+
/** @description The enabled phone number */
|
|
146310
|
+
number_id: number;
|
|
146311
|
+
/** @description Whether the company must forward calls from its own provider */
|
|
146312
|
+
needs_setup: boolean;
|
|
146313
|
+
/** @description What happened, in the operator's words */
|
|
146314
|
+
message: string;
|
|
146315
|
+
};
|
|
146316
|
+
};
|
|
146317
|
+
};
|
|
146318
|
+
};
|
|
146319
|
+
202: components["responses"]["Proposal"];
|
|
146320
|
+
/** @description Refused: credits_exhausted. */
|
|
146321
|
+
402: {
|
|
146322
|
+
headers: {
|
|
146323
|
+
[name: string]: unknown;
|
|
146324
|
+
};
|
|
146325
|
+
content: {
|
|
146326
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146327
|
+
};
|
|
146328
|
+
};
|
|
146329
|
+
/** @description Refused: not_permitted, not_available, authority_off, data_class_blocked. */
|
|
146330
|
+
403: {
|
|
146331
|
+
headers: {
|
|
146332
|
+
[name: string]: unknown;
|
|
146333
|
+
};
|
|
146334
|
+
content: {
|
|
146335
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146336
|
+
};
|
|
146337
|
+
};
|
|
146338
|
+
/** @description Refused: not_found. */
|
|
146339
|
+
404: {
|
|
146340
|
+
headers: {
|
|
146341
|
+
[name: string]: unknown;
|
|
146342
|
+
};
|
|
146343
|
+
content: {
|
|
146344
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146345
|
+
};
|
|
146346
|
+
};
|
|
146347
|
+
/** @description Refused: idempotency_conflict, stale_state. */
|
|
146348
|
+
409: {
|
|
146349
|
+
headers: {
|
|
146350
|
+
[name: string]: unknown;
|
|
146351
|
+
};
|
|
146352
|
+
content: {
|
|
146353
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146354
|
+
};
|
|
146355
|
+
};
|
|
146356
|
+
/** @description Refused: operation_retired. */
|
|
146357
|
+
410: {
|
|
146358
|
+
headers: {
|
|
146359
|
+
[name: string]: unknown;
|
|
146360
|
+
};
|
|
146361
|
+
content: {
|
|
146362
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146363
|
+
};
|
|
146364
|
+
};
|
|
146365
|
+
/** @description Refused: invalid_input, domain_rule. */
|
|
146366
|
+
422: {
|
|
146367
|
+
headers: {
|
|
146368
|
+
[name: string]: unknown;
|
|
146369
|
+
};
|
|
146370
|
+
content: {
|
|
146371
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146372
|
+
};
|
|
146373
|
+
};
|
|
146374
|
+
/** @description Refused: rate_limited. */
|
|
146375
|
+
429: {
|
|
146376
|
+
headers: {
|
|
146377
|
+
[name: string]: unknown;
|
|
146378
|
+
};
|
|
146379
|
+
content: {
|
|
146380
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146381
|
+
};
|
|
146382
|
+
};
|
|
146383
|
+
};
|
|
146384
|
+
};
|
|
146385
|
+
"ops.voice.numbers.list": {
|
|
146386
|
+
parameters: {
|
|
146387
|
+
query?: never;
|
|
146388
|
+
header?: {
|
|
146389
|
+
/** @description Replays the first result when the same call is retried. Send one per user intent on writes. */
|
|
146390
|
+
"Idempotency-Key"?: string;
|
|
146391
|
+
/** @description Send `true` to run every check without changing anything. The answer is `{"dry_run": {"outcome": "would_run" | "would_propose", "input": {...}}}`. */
|
|
146392
|
+
"Axivoy-Dry-Run"?: "true" | "false";
|
|
146393
|
+
};
|
|
146394
|
+
path?: never;
|
|
146395
|
+
cookie?: never;
|
|
146396
|
+
};
|
|
146397
|
+
requestBody?: {
|
|
146398
|
+
content: {
|
|
146399
|
+
/** @example {} */
|
|
146400
|
+
"application/json": {
|
|
146401
|
+
/** @description Cursor from the previous page's next_cursor. */
|
|
146402
|
+
cursor?: string | null;
|
|
146403
|
+
/** @description Rows per page (default 25). */
|
|
146404
|
+
limit?: number | null;
|
|
146405
|
+
/**
|
|
146406
|
+
* Format: date-time
|
|
146407
|
+
* @description Only rows changed at or after this instant, oldest change first, with deleted rows as tombstones.
|
|
146408
|
+
*/
|
|
146409
|
+
updated_since?: string | null;
|
|
146410
|
+
};
|
|
146411
|
+
};
|
|
146412
|
+
};
|
|
146413
|
+
responses: {
|
|
146414
|
+
/** @description The operation ran. */
|
|
146415
|
+
200: {
|
|
146416
|
+
headers: {
|
|
146417
|
+
[name: string]: unknown;
|
|
146418
|
+
};
|
|
146419
|
+
content: {
|
|
146420
|
+
/**
|
|
146421
|
+
* @example {
|
|
146422
|
+
* "result": {
|
|
146423
|
+
* "items": [
|
|
146424
|
+
* {
|
|
146425
|
+
* "id": 1,
|
|
146426
|
+
* "number": "+13125551505",
|
|
146427
|
+
* "source": "sms_registration",
|
|
146428
|
+
* "status": "calls_off",
|
|
146429
|
+
* "status_label": "Calls not turned on",
|
|
146430
|
+
* "is_main": false,
|
|
146431
|
+
* "deleted": null
|
|
146432
|
+
* }
|
|
146433
|
+
* ],
|
|
146434
|
+
* "next_cursor": null
|
|
146435
|
+
* }
|
|
146436
|
+
* }
|
|
146437
|
+
*/
|
|
146438
|
+
"application/json": {
|
|
146439
|
+
result: {
|
|
146440
|
+
/** @description One page of rows. */
|
|
146441
|
+
items: {
|
|
146442
|
+
/** @description The row's id. */
|
|
146443
|
+
id: number;
|
|
146444
|
+
/** @description The number in +1 format */
|
|
146445
|
+
number: string;
|
|
146446
|
+
/** @description sms_registration, rented, ported or external */
|
|
146447
|
+
source: string;
|
|
146448
|
+
/** @description active, needs_setup, calls_off, setting_up, rent_failed, porting_in, pending_port_out */
|
|
146449
|
+
status: string;
|
|
146450
|
+
/** @description The status in the page's words */
|
|
146451
|
+
status_label: string;
|
|
146452
|
+
/** @description Whether calls from Axivoy show this number */
|
|
146453
|
+
is_main: boolean;
|
|
146454
|
+
/** @description True on a tombstone (the row was deleted or recycled); other fields are absent. */
|
|
146455
|
+
deleted?: boolean | null;
|
|
146456
|
+
}[];
|
|
146457
|
+
/** @description Pass as cursor for the next page; null on the last page. */
|
|
146458
|
+
next_cursor?: string | null;
|
|
146459
|
+
};
|
|
146460
|
+
};
|
|
146461
|
+
};
|
|
146462
|
+
};
|
|
146463
|
+
202: components["responses"]["Proposal"];
|
|
146464
|
+
/** @description Refused: credits_exhausted. */
|
|
146465
|
+
402: {
|
|
146466
|
+
headers: {
|
|
146467
|
+
[name: string]: unknown;
|
|
146468
|
+
};
|
|
146469
|
+
content: {
|
|
146470
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146471
|
+
};
|
|
146472
|
+
};
|
|
146473
|
+
/** @description Refused: not_permitted, not_available, authority_off, data_class_blocked. */
|
|
146474
|
+
403: {
|
|
146475
|
+
headers: {
|
|
146476
|
+
[name: string]: unknown;
|
|
146477
|
+
};
|
|
146478
|
+
content: {
|
|
146479
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146480
|
+
};
|
|
146481
|
+
};
|
|
146482
|
+
/** @description Refused: not_found. */
|
|
146483
|
+
404: {
|
|
146484
|
+
headers: {
|
|
146485
|
+
[name: string]: unknown;
|
|
146486
|
+
};
|
|
146487
|
+
content: {
|
|
146488
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146489
|
+
};
|
|
146490
|
+
};
|
|
146491
|
+
/** @description Refused: idempotency_conflict, stale_state. */
|
|
146492
|
+
409: {
|
|
146493
|
+
headers: {
|
|
146494
|
+
[name: string]: unknown;
|
|
146495
|
+
};
|
|
146496
|
+
content: {
|
|
146497
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146498
|
+
};
|
|
146499
|
+
};
|
|
146500
|
+
/** @description Refused: operation_retired. */
|
|
146501
|
+
410: {
|
|
146502
|
+
headers: {
|
|
146503
|
+
[name: string]: unknown;
|
|
146504
|
+
};
|
|
146505
|
+
content: {
|
|
146506
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146507
|
+
};
|
|
146508
|
+
};
|
|
146509
|
+
/** @description Refused: invalid_input, domain_rule. */
|
|
146510
|
+
422: {
|
|
146511
|
+
headers: {
|
|
146512
|
+
[name: string]: unknown;
|
|
146513
|
+
};
|
|
146514
|
+
content: {
|
|
146515
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146516
|
+
};
|
|
146517
|
+
};
|
|
146518
|
+
/** @description Refused: rate_limited. */
|
|
146519
|
+
429: {
|
|
146520
|
+
headers: {
|
|
146521
|
+
[name: string]: unknown;
|
|
146522
|
+
};
|
|
146523
|
+
content: {
|
|
146524
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146525
|
+
};
|
|
146526
|
+
};
|
|
146527
|
+
};
|
|
146528
|
+
};
|
|
146529
|
+
"ops.voice.numbers.search": {
|
|
146530
|
+
parameters: {
|
|
146531
|
+
query?: never;
|
|
146532
|
+
header?: {
|
|
146533
|
+
/** @description Replays the first result when the same call is retried. Send one per user intent on writes. */
|
|
146534
|
+
"Idempotency-Key"?: string;
|
|
146535
|
+
/** @description Send `true` to run every check without changing anything. The answer is `{"dry_run": {"outcome": "would_run" | "would_propose", "input": {...}}}`. */
|
|
146536
|
+
"Axivoy-Dry-Run"?: "true" | "false";
|
|
146537
|
+
};
|
|
146538
|
+
path?: never;
|
|
146539
|
+
cookie?: never;
|
|
146540
|
+
};
|
|
146541
|
+
requestBody?: {
|
|
146542
|
+
content: {
|
|
146543
|
+
/**
|
|
146544
|
+
* @example {
|
|
146545
|
+
* "area_code": "312"
|
|
146546
|
+
* }
|
|
146547
|
+
*/
|
|
146548
|
+
"application/json": {
|
|
146549
|
+
/** @description Three-digit US area code, for example 312 */
|
|
146550
|
+
area_code?: string | null;
|
|
146551
|
+
};
|
|
146552
|
+
};
|
|
146553
|
+
};
|
|
146554
|
+
responses: {
|
|
146555
|
+
/** @description The operation ran. */
|
|
146556
|
+
200: {
|
|
146557
|
+
headers: {
|
|
146558
|
+
[name: string]: unknown;
|
|
146559
|
+
};
|
|
146560
|
+
content: {
|
|
146561
|
+
/**
|
|
146562
|
+
* @example {
|
|
146563
|
+
* "result": {
|
|
146564
|
+
* "numbers": [
|
|
146565
|
+
* {
|
|
146566
|
+
* "number": "+13125550100",
|
|
146567
|
+
* "display": "(312) 555-0100",
|
|
146568
|
+
* "locality": "Springfield",
|
|
146569
|
+
* "region": "IL"
|
|
146570
|
+
* }
|
|
146571
|
+
* ]
|
|
146572
|
+
* }
|
|
146573
|
+
* }
|
|
146574
|
+
*/
|
|
146575
|
+
"application/json": {
|
|
146576
|
+
result: {
|
|
146577
|
+
/** @description Numbers available to rent */
|
|
146578
|
+
numbers: {
|
|
146579
|
+
/** @description The number in +1 format */
|
|
146580
|
+
number: string;
|
|
146581
|
+
/** @description The number as people write it */
|
|
146582
|
+
display: string;
|
|
146583
|
+
/** @description City */
|
|
146584
|
+
locality?: string | null;
|
|
146585
|
+
/** @description State */
|
|
146586
|
+
region?: string | null;
|
|
146587
|
+
}[];
|
|
146588
|
+
};
|
|
146589
|
+
};
|
|
146590
|
+
};
|
|
146591
|
+
};
|
|
146592
|
+
202: components["responses"]["Proposal"];
|
|
146593
|
+
/** @description Refused: credits_exhausted. */
|
|
146594
|
+
402: {
|
|
146595
|
+
headers: {
|
|
146596
|
+
[name: string]: unknown;
|
|
146597
|
+
};
|
|
146598
|
+
content: {
|
|
146599
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146600
|
+
};
|
|
146601
|
+
};
|
|
146602
|
+
/** @description Refused: not_permitted, not_available, authority_off, data_class_blocked. */
|
|
146603
|
+
403: {
|
|
146604
|
+
headers: {
|
|
146605
|
+
[name: string]: unknown;
|
|
146606
|
+
};
|
|
146607
|
+
content: {
|
|
146608
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146609
|
+
};
|
|
146610
|
+
};
|
|
146611
|
+
/** @description Refused: not_found. */
|
|
146612
|
+
404: {
|
|
146613
|
+
headers: {
|
|
146614
|
+
[name: string]: unknown;
|
|
146615
|
+
};
|
|
146616
|
+
content: {
|
|
146617
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146618
|
+
};
|
|
146619
|
+
};
|
|
146620
|
+
/** @description Refused: idempotency_conflict, stale_state. */
|
|
146621
|
+
409: {
|
|
146622
|
+
headers: {
|
|
146623
|
+
[name: string]: unknown;
|
|
146624
|
+
};
|
|
146625
|
+
content: {
|
|
146626
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146627
|
+
};
|
|
146628
|
+
};
|
|
146629
|
+
/** @description Refused: operation_retired. */
|
|
146630
|
+
410: {
|
|
146631
|
+
headers: {
|
|
146632
|
+
[name: string]: unknown;
|
|
146633
|
+
};
|
|
146634
|
+
content: {
|
|
146635
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146636
|
+
};
|
|
146637
|
+
};
|
|
146638
|
+
/** @description Refused: invalid_input, domain_rule. */
|
|
146639
|
+
422: {
|
|
146640
|
+
headers: {
|
|
146641
|
+
[name: string]: unknown;
|
|
146642
|
+
};
|
|
146643
|
+
content: {
|
|
146644
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146645
|
+
};
|
|
146646
|
+
};
|
|
146647
|
+
/** @description Refused: rate_limited. */
|
|
146648
|
+
429: {
|
|
146649
|
+
headers: {
|
|
146650
|
+
[name: string]: unknown;
|
|
146651
|
+
};
|
|
146652
|
+
content: {
|
|
146653
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146654
|
+
};
|
|
146655
|
+
};
|
|
146656
|
+
};
|
|
146657
|
+
};
|
|
146658
|
+
"ops.voice.numbers.set_default": {
|
|
146659
|
+
parameters: {
|
|
146660
|
+
query?: never;
|
|
146661
|
+
header?: {
|
|
146662
|
+
/** @description Replays the first result when the same call is retried. Send one per user intent on writes. */
|
|
146663
|
+
"Idempotency-Key"?: string;
|
|
146664
|
+
/** @description Send `true` to run every check without changing anything. The answer is `{"dry_run": {"outcome": "would_run" | "would_propose", "input": {...}}}`. */
|
|
146665
|
+
"Axivoy-Dry-Run"?: "true" | "false";
|
|
146666
|
+
};
|
|
146667
|
+
path?: never;
|
|
146668
|
+
cookie?: never;
|
|
146669
|
+
};
|
|
146670
|
+
requestBody?: {
|
|
146671
|
+
content: {
|
|
146672
|
+
/**
|
|
146673
|
+
* @example {
|
|
146674
|
+
* "number_id": 1
|
|
146675
|
+
* }
|
|
146676
|
+
*/
|
|
146677
|
+
"application/json": {
|
|
146678
|
+
/** @description The phone number (from voice.numbers.list) */
|
|
146679
|
+
number_id: number;
|
|
146680
|
+
};
|
|
146681
|
+
};
|
|
146682
|
+
};
|
|
146683
|
+
responses: {
|
|
146684
|
+
/** @description The operation ran. */
|
|
146685
|
+
200: {
|
|
146686
|
+
headers: {
|
|
146687
|
+
[name: string]: unknown;
|
|
146688
|
+
};
|
|
146689
|
+
content: {
|
|
146690
|
+
/**
|
|
146691
|
+
* @example {
|
|
146692
|
+
* "result": {
|
|
146693
|
+
* "number_id": 1,
|
|
146694
|
+
* "is_main": true,
|
|
146695
|
+
* "message": "(312) 555-1505 is now the main number."
|
|
146696
|
+
* }
|
|
146697
|
+
* }
|
|
146698
|
+
*/
|
|
146699
|
+
"application/json": {
|
|
146700
|
+
result: {
|
|
146701
|
+
/** @description The new main phone number */
|
|
146702
|
+
number_id: number;
|
|
146703
|
+
/** @description Always true on success */
|
|
146704
|
+
is_main: boolean;
|
|
146705
|
+
/** @description What happened, in the operator's words */
|
|
146706
|
+
message: string;
|
|
146707
|
+
};
|
|
146708
|
+
};
|
|
146709
|
+
};
|
|
146710
|
+
};
|
|
146711
|
+
202: components["responses"]["Proposal"];
|
|
146712
|
+
/** @description Refused: credits_exhausted. */
|
|
146713
|
+
402: {
|
|
146714
|
+
headers: {
|
|
146715
|
+
[name: string]: unknown;
|
|
146716
|
+
};
|
|
146717
|
+
content: {
|
|
146718
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146719
|
+
};
|
|
146720
|
+
};
|
|
146721
|
+
/** @description Refused: not_permitted, not_available, authority_off, data_class_blocked. */
|
|
146722
|
+
403: {
|
|
146723
|
+
headers: {
|
|
146724
|
+
[name: string]: unknown;
|
|
146725
|
+
};
|
|
146726
|
+
content: {
|
|
146727
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146728
|
+
};
|
|
146729
|
+
};
|
|
146730
|
+
/** @description Refused: not_found. */
|
|
146731
|
+
404: {
|
|
146732
|
+
headers: {
|
|
146733
|
+
[name: string]: unknown;
|
|
146734
|
+
};
|
|
146735
|
+
content: {
|
|
146736
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146737
|
+
};
|
|
146738
|
+
};
|
|
146739
|
+
/** @description Refused: idempotency_conflict, stale_state. */
|
|
146740
|
+
409: {
|
|
146741
|
+
headers: {
|
|
146742
|
+
[name: string]: unknown;
|
|
146743
|
+
};
|
|
146744
|
+
content: {
|
|
146745
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146746
|
+
};
|
|
146747
|
+
};
|
|
146748
|
+
/** @description Refused: operation_retired. */
|
|
146749
|
+
410: {
|
|
146750
|
+
headers: {
|
|
146751
|
+
[name: string]: unknown;
|
|
146752
|
+
};
|
|
146753
|
+
content: {
|
|
146754
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146755
|
+
};
|
|
146756
|
+
};
|
|
146757
|
+
/** @description Refused: invalid_input, domain_rule. */
|
|
146758
|
+
422: {
|
|
146759
|
+
headers: {
|
|
146760
|
+
[name: string]: unknown;
|
|
146761
|
+
};
|
|
146762
|
+
content: {
|
|
146763
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146764
|
+
};
|
|
146765
|
+
};
|
|
146766
|
+
/** @description Refused: rate_limited. */
|
|
146767
|
+
429: {
|
|
146768
|
+
headers: {
|
|
146769
|
+
[name: string]: unknown;
|
|
146770
|
+
};
|
|
146771
|
+
content: {
|
|
146772
|
+
"application/json": components["schemas"]["OperationError"];
|
|
146773
|
+
};
|
|
146774
|
+
};
|
|
146775
|
+
};
|
|
146776
|
+
};
|
|
146777
|
+
"ops.voice.port_in.cancel": {
|
|
145170
146778
|
parameters: {
|
|
145171
146779
|
query?: never;
|
|
145172
146780
|
header?: {
|
|
@@ -145182,18 +146790,12 @@ export interface operations {
|
|
|
145182
146790
|
content: {
|
|
145183
146791
|
/**
|
|
145184
146792
|
* @example {
|
|
145185
|
-
* "
|
|
145186
|
-
* "columns": [
|
|
145187
|
-
* "model",
|
|
145188
|
-
* "year"
|
|
145189
|
-
* ]
|
|
146793
|
+
* "port_request_id": 3
|
|
145190
146794
|
* }
|
|
145191
146795
|
*/
|
|
145192
146796
|
"application/json": {
|
|
145193
|
-
/** @description The
|
|
145194
|
-
|
|
145195
|
-
/** @description Spec columns to overwrite: make, model, year, manufacturer, series, trim, vehicle_type, body_class, gvwr_class, gvwr_from_lbs, gvwr_to_lbs, axles, axle_configuration, engine_model, engine_manufacturer, engine_cylinders, engine_displacement_l, engine_hp, fuel_type_primary, fuel_type_secondary, drive_type, brake_system, brake_system_desc, transmission_style, transmission_speeds, cab_type, bed_type, wheelbase_in_from, wheelbase_in_to, wheels, curb_weight_lbs, plant_city, plant_state, plant_country, plant_company, trailer_type, trailer_body_type, trailer_length_ft, trailer_notes */
|
|
145196
|
-
columns: string[] | null;
|
|
146797
|
+
/** @description The transfer (from voice.port_requests.get) */
|
|
146798
|
+
port_request_id: number;
|
|
145197
146799
|
};
|
|
145198
146800
|
};
|
|
145199
146801
|
};
|
|
@@ -145207,23 +146809,20 @@ export interface operations {
|
|
|
145207
146809
|
/**
|
|
145208
146810
|
* @example {
|
|
145209
146811
|
* "result": {
|
|
145210
|
-
* "
|
|
145211
|
-
* "
|
|
145212
|
-
* "message": "
|
|
145213
|
-
* "warning": null
|
|
146812
|
+
* "port_request_id": 3,
|
|
146813
|
+
* "status": "cancelled",
|
|
146814
|
+
* "message": "Transfer cancelled. The number stays with your current provider."
|
|
145214
146815
|
* }
|
|
145215
146816
|
* }
|
|
145216
146817
|
*/
|
|
145217
146818
|
"application/json": {
|
|
145218
146819
|
result: {
|
|
145219
|
-
/** @description The
|
|
145220
|
-
|
|
145221
|
-
/** @description
|
|
145222
|
-
|
|
145223
|
-
/** @description What
|
|
145224
|
-
message
|
|
145225
|
-
/** @description Why nothing was saved, or what to review */
|
|
145226
|
-
warning?: string | null;
|
|
146820
|
+
/** @description The cancelled transfer */
|
|
146821
|
+
port_request_id: number;
|
|
146822
|
+
/** @description The transfer status */
|
|
146823
|
+
status: string;
|
|
146824
|
+
/** @description What happened, in the operator's words */
|
|
146825
|
+
message: string;
|
|
145227
146826
|
};
|
|
145228
146827
|
};
|
|
145229
146828
|
};
|
|
@@ -145294,7 +146893,7 @@ export interface operations {
|
|
|
145294
146893
|
};
|
|
145295
146894
|
};
|
|
145296
146895
|
};
|
|
145297
|
-
"ops.
|
|
146896
|
+
"ops.voice.port_in.check": {
|
|
145298
146897
|
parameters: {
|
|
145299
146898
|
query?: never;
|
|
145300
146899
|
header?: {
|
|
@@ -145310,12 +146909,12 @@ export interface operations {
|
|
|
145310
146909
|
content: {
|
|
145311
146910
|
/**
|
|
145312
146911
|
* @example {
|
|
145313
|
-
* "
|
|
146912
|
+
* "number": "+13125550177"
|
|
145314
146913
|
* }
|
|
145315
146914
|
*/
|
|
145316
146915
|
"application/json": {
|
|
145317
|
-
/** @description The
|
|
145318
|
-
|
|
146916
|
+
/** @description The number to transfer, in +1 format or as typed */
|
|
146917
|
+
number: string;
|
|
145319
146918
|
};
|
|
145320
146919
|
};
|
|
145321
146920
|
};
|
|
@@ -145329,23 +146928,26 @@ export interface operations {
|
|
|
145329
146928
|
/**
|
|
145330
146929
|
* @example {
|
|
145331
146930
|
* "result": {
|
|
145332
|
-
* "
|
|
145333
|
-
* "
|
|
145334
|
-
* "
|
|
145335
|
-
* "
|
|
146931
|
+
* "port_request_id": 1,
|
|
146932
|
+
* "portable": true,
|
|
146933
|
+
* "pin_required": true,
|
|
146934
|
+
* "not_portable_reason": null,
|
|
146935
|
+
* "message": "This number can move to Axivoy."
|
|
145336
146936
|
* }
|
|
145337
146937
|
* }
|
|
145338
146938
|
*/
|
|
145339
146939
|
"application/json": {
|
|
145340
146940
|
result: {
|
|
145341
|
-
/** @description The
|
|
145342
|
-
|
|
145343
|
-
/** @description
|
|
145344
|
-
|
|
145345
|
-
/** @description
|
|
145346
|
-
|
|
145347
|
-
/** @description Why
|
|
145348
|
-
|
|
146941
|
+
/** @description The draft transfer the check started */
|
|
146942
|
+
port_request_id: number;
|
|
146943
|
+
/** @description Whether the number can be transferred automatically */
|
|
146944
|
+
portable: boolean;
|
|
146945
|
+
/** @description Whether the current provider needs a transfer PIN */
|
|
146946
|
+
pin_required: boolean;
|
|
146947
|
+
/** @description Why it cannot move automatically; our team can still help */
|
|
146948
|
+
not_portable_reason?: string | null;
|
|
146949
|
+
/** @description What happened, in the operator's words */
|
|
146950
|
+
message: string;
|
|
145349
146951
|
};
|
|
145350
146952
|
};
|
|
145351
146953
|
};
|
|
@@ -145416,7 +147018,7 @@ export interface operations {
|
|
|
145416
147018
|
};
|
|
145417
147019
|
};
|
|
145418
147020
|
};
|
|
145419
|
-
"ops.
|
|
147021
|
+
"ops.voice.port_in.documents.add": {
|
|
145420
147022
|
parameters: {
|
|
145421
147023
|
query?: never;
|
|
145422
147024
|
header?: {
|
|
@@ -145432,12 +147034,15 @@ export interface operations {
|
|
|
145432
147034
|
content: {
|
|
145433
147035
|
/**
|
|
145434
147036
|
* @example {
|
|
145435
|
-
* "
|
|
147037
|
+
* "port_request_id": 2,
|
|
147038
|
+
* "file": "7acc2c15-058d-4ed7-8b8b-b31a58028e26"
|
|
145436
147039
|
* }
|
|
145437
147040
|
*/
|
|
145438
147041
|
"application/json": {
|
|
145439
|
-
/** @description The
|
|
145440
|
-
|
|
147042
|
+
/** @description The transfer (from voice.port_requests.get) */
|
|
147043
|
+
port_request_id: number;
|
|
147044
|
+
/** @description The bill */
|
|
147045
|
+
file: string;
|
|
145441
147046
|
};
|
|
145442
147047
|
};
|
|
145443
147048
|
};
|
|
@@ -145451,15 +147056,15 @@ export interface operations {
|
|
|
145451
147056
|
/**
|
|
145452
147057
|
* @example {
|
|
145453
147058
|
* "result": {
|
|
145454
|
-
* "
|
|
145455
|
-
* "message": "
|
|
147059
|
+
* "document_id": 1,
|
|
147060
|
+
* "message": "Bill added to the transfer."
|
|
145456
147061
|
* }
|
|
145457
147062
|
* }
|
|
145458
147063
|
*/
|
|
145459
147064
|
"application/json": {
|
|
145460
147065
|
result: {
|
|
145461
|
-
/** @description The
|
|
145462
|
-
|
|
147066
|
+
/** @description The document added to the transfer */
|
|
147067
|
+
document_id: number;
|
|
145463
147068
|
/** @description What happened, in the operator's words */
|
|
145464
147069
|
message: string;
|
|
145465
147070
|
};
|
|
@@ -145532,7 +147137,7 @@ export interface operations {
|
|
|
145532
147137
|
};
|
|
145533
147138
|
};
|
|
145534
147139
|
};
|
|
145535
|
-
"ops.
|
|
147140
|
+
"ops.voice.port_in.resubmit": {
|
|
145536
147141
|
parameters: {
|
|
145537
147142
|
query?: never;
|
|
145538
147143
|
header?: {
|
|
@@ -145548,117 +147153,26 @@ export interface operations {
|
|
|
145548
147153
|
content: {
|
|
145549
147154
|
/**
|
|
145550
147155
|
* @example {
|
|
145551
|
-
* "
|
|
145552
|
-
* "make": "Freightliner",
|
|
145553
|
-
* "model": "Cascadia",
|
|
145554
|
-
* "license_plate": "ABC123"
|
|
147156
|
+
* "port_request_id": 2
|
|
145555
147157
|
* }
|
|
145556
147158
|
*/
|
|
145557
147159
|
"application/json": {
|
|
145558
|
-
/** @description The
|
|
145559
|
-
|
|
145560
|
-
/** @description
|
|
145561
|
-
|
|
145562
|
-
/** @description
|
|
145563
|
-
|
|
145564
|
-
/** @description
|
|
145565
|
-
|
|
145566
|
-
/** @description
|
|
145567
|
-
|
|
145568
|
-
|
|
145569
|
-
|
|
145570
|
-
|
|
145571
|
-
|
|
145572
|
-
|
|
145573
|
-
|
|
145574
|
-
/** @description Serial number, max 64 */
|
|
145575
|
-
serial?: string | null;
|
|
145576
|
-
/** @description Equipment category for power units (equipment_categories.list) */
|
|
145577
|
-
equipment_category_id?: number | string | null;
|
|
145578
|
-
/** @description In the active fleet */
|
|
145579
|
-
is_active?: boolean | string | null;
|
|
145580
|
-
/** @description Keep Samsara from overwriting the profile */
|
|
145581
|
-
locks_samsara_profile?: boolean | string | null;
|
|
145582
|
-
/** @description company, owner_operator or third_party_lease; absent keeps it */
|
|
145583
|
-
ownership?: string | null;
|
|
145584
|
-
/** @description Owner-operator who owns the unit (owner_operator only) */
|
|
145585
|
-
owner_user_id?: number | string | null;
|
|
145586
|
-
/** @description Person who answers for its compliance papers */
|
|
145587
|
-
regulatory_contact_user_id?: number | string | null;
|
|
145588
|
-
/** @description Person who answers for its repairs */
|
|
145589
|
-
maintenance_contact_user_id?: number | string | null;
|
|
145590
|
-
/** @description Spec: Manufacturer */
|
|
145591
|
-
manufacturer?: string | null;
|
|
145592
|
-
/** @description Spec: Series */
|
|
145593
|
-
series?: string | null;
|
|
145594
|
-
/** @description Spec: Trim */
|
|
145595
|
-
trim?: string | null;
|
|
145596
|
-
/** @description Spec: Vehicle type */
|
|
145597
|
-
vehicle_type?: string | null;
|
|
145598
|
-
/** @description Spec: Body class */
|
|
145599
|
-
body_class?: string | null;
|
|
145600
|
-
/** @description Spec: GVWR class */
|
|
145601
|
-
gvwr_class?: string | null;
|
|
145602
|
-
/** @description Spec: GVWR from (lb) */
|
|
145603
|
-
gvwr_from_lbs?: number | string | null;
|
|
145604
|
-
/** @description Spec: GVWR to (lb) */
|
|
145605
|
-
gvwr_to_lbs?: number | string | null;
|
|
145606
|
-
/** @description Spec: Axles */
|
|
145607
|
-
axles?: number | string | null;
|
|
145608
|
-
/** @description Spec: Axle configuration */
|
|
145609
|
-
axle_configuration?: string | null;
|
|
145610
|
-
/** @description Spec: Engine */
|
|
145611
|
-
engine_model?: string | null;
|
|
145612
|
-
/** @description Spec: Engine maker */
|
|
145613
|
-
engine_manufacturer?: string | null;
|
|
145614
|
-
/** @description Spec: Cylinders */
|
|
145615
|
-
engine_cylinders?: number | string | null;
|
|
145616
|
-
/** @description Spec: Displacement */
|
|
145617
|
-
engine_displacement_l?: number | string | null;
|
|
145618
|
-
/** @description Spec: Horsepower */
|
|
145619
|
-
engine_hp?: number | string | null;
|
|
145620
|
-
/** @description Spec: Fuel */
|
|
145621
|
-
fuel_type_primary?: string | null;
|
|
145622
|
-
/** @description Spec: Secondary fuel */
|
|
145623
|
-
fuel_type_secondary?: string | null;
|
|
145624
|
-
/** @description Spec: Drive */
|
|
145625
|
-
drive_type?: string | null;
|
|
145626
|
-
/** @description Spec: Brake system */
|
|
145627
|
-
brake_system?: string | null;
|
|
145628
|
-
/** @description Spec: Description */
|
|
145629
|
-
brake_system_desc?: string | null;
|
|
145630
|
-
/** @description Spec: Transmission */
|
|
145631
|
-
transmission_style?: string | null;
|
|
145632
|
-
/** @description Spec: Speeds */
|
|
145633
|
-
transmission_speeds?: number | string | null;
|
|
145634
|
-
/** @description Spec: Cab type */
|
|
145635
|
-
cab_type?: string | null;
|
|
145636
|
-
/** @description Spec: Bed type */
|
|
145637
|
-
bed_type?: string | null;
|
|
145638
|
-
/** @description Spec: Wheelbase from (in) */
|
|
145639
|
-
wheelbase_in_from?: number | string | null;
|
|
145640
|
-
/** @description Spec: Wheelbase to (in) */
|
|
145641
|
-
wheelbase_in_to?: number | string | null;
|
|
145642
|
-
/** @description Spec: Wheels */
|
|
145643
|
-
wheels?: number | string | null;
|
|
145644
|
-
/** @description Spec: Curb weight */
|
|
145645
|
-
curb_weight_lbs?: number | string | null;
|
|
145646
|
-
/** @description Spec: City */
|
|
145647
|
-
plant_city?: string | null;
|
|
145648
|
-
/** @description Spec: State */
|
|
145649
|
-
plant_state?: string | null;
|
|
145650
|
-
/** @description Spec: Country */
|
|
145651
|
-
plant_country?: string | null;
|
|
145652
|
-
/** @description Spec: Plant */
|
|
145653
|
-
plant_company?: string | null;
|
|
145654
|
-
/** @description Spec: Trailer type */
|
|
145655
|
-
trailer_type?: string | null;
|
|
145656
|
-
/** @description Spec: Body type */
|
|
145657
|
-
trailer_body_type?: string | null;
|
|
145658
|
-
/** @description Spec: Length */
|
|
145659
|
-
trailer_length_ft?: number | string | null;
|
|
145660
|
-
/** @description Spec: Notes */
|
|
145661
|
-
trailer_notes?: string | null;
|
|
147160
|
+
/** @description The transfer (from voice.port_requests.get) */
|
|
147161
|
+
port_request_id: number;
|
|
147162
|
+
/** @description The company that provides the number today */
|
|
147163
|
+
losing_carrier?: string | null;
|
|
147164
|
+
/** @description Person named on the current provider account */
|
|
147165
|
+
authorized_name?: string | null;
|
|
147166
|
+
/** @description Their email; the authorization letter is sent there */
|
|
147167
|
+
authorized_email?: string | null;
|
|
147168
|
+
/** @description Service address on the current provider account */
|
|
147169
|
+
service_address?: {
|
|
147170
|
+
street?: string | null;
|
|
147171
|
+
unit?: string | null;
|
|
147172
|
+
city?: string | null;
|
|
147173
|
+
state?: string | null;
|
|
147174
|
+
zip?: string | null;
|
|
147175
|
+
} | null;
|
|
145662
147176
|
};
|
|
145663
147177
|
};
|
|
145664
147178
|
};
|
|
@@ -145672,20 +147186,20 @@ export interface operations {
|
|
|
145672
147186
|
/**
|
|
145673
147187
|
* @example {
|
|
145674
147188
|
* "result": {
|
|
145675
|
-
* "
|
|
145676
|
-
* "
|
|
145677
|
-
* "
|
|
147189
|
+
* "port_request_id": 2,
|
|
147190
|
+
* "status": "submitted",
|
|
147191
|
+
* "message": "Transfer resubmitted."
|
|
145678
147192
|
* }
|
|
145679
147193
|
* }
|
|
145680
147194
|
*/
|
|
145681
147195
|
"application/json": {
|
|
145682
147196
|
result: {
|
|
145683
|
-
/** @description The
|
|
145684
|
-
|
|
147197
|
+
/** @description The resubmitted transfer */
|
|
147198
|
+
port_request_id: number;
|
|
147199
|
+
/** @description The transfer status */
|
|
147200
|
+
status: string;
|
|
145685
147201
|
/** @description What happened, in the operator's words */
|
|
145686
147202
|
message: string;
|
|
145687
|
-
/** @description The VIN check-digit warning, when the VIN looks wrong */
|
|
145688
|
-
warning?: string | null;
|
|
145689
147203
|
};
|
|
145690
147204
|
};
|
|
145691
147205
|
};
|
|
@@ -145756,7 +147270,7 @@ export interface operations {
|
|
|
145756
147270
|
};
|
|
145757
147271
|
};
|
|
145758
147272
|
};
|
|
145759
|
-
"ops.
|
|
147273
|
+
"ops.voice.port_requests.get": {
|
|
145760
147274
|
parameters: {
|
|
145761
147275
|
query?: never;
|
|
145762
147276
|
header?: {
|
|
@@ -145770,24 +147284,14 @@ export interface operations {
|
|
|
145770
147284
|
};
|
|
145771
147285
|
requestBody?: {
|
|
145772
147286
|
content: {
|
|
145773
|
-
/**
|
|
147287
|
+
/**
|
|
147288
|
+
* @example {
|
|
147289
|
+
* "port_request_id": 2
|
|
147290
|
+
* }
|
|
147291
|
+
*/
|
|
145774
147292
|
"application/json": {
|
|
145775
|
-
/** @description
|
|
145776
|
-
|
|
145777
|
-
/**
|
|
145778
|
-
* @description Only people holding this portal role
|
|
145779
|
-
* @enum {string|null}
|
|
145780
|
-
*/
|
|
145781
|
-
portal?: "admin" | "accountant" | "ar_specialist" | "hr" | "safety" | "maintenance" | "driver" | "dispatcher" | "combined" | null;
|
|
145782
|
-
/** @description Cursor from the previous page's next_cursor. */
|
|
145783
|
-
cursor?: string | null;
|
|
145784
|
-
/** @description Rows per page (default 25). */
|
|
145785
|
-
limit?: number | null;
|
|
145786
|
-
/**
|
|
145787
|
-
* Format: date-time
|
|
145788
|
-
* @description Only rows changed at or after this instant, oldest change first, with deleted rows as tombstones.
|
|
145789
|
-
*/
|
|
145790
|
-
updated_since?: string | null;
|
|
147293
|
+
/** @description The transfer */
|
|
147294
|
+
port_request_id: number;
|
|
145791
147295
|
};
|
|
145792
147296
|
};
|
|
145793
147297
|
};
|
|
@@ -145801,69 +147305,41 @@ export interface operations {
|
|
|
145801
147305
|
/**
|
|
145802
147306
|
* @example {
|
|
145803
147307
|
* "result": {
|
|
145804
|
-
* "
|
|
145805
|
-
*
|
|
145806
|
-
*
|
|
145807
|
-
*
|
|
145808
|
-
*
|
|
145809
|
-
*
|
|
145810
|
-
*
|
|
145811
|
-
*
|
|
145812
|
-
*
|
|
145813
|
-
* "portal_kind": "driver"
|
|
145814
|
-
* }
|
|
145815
|
-
* ],
|
|
145816
|
-
* "employment_status": "active",
|
|
145817
|
-
* "updated_at": "2026-10-20T05:27:30Z"
|
|
145818
|
-
* },
|
|
145819
|
-
* {
|
|
145820
|
-
* "id": 1,
|
|
145821
|
-
* "deleted": null,
|
|
145822
|
-
* "name": "Lisandro Romaguera",
|
|
145823
|
-
* "email": "anthony66@example.org",
|
|
145824
|
-
* "phone": null,
|
|
145825
|
-
* "portals": [
|
|
145826
|
-
* {
|
|
145827
|
-
* "portal_kind": "admin"
|
|
145828
|
-
* }
|
|
145829
|
-
* ],
|
|
145830
|
-
* "employment_status": "not_set",
|
|
145831
|
-
* "updated_at": "2026-10-20T05:27:30Z"
|
|
145832
|
-
* }
|
|
145833
|
-
* ],
|
|
145834
|
-
* "next_cursor": null
|
|
147308
|
+
* "port_request_id": 2,
|
|
147309
|
+
* "number": "+13125550188",
|
|
147310
|
+
* "status": "submitted",
|
|
147311
|
+
* "status_label": "Submitted",
|
|
147312
|
+
* "transfer_date": null,
|
|
147313
|
+
* "last_error": null,
|
|
147314
|
+
* "can_cancel": true,
|
|
147315
|
+
* "cancel_blocked_reason": null,
|
|
147316
|
+
* "can_resubmit": false
|
|
145835
147317
|
* }
|
|
145836
147318
|
* }
|
|
145837
147319
|
*/
|
|
145838
147320
|
"application/json": {
|
|
145839
147321
|
result: {
|
|
145840
|
-
/** @description
|
|
145841
|
-
|
|
145842
|
-
|
|
145843
|
-
|
|
145844
|
-
|
|
145845
|
-
|
|
145846
|
-
|
|
145847
|
-
|
|
145848
|
-
|
|
145849
|
-
|
|
145850
|
-
|
|
145851
|
-
|
|
145852
|
-
|
|
145853
|
-
|
|
145854
|
-
|
|
145855
|
-
|
|
145856
|
-
|
|
145857
|
-
|
|
145858
|
-
|
|
145859
|
-
|
|
145860
|
-
|
|
145861
|
-
updated_at?: string | null;
|
|
145862
|
-
/** @description True on a tombstone (the row was deleted or recycled); other fields are absent. */
|
|
145863
|
-
deleted?: boolean | null;
|
|
145864
|
-
}[];
|
|
145865
|
-
/** @description Pass as cursor for the next page; null on the last page. */
|
|
145866
|
-
next_cursor?: string | null;
|
|
147322
|
+
/** @description The transfer */
|
|
147323
|
+
port_request_id: number;
|
|
147324
|
+
/** @description The number in +1 format */
|
|
147325
|
+
number: string;
|
|
147326
|
+
/** @description draft, submitted, waiting_for_signature, in_progress, transfer_date_set, done, needs_attention, rejected, cancelled */
|
|
147327
|
+
status: string;
|
|
147328
|
+
/** @description The status in the page's words */
|
|
147329
|
+
status_label: string;
|
|
147330
|
+
/**
|
|
147331
|
+
* Format: date
|
|
147332
|
+
* @description The day the number moves, once set
|
|
147333
|
+
*/
|
|
147334
|
+
transfer_date?: string | null;
|
|
147335
|
+
/** @description What the current provider said is wrong */
|
|
147336
|
+
last_error?: string | null;
|
|
147337
|
+
/** @description Whether voice.port_in.cancel would work now */
|
|
147338
|
+
can_cancel: boolean;
|
|
147339
|
+
/** @description Why it cannot be cancelled now */
|
|
147340
|
+
cancel_blocked_reason?: string | null;
|
|
147341
|
+
/** @description Whether voice.port_in.resubmit applies */
|
|
147342
|
+
can_resubmit: boolean;
|
|
145867
147343
|
};
|
|
145868
147344
|
};
|
|
145869
147345
|
};
|