@uappi/public-sdk 1.0.0

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

@@ -0,0 +1,13 @@
+import type { DiscountType } from '../..';
+
+export interface AddCouponRequest {
+  hash: string;
+}
+
+export interface Coupon {
+  discountId: number;
+  discountMainCode: string;
+  discountTitle: string;
+  discountType: DiscountType;
+  discountValue: number;
+}

package/modules/Api/types/endpoints/customer/customer-erros.ts

@@ -0,0 +1,13 @@
+export type CustomerErrorCode =
+  | 'UAPPI_STORE_CUSTOMER_EMAIL_ALREADY_IN_USE'
+  | 'UAPPI_STORE_CUSTOMER_NOT_FOUND'
+  | 'UAPPI_STORE_ALREADY_USED_CUSTOMER_DOCUMENT'
+  | 'UAPPI_STORE_INVALID_ADDRESS'
+  | 'UAPPI_STORE_INVALID_LOGIN'
+  | 'UAPPI_STORE_MFA_IS_REQUIRED'
+  | 'UAPPI_STORE_DIFFERENT_PASSWORD'
+  | 'UAPPI_STORE_INVALID_PASSWORD_LENGTH'
+  | 'UAPPI_STORE_INVALID_CURRENT_PASSWORD'
+  | 'UAPPI_STORE_PASSWORD_NOT_UPDATED'
+  | 'UAPPI_STORE_INVALID_CUSTOMER_FLAG'
+  | 'UAPPI_STORE_HISTORY_NOT_FOUND';

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

@@ -0,0 +1,103 @@
+export type CustomerFields =
+  | 'addresses'
+  | 'documents'
+  | 'flags'
+  | 'giftCardBalance'
+  | 'totalOrderQuantity'
+  | 'cancelledOrderQuantity'
+  | 'totalOrderValue'
+  | 'pointSystemAmount';
+
+export type CustomerConditionFields =
+  | 'id'
+  | 'email'
+  | 'nameCorporateName'
+  | 'active'
+  | 'isCorporate'
+  | 'salesChannelId'
+  | 'deleted'
+  | 'createdAt'
+  | 'gender'
+  | 'nationaly'
+  | 'document'
+  | 'sendPromotionalEmail'
+  | 'sendPromotionalSms'
+  | 'sendOrderEmail'
+  | 'sendOrderSms';
+
+export type CustomerSortFields =
+  | 'id'
+  | 'email'
+  | 'nameCorporateName'
+  | 'createdAt';
+
+export type CustomerOrderGroupFields =
+  | 'customer'
+  | 'addresses'
+  | 'values'
+  | 'orders'
+  | 'productStorage'
+  | 'status'
+  | 'reserves'
+  | 'payments'
+  | 'paymentLogs'
+  | 'items'
+  | 'shipping'
+  | 'invoice'
+  | 'observations'
+  | 'discounts'
+  | 'additions';
+
+export type CustomerOrderGroupSortFields = 'id' | 'createdAt' | 'issuedAt';
+
+export type CustomerOrderGroupConditionFields =
+  | 'id'
+  | 'userId'
+  | 'createdAt'
+  | 'issuedAt'
+  | 'code'
+  | 'cartId'
+  | 'salesChannelId'
+  | 'salesChannelDomain'
+  | 'tradePolicyId'
+  | 'customerId'
+  | 'customerNameCorporateName'
+  | 'customerTradeName'
+  | 'customerEmail'
+  | 'customerDocument'
+  | 'customerDocument2'
+  | 'orderPaymentId'
+  | 'paymentOptionId'
+  | 'paymentStatus'
+  | 'transactionId'
+  | 'shippingTableId'
+  | 'addressId'
+  | 'zipCode'
+  | 'state'
+  | 'city'
+  | 'country'
+  | 'orderItemProductId'
+  | 'orderItemProductName'
+  | 'orderItemProductSku'
+  | 'productStorageId'
+  | 'orderStatusId'
+  | 'orderItemProductAmount'
+  | 'orderItemAmount'
+  | 'subtotalValue'
+  | 'shippingValue'
+  | 'totalValue';
+
+export type CustomerOrderItemHistorySortFields = 'id' | 'createdAt';
+
+export type CustomerOrderItemHistoryConditionFields =
+  | 'origin'
+  | 'action'
+  | 'createdAt';
+
+export type CustomerHistorySortFields = 'id' | 'createdAt';
+
+export type CustomerHistoryConditionFields =
+  | 'orderId'
+  | 'origin'
+  | 'action'
+  | 'createdAt';

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

