@purveyors/sdk 0.40.0 → 0.41.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 +123 -0
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -2601,6 +2601,7 @@ interface paths {
|
|
|
2601
2601
|
order?: "asc" | "desc";
|
|
2602
2602
|
showWholesale?: "true" | "false";
|
|
2603
2603
|
wholesaleOnly?: "true" | "false";
|
|
2604
|
+
projection?: "full" | "summary";
|
|
2604
2605
|
include?: "proof";
|
|
2605
2606
|
origin?: string;
|
|
2606
2607
|
continent?: string;
|
|
@@ -5465,6 +5466,12 @@ interface paths {
|
|
|
5465
5466
|
get: {
|
|
5466
5467
|
parameters: {
|
|
5467
5468
|
query?: {
|
|
5469
|
+
portfolio?: "true" | "false";
|
|
5470
|
+
filters?: string;
|
|
5471
|
+
sort_field?: string;
|
|
5472
|
+
sort_direction?: "asc" | "desc";
|
|
5473
|
+
id?: number;
|
|
5474
|
+
include_pagination?: "true" | "false";
|
|
5468
5475
|
stocked_only?: boolean | null;
|
|
5469
5476
|
catalogId?: number;
|
|
5470
5477
|
purchaseDateStart?: string;
|
|
@@ -5540,6 +5547,27 @@ interface paths {
|
|
|
5540
5547
|
};
|
|
5541
5548
|
};
|
|
5542
5549
|
429: components["responses"]["ApiRateLimitExceeded"];
|
|
5550
|
+
/** @description Portfolio query migration is not installed */
|
|
5551
|
+
503: {
|
|
5552
|
+
headers: {
|
|
5553
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
5554
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
5555
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
5556
|
+
"X-RateLimit-Burst-Limit": components["headers"]["X-RateLimit-Burst-Limit"];
|
|
5557
|
+
"X-RateLimit-Burst-Remaining": components["headers"]["X-RateLimit-Burst-Remaining"];
|
|
5558
|
+
"X-RateLimit-Burst-Reset": components["headers"]["X-RateLimit-Burst-Reset"];
|
|
5559
|
+
[name: string]: unknown;
|
|
5560
|
+
};
|
|
5561
|
+
content: {
|
|
5562
|
+
"application/json": {
|
|
5563
|
+
error: {
|
|
5564
|
+
/** @enum {string} */
|
|
5565
|
+
code: "portfolio_query_unavailable";
|
|
5566
|
+
message: string;
|
|
5567
|
+
};
|
|
5568
|
+
};
|
|
5569
|
+
};
|
|
5570
|
+
};
|
|
5543
5571
|
};
|
|
5544
5572
|
};
|
|
5545
5573
|
put?: never;
|
|
@@ -11754,6 +11782,11 @@ interface components {
|
|
|
11754
11782
|
apiPlan: "viewer" | "member" | "enterprise" | null;
|
|
11755
11783
|
ppiAccess: boolean;
|
|
11756
11784
|
apiScopes: string[];
|
|
11785
|
+
/** @description Minimal live-verified identity for session callers only; absent for API keys and anonymous callers. */
|
|
11786
|
+
sessionIdentity?: {
|
|
11787
|
+
id: string;
|
|
11788
|
+
email: string | null;
|
|
11789
|
+
};
|
|
11757
11790
|
};
|
|
11758
11791
|
AccountDeletionOperation: {
|
|
11759
11792
|
/** Format: uuid */
|
|
@@ -12103,6 +12136,13 @@ interface components {
|
|
|
12103
12136
|
ai_description?: string | null;
|
|
12104
12137
|
ai_tasting_notes?: unknown;
|
|
12105
12138
|
proof?: components["schemas"]["CatalogProofSummary"];
|
|
12139
|
+
/** @description Entitled metadata-presence signals returned only by projection=summary; false also covers fields outside the caller projection. */
|
|
12140
|
+
summarySignals?: {
|
|
12141
|
+
farmNotes: boolean;
|
|
12142
|
+
roastRecommendations: boolean;
|
|
12143
|
+
descriptions: boolean;
|
|
12144
|
+
cuppingNotes: boolean;
|
|
12145
|
+
};
|
|
12106
12146
|
};
|
|
12107
12147
|
CatalogListResponse: {
|
|
12108
12148
|
data: components["schemas"]["CatalogItem"][];
|
|
@@ -13995,9 +14035,37 @@ interface components {
|
|
|
13995
14035
|
catalog_id: number | null;
|
|
13996
14036
|
stocked: boolean | null;
|
|
13997
14037
|
coffee_catalog: components["schemas"]["InventoryCatalog"];
|
|
14038
|
+
roasted_oz_in?: number | null;
|
|
13998
14039
|
};
|
|
13999
14040
|
InventoryListResponse: {
|
|
14000
14041
|
data: components["schemas"]["InventoryResource"][];
|
|
14042
|
+
portfolio?: {
|
|
14043
|
+
summary: {
|
|
14044
|
+
totalCount: number;
|
|
14045
|
+
value: number;
|
|
14046
|
+
purchasedLbs: number;
|
|
14047
|
+
remainingLbs: number;
|
|
14048
|
+
stockedCount: number;
|
|
14049
|
+
avgCost: number;
|
|
14050
|
+
};
|
|
14051
|
+
sources: {
|
|
14052
|
+
[key: string]: {
|
|
14053
|
+
count: number;
|
|
14054
|
+
weight: number;
|
|
14055
|
+
value: number;
|
|
14056
|
+
};
|
|
14057
|
+
};
|
|
14058
|
+
uniqueValues: {
|
|
14059
|
+
[key: string]: string[];
|
|
14060
|
+
};
|
|
14061
|
+
ownerTotal: number;
|
|
14062
|
+
};
|
|
14063
|
+
pagination?: {
|
|
14064
|
+
offset: number;
|
|
14065
|
+
limit: number;
|
|
14066
|
+
total?: number;
|
|
14067
|
+
hasNext: boolean;
|
|
14068
|
+
};
|
|
14001
14069
|
meta: {
|
|
14002
14070
|
/** @enum {string} */
|
|
14003
14071
|
resource: "inventory";
|
|
@@ -14850,6 +14918,17 @@ interface components {
|
|
|
14850
14918
|
origin?: string;
|
|
14851
14919
|
processing?: string;
|
|
14852
14920
|
}[];
|
|
14921
|
+
} | {
|
|
14922
|
+
artisanSource: {
|
|
14923
|
+
fileName: string;
|
|
14924
|
+
fileContent: string;
|
|
14925
|
+
};
|
|
14926
|
+
inventory: {
|
|
14927
|
+
id: number;
|
|
14928
|
+
coffee_name: string;
|
|
14929
|
+
origin?: string;
|
|
14930
|
+
processing?: string;
|
|
14931
|
+
}[];
|
|
14853
14932
|
};
|
|
14854
14933
|
RoastGetResource: components["schemas"]["RoastDetailResource"] & {
|
|
14855
14934
|
chart_x_min: number | null;
|
|
@@ -18070,6 +18149,7 @@ declare function createParchmentClient(options: ParchmentClientOptions): {
|
|
|
18070
18149
|
order?: "asc" | "desc";
|
|
18071
18150
|
showWholesale?: "true" | "false";
|
|
18072
18151
|
wholesaleOnly?: "true" | "false";
|
|
18152
|
+
projection?: "full" | "summary";
|
|
18073
18153
|
include?: "proof";
|
|
18074
18154
|
origin?: string;
|
|
18075
18155
|
continent?: string;
|
|
@@ -18165,6 +18245,7 @@ declare function createParchmentClient(options: ParchmentClientOptions): {
|
|
|
18165
18245
|
order?: "asc" | "desc";
|
|
18166
18246
|
showWholesale?: "true" | "false";
|
|
18167
18247
|
wholesaleOnly?: "true" | "false";
|
|
18248
|
+
projection?: "full" | "summary";
|
|
18168
18249
|
include?: "proof";
|
|
18169
18250
|
origin?: string;
|
|
18170
18251
|
continent?: string;
|
|
@@ -22871,6 +22952,12 @@ declare function createParchmentClient(options: ParchmentClientOptions): {
|
|
|
22871
22952
|
list: (query?: InventoryListQuery) => Promise<openapi_fetch.FetchResponse<{
|
|
22872
22953
|
parameters: {
|
|
22873
22954
|
query?: {
|
|
22955
|
+
portfolio?: "true" | "false";
|
|
22956
|
+
filters?: string;
|
|
22957
|
+
sort_field?: string;
|
|
22958
|
+
sort_direction?: "asc" | "desc";
|
|
22959
|
+
id?: number;
|
|
22960
|
+
include_pagination?: "true" | "false";
|
|
22874
22961
|
stocked_only?: boolean | null;
|
|
22875
22962
|
catalogId?: number;
|
|
22876
22963
|
purchaseDateStart?: string;
|
|
@@ -22942,10 +23029,35 @@ declare function createParchmentClient(options: ParchmentClientOptions): {
|
|
|
22942
23029
|
};
|
|
22943
23030
|
};
|
|
22944
23031
|
429: components["responses"]["ApiRateLimitExceeded"];
|
|
23032
|
+
503: {
|
|
23033
|
+
headers: {
|
|
23034
|
+
"X-RateLimit-Limit": components["headers"]["X-RateLimit-Limit"];
|
|
23035
|
+
"X-RateLimit-Remaining": components["headers"]["X-RateLimit-Remaining"];
|
|
23036
|
+
"X-RateLimit-Reset": components["headers"]["X-RateLimit-Reset"];
|
|
23037
|
+
"X-RateLimit-Burst-Limit": components["headers"]["X-RateLimit-Burst-Limit"];
|
|
23038
|
+
"X-RateLimit-Burst-Remaining": components["headers"]["X-RateLimit-Burst-Remaining"];
|
|
23039
|
+
"X-RateLimit-Burst-Reset": components["headers"]["X-RateLimit-Burst-Reset"];
|
|
23040
|
+
[name: string]: unknown;
|
|
23041
|
+
};
|
|
23042
|
+
content: {
|
|
23043
|
+
"application/json": {
|
|
23044
|
+
error: {
|
|
23045
|
+
code: "portfolio_query_unavailable";
|
|
23046
|
+
message: string;
|
|
23047
|
+
};
|
|
23048
|
+
};
|
|
23049
|
+
};
|
|
23050
|
+
};
|
|
22945
23051
|
};
|
|
22946
23052
|
}, {
|
|
22947
23053
|
params: {
|
|
22948
23054
|
query: {
|
|
23055
|
+
portfolio?: "true" | "false";
|
|
23056
|
+
filters?: string;
|
|
23057
|
+
sort_field?: string;
|
|
23058
|
+
sort_direction?: "asc" | "desc";
|
|
23059
|
+
id?: number;
|
|
23060
|
+
include_pagination?: "true" | "false";
|
|
22949
23061
|
stocked_only?: boolean | null;
|
|
22950
23062
|
catalogId?: number;
|
|
22951
23063
|
purchaseDateStart?: string;
|
|
@@ -24709,6 +24821,17 @@ declare function createParchmentClient(options: ParchmentClientOptions): {
|
|
|
24709
24821
|
origin?: string;
|
|
24710
24822
|
processing?: string;
|
|
24711
24823
|
}[];
|
|
24824
|
+
} | {
|
|
24825
|
+
artisanSource: {
|
|
24826
|
+
fileName: string;
|
|
24827
|
+
fileContent: string;
|
|
24828
|
+
};
|
|
24829
|
+
inventory: {
|
|
24830
|
+
id: number;
|
|
24831
|
+
coffee_name: string;
|
|
24832
|
+
origin?: string;
|
|
24833
|
+
processing?: string;
|
|
24834
|
+
}[];
|
|
24712
24835
|
};
|
|
24713
24836
|
}, `${string}/${string}`>>;
|
|
24714
24837
|
/** List the caller's own roast profiles (owner-scoped). */
|