apirocket 0.12.4 → 0.13.1

package/README.md

@@ -3,10 +3,10 @@
 ```
 <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/apirocket@_VERSION_/dist/ecommerce.css">
 <script src="https://cdn.jsdelivr.net/npm/apirocket@_VERSION/dist/ecommerce.js" defer></script>
-````
+```
 
 
-## Inicializar el ecommerce
+### Inicializar el ecommerce
 
 ```javascript
 
@@ -16,6 +16,15 @@
     });
 ```
 
+### Actions
+
+- cart-add-item
+- cart-open
+- customer-account
+- checkout-open
+- sales-account
+
+
 ### EcommerceReadyEvent
 
 ```javascript
@@ -29,7 +38,7 @@ interface EcommerceReadyEvent extends Event {
 
 ```javascript
 type PublicEcommerceService = {
-    customer: any,
+    customer: CustomerService,
     cart: any,
     config: (value: EcommerceConfig) => void,
     updateEvents: () => void
@@ -71,6 +80,294 @@ type LegalLink = {
 }
 ```
 
+
+### CustomerService
+
+```javascript
+interface ReadOnly <CustomerService> {
+    acceptEmailMarketing: boolean;
+    firstName: string;
+    id: number;
+    phone: string;
+    type: 'B2B' | 'B2C';
+    isLogged: boolean;
+
+    myAccount: () => Promise <CustomerAccount>;
+    price: (productId: number) => Promise <ProductPrice>;
+    orders: (filter: OrdersFilter = {}) => Promise <CustomerOrders>;
+    order: (id: number) => Promise <Order>;
+}
+
+```
+
+### Tipos
+
+```javascript
+interface CustomerAccount {
+    acceptEmailMarketing?: boolean;
+    billingAddress?: Array <AccountBillingAddress>;
+    custom?: any;
+    email?: string
+    firstName?: string;
+    lastName?: string;
+    phone?: string;
+    shippingAddress?: Array <AccountShippingAddress>;
+}
+```
+
+```javascript
+interface AccountBillingAddress {
+    address: string;
+    address2: string;
+    city: string;
+    country: {
+        id: number;
+        name: string;
+    }
+    default: boolean;
+    description: string;
+    id: number;
+    name: string;
+    phone: string;
+    postalCode: string;
+    state: {
+        name: string;
+        id: number;
+    }
+    taxCode: string;
+}
+```
+
+
+```javascript
+interface AccountShippingAddress {
+    address: string;
+    address2: string;
+    city: string;
+    country: CountryRecord;
+    default: boolean;
+    description: string;
+    firstName: string;
+    id: number;
+    lastName: string;
+    name: string;
+    phone: string;
+    postalCode: string;
+    state: {
+        name: string;
+        id: number;
+    }
+}
+```
+
+
+```javacript
+interface ProductPrice {
+    comparePrice: number;
+    comparePriceTaxBase: number;
+    comparePriceTaxAmmount: number;
+    taxAmount: number;
+    taxBase: number;
+    taxes: Array <any>;
+}
+```
+
+
+```javascript
+type CustomerOrders = Array <CustomerOrder>;
+
+interface CustomerOrder {
+    date: string;
+    id: number;
+    number: string;
+    payment: OrderPayment;
+    status: OrderStatus;
+    total: number;
+}
+```
+
+
+```javascript
+interface Order extends CustomerOrder {
+    billingAddres; OrderBillingAddress;
+    cartTaxAmount: number;
+    cartTaxBase: number;
+    customer: OrderCustomer;
+    customerOrder: string;
+    date: string;
+    discount: Array <OrderDiscount>;
+    geolocation: OrderGeolocation;
+    items: Array <OrderItem>;
+    notes: string;
+    payment: OrderPayment;
+    pricesTaxIncluded: boolean;
+    shippingAddress: OrderShippingAddress;
+    shippingMethod: OrderShippingMethod;
+    status: OrderStatus;
+    totalTaxAmount: number;
+    totalTaxBase: number;
+}
+```
+
+
+```javascript
+interface OrderBillindAddress {
+    address?: string;
+    address2?: string;
+    city?: string;
+    country?: CountryRecord;
+    description?: string;
+    id?: number;
+    name?: string;
+    phone?: string;
+    postalCode?: string;
+    state?: { id: number; name: string };
+    taxCode?: string
+}
+```
+
+
+```javascript
+interface  OrderCustomer {
+    code: string;
+    email: string;
+    id: number;
+    isLogged: boolean;
+    name: string;
+    phone: string;
+    priceList: { id: number; name: string }
+    type: 'B2B' | 'B2C';
+}
+```
+
+
+```javascript
+interface OrderDiscount {
+    codes: Array <any>;
+    taxAmount: number;
+    taxBase: number;
+    total: number;
+}
+```
+
+
+```javascript
+interface OrderGeolocation {
+    browser: { name: string, version: string };
+    city: string;
+    continent: string;
+    country: string;
+    device: { type: string; model: string; vendor: string };
+    ip: string;
+    lat: number;
+    lon: number;
+    os: { name: string; version: string };
+    postalCode: string;
+    region: string;
+    remoteAddress: string;
+    timeZone: string;
+    userAgent: string;
+    userIsp: string;
+}
+```
+
+```javascript
+interface OrderItem {
+    id: number;
+    price: number;
+    priceTaxAmount: number;
+    priceTaxBase: number;
+    product: OrderProduct;
+    quantity: number;
+    taxes: any;
+}
+```
+
+
+```javascript
+type OrderPayment = {
+    authorization: string;
+    method: {
+        id: number;
+        name: string;
+        type: PaymentType;
+        notes: string;
+        description: string;
+    }
+    total: number;
+}
+```
+
+
+```javascript
+interface OrderProduct {
+    barcode: string;
+    category: {
+        id: number,
+        name: string
+    },
+    description: string;
+    id: number;
+    image: string;
+    name: string;
+    noShippingCost: boolean,
+    sku: string,
+    stockManagement: boolean,
+    url?: string;
+    weight: number;
+}
+```
+
+```javascript
+type OrdersFilter = {
+    page?: number;
+    perPage?: number;
+}
+```
+
+
+```javascript
+interface OrderShippingAddress {
+    address?: string;
+    address2?: string;
+    city?: string;
+    country?: CountryRecord;
+    description?: string;
+    email?: string;
+    firstName?: string;
+    id?: number;
+    lastName?: string;
+    phone?: string;
+    postalCode?: string;
+    state?: { id: number; name: string };
+}
+```
+
+
+```javascript
+interface OrderShippingMethod {
+    description: string;
+    id: number;
+    name: string;
+    taxAmount: number;
+    taxBase: number;
+    taxes: Array <any>;
+    total: number;
+}
+```
+
+
+```javascript
+type OrderStatus = {
+    id: number;
+    name: string;
+    color: string;
+}
+```
+
+
+###
+
 ### Ejemplo
 
 ```javascript