@uappi/public-sdk 1.0.0

package/modules/Api/types/endpoints/shipment/shipment.interfaces.ts

@@ -0,0 +1,137 @@
+import type {
+  CountryAlpha3,
+  Media,
+  ProductType,
+  StateCode,
+  Storage,
+} from '../..';
+
+export interface ShipmentQuoteCartRequest {
+  targetCountryCode: CountryAlpha3;
+  targetZipCode: string;
+}
+export interface ShippingOption {
+  beginShippingTime: number;
+  endShippingTime: number;
+  label: string;
+  selected: boolean;
+  shippingPickupPointId: null;
+  shippingTableId: number;
+  shippingTimeType: string;
+  shippingValue: number;
+  details: {
+    beginShippingTime: number;
+    carrierName: string;
+    endShippingTime: number;
+    error: null | string;
+    externalShippingCode: string;
+    integrationCode: string;
+    label: string;
+    pickups: null | Array<PickupPoint>;
+    row: null;
+    shippingTableId: number;
+    value: number;
+  };
+}
+
+export interface PickupPoint {
+  address: string;
+  city: string;
+  selected: boolean;
+  complement: string;
+  countryCode: CountryAlpha3;
+  district: string;
+  id: number;
+  latitude: string;
+  longitude: string;
+  name: string;
+  number: string;
+  openingHours: string;
+  stateCode: StateCode;
+  type: 'inner' | 'outer';
+  zipCode: string;
+}
+
+export interface ShipmentQuoteProductRequest {
+  targetCountryCode: string;
+  targetZipCode: string;
+  items: Array<{ productId: number; quantity: number }>;
+}
+export interface ShipmentQuoteProductResponse {
+  errorItems: Array<never>;
+  quoteGroups: Array<QuoteGroupProduct>;
+}
+export interface QuoteGroupProduct {
+  additionalTimeGroup: number;
+  cargoTypeCombination: [];
+  distance: number;
+  error: null | string;
+
+  items: Array<QuoteGroupProductItem>;
+
+  originZipCode: string;
+  productStorageId: number;
+  quantityItems: number;
+  quoteId: string;
+  service: boolean;
+
+  shippingOptions: Array<ShippingOptionProduct>;
+  storage: Storage;
+}
+
+export interface QuoteGroupProductItem {
+  additionalTime: number;
+  cargoTypeId: number;
+  category: { id: number; name: string };
+  code: null;
+  cubicVolumeItem: number;
+  error: null;
+  name: string;
+  product: {
+    active: boolean;
+    combination: Array<number>;
+    comparisonPrice: number;
+    medias: Array<Media>;
+    name: string;
+    productId: number;
+    sku: string;
+    stock: number;
+    type: ProductType;
+    url: string | null;
+  };
+  productId: number;
+  productPairOfferId: null;
+  productPriceRuleId: number;
+  productPriceRuleName: string;
+  productStorages: Array<never>;
+  quantity: number;
+  saleWithoutStock: boolean;
+  service: boolean;
+  sku: string;
+  totalCubicVolume: number;
+  upsellId: null;
+  value: number;
+  volume: { width: number; height: number; length: number; weight: number };
+}
+
+export interface ShippingOptionProduct {
+  beginShippingTime: number;
+  carrierName: string;
+  endShippingTime: number;
+  error: null;
+  externalShippingCode: string;
+  integrationCode: string;
+  label: string;
+  pickups: null;
+  row: null;
+  shippingTableId: number;
+  value: number;
+}
+
+export interface SelectShipimentRequest {
+  orders: Array<{
+    cartOrderId: number;
+    shippingTableId: number;
+    shippingPickupPointId?: number;
+  }>;
+}

package/modules/Api/types/endpoints/showcase/showcase.enums.ts

@@ -0,0 +1,8 @@
+export enum TitleType {
+  H1 = 'h1',
+  H2 = 'h2',
+  H3 = 'h3',
+  H5 = 'h5',
+  P = 'p',
+  SPAN = 'span',
+}

package/modules/Api/types/endpoints/showcase/showcase.interfaces.ts

@@ -0,0 +1,10 @@
+import type { Product } from '../..';
+export interface Showcase {
+  id: number;
+  name: string;
+  code: string;
+  title: string;
+  description: string;
+  bannerGroups: Array<string>;
+  products: Array<Product>;
+}

package/modules/Api/types/endpoints/simple-product/simple-product.interfaces.ts

@@ -0,0 +1,15 @@
+import type { CurrentAttribute, Media, ProductType } from '../..';
+
+export interface SimpleProduct {
+  productId: number;
+  type: ProductType;
+  sku: string;
+  name: string;
+  active: boolean;
+  url: string;
+  comparisonPrice: number;
+  stock: number;
+  medias: Array<Media>;
+  combination: Array<number>;
+  currentAttributes: Array<CurrentAttribute>;
+}

package/modules/Api/types/endpoints/storage/storage.interfaces.ts

@@ -0,0 +1,16 @@
+export interface Storage {
+  active: boolean;
+  address: string;
+  city: string;
+  code: string;
+  complement: string;
+  corporateName: string;
+  district: string;
+  document: string;
+  id: number;
+  latitude: number;
+  longitude: number;
+  number: string;
+  observation: null;
+  zipCode: string;
+}

package/modules/Api/types/endpoints/template/template.interfaces.ts

@@ -0,0 +1,30 @@
+type App = {
+  code: 'google-tag-manager';
+  settings: {
+    'google-tag-manager-id': string;
+  }
+} | {
+  code: 'meta-pixel';
+  settings: {
+    'meta-pixel-id': string;
+  }
+} | {
+  code: 'google-consumer-reviews';
+  settings: {
+    'google-merchant-id': string;
+  }
+} | {
+  code: 'google-login';
+  settings: {
+    'google-login-client-id': string;
+  }
+} | {
+  code: 'facebook-login';
+  settings: {
+    'facebook-login-client-id': string;
+  }
+}
+export interface TemplateResponse<S = unknown> {
+  apps: Array<App>;
+  settings: S;
+}

