@phystack/products 4.3.40-dev

package/src/types/iso-currency-codes.ts

@@ -0,0 +1,182 @@
+export enum IsoCurrencyCodes {
+  AED = 'AED',
+  AFN = 'AFN',
+  ALL = 'ALL',
+  AMD = 'AMD',
+  ANG = 'ANG',
+  AOA = 'AOA',
+  ARS = 'ARS',
+  AUD = 'AUD',
+  AWG = 'AWG',
+  AZN = 'AZN',
+  BAM = 'BAM',
+  BBD = 'BBD',
+  BDT = 'BDT',
+  BGN = 'BGN',
+  BHD = 'BHD',
+  BIF = 'BIF',
+  BMD = 'BMD',
+  BND = 'BND',
+  BOB = 'BOB',
+  BOV = 'BOV',
+  BRL = 'BRL',
+  BSD = 'BSD',
+  BTN = 'BTN',
+  BWP = 'BWP',
+  BYN = 'BYN',
+  BZD = 'BZD',
+  CAD = 'CAD',
+  CDF = 'CDF',
+  CHE = 'CHE',
+  CHF = 'CHF',
+  CHW = 'CHW',
+  CLF = 'CLF',
+  CLP = 'CLP',
+  COP = 'COP',
+  COU = 'COU',
+  CRC = 'CRC',
+  CUC = 'CUC',
+  CUP = 'CUP',
+  CVE = 'CVE',
+  CZK = 'CZK',
+  DJF = 'DJF',
+  DKK = 'DKK',
+  DOP = 'DOP',
+  DZD = 'DZD',
+  EGP = 'EGP',
+  ERN = 'ERN',
+  ETB = 'ETB',
+  EUR = 'EUR',
+  FJD = 'FJD',
+  FKP = 'FKP',
+  GBP = 'GBP',
+  GEL = 'GEL',
+  GHS = 'GHS',
+  GIP = 'GIP',
+  GMD = 'GMD',
+  GNF = 'GNF',
+  GTQ = 'GTQ',
+  GYD = 'GYD',
+  HKD = 'HKD',
+  HNL = 'HNL',
+  HRK = 'HRK',
+  HTG = 'HTG',
+  HUF = 'HUF',
+  IDR = 'IDR',
+  ILS = 'ILS',
+  INR = 'INR',
+  IQD = 'IQD',
+  IRR = 'IRR',
+  ISK = 'ISK',
+  JMD = 'JMD',
+  JOD = 'JOD',
+  JPY = 'JPY',
+  KES = 'KES',
+  KGS = 'KGS',
+  KHR = 'KHR',
+  KMF = 'KMF',
+  KPW = 'KPW',
+  KRW = 'KRW',
+  KWD = 'KWD',
+  KYD = 'KYD',
+  KZT = 'KZT',
+  LAK = 'LAK',
+  LBP = 'LBP',
+  LKR = 'LKR',
+  LRD = 'LRD',
+  LSL = 'LSL',
+  LYD = 'LYD',
+  MAD = 'MAD',
+  MDL = 'MDL',
+  MGA = 'MGA',
+  MKD = 'MKD',
+  MMK = 'MMK',
+  MNT = 'MNT',
+  MOP = 'MOP',
+  MRU = 'MRU',
+  MUR = 'MUR',
+  MVR = 'MVR',
+  MWK = 'MWK',
+  MXN = 'MXN',
+  MXV = 'MXV',
+  MYR = 'MYR',
+  MZN = 'MZN',
+  NAD = 'NAD',
+  NGN = 'NGN',
+  NIO = 'NIO',
+  NOK = 'NOK',
+  NPR = 'NPR',
+  NZD = 'NZD',
+  OMR = 'OMR',
+  PAB = 'PAB',
+  PEN = 'PEN',
+  PGK = 'PGK',
+  PHP = 'PHP',
+  PKR = 'PKR',
+  PLN = 'PLN',
+  PYG = 'PYG',
+  QAR = 'QAR',
+  RON = 'RON',
+  RSD = 'RSD',
+  CNY = 'CNY',
+  RUB = 'RUB',
+  RWF = 'RWF',
+  SAR = 'SAR',
+  SBD = 'SBD',
+  SCR = 'SCR',
+  SDG = 'SDG',
+  SEK = 'SEK',
+  SGD = 'SGD',
+  SHP = 'SHP',
+  SLL = 'SLL',
+  SOS = 'SOS',
+  SRD = 'SRD',
+  SSP = 'SSP',
+  STN = 'STN',
+  SVC = 'SVC',
+  SYP = 'SYP',
+  SZL = 'SZL',
+  THB = 'THB',
+  TJS = 'TJS',
+  TMT = 'TMT',
+  TND = 'TND',
+  TOP = 'TOP',
+  TRY = 'TRY',
+  TTD = 'TTD',
+  TWD = 'TWD',
+  TZS = 'TZS',
+  UAH = 'UAH',
+  UGX = 'UGX',
+  USD = 'USD',
+  USN = 'USN',
+  UYI = 'UYI',
+  UYU = 'UYU',
+  UYW = 'UYW',
+  UZS = 'UZS',
+  VED = 'VED',
+  VES = 'VES',
+  VND = 'VND',
+  VUV = 'VUV',
+  WST = 'WST',
+  XAF = 'XAF',
+  XAG = 'XAG',
+  XAU = 'XAU',
+  XBA = 'XBA',
+  XBB = 'XBB',
+  XBC = 'XBC',
+  XBD = 'XBD',
+  XCD = 'XCD',
+  XDR = 'XDR',
+  XOF = 'XOF',
+  XPD = 'XPD',
+  XPF = 'XPF',
+  XPT = 'XPT',
+  XSU = 'XSU',
+  XTS = 'XTS',
+  XUA = 'XUA',
+  XXX = 'XXX',
+  YER = 'YER',
+  ZAR = 'ZAR',
+  ZMW = 'ZMW',
+  ZWL = 'ZWL',
+}

