@spscommerce/asst-api 1.2.1 → 1.3.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/msw.d.ts CHANGED
@@ -1,30 +1,10 @@
1
1
  import * as msw from 'msw';
2
- import { ResponseResolver, RestRequest, RestContext, DefaultBodyType } from 'msw';
3
- import * as msw_lib_glossary_de6278a9 from 'msw/lib/glossary-de6278a9';
4
- import { A as AsstClient, I as ImportErrors, a as Import, b as ImportsStatus, V as VendorPartnerAttGroups, c as ItemCategoriesSearch, E as Export, d as attrProdTypeSchema, T as TradingPartnerAccessByCompanyId, e as CompanyRelationshipUpsertBody, U as UserAccount, f as ItemErrorDetailsResult, g as ItemErrorSummaryResultV2, h as ItemErrorDetailsResultV2, L as Locale, i as ItemSearchView, j as ItemDetailView, k as AttributeMetaData, l as AttributesByCompany, m as AttributeDefinition, n as AttributeValidValues, S as SpreadsheetTemplate } from './CompanyBriefByOrg-LTdsUKm4.js';
2
+ import { ResponseResolver, HttpResponseResolver } from 'msw';
3
+ import { A as AsstClient, S as SpsItemIdResponse, a as AttributeValidValues } from './CompanyBriefByOrg-itus4RMD.js';
5
4
  import { z } from 'zod';
6
- import { R as RetailerTradingPartnerStages, I as ItemStatusResponse } from './index-Zz-6wNSh.js';
7
- export { c as createCompaniesApi } from './index-Zz-6wNSh.js';
5
+ export { c as createCompaniesApi } from './index-BFKgtuVI.js';
8
6
  import 'ky';
9
7
 
10
- declare function pagedResultsSchema<T extends z.ZodTypeAny>(resultsType: T): z.ZodObject<{
11
- next: z.ZodString;
12
- previous: z.ZodString;
13
- count: z.ZodNumber;
14
- results: z.ZodArray<T, "many">;
15
- }, "strip", z.ZodTypeAny, {
16
- count: number;
17
- next: string;
18
- previous: string;
19
- results: T["_output"][];
20
- }, {
21
- count: number;
22
- next: string;
23
- previous: string;
24
- results: T["_input"][];
25
- }>;
26
- type PagedResults<T extends z.ZodTypeAny> = z.infer<ReturnType<typeof pagedResultsSchema<T>>>;
27
-
28
8
  /**
29
9
  * Generate collection of MSW request handlers for `ImportsApi`
30
10
  * @param client Assortment Client instance
@@ -32,11 +12,7 @@ type PagedResults<T extends z.ZodTypeAny> = z.infer<ReturnType<typeof pagedResul
32
12
  */
