@spscommerce/asst-api 4.3.0 → 4.5.0

package/dist/{SpsItemIdResponse-CI_Ao86P.d.cts → SpsItemIdResponse-gAHfCzwP.d.cts}

@@ -2,9 +2,6 @@ import * as ky from 'ky';
 import { Options } from 'ky';
 import { z } from 'zod';
 
-declare const companyTypeEnumSchema: z.ZodEnum<["RETAILER", "SUPPLIER"]>;
-type CompanyType = z.infer<typeof companyTypeEnumSchema>;
-
 declare const baseUrlsSchema: z.ZodObject<{
     local: z.ZodLiteral<"https://localhost:8443/">;
     test: z.ZodLiteral<"https://integration.api.spscommerce.com/assortment/gateway/">;
@@ -31,16 +28,6 @@ type Listener = (config: AsstClientOptions) => void;
 declare class AsstClient {
     #private;
     constructor(options?: AsstClientOptions);
-    /**
-     * Set company type that will be automatically added to all requests
-     * @param companyType Company type to add to all requests ('RETAILER' | 'SUPPLIER')
-     */
-    setCompanyType(companyType: CompanyType | undefined): this;
-    /**
-     * Get the current company type
-     * @returns Current company type or undefined if not set
-     */
-    getCompanyType(): CompanyType | undefined;
     updateConfig(options: AsstClientOptions): void;
     getBaseUrl(): AsstUrl;
     /**
@@ -57,6 +44,27 @@ declare class AsstClient {
     delete(url: Input, options?: AsstClientOptions): ky.ResponsePromise;
 }
 
+declare const companyBriefByOrgSchema: z.ZodObject<{
+    companyId: z.ZodNumber;
+    name: z.ZodString;
+    orgId: z.ZodString;
+    companyTypes: z.ZodArray<z.ZodEnum<["SUPPLIER", "RETAILER"]>, "many">;
+    dc4Id: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    companyId: number;
+    orgId: string;
+    companyTypes: ("SUPPLIER" | "RETAILER")[];
+    dc4Id: number;
+}, {
+    name: string;
+    companyId: number;
+    orgId: string;
+    companyTypes: ("SUPPLIER" | "RETAILER")[];
+    dc4Id: number;
+}>;
+type CompanyBriefByOrg = z.infer<typeof companyBriefByOrgSchema>;
+
 type Hierarchy = {
     id: string;
     name?: string | null;
@@ -84,4 +92,4 @@ declare const spsItemIdResponseSchema: z.ZodObject<{
 }>;
 type SpsItemIdResponse = z.infer<typeof spsItemIdResponseSchema>;
 
-export { AsstClient as A, BASE_URLS as B, type CompanyType as C, type Env as E, type ItemHierarchyResponse as I, type SpsItemIdResponse as S, type AsstClientOptions as a, type AsstUrl as b, companyTypeEnumSchema as c, envSchema as e, itemHierarchyResponseSchema as i, spsItemIdResponseSchema as s };
+export { AsstClient as A, BASE_URLS as B, type CompanyBriefByOrg as C, type Env as E, type ItemHierarchyResponse as I, type SpsItemIdResponse as S, type AsstClientOptions as a, type AsstUrl as b, companyBriefByOrgSchema as c, envSchema as e, itemHierarchyResponseSchema as i, spsItemIdResponseSchema as s };

package/dist/{SpsItemIdResponse-CI_Ao86P.d.ts → SpsItemIdResponse-gAHfCzwP.d.ts}

@@ -2,9 +2,6 @@ import * as ky from 'ky';
 import { Options } from 'ky';
 import { z } from 'zod';
 
-declare const companyTypeEnumSchema: z.ZodEnum<["RETAILER", "SUPPLIER"]>;
-type CompanyType = z.infer<typeof companyTypeEnumSchema>;
-
 declare const baseUrlsSchema: z.ZodObject<{
     local: z.ZodLiteral<"https://localhost:8443/">;
     test: z.ZodLiteral<"https://integration.api.spscommerce.com/assortment/gateway/">;
@@ -31,16 +28,6 @@ type Listener = (config: AsstClientOptions) => void;
 declare class AsstClient {
     #private;
     constructor(options?: AsstClientOptions);
-    /**
-     * Set company type that will be automatically added to all requests
-     * @param companyType Company type to add to all requests ('RETAILER' | 'SUPPLIER')
-     */
-    setCompanyType(companyType: CompanyType | undefined): this;
-    /**
-     * Get the current company type
-     * @returns Current company type or undefined if not set
-     */
-    getCompanyType(): CompanyType | undefined;
     updateConfig(options: AsstClientOptions): void;
     getBaseUrl(): AsstUrl;
     /**
@@ -57,6 +44,27 @@ declare class AsstClient {
     delete(url: Input, options?: AsstClientOptions): ky.ResponsePromise;
 }
 
+declare const companyBriefByOrgSchema: z.ZodObject<{
+    companyId: z.ZodNumber;
+    name: z.ZodString;
+    orgId: z.ZodString;
+    companyTypes: z.ZodArray<z.ZodEnum<["SUPPLIER", "RETAILER"]>, "many">;
+    dc4Id: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    companyId: number;
+    orgId: string;
+    companyTypes: ("SUPPLIER" | "RETAILER")[];
+    dc4Id: number;
+}, {
+    name: string;
+    companyId: number;
+    orgId: string;
+    companyTypes: ("SUPPLIER" | "RETAILER")[];
+    dc4Id: number;
+}>;
+type CompanyBriefByOrg = z.infer<typeof companyBriefByOrgSchema>;
+
 type Hierarchy = {
     id: string;
     name?: string | null;
@@ -84,4 +92,4 @@ declare const spsItemIdResponseSchema: z.ZodObject<{
 }>;
 type SpsItemIdResponse = z.infer<typeof spsItemIdResponseSchema>;
 
-export { AsstClient as A, BASE_URLS as B, type CompanyType as C, type Env as E, type ItemHierarchyResponse as I, type SpsItemIdResponse as S, type AsstClientOptions as a, type AsstUrl as b, companyTypeEnumSchema as c, envSchema as e, itemHierarchyResponseSchema as i, spsItemIdResponseSchema as s };
+export { AsstClient as A, BASE_URLS as B, type CompanyBriefByOrg as C, type Env as E, type ItemHierarchyResponse as I, type SpsItemIdResponse as S, type AsstClientOptions as a, type AsstUrl as b, companyBriefByOrgSchema as c, envSchema as e, itemHierarchyResponseSchema as i, spsItemIdResponseSchema as s };

package/dist/{chunk-LKUGPDIT.js → chunk-BMTYM2N6.js}

@@ -4227,6 +4227,33 @@ var itemHierarchyResponseSchema = external_exports.object({
   )
 });
 
+// lib/categories/models/CatalogManagement.ts
+var catalogCreateRequestSchema = external_exports.object({
+  type: external_exports.string(),
+  name: external_exports.string(),
+  companyId: external_exports.number()
+});
+var catalogCreateResponseSchema = external_exports.object({
+  categoryid: external_exports.number()
+});
+var catalogSearchParamsSchema = external_exports.object({
+  ownerCompanyIds: external_exports.array(external_exports.number()).optional(),
+  searchTerms: external_exports.string().optional(),
+  categoryType: external_exports.literal("CATALOG")
+});
+var catalogBriefResponseSchema = external_exports.object({
+  categoryId: external_exports.number(),
+  categoryName: external_exports.string(),
+  categoryDescription: external_exports.string(),
+  categoryDescriptionExt: external_exports.string(),
+  ownerCompanyId: external_exports.string(),
+  categoryTypeId: external_exports.number(),
+  createdAt: external_exports.string(),
+  modifiedAt: external_exports.string(),
+  createdBy: external_exports.string(),
+  modifiedBy: external_exports.string()
+});
+
 // lib/locale/models/Locale.ts
 var localeSchema = external_exports.object({
   localeCode: external_exports.string(),
@@ -4815,15 +4842,15 @@ var itemErrorDetailsResultV2Schema = external_exports.object({
   itemErrorDetails: external_exports.array(itemErrorDetailsV2Schema)
 });
 
+// lib/companies/models/CompanyType.ts
+var companyTypeSchema = external_exports.enum(["SUPPLIER", "RETAILER"]);
+
 // lib/companies/models/CompanyBriefByOrg.ts
 var companyBriefByOrgSchema = external_exports.object({
   companyId: external_exports.number(),
   name: external_exports.string(),
   orgId: external_exports.string(),
-  companyType: external_exports.object({
-    type: external_exports.enum(["SUPPLIER", "RETAILER"]),
-    display: external_exports.enum(["SUPPLIER", "RETAILER"])
-  }),
+  companyTypes: external_exports.array(companyTypeSchema),
   dc4Id: external_exports.number()
 });
 
@@ -4849,6 +4876,8 @@ export {
   itemCategorySchema,
   itemCategoriesSearchSchema,
   itemHierarchyResponseSchema,
+  catalogCreateResponseSchema,
+  catalogBriefResponseSchema,
   localeSchema,
   spreadsheetTemplateCompanySchema,
   spreadsheetTemplateSchema,

package/dist/{chunk-CI3ZSIT4.js → chunk-VS3QNXZF.js}

@@ -1,5 +1,7 @@
 import {
   attrProdTypeSchema,
+  catalogBriefResponseSchema,
+  catalogCreateResponseSchema,
   companyBriefByOrgSchema,
   external_exports,
   importErrorsSchema,
@@ -20,11 +22,23 @@ import {
   tradingPartnerAccessByCompanyIdSchema,
   userAccountSchema,
   vendorPartnerAttGroupsSchema
-} from "./chunk-NUUQDRHD.js";
+} from "./chunk-BMTYM2N6.js";
+
+// lib/util.ts
+function getCompanyTypeSearchParams({
+  params,
+  companyType
+}) {
+  const merged = {
+    ...params ?? {},
+    ...companyType ? { companyType } : {}
+  };
+  return Object.keys(merged).length > 0 ? merged : void 0;
+}
 
 // lib/imports/index.ts
 var BASE_URL = "imports";
-function createImportsApi(client) {
+function createImportsApi(client, companyType) {
   async function getImportErrors(importId, params, signal) {
     const data = await client.get(`${BASE_URL}/${importId}/errors`, { searchParams: params, signal }).json();
     return importErrorsSchema.parse(data);
@@ -37,22 +51,28 @@ function createImportsApi(client) {
     return importSchema.parse(data);
   }
   async function getImportsStatus(signal) {
-    const data = await client.get(`${BASE_URL}/status`, { signal }).json();
+    const data = await client.get(`${BASE_URL}/status`, {
+      signal,
+      searchParams: getCompanyTypeSearchParams({ companyType })
+    }).json();
     return external_exports.array(importsStatusSchema).parse(data);
   }
   async function uploadImport(file) {
     await client.post(`${BASE_URL}`, { body: file });
   }
   async function getVendorPartnerGroups(signal) {
-    const data = await client.get(`${BASE_URL}/template/vendor-partner-groups`, { signal }).json();
+    const data = await client.get(`${BASE_URL}/template/vendor-partner-groups`, {
+      signal,
+      searchParams: getCompanyTypeSearchParams({ companyType })
+    }).json();
     return external_exports.array(vendorPartnerAttGroupsSchema).parse(data);
   }
   async function generateImportTemplate(params) {
     const response = await client.get(`${BASE_URL}/template/generate`, {
-      searchParams: params,
       headers: {
         Accept: "application/octet-stream"
       },
+      searchParams: getCompanyTypeSearchParams({ params, companyType }),
       timeout: false
     });
     const disposition = response.headers.get("content-disposition") || "";
@@ -82,7 +102,7 @@ function createImportsApi(client) {
 // lib/exports/index.ts
 var BASE_URL2 = "exports";
 var BASE_URL_V2 = "v2/exports";
-function createExportsApi(client) {
+function createExportsApi(client, companyType) {
   async function createExport(data, params) {
     await client.post(`${BASE_URL_V2}/add`, {
       json: data,
@@ -96,7 +116,7 @@ function createExportsApi(client) {
       availableAttributes: params.availableAttributes?.join(",") ?? ""
     };
     const response = await client.get(`${BASE_URL2}/spreadsheet/by-item`, {
-      searchParams,
+      searchParams: getCompanyTypeSearchParams({ params: searchParams, companyType }),
       headers: {
         Accept: "application/octet-stream"
       },
@@ -140,10 +160,10 @@ function createProductTypesApi(client) {
 
 // lib/tradingPartners/index.ts
 var BASE_URL4 = "trading-partner-access";
-function createTradingPartnerAccessApi(client) {
+function createTradingPartnerAccessApi(client, companyType) {
   async function getAllTradingPartners(params, signal) {
     const data = await client.get(`${BASE_URL4}/connections`, {
-      searchParams: params,
+      searchParams: getCompanyTypeSearchParams({ params, companyType }),
       signal
     }).json();
     return tradingPartnerAccessByCompanyIdSchema.parse(data);
@@ -174,9 +194,10 @@ var retailerTradingPartnerStages = external_exports.array(
 
 // lib/tradingPartnerSettings/index.ts
 var BASE_URL5 = "trading-partner-settings";
-function createTradingPartnerSettingsApi(client) {
+function createTradingPartnerSettingsApi(client, companyType) {
   async function getRetailerStages(signal) {
     const data = await client.get(`${BASE_URL5}/stages/retailer-configured`, {
+      searchParams: getCompanyTypeSearchParams({ companyType }),
       signal
     }).json();
     return retailerTradingPartnerStages.parse(data);
@@ -238,11 +259,41 @@ function createCategoriesApi(client) {
     const data = await client.post(`${BASE_URL6}/item-hierarchy`, { json: { itemIds } }).json();
     return itemHierarchyResponseSchema.parse(data);
   }
+  async function createCatalog(params, signal) {
+    const data = await client.post(`${BASE_URL6}`, {
+      json: params,
+      signal
+    }).json();
+    return catalogCreateResponseSchema.parse(data);
+  }
+  async function searchCatalogsByCompany(params, signal) {
+    const url = "category/brief/CATALOG/search";
+    const searchParams = new URLSearchParams();
+    if (params.ownerCompanyIds?.length) {
+      for (const id of params.ownerCompanyIds) {
+        searchParams.append("ownerCompanyIds", id.toString());
+      }
+    }
+    if (params.searchTerms) {
+      searchParams.set("searchTerms", params.searchTerms);
+    }
+    const data = await client.get(url, {
+      searchParams,
+      signal
+    }).json();
+    return external_exports.array(catalogBriefResponseSchema).parse(data);
+  }
+  async function createCategoryHierarchy(searchParams) {
+    return await client.post(`${BASE_URL6}/hierarchy`, { searchParams }).json();
+  }
   return {
     getCatalogs,
     getProductCodes,
     getSelectionCodes,
-    getItemHierarchy
+    getItemHierarchy,
+    createCatalog,
+    searchCatalogsByCompany,
+    createCategoryHierarchy
   };
 }
 
@@ -284,15 +335,23 @@ function createWhoAmIApi(client) {
 
 // lib/companyFeatures/index.ts
 var BASE_URL10 = "feature";
-function createCompanyFeaturesApi(client) {
+function createCompanyFeaturesApi(client, companyType) {
+  function getSearchParams() {
+    return companyType && { companyType };
+  }
   async function checkIfStageItemSetupIsEnabled(signal) {
     const data = await client.get(`${BASE_URL10}/isphaseditemsetupenabled`, {
-      signal
+      signal,
+      searchParams: getSearchParams()
     }).json();
     return external_exports.boolean().parse(data);
   }
+  async function enableFeatureForCompany(featureKey, companyId) {
+    await client.put(`${BASE_URL10}/${featureKey}/company/${companyId}/enable`);
+  }
   return {
-    checkIfStageItemSetupIsEnabled
+    checkIfStageItemSetupIsEnabled,
+    enableFeatureForCompany
   };
 }
 
@@ -319,27 +378,35 @@ function createFeatureFlagsApi(client) {
     }).json();
     return external_exports.boolean().parse(data);
   }
+  async function checkIfItemMatchEnabled(flagOptions = {}) {
+    const { companyId, signal } = flagOptions;
+    const path = companyId ? `${BASE_URL11}/enable-item-match-section/${companyId}/` : `${BASE_URL11}/enable-item-match-section/`;
+    const data = await client.get(path, {
+      signal
+    }).json();
+    return external_exports.boolean().parse(data);
+  }
   return {
     checkEnableItemsLevelMSIS,
     checkIfEnabledForPackagingHierarchies,
-    checkIfEnabledForItemUomConversionRules
+    checkIfEnabledForItemUomConversionRules,
+    checkIfItemMatchEnabled
   };
 }
 
 // lib/items/v1/index.ts
 var BASE_URL12 = "items";
-function createItemsApi(client) {
-  function createQueryParameterString(params = {}) {
-    const searchParams = new URLSearchParams();
-    const { limit, offset, applicationType, url } = params ?? {};
-    if (limit) searchParams.append("limit", limit.toString());
-    if (offset) searchParams.append("offset", offset.toString());
-    if (applicationType) searchParams.append("application", applicationType);
-    const queryParameterString = searchParams.toString();
-    return url ? `${queryParameterString}&${url}` : queryParameterString;
+function createItemsApi(client, companyType) {
+  function getCoalescedParams(params = {}) {
+    const queryParams = {};
+    if (params.limit !== void 0) queryParams.limit = params.limit.toString();
+    if (params.offset !== void 0) queryParams.offset = params.offset.toString();
+    if (params.applicationType) queryParams.application = params.applicationType;
+    if (params.url) queryParams.url = params.url;
+    return Object.keys(queryParams).length > 0 ? queryParams : void 0;
   }
   async function searchItems(params, signal) {
-    const searchParams = createQueryParameterString(params);
+    const searchParams = getCompanyTypeSearchParams({ params: getCoalescedParams(params), companyType });
     const data = await client.get(`${BASE_URL12}`, { searchParams, signal }).json();
     return itemSearchViewSchema.parse(data);
   }
@@ -350,6 +417,7 @@ function createItemsApi(client) {
   async function updateItem(itemId, item) {
     await client.put(`${BASE_URL12}/details/${itemId}`, {
       json: { ...item },
+      searchParams: getCompanyTypeSearchParams({ companyType }),
       timeout: 45e3
     }).json();
   }
@@ -364,7 +432,9 @@ function createItemsApi(client) {
     await client.delete(`${BASE_URL12}`, { searchParams: params });
   }
   async function getItemInfoId(spsItemId, signal) {
-    const data = await client.get(`${BASE_URL12}/${spsItemId}/itemInfoId`, { signal }).json();
+    const data = await client.get(`${BASE_URL12}/${spsItemId}/itemInfoId`, { searchParams: getCompanyTypeSearchParams({
+      companyType
+    }), signal }).json();
     return external_exports.number().parse(data);
   }
   async function getSpsItemId(itemInfoId, signal) {
@@ -372,7 +442,10 @@ function createItemsApi(client) {
     return spsItemIdResponseSchema.parse(data);
   }
   async function getItemStatus(itemIds) {
-    const data = await client.post(`${BASE_URL12}/status`, { json: { itemIds } }).json();
+    const data = await client.post(`${BASE_URL12}/status`, {
+      json: { itemIds },
+      searchParams: getCompanyTypeSearchParams({ companyType })
+    }).json();
     return itemStatusResponseSchema.parse(data);
   }
   return {
@@ -389,9 +462,12 @@ function createItemsApi(client) {
 
 // lib/items/v2/index.ts
 var BASE_URL13 = "v2/items";
-function createItemsApiV2(client) {
+function createItemsApiV2(client, companyType) {
   async function getItemStatus(itemIds) {
-    const data = await client.post(`${BASE_URL13}/status`, { json: { itemIds } }).json();
+    const data = await client.post(`${BASE_URL13}/status`, {
+      json: { itemIds },
+      searchParams: getCompanyTypeSearchParams({ companyType })
+    }).json();
     return itemStatusV2ResponseSchema.parse(data);
   }
   return {
@@ -401,9 +477,10 @@ function createItemsApiV2(client) {
 
 // lib/errors/v1/index.ts
 var BASE_URL14 = "errors";
-function createErrorsApi(client) {
+function createErrorsApi(client, companyType) {
   async function getInvalidItemErrorDetails(itemInfoId, signal) {
     const data = await client.get(`${BASE_URL14}/items/${itemInfoId}`, {
+      searchParams: getCompanyTypeSearchParams({ companyType }),
       signal
     }).json();
     return itemErrorDetailsResultSchema.parse(data);
@@ -415,23 +492,31 @@ function createErrorsApi(client) {
 
 // lib/errors/v2/index.ts
 var BASE_URL15 = "errors/v2";
-function createErrorsApiV2(client) {
+function createErrorsApiV2(client, companyType) {
   async function getItemErrorSummary(params, signal) {
     const searchParams = new URLSearchParams();
-    if (params.searchField) searchParams.append("searchField", params.searchField);
+    if (params.searchField)
+      searchParams.append("searchField", params.searchField);
     if (params.searchText) searchParams.append("searchText", params.searchText);
     if (params.tradingPartnerIds) {
-      params.tradingPartnerIds.forEach((id) => searchParams.append("tradingPartnerIds", id.toString()));
+      params.tradingPartnerIds.forEach(
+        (id) => searchParams.append("tradingPartnerIds", id.toString())
+      );
     }
     if (params.offset) searchParams.append("offset", params.offset.toString());
     if (params.limit) searchParams.append("limit", params.limit.toString());
-    if (params.docInEventId) searchParams.append("docInEventId", params.docInEventId);
+    if (params.docInEventId)
+      searchParams.append("docInEventId", params.docInEventId);
     if (params.importId) searchParams.append("importId", params.importId);
+    if (companyType) searchParams.append("companyType", companyType);
     const data = await client.get(`${BASE_URL15}/summary`, { signal, searchParams }).json();
     return itemErrorSummaryResultV2Schema.parse(data);
   }
   async function getItemErrorDetails(itemInfoId, signal) {
-    const data = await client.get(`${BASE_URL15}/items/${itemInfoId}`, { signal }).json();
+    const data = await client.get(`${BASE_URL15}/items/${itemInfoId}`, {
+      searchParams: getCompanyTypeSearchParams({ companyType }),
+      signal
+    }).json();
     return itemErrorDetailsResultV2Schema.parse(data);
   }
   return {
@@ -470,9 +555,20 @@ var FlattenedItemIdentifierKeysSchema = external_exports.enum(
   FlattenedItemIdentifierKeys
 );
 
+// lib/uniqueCriteria/models/UniqueCriteriaOptionsSchema.ts
+var uniqueCriteriaOptions = external_exports.object({
+  name: external_exports.string(),
+  value: external_exports.string()
+});
+var uniqueCriteriaOptionsSchema = external_exports.array(uniqueCriteriaOptions);
+
 // lib/uniqueCriteria/index.ts
 var BASE_URL16 = "uniquecriteria";
 function createUniqueCriteriaApi(client) {
+  async function getUniqueCriteriaOptions() {
+    const data = await client.get(`${BASE_URL16}`).json();
+    return uniqueCriteriaOptionsSchema.parse(data);
+  }
   async function getUniqueCriteriaByOrg(params, signal) {
     const data = await client.get(`${BASE_URL16}/org`, {
       searchParams: params,
@@ -487,11 +583,24 @@ function createUniqueCriteriaApi(client) {
     }).json();
     return external_exports.array(FlattenedItemIdentifierKeysSchema).parse(data);
   }
-  return { getUniqueCriteriaByOrg, getProductUniqueCriteriaByOrg };
+  async function updateMultipleUniqueCriteriaAttributes(uniqueAttributes, companyId) {
+    await client.put(`${BASE_URL16}/multiple/${companyId}`, {
+      json: uniqueAttributes,
+      headers: {
+        "Content-Type": "application/json"
+      }
+    });
+  }
+  return {
+    getUniqueCriteriaOptions,
+    getUniqueCriteriaByOrg,
+    getProductUniqueCriteriaByOrg,
+    updateMultipleUniqueCriteriaAttributes
+  };
 }
 
 // lib/companies/index.ts
-var BASE_URL17 = "companys";
+var BASE_URL17 = "v3/companys";
 function createCompaniesApi(client) {
   async function getCompanyBriefInfoByOrg(params, signal) {
     const data = await client.get(`${BASE_URL17}/brief`, {

package/dist/{chunk-55ECRTUX.js → chunk-WX4LGXJV.js}

@@ -1,6 +1,6 @@
 import {
   external_exports
-} from "./chunk-LKUGPDIT.js";
+} from "./chunk-BMTYM2N6.js";
 
 // lib/asstClient.ts
 import ky from "ky";