@esolve/ng-esolve-connect 0.5.1

package/lib/banners/esolve-banner-image-hotspot-record.d.ts

@@ -0,0 +1,8 @@
+import { EsolveUrlTarget } from '../shared/esolve-url-target';
+import { EsolveBannerImageHotspotCoords } from './esolve-banner-image-hotspot';
+export interface EsolveBannerImageHotspotRecord {
+    url: string;
+    target: EsolveUrlTarget;
+    coords: EsolveBannerImageHotspotCoords[];
+    coords_string: string;
+}

package/lib/banners/esolve-banner-image-hotspot.d.ts

@@ -0,0 +1,12 @@
+import { EsolveUrlTarget } from '../shared/esolve-url-target';
+export declare class EsolveBannerImageHotspot {
+    url: string;
+    target: EsolveUrlTarget;
+    coords: EsolveBannerImageHotspotCoords[];
+    coords_string: string;
+    constructor(url: string, target: EsolveUrlTarget, coords: EsolveBannerImageHotspotCoords[], coords_string: string);
+}
+export interface EsolveBannerImageHotspotCoords {
+    x: number;
+    y: number;
+}

package/lib/banners/esolve-banner-image-record.d.ts

@@ -0,0 +1,10 @@
+import { EsolveBannerImageType } from './esolve-banner-type';
+import { EsolveBannerImageHotspotRecord } from './esolve-banner-image-hotspot-record';
+export interface EsolveBannerImageRecord {
+    id: number;
+    image_type: EsolveBannerImageType;
+    width: number;
+    height: number;
+    filename: string;
+    hotspots?: EsolveBannerImageHotspotRecord[];
+}

package/lib/banners/esolve-banner-image.d.ts

@@ -0,0 +1,12 @@
+import { EsolveBannerImageType } from './esolve-banner-type';
+import { EsolveBannerImageHotspot } from './esolve-banner-image-hotspot';
+export declare class EsolveBannerImage {
+    id: number;
+    image_type: EsolveBannerImageType;
+    width: number;
+    height: number;
+    filename: string;
+    hotspots?: EsolveBannerImageHotspot[] | undefined;
+    constructor(id: number, image_type: EsolveBannerImageType, width: number, height: number, filename: string, hotspots?: EsolveBannerImageHotspot[] | undefined);
+    get src(): string;
+}

package/lib/banners/esolve-banner-record.d.ts

@@ -0,0 +1,17 @@
+import { EsolveBannerType, EsolveBannerLink } from './esolve-banner-type';
+import { EsolveBannerImageRecord } from './esolve-banner-image-record';
+export interface EsolveBannerRecord {
+    id: number;
+    banner_display_container: string;
+    identifier: string;
+    type: EsolveBannerType;
+    title: string;
+    article: string;
+    sort_priority: number;
+    link: EsolveBannerLink;
+    images: {
+        desktop?: EsolveBannerImageRecord[];
+        mobile?: EsolveBannerImageRecord[];
+        sub?: EsolveBannerImageRecord[];
+    };
+}

package/lib/banners/esolve-banner-type.d.ts

@@ -0,0 +1,7 @@
+import { EsolveUrlTarget } from '../shared/esolve-url-target';
+export declare type EsolveBannerType = 'static' | 'hotspot';
+export declare type EsolveBannerImageType = 'desktop' | 'mobile' | 'sub';
+export interface EsolveBannerLink {
+    url: string;
+    target: EsolveUrlTarget;
+}

package/lib/banners/esolve-banner.d.ts

@@ -0,0 +1,21 @@
+import { EsolveBannerLink, EsolveBannerType } from './esolve-banner-type';
+import { EsolveBannerImage } from './esolve-banner-image';
+export interface EsolveBannerImageSet {
+    desktop?: EsolveBannerImage[];
+    mobile?: EsolveBannerImage[];
+    sub?: EsolveBannerImage[];
+}
+export declare class EsolveBanner {
+    id: number;
+    banner_display_container: string;
+    identifier: string;
+    type: EsolveBannerType;
+    title: string;
+    article: string;
+    sort_priority: number;
+    link: EsolveBannerLink;
+    desktop_images: EsolveBannerImage[];
+    mobile_images: EsolveBannerImage[];
+    sub_images: EsolveBannerImage[];
+    constructor(id: number, banner_display_container: string, identifier: string, type: EsolveBannerType, title: string, article: string, sort_priority: number, link: EsolveBannerLink, images: EsolveBannerImageSet);
+}

