@artisan-commerce/types 0.14.0-canary.29 → 0.14.0-canary.3

package/CHANGELOG.md

@@ -3,236 +3,6 @@
 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.29](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.28...@artisan-commerce/types@0.14.0-canary.29) (2021-12-28)
-
-
-### Bug Fixes
-
-* **artisn:** fix banner types ([af0d441](https://bitbucket.org/tradesystem/artisn_sdk/commit/af0d441ac0ee0c1bb97dd5ae7c4fca9ace46e2c1))
-
-
-
-## [0.14.0-canary.28](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.27...@artisan-commerce/types@0.14.0-canary.28) (2021-12-15)
-
-
-### Features
-
-* **global:** add function to write pick up time remotely on shopping cart ([e71c4c4](https://bitbucket.org/tradesystem/artisn_sdk/commit/e71c4c408e4a5703bad4600b9cec2e4e642c80d3))
-
-
-
-## [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)
-
-
-### Features
-
-* **global:** fix types and builders for store coupon and add condition to shipping cost ([2800a87](https://bitbucket.org/tradesystem/artisn_sdk/commit/2800a87a326c9f0ca5e0f1fbe202e15768fc32c9))
-
-
-
-## [0.14.0-canary.24](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.23...@artisan-commerce/types@0.14.0-canary.24) (2021-10-22)
-
-
-### Features
-
-* **global:** add interfaces, functions and services for store coupons ([7e8a959](https://bitbucket.org/tradesystem/artisn_sdk/commit/7e8a95998982e8c8b892b61eb709e98ac7671a09))
-* **global:** add missing interface and docs ([e7fca2f](https://bitbucket.org/tradesystem/artisn_sdk/commit/e7fca2f5a608a592380b8cd9aafab04cc32ce13d))
-
-
-
-## [0.14.0-canary.23](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.22...@artisan-commerce/types@0.14.0-canary.23) (2021-10-21)
-
-**Note:** Version bump only for package @artisan-commerce/types
-
-
-
-
-
-## [0.14.0-canary.22](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.21...@artisan-commerce/types@0.14.0-canary.22) (2021-10-21)
-
-
-### Bug Fixes
-
-* **global:** add clean shopping cart to remove benefits and fix coupon docs ([dd3e66a](https://bitbucket.org/tradesystem/artisn_sdk/commit/dd3e66a5aa19430ec745b6e726c1b45c103e1b82))
-
-
-
-## [0.14.0-canary.21](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.20...@artisan-commerce/types@0.14.0-canary.21) (2021-10-20)
-
-**Note:** Version bump only for package @artisan-commerce/types
-
-
-
-
-
-## [0.14.0-canary.20](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.19...@artisan-commerce/types@0.14.0-canary.20) (2021-10-19)
-
-
-### Bug Fixes
-
-* **global:** add interfaces and builders for order ([53d18b0](https://bitbucket.org/tradesystem/artisn_sdk/commit/53d18b07c53fa54f9af69a0751b94a95452bfdc3))
-* **global:** fix tax calculation builder ([3f7698f](https://bitbucket.org/tradesystem/artisn_sdk/commit/3f7698f1cfdf97e2b8d8fa4040b70a7cfa150b74))
-
-
-
-## [0.14.0-canary.19](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.18...@artisan-commerce/types@0.14.0-canary.19) (2021-10-14)
-
-
-### Bug Fixes
-
-* **global:** make export not module by default ([4e701b1](https://bitbucket.org/tradesystem/artisn_sdk/commit/4e701b1b59df89cf8358cf500984b1c2c4f42c60))
-
-
-
-## [0.14.0-canary.18](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.17...@artisan-commerce/types@0.14.0-canary.18) (2021-10-14)
-
-
-### Bug Fixes
-
-* **global:** fix some payment types ([8000970](https://bitbucket.org/tradesystem/artisn_sdk/commit/80009700cd8664828b1236e8ad7cc90ce2fcb3e7))
-
-
-
-## [0.14.0-canary.17](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.16...@artisan-commerce/types@0.14.0-canary.17) (2021-10-14)
-
-**Note:** Version bump only for package @artisan-commerce/types
-
-
-
-
-
-## [0.14.0-canary.16](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.15...@artisan-commerce/types@0.14.0-canary.16) (2021-10-13)
-
-
-### Features
-
-* **global:** fix builder and types to adjust better to reality ([11cdb93](https://bitbucket.org/tradesystem/artisn_sdk/commit/11cdb93199d5a57d12f5aa6f7ece17f0c38c0521))
-* **global:** fix unnecessary params on functions and add docs ([3830d7d](https://bitbucket.org/tradesystem/artisn_sdk/commit/3830d7d8b0044ca580bcbcc4acd0b0ea5a8b0266))
-
-
-
-## [0.14.0-canary.15](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.14...@artisan-commerce/types@0.14.0-canary.15) (2021-10-05)
-
-
-### Bug Fixes
-
-* **global:** fix ProductDetail builder and update its types ([cdc6cf9](https://bitbucket.org/tradesystem/artisn_sdk/commit/cdc6cf9ed2e7ff1a340bc691b0dc1156bc682d38))
-
-
-
-## [0.14.0-canary.14](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.13...@artisan-commerce/types@0.14.0-canary.14) (2021-10-01)
-
-
-### Bug Fixes
-
-* **global:** fix firebase related types ([efa5081](https://bitbucket.org/tradesystem/artisn_sdk/commit/efa5081a844be033ac9135ac65bf8f56184b71b0))
-
-
-
-## [0.14.0-canary.13](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.12...@artisan-commerce/types@0.14.0-canary.13) (2021-09-30)
-
-**Note:** Version bump only for package @artisan-commerce/types
-
-
-
-
-
-## [0.14.0-canary.12](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.11...@artisan-commerce/types@0.14.0-canary.12) (2021-09-30)
-
-**Note:** Version bump only for package @artisan-commerce/types
-
-
-
-
-
-## [0.14.0-canary.11](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.10...@artisan-commerce/types@0.14.0-canary.11) (2021-09-23)
-
-
-### Bug Fixes
-
-* **global:** update types of CDNImage, reduce the depth of product questions ([82dba32](https://bitbucket.org/tradesystem/artisn_sdk/commit/82dba324457455e6cd2d76091aaffaef5f540d9f))
-
-
-
-## [0.14.0-canary.10](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.9...@artisan-commerce/types@0.14.0-canary.10) (2021-09-21)
-
-
-### Bug Fixes
-
-* **global:** fix product details and settings builders ([5452fc9](https://bitbucket.org/tradesystem/artisn_sdk/commit/5452fc9d70ff3fa9f859ed4a665fd933e133c7ce))
-
-
-
-## [0.14.0-canary.9](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.8...@artisan-commerce/types@0.14.0-canary.9) (2021-09-17)
-
-
-### Features
-
-* **global:** add categories property to product details interface ([0d95d09](https://bitbucket.org/tradesystem/artisn_sdk/commit/0d95d093383673322369b0870af290182bb57cb8))
-
-
-
-## [0.14.0-canary.8](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.7...@artisan-commerce/types@0.14.0-canary.8) (2021-08-25)
-
-**Note:** Version bump only for package @artisan-commerce/types
-
-
-
-
-
-## [0.14.0-canary.7](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.6...@artisan-commerce/types@0.14.0-canary.7) (2021-08-24)
-
-**Note:** Version bump only for package @artisan-commerce/types
-
-
-
-
-
-## [0.14.0-canary.6](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.5...@artisan-commerce/types@0.14.0-canary.6) (2021-08-23)
-
-
-### Bug Fixes
-
-* **global:** add missing properties to order interfaces and types ([757157f](https://bitbucket.org/tradesystem/artisn_sdk/commit/757157fbb2dd25d04efc791cd9b9511e41685471))
-
-
-
-## [0.14.0-canary.5](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.4...@artisan-commerce/types@0.14.0-canary.5) (2021-08-23)
-
-
-### Bug Fixes
-
-* **global:** add missing properties to shipping address and complete document type ([c9156f6](https://bitbucket.org/tradesystem/artisn_sdk/commit/c9156f6db3e55f23479484577760f5196e112afc))
-
-
-
-## [0.14.0-canary.4](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.3...@artisan-commerce/types@0.14.0-canary.4) (2021-08-12)
-
-
-### Bug Fixes
-
-* **global:** add CountryCode type and update user builder ([f94eb5d](https://bitbucket.org/tradesystem/artisn_sdk/commit/f94eb5d38e0725bd157398e3c51b3bb8b2592abc))
-
-
-
 ## [0.14.0-canary.3](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/types@0.14.0-canary.2...@artisan-commerce/types@0.14.0-canary.3) (2021-08-12)
 
 

package/build/index.d.ts

@@ -0,0 +1,26 @@
+export * from "./types/account.types";
+export * from "./types/app.types";
+export * from "./types/artisnDB.types";
+export * from "./types/banner.types";
+export * from "./types/billingData.types";
+export * from "./types/catalogue.types";
+export * from "./types/category.types";
+export * from "./types/common.types";
+export * from "./types/country.types";
+export * from "./types/coupon.types";
+export * from "./types/currency.types";
+export * from "./types/fulfillment.types";
+export * from "./types/http.types";
+export * from "./types/image.types";
+export * from "./types/livingPlace.types";
+export * from "./types/notification.types";
+export * from "./types/order.types";
+export * from "./types/payment.types";
+export * from "./types/product.types";
+export * from "./types/settings.types";
+export * from "./types/shippingAddress.types";
+export * from "./types/shippingCost.types";
+export * from "./types/shoppingCart.types";
+export * from "./types/store.types";
+export * from "./types/vendor.types";
+export * from "./types/user.types";

package/build/index.js

@@ -0,0 +1,40 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+// Main
+__exportStar(require("./types/account.types"), exports);
+__exportStar(require("./types/app.types"), exports);
+__exportStar(require("./types/artisnDB.types"), exports);
+__exportStar(require("./types/banner.types"), exports);
+__exportStar(require("./types/billingData.types"), exports);
+__exportStar(require("./types/catalogue.types"), exports);
+__exportStar(require("./types/category.types"), exports);
+__exportStar(require("./types/common.types"), exports);
+__exportStar(require("./types/country.types"), exports);
+__exportStar(require("./types/coupon.types"), exports);
+__exportStar(require("./types/currency.types"), exports);
+__exportStar(require("./types/fulfillment.types"), exports);
+__exportStar(require("./types/http.types"), exports);
+__exportStar(require("./types/image.types"), exports);
+__exportStar(require("./types/livingPlace.types"), exports);
+__exportStar(require("./types/notification.types"), exports);
+__exportStar(require("./types/order.types"), exports);
+__exportStar(require("./types/payment.types"), exports);
+__exportStar(require("./types/product.types"), exports);
+__exportStar(require("./types/settings.types"), exports);
+__exportStar(require("./types/shippingAddress.types"), exports);
+__exportStar(require("./types/shippingCost.types"), exports);
+__exportStar(require("./types/shoppingCart.types"), exports);
+__exportStar(require("./types/store.types"), exports);
+__exportStar(require("./types/vendor.types"), exports);
+__exportStar(require("./types/user.types"), exports);
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,OAAO;AACP,wDAAsC;AACtC,oDAAkC;AAClC,yDAAuC;AACvC,uDAAqC;AACrC,4DAA0C;AAC1C,0DAAwC;AACxC,yDAAuC;AACvC,uDAAqC;AACrC,wDAAsC;AACtC,uDAAqC;AACrC,yDAAuC;AACvC,4DAA0C;AAC1C,qDAAmC;AACnC,sDAAoC;AACpC,4DAA0C;AAC1C,6DAA2C;AAC3C,sDAAoC;AACpC,wDAAsC;AACtC,wDAAsC;AACtC,yDAAuC;AACvC,gEAA8C;AAC9C,6DAA2C;AAC3C,6DAA2C;AAC3C,sDAAoC;AACpC,uDAAqC;AACrC,qDAAmC"}

package/build/types/account.types.d.ts

@@ -0,0 +1,17 @@
+import { CDNImage } from "./image.types";
+/**
+ * Representation of a Commerce Account.
+ *
+ * @interface Account
+ * @since 0.5.14
+ */
+export interface Account {
+    /** Artisn's account unique identifier */
+    accountId: number;
+    /** Account's name */
+    name: string;
+    /** Account's description */
+    description?: string;
+    /** Account's images, see {@link CDNImage} for further information */
+    images: CDNImage[];
+}

package/build/types/account.types.js

@@ -0,0 +1,4 @@
+"use strict";
+// Account types and interfaces
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=account.types.js.map

package/build/types/account.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"account.types.js","sourceRoot":"","sources":["../../src/types/account.types.ts"],"names":[],"mappings":";AAAA,+BAA+B"}

package/build/types/app.types.d.ts

@@ -0,0 +1,153 @@
+import firebase from "firebase";
+/**
+ * The ArtisnApp controls the app connection with the DBs and its settings.
+ *
+ * @typedef ArtisnApp
+ * @since 0.5.14
+ */
+export declare type ArtisnApp = ArtisnAppWeb | ArtisnAppRN;
+/**
+ * The ArtisnAppWeb orchestrate the connections of the app with the DB, server and its settings.
+ *
+ * @interface ArtisnAppWeb
+ * @since 0.5.14
+ */
+export interface ArtisnAppWeb {
+    /** App's name */
+    name: firebase.app.App["name"];
+    /** Artisn's account API URL */
+    apiURL: string;
+    /** Artisn app settings configuration, see {@link ArtisnSettings} */
+    settings: ArtisnSettings;
+    /** Internal configuration of App and databases  */
+    __internals__: firebase.app.App;
+    /** ArtisnApp object internal instance */
+    __instance__: typeof firebase;
+}
+/**
+ * The ArtisnAppRN orchestrate the connections of the app with the DB, server and its settings.
+ *
+ * @interface ArtisnAppRN
+ * @since 0.5.14
+ */
+export interface ArtisnAppRN {
+    /** Artisn's account API URL */
+    apiURL: string;
+    /** Internal configuration of App and databases */
+    __internals__: RNFirebaseInstance;
+    /** ArtisnApp object internal instance */
+    __instance__: RNFirebaseInstance;
+    /** Artisn app settings configuration, see {@link ArtisnSettings} */
+    settings: ArtisnSettings;
+    /** App's name */
+    name: string;
+}
+/**
+ * Settings to configure the Firebase Instance.
+ *
+ * @interface RNFirebaseInstance
+ * @since 0.5.14
+ */
+export interface RNFirebaseInstance {
+    /** Auth package from react-native-auth */
+    auth: any;
+    /**  Firestore package from react-native-auth */
+    firestore: any;
+}
+/**
+ * Settings to configure the Artisn app.
+ *
+ * @interface ArtisnSettings
+ * @since 0.5.14
+ */
+export interface ArtisnSettings {
+    /** Artisn's account unique identifier */
+    accountId?: number;
+    /** Platform where the app is running, see {@link ArtisnPlatform} */
+    platform?: ArtisnPlatform;
+    /** App's project id */
+    projectId: string;
+    /** App's API key */
+    apiKey: string;
+    /** App's external app id */
+    appId?: string;
+    /** App's auth domain url */
+    authDomain: string;
+}
+/**
+ * Settings to configure the Artisn app react-native.
+ *
+ * @interface ArtisnSettingsRN
+ * @since 0.5.14
+ */
+export interface ArtisnSettingsRN {
+    /** Platform where the app is running, see {@link ArtisnPlatform} */
+    platform: ArtisnPlatform;
+    /** Artisn's account unique identifier */
+    accountId?: number;
+}
+/**
+ * Artisn app's allowed platforms to run on.
+ *
+ * @typedef ArtisnPlatform
+ * @since 0.5.14
+ */
+export declare type ArtisnPlatform = "web" | "ios" | "android" | "windows" | "macos" | "call center";
+/**
+ * Artisn's auth instance is the instance of the internal auth object.
+ *
+ * @typedef ArtisnInstanceAuth
+ * @since 0.5.14
+ */
+export declare type ArtisnInstanceAuth = typeof firebase.auth;
+/**
+ * Artisn's auth object to handle providers authentication.
+ *
+ * @typedef ArtisnAuth
+ * @since 0.5.14
+ */
+export interface ArtisnAuth extends firebase.auth.Auth {
+}
+/**
+ * Main artisn commerce filters.
+ *
+ * @interface ArtisnHints
+ * @since 0.5.14
+ */
+export interface ArtisnHints {
+    /** Artisn's account unique identifier */
+    accountId: string | number;
+    /** Artisn's vendor unique identifier */
+    vendorId?: string | number;
+    /** Artisn's catalogue unique identifier  */
+    catalogueId?: string | number;
+    /** Artisn's store unique identifier  */
+    storeId?: number;
+    /** Artisn's category unique identifier  */
+    categoryId?: string | number;
+    /** Artisn's productId unique identifier  */
+    productId?: string | number;
+}
+/**
+ * Unrestricted allowed Artisn SDK rest api headers.
+ *
+ * @interface ArtisnHeaders
+ * @since 0.5.14
+ */
+export interface ArtisnHeaders {
+    /** Platform where the app is running, see {@link ArtisnPlatform} */
+    Platform: ArtisnPlatform;
+    /** Artisn's account unique identifier */
+    account: string;
+}
+/**
+ * Restricted allowed Artisn SDK rest api headers.
+ *
+ * @interface ArtisnRestrictedHeaders
+ * @since 0.5.14
+ * @extends {{@link ArtisnHeaders}
+ */
+export interface ArtisnRestrictedHeaders extends ArtisnHeaders {
+    /** Authorization app's authentication token */
+    Authorization: string;
+}

package/build/types/app.types.js

@@ -0,0 +1,4 @@
+"use strict";
+// Artisn App types and interfaces
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=app.types.js.map

package/build/types/app.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"app.types.js","sourceRoot":"","sources":["../../src/types/app.types.ts"],"names":[],"mappings":";AAAA,kCAAkC"}

package/build/types/artisnDB.types.d.ts

@@ -0,0 +1,29 @@
+import firebase from "firebase";
+/**
+ * Artisn database object.
+ *
+ * @typedef ArtisnDB
+ * @since 0.5.14
+ */
+export declare type ArtisnDB = firebase.firestore.Firestore;
+/**
+ * Artisn database document data object.
+ *
+ * @typedef ArtisnDBDocumentData
+ * @since 0.5.14
+ */
+export declare type ArtisnDBDocumentData = firebase.firestore.DocumentData;
+/**
+ * The current state of a node from the Artisn DB.
+ *
+ * @typedef ArtisnDBQueryDocumentSnapshot
+ * @since 0.5.14
+ */
+export declare type ArtisnDBQueryDocumentSnapshot<T = ArtisnDBDocumentData> = firebase.firestore.QueryDocumentSnapshot<T>;
+/**
+ * An Artisn DB collection of nodes.
+ *
+ * @typedef ArtisnDBCollectionReference
+ * @since 0.5.14
+ */
+export declare type ArtisnDBCollectionReference<T = ArtisnDBDocumentData> = firebase.firestore.CollectionReference<T>;

package/build/types/artisnDB.types.js

@@ -0,0 +1,4 @@
+"use strict";
+// Artisn DB types and interfaces
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=artisnDB.types.js.map

package/build/types/artisnDB.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"artisnDB.types.js","sourceRoot":"","sources":["../../src/types/artisnDB.types.ts"],"names":[],"mappings":";AAAA,iCAAiC"}

package/build/types/banner.types.d.ts

@@ -0,0 +1,97 @@
+import { CDNImage } from "./image.types";
+/**
+ * Representation of a Commerce Banner.
+ *
+ * @interface Banner
+ * @since 0.5.14
+ */
+export interface Banner {
+    /** Banner category id */
+    banner_category_id: number;
+    /** Banner description */
+    banner_description: string;
+    /** Banner qr code */
+    banner_qr_code: string;
+    /** Banner title */
+    banner_title: string;
+    /** Banner type, see {@link BannerType} */
+    banner_type: BannerType;
+    /** Banner image url */
+    banner_url: string | null;
+    /** Banner's benefits */
+    benefits: null;
+    /** Banner category id */
+    category_id: number;
+    /** Banner category name */
+    category_name: string;
+    /** Banner channel's id */
+    channel_id: number;
+    /** Banner coupon's code */
+    coupon: null;
+    /** Banner coupon's id */
+    coupon_id: string | null;
+    /** The base 64 image value, see {@link CDNImage} */
+    image_base64: CDNImage["base64"];
+    /** The bucket where the image is saved */
+    image_bucket: string | null;
+    /** he cloud where the banner is saved, see {@link CDNImage} */
+    image_cloud_front_url: CDNImage["cloudFrontUrl"];
+    /** Banner image's filename */
+    image_file_name: string;
+    /** The directory where the banner image is saved */
+    image_key: string;
+    /** The url where the banner image is saved */
+    image_url: string;
+    /** An array of banner images, see {@link BannerImage}  */
+    images: BannerImage[];
+    /** Banner product's id */
+    product_id: null;
+    /** Banner product's name */
+    product_name: null;
+    /** Banner's section */
+    section: null;
+    /** Banner's scope, see {@link BannerScope} */
+    scope: BannerScope;
+    /** Banner stores array */
+    stores: unknown[];
+    /** Banner vendor's id */
+    vendor_id: number;
+    /** Banner vendor's name */
+    vendor_name: string;
+}
+/**
+ * The possible values of the banner's type.
+ *
+ * @typedef BannerType
+ * @since 0.5.14
+ */
+export declare type BannerType = "INFO" | "URL" | "PRODUCT" | "COUPON";
+/**
+ * The possible values of the banner's scope.
+ *
+ * @typedef BannerScope
+ * @since 0.5.14
+ */
+export declare type BannerScope = "WEB" | "GLOBAL" | "APP";
+/**
+ * Representation of a Banner image.
+ *
+ * @interface BannerImage
+ * @since 0.5.14
+ */
+export interface BannerImage {
+    /** Banner's id */
+    id: number;
+    /** Banner image's filename */
+    file_name: string;
+    /** Banner image's filename */
+    image_file_name: string;
+    /** Banner image's directory */
+    image_key: string;
+    /** The url where the banner image is saved */
+    image_url: string;
+    /** Banner's position inside the banner images array */
+    position: number;
+    /** The url where the banner image is saved */
+    url: string;
+}

package/build/types/banner.types.js

@@ -0,0 +1,4 @@
+"use strict";
+// Banner types and interfaces
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=banner.types.js.map

package/build/types/banner.types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"banner.types.js","sourceRoot":"","sources":["../../src/types/banner.types.ts"],"names":[],"mappings":";AAAA,8BAA8B"}