@usethrottle/api-client 2.8.0 → 2.9.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/index.d.ts +0 -1
- package/dist/generated/index.d.ts.map +1 -1
- package/dist/generated/index.js.map +1 -1
- package/dist/generated/services/CartsService.d.ts +0 -3
- package/dist/generated/services/CartsService.d.ts.map +1 -1
- package/dist/generated/services/CartsService.js.map +1 -1
- package/dist/generated/services/CheckoutSessionsService.d.ts +0 -4
- package/dist/generated/services/CheckoutSessionsService.d.ts.map +1 -1
- package/dist/generated/services/CheckoutSessionsService.js.map +1 -1
- package/dist/generated/services/DefaultService.d.ts +14 -1
- package/dist/generated/services/DefaultService.d.ts.map +1 -1
- package/dist/generated/services/DefaultService.js +32 -0
- package/dist/generated/services/DefaultService.js.map +1 -1
- package/dist/generated/services/FulfillmentsService.d.ts +4 -67
- package/dist/generated/services/FulfillmentsService.d.ts.map +1 -1
- package/dist/generated/services/FulfillmentsService.js +4 -16
- package/dist/generated/services/FulfillmentsService.js.map +1 -1
- package/dist/generated/services/OrdersService.d.ts +1 -45
- package/dist/generated/services/OrdersService.d.ts.map +1 -1
- package/dist/generated/services/OrdersService.js +1 -1
- package/dist/generated/services/OrdersService.js.map +1 -1
- package/dist/generated/services/PartnersService.d.ts +1 -1
- package/dist/generated/services/PartnersService.js +1 -1
- package/dist/generated/services/QuotesService.d.ts +287 -83
- package/dist/generated/services/QuotesService.d.ts.map +1 -1
- package/dist/generated/services/QuotesService.js +187 -46
- package/dist/generated/services/QuotesService.js.map +1 -1
- package/dist/generated/services/TrackingService.d.ts +12 -22
- package/dist/generated/services/TrackingService.d.ts.map +1 -1
- package/dist/generated/services/TrackingService.js +13 -5
- package/dist/generated/services/TrackingService.js.map +1 -1
- package/dist/generated/services/WebhooksOutboundService.d.ts +3 -3
- package/dist/generated/services/WebhooksOutboundService.d.ts.map +1 -1
- package/dist/generated/services/WorkspacesService.d.ts +0 -3
- package/dist/generated/services/WorkspacesService.d.ts.map +1 -1
- package/dist/generated/services/WorkspacesService.js.map +1 -1
- package/package.json +1 -1
- package/dist/generated/models/ClientContext.d.ts +0 -25
- package/dist/generated/models/ClientContext.d.ts.map +0 -1
- package/dist/generated/models/ClientContext.js +0 -2
- package/dist/generated/models/ClientContext.js.map +0 -1
|
@@ -2,6 +2,7 @@ import type { CancelablePromise } from '../core/CancelablePromise.js';
|
|
|
2
2
|
export declare class QuotesService {
|
|
3
3
|
/**
|
|
4
4
|
* List quotes with cursor pagination
|
|
5
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
5
6
|
* @param cursor Cursor for pagination (last item ID)
|
|
6
7
|
* @param limit Number of items per page
|
|
7
8
|
* @param status Comma-separated status filter, e.g. proposed,accepted
|
|
@@ -11,7 +12,7 @@ export declare class QuotesService {
|
|
|
11
12
|
* @returns any Default Response
|
|
12
13
|
* @throws ApiError
|
|
13
14
|
*/
|
|
14
|
-
static getApiV1Quotes(cursor?: string, limit?: number, status?: string, q?: string, assignedMemberId?: string, customerId?: string): CancelablePromise<{
|
|
15
|
+
static getApiV1Quotes(xThrottleEnvironmentId?: string, cursor?: string, limit?: number, status?: string, q?: string, assignedMemberId?: string, customerId?: string): CancelablePromise<{
|
|
15
16
|
data?: Array<{
|
|
16
17
|
id?: string;
|
|
17
18
|
quoteNumber?: string;
|
|
@@ -44,12 +45,9 @@ export declare class QuotesService {
|
|
|
44
45
|
*/
|
|
45
46
|
metadata?: Record<string, any>;
|
|
46
47
|
environmentId?: string;
|
|
48
|
+
total?: number | null;
|
|
47
49
|
createdAt?: string;
|
|
48
50
|
updatedAt?: string;
|
|
49
|
-
/**
|
|
50
|
-
* Current revision's frozen total (minor units) — list responses only
|
|
51
|
-
*/
|
|
52
|
-
total?: number | null;
|
|
53
51
|
}>;
|
|
54
52
|
meta?: {
|
|
55
53
|
requestId?: string;
|
|
@@ -61,10 +59,56 @@ export declare class QuotesService {
|
|
|
61
59
|
}>;
|
|
62
60
|
/**
|
|
63
61
|
* Create a quote (draft, or requested for RFQ intake)
|
|
62
|
+
* @param requestBody
|
|
63
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
64
64
|
* @returns any Default Response
|
|
65
65
|
* @throws ApiError
|
|
66
66
|
*/
|
|
67
|
-
static postApiV1Quotes(
|
|
67
|
+
static postApiV1Quotes(requestBody: {
|
|
68
|
+
status?: 'draft' | 'requested';
|
|
69
|
+
customerId?: string | null;
|
|
70
|
+
customerEmail?: string | null;
|
|
71
|
+
buyerReference?: string | null;
|
|
72
|
+
source?: 'dashboard' | 'api';
|
|
73
|
+
assignedMemberId?: string | null;
|
|
74
|
+
currency?: string;
|
|
75
|
+
internalNotes?: string | null;
|
|
76
|
+
items?: Array<{
|
|
77
|
+
type?: 'product' | 'subscription' | 'service' | 'ticket' | 'donation' | 'custom';
|
|
78
|
+
referenceId?: string | null;
|
|
79
|
+
sku?: string | null;
|
|
80
|
+
name: string;
|
|
81
|
+
description?: string | null;
|
|
82
|
+
unitPrice: number;
|
|
83
|
+
quantity?: number;
|
|
84
|
+
taxAmount?: number;
|
|
85
|
+
discountAmount?: number;
|
|
86
|
+
priceSource?: 'catalog' | 'override' | 'custom';
|
|
87
|
+
optional?: boolean;
|
|
88
|
+
qtyEditable?: boolean;
|
|
89
|
+
imageUrl?: string | null;
|
|
90
|
+
position?: number;
|
|
91
|
+
metadata?: Record<string, any>;
|
|
92
|
+
}>;
|
|
93
|
+
/**
|
|
94
|
+
* pay_in_full | net_terms (netN 1-365) | deposit_balance (deposit percent/fixed + balanceNetN)
|
|
95
|
+
*/
|
|
96
|
+
paymentTerms?: {
|
|
97
|
+
mode: 'pay_in_full' | 'net_terms' | 'deposit_balance';
|
|
98
|
+
netN?: number;
|
|
99
|
+
balanceNetN?: number;
|
|
100
|
+
deposit?: {
|
|
101
|
+
type: 'percent' | 'fixed';
|
|
102
|
+
value: number;
|
|
103
|
+
};
|
|
104
|
+
};
|
|
105
|
+
expiresAt?: string | null;
|
|
106
|
+
buyerNote?: string | null;
|
|
107
|
+
leadTime?: string | null;
|
|
108
|
+
shippingMode?: 'none' | 'flat' | 'checkout_calculated' | 'free';
|
|
109
|
+
shippingFlatAmount?: number | null;
|
|
110
|
+
metadata?: Record<string, any>;
|
|
111
|
+
}, xThrottleEnvironmentId?: string): CancelablePromise<{
|
|
68
112
|
data?: {
|
|
69
113
|
quote?: {
|
|
70
114
|
id?: string;
|
|
@@ -98,6 +142,7 @@ export declare class QuotesService {
|
|
|
98
142
|
*/
|
|
99
143
|
metadata?: Record<string, any>;
|
|
100
144
|
environmentId?: string;
|
|
145
|
+
total?: number | null;
|
|
101
146
|
createdAt?: string;
|
|
102
147
|
updatedAt?: string;
|
|
103
148
|
};
|
|
@@ -197,10 +242,11 @@ export declare class QuotesService {
|
|
|
197
242
|
/**
|
|
198
243
|
* Get a quote with revisions, comments, and timeline (merchant view)
|
|
199
244
|
* @param id
|
|
245
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
200
246
|
* @returns any Default Response
|
|
201
247
|
* @throws ApiError
|
|
202
248
|
*/
|
|
203
|
-
static getApiV1Quotes1(id: string): CancelablePromise<{
|
|
249
|
+
static getApiV1Quotes1(id: string, xThrottleEnvironmentId?: string): CancelablePromise<{
|
|
204
250
|
data?: {
|
|
205
251
|
id?: string;
|
|
206
252
|
quoteNumber?: string;
|
|
@@ -233,6 +279,7 @@ export declare class QuotesService {
|
|
|
233
279
|
*/
|
|
234
280
|
metadata?: Record<string, any>;
|
|
235
281
|
environmentId?: string;
|
|
282
|
+
total?: number | null;
|
|
236
283
|
createdAt?: string;
|
|
237
284
|
updatedAt?: string;
|
|
238
285
|
revisions?: Array<{
|
|
@@ -326,6 +373,7 @@ export declare class QuotesService {
|
|
|
326
373
|
* Update quote assignment, linkage, internal notes, or archive it
|
|
327
374
|
* @param id
|
|
328
375
|
* @param requestBody
|
|
376
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
329
377
|
* @returns any Default Response
|
|
330
378
|
* @throws ApiError
|
|
331
379
|
*/
|
|
@@ -340,7 +388,7 @@ export declare class QuotesService {
|
|
|
340
388
|
*/
|
|
341
389
|
metadata?: Record<string, any>;
|
|
342
390
|
status?: 'archived';
|
|
343
|
-
}): CancelablePromise<{
|
|
391
|
+
}, xThrottleEnvironmentId?: string): CancelablePromise<{
|
|
344
392
|
data?: {
|
|
345
393
|
id?: string;
|
|
346
394
|
quoteNumber?: string;
|
|
@@ -373,6 +421,7 @@ export declare class QuotesService {
|
|
|
373
421
|
*/
|
|
374
422
|
metadata?: Record<string, any>;
|
|
375
423
|
environmentId?: string;
|
|
424
|
+
total?: number | null;
|
|
376
425
|
createdAt?: string;
|
|
377
426
|
updatedAt?: string;
|
|
378
427
|
};
|
|
@@ -387,10 +436,12 @@ export declare class QuotesService {
|
|
|
387
436
|
/**
|
|
388
437
|
* Start a new working revision cloned from the latest issued revision
|
|
389
438
|
* @param id
|
|
439
|
+
* @param requestBody
|
|
440
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
390
441
|
* @returns any Default Response
|
|
391
442
|
* @throws ApiError
|
|
392
443
|
*/
|
|
393
|
-
static postApiV1QuotesRevisions(id: string): CancelablePromise<{
|
|
444
|
+
static postApiV1QuotesRevisions(id: string, requestBody: any, xThrottleEnvironmentId?: string): CancelablePromise<{
|
|
394
445
|
data?: {
|
|
395
446
|
revision?: {
|
|
396
447
|
id?: string;
|
|
@@ -489,10 +540,49 @@ export declare class QuotesService {
|
|
|
489
540
|
* Edit the working revision (items, terms, expiry, notes)
|
|
490
541
|
* @param id
|
|
491
542
|
* @param revId
|
|
543
|
+
* @param requestBody
|
|
544
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
492
545
|
* @returns any Default Response
|
|
493
546
|
* @throws ApiError
|
|
494
547
|
*/
|
|
495
|
-
static patchApiV1QuotesRevisions(id: string, revId: string
|
|
548
|
+
static patchApiV1QuotesRevisions(id: string, revId: string, requestBody: {
|
|
549
|
+
items?: Array<{
|
|
550
|
+
type?: 'product' | 'subscription' | 'service' | 'ticket' | 'donation' | 'custom';
|
|
551
|
+
referenceId?: string | null;
|
|
552
|
+
sku?: string | null;
|
|
553
|
+
name: string;
|
|
554
|
+
description?: string | null;
|
|
555
|
+
unitPrice: number;
|
|
556
|
+
quantity?: number;
|
|
557
|
+
taxAmount?: number;
|
|
558
|
+
discountAmount?: number;
|
|
559
|
+
priceSource?: 'catalog' | 'override' | 'custom';
|
|
560
|
+
optional?: boolean;
|
|
561
|
+
qtyEditable?: boolean;
|
|
562
|
+
imageUrl?: string | null;
|
|
563
|
+
position?: number;
|
|
564
|
+
metadata?: Record<string, any>;
|
|
565
|
+
}>;
|
|
566
|
+
/**
|
|
567
|
+
* pay_in_full | net_terms (netN 1-365) | deposit_balance (deposit percent/fixed + balanceNetN)
|
|
568
|
+
*/
|
|
569
|
+
paymentTerms?: {
|
|
570
|
+
mode: 'pay_in_full' | 'net_terms' | 'deposit_balance';
|
|
571
|
+
netN?: number;
|
|
572
|
+
balanceNetN?: number;
|
|
573
|
+
deposit?: {
|
|
574
|
+
type: 'percent' | 'fixed';
|
|
575
|
+
value: number;
|
|
576
|
+
};
|
|
577
|
+
};
|
|
578
|
+
expiresAt?: string | null;
|
|
579
|
+
buyerNote?: string | null;
|
|
580
|
+
leadTime?: string | null;
|
|
581
|
+
shippingMode?: 'none' | 'flat' | 'checkout_calculated' | 'free';
|
|
582
|
+
shippingFlatAmount?: number | null;
|
|
583
|
+
metadata?: Record<string, any>;
|
|
584
|
+
changeSummary?: string | null;
|
|
585
|
+
}, xThrottleEnvironmentId?: string): CancelablePromise<{
|
|
496
586
|
data?: {
|
|
497
587
|
revision?: {
|
|
498
588
|
id?: string;
|
|
@@ -590,10 +680,12 @@ export declare class QuotesService {
|
|
|
590
680
|
/**
|
|
591
681
|
* Freeze the working revision, supersede the prior one, and propose the quote
|
|
592
682
|
* @param id
|
|
683
|
+
* @param requestBody
|
|
684
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
593
685
|
* @returns any Default Response
|
|
594
686
|
* @throws ApiError
|
|
595
687
|
*/
|
|
596
|
-
static postApiV1QuotesIssue(id: string): CancelablePromise<{
|
|
688
|
+
static postApiV1QuotesIssue(id: string, requestBody: any, xThrottleEnvironmentId?: string): CancelablePromise<{
|
|
597
689
|
data?: {
|
|
598
690
|
quote?: {
|
|
599
691
|
id?: string;
|
|
@@ -627,6 +719,7 @@ export declare class QuotesService {
|
|
|
627
719
|
*/
|
|
628
720
|
metadata?: Record<string, any>;
|
|
629
721
|
environmentId?: string;
|
|
722
|
+
total?: number | null;
|
|
630
723
|
createdAt?: string;
|
|
631
724
|
updatedAt?: string;
|
|
632
725
|
};
|
|
@@ -726,10 +819,12 @@ export declare class QuotesService {
|
|
|
726
819
|
/**
|
|
727
820
|
* Rotate the buyer link token (invalidates the old link)
|
|
728
821
|
* @param id
|
|
822
|
+
* @param requestBody
|
|
823
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
729
824
|
* @returns any Default Response
|
|
730
825
|
* @throws ApiError
|
|
731
826
|
*/
|
|
732
|
-
static postApiV1QuotesRotateLink(id: string): CancelablePromise<{
|
|
827
|
+
static postApiV1QuotesRotateLink(id: string, requestBody: any, xThrottleEnvironmentId?: string): CancelablePromise<{
|
|
733
828
|
data?: {
|
|
734
829
|
quote?: {
|
|
735
830
|
id?: string;
|
|
@@ -763,6 +858,7 @@ export declare class QuotesService {
|
|
|
763
858
|
*/
|
|
764
859
|
metadata?: Record<string, any>;
|
|
765
860
|
environmentId?: string;
|
|
861
|
+
total?: number | null;
|
|
766
862
|
createdAt?: string;
|
|
767
863
|
updatedAt?: string;
|
|
768
864
|
};
|
|
@@ -780,6 +876,7 @@ export declare class QuotesService {
|
|
|
780
876
|
* Add a merchant comment (shared with the buyer, or internal)
|
|
781
877
|
* @param id
|
|
782
878
|
* @param requestBody
|
|
879
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
783
880
|
* @returns any Default Response
|
|
784
881
|
* @throws ApiError
|
|
785
882
|
*/
|
|
@@ -787,7 +884,7 @@ export declare class QuotesService {
|
|
|
787
884
|
body: string;
|
|
788
885
|
visibility?: 'shared' | 'internal';
|
|
789
886
|
revisionId?: string | null;
|
|
790
|
-
}): CancelablePromise<{
|
|
887
|
+
}, xThrottleEnvironmentId?: string): CancelablePromise<{
|
|
791
888
|
data?: {
|
|
792
889
|
id?: string;
|
|
793
890
|
quoteId?: string;
|
|
@@ -812,13 +909,14 @@ export declare class QuotesService {
|
|
|
812
909
|
* Snapshot a cart's lines into a requested quote (the cart is unchanged)
|
|
813
910
|
* @param id
|
|
814
911
|
* @param requestBody
|
|
912
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
815
913
|
* @returns any Default Response
|
|
816
914
|
* @throws ApiError
|
|
817
915
|
*/
|
|
818
916
|
static postApiV1CartsRequestQuote(id: string, requestBody: {
|
|
819
917
|
buyerReference?: string | null;
|
|
820
918
|
note?: string | null;
|
|
821
|
-
}): CancelablePromise<{
|
|
919
|
+
}, xThrottleEnvironmentId?: string): CancelablePromise<{
|
|
822
920
|
data?: {
|
|
823
921
|
quote?: {
|
|
824
922
|
id?: string;
|
|
@@ -852,6 +950,7 @@ export declare class QuotesService {
|
|
|
852
950
|
*/
|
|
853
951
|
metadata?: Record<string, any>;
|
|
854
952
|
environmentId?: string;
|
|
953
|
+
total?: number | null;
|
|
855
954
|
createdAt?: string;
|
|
856
955
|
updatedAt?: string;
|
|
857
956
|
};
|
|
@@ -948,13 +1047,81 @@ export declare class QuotesService {
|
|
|
948
1047
|
};
|
|
949
1048
|
};
|
|
950
1049
|
}>;
|
|
1050
|
+
/**
|
|
1051
|
+
* Record a rep-given acceptance (phone/email deal) and start checkout (spec §8, §9)
|
|
1052
|
+
* @param id
|
|
1053
|
+
* @param requestBody
|
|
1054
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
1055
|
+
* @returns any Default Response
|
|
1056
|
+
* @throws ApiError
|
|
1057
|
+
*/
|
|
1058
|
+
static postApiV1QuotesAccept(id: string, requestBody: {
|
|
1059
|
+
revisionId: string;
|
|
1060
|
+
acceptedByName: string;
|
|
1061
|
+
acceptedByEmail: string;
|
|
1062
|
+
buyerReference?: string | null;
|
|
1063
|
+
itemSelections?: Array<{
|
|
1064
|
+
itemId: string;
|
|
1065
|
+
selected?: boolean;
|
|
1066
|
+
quantity?: number;
|
|
1067
|
+
}>;
|
|
1068
|
+
reason?: string | null;
|
|
1069
|
+
}, xThrottleEnvironmentId?: string): CancelablePromise<{
|
|
1070
|
+
data?: {
|
|
1071
|
+
quote?: {
|
|
1072
|
+
id?: string;
|
|
1073
|
+
quoteNumber?: string;
|
|
1074
|
+
status?: 'draft' | 'requested' | 'under_review' | 'proposed' | 'revision_requested' | 'accepted' | 'converted' | 'declined' | 'expired' | 'archived';
|
|
1075
|
+
customerId?: string | null;
|
|
1076
|
+
customerEmail?: string | null;
|
|
1077
|
+
buyerReference?: string | null;
|
|
1078
|
+
source?: 'dashboard' | 'api' | 'cart' | 'request_form';
|
|
1079
|
+
sourceCartId?: string | null;
|
|
1080
|
+
assignedMemberId?: string | null;
|
|
1081
|
+
currency?: string;
|
|
1082
|
+
currentRevisionId?: string | null;
|
|
1083
|
+
acceptedRevisionId?: string | null;
|
|
1084
|
+
acceptedAt?: string | null;
|
|
1085
|
+
checkoutSessionId?: string | null;
|
|
1086
|
+
orderId?: string | null;
|
|
1087
|
+
declinedAt?: string | null;
|
|
1088
|
+
declinedReason?: string | null;
|
|
1089
|
+
expiresAt?: string | null;
|
|
1090
|
+
/**
|
|
1091
|
+
* qtl_ capability token — the buyer link is /q/{shareToken}
|
|
1092
|
+
*/
|
|
1093
|
+
shareToken?: string;
|
|
1094
|
+
shareTokenPrefix?: string;
|
|
1095
|
+
firstViewedAt?: string | null;
|
|
1096
|
+
lastViewedAt?: string | null;
|
|
1097
|
+
internalNotes?: string | null;
|
|
1098
|
+
/**
|
|
1099
|
+
* Arbitrary key-value metadata
|
|
1100
|
+
*/
|
|
1101
|
+
metadata?: Record<string, any>;
|
|
1102
|
+
environmentId?: string;
|
|
1103
|
+
total?: number | null;
|
|
1104
|
+
createdAt?: string;
|
|
1105
|
+
updatedAt?: string;
|
|
1106
|
+
};
|
|
1107
|
+
checkoutUrl?: string;
|
|
1108
|
+
};
|
|
1109
|
+
meta?: {
|
|
1110
|
+
requestId?: string;
|
|
1111
|
+
pagination?: {
|
|
1112
|
+
cursor?: string | null;
|
|
1113
|
+
hasMore?: boolean;
|
|
1114
|
+
};
|
|
1115
|
+
};
|
|
1116
|
+
}>;
|
|
951
1117
|
/**
|
|
952
1118
|
* Get a quote by its buyer link token (public, buyer-shaped)
|
|
953
1119
|
* @param token
|
|
1120
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
954
1121
|
* @returns any Default Response
|
|
955
1122
|
* @throws ApiError
|
|
956
1123
|
*/
|
|
957
|
-
static getApiV1QuoteLinks(token: string): CancelablePromise<{
|
|
1124
|
+
static getApiV1QuoteLinks(token: string, xThrottleEnvironmentId?: string): CancelablePromise<{
|
|
958
1125
|
data?: {
|
|
959
1126
|
quoteNumber?: string;
|
|
960
1127
|
status?: 'in_progress' | 'ready' | 'being_revised' | 'accepted' | 'ordered' | 'declined' | 'expired';
|
|
@@ -1022,10 +1189,12 @@ export declare class QuotesService {
|
|
|
1022
1189
|
/**
|
|
1023
1190
|
* Record a buyer view of the quote link (throttled quote.viewed webhook)
|
|
1024
1191
|
* @param token
|
|
1192
|
+
* @param requestBody
|
|
1193
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
1025
1194
|
* @returns any Default Response
|
|
1026
1195
|
* @throws ApiError
|
|
1027
1196
|
*/
|
|
1028
|
-
static postApiV1QuoteLinksView(token: string): CancelablePromise<{
|
|
1197
|
+
static postApiV1QuoteLinksView(token: string, requestBody: any, xThrottleEnvironmentId?: string): CancelablePromise<{
|
|
1029
1198
|
data?: {
|
|
1030
1199
|
quote?: {
|
|
1031
1200
|
quoteNumber?: string;
|
|
@@ -1096,10 +1265,16 @@ export declare class QuotesService {
|
|
|
1096
1265
|
/**
|
|
1097
1266
|
* Add a buyer comment (always shared)
|
|
1098
1267
|
* @param token
|
|
1268
|
+
* @param requestBody
|
|
1269
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
1099
1270
|
* @returns any Default Response
|
|
1100
1271
|
* @throws ApiError
|
|
1101
1272
|
*/
|
|
1102
|
-
static postApiV1QuoteLinksComments(token: string
|
|
1273
|
+
static postApiV1QuoteLinksComments(token: string, requestBody: {
|
|
1274
|
+
authorName?: string | null;
|
|
1275
|
+
authorEmail?: string | null;
|
|
1276
|
+
body: string;
|
|
1277
|
+
}, xThrottleEnvironmentId?: string): CancelablePromise<{
|
|
1103
1278
|
data?: {
|
|
1104
1279
|
id?: string;
|
|
1105
1280
|
authorType?: 'buyer' | 'merchant' | 'system';
|
|
@@ -1118,10 +1293,16 @@ export declare class QuotesService {
|
|
|
1118
1293
|
/**
|
|
1119
1294
|
* Ask for changes instead of accepting the current proposal
|
|
1120
1295
|
* @param token
|
|
1296
|
+
* @param requestBody
|
|
1297
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
1121
1298
|
* @returns any Default Response
|
|
1122
1299
|
* @throws ApiError
|
|
1123
1300
|
*/
|
|
1124
|
-
static postApiV1QuoteLinksRequestRevision(token: string
|
|
1301
|
+
static postApiV1QuoteLinksRequestRevision(token: string, requestBody: {
|
|
1302
|
+
authorName?: string | null;
|
|
1303
|
+
authorEmail?: string | null;
|
|
1304
|
+
message?: string | null;
|
|
1305
|
+
}, xThrottleEnvironmentId?: string): CancelablePromise<{
|
|
1125
1306
|
data?: {
|
|
1126
1307
|
quoteNumber?: string;
|
|
1127
1308
|
status?: 'in_progress' | 'ready' | 'being_revised' | 'accepted' | 'ordered' | 'declined' | 'expired';
|
|
@@ -1189,10 +1370,16 @@ export declare class QuotesService {
|
|
|
1189
1370
|
/**
|
|
1190
1371
|
* Decline the quote
|
|
1191
1372
|
* @param token
|
|
1373
|
+
* @param requestBody
|
|
1374
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
1192
1375
|
* @returns any Default Response
|
|
1193
1376
|
* @throws ApiError
|
|
1194
1377
|
*/
|
|
1195
|
-
static postApiV1QuoteLinksDecline(token: string
|
|
1378
|
+
static postApiV1QuoteLinksDecline(token: string, requestBody: {
|
|
1379
|
+
authorName?: string | null;
|
|
1380
|
+
authorEmail?: string | null;
|
|
1381
|
+
reason?: string | null;
|
|
1382
|
+
}, xThrottleEnvironmentId?: string): CancelablePromise<{
|
|
1196
1383
|
data?: {
|
|
1197
1384
|
quoteNumber?: string;
|
|
1198
1385
|
status?: 'in_progress' | 'ready' | 'being_revised' | 'accepted' | 'ordered' | 'declined' | 'expired';
|
|
@@ -1258,12 +1445,24 @@ export declare class QuotesService {
|
|
|
1258
1445
|
};
|
|
1259
1446
|
}>;
|
|
1260
1447
|
/**
|
|
1261
|
-
*
|
|
1448
|
+
* Accept the quote and start checkout (spec §8)
|
|
1262
1449
|
* @param token
|
|
1450
|
+
* @param requestBody
|
|
1451
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
1263
1452
|
* @returns any Default Response
|
|
1264
1453
|
* @throws ApiError
|
|
1265
1454
|
*/
|
|
1266
|
-
static postApiV1QuoteLinksAccept(token: string
|
|
1455
|
+
static postApiV1QuoteLinksAccept(token: string, requestBody: {
|
|
1456
|
+
revisionId: string;
|
|
1457
|
+
acceptedByName: string;
|
|
1458
|
+
acceptedByEmail: string;
|
|
1459
|
+
buyerReference?: string | null;
|
|
1460
|
+
itemSelections?: Array<{
|
|
1461
|
+
itemId: string;
|
|
1462
|
+
selected?: boolean;
|
|
1463
|
+
quantity?: number;
|
|
1464
|
+
}>;
|
|
1465
|
+
}, xThrottleEnvironmentId?: string): CancelablePromise<{
|
|
1267
1466
|
data?: {
|
|
1268
1467
|
quote?: {
|
|
1269
1468
|
quoteNumber?: string;
|
|
@@ -1331,72 +1530,37 @@ export declare class QuotesService {
|
|
|
1331
1530
|
};
|
|
1332
1531
|
};
|
|
1333
1532
|
}>;
|
|
1334
|
-
/**
|
|
1335
|
-
* Record a rep-given acceptance (phone/email deal) and start checkout (spec §8, §9)
|
|
1336
|
-
* @param id
|
|
1337
|
-
* @returns any Default Response
|
|
1338
|
-
* @throws ApiError
|
|
1339
|
-
*/
|
|
1340
|
-
static postApiV1QuotesAccept(id: string): CancelablePromise<{
|
|
1341
|
-
data?: {
|
|
1342
|
-
quote?: {
|
|
1343
|
-
id?: string;
|
|
1344
|
-
quoteNumber?: string;
|
|
1345
|
-
status?: 'draft' | 'requested' | 'under_review' | 'proposed' | 'revision_requested' | 'accepted' | 'converted' | 'declined' | 'expired' | 'archived';
|
|
1346
|
-
customerId?: string | null;
|
|
1347
|
-
customerEmail?: string | null;
|
|
1348
|
-
buyerReference?: string | null;
|
|
1349
|
-
source?: 'dashboard' | 'api' | 'cart' | 'request_form';
|
|
1350
|
-
sourceCartId?: string | null;
|
|
1351
|
-
assignedMemberId?: string | null;
|
|
1352
|
-
currency?: string;
|
|
1353
|
-
currentRevisionId?: string | null;
|
|
1354
|
-
acceptedRevisionId?: string | null;
|
|
1355
|
-
acceptedAt?: string | null;
|
|
1356
|
-
checkoutSessionId?: string | null;
|
|
1357
|
-
orderId?: string | null;
|
|
1358
|
-
declinedAt?: string | null;
|
|
1359
|
-
declinedReason?: string | null;
|
|
1360
|
-
expiresAt?: string | null;
|
|
1361
|
-
/**
|
|
1362
|
-
* qtl_ capability token — the buyer link is /q/{shareToken}
|
|
1363
|
-
*/
|
|
1364
|
-
shareToken?: string;
|
|
1365
|
-
shareTokenPrefix?: string;
|
|
1366
|
-
firstViewedAt?: string | null;
|
|
1367
|
-
lastViewedAt?: string | null;
|
|
1368
|
-
internalNotes?: string | null;
|
|
1369
|
-
/**
|
|
1370
|
-
* Arbitrary key-value metadata
|
|
1371
|
-
*/
|
|
1372
|
-
metadata?: Record<string, any>;
|
|
1373
|
-
environmentId?: string;
|
|
1374
|
-
createdAt?: string;
|
|
1375
|
-
updatedAt?: string;
|
|
1376
|
-
};
|
|
1377
|
-
checkoutUrl?: string;
|
|
1378
|
-
};
|
|
1379
|
-
meta?: {
|
|
1380
|
-
requestId?: string;
|
|
1381
|
-
pagination?: {
|
|
1382
|
-
cursor?: string | null;
|
|
1383
|
-
hasMore?: boolean;
|
|
1384
|
-
};
|
|
1385
|
-
};
|
|
1386
|
-
}>;
|
|
1387
1533
|
/**
|
|
1388
1534
|
* Download the quote PDF (302 redirect to a short-lived signed URL; lazy-rendered from the frozen issued revision)
|
|
1389
1535
|
* @param token
|
|
1536
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
1390
1537
|
* @returns void
|
|
1391
1538
|
* @throws ApiError
|
|
1392
1539
|
*/
|
|
1393
|
-
static getApiV1QuoteLinksPdf(token: string): CancelablePromise<void>;
|
|
1540
|
+
static getApiV1QuoteLinksPdf(token: string, xThrottleEnvironmentId?: string): CancelablePromise<void>;
|
|
1394
1541
|
/**
|
|
1395
1542
|
* Create a hosted RFQ intake form (token revealed once)
|
|
1543
|
+
* @param requestBody
|
|
1544
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
1396
1545
|
* @returns any Default Response
|
|
1397
1546
|
* @throws ApiError
|
|
1398
1547
|
*/
|
|
1399
|
-
static postApiV1QuoteRequestForms(
|
|
1548
|
+
static postApiV1QuoteRequestForms(requestBody: {
|
|
1549
|
+
slug: string;
|
|
1550
|
+
title?: string | null;
|
|
1551
|
+
introText?: string | null;
|
|
1552
|
+
successMessage?: string | null;
|
|
1553
|
+
/**
|
|
1554
|
+
* Must be http(s)
|
|
1555
|
+
*/
|
|
1556
|
+
redirectUrl?: string | null;
|
|
1557
|
+
fields?: {
|
|
1558
|
+
companyName?: boolean;
|
|
1559
|
+
phone?: boolean;
|
|
1560
|
+
buyerReference?: boolean;
|
|
1561
|
+
requireTurnstile?: boolean;
|
|
1562
|
+
};
|
|
1563
|
+
}, xThrottleEnvironmentId?: string): CancelablePromise<{
|
|
1400
1564
|
data?: {
|
|
1401
1565
|
form?: {
|
|
1402
1566
|
id?: string;
|
|
@@ -1416,7 +1580,7 @@ export declare class QuotesService {
|
|
|
1416
1580
|
updatedAt?: string;
|
|
1417
1581
|
};
|
|
1418
1582
|
/**
|
|
1419
|
-
* The raw qrf_ token — REVEAL-ONCE; hash-only stored.
|
|
1583
|
+
* The raw qrf_ token — REVEAL-ONCE; hash-only stored. The hosted form URL is /q/request/{formToken}.
|
|
1420
1584
|
*/
|
|
1421
1585
|
formToken?: string;
|
|
1422
1586
|
};
|
|
@@ -1430,10 +1594,11 @@ export declare class QuotesService {
|
|
|
1430
1594
|
}>;
|
|
1431
1595
|
/**
|
|
1432
1596
|
* List RFQ intake forms for the application + environment
|
|
1597
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
1433
1598
|
* @returns any Default Response
|
|
1434
1599
|
* @throws ApiError
|
|
1435
1600
|
*/
|
|
1436
|
-
static getApiV1QuoteRequestForms(): CancelablePromise<{
|
|
1601
|
+
static getApiV1QuoteRequestForms(xThrottleEnvironmentId?: string): CancelablePromise<{
|
|
1437
1602
|
data?: Array<{
|
|
1438
1603
|
id?: string;
|
|
1439
1604
|
slug?: string;
|
|
@@ -1462,10 +1627,27 @@ export declare class QuotesService {
|
|
|
1462
1627
|
/**
|
|
1463
1628
|
* Update an RFQ intake form (activate/deactivate, texts, fields)
|
|
1464
1629
|
* @param id
|
|
1630
|
+
* @param requestBody
|
|
1631
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
1465
1632
|
* @returns any Default Response
|
|
1466
1633
|
* @throws ApiError
|
|
1467
1634
|
*/
|
|
1468
|
-
static patchApiV1QuoteRequestForms(id: string
|
|
1635
|
+
static patchApiV1QuoteRequestForms(id: string, requestBody: {
|
|
1636
|
+
isActive?: boolean;
|
|
1637
|
+
title?: string | null;
|
|
1638
|
+
introText?: string | null;
|
|
1639
|
+
successMessage?: string | null;
|
|
1640
|
+
/**
|
|
1641
|
+
* Must be http(s)
|
|
1642
|
+
*/
|
|
1643
|
+
redirectUrl?: string | null;
|
|
1644
|
+
fields?: {
|
|
1645
|
+
companyName?: boolean;
|
|
1646
|
+
phone?: boolean;
|
|
1647
|
+
buyerReference?: boolean;
|
|
1648
|
+
requireTurnstile?: boolean;
|
|
1649
|
+
};
|
|
1650
|
+
}, xThrottleEnvironmentId?: string): CancelablePromise<{
|
|
1469
1651
|
data?: {
|
|
1470
1652
|
id?: string;
|
|
1471
1653
|
slug?: string;
|
|
@@ -1494,10 +1676,12 @@ export declare class QuotesService {
|
|
|
1494
1676
|
/**
|
|
1495
1677
|
* Rotate the form token (old URL 404s immediately; new token revealed once)
|
|
1496
1678
|
* @param id
|
|
1679
|
+
* @param requestBody
|
|
1680
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
1497
1681
|
* @returns any Default Response
|
|
1498
1682
|
* @throws ApiError
|
|
1499
1683
|
*/
|
|
1500
|
-
static postApiV1QuoteRequestFormsRotateToken(id: string): CancelablePromise<{
|
|
1684
|
+
static postApiV1QuoteRequestFormsRotateToken(id: string, requestBody: any, xThrottleEnvironmentId?: string): CancelablePromise<{
|
|
1501
1685
|
data?: {
|
|
1502
1686
|
form?: {
|
|
1503
1687
|
id?: string;
|
|
@@ -1517,7 +1701,7 @@ export declare class QuotesService {
|
|
|
1517
1701
|
updatedAt?: string;
|
|
1518
1702
|
};
|
|
1519
1703
|
/**
|
|
1520
|
-
* The raw qrf_ token — REVEAL-ONCE; hash-only stored.
|
|
1704
|
+
* The raw qrf_ token — REVEAL-ONCE; hash-only stored. The hosted form URL is /q/request/{formToken}.
|
|
1521
1705
|
*/
|
|
1522
1706
|
formToken?: string;
|
|
1523
1707
|
};
|
|
@@ -1532,10 +1716,11 @@ export declare class QuotesService {
|
|
|
1532
1716
|
/**
|
|
1533
1717
|
* Public form config for the hosted RFQ page (token-authenticated)
|
|
1534
1718
|
* @param token
|
|
1719
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
1535
1720
|
* @returns any Default Response
|
|
1536
1721
|
* @throws ApiError
|
|
1537
1722
|
*/
|
|
1538
|
-
static getApiV1QuoteRequestFormsPublic(token: string): CancelablePromise<{
|
|
1723
|
+
static getApiV1QuoteRequestFormsPublic(token: string, xThrottleEnvironmentId?: string): CancelablePromise<{
|
|
1539
1724
|
data?: {
|
|
1540
1725
|
slug?: string;
|
|
1541
1726
|
title?: string | null;
|
|
@@ -1559,10 +1744,29 @@ export declare class QuotesService {
|
|
|
1559
1744
|
}>;
|
|
1560
1745
|
/**
|
|
1561
1746
|
* Public RFQ submission (honeypot + min-fill-time + rate limit + optional Turnstile)
|
|
1747
|
+
* @param requestBody
|
|
1748
|
+
* @param xThrottleEnvironmentId Optional workspace environment id for dashboard-session, Clerk JWT, and extension-session requests. API keys are already pinned to one workspace environment.
|
|
1562
1749
|
* @returns any Default Response
|
|
1563
1750
|
* @throws ApiError
|
|
1564
1751
|
*/
|
|
1565
|
-
static postApiV1QuoteRequests(
|
|
1752
|
+
static postApiV1QuoteRequests(requestBody: {
|
|
1753
|
+
formToken: string;
|
|
1754
|
+
email: string;
|
|
1755
|
+
name?: string | null;
|
|
1756
|
+
companyName?: string | null;
|
|
1757
|
+
phone?: string | null;
|
|
1758
|
+
buyerReference?: string | null;
|
|
1759
|
+
message: string;
|
|
1760
|
+
/**
|
|
1761
|
+
* Honeypot — must be empty
|
|
1762
|
+
*/
|
|
1763
|
+
website?: string | null;
|
|
1764
|
+
/**
|
|
1765
|
+
* Client mount time (ms epoch); min fill time enforced
|
|
1766
|
+
*/
|
|
1767
|
+
formLoadedAt?: number;
|
|
1768
|
+
turnstileToken?: string;
|
|
1769
|
+
}, xThrottleEnvironmentId?: string): CancelablePromise<{
|
|
1566
1770
|
data?: {
|
|
1567
1771
|
submitted?: boolean;
|
|
1568
1772
|
};
|