package/modules/Api/types/endpoints/third-party/oauth.interfaces.ts

@@ -0,0 +1,6 @@
+export type OauthType = 'google-login' | 'facebook-login';
+
+export interface RedirectRequest {
+  loginUrl: string;
+  registerUrl: string;
+}

package/modules/Api/types/endpoints/upsell/upsell.interfaces.ts

@@ -0,0 +1,13 @@
+import type { PriceRule, Product } from '../..';
+
+export interface Upsell {
+  id: number;
+  displayTitle: string;
+  displayDescription: string;
+  displayButtonText: string;
+  quantity: number;
+  upsellProduct: Product;
+  priceRule: PriceRule;
+}
+
+export type UpsellResponse = Array<Upsell>;

package/modules/Api/types/endpoints/url/url.interfaces.ts

@@ -0,0 +1,85 @@
+import type {
+  Product,
+  Page,
+  ProductCategory,
+  FilterValue,
+  PriceFilter,
+  Seal,
+  Descriptions,
+  Pagination,
+  Attribute,
+  BrandItem,
+} from '../..';
+
+export interface UrlMenu {
+  brands: Array<{
+    id: number;
+    name: string;
+    logo: string;
+    url: string;
+  }>;
+  categories: Array<ProductCategory>;
+  filters: Array<{
+    id: number;
+    name: string;
+    values: Array<FilterValue>;
+  }>;
+  seals: Array<Seal>;
+  attributes: Array<Attribute>;
+  prices: Array<PriceFilter>;
+}
+
+export interface UrlProduct {
+  type: 'product';
+  entity: Product;
+  menu: null;
+  content: Product;
+}
+
+export interface UrlPage {
+  type: 'page';
+  entity: Page;
+  menu: null;
+  content: Array<never>;
+}
+
+export interface UrlBrand {
+  type: 'brand';
+  entity: BrandItem;
+  menu: UrlMenu;
+  content: {
+    registers: Array<Product>;
+    pagination: Pagination;
+  };
+}
+
+export interface UrlListing {
+  type: 'category';
+  entity: {
+    id: number;
+    parentProductCategoryId: null | string;
+    code: string;
+    name: string;
+    productOrdering: string;
+    active: boolean;
+    directAccess: boolean;
+    bannerGroups: Array<string>;
+    createdAt: string;
+    updatedAt: string;
+    tree: {
+      current: null;
+      children: Array<ProductCategory>;
+      sisters: Array<ProductCategory>;
+      parent: Array<ProductCategory>;
+    };
+    url: string;
+    urls: Array<never>;
+    linkedTradePolicies: null;
+    description: Descriptions;
+  };
+  menu: UrlMenu;
+  content: {
+    registers: Array<Product>;
+    pagination: Pagination;
+  };
+}

package/modules/Api/types/endpoints/wallet/wallet-obsearch.ts

@@ -0,0 +1,8 @@
+export type WalletSortFields = 'id' | 'createdAt';
+
+export type WalletConditionFields =
+  | 'action'
+  | 'promotionalVoucherId'
+  | 'productGiftCardGeneratedId'
+  | 'orderId'
+  | 'createdAt';

package/modules/Api/types/endpoints/wallet/wallet.interfaces.ts

@@ -0,0 +1,57 @@
+import type { Pagination } from '../pagination/pagination.interfaces';
+
+export interface WalletTransactionResponse {
+  registers: Array<WalletTransaction>;
+  pagination: Pagination;
+}
+
+export interface WalletTransaction {
+  id: number;
+  voucher: null | {
+    createdAt: string;
+    customer: null;
+    customerId: number;
+    hash: string;
+    id: number;
+    observation: null | string;
+    userEmail: string;
+    userId: number;
+    userName: string;
+    value: number;
+  };
+  giftCard: null | {
+    activatedAt: string;
+    createdAt: string;
+    code: string;
+    id: number;
+    orderItemId: null;
+    productId: number;
+    userEmail: string;
+    userId: number;
+    userName: string;
+    value: number;
+  };
+  order: {
+    id: number;
+    orderGroupId: number;
+    productStorageId: number;
+    orderStatusId: number;
+  };
+  action: 'remove' | 'action';
+  value: number;
+  createdAt: string;
+}
+
+export interface ClaimGiftCardRequest {
+  codes: Array<string>;
+}
+
+export type ClaimGiftCardResponse = Array<{
+  code: string;
+  customerId: number;
+  error:
+    | 'UAPPI_STORE_GIFT_CARD_NOT_FOUND'
+    | 'UAPPI_STORE_GIFT_CARD_ALREADY_LINKED'
+    | null;
+  giftCardId: number | null;
+}>;

package/modules/Api/types/endpoints/zipcode/zipcode.interfaces.ts

@@ -0,0 +1,23 @@
+import type {
+  CountryAlpha2,
+  CountryAlpha3,
+  CountryName,
+  CountryPhoneCode,
+  StateCode,
+} from '../country/country.types';
+
+export interface ZipcodeResponse {
+  zipCode: string;
+  publicPlace: string;
+  complement: string;
+  district: string;
+  city: string;
+  stateCode: StateCode;
+  latitude: number;
+  longitude: number;
+  countryName: CountryName;
+  countryCodeAlpha2: CountryAlpha2;
+  countryCodeAlpha3: CountryAlpha3;
+  ddi: CountryPhoneCode;
+  currency: string;
+}