package/lib/banners/esolve-banner.service.d.ts

@@ -0,0 +1,26 @@
+import { HttpClient } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import { EsolveConnectConfig } from '../esolve-connect.config';
+import { EsolveBanner } from './esolve-banner';
+import * as i0 from "@angular/core";
+export declare class EsolveBannerService {
+    private config;
+    private http;
+    constructor(config: EsolveConnectConfig, http: HttpClient);
+    private processBannerImageHotspots;
+    private processBannerImages;
+    /**
+     * Process banner records into banner objects
+     * @param records Array of records
+     * @returns List of banners
+     */
+    private processBanners;
+    /**
+     * Retrieves banners records from eSolve instance
+     *
+     * @returns An observable of eSolve banners.
+     */
+    getBanners(identifier?: string, banner_display_container?: string, enable_date_filter?: boolean): Observable<EsolveBanner[]>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EsolveBannerService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<EsolveBannerService>;
+}

package/lib/cart/esolve-cart-item-record.d.ts

@@ -0,0 +1,43 @@
+import { EsolvePostResponseItem } from '../shared/esolve-response';
+export interface EsolveCartItemRecord {
+    id: number;
+    code: string;
+    external_system_code: string;
+    name: string;
+    description: string;
+    qty: number;
+    price: number;
+    price_description: string;
+    price_incl: number;
+    discount_price: number;
+    discount_price_incl: number;
+    discount_total: number;
+    vat_total: number;
+    line_total: number;
+    line_total_incl: number;
+    discount: number;
+    discount_interval: number;
+    vat_rate: number;
+    delivery_category: string;
+    type: string;
+    must_collect: boolean;
+    requested_assembly: boolean;
+    allow_quotes: boolean;
+    allow_orders: boolean;
+    sef_name: string;
+    minimum_onhand: number;
+    group: string;
+    limit_per_transaction: number;
+    onhand: number;
+    cart_question_identifier: string;
+    items_in_pack: number;
+    is_active: boolean;
+    display_only: boolean;
+    ignore_onhand_check: boolean;
+    subcategory_min_level: number;
+    image_name: string;
+}
+export interface EsolveCartItemResponse extends EsolvePostResponseItem {
+    esolve_id: number;
+    current_qty: number;
+}

package/lib/cart/esolve-cart-item.d.ts

@@ -0,0 +1,31 @@
+import { EsolveCartStockItem } from './esolve-cart-stock-item';
+export declare type EsolveCart = EsolveCartItem[];
+export declare class EsolveCartItem {
+    id: number;
+    stock_item: EsolveCartStockItem;
+    qty: number;
+    type: string;
+    price: number;
+    discount: number;
+    discount_interval: number;
+    vat_rate: number;
+    allow_quotes: boolean;
+    allow_orders: boolean;
+    must_collect: boolean;
+    requested_assembly: boolean;
+    price_incl: number;
+    discount_price: number;
+    discount_price_incl: number;
+    discount_total: number;
+    vat_total: number;
+    total: number;
+    total_incl: number;
+    constructor(id: number, stock_item: EsolveCartStockItem, qty: number, type: string, price: number, discount: number, discount_interval: number, vat_rate: number, allow_quotes: boolean, allow_orders: boolean, must_collect: boolean, requested_assembly: boolean, price_incl: number, discount_price: number, discount_price_incl: number, discount_total: number, vat_total: number, total: number, total_incl: number);
+}
+export declare type EsolveCartSetAction = 'add' | 'edit' | 'remove';
+export interface EsolveCartSetItem {
+    code: string;
+    id?: number;
+    qty?: number;
+    action?: EsolveCartSetAction;
+}

package/lib/cart/esolve-cart-stock-item.d.ts

