@uappi/public-sdk 1.0.0

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

@@ -0,0 +1,26 @@
+export interface Menu {
+  id: number;
+  code: string;
+  name: string;
+  items: Array<MenuItem>;
+}
+
+export interface MenuItem {
+  id: number;
+  templateMenuItemId: number;
+  active: boolean;
+  title: string;
+  type: 'custom' | 'product' | 'category' | 'brand' | 'page';
+  productId: number | null;
+  productCategoryId: number | null;
+  productBrandId: number | null;
+  productPageId: number | null;
+  image1: string;
+  image2: string;
+  highlight: boolean;
+  order: number;
+  url: string;
+  target: '_blank' | '_self' | '_parent' | '_top';
+  bannerGroups: Array<string>;
+  items: Array<MenuItem>;
+}

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

@@ -0,0 +1,63 @@
+import type {
+  Media,
+  ProductType,
+  Storage,
+  ShippingOption,
+  CurrentAttribute,
+} from '../..';
+
+export interface Order {
+  orderId: number;
+  quoteId: string;
+  distance: number;
+  subtotalValue: number;
+  shippingValue: number;
+  discountValue: number;
+  additionValue: number;
+  totalValue: number;
+  service: boolean;
+  storage: null | Storage;
+  items: Array<OrderItem>;
+  additions: Array<never>;
+  discounts: Array<OrderDiscount>;
+  shippingOptions: Array<ShippingOption>;
+}
+
+export interface OrderItem {
+  itemId: number;
+  upsellId: null | number;
+  productPairOfferId: null | number;
+  productPriceRuleId: number;
+  productPriceRuleName: 'Original';
+  quantity: number;
+  code: null | string;
+  unitValue: number;
+  unitAdditionValue: number;
+  unitDiscountValue: number;
+  subtotalValue: number;
+  subtotalAdditionValue: number;
+  subtotalDiscountValue: number;
+  totalValue: number;
+  product: {
+    active: boolean;
+    brandId: number;
+    productId: number;
+    type: ProductType;
+    sku: string;
+    name: string;
+    url: null | string;
+    comparisonPrice: number;
+    stock: number;
+    medias: null | Array<Media>;
+    combination: Array<number>;
+    currentAttributes: Array<CurrentAttribute>;
+  };
+}
+
+export interface OrderDiscount {
+  discountId: number;
+  discountMainCode: string;
+  discountTitle: string;
+  discountType: 'coupon';
+  discountValue: number;
+}

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

@@ -0,0 +1,15 @@
+import type { Descriptions } from '../..';
+
+export interface Page {
+  id: number;
+  code: string;
+  name: string;
+  active: boolean;
+  bannerGroups: Array<string>;
+  url: string;
+  urls: Array<string>;
+  linkedTradePolicies: null;
+  description: Descriptions;
+  createdAt: string;
+  updatedAt: string;
+}

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

@@ -0,0 +1,6 @@
+export interface Pagination {
+  limit: number;
+  offset: number;
+  pages: number;
+  registers: number;
+}

package/modules/Api/types/endpoints/pair-offer/pair-offer.interfaces.ts

@@ -0,0 +1,19 @@
+import type { PriceRule, Product } from '../..';
+
+export interface PairOffer {
+  productId1: number;
+  productId2: number;
+  target: 'both' | 'product-1' | 'product-2';
+  active: boolean;
+  createdAt: string;
+  priceRule: PriceRule;
+  price: {
+    comparisonPrice: number;
+    discountValue: number;
+    salePrice: number;
+  };
+
+  products: Array<Product>;
+}
+
+export type PairOfferResponse = Array<PairOffer>;

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

