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

package/build/types/billingData.types.d.ts

@@ -0,0 +1,39 @@
+import { CountrySummary } from "./common.types";
+import { DocumentType } from "./common.types";
+/**
+ * Representation of a Commerce Billing Data.
+ *
+ * @interface BillingData
+ * @since 0.5.14
+ */
+export interface BaseBillingData {
+    /** Billing's nickname */
+    nickname: string;
+    /** Billing's associated user complete name */
+    name: string;
+    /** Billing's associated document type, see {@link DocumentType} */
+    documentType: DocumentType;
+    /** Billing's associated document */
+    document: string;
+    /** Billing's associated user address */
+    address: string;
+    /** Billing's associated user phone without country calling code */
+    phone: string;
+    /** Billing's associated user email */
+    email: string;
+    /** Whether or not the billing is default */
+    default: boolean;
+    /** It contains country id and country name, see {@link CountrySummary} */
+    country: CountrySummary;
+}
+/**
+ * Representation of a billing data saved on a database.
+ *
+ * @interface BillingData
+ * @since 0.5.14
+ * @extends {{@link BaseBillingData}
+ */
+export interface BillingData extends BaseBillingData {
+    /** Billing's auto generated id */
+    id: number;
+}

package/build/types/billingData.types.js

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

package/build/types/billingData.types.js.map

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

package/build/types/catalogue.types.d.ts

@@ -0,0 +1,16 @@
+/**
+ * Representation of a Commerce Catalogue.
+ *
+ * @interface Catalogue
+ * @since 0.5.14
+ */
+export interface Catalogue {
+    /** Catalogue's id */
+    catalogueId: string;
+    /** Catalogue's name */
+    name: string;
+    /** Whether or not the catalogue is active */
+    active: boolean;
+    /** Catalogue's friendly name to use on front end */
+    friendlyName?: string;
+}

package/build/types/catalogue.types.js

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

package/build/types/catalogue.types.js.map

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

package/build/types/category.types.d.ts

@@ -0,0 +1,33 @@
+import { CDNImage } from "./image.types";
+import { BaseProduct } from "./product.types";
+/**
+ * Representation of a Commerce Category.
+ *
+ * @interface Category
+ * @since 0.5.14
+ */
+export interface Category {
+    /** Category's id */
+    categoryId: number;
+    /** Category's name */
+    name: string;
+    /** Category image's array, see {@link CDNImage} */
+    images: CDNImage[];
+    /** Whether or not to display the category */
+    displayInMenu: boolean;
+    /** Whether or not the category should be reloaded */
+    reload: boolean;
+    /** Whether or not the category has subcategories */
+    subcategories: boolean;
+}
+/**
+ * Representation of a category which contains several base products.
+ *
+ * @interface CategoryWithProducts
+ * @since 0.5.14
+ * @extends {{@link Category}
+ */
+export interface CategoryWithProducts extends Category {
+    /** Array of base products associated with a category, see {@link BaseProduct} */
+    products: BaseProduct[];
+}

package/build/types/category.types.js

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

package/build/types/category.types.js.map

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

package/build/types/common.types.d.ts

@@ -0,0 +1,36 @@
+/**
+ * Representation of a generic object.
+ *
+ * @interface Objectify<T>
+ * @since 0.5.14
+ * @property {T} [key: string] object key
+ */
+export interface Objectify<T> {
+    [key: string]: T;
+}
+/**
+ * The possible values of a document type.
+ *
+ * @typedef DocumentType
+ * @since 0.5.14
+ */
+export declare type DocumentType = "CI" | "RUC" | "PASSPORT";
+/**
+ * Representation of the country's summary.
+ *
+ * @interface CountrySummary
+ * @since 0.5.14
+ */
+export interface CountrySummary {
+    /** Country's id */
+    id: number;
+    /** Country's name */
+    name: string;
+}
+/**
+ * The possible values of a week day.
+ *
+ * @typedef BaseWeekDay
+ * @since 0.5.14
+ */
+export declare type BaseWeekDay = "MONDAY" | "TUESDAY" | "WEDNESDAY" | "THURSDAY" | "FRIDAY" | "SATURDAY" | "SUNDAY";

package/build/types/common.types.js

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

package/build/types/common.types.js.map

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

package/build/types/country.types.d.ts