@@ -0,0 +1,31 @@
+export declare class EsolveCartStockItem {
+    code: string;
+    name: string;
+    sef_name: string;
+    description: string;
+    active: boolean;
+    items_in_pack: number;
+    delivery_category: string;
+    private image_name;
+    constructor(code: string, name: string, sef_name: string, description: string, active: boolean, items_in_pack: number, delivery_category: string, image_name: string);
+    /**
+     * Path to tiny stock image
+     */
+    get tiny_image_src(): string;
+    /**
+     * Path to thumbnail stock image
+     */
+    get thumbnail_image_src(): string;
+    /**
+     * Path to small stock image
+     */
+    get small_image_src(): string;
+    /**
+     * Path to big stock image
+     */
+    get big_image_src(): string;
+    /**
+     * Path to original stock image
+     */
+    get original_image_src(): string;
+}

package/lib/cart/esolve-cart-totals-record.d.ts

@@ -0,0 +1,7 @@
+export interface EsolveCartTotalsRecord {
+    records: number;
+    items: string;
+    total: string;
+    vat: string;
+    discount: string;
+}

package/lib/cart/esolve-cart-totals.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Totals in cart
+ */
+export declare class EsolveCartTotals {
+    /**
+     * Number of unique records in cart
+     */
+    records: number;
+    /**
+     * Total quantity of all items in a cart
+     */
+    items: number;
+    /**
+     * Total in cart before discount and VAT is added
+     */
+    sub_total: number;
+    /**
+     * Total VAT of all the items in the cart
+     */
+    vat_total: number;
+    /**
+     * Total discount of all the item in the cart
+     */
+    discount_total: number;
+    constructor(
+    /**
+     * Number of unique records in cart
+     */
+    records?: number, 
+    /**
+     * Total quantity of all items in a cart
+     */
+    items?: number, 
+    /**
+     * Total in cart before discount and VAT is added
+     */
+    sub_total?: number, 
+    /**
+     * Total VAT of all the items in the cart
+     */
+    vat_total?: number, 
+    /**
+     * Total discount of all the item in the cart
+     */
+    discount_total?: number);
+    /**
+     * Grand total of cart which includes discount and VAT (NOTE: shipping and insurance is not included)
+     */
+    get total(): number;
+}

package/lib/cart/esolve-cart.service.d.ts