@@ -0,0 +1,103 @@
+import type { ConfigurationCode, PaymentCode, ProductInstallment } from '../..';
+
+export type PaymentResponse = Array<{
+  paymentOption: Payment;
+  error: null | string;
+  installments: Array<ProductInstallment>;
+  cashDiscount: {
+    discountPercentage: number;
+    discountValue: number;
+    valueWithDiscount: number;
+  };
+}>;
+
+export interface Payment {
+  id: number;
+  paymentId: number;
+  paymentStoreCredentialId: number;
+  paymentAntiFraudCredentialId: null;
+  paymentType: PaymentType;
+  active: boolean;
+  label: string;
+  description: string;
+  instruction: string;
+  paymentCode: string;
+  publicCredentials: any;
+  order: number;
+  options: Array<Payment>;
+  configurations: Array<PaymentConfiguration>;
+  cashDiscount: {
+    discountPercentage: number;
+    discountValue: number;
+    valueWithDiscount: number;
+  };
+  installments: Array<ProductInstallment>; // TODO ver depois
+  error: null | string;
+}
+
+export interface PaymentType {
+  id: number;
+  code: PaymentCode;
+}
+
+export interface PaymentConfiguration {
+  code: ConfigurationCode;
+  title: string;
+  value: number;
+}
+
+export interface PaymentOption {
+  id: number;
+  paymentId: number;
+  paymentStoreCredentialId: number;
+  paymentAntiFraudCredentialId: null;
+  paymentType: PaymentType;
+  active: boolean;
+  label: string;
+  description: string;
+  instruction: string;
+  order: number;
+  options: Array<PaymentOption>;
+  configurations: Array<PaymentConfiguration>;
+}
+
+export interface CardFlags {
+  master: string;
+  visa: string;
+  hiper: string;
+  amex: string;
+  hipercard: string;
+  americanexpress: string;
+  jcb: string;
+  aura: string;
+  banescard: string;
+  cabal: string;
+  diners: string;
+  discover: string;
+  sorocred: string;
+  unionpay: string;
+  credz: string;
+  elo: string;
+}
+
+export interface PaymentConditionsRequest {
+  cashDiscountPaymentOptionId: number;
+  installmentPaymentOptionId: number | null;
+  items: Array<{
+    reference: string;
+    value: number;
+  }>;
+}
+
+export interface PaymentConditionsResponse {
+  [key: string]: {
+    reference: string;
+    value: number;
+    cashDiscount: {
+      discountPercentage: number;
+      discountValue: number;
+      valueWithDiscount: number;
+    };
+    installments: Array<ProductInstallment> | null;
+  };
+}

package/modules/Api/types/endpoints/payment/payment.types.ts

@@ -0,0 +1,27 @@
+export type ConfigurationCode =
+  | 'order-cancellation-time'
+  | 'show-payment-min-value'
+  | 'show-payment-max-value'
+  | 'max-number-installment'
+  | 'min-value-installment'
+  | 'installment-map'
+  | 'cash-discount'
+  | 'automatic-capture'
+  | 'payment-min-value'
+  | 'max-number-card'
+  | 'expiration-time'
+  | 'bank-account-map';
+
+export type PaymentCode =
+  | 'credit-card'
+  | 'pix'
+  | 'billet'
+  | 'external'
+  | 'external-deposit'
+  | 'billet-pix'
+  | 'internal-deposit'
+  | 'incorporated'
+  | 'custom'
+  | 'debit-card'
+  | 'multiple-payment'
+  | 'zero-value';

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

@@ -0,0 +1,22 @@
+export interface PriceRule {
+  id: number;
+  name: string;
+  trigger: 'automatic' | 'code' | 'quantity-rule';
+  ruleTarget: 'product' | 'brand' | 'category';
+  applyInGroup: boolean;
+  updateComparisonPrice: 'original-sale-price' | 'not-update' | 'apply-rule';
+  basePriceField: 'sale-price' | 'base-price';
+  code: null;
+  beginQuantity: null;
+  endQuantity: null;
+  value: number;
+  valueType: 'percentage' | 'value' | 'balance';
+  priority: number;
+  active: boolean;
+  scheduling: {
+    id: number;
+    startDate: string;
+    endDate: string;
+  };
+  tradePolicies: Array<number>;
+}

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