@@ -0,0 +1,51 @@
+/**
+ * Representation of a Commerce Country.
+ *
+ * @interface Country
+ * @since 0.5.14
+ */
+export interface Country {
+    /** Country's id */
+    countryId: string;
+    /** Country's name */
+    name: string;
+    /** Country ISO code, e.g.: EC */
+    code: string;
+    /** Whether or not the country is active */
+    active: boolean;
+    /**
+     * Object which contains information about country's currency,
+     *  see {@link CountryCurrency}
+     */
+    currency: CountryCurrency;
+    /** Array of taxes usually applied on the country, see {@link CountryTax} */
+    taxes: CountryTax[];
+}
+/**
+ * Representation of a country's currency.
+ *
+ * @interface CountryCurrency
+ * @since 0.5.14
+ */
+export interface CountryCurrency {
+    /** Currency's id */
+    currencyId: string;
+    /**  Currency's name */
+    name: string;
+    /** Currency's symbol */
+    sign: string;
+}
+/**
+ * Representation of a country's tax.
+ *
+ * @interface CountryTax
+ * @since 0.5.14
+ */
+export interface CountryTax {
+    /** Tax name */
+    tax: string;
+    /** Value added tax rate */
+    vatRate: string;
+    /** Tax percentage */
+    percentage: number;
+}

package/build/types/country.types.js

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

package/build/types/country.types.js.map

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

package/build/types/coupon.types.d.ts

@@ -0,0 +1,112 @@
+import { ArtisnDBCollectionReference } from "./artisnDB.types";
+import { ArtisnDBQueryDocumentSnapshot } from "./artisnDB.types";
+import { ArtisnDBDocumentData } from "./artisnDB.types";
+import { CDNImage } from "./image.types";
+/**
+ * Wallet user information.
+ *
+ * @interface Wallet
+ * @since 0.5.14
+ */
+export interface Wallet {
+    /** {@link Benefit}'s array from firestore user wallet */
+    benefits: Benefit[];
+}
+/**
+ * Benefit information.
+ *
+ * @interface Benefit
+ * @since 0.5.14
+ */
+export interface Benefit {
+    /** The user wallet id */
+    hash: string;
+    /** The benefit awards, see {@link Award} */
+    award: Award;
+    /** Benefit id */
+    benefitId: number;
+    /** Benefit wallet id */
+    benefitWalletId: number;
+    /** Benefit code in back-end */
+    code: null;
+    /** Combined */
+    combined: string;
+    /** Benefit creation date */
+    createdAt: string;
+    /** Benefit description */
+    description: string;
+    /** Benefit discount percentage */
+    discountPercentage: number;
+    /** Benefit expiration date */
+    expirationDate: string;
+    /** External benefit id */
+    externalId: null;
+    /** Benefit images, see {@link CDNImage} */
+    image: CDNImage[];
+    /** The award limit */
+    limitAward: null;
+    /** The benefit limit */
+    limitBenefit: number;
+    /** The logic operator of the benefit */
+    logicOperator: string;
+    /** Benefit stock */
+    quantity: number;
+    /** The rules of the benefit */
+    rules: any[];
+    /** The benefit title */
+    title: string;
+    /** Benefit type, see {@link BenefitTypes} */
+    type: BenefitTypes;
+    /** Benefit update date */
+    updatedAt: string;
+    /** The channel id of the benefit */
+    channelId: number;
+    /** The vendor id of the benefit */
+    vendorId: number;
+    /** The account id of the benefit */
+    accountId: number;
+}
+/**
+ * Award information.
+ *
+ * @interface Award
+ * @since 0.5.14
+ */
+export interface Award {
+    /** The id of the award */
+    id: number;
+    /** The id of the benefit */
+    benefitId: number;
+    /** Benefit discount percentage */
+    discountPercentage: number;
+    /** Benefit discount value */
+    discountValue: null;
+}
+/**
+ * Applied benefit array in shopping cart.
+ *
+ * @typedef ShoppingCartBenefits
+ * @since 0.5.14
+ */
+export declare type ShoppingCartBenefits = Benefit[];
+/**
+ * A benefit DB node from a user.
+ *
+ * @typedef BenefitsByUserNode
+ * @since 0.5.14
+ */
+export declare type BenefitsByUserNode = ArtisnDBQueryDocumentSnapshot<ArtisnDBDocumentData>;
+/**
+ * The complete collection of benefits DB nodes from a user.
+ *
+ * @typedef BenefitsByUserNodes
+ * @since 0.5.14
+ */
+export declare type BenefitsByUserNodes = ArtisnDBCollectionReference<ArtisnDBDocumentData>;
+/**
+ * The possible values of the benefit type.
+ *
+ * @typedef BenefitTypes
+ * @since 0.5.14
+ */
+export declare type BenefitTypes = "ALTER_DELIVERY" | "PRODUCT" | "DISCOUNT";

package/build/types/coupon.types.js

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

package/build/types/coupon.types.js.map

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