@@ -0,0 +1,112 @@
+import { HttpClient } from '@angular/common/http';
+import { Observable } from 'rxjs';
+import { EsolveConnectConfig } from '../esolve-connect.config';
+import { EsolveCart, EsolveCartSetAction, EsolveCartSetItem } from './esolve-cart-item';
+import { EsolveCartItemResponse } from './esolve-cart-item-record';
+import { EsolveStockLocation } from './esolve-stock-location';
+import { EsolvePaymentMethod } from './esolve-payment-method';
+import { EsolvePaymentMethodOptions } from './esolve-payment-method-record';
+import { EsolveShippingMethod } from './esolve-shipping-method';
+import { EsolveShippingMethodOptions } from './esolve-shipping-method-record';
+import { EsolveShippingCost } from './esolve-shipping-cost';
+import { EsolveShippingCostOptions } from './esolve-shipping-cost-record';
+import { EsolveCartTotals } from './esolve-cart-totals';
+import * as i0 from "@angular/core";
+export declare class EsolveCartService {
+    private config;
+    private http;
+    private _cached_tracking;
+    constructor(config: EsolveConnectConfig, http: HttpClient);
+    /**
+     * Processes the eSolve tree records.
+     * @param cart_item_records Records to process
+     * @returns An array of processed cart items
+     */
+    private processCart;
+    /**
+     * Processes the eSolve stock location records.
+     * @param records Records to process
+     * @returns An array of processed stock location records
+     */
+    private processStockLocations;
+    /**
+     * Processes the eSolve shipping method records.
+     * @param records Records to process
+     * @returns An array of processed shipping methods
+     */
+    private processShippingMethods;
+    /**
+     * Processes the eSolve payment method records.
+     * @param records Records to process
+     * @returns An array of processed payment methods.
+     */
+    private processPaymentMethods;
+    /**
+     * Processes the eSolve shipping costs record.
+     * @param record Data to process
+     * @returns Processed shipping costs
+     */
+    private processShippingCost;
+    /**
+     * Processes the eSolve cart totals
+     * @param record Data to process
+     * @returns Processed cart totals
+     */
+    private processCartTotals;
+    /**
+     * Retrieves the current cart
+     * @returns An `Observable` with an array of cart items
+     */
+    getCart(): Observable<EsolveCart>;
+    /**
+     * Updates the cart by preforming various actions, such as adding, editing or removing items from the cart.
+     * @param items An array of options to update the cart
+     * @param action The default action to preform
+     * @returns An `Observable` with an array of responses that gives feedback on the requested changes
+     */
+    setCart(items: EsolveCartSetItem[], action?: EsolveCartSetAction): Observable<EsolveCartItemResponse[]>;
+    /**
+     * Retrieves a list of stock locations
+     * @returns An `Observable` with an array of stock locations
+     */
+    getStockLocations(): Observable<EsolveStockLocation[]>;
+    /**
+     * Retrieves a list of shipping methods
+     * @returns An `Observable` with an array of shipping methods
+     */
+    getShippingMethods(options?: EsolveShippingMethodOptions): Observable<EsolveShippingMethod[]>;
+    /**
+     * Retrieves a list of payment methods
+     * @returns  An `Observable` with an array of payment methods
+     */
+    getPaymentMethods(options?: EsolvePaymentMethodOptions): Observable<EsolvePaymentMethod[]>;
+    /**
+     * Retrieves the shipping costs
+     * @param options Shipping cost options
+     * @returns An `Observable` with the shipping costs
+     */
+    getShippingCost(options: EsolveShippingCostOptions): Observable<EsolveShippingCost>;
+    /**
+     * Retrieves the totals of the cart with all the totals calculated
+     * @returns An `Observable` with an object containing cart totals
+     */
+    getTotals(): Observable<EsolveCartTotals>;
+    /**
+     * Retrieves a tracking code for the cart
+     * @returns An `Observable` with the cart tracking code
+     */
+    getTrackingCode(): Observable<number>;
+    /**
+     * Initiates checkout of the cart items
+     * @param type The cart type that needs to be checked out
+     * @param addresses_id The ID of the delivery address
+     * @param shipping_id The ID of the shipping method
+     * @param payment_method_id The ID of the selected payment method
+     * @param location_id The ID of the selected branch from with shipping needs to be calculated
+     * @param comments Additional comments on the cart
+     * @returns An `Observable` with the transaction ID
+     */
+    checkout(type: 'order' | 'quote', addresses_id: number, shipping_id: number, payment_method_id?: number, location_id?: number, comments?: string): Observable<number>;
+    static ɵfac: i0.ɵɵFactoryDeclaration<EsolveCartService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<EsolveCartService>;
+}

package/lib/cart/esolve-checkout.d.ts

@@ -0,0 +1,7 @@
+import { EsolvePostResponseItem } from '../shared/esolve-response';
+export interface EsolveTrackingCode {
+    tracking: number;
+}
+export interface EsolveCheckoutResponse extends EsolvePostResponseItem {
+    esolve_id: number;
+}

package/lib/cart/esolve-payment-method-record.d.ts

@@ -0,0 +1,47 @@
+export declare type EsolveIntegrationType = 'Virtual' | 'Direct';
+export interface EsolvePaymentMethodRecord {
+    id: number;
+    location_id: number;
+    paymethod_name: string;
+    description: string;
+    display_banking_details: boolean;
+    bank_name: string;
+    account_holder: string;
+    account: string;
+    account_type: string;
+    swift_number: string;
+    branch_code: string;
+    currency_code: string;
+    terminal_id: string;
+    terminal_id_secondary: string;
+    merchant_id: string;
+    application_id: string;
+    api_username: string;
+    api_password: string;
+    api_signature: string;
+    is_gateway: boolean;
+    must_store_card_details: boolean;
+    allow_budget: boolean;
+    integration_type: EsolveIntegrationType;
+    bank_gateway_id: string;
+    accepted_card_types: string[];
+    post_transactions_to_gateway: boolean;
+    three_d_secure_url: string;
+    gateway_url: string;
+    generate_token_url: string;
+    widget_url: string;
+    successful_url: string;
+    failed_url: string;
+    enable_callback: boolean;
+    live: boolean;
+    default_module_id: number;
+    service_provider: string;
+    on_account: boolean;
+    sort_priority: number;
+    image_url: string;
+}
+export interface EsolvePaymentMethodOptions {
+    live?: boolean;
+    location_id?: number;
+    is_gateway?: boolean;
+}