@@ -0,0 +1,448 @@
+import type {
+  CustomerGender,
+  CustomerOrigin,
+  CountryAlpha3,
+  StateCode,
+  Pagination,
+  PaymentCode,
+  AddressToCartType,
+  SimpleProduct,
+  Discount,
+} from '../..';
+import type { PickupPoint } from '../shipment/shipment.interfaces';
+
+export interface CustomerResponse {
+  id: number;
+  salesChannelId: number;
+  tradePolicyId: number;
+  email: string;
+  dealerGroupId: number;
+  nameCorporateName: string;
+  tradeName: string;
+  isCorporate: false;
+  gender: CustomerGender;
+  nationality: CountryAlpha3;
+  birthdate: string;
+  phone: string;
+  walletAmount: number;
+  pointSystemAmount: number;
+  orderQuantity: number;
+  cancelledOrderQuantity: number;
+  orderValue: number;
+  origin: CustomerOrigin;
+  createdAt: string;
+  active: true;
+  deleted: false;
+  masked: false;
+  addresses: null | Array<CustomerAddressResponse>;
+  documents: null | Array<CustomerDocument>;
+  flags: null | {
+    sendOrderEmail: boolean;
+    sendOrderSms: boolean;
+    sendPromotionalEmail: boolean;
+    sendPromotionalSms: boolean;
+  };
+  giftCardBalance: null | number;
+}
+
+export interface SigninCustomerByEmail {
+  email: string;
+  password: string;
+}
+
+export interface SigninCustomerByDocument {
+  document: string;
+  password: string;
+}
+
+export interface ResponseSigninCustomer {
+  token: string;
+}
+
+export interface CheckCustomer {
+  identification: string;
+}
+
+export type CheckCustomerResponse = 'not-exists' | 'exists' | 'inactive';
+
+export interface SignupCustomer {
+  email: string;
+  nameCorporateName: string;
+  isCorporate: boolean;
+  gender: CustomerGender;
+  birthdate: string;
+  phone: string;
+  nationality: CountryAlpha3;
+  origin: CustomerOrigin;
+  password: string;
+  documents?: Array<CustomerDocument>;
+}
+
+export interface CustomerDocument {
+  type: 'cpf' | 'rg' | 'cnpj' | 'ie' | 'document1' | 'document2' | 'document3';
+  document: string;
+}
+
+export interface PasswordRecoveryCustomer {
+  email: string;
+}
+
+export interface ChangePasswordCustomerByCode {
+  code: string;
+  password: string;
+  confirmPassword: string;
+}
+export interface ChangePasswordCustomerAuthenticated {
+  password: string;
+  confirmPassword: string;
+  currentPassword: string;
+}
+
+export interface UpdateCustomer {
+  email?: string;
+  nameCorporateName?: string;
+  tradeName?: string;
+  isCorporate?: boolean;
+  gender?: CustomerGender;
+  phone?: string;
+}
+
+export interface UpdateCustomerDocument {
+  documents: Array<CustomerDocument>;
+}
+
+export type UpdateCustomerDocumentResponse = Array<CustomerDocument>;
+
+export interface UpsertCustomerAddressRequest {
+  zipCode: string;
+  identification: string;
+  countryCode: CountryAlpha3;
+  stateCode: StateCode;
+  state: string;
+  city: string;
+  street: string;
+  number: string;
+  district: string;
+  complement: string;
+  recipient: string;
+}
+
+export interface CustomerAddressResponse {
+  city: string;
+  complement: string;
+  countryCode: CountryAlpha3;
+  district: string;
+  id: number;
+  identification: string;
+  main: boolean;
+  number: string;
+  recipient: string;
+  state: string;
+  stateCode: StateCode;
+  street: string;
+  zipCode: string;
+  updatedAt: string;
+  createdAt: string;
+}
+
+export interface CustomerAddressesResponse {
+  registers: Array<CustomerAddressResponse>;
+  pagination: Pagination;
+}
+
+export interface CustomerOrderResponse {
+  id: number;
+  cartId: string;
+  tradePolicyId: number;
+  userId: null;
+  userEmail: null;
+  userName: null;
+  code: string;
+  salesChannelDomain: string;
+  currency: string;
+  createdAt: string;
+  issuedAt: string;
+  masked: boolean;
+  payments: Array<CustomerOrderPayment>;
+  customer: {
+    orderGroupId: number;
+    customerId: number;
+    customerNameCorporateName: string;
+    customerTradeName: string;
+    customerEmail: string;
+    customerDocument: string;
+    customerDocument2: string;
+    customerPhone: string;
+    customerIsCorporate: false;
+    customerGender: CustomerGender;
+    customerBirthdate: string;
+  };
+  addresses: Array<{
+    orderGroupId: number;
+    customerAddressType: AddressToCartType;
+    customerAddressId: number;
+    addressZipCode: string;
+    addressRecipient: string;
+    addressStreet: string;
+    addressNumber: string;
+    addressDistrict: string;
+    addressCity: string;
+    addressState: string;
+    addressStateCode: StateCode;
+    addressCountryCode: CountryAlpha3;
+    addressComplement: string;
+  }>;
+  values: {
+    orderId: number;
+    subtotalValue: number;
+    additionValue: number;
+    shippingValue: number;
+    discountValue: number;
+    totalValue: number;
+  } | null;
+  observations: null;
+  orders: Array<{
+    id: number;
+    orderGroupId: number;
+    productStorageId: number;
+    orderStatusId: number;
+    masked: boolean;
+    orderGroup: null;
+    productStorage: {
+      id: number;
+      code: string;
+      corporateName: string;
+      email: string;
+      phone: string;
+      tradeName: string;
+      stateCode: StateCode;
+      countryCode: CountryAlpha3;
+      document: string;
+      zipCode: string;
+      city: string;
+      address: string;
+      district: string;
+      number: string;
+      complement: string;
+      latitude: string;
+      longitude: string;
+      active: boolean;
+      observation: string;
+      tradePolicyExceptions: Array<null>;
+    };
+    status: {
+      id: number;
+      orderStatusParentId: null | number;
+      code:
+        | 'pending'
+        | 'paid'
+        | 'invoiced'
+        | 'sent'
+        | 'delivered'
+        | 'canceled'
+        | 'returned';
+      name: string;
+      icon: 'access_time';
+      children: Array<null>;
+    };
+    customer: null;
+    addresses: null;
+    values: {
+      orderId: number;
+      subtotalValue: number;
+      additionValue: number;
+      shippingValue: number;
+      discountValue: number;
+      totalValue: number;
+    };
+    shipping: {
+      orderId: number;
+      shippingTableId: number;
+      label: string;
+      shippingCarrierId: number;
+      shippingCarrier: string;
+      beginShippingTime: number;
+      endShippingTime: number;
+      initialDeliveryForecast: null;
+      finalDeliveryForecast: null;
+      shippingValue: number;
+      trackingCode: null | string;
+      reverseLogisticsCode: null;
+      trackingUrl: null | string;
+      schedule: boolean;
+      scheduleDay: null;
+      scheduleHour: null;
+      pickUpDetails: null | PickupPoint;
+    } | null;
+    discounts: null;
+    additions: null;
+    items: Array<CustomerOrderItem>;
+    payments: Array<CustomerOrderPayment>;
+    reserves: null;
+    invoice: null | {
+      key: string;
+      number: string;
+      orderId: number;
+      serie: null;
+      url: string;
+      xml: null;
+    };
+  }>;
+  discounts: null | Array<Discount>;
+  additions: null;
+}
+
+export interface CustomerOrdersResponse {
+  registers: Array<CustomerOrderResponse>;
+  pagination: Pagination;
+}
+
+export interface CustomerOrderItemHistoryResponse {
+  id: 466;
+  userId: null;
+  userName: null;
+  userEmail: null;
+  origin: 'alteration' | 'order';
+  action: 'create-addition';
+  createdAt: string;
+  before: [];
+  after: {
+    orderId?: number;
+    entity?: 'payment-fee';
+    entityId?: number;
+    description?: string;
+    value?: number;
+    type?: 'addition';
+    retroactiveDate?: string | null;
+    id?: number;
+    orderGroupId: number;
+    productStorageId?: number;
+    orderStatusId?: number;
+  };
+}
+export interface CustomerOrderItemHistoriesResponse {
+  registers: Array<CustomerOrderItemHistoryResponse>;
+  pagination: Pagination;
+}
+
+export interface CustomerOrderItem {
+  id: number;
+  orderId: number;
+  productId: number;
+  name: string;
+  description: string;
+  sku: string;
+  priceRule: null;
+  quantity: number;
+  unitValue: number;
+  unitAdditionValue: number;
+  unitDiscountValue: number;
+  subtotalValue: number;
+  subtotalAdditionValue: number;
+  subtotalDiscountValue: number;
+  totalValue: number;
+  generateGiftCard: boolean;
+  discounts: null;
+  additions: null;
+  simpleProduct: SimpleProduct;
+}
+
+export interface CustomerOrderPayment {
+  id: 154;
+  orderGroupId: number;
+  orderId: null;
+  customerCardId: null;
+  paymentType: Exclude<PaymentCode, 'multiple-payment'>;
+  paymentProof: string;
+  paymentExpirationDate: string;
+  paymentOptionId: number;
+  parentPaymentOptionId: null;
+  paymentOptionLabel: string;
+  paymentOptionDetail: string;
+  integrationName: string;
+  transactionId: string;
+  currentStatus: 'waiting-payment' | 'paid';
+  paymentAntiFraudId: null;
+  paymentAntiFraudCredentialId: null;
+  antiFraudStatus: null;
+  pixQrCode: null | string;
+  pixEmv: null | string;
+  billetBarCode: null | string;
+  billetDigitableLine: null | string;
+  billetUrl: null | string;
+  cardAutomaticCapture: boolean;
+  cardMasked: string | null;
+  cardFlag:
+    | 'visa'
+    | 'master'
+    | 'elo'
+    | 'americanexpress'
+    | 'diners'
+    | 'hipercard'
+    | 'discover'
+    | 'jcb'
+    | 'aura'
+    | null;
+  cardExpiration: string | null;
+  value: number;
+  installment: number | null;
+  installmentValue: number;
+  fee: number;
+  orderGroup: null;
+  logs: Array<null>;
+}
+
+export interface AddCustomerToNewsletterRequest {
+  email: string;
+  name: string;
+}
+
+export interface AddCustomerToNewsletterResponse {
+  createdAt: string;
+  email: string;
+  id: number;
+  masked: boolean;
+  name: string;
+  salesChannelId: number;
+}
+export interface CustomerHistory {
+  id: number;
+  userId: null;
+  userName: null;
+  userEmail: null;
+  origin: 'customer' | 'address' | 'document' | 'password' | 'point-system';
+  action:
+    | 'create-customer'
+    | 'update-customer'
+    | 'remove-customer'
+    | 'create-address'
+    | 'update-address'
+    | 'remove-address'
+    | 'update-main-address'
+    | 'update-document'
+    | 'remove-document'
+    | 'update-flag'
+    | 'manual-point-addition'
+    | 'order-point-addition'
+    | 'manual-point-remove'
+    | 'point-expiration'
+    | 'order-point-cancelled'
+    | 'order-point-use'
+    | 'order-point-available'
+    | 'order-point-unavailable'
+    | 'order-point-refunded'
+    | 'order-point-cunsumed-again';
+  createdAt: string;
+  before: [] | { id: number };
+  after:
+    | CustomerResponse
+    | { id: number }
+    | CustomerAddressResponse
+    | { amount: number };
+  orderId: null | number;
+}
+
+export interface CustomerHistoryResponse {
+  registers: Array<CustomerHistory>;
+  pagination: Pagination;
+}

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