package/build/types/currency.types.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Artisn's supported currency codes.
+ *
+ * @typedef CurrencyCodes
+ * @since 0.5.14
+ */
+export declare type CurrencyCodes = "USD" | "ARS" | "COP" | "CLP" | "VES";

package/build/types/currency.types.js

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

package/build/types/currency.types.js.map

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

package/build/types/fulfillment.types.d.ts

@@ -0,0 +1,218 @@
+/**
+ * Fulfillment workflow.
+ *
+ * @interface Workflow
+ * @since 0.5.15
+ */
+export interface Workflow {
+    /** Workflow description */
+    description: string;
+    /** Workflow unique identifier */
+    id: number;
+    /** Workflow name */
+    name: string;
+    /** An array of workflow steps, see {@link StepWorkflow}  */
+    steps: StepWorkflow[];
+    /** An array of webhook workflows, see {@link WebhookWorkflow} */
+    webhooks: WebhookWorkflow[];
+}
+/**
+ * The possible values of the step category.
+ *
+ * @typedef StepCategory
+ * @since 0.5.15
+ */
+export declare type StepCategory = "TO_DO" | "PAYMENT_IN_PROGRESS" | "IN_PROGRESS" | "DONE";
+/**
+ * The possible values of the step code.
+ *
+ * @typedef StepCode
+ * @since 0.5.15
+ */
+export declare type StepCode = "START" | "IN_PROGRESS" | "ORDERED" | "RECEIVED" | "TO_ASSIGN" | "ASSIGNED" | "ON_ROUTE" | "DISPATCHED" | "CANCELED" | "ERROR";
+/**
+ * The notification associated with the step.
+ *
+ * @interface StepNotification
+ * @since 0.5.15
+ */
+export interface StepNotification {
+    /** Whether or not to send mail when reaching this step */
+    send_mail: boolean;
+    /** Whether or not to send push when reaching this step */
+    send_push: boolean;
+}
+/**
+ * The step where the workflow is located.
+ *
+ * @interface StepWorkflow
+ * @since 0.5.15
+ */
+export interface StepWorkflow {
+    /** Step workflow additional info, see {@link StepWorkflowAdditionalInfo} */
+    additional_info: StepWorkflowAdditionalInfo;
+    /** Step workflow category, , see {@link StepCategory} */
+    category: StepCategory;
+    /** Step workflow code, , see {@link StepCode} */
+    code: StepCode;
+    /** Step workflow color */
+    color: string;
+    /** Step workflow description */
+    description: string;
+    /** Step workflow description to use on front end */
+    description_frontend: string | null;
+    /** Step workflow id */
+    id: number;
+    /** Step workflow name */
+    name: string;
+    /** Step workflow subtitle to use on front end */
+    subtitle_frontend: string | null;
+    /** Step workflow title to use on front end */
+    title_frontend: string | null;
+    /** Step workflow transitions, see {@link TransitionWorkflow} */
+    transitions: TransitionWorkflow[];
+    /** Step notification, see {@link StepNotification} */
+    notification: StepNotification;
+}
+/**
+ * Step workflow additional info.
+ *
+ * @interface StepWorkflowAdditionalInfo
+ * @since 0.5.15
+ */
+export interface StepWorkflowAdditionalInfo {
+    /** Whether or not to use the step workflow client on front end */
+    client_frontend: boolean;
+    /** Step workflow group, see {@link StepWorkflowGroup} */
+    group: StepWorkflowGroup;
+    /** Whether or not to use the step workflow operators to use on front end */
+    operators_frontend: boolean;
+}
+/**
+ * Step workflow group.
+ *
+ * @interface StepWorkflowGroup
+ * @since 0.5.15
+ */
+export interface StepWorkflowGroup {
+    /** Group code, see {@link StepCode} */
+    code: StepCode;
+    /** Group description */
+    description: string;
+    /** Group type */
+    type: "default";
+    /** Group weight */
+    weight: string;
+}
+/**
+ * The possible transitions of the workflow.
+ *
+ * @interface TransitionWorkflow
+ * @since 0.5.15
+ */
+export interface TransitionWorkflow {
+    /** Channel unique identifier */
+    channel_id: number;
+    /** Transition workflow conditions  */
+    conditions: any[];
+    /** Transition workflow description */
+    description: string;
+    /** The step id where the transition comes from */
+    from_step_id: number;
+    /** Transition workflow unique identifier */
+    id: number;
+    /** Transition workflow name */
+    name: string;
+    /** The step id where the transition can go */
+    to_step_id: number;
+    /** Vendor unique identifier */
+    vendor_id: number;
+}
+/**
+ * Workflow webhook.
+ *
+ * @interface WebhookWorkflow
+ * @since 0.5.15
+ */
+export interface WebhookWorkflow {
+    /** Webhook workflow unique identifier */
+    id: number;
+    /** Webhook workflow method type  */
+    method: string;
+    /** Webhook workflow url */
+    url: string;
+}
+/**
+ * Representation of a Issue object.
+ *
+ * @interface Issue
+ * @since 0.5.15
+ */
+export interface IssueAdditionalInfo {
+    /** User unique identifier */
+    uid: string;
+    /** Array of stores id */
+    stores: number[];
+}
+/**
+ * Representation of a Issue history.
+ *
+ * @interface Issue
+ * @since 0.5.15
+ */
+export interface IssueHistory {
+    /** History unique identifier */
+    id: number;
+    /** Transition unique identifier  */
+    transition_id: number;
+    /** Step unique identifier */
+    step_id: number;
+    /** Step name */
+    step_name: string;
+    /** History additional info, see {@link IssueAdditionalInfo} */
+    additional_info: IssueAdditionalInfo;
+    /** History conditions  */
+    conditions: any[];
+    /** History creation Date */
+    created_at: string;
+    /** History finished Date */
+    finished_at: string;
+}
+/**
+ * Representation of a Issue object.
+ *
+ * @interface Issue
+ * @since 0.5.15
+ */
+export interface Issue {
+    /** Issue unique identifier */
+    id: number;
+    /** Client issue unique identifier */
+    client_issue_id: string;
+    /** Workflow unique identifier */
+    workflow_id: number;
+    /** Parent issue unique identifier */
+    parent_issue_id: null;
+    /** Related issue unique identifier */
+    related_issue_id: null;
+    /** Step unique identifier */
+    step_id: number;
+    /** The step where the issue is located */
+    step: StepWorkflow;
+    /** Account unique identifier */
+    account_id: number;
+    /** Vendor unique identifier */
+    vendor_id: number;
+    /** Children issues */
+    children: any[];
+    /** Related issues */
+    related: any[];
+    /** Issue conditions */
+    conditions: any[];
+    /** Issue additional info, see {@link IssueAdditionalInfo} */
+    additional_info: IssueAdditionalInfo;
+    /** Issue history, see {@link IssueHistory} */
+    history: IssueHistory[];
+    /** Transaction unique identifier  */
+    transaction_id: number | null;
+}