package/lib/cart/esolve-payment-method.d.ts

@@ -0,0 +1,47 @@
+import { EsolveIntegrationType, EsolvePaymentMethodRecord } from './esolve-payment-method-record';
+export declare class EsolvePaymentMethod {
+    id: number;
+    location_id: number;
+    paymethod_name: string;
+    description: string;
+    display_banking_details: boolean;
+    currency_code: string;
+    terminal_id: string;
+    terminal_id_secondary: string;
+    merchant_id: string;
+    application_id: string;
+    api_username: string;
+    api_password: string;
+    api_signature: string;
+    is_gateway: boolean;
+    must_store_card_details: boolean;
+    allow_budget: boolean;
+    integration_type: EsolveIntegrationType;
+    bank_gateway_id: string;
+    accepted_card_types: string[];
+    post_transactions_to_gateway: boolean;
+    three_d_secure_url: string;
+    gateway_url: string;
+    generate_token_url: string;
+    widget_url: string;
+    successful_url: string;
+    failed_url: string;
+    enable_callback: boolean;
+    live: boolean;
+    default_module_id: number;
+    service_provider: string;
+    on_account: boolean;
+    sort_priority: number;
+    image_url: string;
+    banking_details: BankingDetails;
+    constructor(record: EsolvePaymentMethodRecord);
+}
+export declare class BankingDetails {
+    bank_name: string;
+    account_holder: string;
+    account: string;
+    account_type: string;
+    swift_number: string;
+    branch_code: string;
+    constructor(bank_name: string, account_holder: string, account: string, account_type: string, swift_number: string, branch_code: string);
+}

package/lib/cart/esolve-shipping-cost-record.d.ts

@@ -0,0 +1,14 @@
+export interface EsolveShippingCostRecord {
+    shipping_cost_type: string;
+    shipping_total: number;
+    vat_on_shipping: number;
+    total_saving_on_shipping: number;
+    insurance_total: number;
+    vat_on_insurance: number;
+    total_saving_on_insurance: number;
+}
+export interface EsolveShippingCostOptions {
+    location_id?: number;
+    addresses_id: number;
+    shipping_id: number;
+}

package/lib/cart/esolve-shipping-cost.d.ts

@@ -0,0 +1,12 @@
+export declare class EsolveShippingCost {
+    shipping: EsolveShippingTotals;
+    insurance: EsolveShippingTotals;
+    constructor(shipping_total?: number, shipping_vat?: number, shipping_total_savings?: number, insurance_total?: number, insurance_vat?: number, insurance_total_savings?: number);
+}
+declare class EsolveShippingTotals {
+    total: number;
+    vat: number;
+    savings: number;
+    constructor(total: number, vat: number, savings: number);
+}
+export {};

package/lib/cart/esolve-shipping-method-record.d.ts

@@ -0,0 +1,37 @@
+export declare type EsolveLocationType = 'Domestic' | 'International' | 'Domestic and International';
+export declare type EsolveInsuranceCostCalculationMethod = 'not_applicable' | 'included_in_price' | 'percentage_of_price';
+export declare type EsolveShippingCostCalculationMethod = 'by_weight' | 'by_volume' | 'greater_of_volume_weight' | 'add_on_proforma' | 'volumetric' | 'flat_rate' | 'free';
+export interface EsolveShippingMethodRecord {
+    id: number;
+    carrier_name: string;
+    delivery_category: string;
+    description: string;
+    location: EsolveLocationType;
+    pricing: string;
+    link_to_carrier_website: string;
+    days_to_deliver: number;
+    shipping_cost_calculation_method: EsolveShippingCostCalculationMethod;
+    insurance_cost_calculation_method: EsolveInsuranceCostCalculationMethod;
+    insurance_cost_percentage: number;
+    metric_factor: number;
+    allow_immediate_payment_processing: boolean;
+    allow_postal_address: boolean;
+    allow_physical_address: boolean;
+    client_to_collect: boolean;
+    is_default_shipping_method: boolean;
+    location_id: number;
+    use_zones: boolean;
+    min_distance: number;
+    max_distance: number;
+    shipping_surge_condition: number;
+    shipping_surge_percentage: number;
+    sort_priority: number;
+    shipping_group: string;
+    shipping_slot_identifier: string;
+    shipping_slot_delay_hours: number;
+    image_url: string;
+}
+export interface EsolveShippingMethodOptions {
+    location_id?: number;
+    addresses_id?: number;
+}

