@artisan-commerce/types 0.14.0-canary.47 → 0.14.0-canary.49

package/dist/bundle.d.ts

@@ -6,7 +6,7 @@
  */
 interface Country<T extends AdditionalInfo = AdditionalInfo> {
     /** Country's identifier */
-    id: number;
+    id: string;
     /** Country's name */
     name: string;
     /** Country ISO code, see {@link CountryCode} */
@@ -27,7 +27,7 @@ interface Country<T extends AdditionalInfo = AdditionalInfo> {
  */
 interface CountryCurrency {
     /** Currency's identifier */
-    id: number;
+    id: string;
     /**  Currency's name */
     name: string;
     /** Currency's symbol */
@@ -153,7 +153,7 @@ type DocumentType = ARDocumentType | BODocumentType | BRDocumentType | CLDocumen
  */
 interface CountrySummary {
     /** Country's id */
-    id: number;
+    id: string;
     /** Country's name */
     name: string;
 }
@@ -268,7 +268,7 @@ interface RandomImageConfig {
  */
 interface Account<T extends AdditionalInfo = AdditionalInfo> {
     /** Artisn's account unique identifier */
-    accountId: number;
+    accountId: string;
     /** Account's name */
     name: string;
     /** Account's description */
@@ -287,7 +287,7 @@ interface Account<T extends AdditionalInfo = AdditionalInfo> {
  */
 interface Category<T extends AdditionalInfo = AdditionalInfo> {
     /** Category's id */
-    categoryId: number;
+    categoryId: string;
     /** Category's name */
     name: string;
     /** Category image's array, see {@link CDNImage} */
@@ -370,7 +370,7 @@ interface Catalogue<T extends AdditionalInfo = AdditionalInfo> {
  */
 interface Store<T extends AdditionalInfo = AdditionalInfo, U extends AdditionalInfo = AdditionalInfo, V extends AdditionalInfo = AdditionalInfo> {
     /** Store unique identifier */
-    storeId: number;
+    storeId: string;
     /** Store name */
     storeName: string;
     /** Store address */
@@ -560,7 +560,7 @@ interface StorePolygons {
  */
 interface ShippingCost<T extends AdditionalInfo = AdditionalInfo> {
     /** Shipping cost product's id */
-    productId: number;
+    productId: string;
     /** Shipping cost's name */
     name: string;
     /** Shipping cost's amount */
@@ -640,7 +640,7 @@ interface ShoppingCart<T extends AdditionalInfo = AdditionalInfo, U extends Addi
     /** Shopping cart update date */
     updatedAt: string;
     /** Shopping cart channel unique identifier */
-    channelId: number;
+    channelId: string;
     /** Shopping cart stores, see Objectify<{@link CartStore}> */
     stores: Objectify<CartStore<W, U, V, X, Y>>;
     /** Shopping cart shipping cost */
@@ -728,9 +728,9 @@ interface BillTotalCategory {
  * @since 0.1.0
  */
 interface Discount {
-    benefitId: number;
+    benefitId: string;
     /** Benefit wallet id */
-    benefitWalletId: number;
+    benefitWalletId: string;
     /** Discount base value */
     discountBase: number;
     /** Whether or not the coupon has taxes */
@@ -989,7 +989,7 @@ interface ProductDetails<T extends AdditionalInfo = AdditionalInfo, U extends Ad
     /** Array of product questions, see {@link ProductQuestion} */
     questions: ProductQuestion<T>[];
     /** The benefit id of the product */
-    benefitId: number | null;
+    benefitId: string | null;
     /** An array of categories which the product belongs to, see {@link Category} */
     categories: Category<U>[] | null;
 }
@@ -1082,6 +1082,8 @@ interface CartProduct<T extends AdditionalInfo = AdditionalInfo, U extends Addit
     updatedAt: string;
     /** Array of alerts associated with the cart product */
     alerts: Alert[];
+    /** Indicates where the product was added from */
+    addedFrom?: string;
 }
 
 /**
@@ -1102,7 +1104,7 @@ interface Wallet {
  */
 interface Benefit {
     /** The account id of the benefit */
-    accountId: number;
+    accountId: string;
     /**
      * An array of benefit awards if the benefit is of `PRODUCT` type, and an
      * object if the benefit is of `ALTER_DELIVERY` or `DISCOUNT` type,
@@ -1110,11 +1112,11 @@ interface Benefit {
      * */
     award: Award | Award[];
     /** Benefit id */
-    benefitId: number;
+    benefitId: string;
     /** Benefit wallet id */
-    benefitWalletId: number;
+    benefitWalletId: string;
     /** The channel id of the benefit */
-    channelId: number;
+    channelId: string;
     /** Benefit code in back-end */
     code: null;
     /** Combined */
@@ -1162,9 +1164,9 @@ interface Benefit {
  */
 interface Award {
     /** The id of the award */
-    id: number;
+    id: string;
     /** The id of the benefit */
-    benefitId: number;
+    benefitId: string;
     /** Benefit discount percentage */
     discountPercentage: number;
     /** Benefit discount value */
@@ -1174,7 +1176,7 @@ interface Award {
     /** Product description associated with the benefit award */
     productDescription: string;
     /** Product unique identifier associated with the benefit award */
-    productId: number;
+    productId: string;
     /** The vendor id of the award */
     vendorId: Vendor["id"];
 }
@@ -1200,7 +1202,7 @@ type BenefitTypes = "ALTER_DELIVERY" | "PRODUCT" | "DISCOUNT_FIXED" | "DISCOUNT_
  */
 interface BenefitData {
     /** Benefit account unique identifier */
-    account_id: number;
+    account_id: string;
     /** Benefit data amount */
     amount: number | null;
     /** Indicates if the benefit is redeemed automatically */
@@ -1224,7 +1226,7 @@ interface BenefitData {
     /** Benefit external id */
     external_id: string | null;
     /** Benefit data unique identifier */
-    id: number;
+    id: string;
     /** Benefit image */
     image: null;
     /** Benefit instruction */
@@ -1274,17 +1276,17 @@ interface ProductCoupon {
     /** Product coupon amount */
     amount: number;
     /** Product coupon benefit unique identifier */
-    benefitId: number;
+    benefitId: string;
     /** Product coupon discount percentage */
     discountPercentage: number;
     /** Product coupon discount */
     discountValue: number | null;
     /** Product coupon id */
-    id: number;
+    id: string;
     /** Product description */
     productDescription: string | null;
     /** Product unique identifier */
-    productId: number | null;
+    productId: string | null;
     /** Coupon swap product unique identifier */
     swapProductId: null;
     /** Coupon vendor unique identifier */
@@ -1302,7 +1304,7 @@ interface StoreCoupon {
     /** Whether or not the store coupon is featured */
     featured: boolean;
     /** Store coupon unique identifier */
-    id: number;
+    id: string;
     /** Store coupon name */
     name: string;
     /** Store coupon vendor unique identifier */
@@ -1327,7 +1329,7 @@ interface Coupon {
     /** Coupon end date */
     end_date: string;
     /** Coupon unique identifier */
-    id: number;
+    id: string;
     /** Coupon image */
     image: URLImage | null;
     /** Coupon name */
@@ -1368,7 +1370,7 @@ interface CouponCategory {
     /** Whether or not the store coupon category is featured */
     featured: boolean;
     /** Coupon category unique identifier */
-    id: number;
+    id: string;
     /** Coupon category name */
     name: string;
 }
@@ -1382,9 +1384,9 @@ interface Code {
     /** The code associated with the coupon */
     code: string;
     /** Coupon code unique identifier */
-    coupon_id: number;
+    coupon_id: string;
     /** Code unique identifier */
-    id: number;
+    id: string;
     /** The token corresponding to a QR code */
     jwt: Token | null;
     /** The status of the code, see {@link ProductStatus} */
@@ -1426,7 +1428,7 @@ interface StoreCouponDetail extends Omit<Coupon, "category"> {
  */
 interface Banner<T extends AdditionalInfo = AdditionalInfo> {
     /** Banner category id */
-    banner_category_id: number;
+    banner_category_id: string;
     /** Banner description */
     banner_description: string;
     /** Banner qr code */
@@ -1440,15 +1442,15 @@ interface Banner<T extends AdditionalInfo = AdditionalInfo> {
     /** Banner's benefits */
     benefits: BannerBenefits[] | null;
     /** Banner category id */
-    category_id: number | null;
+    category_id: string | null;
     /** Banner category name */
     category_name: string | null;
     /** Banner channel's id */
-    channel_id: number | null;
+    channel_id: string | null;
     /** Banner coupon's code */
     coupon: BannerCoupon | null;
     /** Banner coupon's id */
-    coupon_id: number | null;
+    coupon_id: string | null;
     /** The bucket where the image is saved */
     image_bucket: string | null;
     /** he cloud where the banner is saved, see {@link CDNImage} */
@@ -1462,7 +1464,7 @@ interface Banner<T extends AdditionalInfo = AdditionalInfo> {
     /** An array of banner images, see {@link BannerImage}  */
     images: BannerImage[];
     /** Banner product's id */
-    product_id: number | null;
+    product_id: string | null;
     /** Banner product's name */
     product_name: string | null;
     /** Banner's section */
@@ -1472,7 +1474,7 @@ interface Banner<T extends AdditionalInfo = AdditionalInfo> {
     /** Banner stores array */
     stores: unknown[];
     /** Banner vendor's id */
-    vendor_id: number;
+    vendor_id: string;
     /** Banner vendor's name */
     vendor_name: string;
     /** Banner additional info */
@@ -1500,7 +1502,7 @@ type BannerScope = "WEB" | "GLOBAL" | "APP";
  */
 interface BannerImage {
     /** Banner's id */
-    id: number;
+    id: string;
     /** Banner image's filename */
     file_name: string;
     /** Banner image's filename */
@@ -1521,7 +1523,7 @@ interface BannerImage {
  * @since 0.1.0
  */
 interface BannerBenefits {
-    id: number;
+    id: string;
     name: string;
 }
 /**
@@ -1573,7 +1575,7 @@ interface BaseBillingData<T extends AdditionalInfo = AdditionalInfo> {
  */
 interface BillingData<T extends AdditionalInfo = AdditionalInfo> extends BaseBillingData<T> {
     /** Billing's auto generated id */
-    id: number;
+    id: string;
 }
 
 /**
@@ -1594,7 +1596,7 @@ interface Workflow<T extends AdditionalInfo = AdditionalInfo> {
     /** Workflow description */
     description: string;
     /** Workflow unique identifier */
-    id: number;
+    id: string;
     /** Workflow name */
     name: string;
     /** An array of workflow steps, see {@link StepWorkflow}  */
@@ -1650,7 +1652,7 @@ interface StepWorkflow {
     /** Step workflow description to use on front end */
     description_frontend: string | null;
     /** Step workflow id */
-    id: number;
+    id: string;
     /** Step workflow name */
     name: string;
     /** Step workflow subtitle to use on front end */
@@ -1700,21 +1702,21 @@ interface StepWorkflowGroup {
  */
 interface TransitionWorkflow {
     /** Channel unique identifier */
-    channel_id: number;
+    channel_id: string;
     /** Transition workflow conditions  */
     conditions: any[];
     /** Transition workflow description */
     description: string;
     /** The step id where the transition comes from */
-    from_step_id: number;
+    from_step_id: string;
     /** Transition workflow unique identifier */
-    id: number;
+    id: string;
     /** Transition workflow name */
     name: string;
     /** The step id where the transition can go */
-    to_step_id: number;
+    to_step_id: string;
     /** Vendor unique identifier */
-    vendor_id: number;
+    vendor_id: string;
 }
 /**
  * Workflow webhook.
@@ -1724,7 +1726,7 @@ interface TransitionWorkflow {
  */
 interface WebhookWorkflow {
     /** Webhook workflow unique identifier */
-    id: number;
+    id: string;
     /** Webhook workflow method type  */
     method: string;
     /** Webhook workflow url */
@@ -1750,11 +1752,11 @@ interface IssueAdditionalInfo {
  */
 interface IssueHistory {
     /** History unique identifier */
-    id: number;
+    id: string;
     /** Transition unique identifier  */
-    transition_id: number;
+    transition_id: string;
     /** Step unique identifier */
-    step_id: number;
+    step_id: string;
     /** Step name */
     step_name: string;
     /** History additional info, see {@link IssueAdditionalInfo} */
@@ -1774,23 +1776,23 @@ interface IssueHistory {
  */
 interface Issue {
     /** Issue unique identifier */
-    id: number;
+    id: string;
     /** Client issue unique identifier */
     client_issue_id: string;
     /** Workflow unique identifier */
-    workflow_id: number;
+    workflow_id: string;
     /** Parent issue unique identifier */
     parent_issue_id: null;
     /** Related issue unique identifier */
     related_issue_id: null;
     /** Step unique identifier */
-    step_id: number;
+    step_id: string;
     /** The step where the issue is located */
     step: StepWorkflow;
     /** Account unique identifier */
-    account_id: number;
+    account_id: string;
     /** Vendor unique identifier */
-    vendor_id: number;
+    vendor_id: string;
     /** Children issues */
     children: any[];
     /** Related issues */
@@ -1802,7 +1804,7 @@ interface Issue {
     /** Issue history, see {@link IssueHistory} */
     history: IssueHistory[];
     /** Transaction unique identifier  */
-    transaction_id: number | null;
+    transaction_id: string | null;
 }
 
 /**
@@ -1878,7 +1880,7 @@ interface ArtisnParams {
  */
 interface BaseLivingPlace {
     /** Living place's id */
-    id: number;
+    id: string;
 }
 /**
  * Representation of a living place.
@@ -1893,7 +1895,7 @@ interface LivingPlace extends BaseLivingPlace {
     /** Whether or not the living place is active */
     active: number;
     /** Country unique identifier */
-    countryId: number;
+    countryId: string;
     /** Array of fields required to save a living place, see {@link Field} */
     fields: Field[];
 }
@@ -2007,7 +2009,7 @@ interface BaseShippingAddress<T extends AdditionalInfo = AdditionalInfo> {
  */
 interface ShippingAddress<T extends AdditionalInfo = AdditionalInfo> extends BaseShippingAddress<T> {
     /** Shipping address unique identifier */
-    id: number;
+    id: string;
     /** Object which contains the living place, see {@link LivingPlace} */
     livingPlace: LivingPlace;
 }
@@ -2038,7 +2040,7 @@ interface NewShippingAddress<T extends AdditionalInfo = AdditionalInfo> extends
  */
 interface UpdatedShippingAddress<T extends AdditionalInfo = AdditionalInfo> extends BaseShippingAddress<T> {
     /** Shipping address unique identifier */
-    id: number;
+    id: string;
     /**
      * Object which contains the living place to update,
      * see {@link LivingPlaceToSave}
@@ -2122,7 +2124,7 @@ type UserType = "NORMAL" | "DEPENDENT";
  */
 interface UserCountry {
     /** User's country id */
-    id: number;
+    id: string;
 }
 /**
  * Representation of a phone.
@@ -2189,9 +2191,9 @@ interface Settings {
  */
 interface BaseOrder<T extends AdditionalInfo = AdditionalInfo, U extends AdditionalInfo = AdditionalInfo, V extends AdditionalInfo = AdditionalInfo> {
     /** Order unique identifier */
-    id: number;
+    id: string;
     /** Account unique identifier */
-    accountId: number;
+    accountId: string;
     /** Order additional info*/
     additionalInfo?: T;
     /** User's order billing data' unique identifier */
@@ -2201,7 +2203,7 @@ interface BaseOrder<T extends AdditionalInfo = AdditionalInfo, U extends Additio
     /** Order allocation, see {@link Allocation} */
     allocation: Allocation;
     /** Channel unique identifier */
-    channelId: number;
+    channelId: string;
     /** Order channel name */
     channelName: string;
     /** Order comment */
@@ -2233,7 +2235,7 @@ interface BaseOrder<T extends AdditionalInfo = AdditionalInfo, U extends Additio
     /** Step code, see {@link StepCode} */
     stepCode: StepCode;
     /** Step unique identifier */
-    stepId: number;
+    stepId: string;
     /** Step name */
     stepName: string;
     /** User unique identifier */
@@ -2241,9 +2243,9 @@ interface BaseOrder<T extends AdditionalInfo = AdditionalInfo, U extends Additio
     /** Order user, see {@link OrderUser} */
     user: OrderUser<V>;
     /** Order transaction unique identifier */
-    transactionId: number | null;
+    transactionId: string | null;
     /** Vendor unique identifier */
-    vendorId: number;
+    vendorId: string;
     /** Vendor name */
     vendorName: string;
     /** Order operator information, see {@link OperatorInformation} */
@@ -2270,7 +2272,7 @@ interface OrderShoppingCart<T extends AdditionalInfo = AdditionalInfo> extends O
     /** Order instructions */
     instructions: string | null;
     /** Order status unique identifier */
-    statusId: number;
+    statusId: string;
     /** Order issue unique identifier */
     issueId: string | null;
     /** Order invoice number */
@@ -2322,13 +2324,13 @@ interface OrderCommonFields {
  */
 interface OrderStore {
     /** Suborder unique identifier */
-    id: number;
+    id: string;
     /** Order unique identifier */
-    orderId: number;
+    orderId: string;
     /** Order digital command sent */
     digitalCommandSent: string;
     /** Order store status unique identifier */
-    statusId: number;
+    statusId: string;
     /** Order store status name */
     statusName: string;
     /** Order store status code, see {@link StepCode} */
@@ -2410,11 +2412,11 @@ interface OrderStoreDelivery {
  */
 interface OrderProduct {
     /** Order product id */
-    id: number;
+    id: string;
     /** Order product additional info, see {@link OrderProductAdditionalInfo } */
     additionalInfo: OrderProductAdditionalInfo;
     /** Order product unique identifier */
-    productId: number;
+    productId: string;
     /** Order product name */
     productName: string;
     /** Order product comment */
@@ -2452,7 +2454,7 @@ interface OrderProductAdditionalInfo {
     /** The measure of the product */
     measure: string;
     /** The store associated with the product */
-    new_store: number;
+    new_store: string;
     /** Indicates if a product is out of service */
     out_of_service: boolean;
     /** Indicates if a product is out of stock */
@@ -2612,7 +2614,7 @@ interface OrderProductPriceCategory {
     /** Order product price category type, see {@link PriceCategoryType} */
     category: PriceCategoryType;
     /** Order product price product id */
-    product_id?: number;
+    product_id?: string;
     /** Order product price product name */
     name?: string;
     /** Order product price subtotal without taxes */
@@ -2641,9 +2643,9 @@ interface OrderProductPriceCategory {
  */
 interface OrderRetry extends Status, OrderCommonFields {
     /** Order retry unique identifier */
-    id: number;
+    id: string;
     /** Order payment method id **/
-    payment_method_by_order_id: number;
+    payment_method_by_order_id: string;
     /** Order retry reference **/
     reference: string;
     /** Order retry platform **/
@@ -2672,13 +2674,13 @@ interface OrderRetry extends Status, OrderCommonFields {
  */
 interface PaymentMethodByOrder extends Status, OrderCommonFields {
     /** Payment method by order unique identifier **/
-    id: number;
+    id: string;
     /** Order unique identifier **/
-    order_id: number;
+    order_id: string;
     /** Payment method id **/
-    payment_method_id: number;
+    payment_method_id: string;
     /** Internal revenue service payment method id **/
-    sri_payment_method_id: number;
+    sri_payment_method_id: string;
     /** Order payment method, see {@link OrderRetryPaymentMethod} */
     order: OrderRetryPaymentMethod;
 }
@@ -2690,7 +2692,7 @@ interface PaymentMethodByOrder extends Status, OrderCommonFields {
  */
 interface OrderRetryPaymentMethod extends Status {
     /** Order retry payment method unique identifier **/
-    id: number;
+    id: string;
     /** User unique identifier associated with the order retry **/
     uid: string;
     /** Order retry billing data by user id **/
@@ -2710,13 +2712,13 @@ interface OrderRetryPaymentMethod extends Status {
     /** Order retry sent fulfillment **/
     sent_fulfillment: string;
     /** Order retry account id **/
-    account_id: number;
+    account_id: string;
     /** Order retry sequence value **/
     seq_val: string;
     /** Order retry vendor id **/
-    vendor_id: number;
+    vendor_id: string;
     /** Order retry channel id **/
-    channel_id: number;
+    channel_id: string;
     /** Order retry created date **/
     created_at: string;
     /** Order retry update date **/
@@ -2734,7 +2736,7 @@ interface OrderRetryPaymentMethod extends Status {
  */
 interface Status {
     /** Status unique identifier **/
-    status_id: number;
+    status_id: string;
     /** Status name **/
     status_name: string;
     /** Status code **/
@@ -2751,13 +2753,13 @@ interface Status {
  */
 interface Suborder extends Status {
     /** Suborder unique identifier **/
-    id: number;
+    id: string;
     /** Suborder store unique identifier **/
-    store_id: number;
+    store_id: string;
     /** Suborder store unique identifier **/
     store_name: string;
     /** Suborder order id **/
-    order_id: number;
+    order_id: string;
     /** Suborder digital command sent **/
     digital_command_sent: string;
     /** Suborder vendor **/
@@ -2781,7 +2783,7 @@ interface OrderStep {
     /** Order step description to use on front end */
     description_frontend: string;
     /** Order step unique identifier */
-    id: number;
+    id: string;
     /** Order step name */
     name: string;
     /** Order step code */
@@ -2875,7 +2877,7 @@ type Order<T extends AdditionalInfo = AdditionalInfo, U extends AdditionalInfo =
  */
 interface BaseField {
     /** Base field unique identifier */
-    id: number;
+    id: string;
     /** Base field name */
     name: string;
 }
@@ -2997,9 +2999,9 @@ interface OperatorInformation {
  */
 interface OrderPaymentMethod {
     /** Order payment method id */
-    id: number;
+    id: string;
     /** Order payment method id */
-    payment_method_id: number;
+    payment_method_id: string;
     /** Order payment method name */
     payment_method_name: string;
     /** Order total by payment method */
@@ -3027,7 +3029,7 @@ type OrderStatus = "APPROVED" | "REJECTED" | "PENDING";
  */
 interface Notification {
     /** Notification unique identifier */
-    id: number;
+    id: string;
     /** Notification title */
     title: string;
     /** Notification description */
@@ -3070,7 +3072,7 @@ type ReadValue = "YES" | "NO";
  */
 interface NotificationExtraData {
     /** The id of the notification extra data */
-    id: number;
+    id: string;
     /** Sequential value */
     seqVal: string;
     /** Unique identifier */
@@ -3086,9 +3088,9 @@ interface NotificationExtraData {
     /** Store related to the notification, see {@link NotificationStore} */
     store: NotificationStore;
     /** Channel unique identifier */
-    channel_id: number;
+    channel_id: string;
     /** Provided country id */
-    countryId: number;
+    countryId: string;
     /** Notification step, see {@link NotificationStep} */
     step: NotificationStep;
     /** Allocation options, see {@link Allocation} */
@@ -3159,7 +3161,7 @@ interface NotificationAdditionalInfo {
     /** Project unique identifier */
     aud: string;
     /** Unique identifier of workflowId */
-    workflowId: number;
+    workflowId: string;
 }
 /**
  * Notification list item.
@@ -3182,7 +3184,7 @@ interface NotificationListItem {
  */
 interface BasePaymentMethod {
     /** Payment method's id */
-    id: number;
+    id: string;
     /** Payment method's created date */
     created_at: string | null;
     /** Payment method's updated date */
@@ -3251,7 +3253,7 @@ interface PaymentProvider extends Omit<PaymentMethod, "name"> {
  */
 interface CreditCardMapping extends BasePaymentMethod {
     /** Credit card mapping unique identifier */
-    id: number;
+    id: string;
     /** Credit card mapping name, see {@link CardName} */
     name: CardName;
     /** Payment method image's url, commonly used to save image cards */
@@ -3280,7 +3282,7 @@ type CardName = "Diners" | "Discover" | "American Express" | "Visa" | "MasterCar
  * @since 0.5.15
  */
 interface CardInscription {
-    id: number;
+    id: string;
     uid: string;
     number: string;
     type: string;

package/package.json

@@ -2,7 +2,7 @@
   "name": "@artisan-commerce/types",
   "description": "Artisn's types and interfaces library",
   "type": "module",
-  "version": "0.14.0-canary.47",
+  "version": "0.14.0-canary.49",
   "types": "./dist/bundle.d.ts",
   "files": [
     "dist"
@@ -24,7 +24,7 @@
   },
   "author": "Luis Eduardo Andrade",
   "license": "MIT",
-  "gitHead": "31a5315d6416ef7c087483b2633e3082a93d93c7",
+  "gitHead": "98e0239c60db3d4644252e78de08e6a902f5904b",
   "nx": {
     "targets": {
       "build": {