@artisan-commerce/types 0.14.0-canary.4 → 0.14.0-canary.6

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.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)
 
 

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

@@ -1,3 +1,9 @@
+import { ARDocumentType, BODocumentType } from "./country.types";
+import { BRDocumentType, CLDocumentType } from "./country.types";
+import { CODocumentType, ECDocumentType } from "./country.types";
+import { PYDocumentType, PEDocumentType } from "./country.types";
+import { UYDocumentType, VEDocumentType } from "./country.types";
+import { USDocumentType } from "./country.types";
 /**
  * Representation of a generic object.
  *
@@ -12,9 +18,9 @@ export interface Objectify<T> {
  * The possible values of a document type.
  *
  * @typedef DocumentType
- * @since 0.5.14
+ * @since 0.1.0
  */
-export declare type DocumentType = "CI" | "RUC" | "PASSPORT";
+export declare type DocumentType = ARDocumentType | BODocumentType | BRDocumentType | CLDocumentType | CODocumentType | ECDocumentType | PYDocumentType | PEDocumentType | UYDocumentType | VEDocumentType | USDocumentType;
 /**
  * Representation of the country's summary.
  *

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

@@ -57,3 +57,87 @@ export interface CountryTax {
  * @see https://www.nationsonline.org/oneworld/country_code_list.htm for reference
  */
 export declare type CountryCode = "AR" | "BO" | "BR" | "CL" | "CO" | "EC" | "PY" | "PE" | "UY" | "VE" | "US";
+/**
+ * Default documents for all countries.
+ *
+ * @typedef CommonDocumentType
+ * @since 0.1.0
+ */
+export declare type CommonDocumentType = "PASSPORT";
+/**
+ * Argentina supported document types.
+ *
+ * @typedef ARDocumentType
+ * @since 0.1.0
+ */
+export declare type ARDocumentType = CommonDocumentType;
+/**
+ * Bolivia supported document types.
+ *
+ * @typedef BODocumentType
+ * @since 0.1.0
+ */
+export declare type BODocumentType = CommonDocumentType;
+/**
+ * Brasil supported document types.
+ *
+ * @typedef BRDocumentType
+ * @since 0.1.0
+ */
+export declare type BRDocumentType = CommonDocumentType;
+/**
+ * Chile supported document types.
+ *
+ * @typedef CLDocumentType
+ * @since 0.1.0
+ */
+export declare type CLDocumentType = CommonDocumentType;
+/**
+ * Colombia supported document types.
+ *
+ * @typedef CODocumentType
+ * @since 0.1.0
+ */
+export declare type CODocumentType = CommonDocumentType | "RUT" | "NIT" | "CE" | "CC";
+/**
+ * Ecuador supported document types.
+ *
+ * @typedef ECDocumentType
+ * @since 0.1.0
+ */
+export declare type ECDocumentType = CommonDocumentType | "CI" | "RUC";
+/**
+ * Paraguay supported document types.
+ *
+ * @typedef PYDocumentType
+ * @since 0.1.0
+ */
+export declare type PYDocumentType = CommonDocumentType;
+/**
+ * Perú supported document types.
+ *
+ * @typedef PEDocumentType
+ * @since 0.1.0
+ */
+export declare type PEDocumentType = CommonDocumentType;
+/**
+ * Uruguay supported document types.
+ *
+ * @typedef UYDocumentType
+ * @since 0.1.0
+ */
+export declare type UYDocumentType = CommonDocumentType;
+/**
+ * Venezuela supported document types.
+ *
+ * @typedef VEDocumentType
+ * @since 0.1.0
+ */
+export declare type VEDocumentType = CommonDocumentType;
+/**
+ * United States supported document types.
+ *
+ * @typedef USDocumentType
+ * @since 0.1.0
+ */
+export declare type USDocumentType = CommonDocumentType;

package/build/types/order.types.d.ts

@@ -1,23 +1,41 @@
-import { BillTotalCategory } from "./shoppingCart.types";
+import { ShoppingCart } from "./shoppingCart.types";
 import { ShippingAddress } from "./shippingAddress.types";
 import { BillingData } from "./billingData.types";