@@ -0,0 +1,63 @@
+export type ProductFields =
+  | 'brand'
+  | 'flags'
+  | 'mainUrl'
+  | 'secondaryUrls'
+  | 'description'
+  | 'indicatedProducts'
+  | 'relatedProducts'
+  | 'tax'
+  | 'filters'
+  | 'stockByStorage'
+  | 'stock'
+  | 'seals'
+  | 'mainCategory'
+  | 'categories'
+  | 'categoryBreadcrumb'
+  | 'dimension'
+  | 'variation'
+  | 'media'
+  | 'price'
+  | 'bannerGroups'
+  | 'review'
+  | 'status';
+
+export type ProductConditionFields =
+  | 'id'
+  | 'brandId'
+  | 'active'
+  | 'type'
+  | 'sku'
+  | 'url'
+  | 'showInSite'
+  | 'saleWithoutStock'
+  | 'category'
+  | 'mainCategory'
+  | 'salePrice'
+  | 'comparisonPrice'
+  | 'priceDifference'
+  | 'filter'
+  | 'stock'
+  | 'stockInStorage'
+  | 'name'
+  | 'shortDescription'
+  | 'description'
+  | 'searchDescription'
+  | 'seal'
+  | 'tradePolicyId'
+  | 'productAttributeValueId'
+  | 'exclusive'
+  | 'ean'
+  | 'averageRating'
+  | 'quantityRating';
+
+export type ProductSortFields =
+  | 'id'
+  | 'priority'
+  | 'sku'
+  | 'relevance'
+  | 'stock'
+  | 'stockByStorage'
+  | 'name'
+  | 'price'
+  | 'hasStock';

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

@@ -0,0 +1,109 @@
+import type {
+  Descriptions,
+  Seals,
+  Filter,
+  Media,
+  ProductStatus,
+  ProductType,
+  Variations,
+  BrandItem,
+  CurrentAttribute,
+} from '../..';
+
+export interface Product {
+  id: number;
+  type: ProductType;
+  sku: string;
+  name: string;
+  priority: number;
+  basePrice: number;
+  active: boolean;
+  bannerGroups: Array<never>;
+  updatedAt: string;
+  url: string;
+  urls: [];
+  currentAttributes: Array<CurrentAttribute>
+  brand: null | BrandItem;
+  mainCategory: null | ProductCategory;
+  categories: null | Array<ProductCategory>;
+  categoryBreadcrumb: null | Array<ProductCategory>;
+  description: null | Descriptions;
+  dimensions: null | ProductDimension;
+  filters: null | Array<Filter>;
+  flags: null | ProductFlags;
+  indicatedProducts: null;
+  linkedTradePolicies: null;
+  medias: null | Array<Media>;
+  originalPrice: null;
+  parentProductId: null | number;
+  price: null | ProductPrice;
+  priceRules: null;
+  relatedProducts: null;
+  seals: null | Seals;
+  stock: null | Stock;
+  stocks: null;
+  status: null | ProductStatus;
+  tax: null;
+  variations: null | Variations;
+  review: null | {
+    productId: number,
+    averageRating: number,
+    quantityRating: number
+  };
+
+  combination: Array<never>;
+  createdAt: string;
+  isGiftCard: boolean;
+}
+
+export interface ProductCategory {
+  id: number;
+  name: string;
+  url: string;
+}
+
+export interface ProductPrice {
+  comparisonPrice: number;
+  salePrice: number;
+  markup: number;
+  ruleId: number;
+  ruleTrigger: string;
+  ruleName: string;
+  priceWithDiscount: number;
+  availableForSale: boolean;
+  installments: Array<ProductInstallment>;
+}
+
+export interface ProductInstallment {
+  fee: number;
+  feeTotalValue: number;
+  installment: number;
+  installmentValue: number;
+  totalValue: number;
+}
+
+export interface ProductDimension {
+  shippingCargoTypeId: null | number;
+  additionalTime: null | number;
+  width: number;
+  height: number;
+  length: number;
+  weight: number;
+}
+
+export interface ProductFlags {
+  subscription: boolean;
+  service: boolean;
+  pickUp: boolean;
+  showInSite: boolean;
+  saleWithoutStock: boolean;
+  minimumStock: number;
+}
+
+export interface Stock {
+  productId: number;
+  productStorageId: number;
+  availableStock: number;
+  reservedStock: number;
+  updatedAt?: string;
+}

package/modules/Api/types/endpoints/product/product.types.ts

@@ -0,0 +1,3 @@
+export type ProductStatus = 'available' | 'onrequest' | 'unavailable';
+
+export type ProductType = 'product' | 'variation' | 'kit'; // TODO veirificar tipos 'pdp', 'ldp' , 'lpl', 'vitrine', 'cart'.

package/modules/Api/types/endpoints/product-comment/product-comment-obsearch.types.ts