package/src/types/iso-language-ids.ts

@@ -0,0 +1,170 @@
+export enum IsoLanguageIds {
+  af_ZA = 'af-ZA',
+  am_ET = 'am-ET',
+  ar_AE = 'ar-AE',
+  ar_BH = 'ar-BH',
+  ar_DZ = 'ar-DZ',
+  ar_EG = 'ar-EG',
+  ar_IQ = 'ar-IQ',
+  ar_JO = 'ar-JO',
+  ar_KW = 'ar-KW',
+  ar_LB = 'ar-LB',
+  ar_LY = 'ar-LY',
+  ar_MA = 'ar-MA',
+  ar_OM = 'ar-OM',
+  ar_QA = 'ar-QA',
+  ar_SA = 'ar-SA',
+  ar_SY = 'ar-SY',
+  ar_TN = 'ar-TN',
+  ar_YE = 'ar-YE',
+  as_IN = 'as-IN',
+  ba_RU = 'ba-RU',
+  be_BY = 'be-BY',
+  bg_BG = 'bg-BG',
+  bn_BD = 'bn-BD',
+  bn_IN = 'bn-IN',
+  bo_CN = 'bo-CN',
+  br_FR = 'br-FR',
+  ca_ES = 'ca-ES',
+  co_FR = 'co-FR',
+  cs_CZ = 'cs-CZ',
+  cy_GB = 'cy-GB',
+  da_DK = 'da-DK',
+  de_AT = 'de-AT',
+  de_CH = 'de-CH',
+  de_DE = 'de-DE',
+  de_LI = 'de-LI',
+  de_LU = 'de-LU',
+  dv_MV = 'dv-MV',
+  el_GR = 'el-GR',
+  en_AU = 'en-AU',
+  en_BZ = 'en-BZ',
+  en_CA = 'en-CA',
+  en_GB = 'en-GB',
+  en_IE = 'en-IE',
+  en_IN = 'en-IN',
+  en_JM = 'en-JM',
+  en_MY = 'en-MY',
+  en_NZ = 'en-NZ',
+  en_PH = 'en-PH',
+  en_SG = 'en-SG',
+  en_TT = 'en-TT',
+  en_US = 'en-US',
+  en_ZA = 'en-ZA',
+  en_ZW = 'en-ZW',
+  es_AR = 'es-AR',
+  es_BO = 'es-BO',
+  es_CL = 'es-CL',
+  es_CO = 'es-CO',
+  es_CR = 'es-CR',
+  es_DO = 'es-DO',
+  es_EC = 'es-EC',
+  es_ES = 'es-ES',
+  es_GT = 'es-GT',
+  es_HN = 'es-HN',
+  es_MX = 'es-MX',
+  es_NI = 'es-NI',
+  es_PA = 'es-PA',
+  es_PE = 'es-PE',
+  es_PR = 'es-PR',
+  es_PY = 'es-PY',
+  es_SV = 'es-SV',
+  es_US = 'es-US',
+  es_UY = 'es-UY',
+  es_VE = 'es-VE',
+  et_EE = 'et-EE',
+  eu_ES = 'eu-ES',
+  fa_IR = 'fa-IR',
+  fi_FI = 'fi-FI',
+  fo_FO = 'fo-FO',
+  fr_BE = 'fr-BE',
+  fr_CA = 'fr-CA',
+  fr_CH = 'fr-CH',
+  fr_FR = 'fr-FR',
+  fr_LU = 'fr-LU',
+  fr_MC = 'fr-MC',
+  fy_NL = 'fy-NL',
+  ga_IE = 'ga-IE',
+  gd_GB = 'gd-GB',
+  gl_ES = 'gl-ES',
+  gu_IN = 'gu-IN',
+  he_IL = 'he-IL',
+  hi_IN = 'hi-IN',
+  hr_BA = 'hr-BA',
+  hr_HR = 'hr-HR',
+  hu_HU = 'hu-HU',
+  hy_AM = 'hy-AM',
+  id_ID = 'id-ID',
+  ig_NG = 'ig-NG',
+  ii_CN = 'ii-CN',
+  is_IS = 'is-IS',
+  it_CH = 'it-CH',
+  it_IT = 'it-IT',
+  ja_JP = 'ja-JP',
+  ka_GE = 'ka-GE',
+  kk_KZ = 'kk-KZ',
+  kl_GL = 'kl-GL',
+  km_KH = 'km-KH',
+  kn_IN = 'kn-IN',
+  ko_KR = 'ko-KR',
+  ky_KG = 'ky-KG',
+  lb_LU = 'lb-LU',
+  lo_LA = 'lo-LA',
+  lt_LT = 'lt-LT',
+  lv_LV = 'lv-LV',
+  mi_NZ = 'mi-NZ',
+  mk_MK = 'mk-MK',
+  ml_IN = 'ml-IN',
+  mn_MN = 'mn-MN',
+  mr_IN = 'mr-IN',
+  ms_BN = 'ms-BN',
+  ms_MY = 'ms-MY',
+  mt_MT = 'mt-MT',
+  nb_NO = 'nb-NO',
+  ne_NP = 'ne-NP',
+  nl_BE = 'nl-BE',
+  nl_NL = 'nl-NL',
+  nn_NO = 'nn-NO',
+  oc_FR = 'oc-FR',
+  or_IN = 'or-IN',
+  pa_IN = 'pa-IN',
+  pl_PL = 'pl-PL',
+  ps_AF = 'ps-AF',
+  pt_BR = 'pt-BR',
+  pt_PT = 'pt-PT',
+  rm_CH = 'rm-CH',
+  ro_RO = 'ro-RO',
+  ru_RU = 'ru-RU',
+  rw_RW = 'rw-RW',
+  sa_IN = 'sa-IN',
+  se_FI = 'se-FI',
+  se_NO = 'se-NO',
+  se_SE = 'se-SE',
+  si_LK = 'si-LK',
+  sk_SK = 'sk-SK',
+  sl_SI = 'sl-SI',
+  sq_AL = 'sq-AL',
+  sv_FI = 'sv-FI',
+  sv_SE = 'sv-SE',
+  sw_KE = 'sw-KE',
+  ta_IN = 'ta-IN',
+  te_IN = 'te-IN',
+  th_TH = 'th-TH',
+  tk_TM = 'tk-TM',
+  tn_ZA = 'tn-ZA',
+  tr_TR = 'tr-TR',
+  tt_RU = 'tt-RU',
+  ug_CN = 'ug-CN',
+  uk_UA = 'uk-UA',
+  ur_PK = 'ur-PK',
+  vi_VN = 'vi-VN',
+  wo_SN = 'wo-SN',
+  xh_ZA = 'xh-ZA',
+  yo_NG = 'yo-NG',
+  zh_CN = 'zh-CN',
+  zh_HK = 'zh-HK',
+  zh_MO = 'zh-MO',
+  zh_SG = 'zh-SG',
+  zh_TW = 'zh-TW',
+  zu_ZA = 'zu-ZA',
+}

