@spscommerce/asst-api 0.0.1-beta.0 → 0.0.1-beta.10

package/dist/index.d.ts

@@ -1,33 +1,12 @@
-import { A as AsstClient, V as VendorPartnerAttGroups, a as AttrProdType, T as TradingPartnerAccessByCompanyId } from './TradingPartnerAccessByCompanyId-479e3e57.js';
-export { b as AsstClientOptions, c as AsstUrl, B as BASE_URLS, E as Env } from './TradingPartnerAccessByCompanyId-479e3e57.js';
-import { I as Import, a as ImportsStatus, E as Export, b as ItemCategoriesSearch } from './ItemCategoriesSearch-1bb945de.js';
-export { c as ImportErrors } from './ItemCategoriesSearch-1bb945de.js';
+import { A as AsstClient, I as Import, a as ImportsStatus, V as VendorPartnerAttGroups, E as Export, b as AttrProdType, T as TradingPartnerAccessByCompanyId, c as ItemCategoriesSearch, d as AttributeMetaData, e as AttributesByCompany, f as AttributeDefinition, g as AttributeValidValues, L as Locale, S as SpreadsheetTemplate, U as UserAccount, h as ItemSearchView, i as ItemDetailView, j as ItemErrorDetailsResult } from './ItemErrorDetailsResult-fbc33a43.js';
+export { k as AsstClientOptions, l as AsstUrl, B as BASE_URLS, m as Env, n as ImportErrors } from './ItemErrorDetailsResult-fbc33a43.js';
+import { G as GenerateImportTemplateParams, D as DownLoadItemsParams, I as ItemHierarchyResponse, a as ItemDetail, S as SpsItemIdResponse } from './ItemErrorDetails-ba155b70.js';
+export { i as AttrDatatypeNameEnum, t as AttributeDetail, j as AttributeGroup, A as AttributeSummary, K as Bulb, u as CategoryEnum, v as ComponentDetails, C as Connection, E as ExportDayOfWeek, e as ExportFrequency, f as ExportType, w as GroupedAttributeList, x as GroupedAttributes, y as GroupedItem, H as Hierarchy, z as HierarchyCategory, B as HierarchyDetails, m as IdentityServiceDatetimePreferences, n as IdentityServiceOrganization, l as IdentityServiceOrganizationMetadata, o as IdentityServicePreferences, p as IdentityServiceUser, b as ImportDetails, c as ImportError, d as ImportStatusEnum, g as ItemCategory, Q as ItemErrorDetails, q as ItemHeader, h as ItemHierarchy, r as ItemMap, F as ItemPrice, s as ItemTable, M as MediaItem, L as PackComponent, J as PackComponentDetails, O as PackComponentItemInfo, P as PhaseEnum, R as RegisteredService, N as RepeatableGroup, k as SpreadsheetTemplateCompany, T as TradingPartnerStage } from './ItemErrorDetails-ba155b70.js';
+import { I as ItemStatusResponse } from './ItemStatusResponse-7f871d5a.js';
 import { z } from 'zod';
-export { E as ExportDayOfWeek, c as ExportFrequency, d as ExportType, I as ImportDetails, a as ImportError, b as ImportStatusEnum, e as ItemCategory } from './ItemCategory-768179bd.js';
 import 'ky-universal';
 import 'ky';
 