@@ -0,0 +1,24 @@
+export type ProductCommentFields = '';
+
+export type ProductCommentConditionFields =
+  | 'parentCommentId'
+  | 'productId'
+  | 'userId'
+  | 'userName'
+  | 'userEmail'
+  | 'customerId'
+  | 'customerName'
+  | 'customerEmail'
+  | 'replyByUser'
+  | 'active'
+  | 'createdAt';
+
+export type ProductCommentSortFields =
+  | 'productId'
+  | 'userId'
+  | 'userName'
+  | 'userEmail'
+  | 'customerId'
+  | 'customerName'
+  | 'customerEmail'
+  | 'createdAt';

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

@@ -0,0 +1,32 @@
+import type { Pagination, SimpleProduct } from '../..';
+
+export interface ProductComment {
+  id: number;
+  productId: number;
+  parentCommentId: number;
+  customerId: number;
+  customerName: string;
+  customerEmail: string;
+  userId: number;
+  userName: string;
+  userEmail: string;
+  message: string;
+  replyByUser: boolean;
+  active: boolean;
+  totalReplies: number;
+  product: SimpleProduct | null;
+  createdAt: string;
+  updateAt: string;
+}
+
+export interface CreateProductComment {
+  customerName: string;
+  customerEmail: string;
+  parentCommentId: number | null;
+  message: string;
+}
+
+export interface ProductCommentsResponse {
+  registers: Array<ProductComment>;
+  pagination: Pagination;
+}

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

@@ -0,0 +1,7 @@
+export interface Redirect {
+  salesChannelId?: number;
+  url: string;
+  redirect: boolean;
+  redirectCode: number;
+  target: string;
+}

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

@@ -0,0 +1,18 @@
+export type ReviewFields = 'products' | 'medias';
+
+export type ReviewConditionFields =
+  | 'recommended'
+  | 'createdAt'
+  | 'active'
+  | 'score'
+  | 'productId'
+  | 'salesChannelId'
+  | 'customerId';
+
+export type ReviewSortFields =
+  | 'id'
+  | 'createdAt'
+  | 'score'
+  | 'productId'
+  | 'salesChannelId'
+  | 'customerId';

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

@@ -0,0 +1,34 @@
+import type { Pagination, SimpleProduct } from '../..';
+
+export interface ProductReview {
+  id: number;
+  name: string;
+  email: string;
+  comment: string;
+  recommended: boolean;
+  score: number;
+  active: boolean;
+  masked: boolean;
+  createdAt: string;
+  updatedAt: string;
+  productId: number;
+  customerId: number;
+  medias: null | Array<{
+    reviewId: number;
+    mediaId: number;
+    image: string;
+    createdAt: string;
+  }>;
+  product: null | SimpleProduct;
+}
+
+export interface ProductReviewResponse {
+  registers: Array<ProductReview>;
+  pagination: Pagination;
+}
+
+export interface ProductReviewRequest {
+  comment: string;
+  recommended: boolean;
+  score: number;
+}

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

@@ -0,0 +1,21 @@
+export interface Seal {
+  id: number;
+  name: string;
+  description: string;
+  active: boolean;
+  textColor: string;
+  sealColor: string;
+  image: string | null;
+  originalImage: string | null;
+  setting: SealSetting;
+  createdAt: string;
+}
+
+export interface SealSetting {
+  horizontalPosition: 'left' | 'center' | 'right';
+  id: number;
+  proportionInProductDetail: number;
+  proportionInProductShowcase: number;
+  scheduling: null;
+  verticalPosition: 'top' | 'mid' | 'bottom';
+}

package/modules/Api/types/endpoints/seal/seal.types.ts

@@ -0,0 +1,3 @@
+import type { Seal } from '../..';
+
+export type Seals = Array<Seal>;

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

@@ -0,0 +1,11 @@
+import type { UrlMenu, Pagination, Product } from '../..';
+
+export interface Search {
+  type: 'search';
+  entity: null;
+  menu: UrlMenu;
+  content: {
+    pagination: Pagination;
+    registers: Array<Product>;
+  };
+}

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

@@ -0,0 +1,11 @@
+export interface Seo {
+  title: string;
+  description: string;
+  titleSocial: string;
+  descriptionSocial: string;
+  openGraphUrlImagem: string;
+  twitterUrlImagem: string;
+  keywords: string;
+  canonical: string;
+  indexar: boolean;
+}