@faststore/api 3.64.0 → 3.65.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.
Files changed (81) hide show
  1. package/dist/cjs/package.json +1 -1
  2. package/dist/cjs/src/__generated__/schema.d.ts +249 -0
  3. package/dist/cjs/src/__generated__/schema.d.ts.map +1 -1
  4. package/dist/cjs/src/__generated__/schema.js +1 -0
  5. package/dist/cjs/src/__generated__/schema.js.map +1 -1
  6. package/dist/cjs/src/index.d.ts +18 -0
  7. package/dist/cjs/src/index.d.ts.map +1 -1
  8. package/dist/cjs/src/platforms/vtex/clients/commerce/index.d.ts +10 -1
  9. package/dist/cjs/src/platforms/vtex/clients/commerce/index.d.ts.map +1 -1
  10. package/dist/cjs/src/platforms/vtex/clients/commerce/index.js +32 -4
  11. package/dist/cjs/src/platforms/vtex/clients/commerce/index.js.map +1 -1
  12. package/dist/cjs/src/platforms/vtex/clients/index.d.ts +9 -0
  13. package/dist/cjs/src/platforms/vtex/clients/index.d.ts.map +1 -1
  14. package/dist/cjs/src/platforms/vtex/index.d.ts +18 -0
  15. package/dist/cjs/src/platforms/vtex/index.d.ts.map +1 -1
  16. package/dist/cjs/src/platforms/vtex/resolvers/mutation.d.ts +3 -0
  17. package/dist/cjs/src/platforms/vtex/resolvers/mutation.d.ts.map +1 -1
  18. package/dist/cjs/src/platforms/vtex/resolvers/mutation.js +2 -0
  19. package/dist/cjs/src/platforms/vtex/resolvers/mutation.js.map +1 -1
  20. package/dist/cjs/src/platforms/vtex/resolvers/processOrderAuthorization.d.ts +6 -0
  21. package/dist/cjs/src/platforms/vtex/resolvers/processOrderAuthorization.d.ts.map +1 -0
  22. package/dist/cjs/src/platforms/vtex/resolvers/processOrderAuthorization.js +18 -0
  23. package/dist/cjs/src/platforms/vtex/resolvers/processOrderAuthorization.js.map +1 -0
  24. package/dist/cjs/src/platforms/vtex/resolvers/query.d.ts +14 -1
  25. package/dist/cjs/src/platforms/vtex/resolvers/query.d.ts.map +1 -1
  26. package/dist/cjs/src/platforms/vtex/resolvers/query.js +64 -0
  27. package/dist/cjs/src/platforms/vtex/resolvers/query.js.map +1 -1
  28. package/dist/cjs/src/platforms/vtex/utils/commercialAuth.d.ts +12 -0
  29. package/dist/cjs/src/platforms/vtex/utils/commercialAuth.d.ts.map +1 -0
  30. package/dist/cjs/src/platforms/vtex/utils/commercialAuth.js +44 -0
  31. package/dist/cjs/src/platforms/vtex/utils/commercialAuth.js.map +1 -0
  32. package/dist/cjs/src/typeDefs/mutation.graphql +6 -0
  33. package/dist/cjs/src/typeDefs/orderCommercialAuthorizaton.graphql +399 -0
  34. package/dist/cjs/src/typeDefs/query.graphql +43 -0
  35. package/dist/cjs/src/typeDefs/userOrder.graphql +4 -0
  36. package/dist/esm/package.json +1 -1
  37. package/dist/esm/src/__generated__/schema.d.ts +249 -0
  38. package/dist/esm/src/__generated__/schema.d.ts.map +1 -1
  39. package/dist/esm/src/__generated__/schema.js +1 -0
  40. package/dist/esm/src/__generated__/schema.js.map +1 -1
  41. package/dist/esm/src/index.d.ts +18 -0
  42. package/dist/esm/src/index.d.ts.map +1 -1
  43. package/dist/esm/src/platforms/vtex/clients/commerce/index.d.ts +10 -1
  44. package/dist/esm/src/platforms/vtex/clients/commerce/index.d.ts.map +1 -1
  45. package/dist/esm/src/platforms/vtex/clients/commerce/index.js +32 -4
  46. package/dist/esm/src/platforms/vtex/clients/commerce/index.js.map +1 -1
  47. package/dist/esm/src/platforms/vtex/clients/index.d.ts +9 -0
  48. package/dist/esm/src/platforms/vtex/clients/index.d.ts.map +1 -1
  49. package/dist/esm/src/platforms/vtex/index.d.ts +18 -0
  50. package/dist/esm/src/platforms/vtex/index.d.ts.map +1 -1
  51. package/dist/esm/src/platforms/vtex/resolvers/mutation.d.ts +3 -0
  52. package/dist/esm/src/platforms/vtex/resolvers/mutation.d.ts.map +1 -1
  53. package/dist/esm/src/platforms/vtex/resolvers/mutation.js +2 -0
  54. package/dist/esm/src/platforms/vtex/resolvers/mutation.js.map +1 -1
  55. package/dist/esm/src/platforms/vtex/resolvers/processOrderAuthorization.d.ts +6 -0
  56. package/dist/esm/src/platforms/vtex/resolvers/processOrderAuthorization.d.ts.map +1 -0
  57. package/dist/esm/src/platforms/vtex/resolvers/processOrderAuthorization.js +14 -0
  58. package/dist/esm/src/platforms/vtex/resolvers/processOrderAuthorization.js.map +1 -0
  59. package/dist/esm/src/platforms/vtex/resolvers/query.d.ts +14 -1
  60. package/dist/esm/src/platforms/vtex/resolvers/query.d.ts.map +1 -1
  61. package/dist/esm/src/platforms/vtex/resolvers/query.js +64 -0
  62. package/dist/esm/src/platforms/vtex/resolvers/query.js.map +1 -1
  63. package/dist/esm/src/platforms/vtex/utils/commercialAuth.d.ts +12 -0
  64. package/dist/esm/src/platforms/vtex/utils/commercialAuth.d.ts.map +1 -0
  65. package/dist/esm/src/platforms/vtex/utils/commercialAuth.js +39 -0
  66. package/dist/esm/src/platforms/vtex/utils/commercialAuth.js.map +1 -0
  67. package/dist/esm/src/typeDefs/mutation.graphql +6 -0
  68. package/dist/esm/src/typeDefs/orderCommercialAuthorizaton.graphql +399 -0
  69. package/dist/esm/src/typeDefs/query.graphql +43 -0
  70. package/dist/esm/src/typeDefs/userOrder.graphql +4 -0
  71. package/package.json +2 -2
  72. package/src/__generated__/schema.ts +268 -0
  73. package/src/platforms/vtex/clients/commerce/index.ts +65 -4
  74. package/src/platforms/vtex/resolvers/mutation.ts +2 -0
  75. package/src/platforms/vtex/resolvers/processOrderAuthorization.ts +30 -0
  76. package/src/platforms/vtex/resolvers/query.ts +87 -0
  77. package/src/platforms/vtex/utils/commercialAuth.ts +55 -0
  78. package/src/typeDefs/mutation.graphql +6 -0
  79. package/src/typeDefs/orderCommercialAuthorizaton.graphql +399 -0
  80. package/src/typeDefs/query.graphql +43 -0
  81. package/src/typeDefs/userOrder.graphql +4 -0