+import { StepCategory, StepCode } from "./fulfillment.types";
+import { BaseUser } from "./user.types";
 /**
  * Representation of common properties of the order.
  *
  * @interface BaseOrder
- * @since 0.5.15
+ * @since 0.1.0
  */
 export interface BaseOrder {
     /** Order unique identifier */
     id: number;
-    /** Order additional info */
-    additionalInfo: any[];
+    /** Account unique identifier */
+    accountId: number;
+    /** Order additional info, see {@link OrderAdditionalInfo} */
+    additionalInfo: OrderAdditionalInfo;
+    /** User's order billing data' unique identifier */
+    billingDataByUserId: string;
     /** Order additional messages */
     additionalMessage: string | null;
-    /** Order allocation */
-    allocation: string;
+    /** Order allocation, see {@link Allocation} */
+    allocation: Allocation;
     /** Channel unique identifier */
     channelId: number;
+    /** Order channel name */
+    channelName: string;
+    /** Order comment */
+    comment: string;
+    /** Order hash */
+    hash: string;
+    /** Order issue unique identifier */
+    issueId: string;
+    /** Order pickup cook time */
+    pickupCooktime: string | null;
+    /** User's order shipping address' unique identifier */
+    shippingAddressByUserId: string;
     /** Order date, e.g.: `02 Aug 2021` */
     orderDate: string;
     /** Order time, e.g.: `17:00 am` */
@@ -31,97 +49,275 @@ export interface BaseOrder {
     /** Shopping cart associated with the order, see {@link OrderShoppingCart} */
     shoppingCart: OrderShoppingCart;
     /** Order step, see {@link OrderStep} */
-    step: OrderStep;
-    /** Step category */
-    stepCategory: string;
-    /** Step code */
-    stepCode: string;
+    step: number;
+    /** Step category, see {@link StepCategory} */
+    stepCategory: StepCategory;
+    /** Step code, see {@link StepCode} */
+    stepCode: StepCode;
     /** Step unique identifier */
     stepId: number;
     /** Step name */
     stepName: string;
+    /** User unique identifier */
+    uid: string;
+    /** Order user, see {@link OrderUser} */
+    user: OrderUser;
     /** Order transaction unique identifier */
     transactionId: number | null;
     /** Vendor unique identifier */
     vendorId: number;
+    /** Vendor name */
+    vendorName: string;
+    /** Order operator information, see {@link OperatorInformation} */
+    createdByOperator: OperatorInformation;
 }
 /**
  * The shopping cart associated with the order.
  *
  * @interface OrderShoppingCart
- * @since 0.5.15
+ * @since 0.1.0
+ * @extends {{@link ShoppingCart}
  */
-export interface OrderShoppingCart {
-    /** Order bill total category, see {@link BillTotalCategory} */
-    billTotal: BillTotalCategory;
+export interface OrderShoppingCart extends ShoppingCart {
+    /** Order shopping cart comment */
+    comment: string | null;
+    /** Order instructions */
+    instructions: string | null;
+    /** Order status unique identifier */
+    statusId: number;
+    /** Order issue unique identifier */
+    issueId: string | null;
+    /** Order invoice number */
+    invoiceNumber: string | null;
+    /** Order status name */
+    statusName: string;
+    /** Status code, see {@link StepCode} */
+    statusCode: StepCode;
+    /** Order payment status, see {@link OrderStatus} */
+    paymentStatus: OrderStatus;
     /**
      * An array of the order paid payment methods,
-     * see {@link OrderPaidPaymentMethod}
+     * see {@link OrderPaymentMethod}
      */
-    paidPaymentMethods: OrderPaidPaymentMethod[];
-    /** An array of order stores, see {@link OrderStore} */
-    stores: OrderStore[];
+    paidPaymentMethods: OrderPaymentMethod[] | null;
+    /** An array of order retries, see {@link OrderRetry} */
+    allRetries: OrderRetry[];
+    /**
+     * An array of the order rejected payment methods,
+     * see {@link OrderPaymentMethod}
+     */
+    rejectedPaymentMethods: OrderPaymentMethod[] | null;
 }
 /**
- * Store associated with the order.
+ * Order common fields.
  *
- * @interface OrderStore
- * @since 0.5.15
+ * @interface OrderCommonFields
+ * @since 0.1.0
  */
-export interface OrderStore {
-    /**
-     * An array of products associated with the order,
-     * see {@link OrderProduct}
-     */
-    products: OrderProduct[];
-    /** Store name */
-    storeName: string;
+export interface OrderCommonFields {
+    /** Order amount **/
+    amount: string;
+    /** Order status **/
+    status: string;
+    /** Order created date **/
+    created_at: string;
+    /** Order update date **/
+    updated_at: string;
 }
 /**
- * Product associated with the order.
+ * The retry of the order.
  *
- * @interface OrderProduct
- * @since 0.5.15
+ * @interface OrderRetry
+ * @since 0.1.0
+ * @extends {{@link Status}, {@link OrderCommonFields}
+ */
+export interface OrderRetry extends Status, OrderCommonFields {
+    /** Order retry unique identifier */
+    id: number;
+    /** Order payment method id **/
+    payment_method_by_order_id: number;
+    /** Order retry reference **/
+    reference: string;
+    /** Order retry platform **/
+    platform: string;
+    /** Order retry user agent **/
+    user_agent: string;
+    /** Order retry ip address **/
+    ip_address: string;
+    /** Order retry request id **/
+    request_id: string;
+    /** Order retry process url **/
+    process_url: string;
+    /** Order payment method, see {@link PaymentMethodByOrder} **/
+    payment_method_by_order: PaymentMethodByOrder;
+    /** Order step, see {@link OrderStep} */
+    step: OrderStep;
+}
+/**
+ * The retry of the order.
+ *
+ * @interface PaymentMethodByOrder
+ * @since 0.1.0
+ * @extends {{@link Status}, {@link OrderCommonFields}
  */
-export interface OrderProduct {
-    /** Product unique identifier */
-    productId: number;
-    /** Product name */
-    productName: string;
+export interface PaymentMethodByOrder extends Status, OrderCommonFields {
+    /** Payment method by order unique identifier **/
+    id: number;
+    /** Order unique identifier **/
+    order_id: number;
+    /** Payment method id **/
+    payment_method_id: number;
+    /** Internal revenue service payment method id **/
+    sri_payment_method_id: number;
+    /** Order payment method, see {@link OrderRetryPaymentMethod} */
+    order: OrderRetryPaymentMethod;
 }
 /**
- * Paid payment methods associated with the order.
+ * Order retry payment method.
  *
- * @interface OrderPaidPaymentMethod
- * @since 0.5.15
+ * @interface OrderRetryPaymentMethod
+ * @since 0.1.0
  */
-export interface OrderPaidPaymentMethod {
-    /** Order paid payment methods */
-    payment_method_name: string;
-    /** Order last retry, see {@link OrderLastRetry} */
-    lastRetry: OrderLastRetry;
+export interface OrderRetryPaymentMethod extends Status {
+    /** Order retry payment method unique identifier **/
+    id: number;
+    /** User unique identifier associated with the order retry **/
+    uid: string;
+    /** Order retry billing data by user id **/
+    billing_data_by_user_id: string;
+    /** Order retry shopping cart id **/
+    shopping_cart_id: string;
+    /** Order retry latitude **/
+    latitude: string;
+    /** Order retry longitude **/
+    longitude: string;
+    /** Order payment status, {@link OrderStatus} **/
+    payment_status: OrderStatus;
+    /** Order retry step **/
+    step: number;
+    /** In soft order process */
+    insoft_order_process: string;
+    /** Order retry sent fulfillment **/
+    sent_fulfillment: string;
+    /** Order retry account id **/
+    account_id: number;
+    /** Order retry sequence value **/
+    seq_val: string;
+    /** Order retry vendor id **/
+    vendor_id: number;
+    /** Order retry channel id **/
+    channel_id: number;
+    /** Order retry created date **/
+    created_at: string;
+    /** Order retry update date **/
+    updated_at: string;
+    /** Order retry allocation, see {@link Allocation} **/
+    allocation: Allocation;
+    /** Order retry suborder, see {@link Suborder}  **/
+    suborders: Suborder[];
 }
 /**
- * The last retry of the order.
+ * Representation of a order status.
  *
- * @interface OrderLastRetry
- * @since 0.5.15
+ * @interface Status
+ * @since 0.1.0
  */
-export interface OrderLastRetry {
-    /** Order last retry step */
-    step: OrderStep;
+export interface Status {
+    /** Status unique identifier **/
+    status_id: number;
+    /** Status name **/
+    status_name: string;
+    /** Status code **/
+    status_code: string;
+    /** Status category **/
+    status_category: string;
+}
+/**
+ * Representation of a suborder object.
+ *
+ * @interface Suborder
+ * @since 0.1.0
+ * @extends {{@link Status}
+ */
+export interface Suborder extends Status {
+    /** Suborder unique identifier **/
+    id: number;
+    /** Suborder store unique identifier **/
+    store_id: number;
+    /** Suborder store unique identifier **/
+    store_name: string;
+    /** Suborder order id **/
+    order_id: number;
+    /** Suborder digital command sent **/
+    digital_command_sent: string;
+    /** Suborder vendor **/
+    vendor: string;
+    /** Suborder additional information **/
+    additional_info: string;
+    /** Suborder creation date**/
+    created_at: string;
+    /** Suborder update date **/
+    updated_at: string;
 }
 /**
  * The step where the order is located.
  *
  * @interface OrderStep
- * @since 0.5.15
+ * @since 0.1.0
  */
 export interface OrderStep {
-    /** Step title to use on front end */
+    /** Order step title to use on front end */
     title_frontend: string;
-    /** Step description to use on front end */
+    /** Order step description to use on front end */
     description_frontend: string;
+    /** Order step unique identifier */
+    id: number;
+    /** Order step name */
+    name: string;
+    /** Order step code */
+    code: string;
+    /** Order step description */
+    description: string;
+    /** Order step category */
+    category: string;
+    /** Order step subtitle to use on front end */
+    subtitle_frontend: string;
+    /** Order step color */
+    color: string;
+    /** Order step additional information, see {@link OrderStepAdditionalInfo} */
+    additional_info: OrderStepAdditionalInfo;
+}
+/**
+ * Order step additional information.
+ *
+ * @interface OrderStepAdditionalInfo
+ * @since 0.1.0
+ */
+export interface OrderStepAdditionalInfo {
+    /** Whether or not to use the client on front end */
+    client_frontend: boolean;
+    /** Whether or not to use the operators on front end */
+    operators_frontend: boolean;
+    /** Whether or not to use the client has an error on front end */
+    client_frontend_error: boolean;
+    /** Order additional information group, see {@link OrderStepAdditionalInfoGroup}  */
+    group: OrderStepAdditionalInfoGroup;
+}
+/**
+ * Order step additional information group.
+ *
+ * @interface OrderStepAdditionalInfoGroup
+ * @since 0.1.0
+ */
+export interface OrderStepAdditionalInfoGroup {
+    /** Order additional information group code */
+    code: string;
+    /** Order additional information group description */
+    description: string;
+    /** Order additional information group weight */
+    weight: string;
+    /** Order additional information group type */
+    type: string;
 }
 /**
  * The details of the order.
@@ -155,3 +351,179 @@ export interface OrderDetailShippingCost {
  * @since 0.5.15
  */
 export declare type Order = BaseOrder | OrderDetails;
+/**
+ * Order shipping metadata base field.
+ *
+ * @interface BaseField
+ * @since 0.1.0
+ */
+export interface BaseField {
+    /** Base field unique identifier */
+    id: number;
+    /** Base field name */
+    name: string;
+}
+/**
+ * Order shipping metadata zip code base field.
+ *
+ * @interface ZipCodeField
+ * @since 0.1.0
+ * @extends {{@link BaseField}
+ */
+export interface ZipCodeField extends BaseField {
+    /** Base field zip code */
+    zipCode: string;
+}
+/**
+ * Order injection field.
+ *
+ * @interface Injection
+ * @since 0.1.0
+ * @property {InjectionDetail} [key: string] object with key as string
+ * and value as InjectionDetail
+ */
+export interface Injection {
+    [key: string]: InjectionDetail;
+}
+/**
+ * Order injection detail field.
+ *
+ * @interface InjectionDetail
+ * @since 0.1.0
+ */
+export interface InjectionDetail {
+    /**
+     * Order injection detail cause,
+     * property is purposefully named in spanish
+     */
+    causa: string;
+    /**
+     * Order injection detail code
+     * property is purposefully named in spanish
+     */
+    codigo: number;
+    /**
+     * Order injection detail message
+     * property is purposefully named in spanish
+     * */
+    mensaje: string;
+}
+/**
+ * Order integration message.
+ *
+ * @interface IntegrationMessage
+ * @since 0.1.0
+ */
+export interface IntegrationMessage {
+    /** Order injection, see {@link Injection} */
+    kfcInjection: Injection;
+}
+/**
+ * Order shipping metadata.
+ *
+ * @interface MetadataShipping
+ * @since 0.1.0
+ */
+export interface MetadataShipping {
+    /** Order shipping area, see {@link BaseField} */
+    area: BaseField;
+    /** Order shipping city, see {@link BaseField} */
+    city: BaseField;
+    /** Order shipping zone, see {@link ZipCodeField} */
+    zone: ZipCodeField;
+    /** Order shipping store, see {@link BaseField} */
+    store: BaseField;
+    /** Order shipping country, see {@link BaseField} */
+    country: BaseField;
+}
+/**
+ * Order additional info.
+ *
+ * @interface OrderAdditionalInfo
+ * @since 0.1.0
+ */
+export interface OrderAdditionalInfo {
+    /** Order auth provider */
+    providerAuth: string | null;
+    /** Order metadata shipping, see {@link MetadataShipping} */
+    metadataShipping: MetadataShipping;
+    /** Order integration messages, see {@link IntegrationMessage} */
+    integrationMessages: IntegrationMessage;
+    /** Order parent shipping cart */
+    parentShoppingCart: boolean;
+}
+/**
+ * Order allocation options.
+ *
+ * @typedef Allocation
+ * @since 0.1.0
+ */
+export declare type Allocation = "PICKUP_TO_GO" | "PICKUP_IN_PLACE" | "DELIVERY";
+/**
+ * Order user.
+ *
+ * @interface OrderUser
+ * @since 0.1.0
+ * @extends {{@link BaseUser}
+ */
+export interface OrderUser extends BaseUser {
+    /** Order user settings, see {@link NotificationSettings} */
+    settings: NotificationSettings;
+}
+/**
+ * Order user notification settings.
+ *
+ * @interface NotificationSettings
+ * @since 0.1.0
+ */
+export interface NotificationSettings {
+    /** Whether or not the user has email notifications enabled */
+    emailNotifications: boolean;
+    /** Whether or not the user has push notifications enabled */
+    pushNotifications: boolean;
+}
+/**
+ * Order operator information.
+ *
+ * @interface OperatorInformation
+ * @since 0.1.0
+ */
+export interface OperatorInformation {
+    /** Operator unique identifier */
+    id: string;
+    /** Operator name */
+    name: string;
+    /** Operator email */
+    email: string;
+    /** Operator skill */
+    skill: string;
+    /** Operator document */
+    document: string;
+}
+/**
+ * Order payment method.
+ *
+ * @interface OrderPaymentMethod
+ * @since 0.1.0
+ */
+export interface OrderPaymentMethod {
+    /** Order payment method id */
+    payment_method_id: number;
+    /** Order payment method name */
+    payment_method_name: string;
+    /** Order total by payment method */
+    total: string;
+    /** Order status, see {@link OrderStatus} */
+    status: OrderStatus;
+    /** Order payment method last retry, see {@link OrderRetry}  */
+    lastRetry: OrderRetry;
+    /** Order step, see {@link OrderStep}  */
+    step: OrderStep;
+}
+/**
+ * Order status.
+ *
+ * @typedef OrderStatus
+ * @since 0.1.0
+ */
+export declare type OrderStatus = "APPROVED" | "REJECTED" | "PENDING";

package/build/types/shippingAddress.types.d.ts

@@ -21,10 +21,16 @@ export interface BaseShippingAddress {
     number: string;
     /** Shipping address' secondary street */
     secondaryStreet: string;
-    /** Shipping address' reference */
-    addressReference: string;
     /** It contains country id and country name, see {@link CountrySummary} */
     country: CountrySummary;
+    /** Shipping address' update date  */
+    updatedAt?: string;
+    /** Shipping address' creation date */
+    createdAt: string;
+    /** Shipping address' nickname */
+    nickname: string;
+    /** Shipping address' number contact address */
+    numberContactAddress: string;
 }
 /**
  * Representation of a Commerce Shipping Address.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@artisan-commerce/types",
   "description": "Artisn's types and interfaces library",
-  "version": "0.14.0-canary.4",
+  "version": "0.14.0-canary.6",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",
   "files": [
@@ -42,5 +42,5 @@
     "prettier": "^2.1.2",
     "webpack-bundle-analyzer": "^3.9.0"
   },
-  "gitHead": "f4abe618634cd11424484eaf7e0422fc97b615e8"
+  "gitHead": "b1b59c5298c8d01599287be797a956078821728d"
 }