@purveyors/sdk 0.54.0 → 0.57.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/index.d.ts +389 -19
- package/dist/index.js +4 -1
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -4362,6 +4362,9 @@ interface paths {
|
|
|
4362
4362
|
has_additives?: "true" | "false";
|
|
4363
4363
|
processing_disclosure_level?: string;
|
|
4364
4364
|
processing_confidence_min?: number | null;
|
|
4365
|
+
varietyCode?: string | string[];
|
|
4366
|
+
speciesCode?: string | string[];
|
|
4367
|
+
dryingMethodCode?: string | string[];
|
|
4365
4368
|
};
|
|
4366
4369
|
header?: {
|
|
4367
4370
|
Prefer?: string;
|
|
@@ -4386,6 +4389,21 @@ interface paths {
|
|
|
4386
4389
|
"application/json": components["schemas"]["CatalogListResponse"];
|
|
4387
4390
|
};
|
|
4388
4391
|
};
|
|
4392
|
+
/** @description Invalid query: an unknown variety, species or drying method code */
|
|
4393
|
+
400: {
|
|
4394
|
+
headers: {
|
|
4395
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
4396
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
4397
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
4398
|
+
"X-RateLimit-Burst-Limit": components["headers"]["X-RateLimit-Burst-Limit"];
|
|
4399
|
+
"X-RateLimit-Burst-Remaining": components["headers"]["X-RateLimit-Burst-Remaining"];
|
|
4400
|
+
"X-RateLimit-Burst-Reset": components["headers"]["X-RateLimit-Burst-Reset"];
|
|
4401
|
+
[name: string]: unknown;
|
|
4402
|
+
};
|
|
4403
|
+
content: {
|
|
4404
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
4405
|
+
};
|
|
4406
|
+
};
|
|
4389
4407
|
/** @description Authentication required */
|
|
4390
4408
|
401: {
|
|
4391
4409
|
headers: {
|
|
@@ -4486,6 +4504,9 @@ interface paths {
|
|
|
4486
4504
|
has_additives?: "true" | "false";
|
|
4487
4505
|
processing_disclosure_level?: string;
|
|
4488
4506
|
processing_confidence_min?: number | null;
|
|
4507
|
+
varietyCode?: string | string[];
|
|
4508
|
+
speciesCode?: string | string[];
|
|
4509
|
+
dryingMethodCode?: string | string[];
|
|
4489
4510
|
place_id?: string;
|
|
4490
4511
|
bbox?: string;
|
|
4491
4512
|
zoom?: number;
|
|
@@ -4515,7 +4536,7 @@ interface paths {
|
|
|
4515
4536
|
"application/json": components["schemas"]["CatalogMapResponse"];
|
|
4516
4537
|
};
|
|
4517
4538
|
};
|
|
4518
|
-
/** @description Malformed map geometry, zoom, place id, or elevation range */
|
|
4539
|
+
/** @description Malformed map geometry, zoom, place id, or elevation range, or an unknown variety, species or drying method code */
|
|
4519
4540
|
400: {
|
|
4520
4541
|
headers: {
|
|
4521
4542
|
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
@@ -4600,7 +4621,7 @@ interface paths {
|
|
|
4600
4621
|
get: {
|
|
4601
4622
|
parameters: {
|
|
4602
4623
|
query?: {
|
|
4603
|
-
include?: "grading";
|
|
4624
|
+
include?: ("grading" | "taxonomy" | "grading,taxonomy" | "taxonomy,grading") | ("grading" | "taxonomy" | "grading,taxonomy" | "taxonomy,grading")[];
|
|
4604
4625
|
stocked?: "true" | "false" | "all";
|
|
4605
4626
|
showWholesale?: "true" | "false";
|
|
4606
4627
|
wholesaleOnly?: "true" | "false";
|
|
@@ -4640,6 +4661,9 @@ interface paths {
|
|
|
4640
4661
|
waterActivityMax?: number | null;
|
|
4641
4662
|
densityMin?: number | null;
|
|
4642
4663
|
scoreProtocol?: "sca_2004" | "cva_affective" | "q_arabica" | "coe" | "supplier_unspecified";
|
|
4664
|
+
varietyCode?: string | string[];
|
|
4665
|
+
speciesCode?: string | string[];
|
|
4666
|
+
dryingMethodCode?: string | string[];
|
|
4643
4667
|
processing_base_method?: string;
|
|
4644
4668
|
fermentation_type?: string;
|
|
4645
4669
|
process_additive?: string;
|
|
@@ -4670,6 +4694,21 @@ interface paths {
|
|
|
4670
4694
|
"application/json": components["schemas"]["CatalogFacetsResponse"];
|
|
4671
4695
|
};
|
|
4672
4696
|
};
|
|
4697
|
+
/** @description Invalid query: an unknown variety, species or drying method code */
|
|
4698
|
+
400: {
|
|
4699
|
+
headers: {
|
|
4700
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
4701
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
4702
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
4703
|
+
"X-RateLimit-Burst-Limit": components["headers"]["X-RateLimit-Burst-Limit"];
|
|
4704
|
+
"X-RateLimit-Burst-Remaining": components["headers"]["X-RateLimit-Burst-Remaining"];
|
|
4705
|
+
"X-RateLimit-Burst-Reset": components["headers"]["X-RateLimit-Burst-Reset"];
|
|
4706
|
+
[name: string]: unknown;
|
|
4707
|
+
};
|
|
4708
|
+
content: {
|
|
4709
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
4710
|
+
};
|
|
4711
|
+
};
|
|
4673
4712
|
/** @description Authentication required */
|
|
4674
4713
|
401: {
|
|
4675
4714
|
headers: {
|
|
@@ -6519,6 +6558,84 @@ interface paths {
|
|
|
6519
6558
|
patch?: never;
|
|
6520
6559
|
trace?: never;
|
|
6521
6560
|
};
|
|
6561
|
+
"/v1/catalog/taxonomies": {
|
|
6562
|
+
parameters: {
|
|
6563
|
+
query?: never;
|
|
6564
|
+
header?: never;
|
|
6565
|
+
path?: never;
|
|
6566
|
+
cookie?: never;
|
|
6567
|
+
};
|
|
6568
|
+
/**
|
|
6569
|
+
* Variety, species, and drying-method vocabularies
|
|
6570
|
+
* @description Lists canonical variety, species, and drying-method codes with labels, family links (`parent_code`), descriptions, and the supplier spellings (`aliases`) that map to each code. Reference data: identical for every authorized caller and not subject to row projection or collection limits. Retired codes are omitted unless includeRetired=true, except a retired family or species that an active code still names in `parent_code` or `species_code`: it is returned with `active: false` so every link resolves within the response. New values are added as rows; clients should not hard-code the lists.
|
|
6571
|
+
*/
|
|
6572
|
+
get: {
|
|
6573
|
+
parameters: {
|
|
6574
|
+
query?: {
|
|
6575
|
+
includeRetired?: "true" | "false";
|
|
6576
|
+
};
|
|
6577
|
+
header?: never;
|
|
6578
|
+
path?: never;
|
|
6579
|
+
cookie?: never;
|
|
6580
|
+
};
|
|
6581
|
+
requestBody?: never;
|
|
6582
|
+
responses: {
|
|
6583
|
+
/** @description Taxonomy vocabularies */
|
|
6584
|
+
200: {
|
|
6585
|
+
headers: {
|
|
6586
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
6587
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
6588
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
6589
|
+
"X-RateLimit-Burst-Limit": components["headers"]["X-RateLimit-Burst-Limit"];
|
|
6590
|
+
"X-RateLimit-Burst-Remaining": components["headers"]["X-RateLimit-Burst-Remaining"];
|
|
6591
|
+
"X-RateLimit-Burst-Reset": components["headers"]["X-RateLimit-Burst-Reset"];
|
|
6592
|
+
[name: string]: unknown;
|
|
6593
|
+
};
|
|
6594
|
+
content: {
|
|
6595
|
+
"application/json": components["schemas"]["CatalogTaxonomiesResponse"];
|
|
6596
|
+
};
|
|
6597
|
+
};
|
|
6598
|
+
/** @description Authentication required */
|
|
6599
|
+
401: {
|
|
6600
|
+
headers: {
|
|
6601
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
6602
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
6603
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
6604
|
+
"X-RateLimit-Burst-Limit": components["headers"]["X-RateLimit-Burst-Limit"];
|
|
6605
|
+
"X-RateLimit-Burst-Remaining": components["headers"]["X-RateLimit-Burst-Remaining"];
|
|
6606
|
+
"X-RateLimit-Burst-Reset": components["headers"]["X-RateLimit-Burst-Reset"];
|
|
6607
|
+
[name: string]: unknown;
|
|
6608
|
+
};
|
|
6609
|
+
content: {
|
|
6610
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
6611
|
+
};
|
|
6612
|
+
};
|
|
6613
|
+
/** @description Insufficient entitlement (plan or role) */
|
|
6614
|
+
403: {
|
|
6615
|
+
headers: {
|
|
6616
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
6617
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
6618
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
6619
|
+
"X-RateLimit-Burst-Limit": components["headers"]["X-RateLimit-Burst-Limit"];
|
|
6620
|
+
"X-RateLimit-Burst-Remaining": components["headers"]["X-RateLimit-Burst-Remaining"];
|
|
6621
|
+
"X-RateLimit-Burst-Reset": components["headers"]["X-RateLimit-Burst-Reset"];
|
|
6622
|
+
[name: string]: unknown;
|
|
6623
|
+
};
|
|
6624
|
+
content: {
|
|
6625
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
6626
|
+
};
|
|
6627
|
+
};
|
|
6628
|
+
429: components["responses"]["ApiRateLimitExceeded"];
|
|
6629
|
+
};
|
|
6630
|
+
};
|
|
6631
|
+
put?: never;
|
|
6632
|
+
post?: never;
|
|
6633
|
+
delete?: never;
|
|
6634
|
+
options?: never;
|
|
6635
|
+
head?: never;
|
|
6636
|
+
patch?: never;
|
|
6637
|
+
trace?: never;
|
|
6638
|
+
};
|
|
6522
6639
|
"/v1/catalog/{id}/price-history": {
|
|
6523
6640
|
parameters: {
|
|
6524
6641
|
query?: never;
|
|
@@ -10020,7 +10137,7 @@ interface paths {
|
|
|
10020
10137
|
get?: never;
|
|
10021
10138
|
/**
|
|
10022
10139
|
* Replace an owner roast live curve
|
|
10023
|
-
* @description Atomically replace live temperature samples and all event markers, derive milestone and phase fields upstream, and preserve non-live temperature samples. Optional If-Match protects against lost updates.
|
|
10140
|
+
* @description Atomically replace live temperature samples and all event markers, derive milestone and phase fields upstream, and preserve non-live temperature samples. The fields are derived from milestone events named `charge`, `dry_end`, `fc_start`, `fc_end`, `sc_start`, `drop`, and `cool`; the older names `start`, `maillard`, and `end` are read as `charge`, `dry_end`, and `cool` when the current name is absent. Derived times count from CHARGE, or from the start of the recording when neither `charge` nor `start` is sent, in which case `charge_time` is null. A turning point is not derived. Optional If-Match protects against lost updates.
|
|
10024
10141
|
*/
|
|
10025
10142
|
put: {
|
|
10026
10143
|
parameters: {
|
|
@@ -14238,6 +14355,7 @@ interface components {
|
|
|
14238
14355
|
ReferenceProfileChart: {
|
|
14239
14356
|
/** @enum {string} */
|
|
14240
14357
|
temperatureUnit: "F" | "C";
|
|
14358
|
+
/** @description Where CHARGE sits on the chart's clock, in milliseconds since the recording started. Null when no CHARGE is marked. Subtract it from any chart time for time since CHARGE. */
|
|
14241
14359
|
chargeTimeMilliseconds: number | null;
|
|
14242
14360
|
series: {
|
|
14243
14361
|
id: string;
|
|
@@ -14248,11 +14366,13 @@ interface components {
|
|
|
14248
14366
|
deviceIndex: number | null;
|
|
14249
14367
|
channel: 1 | 2 | null;
|
|
14250
14368
|
points: {
|
|
14369
|
+
/** @description Milliseconds since the recording started. Subtract the chart's `chargeTimeMilliseconds` for time since CHARGE. */
|
|
14251
14370
|
timeMilliseconds: number;
|
|
14252
14371
|
value: number;
|
|
14253
14372
|
}[];
|
|
14254
14373
|
}[];
|
|
14255
14374
|
events: {
|
|
14375
|
+
/** @description Milliseconds since the recording started. Subtract the chart's `chargeTimeMilliseconds` for time since CHARGE. */
|
|
14256
14376
|
timeMilliseconds: number;
|
|
14257
14377
|
name: string;
|
|
14258
14378
|
value: string | null;
|
|
@@ -14287,7 +14407,9 @@ interface components {
|
|
|
14287
14407
|
temperatureAdjustments: {
|
|
14288
14408
|
/** @enum {string} */
|
|
14289
14409
|
kind: "bean_temperature" | "environmental_temperature";
|
|
14410
|
+
/** @description Start of the change on the parent chart's clock. Milliseconds since the recording started, as chart points are timed. For a time counted from CHARGE, add the chart's `chargeTimeMilliseconds`. */
|
|
14290
14411
|
startMilliseconds: number;
|
|
14412
|
+
/** @description End of the change on the parent chart's clock. Milliseconds since the recording started, as chart points are timed. For a time counted from CHARGE, add the chart's `chargeTimeMilliseconds`. */
|
|
14291
14413
|
endMilliseconds: number;
|
|
14292
14414
|
delta: number;
|
|
14293
14415
|
}[];
|
|
@@ -14307,10 +14429,12 @@ interface components {
|
|
|
14307
14429
|
unchangedZeroSampleCount: number;
|
|
14308
14430
|
parent: {
|
|
14309
14431
|
first: {
|
|
14432
|
+
/** @description Milliseconds since the recording started. Subtract the chart's `chargeTimeMilliseconds` for time since CHARGE. */
|
|
14310
14433
|
timeMilliseconds: number;
|
|
14311
14434
|
value: number;
|
|
14312
14435
|
} | null;
|
|
14313
14436
|
last: {
|
|
14437
|
+
/** @description Milliseconds since the recording started. Subtract the chart's `chargeTimeMilliseconds` for time since CHARGE. */
|
|
14314
14438
|
timeMilliseconds: number;
|
|
14315
14439
|
value: number;
|
|
14316
14440
|
} | null;
|
|
@@ -14319,10 +14443,12 @@ interface components {
|
|
|
14319
14443
|
};
|
|
14320
14444
|
planned: {
|
|
14321
14445
|
first: {
|
|
14446
|
+
/** @description Milliseconds since the recording started. Subtract the chart's `chargeTimeMilliseconds` for time since CHARGE. */
|
|
14322
14447
|
timeMilliseconds: number;
|
|
14323
14448
|
value: number;
|
|
14324
14449
|
} | null;
|
|
14325
14450
|
last: {
|
|
14451
|
+
/** @description Milliseconds since the recording started. Subtract the chart's `chargeTimeMilliseconds` for time since CHARGE. */
|
|
14326
14452
|
timeMilliseconds: number;
|
|
14327
14453
|
value: number;
|
|
14328
14454
|
} | null;
|
|
@@ -14356,7 +14482,9 @@ interface components {
|
|
|
14356
14482
|
temperatureAdjustments: {
|
|
14357
14483
|
/** @enum {string} */
|
|
14358
14484
|
kind: "bean_temperature" | "environmental_temperature";
|
|
14485
|
+
/** @description Start of the change on the parent chart's clock. Milliseconds since the recording started, as chart points are timed. For a time counted from CHARGE, add the chart's `chargeTimeMilliseconds`. */
|
|
14359
14486
|
startMilliseconds: number;
|
|
14487
|
+
/** @description End of the change on the parent chart's clock. Milliseconds since the recording started, as chart points are timed. For a time counted from CHARGE, add the chart's `chargeTimeMilliseconds`. */
|
|
14360
14488
|
endMilliseconds: number;
|
|
14361
14489
|
delta: number;
|
|
14362
14490
|
}[];
|
|
@@ -14451,7 +14579,9 @@ interface components {
|
|
|
14451
14579
|
temperatureAdjustments: {
|
|
14452
14580
|
/** @enum {string} */
|
|
14453
14581
|
kind: "bean_temperature" | "environmental_temperature";
|
|
14582
|
+
/** @description Start of the change on the parent chart's clock. Milliseconds since the recording started, as chart points are timed. For a time counted from CHARGE, add the chart's `chargeTimeMilliseconds`. */
|
|
14454
14583
|
startMilliseconds: number;
|
|
14584
|
+
/** @description End of the change on the parent chart's clock. Milliseconds since the recording started, as chart points are timed. For a time counted from CHARGE, add the chart's `chargeTimeMilliseconds`. */
|
|
14455
14585
|
endMilliseconds: number;
|
|
14456
14586
|
delta: number;
|
|
14457
14587
|
}[];
|
|
@@ -14471,10 +14601,12 @@ interface components {
|
|
|
14471
14601
|
unchangedZeroSampleCount: number;
|
|
14472
14602
|
parent: {
|
|
14473
14603
|
first: {
|
|
14604
|
+
/** @description Milliseconds since the recording started. Subtract the chart's `chargeTimeMilliseconds` for time since CHARGE. */
|
|
14474
14605
|
timeMilliseconds: number;
|
|
14475
14606
|
value: number;
|
|
14476
14607
|
} | null;
|
|
14477
14608
|
last: {
|
|
14609
|
+
/** @description Milliseconds since the recording started. Subtract the chart's `chargeTimeMilliseconds` for time since CHARGE. */
|
|
14478
14610
|
timeMilliseconds: number;
|
|
14479
14611
|
value: number;
|
|
14480
14612
|
} | null;
|
|
@@ -14483,10 +14615,12 @@ interface components {
|
|
|
14483
14615
|
};
|
|
14484
14616
|
planned: {
|
|
14485
14617
|
first: {
|
|
14618
|
+
/** @description Milliseconds since the recording started. Subtract the chart's `chargeTimeMilliseconds` for time since CHARGE. */
|
|
14486
14619
|
timeMilliseconds: number;
|
|
14487
14620
|
value: number;
|
|
14488
14621
|
} | null;
|
|
14489
14622
|
last: {
|
|
14623
|
+
/** @description Milliseconds since the recording started. Subtract the chart's `chargeTimeMilliseconds` for time since CHARGE. */
|
|
14490
14624
|
timeMilliseconds: number;
|
|
14491
14625
|
value: number;
|
|
14492
14626
|
} | null;
|
|
@@ -14552,6 +14686,7 @@ interface components {
|
|
|
14552
14686
|
kind: "bean_temperature" | "environmental_temperature" | "auxiliary";
|
|
14553
14687
|
unit: string;
|
|
14554
14688
|
points: {
|
|
14689
|
+
/** @description Milliseconds since CHARGE. */
|
|
14555
14690
|
timeMilliseconds: number;
|
|
14556
14691
|
left: number;
|
|
14557
14692
|
right: number;
|
|
@@ -14560,7 +14695,9 @@ interface components {
|
|
|
14560
14695
|
}[];
|
|
14561
14696
|
milestones: {
|
|
14562
14697
|
name: string;
|
|
14698
|
+
/** @description The left profile's milestone, in milliseconds since its CHARGE. */
|
|
14563
14699
|
leftMilliseconds: number;
|
|
14700
|
+
/** @description The right profile's milestone, in milliseconds since its CHARGE. */
|
|
14564
14701
|
rightMilliseconds: number;
|
|
14565
14702
|
deltaMilliseconds: number;
|
|
14566
14703
|
}[];
|
|
@@ -14987,6 +15124,28 @@ interface components {
|
|
|
14987
15124
|
protocol: "sca_2004" | "cva_affective" | "q_arabica" | "coe" | "supplier_unspecified" | null;
|
|
14988
15125
|
};
|
|
14989
15126
|
};
|
|
15127
|
+
/** @description ADR-018 canonical variety, species and drying values mapped from the supplier text, which stays in cultivar_detail and drying_method. Omitted when no stated value matched the vocabulary; nothing is inferred. */
|
|
15128
|
+
taxonomy?: {
|
|
15129
|
+
varieties: {
|
|
15130
|
+
code: string;
|
|
15131
|
+
label: string;
|
|
15132
|
+
/** @description Family this value belongs to, when it has one */
|
|
15133
|
+
parent_code: string | null;
|
|
15134
|
+
}[];
|
|
15135
|
+
species: {
|
|
15136
|
+
code: string;
|
|
15137
|
+
label: string;
|
|
15138
|
+
/** @description Family this value belongs to, when it has one */
|
|
15139
|
+
parent_code: string | null;
|
|
15140
|
+
}[];
|
|
15141
|
+
/** @description Returned where the projection includes drying_method */
|
|
15142
|
+
drying_methods?: {
|
|
15143
|
+
code: string;
|
|
15144
|
+
label: string;
|
|
15145
|
+
/** @description Family this value belongs to, when it has one */
|
|
15146
|
+
parent_code: string | null;
|
|
15147
|
+
}[];
|
|
15148
|
+
};
|
|
14990
15149
|
proof?: components["schemas"]["CatalogProofSummary"];
|
|
14991
15150
|
/** @description Entitled metadata-presence signals returned only by projection=summary; false also covers fields outside the caller projection. */
|
|
14992
15151
|
summarySignals?: {
|
|
@@ -15224,6 +15383,9 @@ interface components {
|
|
|
15224
15383
|
grade_preparation?: string[];
|
|
15225
15384
|
screen_size_min?: string[];
|
|
15226
15385
|
elevation_band?: string[];
|
|
15386
|
+
varieties?: string[];
|
|
15387
|
+
species_codes?: string[];
|
|
15388
|
+
drying_methods?: string[];
|
|
15227
15389
|
};
|
|
15228
15390
|
/** @description Counted facet values for CLI/agent use. Counts are computed after visibility and entitled query filters are applied. */
|
|
15229
15391
|
facets: {
|
|
@@ -15319,6 +15481,18 @@ interface components {
|
|
|
15319
15481
|
value: string;
|
|
15320
15482
|
count: number;
|
|
15321
15483
|
}[];
|
|
15484
|
+
varieties?: {
|
|
15485
|
+
value: string;
|
|
15486
|
+
count: number;
|
|
15487
|
+
}[];
|
|
15488
|
+
species_codes?: {
|
|
15489
|
+
value: string;
|
|
15490
|
+
count: number;
|
|
15491
|
+
}[];
|
|
15492
|
+
drying_methods?: {
|
|
15493
|
+
value: string;
|
|
15494
|
+
count: number;
|
|
15495
|
+
}[];
|
|
15322
15496
|
};
|
|
15323
15497
|
meta: {
|
|
15324
15498
|
/** @enum {string} */
|
|
@@ -16703,6 +16877,49 @@ interface components {
|
|
|
16703
16877
|
dimensions: ("size" | "altitude" | "defects" | "cup" | "preparation")[];
|
|
16704
16878
|
};
|
|
16705
16879
|
};
|
|
16880
|
+
VarietyEntry: {
|
|
16881
|
+
/** @example yellow_bourbon */
|
|
16882
|
+
code: string;
|
|
16883
|
+
/** @example Yellow Bourbon */
|
|
16884
|
+
label: string;
|
|
16885
|
+
/** @description Family this value belongs to. A family code matches itself and every descendant. */
|
|
16886
|
+
parent_code: string | null;
|
|
16887
|
+
description: string | null;
|
|
16888
|
+
active: boolean;
|
|
16889
|
+
sort_order: number;
|
|
16890
|
+
/** @description Normalized supplier spellings that map to this code. */
|
|
16891
|
+
aliases: string[];
|
|
16892
|
+
species_code: string | null;
|
|
16893
|
+
};
|
|
16894
|
+
TaxonomyEntry: {
|
|
16895
|
+
/** @example yellow_bourbon */
|
|
16896
|
+
code: string;
|
|
16897
|
+
/** @example Yellow Bourbon */
|
|
16898
|
+
label: string;
|
|
16899
|
+
/** @description Family this value belongs to. A family code matches itself and every descendant. */
|
|
16900
|
+
parent_code: string | null;
|
|
16901
|
+
description: string | null;
|
|
16902
|
+
active: boolean;
|
|
16903
|
+
sort_order: number;
|
|
16904
|
+
/** @description Normalized supplier spellings that map to this code. */
|
|
16905
|
+
aliases: string[];
|
|
16906
|
+
};
|
|
16907
|
+
CatalogTaxonomiesResponse: {
|
|
16908
|
+
data: {
|
|
16909
|
+
varieties: components["schemas"]["VarietyEntry"][];
|
|
16910
|
+
species: components["schemas"]["TaxonomyEntry"][];
|
|
16911
|
+
drying_methods: components["schemas"]["TaxonomyEntry"][];
|
|
16912
|
+
};
|
|
16913
|
+
meta: {
|
|
16914
|
+
/** @enum {string} */
|
|
16915
|
+
resource: "catalog-taxonomies";
|
|
16916
|
+
/** @enum {string} */
|
|
16917
|
+
namespace: "/v1/catalog/taxonomies";
|
|
16918
|
+
/** @enum {string} */
|
|
16919
|
+
version: "v1";
|
|
16920
|
+
taxonomies: ("variety" | "species" | "drying_method")[];
|
|
16921
|
+
};
|
|
16922
|
+
};
|
|
16706
16923
|
LotPriceHistoryResponse: {
|
|
16707
16924
|
data: {
|
|
16708
16925
|
catalogId: number;
|
|
@@ -17072,7 +17289,9 @@ interface components {
|
|
|
17072
17289
|
temperatureAdjustments: {
|
|
17073
17290
|
/** @enum {string} */
|
|
17074
17291
|
kind: "bean_temperature" | "environmental_temperature";
|
|
17292
|
+
/** @description Start of the change on the parent chart's clock. Milliseconds since the recording started, as chart points are timed. For a time counted from CHARGE, add the chart's `chargeTimeMilliseconds`. */
|
|
17075
17293
|
startMilliseconds: number;
|
|
17294
|
+
/** @description End of the change on the parent chart's clock. Milliseconds since the recording started, as chart points are timed. For a time counted from CHARGE, add the chart's `chargeTimeMilliseconds`. */
|
|
17076
17295
|
endMilliseconds: number;
|
|
17077
17296
|
delta: number;
|
|
17078
17297
|
}[];
|
|
@@ -17603,6 +17822,7 @@ interface components {
|
|
|
17603
17822
|
};
|
|
17604
17823
|
RoastTemperature: {
|
|
17605
17824
|
roast_id: number;
|
|
17825
|
+
/** @description Seconds since the recording started, the clock the curve is sampled on. Subtract the roast's `charge_time` for time since CHARGE. */
|
|
17606
17826
|
time_seconds: number;
|
|
17607
17827
|
bean_temp: number | null;
|
|
17608
17828
|
environmental_temp: number | null;
|
|
@@ -17612,6 +17832,7 @@ interface components {
|
|
|
17612
17832
|
};
|
|
17613
17833
|
RoastEvent: {
|
|
17614
17834
|
roast_id: number;
|
|
17835
|
+
/** @description Seconds since the recording started, the clock the curve is sampled on. Subtract the roast's `charge_time` for time since CHARGE. */
|
|
17615
17836
|
time_seconds: number;
|
|
17616
17837
|
event_type: number | null;
|
|
17617
17838
|
event_value: string | null;
|
|
@@ -17636,25 +17857,34 @@ interface components {
|
|
|
17636
17857
|
roaster_type: string | null;
|
|
17637
17858
|
roaster_size: string | null;
|
|
17638
17859
|
temperature_unit: string | null;
|
|
17860
|
+
/** @description Roast length in seconds, from CHARGE to DROP. From the start of the recording when `charge_time` is null. */
|
|
17639
17861
|
total_roast_time: number | null;
|
|
17862
|
+
/** @description Development: first crack start to DROP, as a share of the time from CHARGE to DROP (`total_roast_time`), in percent. */
|
|
17640
17863
|
development_percent: number | null;
|
|
17641
17864
|
data_source: string | null;
|
|
17642
17865
|
last_updated: string;
|
|
17643
17866
|
roast_uuid: string | null;
|
|
17867
|
+
/** @description First crack start. Seconds since CHARGE. When `charge_time` is null the roast has no CHARGE marked and this counts from the start of the recording instead. */
|
|
17644
17868
|
fc_start_time: number | null;
|
|
17645
17869
|
fc_start_temp: number | null;
|
|
17870
|
+
/** @description First crack end. Seconds since CHARGE. When `charge_time` is null the roast has no CHARGE marked and this counts from the start of the recording instead. */
|
|
17646
17871
|
fc_end_time: number | null;
|
|
17647
17872
|
fc_end_temp: number | null;
|
|
17873
|
+
/** @description DROP. Seconds since CHARGE. When `charge_time` is null the roast has no CHARGE marked and this counts from the start of the recording instead. */
|
|
17648
17874
|
drop_time: number | null;
|
|
17649
17875
|
drop_temp: number | null;
|
|
17650
17876
|
charge_temp: number | null;
|
|
17877
|
+
/** @description Where CHARGE sits on the recording clock: seconds from the start of the recording to CHARGE. Null when no CHARGE is marked. Every other roast time counts from this moment; add it to one of them to place it on the curve. */
|
|
17651
17878
|
charge_time: number | null;
|
|
17652
|
-
/** @description Drying-phase end
|
|
17879
|
+
/** @description Drying-phase end. Seconds since CHARGE. When `charge_time` is null the roast has no CHARGE marked and this counts from the start of the recording instead. */
|
|
17653
17880
|
dry_end_time: number | null;
|
|
17881
|
+
/** @description Turning point. Seconds since CHARGE. When `charge_time` is null the roast has no CHARGE marked and this counts from the start of the recording instead. */
|
|
17654
17882
|
tp_time: number | null;
|
|
17655
17883
|
tp_temp: number | null;
|
|
17656
17884
|
total_ror: number | null;
|
|
17885
|
+
/** @description Drying: CHARGE to drying-phase end, as a share of the time from CHARGE to DROP (`total_roast_time`), in percent. */
|
|
17657
17886
|
dry_percent: number | null;
|
|
17887
|
+
/** @description Maillard: drying-phase end to first crack start, as a share of the time from CHARGE to DROP (`total_roast_time`), in percent. */
|
|
17658
17888
|
maillard_percent: number | null;
|
|
17659
17889
|
auc: number | null;
|
|
17660
17890
|
dry_phase_ror: number | null;
|
|
@@ -17687,6 +17917,7 @@ interface components {
|
|
|
17687
17917
|
};
|
|
17688
17918
|
};
|
|
17689
17919
|
RoastTemperatureInput: {
|
|
17920
|
+
/** @description Seconds since the recording started. */
|
|
17690
17921
|
timeSeconds: number;
|
|
17691
17922
|
beanTemp?: number | null;
|
|
17692
17923
|
environmentalTemp?: number | null;
|
|
@@ -17696,6 +17927,7 @@ interface components {
|
|
|
17696
17927
|
dataSource?: "live" | "artisan_import" | "manual";
|
|
17697
17928
|
};
|
|
17698
17929
|
RoastEventInput: {
|
|
17930
|
+
/** @description Seconds since the recording started, the same clock as the temperature samples. */
|
|
17699
17931
|
timeSeconds: number;
|
|
17700
17932
|
eventType?: number | null;
|
|
17701
17933
|
eventValue?: string | null;
|
|
@@ -17721,18 +17953,24 @@ interface components {
|
|
|
17721
17953
|
roasterSize?: string;
|
|
17722
17954
|
/** @enum {string} */
|
|
17723
17955
|
temperatureUnit?: "F" | "C";
|
|
17956
|
+
/** @description Roast length in seconds, from CHARGE to DROP. */
|
|
17724
17957
|
totalRoastTime?: number;
|
|
17725
17958
|
developmentPercent?: number;
|
|
17726
17959
|
dataSource?: string;
|
|
17727
17960
|
roastUuid?: string;
|
|
17961
|
+
/** @description First crack start, in seconds since CHARGE. */
|
|
17728
17962
|
fcStartTime?: number;
|
|
17729
17963
|
fcStartTemp?: number;
|
|
17964
|
+
/** @description First crack end, in seconds since CHARGE. */
|
|
17730
17965
|
fcEndTime?: number;
|
|
17731
17966
|
fcEndTemp?: number;
|
|
17967
|
+
/** @description DROP, in seconds since CHARGE. */
|
|
17732
17968
|
dropTime?: number;
|
|
17733
17969
|
dropTemp?: number;
|
|
17734
17970
|
chargeTemp?: number;
|
|
17971
|
+
/** @description Where CHARGE sits on the recording clock: seconds from the start of the recording to CHARGE. Every other roast time counts from it. */
|
|
17735
17972
|
chargeTime?: number;
|
|
17973
|
+
/** @description Turning point, in seconds since CHARGE. */
|
|
17736
17974
|
tpTime?: number;
|
|
17737
17975
|
tpTemp?: number;
|
|
17738
17976
|
totalRor?: number;
|
|
@@ -17794,18 +18032,24 @@ interface components {
|
|
|
17794
18032
|
roasterSize?: string;
|
|
17795
18033
|
/** @enum {string} */
|
|
17796
18034
|
temperatureUnit?: "F" | "C";
|
|
18035
|
+
/** @description Roast length in seconds, from CHARGE to DROP. */
|
|
17797
18036
|
totalRoastTime?: number;
|
|
17798
18037
|
developmentPercent?: number;
|
|
17799
18038
|
dataSource?: string;
|
|
17800
18039
|
roastUuid?: string;
|
|
18040
|
+
/** @description First crack start, in seconds since CHARGE. */
|
|
17801
18041
|
fcStartTime?: number;
|
|
17802
18042
|
fcStartTemp?: number;
|
|
18043
|
+
/** @description First crack end, in seconds since CHARGE. */
|
|
17803
18044
|
fcEndTime?: number;
|
|
17804
18045
|
fcEndTemp?: number;
|
|
18046
|
+
/** @description DROP, in seconds since CHARGE. */
|
|
17805
18047
|
dropTime?: number;
|
|
17806
18048
|
dropTemp?: number;
|
|
17807
18049
|
chargeTemp?: number;
|
|
18050
|
+
/** @description Where CHARGE sits on the recording clock: seconds from the start of the recording to CHARGE. Every other roast time counts from it. */
|
|
17808
18051
|
chargeTime?: number;
|
|
18052
|
+
/** @description Turning point, in seconds since CHARGE. */
|
|
17809
18053
|
tpTime?: number;
|
|
17810
18054
|
tpTemp?: number;
|
|
17811
18055
|
totalRor?: number;
|
|
@@ -18023,25 +18267,34 @@ interface components {
|
|
|
18023
18267
|
roaster_type: string | null;
|
|
18024
18268
|
roaster_size: string | null;
|
|
18025
18269
|
temperature_unit: string | null;
|
|
18270
|
+
/** @description Roast length in seconds, from CHARGE to DROP. From the start of the recording when `charge_time` is null. */
|
|
18026
18271
|
total_roast_time: number | null;
|
|
18272
|
+
/** @description Development: first crack start to DROP, as a share of the time from CHARGE to DROP (`total_roast_time`), in percent. */
|
|
18027
18273
|
development_percent: number | null;
|
|
18028
18274
|
data_source: string | null;
|
|
18029
18275
|
last_updated: string;
|
|
18030
18276
|
roast_uuid: string | null;
|
|
18277
|
+
/** @description First crack start. Seconds since CHARGE. When `charge_time` is null the roast has no CHARGE marked and this counts from the start of the recording instead. */
|
|
18031
18278
|
fc_start_time: number | null;
|
|
18032
18279
|
fc_start_temp: number | null;
|
|
18280
|
+
/** @description First crack end. Seconds since CHARGE. When `charge_time` is null the roast has no CHARGE marked and this counts from the start of the recording instead. */
|
|
18033
18281
|
fc_end_time: number | null;
|
|
18034
18282
|
fc_end_temp: number | null;
|
|
18283
|
+
/** @description DROP. Seconds since CHARGE. When `charge_time` is null the roast has no CHARGE marked and this counts from the start of the recording instead. */
|
|
18035
18284
|
drop_time: number | null;
|
|
18036
18285
|
drop_temp: number | null;
|
|
18037
18286
|
charge_temp: number | null;
|
|
18287
|
+
/** @description Where CHARGE sits on the recording clock: seconds from the start of the recording to CHARGE. Null when no CHARGE is marked. Every other roast time counts from this moment; add it to one of them to place it on the curve. */
|
|
18038
18288
|
charge_time: number | null;
|
|
18039
|
-
/** @description Drying-phase end
|
|
18289
|
+
/** @description Drying-phase end. Seconds since CHARGE. When `charge_time` is null the roast has no CHARGE marked and this counts from the start of the recording instead. */
|
|
18040
18290
|
dry_end_time: number | null;
|
|
18291
|
+
/** @description Turning point. Seconds since CHARGE. When `charge_time` is null the roast has no CHARGE marked and this counts from the start of the recording instead. */
|
|
18041
18292
|
tp_time: number | null;
|
|
18042
18293
|
tp_temp: number | null;
|
|
18043
18294
|
total_ror: number | null;
|
|
18295
|
+
/** @description Drying: CHARGE to drying-phase end, as a share of the time from CHARGE to DROP (`total_roast_time`), in percent. */
|
|
18044
18296
|
dry_percent: number | null;
|
|
18297
|
+
/** @description Maillard: drying-phase end to first crack start, as a share of the time from CHARGE to DROP (`total_roast_time`), in percent. */
|
|
18045
18298
|
maillard_percent: number | null;
|
|
18046
18299
|
auc: number | null;
|
|
18047
18300
|
dry_phase_ror: number | null;
|
|
@@ -18139,6 +18392,7 @@ interface components {
|
|
|
18139
18392
|
};
|
|
18140
18393
|
RoastChartPoint: {
|
|
18141
18394
|
data_type: string;
|
|
18395
|
+
/** @description Milliseconds since the recording started, the clock the curve is sampled on. Subtract `metadata.charge_time_ms` for time since CHARGE. */
|
|
18142
18396
|
time_milliseconds: number;
|
|
18143
18397
|
field_name: string;
|
|
18144
18398
|
value_numeric: number;
|
|
@@ -18147,6 +18401,7 @@ interface components {
|
|
|
18147
18401
|
subcategory: string;
|
|
18148
18402
|
};
|
|
18149
18403
|
RoastChartSeriesPoint: {
|
|
18404
|
+
/** @description Milliseconds since the recording started, the clock the curve is sampled on. Subtract `metadata.charge_time_ms` for time since CHARGE. */
|
|
18150
18405
|
time_milliseconds: number;
|
|
18151
18406
|
value_numeric: number;
|
|
18152
18407
|
};
|
|
@@ -18163,6 +18418,7 @@ interface components {
|
|
|
18163
18418
|
points: components["schemas"]["RoastChartSeriesPoint"][];
|
|
18164
18419
|
};
|
|
18165
18420
|
RoastChartEvent: {
|
|
18421
|
+
/** @description Milliseconds since the recording started, the clock the curve is sampled on. Subtract `metadata.charge_time_ms` for time since CHARGE. */
|
|
18166
18422
|
time_milliseconds: number;
|
|
18167
18423
|
name: string;
|
|
18168
18424
|
value: string | null;
|
|
@@ -18182,6 +18438,7 @@ interface components {
|
|
|
18182
18438
|
temp_max: number | null;
|
|
18183
18439
|
ror_min: number | null;
|
|
18184
18440
|
ror_max: number | null;
|
|
18441
|
+
/** @description Where CHARGE sits on the recording clock, in milliseconds. Null when no CHARGE is marked. Subtract it from any chart time for time since CHARGE. */
|
|
18185
18442
|
charge_time_ms: number | null;
|
|
18186
18443
|
temperature_unit: string | null;
|
|
18187
18444
|
profile_schema_version: number | null;
|
|
@@ -18803,6 +19060,8 @@ type CatalogSimilarQuery = NonNullable<paths["/v1/catalog/{id}/similar"]["get"][
|
|
|
18803
19060
|
type CatalogCompareQuery = NonNullable<paths["/v1/catalog/compare"]["get"]["parameters"]["query"]>;
|
|
18804
19061
|
/** Query parameters for {@link ParchmentClient.catalog.grades}. */
|
|
18805
19062
|
type CatalogGradesQuery = NonNullable<paths["/v1/catalog/grades"]["get"]["parameters"]["query"]>;
|
|
19063
|
+
/** Query parameters for {@link ParchmentClient.catalog.taxonomies}. */
|
|
19064
|
+
type CatalogTaxonomiesQuery = NonNullable<paths["/v1/catalog/taxonomies"]["get"]["parameters"]["query"]>;
|
|
18806
19065
|
/** Query parameters for {@link ParchmentClient.catalog.priceHistory}. */
|
|
18807
19066
|
type CatalogPriceHistoryQuery = NonNullable<paths["/v1/catalog/{id}/price-history"]["get"]["parameters"]["query"]>;
|
|
18808
19067
|
/** Query parameters for {@link ParchmentClient.priceIndex.list}. */
|
|
@@ -21418,6 +21677,9 @@ declare function createParchmentClient(options: ParchmentClientOptions): {
|
|
|
21418
21677
|
has_additives?: "true" | "false";
|
|
21419
21678
|
processing_disclosure_level?: string;
|
|
21420
21679
|
processing_confidence_min?: number | null;
|
|
21680
|
+
varietyCode?: string | string[];
|
|
21681
|
+
speciesCode?: string | string[];
|
|
21682
|
+
dryingMethodCode?: string | string[];
|
|
21421
21683
|
};
|
|
21422
21684
|
header?: {
|
|
21423
21685
|
Prefer?: string;
|
|
@@ -21441,6 +21703,20 @@ declare function createParchmentClient(options: ParchmentClientOptions): {
|
|
|
21441
21703
|
"application/json": components["schemas"]["CatalogListResponse"];
|
|
21442
21704
|
};
|
|
21443
21705
|
};
|
|
21706
|
+
400: {
|
|
21707
|
+
headers: {
|
|
21708
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
21709
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
21710
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
21711
|
+
"X-RateLimit-Burst-Limit": components["headers"]["X-RateLimit-Burst-Limit"];
|
|
21712
|
+
"X-RateLimit-Burst-Remaining": components["headers"]["X-RateLimit-Burst-Remaining"];
|
|
21713
|
+
"X-RateLimit-Burst-Reset": components["headers"]["X-RateLimit-Burst-Reset"];
|
|
21714
|
+
[name: string]: unknown;
|
|
21715
|
+
};
|
|
21716
|
+
content: {
|
|
21717
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
21718
|
+
};
|
|
21719
|
+
};
|
|
21444
21720
|
401: {
|
|
21445
21721
|
headers: {
|
|
21446
21722
|
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
@@ -21525,6 +21801,9 @@ declare function createParchmentClient(options: ParchmentClientOptions): {
|
|
|
21525
21801
|
has_additives?: "true" | "false";
|
|
21526
21802
|
processing_disclosure_level?: string;
|
|
21527
21803
|
processing_confidence_min?: number | null;
|
|
21804
|
+
varietyCode?: string | string[];
|
|
21805
|
+
speciesCode?: string | string[];
|
|
21806
|
+
dryingMethodCode?: string | string[];
|
|
21528
21807
|
} | undefined;
|
|
21529
21808
|
header: {
|
|
21530
21809
|
Prefer?: string;
|
|
@@ -21580,6 +21859,9 @@ declare function createParchmentClient(options: ParchmentClientOptions): {
|
|
|
21580
21859
|
has_additives?: "true" | "false";
|
|
21581
21860
|
processing_disclosure_level?: string;
|
|
21582
21861
|
processing_confidence_min?: number | null;
|
|
21862
|
+
varietyCode?: string | string[];
|
|
21863
|
+
speciesCode?: string | string[];
|
|
21864
|
+
dryingMethodCode?: string | string[];
|
|
21583
21865
|
place_id?: string;
|
|
21584
21866
|
bbox?: string;
|
|
21585
21867
|
zoom?: number;
|
|
@@ -21714,6 +21996,9 @@ declare function createParchmentClient(options: ParchmentClientOptions): {
|
|
|
21714
21996
|
has_additives?: "true" | "false";
|
|
21715
21997
|
processing_disclosure_level?: string;
|
|
21716
21998
|
processing_confidence_min?: number | null;
|
|
21999
|
+
varietyCode?: string | string[];
|
|
22000
|
+
speciesCode?: string | string[];
|
|
22001
|
+
dryingMethodCode?: string | string[];
|
|
21717
22002
|
place_id?: string;
|
|
21718
22003
|
bbox?: string;
|
|
21719
22004
|
zoom?: number;
|
|
@@ -21732,7 +22017,7 @@ declare function createParchmentClient(options: ParchmentClientOptions): {
|
|
|
21732
22017
|
facets: (query?: CatalogFacetsQuery, headers?: CatalogFacetsHeaders) => Promise<openapi_fetch.FetchResponse<{
|
|
21733
22018
|
parameters: {
|
|
21734
22019
|
query?: {
|
|
21735
|
-
include?: "grading";
|
|
22020
|
+
include?: ("grading" | "taxonomy" | "grading,taxonomy" | "taxonomy,grading") | ("grading" | "taxonomy" | "grading,taxonomy" | "taxonomy,grading")[];
|
|
21736
22021
|
stocked?: "true" | "false" | "all";
|
|
21737
22022
|
showWholesale?: "true" | "false";
|
|
21738
22023
|
wholesaleOnly?: "true" | "false";
|
|
@@ -21772,6 +22057,9 @@ declare function createParchmentClient(options: ParchmentClientOptions): {
|
|
|
21772
22057
|
waterActivityMax?: number | null;
|
|
21773
22058
|
densityMin?: number | null;
|
|
21774
22059
|
scoreProtocol?: "sca_2004" | "cva_affective" | "q_arabica" | "coe" | "supplier_unspecified";
|
|
22060
|
+
varietyCode?: string | string[];
|
|
22061
|
+
speciesCode?: string | string[];
|
|
22062
|
+
dryingMethodCode?: string | string[];
|
|
21775
22063
|
processing_base_method?: string;
|
|
21776
22064
|
fermentation_type?: string;
|
|
21777
22065
|
process_additive?: string;
|
|
@@ -21801,6 +22089,20 @@ declare function createParchmentClient(options: ParchmentClientOptions): {
|
|
|
21801
22089
|
"application/json": components["schemas"]["CatalogFacetsResponse"];
|
|
21802
22090
|
};
|
|
21803
22091
|
};
|
|
22092
|
+
400: {
|
|
22093
|
+
headers: {
|
|
22094
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
22095
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
22096
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
22097
|
+
"X-RateLimit-Burst-Limit": components["headers"]["X-RateLimit-Burst-Limit"];
|
|
22098
|
+
"X-RateLimit-Burst-Remaining": components["headers"]["X-RateLimit-Burst-Remaining"];
|
|
22099
|
+
"X-RateLimit-Burst-Reset": components["headers"]["X-RateLimit-Burst-Reset"];
|
|
22100
|
+
[name: string]: unknown;
|
|
22101
|
+
};
|
|
22102
|
+
content: {
|
|
22103
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
22104
|
+
};
|
|
22105
|
+
};
|
|
21804
22106
|
401: {
|
|
21805
22107
|
headers: {
|
|
21806
22108
|
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
@@ -21834,7 +22136,7 @@ declare function createParchmentClient(options: ParchmentClientOptions): {
|
|
|
21834
22136
|
}, {
|
|
21835
22137
|
params: {
|
|
21836
22138
|
query: {
|
|
21837
|
-
include?: "grading";
|
|
22139
|
+
include?: ("grading" | "taxonomy" | "grading,taxonomy" | "taxonomy,grading") | ("grading" | "taxonomy" | "grading,taxonomy" | "taxonomy,grading")[];
|
|
21838
22140
|
stocked?: "true" | "false" | "all";
|
|
21839
22141
|
showWholesale?: "true" | "false";
|
|
21840
22142
|
wholesaleOnly?: "true" | "false";
|
|
@@ -21874,6 +22176,9 @@ declare function createParchmentClient(options: ParchmentClientOptions): {
|
|
|
21874
22176
|
waterActivityMax?: number | null;
|
|
21875
22177
|
densityMin?: number | null;
|
|
21876
22178
|
scoreProtocol?: "sca_2004" | "cva_affective" | "q_arabica" | "coe" | "supplier_unspecified";
|
|
22179
|
+
varietyCode?: string | string[];
|
|
22180
|
+
speciesCode?: string | string[];
|
|
22181
|
+
dryingMethodCode?: string | string[];
|
|
21877
22182
|
processing_base_method?: string;
|
|
21878
22183
|
fermentation_type?: string;
|
|
21879
22184
|
process_additive?: string;
|
|
@@ -22916,6 +23221,69 @@ declare function createParchmentClient(options: ParchmentClientOptions): {
|
|
|
22916
23221
|
} | undefined;
|
|
22917
23222
|
};
|
|
22918
23223
|
}, `${string}/${string}`>>;
|
|
23224
|
+
/** Variety, species, and drying-method vocabularies with aliases and family links. */
|
|
23225
|
+
taxonomies: (query?: CatalogTaxonomiesQuery) => Promise<openapi_fetch.FetchResponse<{
|
|
23226
|
+
parameters: {
|
|
23227
|
+
query?: {
|
|
23228
|
+
includeRetired?: "true" | "false";
|
|
23229
|
+
};
|
|
23230
|
+
header?: never;
|
|
23231
|
+
path?: never;
|
|
23232
|
+
cookie?: never;
|
|
23233
|
+
};
|
|
23234
|
+
requestBody?: never;
|
|
23235
|
+
responses: {
|
|
23236
|
+
200: {
|
|
23237
|
+
headers: {
|
|
23238
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
23239
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
23240
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
23241
|
+
"X-RateLimit-Burst-Limit": components["headers"]["X-RateLimit-Burst-Limit"];
|
|
23242
|
+
"X-RateLimit-Burst-Remaining": components["headers"]["X-RateLimit-Burst-Remaining"];
|
|
23243
|
+
"X-RateLimit-Burst-Reset": components["headers"]["X-RateLimit-Burst-Reset"];
|
|
23244
|
+
[name: string]: unknown;
|
|
23245
|
+
};
|
|
23246
|
+
content: {
|
|
23247
|
+
"application/json": components["schemas"]["CatalogTaxonomiesResponse"];
|
|
23248
|
+
};
|
|
23249
|
+
};
|
|
23250
|
+
401: {
|
|
23251
|
+
headers: {
|
|
23252
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
23253
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
23254
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
23255
|
+
"X-RateLimit-Burst-Limit": components["headers"]["X-RateLimit-Burst-Limit"];
|
|
23256
|
+
"X-RateLimit-Burst-Remaining": components["headers"]["X-RateLimit-Burst-Remaining"];
|
|
23257
|
+
"X-RateLimit-Burst-Reset": components["headers"]["X-RateLimit-Burst-Reset"];
|
|
23258
|
+
[name: string]: unknown;
|
|
23259
|
+
};
|
|
23260
|
+
content: {
|
|
23261
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
23262
|
+
};
|
|
23263
|
+
};
|
|
23264
|
+
403: {
|
|
23265
|
+
headers: {
|
|
23266
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
23267
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
23268
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
23269
|
+
"X-RateLimit-Burst-Limit": components["headers"]["X-RateLimit-Burst-Limit"];
|
|
23270
|
+
"X-RateLimit-Burst-Remaining": components["headers"]["X-RateLimit-Burst-Remaining"];
|
|
23271
|
+
"X-RateLimit-Burst-Reset": components["headers"]["X-RateLimit-Burst-Reset"];
|
|
23272
|
+
[name: string]: unknown;
|
|
23273
|
+
};
|
|
23274
|
+
content: {
|
|
23275
|
+
"application/json": components["schemas"]["ErrorResponse"];
|
|
23276
|
+
};
|
|
23277
|
+
};
|
|
23278
|
+
429: components["responses"]["ApiRateLimitExceeded"];
|
|
23279
|
+
};
|
|
23280
|
+
}, {
|
|
23281
|
+
params: {
|
|
23282
|
+
query: {
|
|
23283
|
+
includeRetired?: "true" | "false";
|
|
23284
|
+
} | undefined;
|
|
23285
|
+
};
|
|
23286
|
+
}, `${string}/${string}`>>;
|
|
22919
23287
|
};
|
|
22920
23288
|
priceIndex: {
|
|
22921
23289
|
/** Available exact 30-day comparisons, with no empty-origin search. */
|
|
@@ -30397,9 +30765,7 @@ declare function createParchmentClient(options: ParchmentClientOptions): {
|
|
|
30397
30765
|
"application/json": components["schemas"]["ErrorResponse"];
|
|
30398
30766
|
};
|
|
30399
30767
|
};
|
|
30400
|
-
429:
|
|
30401
|
-
/** Closed session-only command for {@link ParchmentClient.confirmedActions.execute}. */
|
|
30402
|
-
components["responses"]["ApiRateLimitExceeded"];
|
|
30768
|
+
429: components["responses"]["ApiRateLimitExceeded"];
|
|
30403
30769
|
};
|
|
30404
30770
|
}, {
|
|
30405
30771
|
params: {
|
|
@@ -30530,7 +30896,9 @@ declare function createParchmentClient(options: ParchmentClientOptions): {
|
|
|
30530
30896
|
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
30531
30897
|
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
30532
30898
|
"X-RateLimit-Burst-Limit": components["headers"]["X-RateLimit-Burst-Limit"];
|
|
30533
|
-
"X-RateLimit-Burst-Remaining":
|
|
30899
|
+
"X-RateLimit-Burst-Remaining":
|
|
30900
|
+
/** Create a signed, short-lived login request bound to a PKCE challenge. */
|
|
30901
|
+
components["headers"]["X-RateLimit-Burst-Remaining"];
|
|
30534
30902
|
"X-RateLimit-Burst-Reset": components["headers"]["X-RateLimit-Burst-Reset"];
|
|
30535
30903
|
[name: string]: unknown;
|
|
30536
30904
|
};
|
|
@@ -30597,9 +30965,7 @@ declare function createParchmentClient(options: ParchmentClientOptions): {
|
|
|
30597
30965
|
409: {
|
|
30598
30966
|
headers: {
|
|
30599
30967
|
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
30600
|
-
"X-RateLimit-Remaining":
|
|
30601
|
-
/** Available exact 30-day comparisons, with no empty-origin search. */
|
|
30602
|
-
components["headers"]["X-RateLimit-Remaining"];
|
|
30968
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
30603
30969
|
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
30604
30970
|
"X-RateLimit-Burst-Limit": components["headers"]["X-RateLimit-Burst-Limit"];
|
|
30605
30971
|
"X-RateLimit-Burst-Remaining": components["headers"]["X-RateLimit-Burst-Remaining"];
|
|
@@ -30629,7 +30995,7 @@ declare function createParchmentClient(options: ParchmentClientOptions): {
|
|
|
30629
30995
|
id: string;
|
|
30630
30996
|
revisionId: string;
|
|
30631
30997
|
};
|
|
30632
|
-
cookie
|
|
30998
|
+
cookie?: never;
|
|
30633
30999
|
};
|
|
30634
31000
|
requestBody: {
|
|
30635
31001
|
content: {
|
|
@@ -31488,7 +31854,9 @@ declare function createParchmentClient(options: ParchmentClientOptions): {
|
|
|
31488
31854
|
403: {
|
|
31489
31855
|
headers: {
|
|
31490
31856
|
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
31491
|
-
"X-RateLimit-Remaining":
|
|
31857
|
+
"X-RateLimit-Remaining":
|
|
31858
|
+
/** Revoke an API key owned by the authenticated session user. */
|
|
31859
|
+
components["headers"]["X-RateLimit-Remaining"];
|
|
31492
31860
|
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
31493
31861
|
"X-RateLimit-Burst-Limit": components["headers"]["X-RateLimit-Burst-Limit"];
|
|
31494
31862
|
"X-RateLimit-Burst-Remaining": components["headers"]["X-RateLimit-Burst-Remaining"];
|
|
@@ -31599,7 +31967,9 @@ declare function createParchmentClient(options: ParchmentClientOptions): {
|
|
|
31599
31967
|
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
31600
31968
|
"X-RateLimit-Burst-Limit": components["headers"]["X-RateLimit-Burst-Limit"];
|
|
31601
31969
|
"X-RateLimit-Burst-Remaining": components["headers"]["X-RateLimit-Burst-Remaining"];
|
|
31602
|
-
"X-RateLimit-Burst-Reset":
|
|
31970
|
+
"X-RateLimit-Burst-Reset":
|
|
31971
|
+
/** Query parameters for {@link ParchmentClient.tasting.get}. */
|
|
31972
|
+
components["headers"]["X-RateLimit-Burst-Reset"];
|
|
31603
31973
|
[name: string]: unknown;
|
|
31604
31974
|
};
|
|
31605
31975
|
content: {
|
|
@@ -32793,7 +33163,7 @@ type ParchmentClientMethod = MethodPaths<Omit<ParchmentClient, "raw">>;
|
|
|
32793
33163
|
* SDK (such as the CLI) can import this list to prove they cover everything
|
|
32794
33164
|
* the web agent can do.
|
|
32795
33165
|
*/
|
|
32796
|
-
declare const CHAT_AGENT_CAPABILITIES: readonly ["me", "catalog.list", "catalog.facets", "catalog.rank", "catalog.suppliers", "catalog.similar", "catalog.compare", "catalog.grades", "catalog.priceHistory", "inventory.list", "roasts.list", "roasts.get", "roasts.chartData", "referenceProfiles.list", "referenceProfiles.get", "referenceProfiles.chart", "referenceProfiles.compare", "referenceProfiles.preview", "referenceProfiles.roastCandidates", "referenceProfiles.previewFromRoast", "tasting.get", "priceIndex.list", "priceIndex.stats", "priceIndex.comparisons", "priceIndex.comparison", "priceIndex.history", "market.signals", "market.metadataIndex", "market.overview", "market.evidence"];
|
|
33166
|
+
declare const CHAT_AGENT_CAPABILITIES: readonly ["me", "catalog.list", "catalog.facets", "catalog.rank", "catalog.suppliers", "catalog.similar", "catalog.compare", "catalog.grades", "catalog.taxonomies", "catalog.priceHistory", "inventory.list", "roasts.list", "roasts.get", "roasts.chartData", "referenceProfiles.list", "referenceProfiles.get", "referenceProfiles.chart", "referenceProfiles.compare", "referenceProfiles.preview", "referenceProfiles.roastCandidates", "referenceProfiles.previewFromRoast", "tasting.get", "priceIndex.list", "priceIndex.stats", "priceIndex.comparisons", "priceIndex.comparison", "priceIndex.history", "market.signals", "market.metadataIndex", "market.overview", "market.evidence"];
|
|
32797
33167
|
type ChatAgentCapability = (typeof CHAT_AGENT_CAPABILITIES)[number];
|
|
32798
33168
|
/**
|
|
32799
33169
|
* Writes the web agent can propose. The agent never writes directly: it
|
|
@@ -32838,4 +33208,4 @@ type PickPaths<T, P extends string> = {
|
|
|
32838
33208
|
};
|
|
32839
33209
|
type ChatAgentClient = PickPaths<ParchmentClient, ChatAgentCapability>;
|
|
32840
33210
|
|
|
32841
|
-
export { type AccountDeletionOperation, type AccountDeletionRequest, type BillingCheckoutCreateRequest, type BillingCheckoutSession, type BillingManualEntitlementsRequest, type BillingSubscriptionMutationRequest, type BillingSubscriptionOperation, type BriefMatchesQuery, CHAT_AGENT_CAPABILITIES, CHAT_AGENT_CAPABILITY_EXCLUSIONS, CHAT_AGENT_CONFIRMED_ACTION_TYPES, type CatalogCompareQuery, type CatalogGradesQuery, type CatalogInventoryBatchLifecycle, type CatalogInventoryBatchReserveRequest, type CatalogInventoryBatchResult, type CatalogItem, type CatalogListQuery, type CatalogMapHeaders, type CatalogMapQuery, type CatalogMapResponse, type CatalogPriceHistoryQuery, type CatalogProofSummary, type CatalogSimilarQuery, type ChatAgentCapability, type ChatAgentCapabilityExclusion, type ChatAgentCapabilityExclusionReason, type ChatAgentClient, type ChatAgentConfirmedActionType, type ConfirmedActionExecuteRequest, type ConversationCanvasUpdateRequest, type ConversationChatStreamRequest, type ConversationMemoryDreamRequest, type ConversationMemoryUpdateRequest, type ConversationMessageAppendRequest, type ConversationSummaryUpdateRequest, type ConversationWorkspaceClearRequest, type ConversationWorkspaceCreateRequest, type ConversationWorkspaceMetadataRequest, type InventoryCreateRequest, type InventoryShareCatalog, type InventoryShareGrant, type InventoryShareGrantCreateRequest, type InventoryShareGrantRedeemRequest, type InventoryShareInventory, type InventoryShareRoastSummary, type InventoryUpdateRequest, type MarketOverview, type MarketSignalsQuery, type MetadataIndexQuery, type OwnerApiUsage, type OwnerApiUsageQuery, type ParchmentClient, type ParchmentClientMethod, type ParchmentClientOptions, type PriceIndexQuery, type PriceIndexStatsQuery, type ProfitItem, type ProfitListQuery, type RoastBatchCreateRequest, type RoastChartData, type RoastChartDataQuery, type RoastChartEvent, type RoastChartSeries, type RoastLiveCurveRequest, type SalesCreateRequest, type SalesListQuery, type SalesUpdateRequest, type SourcingBriefCreateRequest, type TrackedLotMutation, type TrackedLotSummary, type TrackedLotsListQuery, type components, createParchmentClient, type paths };
|
|
33211
|
+
export { type AccountDeletionOperation, type AccountDeletionRequest, type BillingCheckoutCreateRequest, type BillingCheckoutSession, type BillingManualEntitlementsRequest, type BillingSubscriptionMutationRequest, type BillingSubscriptionOperation, type BriefMatchesQuery, CHAT_AGENT_CAPABILITIES, CHAT_AGENT_CAPABILITY_EXCLUSIONS, CHAT_AGENT_CONFIRMED_ACTION_TYPES, type CatalogCompareQuery, type CatalogGradesQuery, type CatalogInventoryBatchLifecycle, type CatalogInventoryBatchReserveRequest, type CatalogInventoryBatchResult, type CatalogItem, type CatalogListQuery, type CatalogMapHeaders, type CatalogMapQuery, type CatalogMapResponse, type CatalogPriceHistoryQuery, type CatalogProofSummary, type CatalogSimilarQuery, type CatalogTaxonomiesQuery, type ChatAgentCapability, type ChatAgentCapabilityExclusion, type ChatAgentCapabilityExclusionReason, type ChatAgentClient, type ChatAgentConfirmedActionType, type ConfirmedActionExecuteRequest, type ConversationCanvasUpdateRequest, type ConversationChatStreamRequest, type ConversationMemoryDreamRequest, type ConversationMemoryUpdateRequest, type ConversationMessageAppendRequest, type ConversationSummaryUpdateRequest, type ConversationWorkspaceClearRequest, type ConversationWorkspaceCreateRequest, type ConversationWorkspaceMetadataRequest, type InventoryCreateRequest, type InventoryShareCatalog, type InventoryShareGrant, type InventoryShareGrantCreateRequest, type InventoryShareGrantRedeemRequest, type InventoryShareInventory, type InventoryShareRoastSummary, type InventoryUpdateRequest, type MarketOverview, type MarketSignalsQuery, type MetadataIndexQuery, type OwnerApiUsage, type OwnerApiUsageQuery, type ParchmentClient, type ParchmentClientMethod, type ParchmentClientOptions, type PriceIndexQuery, type PriceIndexStatsQuery, type ProfitItem, type ProfitListQuery, type RoastBatchCreateRequest, type RoastChartData, type RoastChartDataQuery, type RoastChartEvent, type RoastChartSeries, type RoastLiveCurveRequest, type SalesCreateRequest, type SalesListQuery, type SalesUpdateRequest, type SourcingBriefCreateRequest, type TrackedLotMutation, type TrackedLotSummary, type TrackedLotsListQuery, type components, createParchmentClient, type paths };
|