@artisan-commerce/types 0.14.0-canary.25 → 0.14.0-canary.27

package/CHANGELOG.md

@@ -3,6 +3,24 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.14.0-canary.27](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.26...@artisan-commerce/types@0.14.0-canary.27) (2021-12-13)
+
+
+### Bug Fixes
+
+* **global:** fix types and builder for order store ([35286a9](https://bitbucket.org/tradesystem/artisn_sdk/commit/35286a92e5e3df2fe5b3cfa5f289a0e321a24128))
+
+
+
+## [0.14.0-canary.26](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.25...@artisan-commerce/types@0.14.0-canary.26) (2021-12-01)
+
+
+### Features
+
+* **global:** update and add types and builders for notifications ([5d6902b](https://bitbucket.org/tradesystem/artisn_sdk/commit/5d6902ba54a84d14a783b5bcda3381ec68a1e636))
+
+
+
 ## [0.14.0-canary.25](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.24...@artisan-commerce/types@0.14.0-canary.25) (2021-11-05)
 
 

package/dist/bundle.d.ts

@@ -2076,28 +2076,6 @@ interface Rule {
     min: number;
 }
 
-/**
- * Notification object.
- *
- * @interface Notification
- * @since 0.5.15
- */
-interface Notification {
-    /** Notification unique identifier */
-    id: number;
-    /** Notification title */
-    title: string;
-    /** Notification description */
-    description: string;
-    /**
-     * Whether or not the notification was read. Purposefully
-     * has a string type.
-     */
-    read: string;
-    /** Notification creation date */
-    creationDate: string;
-}
-
 /**
  * Representation of a basic Shipping Address.
  *
@@ -2443,10 +2421,9 @@ interface OrderCommonFields {
  *
  * @interface OrderStore
  * @since 0.1.0
- * @extends {{@link Store}
  */
-interface OrderStore extends Store {
-    /** Order store id */
+interface OrderStore {
+    /** Suborder unique identifier */
     id: number;
     /** Order unique identifier */
     orderId: number;
@@ -2462,6 +2439,70 @@ interface OrderStore extends Store {
     billStoreTotal: OrderBillTotal;
     /** An array of OrderProducts, see {@link OrderProduct} */
     products: OrderProduct[];
+    /** Store unique identifier */
+    storeId: Store["storeId"];
+    /** Store name */
+    storeName: Store["storeName"];
+    /** Additional information for the store, see {@link OrderStoreAdditionalInfo} */
+    additionalInfo: OrderStoreAdditionalInfo;
+}
+/**
+ * Order store additional information.
+ *
+ * @interface OrderStoreAdditionalInfo
+ * @since 0.1.0
+ */
+interface OrderStoreAdditionalInfo {
+    /** Store address */
+    address: string;
+    /** Store channel name */
+    channel_name: string;
+    /** Whether or not the store is within coverage */
+    coverage: boolean;
+    /** Store delivery information, see {@link OrderStoreDelivery} */
+    delivery: OrderStoreDelivery;
+    /** Store external identifier */
+    external_id: string;
+    /** Whether or not the store has a dedicated drinks store */
+    is_drinks_store: boolean;
+    /** Store latitude */
+    latitude: number;
+    /** Store longitude */
+    longitude: number;
+    /** Order maximum amount allowed */
+    max_order_amount: number;
+    /** Order minimum amount allowed */
+    min_order_amount: number;
+    /** Order currency's symbol */
+    order_symbol: string;
+    /** Store phone */
+    phone: string;
+    /** Store schedules, see {@link Schedule} */
+    schedules: Schedule[];
+    /** Whether or not to show the drinks store */
+    show_drinks_store: boolean;
+    /** Whether or not the store is sponsored */
+    sponsored: boolean;
+    /** Store external code */
+    store_external_code: string;
+    /** Store timezone */
+    timezone: string;
+}
+/**
+ * The delivery information associated with the order store.
+ *
+ * @interface OrderStoreDelivery
+ * @since 0.1.0
+ */
+interface OrderStoreDelivery {
+    /** Whether or not the store has free delivery */
+    free_delivery: Delivery["freeDelivery"];
+    /** Whether or not the store has a express delivery */
+    express: Delivery["express"];
+    /** Time value for delivery as string */
+    delivery_time_value: Delivery["deliveryTimeValue"];
+    /** Time unit for delivery, see {@link DeliveryTimeUnit} */
+    delivery_time_unit: Delivery["deliveryTimeUnit"];
 }
 /**
  * The product associated with the order.
@@ -3068,6 +3109,161 @@ interface OrderPaymentMethod {
  */
 declare type OrderStatus = "APPROVED" | "REJECTED" | "PENDING";
 
+/**
+ * Notification object.
+ *
+ * @interface Notification
+ * @since 0.1.0
+ */
+interface Notification {
+    /** Notification unique identifier */
+    id: number;
+    /** Notification title */
+    title: string;
+    /** Notification description */
+    description: string;
+    /** Notification list title */
+    listTitle: string;
+    /** Notification list items */
+    listItems: NotificationListItem[];
+    /** Notification creation date */
+    creationDate: string;
+    /** Notification priority, see {@link NotificationPriority} */
+    priority: NotificationPriority;
+    /**
+     * Whether or not the notification was read. Purposefully
+     * has a string type.
+     */
+    read: ReadValue;
+    /** Notification extra data, see {@link NotificationExtraData} */
+    extra_data: NotificationExtraData;
+}
+/**
+ * Possible priority values for notifications.
+ *
+ * @typedef NotificationPriority
+ * @since 0.1.0
+ */
+declare type NotificationPriority = "HIGH" | "LOW";
+/**
+ * Possible read values for notifications.
+ *
+ * @typedef ReadValue
+ * @since 0.1.0
+ */
+declare type ReadValue = "YES" | "NO";
+/**
+ * Notification extra data.
+ *
+ * @interface NotificationExtraData
+ * @since 0.1.0
+ */
+interface NotificationExtraData {
+    /** The id of the notification extra data */
+    id: number;
+    /** Sequential value */
+    seqVal: string;
+    /** Unique identifier */
+    uid: string;
+    /** Notification user, see {@link NotificationUser} */
+    user: NotificationUser;
+    /** The provided account id of the application */
+    accountId: Account["accountId"];
+    /** Vendor related to the notification, see {@link NotificationVendor} */
+    vendor: NotificationVendor;
+    /** City of the store related to the notification, see {@link BaseField} */
+    city: BaseField;
+    /** Store related to the notification, see {@link NotificationStore} */
+    store: NotificationStore;
+    /** Channel unique identifier */
+    channel_id: number;
+    /** Provided country id */
+    countryId: number;
+    /** Notification step, see {@link NotificationStep} */
+    step: NotificationStep;
+    /** Allocation options, see {@link Allocation} */
+    allocation: Allocation;
+    /** Payment Method of the order related to the notification */
+    paymentMethod: string;
+    /** Total price of the order */
+    total: string;
+    /** Notification additional information, see {@link NotificationAdditionalInfo} */
+    additionalInfo: NotificationAdditionalInfo;
+    /** Notification creation Date */
+    created_at: string;
+}
+/**
+ * Notification vendor.
+ *
+ * @interface NotificationVendor
+ * @since 0.1.0
+ * @extends Vendor
+ */
+interface NotificationVendor extends Omit<Vendor, "images" | "maxPurchaseValue" | "description" | "sponsored" | "active"> {
+}
+/**
+ * Notification store.
+ *
+ * @interface NotificationStore
+ * @since 0.1.0
+ * @extends BaseField
+ */
+interface NotificationStore extends BaseField {
+    /** Store's address */
+    address: string;
+}
+/**
+ * Notification user.
+ *
+ * @interface NotificationUser
+ * @since 0.1.0
+ */
+interface NotificationUser {
+    /** Notification user name */
+    name: string;
+    /** Notification user address */
+    address: string;
+    /** Notification user email */
+    email: string;
+}
+/**
+ * Notification step.
+ *
+ * @interface NotificationStep
+ * @since 0.1.0
+ * @extends StepWorkflow
+ */
+interface NotificationStep extends Omit<StepWorkflow, "additional_info" | "color" | "description" | "description_frontend" | "subtitle_frontend" | "title_frontend" | "transitions" | "notification"> {
+}
+/**
+ * Notification additional information.
+ *
+ * @interface NotificationAdditionalInfo
+ * @since 0.1.0
+ */
+interface NotificationAdditionalInfo {
+    /** Whether or not notification has parent shopping cart*/
+    parent_shopping_cart: boolean;
+    /** Order metadata shipping, see {@link MetadataShipping} */
+    metadata_shipping: MetadataShipping;
+    /** Project unique identifier */
+    aud: string;
+    /** Unique identifier of workflowId */
+    workflowId: number;
+}
+/**
+ * Notification list item.
+ *
+ * @interface NotificationListItem
+ * @since 0.1.0
+ */
+interface NotificationListItem {
+    /** Notification list item title */
+    title: string;
+    /** Notification list item description */
+    description: string;
+}
+
 /**
  * Basic payment method object.
  *
@@ -3168,4 +3364,4 @@ interface CardInscription {
     createdAt?: string;
 }
 
-export { ARDocumentType, Account, AdditionalInfo, AdditionalStoreInformation, Alert, Allocation, ArtisnApp, ArtisnDB, ArtisnDBCollectionReference, ArtisnDBDocumentData, ArtisnDBQueryDocumentSnapshot, ArtisnHeaders, ArtisnHints, ArtisnParams, ArtisnPlatform, ArtisnQuery, ArtisnRNApp, ArtisnRNAuth, ArtisnRNAuthInstance, ArtisnRNSettings, ArtisnRequest, ArtisnRequestBody, ArtisnRequestHeaders, ArtisnRequestMethod, ArtisnRestrictedHeaders, ArtisnWebApp, ArtisnWebAuth, ArtisnWebAuthInstance, ArtisnWebSettings, Award, BODocumentType, BRDocumentType, Banner, BannerImage, BannerScope, BannerType, BaseBillingData, BaseField, BaseLivingPlace, BaseOrder, BasePaymentMethod, BaseProduct, BaseShippingAddress, BaseUser, BaseWeekDay, Benefit, BenefitData, BenefitTypes, BenefitsByUserNode, BenefitsByUserNodes, BillTotal, BillTotalCategory, BillingData, CDNImage, CLDocumentType, CODocumentType, CardInscription, CardName, CartProduct, CartProductAnswer, CartProductQuestion, CartStore, CartTotals, Catalogue, Category, CategoryWithProducts, Code, CommonDocumentType, Country, CountryCode, CountryCurrency, CountrySummary, Coupon, CouponCategory, CouponType, CreditCardMapping, CurrencyCodes, DayOfWeek, Days, Delivery, DeliveryTimeUnit, DocumentType, ECDocumentType, Field, FieldRecord, Gender, GenericStoreLocation, Image, ImageFit, ImageManipulationConfig, ImageToFormat, Injection, InjectionDetail, IntegrationMessage, Issue, IssueAdditionalInfo, IssueHistory, LivingPlace, LivingPlaceToSave, MaritalStatus, Message, MetadataShipping, NewShippingAddress, Notification, Objectify, OperatorInformation, Order, OrderAdditionalInfo, OrderBillProduct, OrderBillProductAdditionalInfo, OrderBillTotal, OrderCommonFields, OrderDetailShippingCost, OrderDetails, OrderPaymentMethod, OrderProduct, OrderProductAdditionalInfo, OrderProductAttributes, OrderProductImage, OrderProductPriceCategory, OrderRetry, OrderRetryPaymentMethod, OrderShoppingCart, OrderStatus, OrderStep, OrderStepAdditionalInfo, OrderStepAdditionalInfoGroup, OrderStore, OrderUser, PEDocumentType, PYDocumentType, PaymentMethod, PaymentMethodByOrder, PaymentMethodName, PaymentProvider, Phone, PriceCategory, PriceCategoryTax, PriceCategoryType, Product, ProductAnswer, ProductAttributes, ProductCoupon, ProductDetails, ProductPrices, ProductQuestion, ProductStatus, ProductType, RandomImageConfig, Rule, Schedule, Service, Settings, ShippingAddress, ShippingCost, ShippingCostTax, ShoppingCart, ShoppingCartBenefits, ShoppingCartNode, ShoppingCartNodes, Status, StepCategory, StepCode, StepNotification, StepWorkflow, StepWorkflowAdditionalInfo, StepWorkflowGroup, Store, StoreCoupon, StoreCouponDetail, StoreLocation, StorePolygons, Suborder, TaxCalculation, TaxCalculations, TaxType, Token, TransitionWorkflow, URLImage, USDocumentType, UYDocumentType, UpdatedShippingAddress, User, UserCountry, UserSettings, UserType, VEDocumentType, Vendor, Wallet, WebhookWorkflow, Workflow, ZipCodeField };
+export { ARDocumentType, Account, AdditionalInfo, AdditionalStoreInformation, Alert, Allocation, ArtisnApp, ArtisnDB, ArtisnDBCollectionReference, ArtisnDBDocumentData, ArtisnDBQueryDocumentSnapshot, ArtisnHeaders, ArtisnHints, ArtisnParams, ArtisnPlatform, ArtisnQuery, ArtisnRNApp, ArtisnRNAuth, ArtisnRNAuthInstance, ArtisnRNSettings, ArtisnRequest, ArtisnRequestBody, ArtisnRequestHeaders, ArtisnRequestMethod, ArtisnRestrictedHeaders, ArtisnWebApp, ArtisnWebAuth, ArtisnWebAuthInstance, ArtisnWebSettings, Award, BODocumentType, BRDocumentType, Banner, BannerImage, BannerScope, BannerType, BaseBillingData, BaseField, BaseLivingPlace, BaseOrder, BasePaymentMethod, BaseProduct, BaseShippingAddress, BaseUser, BaseWeekDay, Benefit, BenefitData, BenefitTypes, BenefitsByUserNode, BenefitsByUserNodes, BillTotal, BillTotalCategory, BillingData, CDNImage, CLDocumentType, CODocumentType, CardInscription, CardName, CartProduct, CartProductAnswer, CartProductQuestion, CartStore, CartTotals, Catalogue, Category, CategoryWithProducts, Code, CommonDocumentType, Country, CountryCode, CountryCurrency, CountrySummary, Coupon, CouponCategory, CouponType, CreditCardMapping, CurrencyCodes, DayOfWeek, Days, Delivery, DeliveryTimeUnit, DocumentType, ECDocumentType, Field, FieldRecord, Gender, GenericStoreLocation, Image, ImageFit, ImageManipulationConfig, ImageToFormat, Injection, InjectionDetail, IntegrationMessage, Issue, IssueAdditionalInfo, IssueHistory, LivingPlace, LivingPlaceToSave, MaritalStatus, Message, MetadataShipping, NewShippingAddress, Notification, NotificationAdditionalInfo, NotificationExtraData, NotificationListItem, NotificationPriority, NotificationStep, NotificationStore, NotificationUser, NotificationVendor, Objectify, OperatorInformation, Order, OrderAdditionalInfo, OrderBillProduct, OrderBillProductAdditionalInfo, OrderBillTotal, OrderCommonFields, OrderDetailShippingCost, OrderDetails, OrderPaymentMethod, OrderProduct, OrderProductAdditionalInfo, OrderProductAttributes, OrderProductImage, OrderProductPriceCategory, OrderRetry, OrderRetryPaymentMethod, OrderShoppingCart, OrderStatus, OrderStep, OrderStepAdditionalInfo, OrderStepAdditionalInfoGroup, OrderStore, OrderStoreAdditionalInfo, OrderStoreDelivery, OrderUser, PEDocumentType, PYDocumentType, PaymentMethod, PaymentMethodByOrder, PaymentMethodName, PaymentProvider, Phone, PriceCategory, PriceCategoryTax, PriceCategoryType, Product, ProductAnswer, ProductAttributes, ProductCoupon, ProductDetails, ProductPrices, ProductQuestion, ProductStatus, ProductType, RandomImageConfig, ReadValue, Rule, Schedule, Service, Settings, ShippingAddress, ShippingCost, ShippingCostTax, ShoppingCart, ShoppingCartBenefits, ShoppingCartNode, ShoppingCartNodes, Status, StepCategory, StepCode, StepNotification, StepWorkflow, StepWorkflowAdditionalInfo, StepWorkflowGroup, Store, StoreCoupon, StoreCouponDetail, StoreLocation, StorePolygons, Suborder, TaxCalculation, TaxCalculations, TaxType, Token, TransitionWorkflow, URLImage, USDocumentType, UYDocumentType, UpdatedShippingAddress, User, UserCountry, UserSettings, UserType, VEDocumentType, Vendor, Wallet, WebhookWorkflow, Workflow, ZipCodeField };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@artisan-commerce/types",
   "description": "Artisn's types and interfaces library",
-  "version": "0.14.0-canary.25",
+  "version": "0.14.0-canary.27",
   "main": "./dist/bundle.d.ts",
   "module": "./dist/bundle.d.ts",
   "types": "./dist/bundle.d.ts",
@@ -34,5 +34,5 @@
     "@react-native-firebase/firestore": "^12.8.0",
     "firebase": "^8.1.1"
   },
-  "gitHead": "b388e92c72e306a3f446181f11d0cb05ca55bbf3"
+  "gitHead": "3f1273ea8d92b7f1e350b1c5fd41882fd0a9e969"
 }