@spscommerce/asst-api 1.0.1 → 1.2.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.cjs CHANGED
@@ -37,6 +37,7 @@ __export(lib_exports, {
37
37
  createCompaniesApi: () => createCompaniesApi,
38
38
  createCompanyFeaturesApi: () => createCompanyFeaturesApi,
39
39
  createErrorsApi: () => createErrorsApi,
40
+ createErrorsApiV2: () => createErrorsApiV2,
40
41
  createExportsApi: () => createExportsApi,
41
42
  createFeatureFlagsApi: () => createFeatureFlagsApi,
42
43
  createImportsApi: () => createImportsApi,
@@ -4922,7 +4923,8 @@ var exportSchema = z.object({
4922
4923
  spreadsheetTemplateId: z.optional(z.number()),
4923
4924
  emailAddresses: z.optional(z.array(z.string())),
4924
4925
  subjectLine: z.optional(z.string()),
4925
- additionalLocales: z.optional(z.array(z.string()))
4926
+ additionalLocales: z.optional(z.array(z.string())),
4927
+ availableAttributeList: z.optional(z.array(z.string()))
4926
4928
  });
4927
4929
 
4928
4930
  // lib/exports/models/DownloadItemsParams.ts
@@ -4931,7 +4933,7 @@ var downLoadItemsParamsSchema = z.object({
4931
4933
  ids: z.array(z.string())
4932
4934
  });
4933
4935
 
4934
- // lib/errors/models/ItemErrorDetails.ts
4936
+ // lib/errors/v1/models/ItemErrorDetails.ts
4935
4937
  var itemErrorDetailsSchema = z.object({
4936
4938
  errorMessage: z.string(),
4937
4939
  attributeName: z.string().nullable(),
@@ -4942,7 +4944,7 @@ var itemErrorDetailsSchema = z.object({
4942
4944
  repeatableGroupId: z.string().nullish()
4943
4945
  });
4944
4946
 
4945
- // lib/errors/models/ItemErrorDetailsResult.ts
4947
+ // lib/errors/v1/models/ItemErrorDetailsResult.ts
4946
4948
  var itemErrorDetailsResultSchema = z.object({
4947
4949
  itemInfoId: z.number(),
4948
4950
  upc: z.string().nullish(),
@@ -4954,6 +4956,135 @@ var itemErrorDetailsResultSchema = z.object({
4954
4956
  itemErrorDetails: z.array(itemErrorDetailsSchema)
4955
4957
  });
4956
4958
 
4959
+ // lib/items/v2/models/Stage.ts
4960
+ var stageSchema = z.enum([
4961
+ "CORE",
4962
+ "CORE_PLUS",
4963
+ "CORE_ADVANCED",
4964
+ "ENRICHED"
4965
+ ]);
4966
+
4967
+ // lib/items/v2/models/OrgSummary.ts
4968
+ var orgSummarySchema = z.object({
4969
+ ref: z.string(),
4970
+ id: z.string(),
4971
+ name: z.string()
4972
+ });
4973
+
4974
+ // lib/items/v2/models/ItemOrgStageDetails.ts
4975
+ var itemOrgStageDetailsSchema = z.object({
4976
+ /**
4977
+ * When called as retailer, the vendor, else when vendor, the retailer.
4978
+ * */
4979
+ orgSummary: orgSummarySchema,
4980
+ /**
4981
+ * The company id of the retailer or vendor used for matching ItemOrgStageDetails to TradingPartnerStage for ErrorService
4982
+ */
4983
+ companyId: z.number().nullish(),
4984
+ /**
4985
+ * "Standard Requirements" (null) UNLESS the retailer of the item is MSIS Enabled
4986
+ * OTHERWISE the retailer default Stage UNLESS there's a currently active vendor-specific Stage defined
4987
+ * OTHERWISE the trading partnership Stage UNLESS there's a currently active Item Level override defined
4988
+ * OTHERWISE the item level override */
4989
+ stage: stageSchema.nullish(),
4990
+ /**
4991
+ * If the item is valid for the active stage. Note that for "Standard Requirements" or
4992
+ * "Enriched" this cam come directly from the item_doc table, but anything else requires validation
4993
+ */
4994
+ isValid: z.boolean(),
4995
+ /**
4996
+ * Not null if there's an item level policy override for this trading partnership
4997
+ */
4998
+ itemPolicyId: z.string().nullish(),
4999
+ /**
5000
+ * Start date for the Item level Stage if applicable
5001
+ */
5002
+ startDate: z.number().transform((num) => new Date(num * 1e3)).nullish(),
5003
+ /**
5004
+ * End date for the Item level Stage if applicable
5005
+ */
5006
+ endDate: z.number().transform((num) => new Date(num * 1e3)).nullish()
5007
+ });
5008
+
5009
+ // lib/items/v2/models/ItemStatusV2.ts
5010
+ var itemStatusV2Schema = z.object({
5011
+ itemId: z.string(),
5012
+ mostRestrictiveRetailerStage: stageSchema.nullable(),
5013
+ itemOrgStageDetails: z.array(itemOrgStageDetailsSchema)
5014
+ });
5015
+
5016
+ // lib/items/v2/models/ItemStatusV2Response.ts
5017
+ var itemStatusV2ResponseSchema = z.object({
5018
+ itemStatuses: z.array(itemStatusV2Schema)
5019
+ });
5020
+
5021
+ // lib/errors/v2/models/TradingPartnerStage.ts
5022
+ var tradingPartnerStageV2Schema = z.object({
5023
+ companyId: z.number(),
5024
+ companyName: z.string(),
5025
+ stage: stageSchema.nullish(),
5026
+ isValid: z.boolean()
5027
+ });
5028
+
5029
+ // lib/errors/v2/models/ItemErrorSummary.ts
5030
+ var itemErrorSummaryV2Schema = z.object({
5031
+ itemInfoId: z.number(),
5032
+ upc: z.string().nullish(),
5033
+ isbn: z.string().nullish(),
5034
+ gtin: z.string().nullish(),
5035
+ ean: z.string().nullish(),
5036
+ partnumber: z.string().nullish(),
5037
+ colorfamily: z.string().nullish(),
5038
+ fit: z.string().nullish(),
5039
+ productcolordescription: z.string().nullish(),
5040
+ distributioncentercode: z.string().nullish(),
5041
+ accountnumber: z.string().nullish(),
5042
+ erpid: z.string().nullish(),
5043
+ totalErrors: z.number(),
5044
+ tradingPartners: z.array(z.string()),
5045
+ tradingPartnerIds: z.array(z.number()),
5046
+ // These are the stages assigned to the TradingPartners, not the stages of the errors
5047
+ phases: z.array(z.string()),
5048
+ // Same thing for the stage property in here: it's the stage of the Item & TradingPartner, not the stage of the error
5049
+ tradingPartnerStages: z.array(tradingPartnerStageV2Schema),
5050
+ validatedDate: z.number().pipe(z.coerce.date()).nullish()
5051
+ });
5052
+
5053
+ // lib/errors/v2/models/ItemErrorSummaryResult.ts
5054
+ var itemErrorSummaryResultV2Schema = z.object({
5055
+ hasNext: z.boolean(),
5056
+ errors: z.array(itemErrorSummaryV2Schema)
5057
+ });
5058
+
5059
+ // lib/errors/v2/models/ItemErrorDetails.ts
5060
+ var itemErrorDetailsV2Schema = z.object({
5061
+ errorMessage: z.string(),
5062
+ attributeName: z.string(),
5063
+ attributeDbNames: z.array(z.string()),
5064
+ tradingPartnerNames: z.array(z.string()),
5065
+ phases: z.set(stageSchema),
5066
+ tradingPartnerStages: z.array(tradingPartnerStageV2Schema),
5067
+ repeatableGroupId: z.string()
5068
+ });
5069
+
5070
+ // lib/errors/v2/models/ItemErrorDetailsResult.ts
5071
+ var itemErrorDetailsResultV2Schema = z.object({
5072
+ itemInfoId: z.number(),
5073
+ upc: z.string().nullish(),
5074
+ isbn: z.string().nullish(),
5075
+ gtin: z.string().nullish(),
5076
+ partnumber: z.string().nullish(),
5077
+ ean: z.string().nullish(),
5078
+ colorfamily: z.string().nullish(),
5079
+ fit: z.string().nullish(),
5080
+ productcolordescription: z.string().nullish(),
5081
+ distributioncentercode: z.string().nullish(),
5082
+ accountnumber: z.string().nullish(),
5083
+ erpid: z.string().nullish(),
5084
+ itemName: z.string().nullish(),
5085
+ itemErrorDetails: z.array(itemErrorDetailsV2Schema)
5086
+ });
5087
+
4957
5088
  // lib/companies/models/CompanyBriefByOrg.ts
4958
5089
  var companyBriefByOrgSchema = z.object({
4959
5090
  companyId: z.number(),
@@ -5259,68 +5390,6 @@ function createItemsApi(client) {
5259
5390
  };
5260
5391
  }
5261
5392
 
5262
- // lib/items/v2/models/Stage.ts
5263
- var stageSchema = z.enum([
5264
- "CORE",
5265
- "CORE_PLUS",
5266
- "CORE_ADVANCED",
5267
- "ENRICHED"
5268
- ]);
5269
-
5270
- // lib/items/v2/models/OrgSummary.ts
5271
- var orgSummarySchema = z.object({
5272
- ref: z.string(),
5273
- id: z.string(),
5274
- name: z.string()
5275
- });
5276
-
5277
- // lib/items/v2/models/ItemOrgStageDetails.ts
5278
- var itemOrgStageDetailsSchema = z.object({
5279
- /**
5280
- * When called as retailer, the vendor, else when vendor, the retailer.
5281
- * */
5282
- orgSummary: orgSummarySchema,
5283
- /**
5284
- * The company id of the retailer or vendor used for matching ItemOrgStageDetails to TradingPartnerStage for ErrorService
5285
- */
5286
- companyId: z.number().nullish(),
5287
- /**
5288
- * "Standard Requirements" (null) UNLESS the retailer of the item is MSIS Enabled
5289
- * OTHERWISE the retailer default Stage UNLESS there's a currently active vendor-specific Stage defined
5290
- * OTHERWISE the trading partnership Stage UNLESS there's a currently active Item Level override defined
5291
- * OTHERWISE the item level override */
5292
- stage: stageSchema.nullish(),
5293
- /**
5294
- * If the item is valid for the active stage. Note that for "Standard Requirements" or
5295
- * "Enriched" this cam come directly from the item_doc table, but anything else requires validation
5296
- */
5297
- isValid: z.boolean(),
5298
- /**
5299
- * Not null if there's an item level policy override for this trading partnership
5300
- */
5301
- itemPolicyId: z.string().nullish(),
5302
- /**
5303
- * Start date for the Item level Stage if applicable
5304
- */
5305
- startDate: z.number().pipe(z.coerce.date()).nullish(),
5306
- /**
5307
- * End date for the Item level Stage if applicable
5308
- */
5309
- endDate: z.number().pipe(z.coerce.date()).nullish()
5310
- });
5311
-
5312
- // lib/items/v2/models/ItemStatusV2.ts
5313
- var itemStatusV2Schema = z.object({
5314
- itemId: z.string(),
5315
- mostRestrictiveRetailerStage: stageSchema.nullable(),
5316
- itemOrgStageDetails: z.array(itemOrgStageDetailsSchema)
5317
- });
5318
-
5319
- // lib/items/v2/models/ItemStatusV2Response.ts
5320
- var itemStatusV2ResponseSchema = z.object({
5321
- itemStatuses: z.array(itemStatusV2Schema)
5322
- });
5323
-
5324
5393
  // lib/items/v2/index.ts
5325
5394
  var BASE_URL14 = "v2/items";
5326
5395
  function createItemsApiV2(client) {
@@ -5333,7 +5402,7 @@ function createItemsApiV2(client) {
5333
5402
  };
5334
5403
  }
5335
5404
 
5336
- // lib/errors/index.ts
5405
+ // lib/errors/v1/index.ts
5337
5406
  var BASE_URL15 = "errors";
5338
5407
  function createErrorsApi(client) {
5339
5408
  async function getInvalidItemErrorDetails(itemInfoId, signal) {
@@ -5347,11 +5416,44 @@ function createErrorsApi(client) {
5347
5416
  };
5348
5417
  }
5349
5418
 
5419
+ // lib/errors/v2/index.ts
5420
+ var BASE_URL16 = "errors/v2";
5421
+ function createErrorsApiV2(client) {
5422
+ async function getItemErrorSummary(params, signal) {
5423
+ const searchParams = new URLSearchParams();
5424
+ if (params.searchField)
5425
+ searchParams.append("searchField", params.searchField);
5426
+ if (params.searchText)
5427
+ searchParams.append("searchText", params.searchText);
5428
+ if (params.tradingPartnerIds) {
5429
+ params.tradingPartnerIds.forEach((id) => searchParams.append("tradingPartnerIds", id.toString()));
5430
+ }
5431
+ if (params.offset)
5432
+ searchParams.append("offset", params.offset.toString());
5433
+ if (params.limit)
5434
+ searchParams.append("limit", params.limit.toString());
5435
+ if (params.docInEventId)
5436
+ searchParams.append("docInEventId", params.docInEventId);
5437
+ if (params.importId)
5438
+ searchParams.append("importId", params.importId);
5439
+ const data = await client.get(`${BASE_URL16}/summary`, { signal, searchParams }).json();
5440
+ return itemErrorSummaryResultV2Schema.parse(data);
5441
+ }
5442
+ async function getItemErrorDetails(itemInfoId, signal) {
5443
+ const data = await client.get(`${BASE_URL16}/items/${itemInfoId}`, { signal }).json();
5444
+ return itemErrorDetailsResultV2Schema.parse(data);
5445
+ }
5446
+ return {
5447
+ getItemErrorSummary,
5448
+ getItemErrorDetails
5449
+ };
5450
+ }
5451
+
5350
5452
  // lib/uniqueCriteria/index.ts
5351
- var BASE_URL16 = "uniquecriteria";
5453
+ var BASE_URL17 = "uniquecriteria";
5352
5454
  function createUniqueCriteriaApi(client) {
5353
5455
  async function getUniqueCriteriaByOrg(params, signal) {
5354
- const data = await client.get(`${BASE_URL16}/org`, {
5456
+ const data = await client.get(`${BASE_URL17}/org`, {
5355
5457
  searchParams: params,
5356
5458
  signal
5357
5459
  }).json();
@@ -5361,10 +5463,10 @@ function createUniqueCriteriaApi(client) {
5361
5463
  }
5362
5464
 
5363
5465
  // lib/companies/index.ts
5364
- var BASE_URL17 = "companys";
5466
+ var BASE_URL18 = "companys";
5365
5467
  function createCompaniesApi(client) {
5366
5468
  async function getCompanyBriefInfoByOrg(params, signal) {
5367
- const data = await client.get(`${BASE_URL17}/brief`, {
5469
+ const data = await client.get(`${BASE_URL18}/brief`, {
5368
5470
  searchParams: params,
5369
5471
  signal
5370
5472
  }).json();
@@ -5381,6 +5483,7 @@ function createCompaniesApi(client) {
5381
5483
  createCompaniesApi,
5382
5484
  createCompanyFeaturesApi,
5383
5485
  createErrorsApi,
5486
+ createErrorsApiV2,
5384
5487
  createExportsApi,
5385
5488
  createFeatureFlagsApi,
5386
5489
  createImportsApi,
package/dist/index.d.cts CHANGED
@@ -1,11 +1,10 @@
1
- import { A as AsstClient, a as Import, b as ImportsStatus, V as VendorPartnerAttGroups, E as Export, m as AttrProdType, T as TradingPartnerAccessByCompanyId, e as CompanyRelationshipUpsertBody, c as ItemCategoriesSearch, i as AttributeMetaData, j as AttributesByCompany, k as AttributeDefinition, l as AttributeValidValues, L as Locale, S as SpreadsheetTemplate, U as UserAccount, g as ItemSearchView, h as ItemDetailView, f as ItemErrorDetailsResult } from './CompanyBriefByOrg-HsKxilwl.js';
2
- export { o as AsstClientOptions, p as AsstUrl, B as BASE_URLS, C as CompanyBriefByOrg, q as Env, I as ImportErrors, n as envSchema } from './CompanyBriefByOrg-HsKxilwl.js';
3
- import { G as GenerateImportTemplateParams, D as DownLoadItemsParams, I as ItemPartner, a as ItemHierarchyResponse, b as ItemDetail, S as SpsItemIdResponse } from './zod-9pZn6tpQ.js';
4
- export { i as AttrDatatypeNameEnum, t as AttributeDetail, j as AttributeGroup, A as AttributeSummary, J as Bulb, u as CategoryEnum, v as ComponentDetails, C as Connection, E as ExportDayOfWeek, f as ExportFrequency, g as ExportType, w as GroupedAttributeList, x as GroupedAttributes, y as GroupedItem, H as HierarchyCategory, z as HierarchyDetails, m as IdentityServiceDatetimePreferences, n as IdentityServiceOrganization, l as IdentityServiceOrganizationMetadata, o as IdentityServicePreferences, p as IdentityServiceUser, c as ImportDetails, d as ImportError, e as ImportStatusEnum, h as ItemCategory, O as ItemErrorDetails, q as ItemHeader, r as ItemMap, B as ItemPrice, s as ItemTable, M as MediaItem, K as PackComponent, F as PackComponentDetails, N as PackComponentItemInfo, P as PhaseEnum, R as RegisteredService, L as RepeatableGroup, k as SpreadsheetTemplateCompany, T as TradingPartnerStage } from './zod-9pZn6tpQ.js';
5
- import { R as RetailerTradingPartnerStages, I as ItemStatusResponse } from './index-wuCGfJSu.js';
6
- export { c as createCompaniesApi } from './index-wuCGfJSu.js';
1
+ import { A as AsstClient, a as Import, b as ImportsStatus, V as VendorPartnerAttGroups, E as Export, o as AttrProdType, T as TradingPartnerAccessByCompanyId, e as CompanyRelationshipUpsertBody, c as ItemCategoriesSearch, k as AttributeMetaData, l as AttributesByCompany, m as AttributeDefinition, n as AttributeValidValues, L as Locale, S as SpreadsheetTemplate, U as UserAccount, i as ItemSearchView, j as ItemDetailView, f as ItemErrorDetailsResult, g as ItemErrorSummaryResultV2, h as ItemErrorDetailsResultV2 } from './CompanyBriefByOrg-57oGCtjK.js';
2
+ export { q as AsstClientOptions, r as AsstUrl, B as BASE_URLS, C as CompanyBriefByOrg, s as Env, I as ImportErrors, p as envSchema } from './CompanyBriefByOrg-57oGCtjK.js';
3
+ import { G as GenerateImportTemplateParams, D as DownLoadItemsParams, I as ItemPartner, a as ItemHierarchyResponse, b as ItemDetail, S as SpsItemIdResponse } from './zod-zxqlYYMG.js';
4
+ export { i as AttrDatatypeNameEnum, t as AttributeDetail, j as AttributeGroup, A as AttributeSummary, J as Bulb, u as CategoryEnum, v as ComponentDetails, C as Connection, E as ExportDayOfWeek, f as ExportFrequency, g as ExportType, w as GroupedAttributeList, x as GroupedAttributes, y as GroupedItem, H as HierarchyCategory, z as HierarchyDetails, m as IdentityServiceDatetimePreferences, n as IdentityServiceOrganization, l as IdentityServiceOrganizationMetadata, o as IdentityServicePreferences, p as IdentityServiceUser, c as ImportDetails, d as ImportError, e as ImportStatusEnum, h as ItemCategory, O as ItemErrorDetails, U as ItemErrorDetailsV2, Q as ItemErrorSummaryV2, q as ItemHeader, r as ItemMap, B as ItemPrice, s as ItemTable, M as MediaItem, K as PackComponent, F as PackComponentDetails, N as PackComponentItemInfo, P as PhaseEnum, R as RegisteredService, L as RepeatableGroup, k as SpreadsheetTemplateCompany, T as TradingPartnerStage, V as TradingPartnerStageV2 } from './zod-zxqlYYMG.js';
5
+ import { R as RetailerTradingPartnerStages, I as ItemStatusResponse } from './index-fgr_c5Wj.js';
6
+ export { c as createCompaniesApi } from './index-fgr_c5Wj.js';
7
7
  import { z } from 'zod';
8
- import 'ky-universal';
9
8
  import 'ky';
10
9
 
11
10
  /**
@@ -330,11 +329,11 @@ declare const itemOrgStageDetailsSchema: z.ZodObject<{
330
329
  /**
331
330
  * Start date for the Item level Stage if applicable
332
331
  */
333
- startDate: z.ZodOptional<z.ZodNullable<z.ZodPipeline<z.ZodNumber, z.ZodDate>>>;
332
+ startDate: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, Date, number>>>;
334
333
  /**
335
334
  * End date for the Item level Stage if applicable
336
335
  */
337
- endDate: z.ZodOptional<z.ZodNullable<z.ZodPipeline<z.ZodNumber, z.ZodDate>>>;
336
+ endDate: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, Date, number>>>;
338
337
  }, "strip", z.ZodTypeAny, {
339
338
  isValid: boolean;
340
339
  orgSummary: {
@@ -383,8 +382,8 @@ declare const itemStatusV2Schema: z.ZodObject<{
383
382
  stage: z.ZodOptional<z.ZodNullable<z.ZodEnum<["CORE", "CORE_PLUS", "CORE_ADVANCED", "ENRICHED"]>>>;
384
383
  isValid: z.ZodBoolean;
385
384
  itemPolicyId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
386
- startDate: z.ZodOptional<z.ZodNullable<z.ZodPipeline<z.ZodNumber, z.ZodDate>>>;
387
- endDate: z.ZodOptional<z.ZodNullable<z.ZodPipeline<z.ZodNumber, z.ZodDate>>>;
385
+ startDate: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, Date, number>>>;
386
+ endDate: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, Date, number>>>;
388
387
  }, "strip", z.ZodTypeAny, {
389
388
  isValid: boolean;
390
389
  orgSummary: {
@@ -467,8 +466,8 @@ declare const itemStatusV2ResponseSchema: z.ZodObject<{
467
466
  stage: z.ZodOptional<z.ZodNullable<z.ZodEnum<["CORE", "CORE_PLUS", "CORE_ADVANCED", "ENRICHED"]>>>;
468
467
  isValid: z.ZodBoolean;
469
468
  itemPolicyId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
470
- startDate: z.ZodOptional<z.ZodNullable<z.ZodPipeline<z.ZodNumber, z.ZodDate>>>;
471
- endDate: z.ZodOptional<z.ZodNullable<z.ZodPipeline<z.ZodNumber, z.ZodDate>>>;
469
+ startDate: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, Date, number>>>;
470
+ endDate: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, Date, number>>>;
472
471
  }, "strip", z.ZodTypeAny, {
473
472
  isValid: boolean;
474
473
  orgSummary: {
@@ -602,6 +601,25 @@ declare function createErrorsApi(client: AsstClient): {
602
601
  getInvalidItemErrorDetails: (itemInfoId: string, signal?: AbortSignal) => Promise<ItemErrorDetailsResult>;
603
602
  };
604
603
 
604
+ type GetItemErrorSummaryParams = {
605
+ searchField?: string;
606
+ searchText?: string;
607
+ tradingPartnerIds?: number[];
608
+ offset?: number;
609
+ limit?: number;
610
+ docInEventId?: string;
611
+ importId?: string;
612
+ };
613
+ /**
614
+ * Initialize Errors Api functions
615
+ * @param client Assortment Client instance
616
+ * @returns An object containing Errors API functions
617
+ */
618
+ declare function createErrorsApiV2(client: AsstClient): {
619
+ getItemErrorSummary: (params: GetItemErrorSummaryParams, signal?: AbortSignal) => Promise<ItemErrorSummaryResultV2>;
620
+ getItemErrorDetails: (itemInfoId: number, signal?: AbortSignal) => Promise<ItemErrorDetailsResultV2>;
621
+ };
622
+
605
623
  /**
606
624
  * Initialize UniqueCriteria Api functions
607
625
  * @param client Assortment Client instance
@@ -613,4 +631,4 @@ declare function createUniqueCriteriaApi(client: AsstClient): {
613
631
  }, signal?: AbortSignal) => Promise<string[]>;
614
632
  };
615
633
 
616
- export { type ApplicationType, AsstClient, AttrProdType, AttributeDefinition, AttributeMetaData, AttributeValidValues, AttributesByCompany, type CategoriesApi, CompanyRelationshipUpsertBody, DownLoadItemsParams, Export, GenerateImportTemplateParams, Import, ImportsStatus, ItemCategoriesSearch, ItemDetail, ItemDetailView, ItemErrorDetailsResult, ItemHierarchyResponse, type ItemOrgStageDetails, type ItemOrgStatus, ItemPartner, ItemSearchView, type ItemStatus, ItemStatusResponse, type ItemStatusV2, type ItemStatusV2Response, Locale, type OrgSummary, RetailerTradingPartnerStages, SpreadsheetTemplate, SpsItemIdResponse, type Stage, TradingPartnerAccessByCompanyId, UserAccount, VendorPartnerAttGroups, createAttributesApi, createCategoriesApi, createCompanyFeaturesApi, createErrorsApi, createExportsApi, createFeatureFlagsApi, createImportsApi, createItemsApi, createItemsApiV2, createLocaleApi, createProductTypesApi, createSpreadsheetTemplateApi, createTradingPartnerAccessApi, createTradingPartnerSettingsApi, createUniqueCriteriaApi, createWhoAmIApi };
634
+ export { type ApplicationType, AsstClient, AttrProdType, AttributeDefinition, AttributeMetaData, AttributeValidValues, AttributesByCompany, type CategoriesApi, CompanyRelationshipUpsertBody, DownLoadItemsParams, Export, GenerateImportTemplateParams, type GetItemErrorSummaryParams, Import, ImportsStatus, ItemCategoriesSearch, ItemDetail, ItemDetailView, ItemErrorDetailsResult, ItemErrorDetailsResultV2, ItemErrorSummaryResultV2, ItemHierarchyResponse, type ItemOrgStageDetails, type ItemOrgStatus, ItemPartner, ItemSearchView, type ItemStatus, ItemStatusResponse, type ItemStatusV2, type ItemStatusV2Response, Locale, type OrgSummary, RetailerTradingPartnerStages, SpreadsheetTemplate, SpsItemIdResponse, type Stage, TradingPartnerAccessByCompanyId, UserAccount, VendorPartnerAttGroups, createAttributesApi, createCategoriesApi, createCompanyFeaturesApi, createErrorsApi, createErrorsApiV2, createExportsApi, createFeatureFlagsApi, createImportsApi, createItemsApi, createItemsApiV2, createLocaleApi, createProductTypesApi, createSpreadsheetTemplateApi, createTradingPartnerAccessApi, createTradingPartnerSettingsApi, createUniqueCriteriaApi, createWhoAmIApi };
package/dist/index.d.ts CHANGED
@@ -1,11 +1,10 @@
1
- import { A as AsstClient, a as Import, b as ImportsStatus, V as VendorPartnerAttGroups, E as Export, m as AttrProdType, T as TradingPartnerAccessByCompanyId, e as CompanyRelationshipUpsertBody, c as ItemCategoriesSearch, i as AttributeMetaData, j as AttributesByCompany, k as AttributeDefinition, l as AttributeValidValues, L as Locale, S as SpreadsheetTemplate, U as UserAccount, g as ItemSearchView, h as ItemDetailView, f as ItemErrorDetailsResult } from './CompanyBriefByOrg-HsKxilwl.js';
2
- export { o as AsstClientOptions, p as AsstUrl, B as BASE_URLS, C as CompanyBriefByOrg, q as Env, I as ImportErrors, n as envSchema } from './CompanyBriefByOrg-HsKxilwl.js';
3
- import { G as GenerateImportTemplateParams, D as DownLoadItemsParams, I as ItemPartner, a as ItemHierarchyResponse, b as ItemDetail, S as SpsItemIdResponse } from './zod-9pZn6tpQ.js';
4
- export { i as AttrDatatypeNameEnum, t as AttributeDetail, j as AttributeGroup, A as AttributeSummary, J as Bulb, u as CategoryEnum, v as ComponentDetails, C as Connection, E as ExportDayOfWeek, f as ExportFrequency, g as ExportType, w as GroupedAttributeList, x as GroupedAttributes, y as GroupedItem, H as HierarchyCategory, z as HierarchyDetails, m as IdentityServiceDatetimePreferences, n as IdentityServiceOrganization, l as IdentityServiceOrganizationMetadata, o as IdentityServicePreferences, p as IdentityServiceUser, c as ImportDetails, d as ImportError, e as ImportStatusEnum, h as ItemCategory, O as ItemErrorDetails, q as ItemHeader, r as ItemMap, B as ItemPrice, s as ItemTable, M as MediaItem, K as PackComponent, F as PackComponentDetails, N as PackComponentItemInfo, P as PhaseEnum, R as RegisteredService, L as RepeatableGroup, k as SpreadsheetTemplateCompany, T as TradingPartnerStage } from './zod-9pZn6tpQ.js';
5
- import { R as RetailerTradingPartnerStages, I as ItemStatusResponse } from './index-wuCGfJSu.js';
6
- export { c as createCompaniesApi } from './index-wuCGfJSu.js';
1
+ import { A as AsstClient, a as Import, b as ImportsStatus, V as VendorPartnerAttGroups, E as Export, o as AttrProdType, T as TradingPartnerAccessByCompanyId, e as CompanyRelationshipUpsertBody, c as ItemCategoriesSearch, k as AttributeMetaData, l as AttributesByCompany, m as AttributeDefinition, n as AttributeValidValues, L as Locale, S as SpreadsheetTemplate, U as UserAccount, i as ItemSearchView, j as ItemDetailView, f as ItemErrorDetailsResult, g as ItemErrorSummaryResultV2, h as ItemErrorDetailsResultV2 } from './CompanyBriefByOrg-57oGCtjK.js';
2
+ export { q as AsstClientOptions, r as AsstUrl, B as BASE_URLS, C as CompanyBriefByOrg, s as Env, I as ImportErrors, p as envSchema } from './CompanyBriefByOrg-57oGCtjK.js';
3
+ import { G as GenerateImportTemplateParams, D as DownLoadItemsParams, I as ItemPartner, a as ItemHierarchyResponse, b as ItemDetail, S as SpsItemIdResponse } from './zod-zxqlYYMG.js';
4
+ export { i as AttrDatatypeNameEnum, t as AttributeDetail, j as AttributeGroup, A as AttributeSummary, J as Bulb, u as CategoryEnum, v as ComponentDetails, C as Connection, E as ExportDayOfWeek, f as ExportFrequency, g as ExportType, w as GroupedAttributeList, x as GroupedAttributes, y as GroupedItem, H as HierarchyCategory, z as HierarchyDetails, m as IdentityServiceDatetimePreferences, n as IdentityServiceOrganization, l as IdentityServiceOrganizationMetadata, o as IdentityServicePreferences, p as IdentityServiceUser, c as ImportDetails, d as ImportError, e as ImportStatusEnum, h as ItemCategory, O as ItemErrorDetails, U as ItemErrorDetailsV2, Q as ItemErrorSummaryV2, q as ItemHeader, r as ItemMap, B as ItemPrice, s as ItemTable, M as MediaItem, K as PackComponent, F as PackComponentDetails, N as PackComponentItemInfo, P as PhaseEnum, R as RegisteredService, L as RepeatableGroup, k as SpreadsheetTemplateCompany, T as TradingPartnerStage, V as TradingPartnerStageV2 } from './zod-zxqlYYMG.js';
5
+ import { R as RetailerTradingPartnerStages, I as ItemStatusResponse } from './index-fgr_c5Wj.js';
6
+ export { c as createCompaniesApi } from './index-fgr_c5Wj.js';
7
7
  import { z } from 'zod';
8
- import 'ky-universal';
9
8
  import 'ky';
10
9
 
11
10
  /**
@@ -330,11 +329,11 @@ declare const itemOrgStageDetailsSchema: z.ZodObject<{
330
329
  /**
331
330
  * Start date for the Item level Stage if applicable
332
331
  */
333
- startDate: z.ZodOptional<z.ZodNullable<z.ZodPipeline<z.ZodNumber, z.ZodDate>>>;
332
+ startDate: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, Date, number>>>;
334
333
  /**
335
334
  * End date for the Item level Stage if applicable
336
335
  */
337
- endDate: z.ZodOptional<z.ZodNullable<z.ZodPipeline<z.ZodNumber, z.ZodDate>>>;
336
+ endDate: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, Date, number>>>;
338
337
  }, "strip", z.ZodTypeAny, {
339
338
  isValid: boolean;
340
339
  orgSummary: {
@@ -383,8 +382,8 @@ declare const itemStatusV2Schema: z.ZodObject<{
383
382
  stage: z.ZodOptional<z.ZodNullable<z.ZodEnum<["CORE", "CORE_PLUS", "CORE_ADVANCED", "ENRICHED"]>>>;
384
383
  isValid: z.ZodBoolean;
385
384
  itemPolicyId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
386
- startDate: z.ZodOptional<z.ZodNullable<z.ZodPipeline<z.ZodNumber, z.ZodDate>>>;
387
- endDate: z.ZodOptional<z.ZodNullable<z.ZodPipeline<z.ZodNumber, z.ZodDate>>>;
385
+ startDate: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, Date, number>>>;
386
+ endDate: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, Date, number>>>;
388
387
  }, "strip", z.ZodTypeAny, {
389
388
  isValid: boolean;
390
389
  orgSummary: {
@@ -467,8 +466,8 @@ declare const itemStatusV2ResponseSchema: z.ZodObject<{
467
466
  stage: z.ZodOptional<z.ZodNullable<z.ZodEnum<["CORE", "CORE_PLUS", "CORE_ADVANCED", "ENRICHED"]>>>;
468
467
  isValid: z.ZodBoolean;
469
468
  itemPolicyId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
470
- startDate: z.ZodOptional<z.ZodNullable<z.ZodPipeline<z.ZodNumber, z.ZodDate>>>;
471
- endDate: z.ZodOptional<z.ZodNullable<z.ZodPipeline<z.ZodNumber, z.ZodDate>>>;
469
+ startDate: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, Date, number>>>;
470
+ endDate: z.ZodOptional<z.ZodNullable<z.ZodEffects<z.ZodNumber, Date, number>>>;
472
471
  }, "strip", z.ZodTypeAny, {
473
472
  isValid: boolean;
474
473
  orgSummary: {
@@ -602,6 +601,25 @@ declare function createErrorsApi(client: AsstClient): {
602
601
  getInvalidItemErrorDetails: (itemInfoId: string, signal?: AbortSignal) => Promise<ItemErrorDetailsResult>;
603
602
  };
604
603
 
604
+ type GetItemErrorSummaryParams = {
605
+ searchField?: string;
606
+ searchText?: string;
607
+ tradingPartnerIds?: number[];
608
+ offset?: number;
609
+ limit?: number;
610
+ docInEventId?: string;
611
+ importId?: string;
612
+ };
613
+ /**
614
+ * Initialize Errors Api functions
615
+ * @param client Assortment Client instance
616
+ * @returns An object containing Errors API functions
617
+ */
618
+ declare function createErrorsApiV2(client: AsstClient): {
619
+ getItemErrorSummary: (params: GetItemErrorSummaryParams, signal?: AbortSignal) => Promise<ItemErrorSummaryResultV2>;
620
+ getItemErrorDetails: (itemInfoId: number, signal?: AbortSignal) => Promise<ItemErrorDetailsResultV2>;
621
+ };
622
+
605
623
  /**
606
624
  * Initialize UniqueCriteria Api functions
607
625
  * @param client Assortment Client instance
@@ -613,4 +631,4 @@ declare function createUniqueCriteriaApi(client: AsstClient): {
613
631
  }, signal?: AbortSignal) => Promise<string[]>;
614
632
  };
615
633
 
616
- export { type ApplicationType, AsstClient, AttrProdType, AttributeDefinition, AttributeMetaData, AttributeValidValues, AttributesByCompany, type CategoriesApi, CompanyRelationshipUpsertBody, DownLoadItemsParams, Export, GenerateImportTemplateParams, Import, ImportsStatus, ItemCategoriesSearch, ItemDetail, ItemDetailView, ItemErrorDetailsResult, ItemHierarchyResponse, type ItemOrgStageDetails, type ItemOrgStatus, ItemPartner, ItemSearchView, type ItemStatus, ItemStatusResponse, type ItemStatusV2, type ItemStatusV2Response, Locale, type OrgSummary, RetailerTradingPartnerStages, SpreadsheetTemplate, SpsItemIdResponse, type Stage, TradingPartnerAccessByCompanyId, UserAccount, VendorPartnerAttGroups, createAttributesApi, createCategoriesApi, createCompanyFeaturesApi, createErrorsApi, createExportsApi, createFeatureFlagsApi, createImportsApi, createItemsApi, createItemsApiV2, createLocaleApi, createProductTypesApi, createSpreadsheetTemplateApi, createTradingPartnerAccessApi, createTradingPartnerSettingsApi, createUniqueCriteriaApi, createWhoAmIApi };
634
+ export { type ApplicationType, AsstClient, AttrProdType, AttributeDefinition, AttributeMetaData, AttributeValidValues, AttributesByCompany, type CategoriesApi, CompanyRelationshipUpsertBody, DownLoadItemsParams, Export, GenerateImportTemplateParams, type GetItemErrorSummaryParams, Import, ImportsStatus, ItemCategoriesSearch, ItemDetail, ItemDetailView, ItemErrorDetailsResult, ItemErrorDetailsResultV2, ItemErrorSummaryResultV2, ItemHierarchyResponse, type ItemOrgStageDetails, type ItemOrgStatus, ItemPartner, ItemSearchView, type ItemStatus, ItemStatusResponse, type ItemStatusV2, type ItemStatusV2Response, Locale, type OrgSummary, RetailerTradingPartnerStages, SpreadsheetTemplate, SpsItemIdResponse, type Stage, TradingPartnerAccessByCompanyId, UserAccount, VendorPartnerAttGroups, createAttributesApi, createCategoriesApi, createCompanyFeaturesApi, createErrorsApi, createErrorsApiV2, createExportsApi, createFeatureFlagsApi, createImportsApi, createItemsApi, createItemsApiV2, createLocaleApi, createProductTypesApi, createSpreadsheetTemplateApi, createTradingPartnerAccessApi, createTradingPartnerSettingsApi, createUniqueCriteriaApi, createWhoAmIApi };
package/dist/index.js CHANGED
@@ -4,6 +4,7 @@ import {
4
4
  createCompaniesApi,
5
5
  createCompanyFeaturesApi,
6
6
  createErrorsApi,
7
+ createErrorsApiV2,
7
8
  createExportsApi,
8
9
  createFeatureFlagsApi,
9
10
  createImportsApi,
@@ -15,75 +16,13 @@ import {
15
16
  createTradingPartnerSettingsApi,
16
17
  createUniqueCriteriaApi,
17
18
  createWhoAmIApi
18
- } from "./chunk-HCQG42LN.js";
19
+ } from "./chunk-27XV7TS2.js";
19
20
  import {
20
21
  AsstClient,
21
22
  BASE_URLS,
22
23
  envSchema,
23
- z
24
- } from "./chunk-6FFDMMN5.js";
25
-
26
- // lib/items/v2/models/Stage.ts
27
- var stageSchema = z.enum([
28
- "CORE",
29
- "CORE_PLUS",
30
- "CORE_ADVANCED",
31
- "ENRICHED"
32
- ]);
33
-
34
- // lib/items/v2/models/OrgSummary.ts
35
- var orgSummarySchema = z.object({
36
- ref: z.string(),
37
- id: z.string(),
38
- name: z.string()
39
- });
40
-
41
- // lib/items/v2/models/ItemOrgStageDetails.ts
42
- var itemOrgStageDetailsSchema = z.object({
43
- /**
44
- * When called as retailer, the vendor, else when vendor, the retailer.
45
- * */
46
- orgSummary: orgSummarySchema,
47
- /**
48
- * The company id of the retailer or vendor used for matching ItemOrgStageDetails to TradingPartnerStage for ErrorService
49
- */
50
- companyId: z.number().nullish(),
51
- /**
52
- * "Standard Requirements" (null) UNLESS the retailer of the item is MSIS Enabled
53
- * OTHERWISE the retailer default Stage UNLESS there's a currently active vendor-specific Stage defined
54
- * OTHERWISE the trading partnership Stage UNLESS there's a currently active Item Level override defined
55
- * OTHERWISE the item level override */
56
- stage: stageSchema.nullish(),
57
- /**
58
- * If the item is valid for the active stage. Note that for "Standard Requirements" or
59
- * "Enriched" this cam come directly from the item_doc table, but anything else requires validation
60
- */
61
- isValid: z.boolean(),
62
- /**
63
- * Not null if there's an item level policy override for this trading partnership
64
- */
65
- itemPolicyId: z.string().nullish(),
66
- /**
67
- * Start date for the Item level Stage if applicable
68
- */
69
- startDate: z.number().pipe(z.coerce.date()).nullish(),
70
- /**
71
- * End date for the Item level Stage if applicable
72
- */
73
- endDate: z.number().pipe(z.coerce.date()).nullish()
74
- });
75
-
76
- // lib/items/v2/models/ItemStatusV2.ts
77
- var itemStatusV2Schema = z.object({
78
- itemId: z.string(),
79
- mostRestrictiveRetailerStage: stageSchema.nullable(),
80
- itemOrgStageDetails: z.array(itemOrgStageDetailsSchema)
81
- });
82
-
83
- // lib/items/v2/models/ItemStatusV2Response.ts
84
- var itemStatusV2ResponseSchema = z.object({
85
- itemStatuses: z.array(itemStatusV2Schema)
86
- });
24
+ itemStatusV2ResponseSchema
25
+ } from "./chunk-CUVSWUIQ.js";
87
26
 
88
27
  // lib/items/v2/index.ts
89
28
  var BASE_URL = "v2/items";
@@ -104,6 +43,7 @@ export {
104
43
  createCompaniesApi,
105
44
  createCompanyFeaturesApi,
106
45
  createErrorsApi,
46
+ createErrorsApiV2,
107
47
  createExportsApi,
108
48
  createFeatureFlagsApi,
109
49
  createImportsApi,