@purveyors/sdk 0.57.0 → 0.58.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 +10 -5
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -6182,14 +6182,14 @@ interface paths {
|
|
|
6182
6182
|
};
|
|
6183
6183
|
/**
|
|
6184
6184
|
* Metadata-trend index (process/disclosure/Purveyor Score over time)
|
|
6185
|
-
* @description Metadata-trend index over metadata_index_snapshots. The process/retail/month slice is public; other dimensions, origins, and grains require Parchment Intelligence (ppiAccess). Purveyor Score dimensions use coffee_catalog.purveyor_score and companion fields, never supplier-stated score_value.
|
|
6185
|
+
* @description Metadata-trend index over metadata_index_snapshots. The process/retail/month slice is public; other dimensions, origins, and grains require Parchment Intelligence (ppiAccess). Purveyor Score dimensions use coffee_catalog.purveyor_score and companion fields, never supplier-stated score_value. The cultivar and drying dimensions use bucket keys from /v1/catalog/taxonomies (variety and drying method codes), plus undisclosed (the supplier states none) and unmapped (it states one the vocabulary does not cover yet); their buckets overlap, see meta.bucketSemantics.
|
|
6186
6186
|
*/
|
|
6187
6187
|
get: {
|
|
6188
6188
|
parameters: {
|
|
6189
6189
|
query?: {
|
|
6190
6190
|
page?: number;
|
|
6191
6191
|
limit?: number;
|
|
6192
|
-
dimension?: "process" | "disclosure" | "purveyor_score" | "purveyor_score_confidence" | "purveyor_score_tier";
|
|
6192
|
+
dimension?: "process" | "disclosure" | "purveyor_score" | "purveyor_score_confidence" | "purveyor_score_tier" | "cultivar" | "drying";
|
|
6193
6193
|
origin?: string;
|
|
6194
6194
|
market?: "retail" | "wholesale" | "all";
|
|
6195
6195
|
grain?: "week" | "month";
|
|
@@ -16607,7 +16607,7 @@ interface components {
|
|
|
16607
16607
|
};
|
|
16608
16608
|
filters: {
|
|
16609
16609
|
/** @enum {string} */
|
|
16610
|
-
dimension: "process" | "disclosure" | "purveyor_score" | "purveyor_score_confidence" | "purveyor_score_tier";
|
|
16610
|
+
dimension: "process" | "disclosure" | "purveyor_score" | "purveyor_score_confidence" | "purveyor_score_tier" | "cultivar" | "drying";
|
|
16611
16611
|
origin: string | null;
|
|
16612
16612
|
/** @enum {string} */
|
|
16613
16613
|
market: "retail" | "wholesale" | "all";
|
|
@@ -16624,6 +16624,11 @@ interface components {
|
|
|
16624
16624
|
};
|
|
16625
16625
|
asOf: string | null;
|
|
16626
16626
|
computedAt: string | null;
|
|
16627
|
+
/**
|
|
16628
|
+
* @description How a period's buckets relate. disjoint: each lot is in one bucket and shares sum to 1. overlapping (cultivar, drying): a lot counts under every code it carries and each family, so shares do not sum to 1 and counts must not be added; lotCount is the period's lot total. percentile: buckets are p25, p50 and p75.
|
|
16629
|
+
* @enum {string}
|
|
16630
|
+
*/
|
|
16631
|
+
bucketSemantics: "disjoint" | "overlapping" | "percentile";
|
|
16627
16632
|
thresholds: {
|
|
16628
16633
|
originSuppressionMinLots: number;
|
|
16629
16634
|
publicSlice: {
|
|
@@ -24067,7 +24072,7 @@ declare function createParchmentClient(options: ParchmentClientOptions): {
|
|
|
24067
24072
|
query?: {
|
|
24068
24073
|
page?: number;
|
|
24069
24074
|
limit?: number;
|
|
24070
|
-
dimension?: "process" | "disclosure" | "purveyor_score" | "purveyor_score_confidence" | "purveyor_score_tier";
|
|
24075
|
+
dimension?: "process" | "disclosure" | "purveyor_score" | "purveyor_score_confidence" | "purveyor_score_tier" | "cultivar" | "drying";
|
|
24071
24076
|
origin?: string;
|
|
24072
24077
|
market?: "retail" | "wholesale" | "all";
|
|
24073
24078
|
grain?: "week" | "month";
|
|
@@ -24129,7 +24134,7 @@ declare function createParchmentClient(options: ParchmentClientOptions): {
|
|
|
24129
24134
|
query: {
|
|
24130
24135
|
page?: number;
|
|
24131
24136
|
limit?: number;
|
|
24132
|
-
dimension?: "process" | "disclosure" | "purveyor_score" | "purveyor_score_confidence" | "purveyor_score_tier";
|
|
24137
|
+
dimension?: "process" | "disclosure" | "purveyor_score" | "purveyor_score_confidence" | "purveyor_score_tier" | "cultivar" | "drying";
|
|
24133
24138
|
origin?: string;
|
|
24134
24139
|
market?: "retail" | "wholesale" | "all";
|
|
24135
24140
|
grain?: "week" | "month";
|