@@ -0,0 +1,3 @@
+export type CustomerGender = 'male' | 'female' | 'undefined';
+
+export type CustomerOrigin = 'frontend' | 'api' | 'admin';

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

@@ -0,0 +1,30 @@
+export interface Descriptions {
+  id: number;
+  salesChannelId: number;
+  name: string;
+  shortDescription: null | string;
+  videoUrl: null | string;
+  searchDescription: null | string;
+  description: null | string;
+  customDescription1: null | string;
+  customDescription2: null | string;
+  customDescription3: null | string;
+  measureTable: null | string;
+  seoTitle: null | string;
+  seoDescription: null | string;
+  seoKeywords: null | string;
+  seoCanonical: null | string;
+  seoSocialTitle: null | string;
+  seoSocialDescription: null | string;
+  seoTwitterImageUrl: null | string;
+  seoGraphImageUrl: null | string;
+  seoGoogleCategoryId: null | number;
+  seoIndexOnGoogle: boolean;
+  seoGoogleCondition: null | string;
+  seoGoogleAgeGroup: null | string;
+  seoGoogleGender: null | string;
+  productId: null | number;
+  productCategoryId: null | number;
+  productBrandId: null | number;
+  productPageId: null | number;
+}

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

@@ -0,0 +1,9 @@
+import type { DiscountType } from '../..';
+
+export interface Discount {
+  entityId: string;
+  id: number;
+  orderId: number;
+  type: DiscountType;
+  value: number;
+}

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