-declare const generateImportTemplateParamsSchema: z.ZodObject<{
-    "multi-sheet": z.ZodBoolean;
-    gids: z.ZodOptional<z.ZodString>;
-    productTypeIds: z.ZodOptional<z.ZodString>;
-    groupTypeId: z.ZodOptional<z.ZodNumber>;
-    includeGuides: z.ZodOptional<z.ZodBoolean>;
-}, "strip", z.ZodTypeAny, {
-    "multi-sheet": boolean;
-    gids?: string | undefined;
-    productTypeIds?: string | undefined;
-    groupTypeId?: number | undefined;
-    includeGuides?: boolean | undefined;
-}, {
-    "multi-sheet": boolean;
-    gids?: string | undefined;
-    productTypeIds?: string | undefined;
-    groupTypeId?: number | undefined;
-    includeGuides?: boolean | undefined;
-}>;
-type GenerateImportTemplateParams = z.infer<typeof generateImportTemplateParamsSchema>;
-
 /**
  * Initialize Imports Api functions
  * @param client Assortment Client instance
@@ -41,10 +20,10 @@ declare function createImportsApi(client: AsstClient): {
         importId: number;
         count: number;
         errors: {
-            attribute: string;
             description: string;
             importErrorId: number;
             row: number;
+            attribute?: string | null | undefined;
         }[];
         hasNext: boolean;
         totalCount: number;
@@ -65,6 +44,7 @@ declare function createImportsApi(client: AsstClient): {
  */
 declare function createExportsApi(client: AsstClient): {
     createExport: (data: Export) => Promise<void>;
+    downloadItems: (params: DownLoadItemsParams) => Promise<void>;
 };
 
 /**
@@ -78,24 +58,6 @@ declare function createProductTypesApi(client: AsstClient): {
     }, signal?: AbortSignal) => Promise<AttrProdType[]>;
 };
 
-declare const connectionSchema: z.ZodObject<{
-    catalog_id: z.ZodNumber;
-    catalog_name: z.ZodString;
-    partner_company_name: z.ZodString;
-    partner_company_id: z.ZodNumber;
-}, "strip", z.ZodTypeAny, {
-    catalog_id: number;
-    catalog_name: string;
-    partner_company_name: string;
-    partner_company_id: number;
-}, {
-    catalog_id: number;
-    catalog_name: string;
-    partner_company_name: string;
-    partner_company_id: number;
-}>;
-type Connection = z.infer<typeof connectionSchema>;
-
 /**
  * Initialize Trading Partner Access Api functions
  * @param client Assortment Client instance
@@ -116,10 +78,199 @@ declare function createCategoriesApi(client: AsstClient): {
     }, signal?: AbortSignal) => Promise<ItemCategoriesSearch>;
     getProductCodes: (params?: {
         categoryName?: string;
+        catalogId?: string;
+        selectionCodeId?: string;
     }, signal?: AbortSignal) => Promise<ItemCategoriesSearch>;
     getSelectionCodes: (params?: {
         categoryName?: string;
+        catalogId?: string;
     }, signal?: AbortSignal) => Promise<ItemCategoriesSearch>;
+    getItemHierarchy: (itemIds: string[]) => Promise<ItemHierarchyResponse>;
+};
+
+/**
+ * Initialize Attributes Api functions
+ * @param client Assortment Client instance
+ * @returns An object containing Attributes API functions
+ */
+declare function createAttributesApi(client: AsstClient): {
+    getAllAttributes: (signal?: AbortSignal) => Promise<AttributeMetaData[]>;
+    getAllAttributesByCompany: (params?: {
+        offset?: number;
+        limit?: number;
+    }, signal?: AbortSignal) => Promise<AttributesByCompany>;
+    getAttributesExtensiveInfo: (signal?: AbortSignal) => Promise<AttributeDefinition[]>;
+    getAttributeValidValues: (attributeDbName: string, signal?: AbortSignal) => Promise<AttributeValidValues[]>;
+    getCompanyInterestedAttributes: (signal?: AbortSignal) => Promise<string[]>;
+};
+
+/**
+ * Initialize Locale Api functions
+ * @param client Assortment Client instance
+ * @returns An object containing Locale API functions
+ */
+declare function createLocaleApi(client: AsstClient): {
+    getLocale: (signal?: AbortSignal) => Promise<Locale[]>;
+};
+
+/**
+ * Initialize Spreadsheet Template Api functions
+ * @param client Assortment Client instance
+ * @returns An object containing Spreadsheet Template API functions
+ */
+declare function createSpreadsheetTemplateApi(client: AsstClient): {
+    getTemplates: (signal?: AbortSignal) => Promise<SpreadsheetTemplate[]>;
+};
+
+/**
+ * Initialize WhoAmI Api functions
+ * @param client Assortment Client instance
+ * @returns An object containing WhoAmI API functions
+ */
+declare function createWhoAmIApi(client: AsstClient): {
+    whoAmI: (signal?: AbortSignal) => Promise<UserAccount>;
+};
+
+/**
+ * Initialize Company Features Api functions
+ * @param client Assortment Client instance
+ * @returns An object containing Company Features API functions
+ */
+declare function createCompanyFeaturesApi(client: AsstClient): {
+    checkIfStageItemSetupIsEnabled: (signal?: AbortSignal) => Promise<boolean>;
+};
+
+/**
+ * Initialize Feature Flags Api functions
+ * @param client Assortment Client instance
+ * @returns An object containing feature flags utility functions
+ */
+declare function createFeatureFlagsApi(client: AsstClient): {
+    checkEnableItemsApiEndpointsForImports: (signal?: AbortSignal) => Promise<boolean>;
+};
+
+declare const itemStatusSchema: z.ZodObject<{
+    itemId: z.ZodString;
+    itemOrgStatuses: z.ZodArray<z.ZodObject<{
+        org: z.ZodObject<{
+            ref: z.ZodString;
+            id: z.ZodString;
+            name: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            name: string;
+            id: string;
+            ref: string;
+        }, {
+            name: string;
+            id: string;
+            ref: string;
+        }>;
+        lowestInvalidStage: z.ZodNullable<z.ZodEnum<["CORE", "CORE_PLUS", "CORE_ADVANCED", "ENRICHED", "STANDARD_REQUIREMENTS"]>>;
+        validForRelationship: z.ZodBoolean;
+    }, "strip", z.ZodTypeAny, {
+        org: {
+            name: string;
+            id: string;
+            ref: string;
+        };
+        lowestInvalidStage: "CORE" | "CORE_PLUS" | "CORE_ADVANCED" | "ENRICHED" | "STANDARD_REQUIREMENTS" | null;
+        validForRelationship: boolean;
+    }, {
+        org: {
+            name: string;
+            id: string;
+            ref: string;
+        };
+        lowestInvalidStage: "CORE" | "CORE_PLUS" | "CORE_ADVANCED" | "ENRICHED" | "STANDARD_REQUIREMENTS" | null;
+        validForRelationship: boolean;
+    }>, "many">;
+}, "strip", z.ZodTypeAny, {
+    itemId: string;
+    itemOrgStatuses: {
+        org: {
+            name: string;
+            id: string;
+            ref: string;
+        };
+        lowestInvalidStage: "CORE" | "CORE_PLUS" | "CORE_ADVANCED" | "ENRICHED" | "STANDARD_REQUIREMENTS" | null;
+        validForRelationship: boolean;
+    }[];
+}, {
+    itemId: string;
+    itemOrgStatuses: {
+        org: {
+            name: string;
+            id: string;
+            ref: string;
+        };
+        lowestInvalidStage: "CORE" | "CORE_PLUS" | "CORE_ADVANCED" | "ENRICHED" | "STANDARD_REQUIREMENTS" | null;
+        validForRelationship: boolean;
+    }[];
+}>;
+type ItemStatus = z.infer<typeof itemStatusSchema>;
+
+declare const itemOrgStatusSchema: z.ZodObject<{
+    org: z.ZodObject<{
+        ref: z.ZodString;
+        id: z.ZodString;
+        name: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        id: string;
+        ref: string;
+    }, {
+        name: string;
+        id: string;
+        ref: string;
+    }>;
+    lowestInvalidStage: z.ZodNullable<z.ZodEnum<["CORE", "CORE_PLUS", "CORE_ADVANCED", "ENRICHED", "STANDARD_REQUIREMENTS"]>>;
+    validForRelationship: z.ZodBoolean;
+}, "strip", z.ZodTypeAny, {
+    org: {
+        name: string;
+        id: string;
+        ref: string;
+    };
+    lowestInvalidStage: "CORE" | "CORE_PLUS" | "CORE_ADVANCED" | "ENRICHED" | "STANDARD_REQUIREMENTS" | null;
+    validForRelationship: boolean;
+}, {
+    org: {
+        name: string;
+        id: string;
+        ref: string;
+    };
+    lowestInvalidStage: "CORE" | "CORE_PLUS" | "CORE_ADVANCED" | "ENRICHED" | "STANDARD_REQUIREMENTS" | null;
+    validForRelationship: boolean;
+}>;
+type ItemOrgStatus = z.infer<typeof itemOrgStatusSchema>;
+
+/**
+ * Initialize Items Api functions
+ * @param client Assortment Client instance
+ * @returns An object containing Items API functions
+ */
+declare function createItemsApi(client: AsstClient): {
+    searchItems: (params?: {
+        url: string;
+        limit?: number;
+        offset?: number;
+    }, signal?: AbortSignal) => Promise<ItemSearchView>;
+    getItem: (itemId: string, locale?: string, signal?: AbortSignal) => Promise<ItemDetailView>;
+    updateItem: (itemId: string, item: ItemDetail) => Promise<void>;
+    deleteItem: (itemId: number) => Promise<void>;
+    deleteItems: (itemIds: string[]) => Promise<void>;
+    getItemInfoId: (spsItemId: string, signal?: AbortSignal) => Promise<number>;
+    getSpsItemId: (itemInfoId: string, signal?: AbortSignal) => Promise<SpsItemIdResponse>;
+    getItemStatus: (itemIds: string[]) => Promise<ItemStatusResponse>;
+};
+
+/**
+ * Initialize Errors Api functions
+ * @param client Assortment Client instance
+ * @returns An object containing Errors API functions
+ */
+declare function createErrorsApi(client: AsstClient): {
+    getInvalidItemErrorDetails: (itemInfoId: string, signal?: AbortSignal) => Promise<ItemErrorDetailsResult>;
 };
 
