@artisan-commerce/builders 0.7.0-canary.5 → 0.7.0-canary.7

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.7.0-canary.7](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.6...@artisan-commerce/builders@0.7.0-canary.7) (2021-08-23)
+
+
+### Bug Fixes
+
+* **global:** add missing properties to order interfaces and types ([757157f](https://bitbucket.org/tradesystem/artisn_sdk/commit/757157fbb2dd25d04efc791cd9b9511e41685471))
+
+
+
+## [0.7.0-canary.6](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.5...@artisan-commerce/builders@0.7.0-canary.6) (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.7.0-canary.5](https://bitbucket.org/tradesystem/artisn_sdk/compare/@artisan-commerce/builders@0.7.0-canary.4...@artisan-commerce/builders@0.7.0-canary.5) (2021-08-12)
 
 

package/build/builders/common.builder.d.ts

@@ -1,5 +1,83 @@
-import { DocumentType } from "@artisan-commerce/types";
+import { CountryCode, DocumentType } from "@artisan-commerce/types";
+import { ARDocumentType, BODocumentType } from "@artisan-commerce/types";
+import { BRDocumentType, CLDocumentType } from "@artisan-commerce/types";
+import { CODocumentType, ECDocumentType } from "@artisan-commerce/types";
+import { PYDocumentType, PEDocumentType } from "@artisan-commerce/types";
+import { UYDocumentType, VEDocumentType } from "@artisan-commerce/types";
+import { USDocumentType, CommonDocumentType } from "@artisan-commerce/types";
 import { CountrySummary, RandomImageConfig } from "@artisan-commerce/types";
+/**
+ * Default document types for all countries.
+ *
+ * @since 0.1.0
+ */
+export declare const commonDocumentTypes: CommonDocumentType[];
+/**
+ * Argentina supported document types.
+ *
+ * @since 0.1.0
+ */
+export declare const ARDocumentTypes: ARDocumentType[];
+/**
+ * Bolivia supported document types.
+ *
+ * @since 0.1.0
+ */
+export declare const BODocumentTypes: BODocumentType[];
+/**
+ * Brasil supported document types.
+ *
+ * @since 0.1.0
+ */
+export declare const BRDocumentTypes: BRDocumentType[];
+/**
+ * Chile supported document types.
+ *
+ * @since 0.1.0
+ */
+export declare const CLDocumentTypes: CLDocumentType[];
+/**
+ * Colombia supported document types.
+ *
+ * @since 0.1.0
+ */
+export declare const CODocumentTypes: CODocumentType[];
+/**
+ * Ecuador supported document types.
+ *
+ * @since 0.1.0
+ */
+export declare const ECDocumentTypes: ECDocumentType[];
+/**
+ * Paraguay supported document types.
+ *
+ * @since 0.1.0
+ */
+export declare const PYDocumentTypes: PYDocumentType[];
+/**
+ * Perú supported document types.
+ *
+ * @since 0.1.0
+ */
+export declare const PEDocumentTypes: PEDocumentType[];
+/**
+ * Uruguay supported document types.
+ *
+ * @since 0.1.0
+ */
+export declare const UYDocumentTypes: UYDocumentType[];
+/**
+ * Venezuela supported document types.
+ *
+ * @since 0.1.0
+ */
+export declare const VEDocumentTypes: VEDocumentType[];
+/**
+ * United States supported document types.
+ *
+ * @since 0.1.0
+ */
+export declare const USDocumentTypes: USDocumentType[];
 /**
  * Generates a random password.
  *
@@ -150,8 +228,9 @@ export declare const genDocument: (digits: number) => string;
  * Generates a random document type.
  *
  * @since 0.5.14
+ * @param {string} countryISOCode Country calling code
  */
-export declare const genDocumentType: () => DocumentType;
+export declare const genDocumentType: (countryISOCode?: CountryCode) => DocumentType;
 /**
  * Generates a random mobile phone with the country code provided.
  *
@@ -202,3 +281,9 @@ export declare const chooseRandomEnum: <T>(anEnum: T) => T[keyof T];
  * @since 0.5.14
  */
 export declare const genSymbol: string;
+/**
+ * Generates a random internet ip.
+ *
+ * @since 0.1.0
+ */
+export declare const genIP: () => string;

package/build/builders/fulfillment.builder.d.ts

@@ -1,10 +1,22 @@
 import { Workflow, StepWorkflow } from "@artisan-commerce/types";
 import { StepWorkflowAdditionalInfo } from "@artisan-commerce/types";
-import { StepWorkflowGroup } from "@artisan-commerce/types";
+import { StepWorkflowGroup, StepCode } from "@artisan-commerce/types";
 import { Issue } from "@artisan-commerce/types";
-import { StepNotification } from "@artisan-commerce/types";
+import { StepCategory, StepNotification } from "@artisan-commerce/types";
 import { IssueAdditionalInfo, IssueHistory } from "@artisan-commerce/types";
 import { WebhookWorkflow, TransitionWorkflow } from "@artisan-commerce/types";
+/**
+ * All values of StepCategory.
+ *
+ * @since 0.1.0
+ */
+export declare const stepCategory: StepCategory[];
+/**
+ * All values of StepCode.
+ *
+ * @since 0.1.0
+ */
+export declare const stepCode: StepCode[];
 /**
  * Generates Issue object with random data.
  *

package/build/builders/order.builder.d.ts

@@ -1,8 +1,42 @@
-import { OrderLastRetry } from "@artisan-commerce/types";
+import { PaymentMethodByOrder } from "@artisan-commerce/types";
+import { OrderRetry, Suborder, ZipCodeField } from "@artisan-commerce/types";
+import { OperatorInformation } from "@artisan-commerce/types";
+import { NotificationSettings } from "@artisan-commerce/types";
+import { OrderAdditionalInfo } from "@artisan-commerce/types";
+import { OrderRetryPaymentMethod } from "@artisan-commerce/types";
+import { MetadataShipping, OrderUser } from "@artisan-commerce/types";
+import { InjectionDetail, IntegrationMessage } from "@artisan-commerce/types";
+import { Allocation, BaseField, Status } from "@artisan-commerce/types";
 import { BaseOrder, OrderDetails } from "@artisan-commerce/types";
 import { OrderStep, OrderShoppingCart } from "@artisan-commerce/types";
-import { OrderPaidPaymentMethod, OrderStore } from "@artisan-commerce/types";
-import { OrderProduct, OrderDetailShippingCost } from "@artisan-commerce/types";
+import { OrderPaymentMethod, OrderStatus } from "@artisan-commerce/types";
+import { OrderDetailShippingCost } from "@artisan-commerce/types";
+import { OrderStepAdditionalInfo } from "@artisan-commerce/types";
+import { OrderStepAdditionalInfoGroup } from "@artisan-commerce/types";
+/**
+ * All values of OrderStatus.
+ *
+ * @since 0.1.0
+ */
+export declare const orderStatusOptions: OrderStatus[];
+/**
+ * All values of Allocation.
+ *
+ * @since 0.1.0
+ */
+export declare const allocationOptions: Allocation[];
+/**
+ * Generate a sequence identifier with random numbers.
+ *
+ * @since 0.1.0
+ */
+export declare const genSeqId: () => string;
+/**
+ * Generate a order reference with random data.
+ *
+ * @since 0.1.0
+ */
+export declare const genReference: () => string;
 /**
  * Generates BaseOrder object with random data.
  *
@@ -48,6 +82,36 @@ export declare const genOrderDetails: (quantity?: number | undefined) => OrderDe
  * @returns {OrderStep} A {@link OrderStep} object
  */
 export declare const buildOrderStep: (overrides?: Partial<OrderStep>) => OrderStep;
+/**
+ * Generates OrderStepAdditionalInfo object with random data.
+ *
+ * @since 0.1.0
+ * @param {Partial<OrderStepAdditionalInfo>} overrides Properties to override
+ * a {@link OrderStepAdditionalInfo}
+ * @returns {OrderStepAdditionalInfo} A
+ * {@link OrderStepAdditionalInfo} object
+ */
+export declare const buildOrderStepAdditionalInfo: (overrides?: Partial<OrderStepAdditionalInfo>) => OrderStepAdditionalInfo;
+/**
+ * Generates a list of OrderStepAdditionalInfo objects with random data.
+ *
+ * @since 0.1.0
+ * @param {number} quantity The number of objects to be generated
+ * @returns {OrderStepAdditionalInfo[]} An array of
+ * OrderStepAdditionalInfo objects,
+ * see {@link OrderStepAdditionalInfo}
+ */
+export declare const genOrderStepAdditionalInfos: (quantity?: number | undefined) => OrderStepAdditionalInfo[];
+/**
+ * Generates OrderStepAdditionalInfoGroup object with random data.
+ *
+ * @since 0.1.0
+ * @param {Partial<OrderStepAdditionalInfoGroup>} overrides Properties
+ * to override a {@link OrderStepAdditionalInfoGroup}
+ * @returns {OrderStepAdditionalInfoGroup} A
+ * {@link OrderStepAdditionalInfoGroup} object
+ */
+export declare const buildOrderStepAdditionalInfoGroup: (overrides?: Partial<OrderStepAdditionalInfoGroup>) => OrderStepAdditionalInfoGroup;
 /**
  * Generates a list of OrderStep objects with random data.
  *
@@ -76,77 +140,59 @@ export declare const buildOrderDetailShippingCost: (overrides?: Partial<OrderDet
  */
 export declare const genOrderDetailShippingCosts: (quantity?: number | undefined) => OrderDetailShippingCost[];
 /**
- * Generates OrderLastRetry object with random data.
+ * Generates OrderRetry object with random data.
  *
  * @since 0.5.14
- * @param {Partial<OrderLastRetry>} overrides Properties to override
- * a {@link OrderLastRetry}
- * @returns {OrderLastRetry} A {@link OrderLastRetry} object
+ * @param {Partial<OrderRetry>} overrides Properties to override
+ * a {@link OrderRetry}
+ * @returns {OrderRetry} A {@link OrderRetry} object
  */
-export declare const buildOrderLastRetry: (overrides?: Partial<OrderLastRetry>) => OrderLastRetry;
+export declare const buildOrderRetry: (overrides?: Partial<OrderRetry>) => OrderRetry;
 /**
- * Generates a list of OrderLastRetry objects with random data.
+ * Generates Status object with random data.
  *
- * @since 0.5.14
- * @param {number} quantity The number of objects to be generated
- * @returns {OrderLastRetry[]} An array of OrderLastRetry objects,
- * see {@link OrderLastRetry}
+ * @since 0.1.0
+ * @param {Partial<Status>} overrides Properties to override
+ * a {@link Status}
+ * @returns {Status} A {@link Status} object
  */
-export declare const genOrderLastRetries: (quantity?: number | undefined) => OrderLastRetry[];
+export declare const buildStatus: (overrides?: Partial<Status>) => Status;
 /**
- * Generates OrderPaidPaymentMethod object with random data.
+ * Generates a list of Status objects with random data.
  *
- * @since 0.5.14
- * @param {Partial<OrderPaidPaymentMethod>} overrides Properties to override
- * a {@link OrderPaidPaymentMethod}
- * @returns {OrderPaidPaymentMethod} A {@link OrderPaidPaymentMethod} object
- */
-export declare const buildOrderPaidPaymentMethod: (overrides?: Partial<OrderPaidPaymentMethod>) => OrderPaidPaymentMethod;
-/**
- * Generates a list of OrderPaidPaymentMethod objects with random data.
- *
- * @since 0.5.14
+ * @since 0.1.0
  * @param {number} quantity The number of objects to be generated
- * @returns {OrderPaidPaymentMethod[]} An array of OrderPaidPaymentMethod
- * objects, see {@link OrderPaidPaymentMethod}
+ * @returns {Status[]} An array of Status objects,
+ * see {@link Status}
  */
-export declare const genOrderPaidPaymentMethods: (quantity?: number | undefined) => OrderPaidPaymentMethod[];
+export declare const genStatus: (quantity?: number | undefined) => Status[];
 /**
- * Generates OrderProduct object with random data.
- *
- * @since 0.5.14
- * @param {Partial<OrderProduct>} overrides Properties to override
- * a {@link OrderProduct}
- * @returns {OrderProduct} A {@link OrderProduct} object
- */
-export declare const buildOrderProduct: (overrides?: Partial<OrderProduct>) => OrderProduct;
-/**
- * Generates a list of OrderProduct objects with random data.
+ * Generates a list of OrderRetry objects with random data.
  *
  * @since 0.5.14
  * @param {number} quantity The number of objects to be generated
- * @returns {OrderProduct[]} An array of OrderProduct objects,
- * see {@link OrderProduct}
+ * @returns {OrderRetry[]} An array of OrderRetry objects,
+ * see {@link OrderRetry}
  */
-export declare const genOrderProducts: (quantity?: number | undefined) => OrderProduct[];
+export declare const genOrderRetries: (quantity?: number | undefined) => OrderRetry[];
 /**
- * Generates OrderStore object with random data.
+ * Generates OrderPaymentMethod object with random data.
  *
  * @since 0.5.14
- * @param {Partial<OrderStore>} overrides Properties to override
- * a {@link OrderStore}
- * @returns {OrderStore} A {@link OrderStore} object
+ * @param {Partial<OrderPaymentMethod>} overrides Properties to override
+ * a {@link OrderPaymentMethod}
+ * @returns {OrderPaymentMethod} A {@link OrderPaymentMethod} object
  */
-export declare const buildOrderStore: (overrides?: Partial<OrderStore>) => OrderStore;
+export declare const buildOrderPaymentMethod: (overrides?: Partial<OrderPaymentMethod>) => OrderPaymentMethod;
 /**
- * Generates a list of OrderStore objects with random data.
+ * Generates a list of OrderPaymentMethod objects with random data.
  *
  * @since 0.5.14
  * @param {number} quantity The number of objects to be generated
- * @returns {OrderStore[]} An array of OrderStore objects,
- * see {@link OrderStore}
+ * @returns {OrderPaymentMethod[]} An array of OrderPaymentMethod
+ * objects, see {@link OrderPaymentMethod}
  */
-export declare const genOrderStores: (quantity?: number | undefined) => OrderStore[];
+export declare const genOrderPaymentMethods: (quantity?: number | undefined) => OrderPaymentMethod[];
 /**
  * Generates OrderShoppingCart object with random data.
  *
@@ -165,3 +211,217 @@ export declare const buildOrderShoppingCart: (overrides?: Partial<OrderShoppingC
  * see {@link OrderShoppingCart}
  */
 export declare const genOrderShoppingCarts: (quantity?: number | undefined) => OrderShoppingCart[];
+/**
+ * Generates OrderAdditionalInfo object with random data.
+ *
+ * @since 0.1.0
+ * @param {Partial<OrderAdditionalInfo>} overrides Properties to override
+ * a {@link OrderAdditionalInfo}
+ * @returns {OrderAdditionalInfo} A {@link OrderAdditionalInfo} object
+ */
+export declare const buildOrderAdditionalInfo: (overrides?: Partial<OrderAdditionalInfo>) => OrderAdditionalInfo;
+/**
+ * Generates a list of OrderAdditionalInfo objects with random data.
+ *
+ * @since 0.1.0
+ * @param {number} quantity The number of objects to be generated
+ * @returns {OrderAdditionalInfo[]} An array of OrderAdditionalInfo objects,
+ * see {@link OrderAdditionalInfo}
+ */
+export declare const genOrderAdditionalInfos: (quantity?: number | undefined) => OrderAdditionalInfo[];
+/**
+ * Generates MetadataShipping object with random data.
+ *
+ * @since 0.1.0
+ * @param {Partial<MetadataShipping>} overrides Properties to override
+ * a {@link MetadataShipping}
+ * @returns {MetadataShipping} A {@link MetadataShipping} object
+ */
+export declare const buildMetadataShipping: (overrides?: Partial<MetadataShipping>) => MetadataShipping;
+/**
+ * Generates a list of MetadataShipping objects with random data.
+ *
+ * @since 0.1.0
+ * @param {number} quantity The number of objects to be generated
+ * @returns {MetadataShipping[]} An array of MetadataShipping objects,
+ * see {@link MetadataShipping}
+ */
+export declare const genMetadataShippings: (quantity?: number | undefined) => MetadataShipping[];
+/**
+ * Generates BaseField object with random data.
+ *
+ * @since 0.1.0
+ * @param {Partial<BaseField>} overrides Properties to override
+ * a {@link BaseField}
+ * @returns {BaseField} A {@link BaseField} object
+ */
+export declare const buildBaseField: (overrides?: Partial<BaseField>) => BaseField;
+/**
+ * Generates a list of BaseField objects with random data.
+ *
+ * @since 0.1.0
+ * @param {number} quantity The number of objects to be generated
+ * @returns {BaseField[]} An array of BaseField objects,
+ * see {@link BaseField}
+ */
+export declare const genBaseFields: (quantity?: number | undefined) => BaseField[];
+/**
+ * Generates ZipCodeField object with random data.
+ *
+ * @since 0.1.0
+ * @param {Partial<ZipCodeField>} overrides Properties to override
+ * a {@link ZipCodeField}
+ * @returns {ZipCodeField} A {@link ZipCodeField} object
+ */
+export declare const buildZipCodeField: (overrides?: Partial<ZipCodeField>) => ZipCodeField;
+/**
+ * Generates a list of ZipCodeField objects with random data.
+ *
+ * @since 0.1.0
+ * @param {number} quantity The number of objects to be generated
+ * @returns {ZipCodeField[]} An array of ZipCodeField objects,
+ * see {@link ZipCodeField}
+ */
+export declare const genZipCodeFields: (quantity?: number | undefined) => ZipCodeField[];
+/**
+ * Generates IntegrationMessage object with random data.
+ *
+ * @since 0.1.0
+ * @param {Partial<IntegrationMessage>} overrides Properties to override
+ * a {@link IntegrationMessage}
+ * @returns {IntegrationMessage} A {@link IntegrationMessage} object
+ */
+export declare const buildIntegrationMessage: (overrides?: Partial<IntegrationMessage>) => IntegrationMessage;
+/**
+ * Generates a list of IntegrationMessage objects with random data.
+ *
+ * @since 0.1.0
+ * @param {number} quantity The number of objects to be generated
+ * @returns {IntegrationMessage[]} An array of IntegrationMessage objects,
+ * see {@link IntegrationMessage}
+ */
+export declare const genIntegrationMessages: (quantity?: number | undefined) => IntegrationMessage[];
+/**
+ * Generates InjectionDetail object with random data.
+ *
+ * @since 0.1.0
+ * @param {Partial<InjectionDetail>} overrides Properties to override
+ * a {@link InjectionDetail}
+ * @returns {InjectionDetail} A {@link InjectionDetail} object
+ */
+export declare const buildInjectionDetail: (overrides?: Partial<InjectionDetail>) => InjectionDetail;
+/**
+ * Generates a list of InjectionDetail objects with random data.
+ *
+ * @since 0.1.0
+ * @param {number} quantity The number of objects to be generated
+ * @returns {InjectionDetail[]} An array of InjectionDetail objects,
+ * see {@link InjectionDetail}
+ */
+export declare const genInjectionDetails: (quantity?: number | undefined) => InjectionDetail[];
+/**
+ * Generates OrderUser object with random data.
+ *
+ * @since 0.1.0
+ * @param {Partial<OrderUser>} overrides Properties to override
+ * a {@link OrderUser}
+ * @returns {OrderUser} A {@link OrderUser} object
+ */
+export declare const buildOrderUser: (overrides?: Partial<OrderUser>) => OrderUser;
+/**
+ * Generates a list of OrderUser objects with random data.
+ *
+ * @since 0.1.0
+ * @param {number} quantity The number of objects to be generated
+ * @returns {OrderUser[]} An array of OrderUser objects,
+ * see {@link OrderUser}
+ */
+export declare const genOrderUsers: (quantity?: number | undefined) => OrderUser[];
+/**
+ * Generates NotificationSettings object with random data.
+ *
+ * @since 0.1.0
+ * @param {Partial<NotificationSettings>} overrides Properties to override
+ * a {@link NotificationSettings}
+ * @returns {NotificationSettings} A {@link NotificationSettings} object
+ */
+export declare const buildNotificationSettings: (overrides?: Partial<NotificationSettings>) => NotificationSettings;
+/**
+ * Generates a list of NotificationSettings objects with random data.
+ *
+ * @since 0.1.0
+ * @param {number} quantity The number of objects to be generated
+ * @returns {NotificationSettings[]} An array of NotificationSettings objects,
+ * see {@link NotificationSettings}
+ */
+export declare const genNotificationSettings: (quantity?: number | undefined) => NotificationSettings[];
+/**
+ * Generates OperatorInformation object with random data.
+ *
+ * @param {Partial<OperatorInformation>} overrides Properties to override
+ * a {@link OperatorInformation}
+ * @returns {OperatorInformation} A {@link OperatorInformation} object
+ */
+export declare const buildOperatorInformation: (overrides?: Partial<OperatorInformation>) => OperatorInformation;
+/**
+ * Generates a list of OperatorInformation objects with random data.
+ *
+ * @param {number} quantity The number of objects to be generated
+ * @returns {OperatorInformation[]} An array of OperatorInformation objects,
+ * see {@link OperatorInformation}
+ */
+export declare const genOperatorInformation: (quantity?: number | undefined) => OperatorInformation[];
+/**
+ * Generates Suborder object with random data.
+ *
+ * @since 0.1.0
+ * @param {Partial<Suborder>} overrides Properties to override
+ * a {@link Suborder}
+ * @returns {Suborder} A {@link Suborder} object
+ */
+export declare const buildSuborder: (overrides?: Partial<Suborder>) => Suborder;
+/**
+ * Generates a list of Suborder objects with random data.
+ *
+ * @since 0.1.0
+ * @param {number} quantity The number of objects to be generated
+ * @returns {Suborder[]} An array of Suborder objects,
+ * see {@link Suborder}
+ */
+export declare const genSuborders: (quantity?: number | undefined) => Suborder[];
+/**
+ * Generates PaymentMethodByOrder object with random data.
+ *
+ * @since 0.1.0
+ * @param {Partial<PaymentMethodByOrder>} overrides Properties to override
+ * a {@link PaymentMethodByOrder}
+ * @returns {PaymentMethodByOrder} A {@link PaymentMethodByOrder} object
+ */
+export declare const buildPaymentMethodByOrder: (overrides?: Partial<PaymentMethodByOrder>) => PaymentMethodByOrder;
+/**
+ * Generates a list of PaymentMethodByOrder objects with random data.
+ *
+ * @since 0.1.0
+ * @param {number} quantity The number of objects to be generated
+ * @returns {PaymentMethodByOrder[]} An array of PaymentMethodByOrder objects,
+ * see {@link PaymentMethodByOrder}
+ */
+export declare const genPaymentMethodByOrders: (quantity?: number | undefined) => PaymentMethodByOrder[];
+/**
+ * Generates OrderRetryPaymentMethod object with random data.
+ *
+ * @since 0.1.0
+ * @param {Partial<OrderRetryPaymentMethod>} overrides Properties to override
+ * a {@link OrderRetryPaymentMethod}
+ * @returns {OrderRetryPaymentMethod} A {@link OrderRetryPaymentMethod} object
+ */
+export declare const buildOrderRetryPaymentMethod: (overrides?: Partial<OrderRetryPaymentMethod>) => OrderRetryPaymentMethod;
+/**
+ * Generates a list of OrderRetryPaymentMethod objects with random data.
+ *
+ * @since 0.1.0
+ * @param {number} quantity The number of objects to be generated
+ * @returns {OrderRetryPaymentMethod[]} An array of
+ * OrderRetryPaymentMethod objects, see {@link OrderRetryPaymentMethod}
+ */
+export declare const genOrderRetryPaymentMethods: (quantity?: number | undefined) => OrderRetryPaymentMethod[];