@@ -0,0 +1,5 @@
+export type DiscountType =
+  | 'promotion'
+  | 'points'
+  | 'coupon'
+  | 'customer-wallet';

package/modules/Api/types/endpoints/filters/filter.type.ts

@@ -0,0 +1 @@
+export type TypeFilter = 'text' | 'enum' | 'bool' | 'array';

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

@@ -0,0 +1,26 @@
+import type { TypeFilter } from '../..';
+
+export interface Filter {
+  id: number;
+  name: string;
+  active: boolean;
+  showInListing: boolean;
+  showInSpecificationTable: boolean;
+  type: TypeFilter;
+  values?: Array<FilterValue>;
+}
+
+export interface FilterValue {
+  id: number;
+  name: string;
+  image: string;
+  originalImage: string;
+  color: string;
+  order: number;
+  value: null | string;
+}
+
+export interface PriceFilter {
+  min: number | null;
+  max: number | null;
+}

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

@@ -0,0 +1,22 @@
+export type InterestType = 'notify-me' | 'on-request';
+
+export interface RequestInterest {
+  productId: number;
+  origin: InterestType;
+  name: string;
+  email: string;
+  phone: string;
+  message: string;
+}
+
+export interface ResponseInterest {
+  id: number;
+  productId: number;
+  origin: InterestType;
+  name: string;
+  email: string;
+  phone: string;
+  message: string;
+  replied: boolean;
+  createdAt: string;
+}

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

@@ -0,0 +1,13 @@
+export interface Media {
+  id: number;
+  title: string;
+  alternativeText: string;
+  type: 'image';
+  file: string;
+  originalFile: string;
+  originalSize: number;
+  size: number;
+  url: null;
+  width: number;
+  height: number;
+}

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

@@ -0,0 +1,8 @@
+export type Target = '_self' | '_blank';
+
+export type Type =
+  | 'personalizado'
+  | 'categoria'
+  | 'categoriaSecundaria'
+  | 'marca'
+  | 'pagina';