-export { AsstClient, AttrProdType, Connection, Export, GenerateImportTemplateParams, Import, ImportsStatus, ItemCategoriesSearch, TradingPartnerAccessByCompanyId, VendorPartnerAttGroups, createCategoriesApi, createExportsApi, createImportsApi, createProductTypesApi, createTradingPartnerAccessApi };
+export { AsstClient, AttrProdType, AttributeDefinition, AttributeMetaData, AttributeValidValues, AttributesByCompany, DownLoadItemsParams, Export, GenerateImportTemplateParams, Import, ImportsStatus, ItemCategoriesSearch, ItemDetail, ItemDetailView, ItemErrorDetailsResult, ItemHierarchyResponse, ItemOrgStatus, ItemSearchView, ItemStatus, ItemStatusResponse, Locale, SpreadsheetTemplate, SpsItemIdResponse, TradingPartnerAccessByCompanyId, UserAccount, VendorPartnerAttGroups, createAttributesApi, createCategoriesApi, createCompanyFeaturesApi, createErrorsApi, createExportsApi, createFeatureFlagsApi, createImportsApi, createItemsApi, createLocaleApi, createProductTypesApi, createSpreadsheetTemplateApi, createTradingPartnerAccessApi, createWhoAmIApi };

package/dist/index.js