package/build/types/fulfillment.types.js

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

package/build/types/fulfillment.types.js.map

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

package/build/types/http.types.d.ts

@@ -0,0 +1,64 @@
+/**
+ * Representation of a Artisn request.
+ *
+ * @interface ArtisnRequest
+ * @since 0.5.14
+ */
+export interface ArtisnRequest {
+    /** Request's url */
+    url: string;
+    /** Request's headers, see {@link ArtisnRequestHeaders} */
+    headers: ArtisnRequestHeaders;
+    /** Request's body, see {@link ArtisnRequestBody} */
+    body: ArtisnRequestBody;
+    /** Request's query, see {@link ArtisnQuery} */
+    query: ArtisnQuery;
+    /** Request's params, see {@link ArtisnParams} */
+    params: ArtisnParams;
+    /** Request's method, see {@link ArtisnRequestMethod} */
+    method?: ArtisnRequestMethod;
+}
+/**
+ * Artisn request headers based on the fetch API.
+ *
+ * @typedef ArtisnRequestHeaders
+ * @since 0.5.14
+ */
+export declare type ArtisnRequestHeaders = Headers;
+/**
+ * Allowed methods for requests.
+ *
+ * @typedef ArtisnRequestMethod
+ * @since 0.5.14
+ */
+export declare type ArtisnRequestMethod = "POST" | "GET" | "PUT" | "DELETE" | "PATCH";
+/**
+ * Artisn request's body.
+ *
+ * @interface ArtisnRequestBody
+ * @since 0.5.14
+ * @property {any} [key:string] Object with key-value pairs
+ */
+export interface ArtisnRequestBody {
+    [key: string]: any;
+}
+/**
+ * Artisn request's body.
+ *
+ * @interface ArtisnQuery
+ * @since 0.5.14
+ * @property {string | number | boolean} [key:string] Object with key-value pairs
+ */
+export interface ArtisnQuery {
+    [key: string]: string | number | boolean;
+}
+/**
+ * Artisn request's params.
+ *
+ * @interface ArtisnParams
+ * @since 0.5.14
+ * @property {string | number} [key:string] Object with key-value pairs
+ */
+export interface ArtisnParams {
+    [key: string]: string | number;
+}

package/build/types/http.types.js

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

package/build/types/http.types.js.map

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