33
13
  declare function createImportsApiHandlers(client: AsstClient): {
34
14
  getImportErrors: {
35
- (resolver?: ResponseResolver<RestRequest<never, {
36
- importId: string;
37
- offset?: string;
38
- limit?: string;
39
- }>, RestContext, ImportErrors>): msw.RestHandler<msw_lib_glossary_de6278a9.M<DefaultBodyType>>;
15
+ (resolver?: ResponseResolver): msw.HttpHandler;
40
16
  generateData(): {
41
17
  importId: number;
42
18
  count: number;
@@ -51,9 +27,7 @@ declare function createImportsApiHandlers(client: AsstClient): {
51
27
  };
52
28
  };
53
29
  getImports: {
54
- (resolver?: ResponseResolver<RestRequest<never, {
55
- status?: string;
56
- }>, RestContext, Import>): msw.RestHandler<msw_lib_glossary_de6278a9.M<DefaultBodyType>>;
30
+ (resolver?: ResponseResolver): msw.HttpHandler;
57
31
  generateData(): {
58
32
  count: number;
59
33
  imports: {
@@ -68,7 +42,7 @@ declare function createImportsApiHandlers(client: AsstClient): {
68
42
  };
69
43
  };
70
44
  getImportsStatus: {
71
- (resolver?: ResponseResolver<RestRequest<never, never>, RestContext, ImportsStatus[]>): msw.RestHandler<msw_lib_glossary_de6278a9.M<DefaultBodyType>>;
45
+ (resolver?: ResponseResolver): msw.HttpHandler;
72
46
  generateData(): {
73
47
  status: "QUEUED_FOR_IMPORT" | "IN_PROGRESS" | "DOC_FAILED" | "VALIDATION_FAILED" | "COMPLETED";
74
48
  importId: number;
@@ -82,15 +56,15 @@ declare function createImportsApiHandlers(client: AsstClient): {
82
56
  }[];
83
57
  };
84
58
  getVendorPartnerGroups: {
85
- (resolver?: ResponseResolver<RestRequest<never, never>, RestContext, VendorPartnerAttGroups[]>): msw.RestHandler<msw_lib_glossary_de6278a9.M<DefaultBodyType>>;
59
+ (resolver?: ResponseResolver): msw.HttpHandler;
86
60
  generateData(): {
87
61
  partnerCompanyId: number;
88
62
  partnerCompanyName: string;
89
63
  partnerAttributeGroups: number[];
90
64
  }[];
91
65
  };
92
- uploadImport: (resolver?: ResponseResolver) => msw.RestHandler<msw_lib_glossary_de6278a9.M<DefaultBodyType>>;
93
- generateImportTemplate: (resolver?: ResponseResolver) => msw.RestHandler<msw_lib_glossary_de6278a9.M<DefaultBodyType>>;
66
+ uploadImport: (resolver?: ResponseResolver) => msw.HttpHandler;
67
+ generateImportTemplate: (resolver?: ResponseResolver) => msw.HttpHandler;
94
68
  };
95
69
 
96
70
  /**
@@ -100,9 +74,7 @@ declare function createImportsApiHandlers(client: AsstClient): {
100
74
  */
101
75
  declare function createCategoriesApiHandlers(client: AsstClient): {
102
76
  getCategory: {
103
- (resolver?: ResponseResolver<RestRequest<never, {
104
- categoryName?: string;
105
- }>, RestContext, ItemCategoriesSearch>): msw.RestHandler<msw_lib_glossary_de6278a9.M<DefaultBodyType>>;
77
+ (resolver?: ResponseResolver): msw.HttpHandler;
106
78
  generateData(): {
107
79
  count: number;
108
80
  data: {
@@ -129,8 +101,8 @@ declare function createCategoriesApiHandlers(client: AsstClient): {
129
101
  * @returns An object containing functions to generate MSW request handlers
130
102
  */
131
103
  declare function createExportsApiHandlers(client: AsstClient): {
132
- createExport: (resolver?: ResponseResolver<RestRequest<Export>, RestContext>) => msw.RestHandler<msw_lib_glossary_de6278a9.M<msw_lib_glossary_de6278a9.h>>;
133
- downloadItems: (resolver?: ResponseResolver) => msw.RestHandler<msw_lib_glossary_de6278a9.M<msw_lib_glossary_de6278a9.h>>;
104
+ createExport: (resolver?: ResponseResolver) => msw.HttpHandler;
105
+ downloadItems: (resolver?: ResponseResolver) => msw.HttpHandler;
134
106
  };
135
107
 
136
108
  /**
@@ -140,9 +112,7 @@ declare function createExportsApiHandlers(client: AsstClient): {
140
112
  */
141
113
  declare function createProductTypesApiHandlers(client: AsstClient): {
142
114
  getProductTypes: {
143
- (resolver?: ResponseResolver<RestRequest<never, {
144
- retailerIds: string;
145
- }>, RestContext, PagedResults<typeof attrProdTypeSchema>>): msw.RestHandler<msw_lib_glossary_de6278a9.M<DefaultBodyType>>;
115
+ (resolver?: ResponseResolver): msw.HttpHandler;
146
116
  generateData(): {
147
117
  count: number;
148
118
  next: string;
@@ -168,7 +138,7 @@ declare function createProductTypesApiHandlers(client: AsstClient): {
168
138
  */
169
139
  declare function createTradingPartnerAccessApiHandlers(client: AsstClient): {
170
140
  getAllTradingPartners: {
171
- (resolver?: ResponseResolver<RestRequest<never>, RestContext, TradingPartnerAccessByCompanyId>): msw.RestHandler<msw_lib_glossary_de6278a9.M<msw_lib_glossary_de6278a9.h>>;
141
+ (resolver?: ResponseResolver): msw.HttpHandler;
172
142
  generateData(): {
173
143
  count: number;
174
144
  companyId: number;
@@ -185,7 +155,7 @@ declare function createTradingPartnerAccessApiHandlers(client: AsstClient): {
185
155
  };
186
156
  };
187
157
  upsertRelationship: {
188
- (resolver?: ResponseResolver<RestRequest<CompanyRelationshipUpsertBody>, RestContext>): msw.RestHandler<msw_lib_glossary_de6278a9.M<msw_lib_glossary_de6278a9.h>>;
158
+ (resolver?: ResponseResolver): msw.HttpHandler;
189
159
  generateData(): {
190
160
  isActive: number;
191
161
  createdDate: string;
@@ -197,7 +167,7 @@ declare function createTradingPartnerAccessApiHandlers(client: AsstClient): {
197
167
  applications: ("ASSORTMENT" | "ITEM-XREF")[];
198
168
  };
199
169
  };
200
- upsertHierarchy: (resolver?: ResponseResolver<RestRequest<CompanyRelationshipUpsertBody>, RestContext>) => msw.RestHandler<msw_lib_glossary_de6278a9.M<msw_lib_glossary_de6278a9.h>>;
170
+ upsertHierarchy: (resolver?: ResponseResolver) => msw.HttpHandler;
201
171
  };
202
172
 
203
173
  /**
@@ -207,7 +177,7 @@ declare function createTradingPartnerAccessApiHandlers(client: AsstClient): {
207
177
  */
208
178
  declare function createTradingPartnerSettingsApiHandlers(client: AsstClient): {
209
179
  getRetailerStages: {
210
- (resolver?: ResponseResolver<RestRequest<never>, RestContext, RetailerTradingPartnerStages>): msw.RestHandler<msw_lib_glossary_de6278a9.M<msw_lib_glossary_de6278a9.h>>;
180
+ (resolver?: ResponseResolver): msw.HttpHandler;
211
181
  generateData(): ("Core" | "Core Plus" | "Core Advanced" | "Enriched" | "Standard Requirements")[];
212
182
  };
213
183
  };
@@ -219,7 +189,7 @@ declare function createTradingPartnerSettingsApiHandlers(client: AsstClient): {
219
189
  */
220
190
  declare function createWhoAmIApiHandlers(client: AsstClient): {
221
191
  whoAmI: {
222
- (resolver?: ResponseResolver<RestRequest<never>, RestContext, UserAccount>): msw.RestHandler<msw_lib_glossary_de6278a9.M<msw_lib_glossary_de6278a9.h>>;
192
+ (resolver?: ResponseResolver): msw.HttpHandler;
223
193
  generateData(): {
224
194
  name: string;
225
195
  companyId: number;
@@ -303,9 +273,7 @@ declare function createWhoAmIApiHandlers(client: AsstClient): {
303
273
  */
304
274
  declare function createErrorsApiHandlers(client: AsstClient): {
305
275
  getInvalidItemErrorDetails: {
306
- (resolver?: ResponseResolver<RestRequest<never, {
307
- itemInfoId: string;
308
- }>, RestContext, ItemErrorDetailsResult>): msw.RestHandler<msw_lib_glossary_de6278a9.M<DefaultBodyType>>;
276
+ (resolver?: ResponseResolver): msw.HttpHandler;
309
277
  generateData(): {
310
278
  itemInfoId: number;
311
279
  itemName: string | null;
@@ -338,11 +306,9 @@ declare function createErrorsApiHandlers(client: AsstClient): {
338
306
  * @returns An object containing functions to generate MSW request handlers
339
307
  */
340
308
  declare function createErrorsApiV2Handlers(client: AsstClient): {
341
- getItemErrorSummary: (resolver?: ResponseResolver<RestRequest, RestContext, ItemErrorSummaryResultV2>) => msw.RestHandler<msw_lib_glossary_de6278a9.M<DefaultBodyType>>;
309
+ getItemErrorSummary: (resolver?: ResponseResolver) => msw.HttpHandler;
342
310
  getItemErrorDetails: {
343
- (resolver?: ResponseResolver<RestRequest<never, {
344
- itemInfoId: string;
345
- }>, RestContext, ItemErrorDetailsResultV2>): msw.RestHandler<msw_lib_glossary_de6278a9.M<DefaultBodyType>>;
311
+ (resolver?: ResponseResolver): msw.HttpHandler;
346
312
  generateData(): {
347
313
  itemInfoId: number;
348
314
  itemErrorDetails: {
@@ -382,7 +348,7 @@ declare function createErrorsApiV2Handlers(client: AsstClient): {
382
348
  */
383
349
  declare function createLocaleApiHandlers(client: AsstClient): {
384
350
  getLocale: {
385
- (resolver?: ResponseResolver<RestRequest<never, never>, RestContext, Locale[]>): msw.RestHandler<msw_lib_glossary_de6278a9.M<msw_lib_glossary_de6278a9.h>>;
351
+ (resolver?: ResponseResolver): msw.HttpHandler;
386
352
  generateData(): {
387
353
  localeCode: string;
388
354
  localeDescription: string;
@@ -397,11 +363,7 @@ declare function createLocaleApiHandlers(client: AsstClient): {
397
363
  */
398
364
  declare function createItemsApiHandlers(client: AsstClient): {
399
365
  searchItems: {
400
- (resolver?: ResponseResolver<RestRequest<never, {
401
- url?: string;
402
- offset?: string;
403
- limit?: string;
404
- }>, RestContext, ItemSearchView>): msw.RestHandler<msw_lib_glossary_de6278a9.M<DefaultBodyType>>;
366
+ (resolver?: ResponseResolver): msw.HttpHandler;
405
367
  generateData(): {
406
368
  count: number;
407
369
  hasNext: boolean;
@@ -460,9 +422,7 @@ declare function createItemsApiHandlers(client: AsstClient): {
460
422
  };
461
423
  };
462
424
  getItem: {
463
- (resolver?: ResponseResolver<RestRequest<never, {
464
- itemId: string;
465
- }>, RestContext, ItemDetailView>): msw.RestHandler<msw_lib_glossary_de6278a9.M<DefaultBodyType>>;
425
+ (resolver?: ResponseResolver): msw.HttpHandler;
466
426
  generateData(): {
467
427
  item: {
468
428
  status: string;
@@ -580,31 +540,24 @@ declare function createItemsApiHandlers(client: AsstClient): {
580
540
  };
581
541
  };
582
542
  };
583
- updateItem: (resolver?: ResponseResolver<RestRequest<never, {
584
- itemId: string;
585
- }>, RestContext>) => msw.RestHandler<msw_lib_glossary_de6278a9.M<DefaultBodyType>>;
586
- deleteItem: (resolver?: ResponseResolver<RestRequest<never, {
587
- itemId: string;
588
- }>>) => msw.RestHandler<msw_lib_glossary_de6278a9.M<DefaultBodyType>>;
589
- deleteItems: (resolver?: ResponseResolver<RestRequest<never, {
590
- itemIds: string[];
591
- }>>) => msw.RestHandler<msw_lib_glossary_de6278a9.M<DefaultBodyType>>;
543
+ updateItem: (resolver?: ResponseResolver) => msw.HttpHandler;
544
+ deleteItem: (resolver?: ResponseResolver) => msw.HttpHandler;
545
+ deleteItems: (resolver?: ResponseResolver) => msw.HttpHandler;
592
546
  getItemInfoId: {
593
- (resolver?: ResponseResolver<RestRequest<never, {
594
- spsItemId: string;
595
- }>, RestContext, number>): msw.RestHandler<msw_lib_glossary_de6278a9.M<DefaultBodyType>>;
547
+ (resolver?: ResponseResolver): msw.HttpHandler;
596
548
  generateData(): number;
597
549
  };
598
550
  getSpsItemId: {
599
- (resolver?: ResponseResolver<RestRequest<never, {
551
+ (resolver?: HttpResponseResolver<{
600
552
  itemInfoId: string;
601
- }>, RestContext, string>): msw.RestHandler<msw_lib_glossary_de6278a9.M<DefaultBodyType>>;
602
- generateData(): string;
553
+ }, never, SpsItemIdResponse>): msw.HttpHandler;
554
+ generateData(): {
555
+ id: string;
556
+ ref: string;
557
+ };
603
558
  };
604
559
  getItemStatus: {
605
- (resolver?: ResponseResolver<RestRequest<never, {
606
- itemIds: string[];
607
- }>, RestContext, ItemStatusResponse>): msw.RestHandler<msw_lib_glossary_de6278a9.M<DefaultBodyType>>;
560
+ (resolver?: ResponseResolver): msw.HttpHandler;
608
561
  generateData(): {
609
562
  itemStatuses: {
610
563
  itemId: string;
@@ -629,7 +582,7 @@ declare function createItemsApiHandlers(client: AsstClient): {
629
582
  */
630
583
  declare function createAttributesApiHandlers(client: AsstClient): {
631
584
  getAllAttributes: {
632
- (resolver?: ResponseResolver<RestRequest<never, never>, RestContext, AttributeMetaData[]>): msw.RestHandler<msw_lib_glossary_de6278a9.M<DefaultBodyType>>;
585
+ (resolver?: ResponseResolver): msw.HttpHandler;
633
586
  generateData(): {
634
587
  type: string;
635
588
  label: string;
@@ -648,10 +601,7 @@ declare function createAttributesApiHandlers(client: AsstClient): {
648
601
  };
649
602
  };
650
603
  getAllAttributesByCompany: {
651
- (resolver?: ResponseResolver<RestRequest<never, {
652
- offset?: string;
653
- limit?: string;
654
- }>, RestContext, AttributesByCompany>): msw.RestHandler<msw_lib_glossary_de6278a9.M<DefaultBodyType>>;
604
+ (resolver?: ResponseResolver): msw.HttpHandler;
655
605
  generateData(): {
656
606
  count: number;
657
607
  results: {
@@ -669,7 +619,7 @@ declare function createAttributesApiHandlers(client: AsstClient): {
669
619
  };
670
620
  };
671
621
  getAttributesExtensiveInfo: {
672
- (resolver?: ResponseResolver<RestRequest<never, never>, RestContext, AttributeDefinition[]>): msw.RestHandler<msw_lib_glossary_de6278a9.M<DefaultBodyType>>;
622
+ (resolver?: ResponseResolver): msw.HttpHandler;
673
623
  generateData(): {
674
624
  createdDate: number;
675
625
  createdBy: string;
@@ -790,9 +740,9 @@ declare function createAttributesApiHandlers(client: AsstClient): {
790
740
  }[];
791
741
  };
792
742
  getAttributeValidValues: {
793
- (resolver?: ResponseResolver<RestRequest<never, {
743
+ (resolver?: HttpResponseResolver<{
794
744
  attributeDbName: string;
795
- }>, RestContext, AttributeValidValues[]>): msw.RestHandler<msw_lib_glossary_de6278a9.M<DefaultBodyType>>;
745
+ }, undefined, AttributeValidValues[]>): msw.HttpHandler;
796
746
  generateData(): {
797
747
  value: string;
798
748
  createdDate: number;
@@ -807,7 +757,7 @@ declare function createAttributesApiHandlers(client: AsstClient): {
807
757
  };
808
758
  };
809
759
  getCompanyInterestedAttributes: {
810
- (resolver?: ResponseResolver<RestRequest<never, never>, RestContext, string[]>): msw.RestHandler<msw_lib_glossary_de6278a9.M<DefaultBodyType>>;
760
+ (resolver?: ResponseResolver): msw.HttpHandler;
811
761
  generateData(): string[];
812
762
  };
813
763
  };
@@ -819,7 +769,7 @@ declare function createAttributesApiHandlers(client: AsstClient): {
819
769
  */
820
770
  declare function createSpreadsheetTemplateApiHandlers(client: AsstClient): {
821
771
  getTemplates: {
822
- (resolver?: ResponseResolver<RestRequest<never, never>, RestContext, SpreadsheetTemplate[]>): msw.RestHandler<msw_lib_glossary_de6278a9.M<msw_lib_glossary_de6278a9.h>>;
772
+ (resolver?: ResponseResolver): msw.HttpHandler;
823
773
  generateData(): {
824
774
  name: string;
825
775
  id: number;
@@ -845,7 +795,7 @@ declare function createSpreadsheetTemplateApiHandlers(client: AsstClient): {
845
795
  * @returns An object containing functions to generate MSW request handlers
846
796
  */
847
797
  declare function createCompanyFeaturesApiHandlers(client: AsstClient): {
848
- checkIfStageItemSetupIsEnabled: (resolver?: ResponseResolver<RestRequest<never>, RestContext, boolean>) => msw.RestHandler<msw_lib_glossary_de6278a9.M<msw_lib_glossary_de6278a9.h>>;
798
+ checkIfStageItemSetupIsEnabled: (resolver?: ResponseResolver) => msw.HttpHandler;
849
799
  };
850
800
 
851
801
  /**
@@ -854,7 +804,8 @@ declare function createCompanyFeaturesApiHandlers(client: AsstClient): {
854
804
  * @returns An object containing functions to generate MSW request handlers
855
805
  */
856
806
  declare function createFeatureFlagsApiHandlers(client: AsstClient): {
857
- checkEnableItemsLevelMSIS: (resolver?: ResponseResolver<RestRequest<never>, RestContext, boolean>) => msw.RestHandler<msw_lib_glossary_de6278a9.M<msw_lib_glossary_de6278a9.h>>;
807
+ checkEnableItemsLevelMSIS: (resolver?: ResponseResolver) => msw.HttpHandler;
808
+ checkIfEnabledForPackagingHierarchies: (resolver?: ResponseResolver) => msw.HttpHandler;
858
809
  };
859
810
 
860
811
  /**
@@ -864,11 +815,13 @@ declare function createFeatureFlagsApiHandlers(client: AsstClient): {
864
815
  */
865
816
  declare function createUniqueCriteriaApiHandlers(client: AsstClient): {
866
817
  getUniqueCriteriaByOrg: {
867
- (resolver?: ResponseResolver<RestRequest<never, {
868
- orgId: string;
869
- }>, RestContext, string[]>): msw.RestHandler<msw_lib_glossary_de6278a9.M<msw_lib_glossary_de6278a9.h>>;
818
+ (resolver?: ResponseResolver): msw.HttpHandler;
870
819
  generateData(): string[];
871
820
  };
821
+ getProductUniqueCriteriaByOrg: {
822
+ (resolver?: ResponseResolver): msw.HttpHandler;
823
+ generateData(): ("gtin" | "upc" | "ean" | "isbn" | "partnumber" | "eaneight" | "upcCaseCode" | "buyerPartNumber" | "sku" | "nationalDrugCode" | "drugIdentificationNumber" | "nationalHealthRelatedItemCode" | "manufacturersPartNumber" | "internationalStandardSerialNumber" | "nabcaNumber" | "erpId" | "componentId")[];
824
+ };
872
825
  };
873
826
 
874
827
  export { createAttributesApiHandlers, createCategoriesApiHandlers, createCompanyFeaturesApiHandlers, createErrorsApiHandlers, createErrorsApiV2Handlers, createExportsApiHandlers, createFeatureFlagsApiHandlers, createImportsApiHandlers, createItemsApiHandlers, createLocaleApiHandlers, createProductTypesApiHandlers, createSpreadsheetTemplateApiHandlers, createTradingPartnerAccessApiHandlers, createTradingPartnerSettingsApiHandlers, createUniqueCriteriaApiHandlers, createWhoAmIApiHandlers };