@@ -0,0 +1,399 @@
1
+ """
2
+ Commercial Authorization response.
3
+ """
4
+ type CommercialAuthorizationResponse {
5
+ """
6
+ Commercial Authorization ID.
7
+ """
8
+ id: String!
9
+ """
10
+ Order ID associated with the commercial authorization.
11
+ """
12
+ orderId: String!
13
+ """
14
+ Workflow instance ID.
15
+ """
16
+ workflowInstanceId: String!
17
+ """
18
+ Current status of the commercial authorization.
19
+ """
20
+ status: CommercialAuthorizationStatus!
21
+ """
22
+ List of units.
23
+ """
24
+ units: [String!]!
25
+ """
26
+ Callback endpoint URL.
27
+ """
28
+ callbackEndpoint: String!
29
+ """
30
+ Total order value desired by the seller.
31
+ """
32
+ totalOrderValueDesiredBySeller: Float!
33
+ """
34
+ Marketplace payment value.
35
+ """
36
+ marketPlacePaymentValue: Float!
37
+ """
38
+ Collection of items in the commercial authorization.
39
+ """
40
+ itemCollection: [CommercialAuthorizationItem!]!
41
+ """
42
+ Additional information as key-value pairs.
43
+ """
44
+ additionalInfo: JSONObject!
45
+ """
46
+ Dimension status information.
47
+ """
48
+ dimensionStatus: [CommercialAuthorizationDimensionStatus!]!
49
+ """
50
+ Creation version.
51
+ """
52
+ creationVersion: String!
53
+ """
54
+ Creation environment.
55
+ """
56
+ creationEnvironment: String!
57
+ """
58
+ User profile ID.
59
+ """
60
+ userProfileId: String!
61
+ }
62
+
63
+ """
64
+ Commercial Authorization status.
65
+ """
66
+ enum CommercialAuthorizationStatus {
67
+ """
68
+ Authorization is pending.
69
+ """
70
+ pending
71
+ """
72
+ Authorization has been accepted.
73
+ """
74
+ accepted
75
+ """
76
+ Authorization has been denied.
77
+ """
78
+ denied
79
+ }
80
+
81
+ """
82
+ Commercial Authorization item.
83
+ """
84
+ type CommercialAuthorizationItem {
85
+ """
86
+ Item ID.
87
+ """
88
+ id: String!
89
+ """
90
+ Item SKU.
91
+ """
92
+ sku: String!
93
+ """
94
+ Item price.
95
+ """
96
+ price: Float!
97
+ """
98
+ Total system discount applied.
99
+ """
100
+ totalSystemDiscount: Float!
101
+ """
102
+ Total manual discount applied.
103
+ """
104
+ totalManualDiscount: Float!
105
+ """
106
+ Item quantity.
107
+ """
108
+ quantity: Int!
109
+ """
110
+ Additional information as key-value pairs.
111
+ """
112
+ additionalInfo: JSONObject!
113
+ }
114
+
115
+ """
116
+ Commercial Authorization dimension status.
117
+ """
118
+ type CommercialAuthorizationDimensionStatus {
119
+ """
120
+ Dimension status ID.
121
+ """
122
+ id: String!
123
+ """
124
+ Dimension status name.
125
+ """
126
+ name: String!
127
+ """
128
+ Unit ID, if applicable.
129
+ """
130
+ unitId: String
131
+ """
132
+ Current status of the dimension.
133
+ """
134
+ status: CommercialAuthorizationStatus!
135
+ """
136
+ Dimension score.
137
+ """
138
+ score: Float!
139
+ """
140
+ Priority level.
141
+ """
142
+ priority: Int!
143
+ """
144
+ Indicates if simulation should be performed.
145
+ """
146
+ shouldSimulate: Boolean!
147
+ """
148
+ Collection of rules for this dimension.
149
+ """
150
+ ruleCollection: [CommercialAuthorizationRule!]!
151
+ """
152
+ Creation date.
153
+ """
154
+ creationDate: String!
155
+ """
156
+ Creation version.
157
+ """
158
+ creationVersion: String!
159
+ """
160
+ Creation environment.
161
+ """
162
+ creationEnvironment: String!
163
+ """
164
+ Indicates if all rules acceptance is required.
165
+ """
166
+ requireAllRulesAcceptance: Boolean!
167
+ }
168
+
169
+ """
170
+ Commercial Authorization rule.
171
+ """
172
+ type CommercialAuthorizationRule {
173
+ """
174
+ Rule ID.
175
+ """
176
+ id: String!
177
+ """
178
+ Rule name.
179
+ """
180
+ name: String!
181
+ """
182
+ Current status of the rule.
183
+ """
184
+ status: CommercialAuthorizationStatus!
185
+ """
186
+ DO ID, if applicable.
187
+ """
188
+ doId: String
189
+ """
190
+ List of authorized email addresses.
191
+ """
192
+ authorizedEmails: [String!]!
193
+ """
194
+ Rule priority.
195
+ """
196
+ priority: Int!
197
+ """
198
+ Rule trigger configuration.
199
+ """
200
+ trigger: CommercialAuthorizationRuleTrigger!
201
+ """
202
+ Timeout value.
203
+ """
204
+ timeout: Int!
205
+ """
206
+ Indicates if notification is enabled.
207
+ """
208
+ notification: Boolean!
209
+ """
210
+ Score interval configuration.
211
+ """
212
+ scoreInterval: CommercialAuthorizationRuleScoreInterval!
213
+ """
214
+ Authorization data, if available.
215
+ """
216
+ authorizationData: CommercialAuthorizationRuleAuthorizationData
217
+ """
218
+ Indicates that the user is listed as one of the possible approvers,
219
+ but does not necessarily mean that he or she is the next in the chain to approve.
220
+ """
221
+ isUserAuthorized: Boolean!
222
+ """
223
+ Indicates that the user is next in the approval chain.
224
+ This means that they must take an approval or rejection action.
225
+ """
226
+ isUserNextAuthorizer: Boolean!
227
+ }
228
+
229
+ """
230
+ Commercial Authorization rule trigger.
231
+ """
232
+ type CommercialAuthorizationRuleTrigger {
233
+ """
234
+ Trigger condition.
235
+ """
236
+ condition: CommercialAuthorizationRuleTriggerCondition!
237
+ """
238
+ Trigger effect.
239
+ """
240
+ effect: CommercialAuthorizationRuleTriggerEffect!
241
+ }
242
+
243
+ """
244
+ Commercial Authorization rule trigger condition.
245
+ """
246
+ type CommercialAuthorizationRuleTriggerCondition {
247
+ """
248
+ Condition type.
249
+ """
250
+ conditionType: Int!
251
+ """
252
+ Condition description.
253
+ """
254
+ description: String
255
+ """
256
+ Less than value.
257
+ """
258
+ lessThan: Float
259
+ """
260
+ Greater than value.
261
+ """
262
+ greatherThan: Float
263
+ """
264
+ Condition expression.
265
+ """
266
+ expression: String
267
+ }
268
+
269
+ """
270
+ Commercial Authorization rule trigger effect.
271
+ """
272
+ type CommercialAuthorizationRuleTriggerEffect {
273
+ """
274
+ Effect description.
275
+ """
276
+ description: String
277
+ """
278
+ Effect type.
279
+ """
280
+ effectType: Int!
281
+ """
282
+ Function path.
283
+ """
284
+ funcPath: String
285
+ }
286
+
287
+ """
288
+ Commercial Authorization rule score interval.
289
+ """
290
+ type CommercialAuthorizationRuleScoreInterval {
291
+ """
292
+ Accept score threshold.
293
+ """
294
+ accept: Float!
295
+ """
296
+ Deny score threshold.
297
+ """
298
+ deny: Float!
299
+ }
300
+
301
+ """
302
+ Commercial Authorization rule authorization data.
303
+ """
304
+ type CommercialAuthorizationRuleAuthorizationData {
305
+ """
306
+ Indicates if all approvals are required.
307
+ """
308
+ requireAllApprovals: Boolean!
309
+ """
310
+ List of authorizers.
311
+ """
312
+ authorizers: [CommercialAuthorizationRuleAuthorizer!]!
313
+ }
314
+
315
+ """
316
+ Commercial Authorization rule authorizer.
317
+ """
318
+ type CommercialAuthorizationRuleAuthorizer {
319
+ """
320
+ Authorizer ID.
321
+ """
322
+ id: String!
323
+ """
324
+ Authorizer email.
325
+ """
326
+ email: String
327
+ """
328
+ Authorizer type.
329
+ """
330
+ type: String!
331
+ """
332
+ Authorization date.
333
+ """
334
+ authorizationDate: String
335
+ }
336
+
337
+ """
338
+ Input to get commercial authorizations by order ID.
339
+ """
340
+ input ICommercialAuthorizationByOrderId {
341
+ """
342
+ Order ID to get commercial authorizations for.
343
+ """
344
+ orderId: String!
345
+ }
346
+
347
+ """
348
+ Input to process order authorization (approve or reject).
349
+ """
350
+ input IProcessOrderAuthorization {
351
+ """
352
+ Order authorization ID.
353
+ """
354
+ orderAuthorizationId: String!
355
+ """
356
+ Rule ID associated with the authorization.
357
+ """
358
+ ruleId: String!
359
+ """
360
+ Dimension ID associated with the authorization.
361
+ """
362
+ dimensionId: String!
363
+ """
364
+ Whether the authorization is approved (true) or rejected (false).
365
+ """
366
+ approved: Boolean!
367
+ }
368
+
369
+ """
370
+ Process Order Authorization response.
371
+ """
372
+ type ProcessOrderAuthorizationResponse {
373
+ """
374
+ Indicates if authorization is pending for other authorizers.
375
+ """
376
+ isPendingForOtherAuthorizer: Boolean!
377
+ """
378
+ The updated rule for authorization, if any.
379
+ """
380
+ ruleForAuthorization: ProcessOrderAuthorizationRule
381
+ }
382
+
383
+ """
384
+ Extended Commercial Authorization rule with additional process context.
385
+ """
386
+ type ProcessOrderAuthorizationRule {
387
+ """
388
+ Order authorization ID.
389
+ """
390
+ orderAuthorizationId: String!
391
+ """
392
+ Dimension ID.
393
+ """
394
+ dimensionId: String!
395
+ """
396
+ Base rule information.
397
+ """
398
+ rule: CommercialAuthorizationRule!
399
+ }
@@ -414,6 +414,18 @@ type Query {
414
414
  ): UserOrderListMinimalResult