package/src/types/parameters.ts

@@ -0,0 +1,231 @@
+import { ProductFeatureModel } from './grid-product';
+import { IsoLanguageIds } from './iso-language-ids';
+
+export type ProductQueryParameters = {
+  select?: string;
+  filter?: string;
+  additionalRawFilter?: string;
+  sort?: string;
+  limit?: number;
+  page?: number;
+  includeAttributeFilters?: boolean;
+  attributeFilters?: string;
+  productTypesCoverage?: string;
+  isSourceSearch?: string; // temp: identifier to use azure cognitive search source
+  excludeUnavailable?: boolean;
+};
+
+export interface SearchQueryParameters {
+  term: string;
+  select?: string;
+  filter?: string;
+  additionalRawFilter?: string;
+  productTypesCoverage?: string;
+  excludeUnavailable?: boolean;
+}
+
+export interface ProductDetailsQueryParameters {
+  select?: string;
+  filter?: string;
+  includeProductsByVariantsByGroupId?: string;
+  productTypesCoverage?: string;
+  excludeUnavailable?: boolean;
+}
+
+export interface ProductDetailsByCodeQueryParameters {
+  select?: string;
+  filter?: string;
+  includeProductsByVariantsByGroupId?: 'true' | 'false';
+  productTypesCoverage?: string;
+  excludeUnavailable?: boolean;
+}
+
+export interface ProductFiltersQueryParameters {
+  productTypes?: string[];
+  filterKeys?: string[];
+  spaceId?: string;
+  productTypesCoverage?: string;
+  featureFilter?: string;
+}
+
+export enum FilterNumericKeys {
+  shellLifeDays = 'shellLifeDays',
+  productPriceList_suggestedRetailPrice = 'productPriceList/suggestedRetailPrice',
+  productPriceList_listPrice = 'productPriceList/listPrice',
+  productItemQuantity_productItemQuantity = 'productItemQuantity/productItemQuantity',
+}
+
+export enum SameValueFilterKeys {
+  productName = 'productName',
+  productShortDescription = 'productShortDescription',
+  productInternalName = 'productInternalName',
+  productStatus = 'productStatus',
+  productLabel = 'productLabel',
+  productTags = 'productTags',
+  productItemQuantity = 'productItemQuantity',
+  productVendor = 'productVendor',
+}
+
+export enum ObjectFilterKeys {
+  variants_productId = 'variants/productId',
+  variants_productGroupId = 'variants/productGroupId',
+  variants_periodStartDate = 'variants/periodStartDate',
+  variants_periodEndDate = 'variants/periodEndDate',
+  variants_color = 'variants/color',
+  variants_colorImageUrl = 'variants/colorImageUrl',
+  variants_size = 'variants/size',
+  variants_style = 'variants/style',
+  brand_brandName = 'brand/BrandName',
+  productStatus_isoLanguageId = 'productStatus/isoLanguageId',
+  productStatus_periodStartDate = 'productStatus/periodStartDate',
+  productStatus_periodEndDate = 'productStatus/periodEndDate',
+  productFeature_productFeatureType = 'productFeature/productFeatureType',
+  productFeature_productFeatureValue = 'productFeature/productFeatureValue',
+  productLabel_isoLanguageId = 'productLabel/isoLanguageId',
+  productTags_isoLanguageId = 'productTags/isoLanguageId',
+  productItemQuantity_productId = 'productItemQuantity/productId',
+  productItemQuantity_productItemQuantityStartDate = 'productItemQuantity/productItemQuantityStartDate',
+  productItemQuantity_productItemQuantityEndDate = 'productItemQuantity/productItemQuantityEndDate',
+  productItemQuantity_spaceId = 'productItemQuantity/spaceId',
+  productPriceList_suggestedRetailPrice = 'productPriceList/suggestedRetailPrice',
+  productPriceList_listPrice = 'productPriceList/listPrice',
+  productPriceList_spaceId = 'productPriceList/spaceId',
+  relatedProductGroups_relatedProductGroupId = 'relatedProductGroups/relatedProductGroupId',
+  relatedProductGroups_productRelationshipType = 'relatedProductGroups/productRelationshipType',
+}
+
+export enum SingleFilterKeys {
+  productGroupId = 'productGroupId',
+  tenantId = 'tenantId',
+  introductionDate = 'introductionDate',
+  plannedAbandonmentDate = 'plannedAbandonmentDate',
+  shellLifeDays = 'shellLifeDays',
+  isDeleted = 'isDeleted',
+  variantsGroupId = 'variantsGroupId',
+}
+
+export enum SingleArrayFilterKeys {
+  spaceIds = 'spaceIds',
+  productType = 'productType',
+}
+
+export enum ObjectArrayFilterKeys {
+  variants_globalTradeItemNumber = 'variants/globalTradeItemNumber',
+  variants_gtinName = 'variants/gtinName',
+  variants_europeanArticleNumber = 'variants/europeanArticleNumber',
+  variants_universalProductCode = 'variants/universalProductCode',
+}
+
+export const FilterableKeys = {
+  ...SingleFilterKeys,
+  ...SingleArrayFilterKeys,
+  ...ObjectFilterKeys,
+  ...SameValueFilterKeys,
+  ...FilterNumericKeys,
+  ...ObjectArrayFilterKeys,
+};
+
+export enum SortableKeys {
+  productGroupId = 'productGroupId',
+  introductionDate = 'introductionDate',
+  plannedAbandonmentDate = 'plannedAbandonmentDate',
+  shellLifeDays = 'shellLifeDays',
+}
+
+export type ProductFeatureParameters = Omit<ProductFeatureModel, 'id' | 'partitionKey'>;
+
+export enum RequestTypeEnum {
+  GET = 'GET',
+  POST = 'POST',
+}
+
+export enum ProductRecommendationSourceEnum {
+  DEFAULT = 'default',
+  STREAMOID = 'streamoid',
+  UNBXD = 'unbxd',
+}
+
+export enum ProductRecommendationInclusionEnum {
+  DEFAULT = 'default', // Default from Grid Products
+  ALL = 'all', // Both "Similar items" and "Complete the look"
+  SIMILAR_ITEMS = 'similarItems',
+  COMPLETE_THE_LOOK = 'completeTheLook',
+  SIMILAR = 'similar',
+  STYLE_WITH = 'styleWith',
+}
+
+export interface ProductRecommendationsBaseParameters {
+  source: ProductRecommendationSourceEnum;
+  recommendationInclusion?: ProductRecommendationInclusionEnum;
+  excludeUnavailable?: boolean;
+}
+
+export interface StreamoidRecommendationsQueryParameters
+  extends ProductRecommendationsBaseParameters {
+  streamoidRefreshToken?: string;
+}
+
+export interface UnbxdRecommendationsQueryParameters
+  extends ProductRecommendationsBaseParameters {
+  unbxdApiKey?: string;
+  unbxdSiteKey?: string;
+}
+
+export interface ProductRecommendationsQueryParameters
+  extends StreamoidRecommendationsQueryParameters,
+    UnbxdRecommendationsQueryParameters {
+  limit?: number;
+  storeId?: string;
+  spaceId?: string;
+}
+
+export interface ProductTypesListQueryParameters {
+  ids?: string[];
+  includeChildren?: boolean;
+}
+
+export interface ProductTypesListWithSpaceProductsQueryParameters {
+  spaceIds: string[];
+}
+
+export interface ProductGroupStoresInventoryParam {
+  storeId: string;
+  marketId: string;
+  storeSalesChannelId: string;
+  productGroupId: string;
+  requestedQty: number;
+  radiusMeters: number;
+  locale: IsoLanguageIds;
+}
+
+export interface ProductGroupInventory {
+  productGroupId: string;
+  productId: string;
+  quantity: number;
+  available: boolean;
+}
+
+export interface ProductGroupStoresInventoryResponse {
+  productGroupId: string;
+  store: {
+    storeId: string;
+    storeName?: string;
+    streetName1?: string;
+    streetName2?: string;
+    postCode?: string;
+    postalAddress?: string;
+    products: ProductGroupInventory[];
+  };
+  online: {
+    products: ProductGroupInventory[];
+  };
+  nearbyStores: {
+    storeId: string;
+    storeName?: string;
+    streetName1?: string;
+    streetName2?: string;
+    postCode?: string;
+    postalAddress?: string;
+    products: ProductGroupInventory[];
+  }[];
+}