package/lib/cart/esolve-shipping-method.d.ts

@@ -0,0 +1,32 @@
+import { EsolveInsuranceCostCalculationMethod, EsolveLocationType, EsolveShippingCostCalculationMethod } from './esolve-shipping-method-record';
+export declare class EsolveShippingMethod {
+    id: number;
+    carrier_name: string;
+    delivery_category: string;
+    description: string;
+    location: EsolveLocationType;
+    pricing: string;
+    link_to_carrier_website: string;
+    days_to_deliver: number;
+    shipping_cost_calculation_method: EsolveShippingCostCalculationMethod;
+    insurance_cost_calculation_method: EsolveInsuranceCostCalculationMethod;
+    insurance_cost_percentage: number;
+    metric_factor: number;
+    allow_immediate_payment_processing: boolean;
+    allow_postal_address: boolean;
+    allow_physical_address: boolean;
+    client_to_collect: boolean;
+    is_default: boolean;
+    location_id: number;
+    use_zones: boolean;
+    min_distance: number;
+    max_distance: number;
+    shipping_surge_condition: number;
+    shipping_surge_percentage: number;
+    sort_priority: number;
+    shipping_group: string;
+    shipping_slot_identifier: string;
+    shipping_slot_delay_hours: number;
+    image_url: string;
+    constructor(id: number, carrier_name: string, delivery_category: string, description: string, location: EsolveLocationType, pricing: string, link_to_carrier_website: string, days_to_deliver: number, shipping_cost_calculation_method: EsolveShippingCostCalculationMethod, insurance_cost_calculation_method: EsolveInsuranceCostCalculationMethod, insurance_cost_percentage: number, metric_factor: number, allow_immediate_payment_processing: boolean, allow_postal_address: boolean, allow_physical_address: boolean, client_to_collect: boolean, is_default: boolean, location_id: number, use_zones: boolean, min_distance: number, max_distance: number, shipping_surge_condition: number, shipping_surge_percentage: number, sort_priority: number, shipping_group: string, shipping_slot_identifier: string, shipping_slot_delay_hours: number, image_url: string);
+}

package/lib/cart/esolve-stock-location-record.d.ts

@@ -0,0 +1,47 @@
+export interface EsolveStockLocationRecord {
+    id: number;
+    identifier: string;
+    head_office: boolean;
+    default_location_for_payment_methods: boolean;
+    description: string;
+    external_system_code: string;
+    erp_identifier: string;
+    userid: number;
+    importance: number;
+    is_active: boolean;
+    street: string;
+    suburb: string;
+    city: string;
+    province: string;
+    country: string;
+    postal_code: string;
+    latitude: number;
+    longitude: number;
+    pobox_postal_code: string;
+    pobox_city: string;
+    pobox: string;
+    branch_telnumber: string;
+    branch_telnumber_2: string;
+    branch_telnumber_3: string;
+    branch_cellnumber: string;
+    branch_fax: string;
+    branch_email: string;
+    monday_open_time: string;
+    monday_close_time: string;
+    tuesday_open_time: string;
+    tuesday_close_time: string;
+    wednesday_open_time: string;
+    wednesday_close_time: string;
+    thursday_open_time: string;
+    thursday_close_time: string;
+    friday_open_time: string;
+    friday_close_time: string;
+    saturday_open_time: string;
+    saturday_close_time: string;
+    sunday_open_time: string;
+    sunday_close_time: string;
+    public_holiday_open_time: string;
+    public_holiday_close_time: string;
+    trading_hours_additional_in?: string;
+    website_url: string;
+}