@@ -1,69 +1,36 @@
 import {
+  createAttributesApi,
   createCategoriesApi,
+  createCompanyFeaturesApi,
+  createErrorsApi,
   createExportsApi,
+  createFeatureFlagsApi,
   createImportsApi,
+  createItemsApi,
+  createLocaleApi,
   createProductTypesApi,
-  createTradingPartnerAccessApi
-} from "./chunk-RNUSCCKB.js";
-import "./chunk-D3ML6E4G.js";
-
-// lib/asstClient.ts
-import ky from "ky-universal";
-var BASE_URLS = {
-  local: "https://localhost:8443",
-  test: "https://integration.api.spscommerce.com/assortment/gateway",
-  prod: "https://api.spscommerce.com/assortment/gateway"
-};
-var AsstClient = class {
-  #client = ky.create({
-    prefixUrl: BASE_URLS["test"],
-    retry: 0
-  });
-  #baseUrl = BASE_URLS["test"];
-  #subscriptionCallback;
-  constructor(options) {
-    this.updateConfig(options);
-  }
-  updateConfig(options) {
-    this.#client = this.#client.extend(options);
-    if (options.prefixUrl) {
-      this.#baseUrl = options.prefixUrl;
-    }
-    if (this.#subscriptionCallback) {
-      this.#subscriptionCallback(options);
-    }
-  }
-  getBaseUrl() {
-    return this.#baseUrl;
-  }
-  subscribeToConfigChange(subscriptionCallback) {
-    this.#subscriptionCallback = subscriptionCallback;
-  }
-  get(url, options) {
-    return this.#client.get(url, options);
-  }
-  post(url, options) {
-    return this.#client.post(url, options);
-  }
-  put(url, options) {
-    return this.#client.put(url, options);
-  }
-  patch(url, options) {
-    return this.#client.patch(url, options);
-  }
-  head(url, options) {
-    return this.#client.head(url, options);
-  }
-  delete(url, options) {
-    return this.#client.delete(url, options);
-  }
-};
+  createSpreadsheetTemplateApi,
+  createTradingPartnerAccessApi,
+  createWhoAmIApi
+} from "./chunk-J3A66IGS.js";
+import {
+  AsstClient,
+  BASE_URLS
+} from "./chunk-5YWAQNT6.js";
 export {
   AsstClient,
   BASE_URLS,
+  createAttributesApi,
   createCategoriesApi,
+  createCompanyFeaturesApi,
+  createErrorsApi,
   createExportsApi,
+  createFeatureFlagsApi,
   createImportsApi,
+  createItemsApi,
+  createLocaleApi,
   createProductTypesApi,
-  createTradingPartnerAccessApi
+  createSpreadsheetTemplateApi,
+  createTradingPartnerAccessApi,
+  createWhoAmIApi
 };