415
415
  @cacheControl(scope: "public", sMaxAge: 120, staleWhileRevalidate: 3600)
416
416
 
417
+ """
418
+ Returns information about the current user details.
419
+ """
420
+ userDetails: StoreUserDetails!
421
+ @cacheControl(scope: "public", sMaxAge: 120, staleWhileRevalidate: 3600)
422
+
423
+ """
424
+ Returns the account profile information for the current authenticated user (b2b or b2c user).
425
+ """
426
+ accountProfile: StoreAccountProfile!
427
+ @cacheControl(scope: "public", sMaxAge: 120, staleWhileRevalidate: 3600)
428
+
417
429
  """
418
430
  Returns the account name of the current user or the B2B contract name if applicable.
419
431
  """
@@ -476,3 +488,34 @@ type SellerInfo {
476
488
  """
477
489
  logo: String
478
490
  }
491
+
492
+ """
493
+ User details information.
494
+ """
495
+ type StoreUserDetails {
496
+ """
497
+ User's name.
498
+ """
499
+ name: String
500
+ """
501
+ User's email.
502
+ """
503
+ email: String
504
+ """
505
+ User's role.
506
+ """
507
+ role: [String]
508
+ """
509
+ User's organizational unit.
510
+ """
511
+ orgUnit: String
512
+ }
513
+
514
+ """
515
+ Account profile information.
516
+ """
517
+ type StoreAccountProfile {
518
+ name: String
519
+ email: String
520
+ id: String
521
+ }
@@ -57,11 +57,14 @@ type UserOrder {
57
57
  totals: [UserOrderTotals]
58
58
  deliveryOptionsData: UserOrderDeliveryOptionsData
59
59
  customFields: [UserOrderCustomFieldsGrouped]
60
+ canProcessOrderAuthorization: Boolean
61
+ ruleForAuthorization: ProcessOrderAuthorizationRule
60
62
  }
61
63
 
62
64
  type UserOrderResult {
63
65
  orderId: String
64
66
  status: String
67
+ canProcessOrderAuthorization: Boolean
65
68
  statusDescription: String
66
69
  allowCancellation: Boolean
67
70
  storePreferencesData: UserOrderStorePreferencesData
@@ -73,6 +76,7 @@ type UserOrderResult {
73
76
  totals: [UserOrderTotals]
74
77
  shippingData: UserOrderShippingData
75
78
  items: [UserOrderItems]
79
+ ruleForAuthorization: ProcessOrderAuthorizationRule
76
80
  }
77
81
 
78
82
  type UserOrderListResult {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@faststore/api",
3
- "version": "3.64.0",
3
+ "version": "3.65.0",
4
4
  "license": "MIT",
5
5
  "main": "dist/cjs/src/index.js",
6
6
  "typings": "dist/esm/src/index.d.ts",
@@ -73,5 +73,5 @@
73
73
  "volta": {
74
74
  "extends": "../../package.json"
75
75
  },
76
- "gitHead": "016d1a9af1ac985995f4a0ffb523144869289fb8"
76
+ "gitHead": "1dea73f0a9afa63aa0edcc3eb8433bd1155f3e74"
77
77
  }