@artisan-commerce/types 0.14.0-canary.2 → 0.14.0-canary.21

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

@@ -1,51 +0,0 @@
-/**
- * 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

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

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

@@ -1 +0,0 @@
-{"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

@@ -1,112 +0,0 @@
-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

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

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

@@ -1 +0,0 @@
-{"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

@@ -1,7 +0,0 @@
-/**
- * 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

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

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

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

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

@@ -1,218 +0,0 @@
-/**
- * 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

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

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

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

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

@@ -1,64 +0,0 @@
-/**
- * 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

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

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

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

package/build/types/image.types.d.ts

@@ -1,82 +0,0 @@
-/**
- * Representation of a image allocated in a CDN.
- *
- * @interface CDNImage
- * @since 0.5.14
- */
-export interface CDNImage {
-    /** The bucket where the image is located */
-    bucket?: string;
-    /** The cloud where the image is saved */
-    cloudFrontUrl?: string;
-    /** The directory where the image is saved */
-    key?: string;
-    /** Image's name */
-    name: string;
-    /** The url where the image is saved */
-    url: string;
-    /** The base 64 image value */
-    base64?: string;
-}
-/**
- * A image url.
- *
- * @typedef URLImage
- * @since 0.5.14
- */
-export declare type URLImage = string;
-/**
- * Configuration on how to setup the cloudfront image manipulation.
- *
- * @since 0.5.14
- * @interface ImageManipulationConfig
- */
-export interface ImageManipulationConfig {
-    /** Image's width */
-    width?: number;
-    /** Image's height */
-    height?: number;
-    /** Determines how to resize the image, see {@link ImageFit} */
-    fit?: ImageFit;
-    /**
-     * Determines in which format the resulting image must be,
-     * see {@link ImageToFormat}
-     */
-    toFormat?: ImageToFormat;
-}
-/**
- * Representation of a Commerce Image which could be a
- * {@link CDNImage} or a {@link URLImage}.
- *
- * @typedef Image
- * @since 0.5.14
- */
-export declare type Image = CDNImage | URLImage;
-/**
- * Contains different properties on how to resize the image.
- *
- * @typedef ImageFit
- * @since 0.5.14
- */
-export declare type ImageFit = "fill" | "cover" | "contain" | "inside" | "outside";
-/**
- * Contains different image formats.
- *
- * @typedef ImageToFormat
- * @since 0.5.14
- */
-export declare type ImageToFormat = "jpg" | "jpeg" | "png" | "svg";
-/**
- * Random image configuration.
- *
- * @since 0.5.15
- * @interface RandomImageConfig
- */
-export interface RandomImageConfig {
-    /** A word which will be used to generate the random image */
-    query?: string | undefined;
-    /** The width to be used to generate the random image */
-    width?: number;
-    /** The height to be used to generate the random image */
-    height?: number;
-}

package/build/types/image.types.js

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

package/build/types/image.types.js.map

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

package/build/types/livingPlace.types.d.ts

@@ -1,92 +0,0 @@
-/**
- * Representation of a living place base object.
- *
- * @interface BaseLivingPlace
- * @since 0.5.14
- */
-export interface BaseLivingPlace {
-    /** Living place's id */
-    id: number;
-}
-/**
- * Representation of a living place.
- *
- * @interface LivingPlace
- * @since 0.5.14
- * @extends {{@link BaseLivingPlace}
- */
-export interface LivingPlace extends BaseLivingPlace {
-    /** Living place's name  */
-    name: string;
-    /** Whether or not the living place is active */
-    active: number;
-    /** Country unique identifier */
-    countryId: number;
-    /** Array of fields required to save a living place, see {@link Field} */
-    fields: Field[];
-}
-/**
- * Representation of a living place which will be saved.
- *
- * @interface LivingPlaceToSave
- * @since 0.5.14
- * @extends {{@link BaseLivingPlace}
- */
-export interface LivingPlaceToSave extends BaseLivingPlace {
-    /** Array of fields to be saved, see {@link FieldRecord} */
-    fields: FieldRecord[];
-}
-/**
- * Representation of a field object.
- *
- * @interface Field
- * @since 0.5.14
- */
-export interface Field {
-    /** Field's id */
-    id: string;
-    /** Field's label */
-    label: string;
-    /** Field's rules, see {@link Rules} */
-    rules: Rule;
-    /** Field's messages based on rules, see {@link Messages} */
-    messages: Message;
-    /** Field's value */
-    value?: string;
-}
-/**
- * Representation of a field record.
- *
- * @interface FieldRecord
- * @since 0.5.14
- */
-export interface FieldRecord {
-    /** Field record's id */
-    id: string;
-    /** Field record's value */
-    value: string;
-}
-/**
- * Messages for living places.
- *
- * @interface Message
- * @since 0.5.14
- */
-export interface Message {
-    /** The maximum number's message of allowed living places */
-    max: string;
-    /** The minimum number's message of allowed living places */
-    min: string;
-}
-/**
- * Rules for living places.
- *
- * @interface Rule
- * @since 0.5.14
- */
-export interface Rule {
-    /** The maximum number of allowed living places */
-    max: number;
-    /** The minimum number of allowed living places */
-    min: number;
-}

package/build/types/livingPlace.types.js

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

package/build/types/livingPlace.types.js.map

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