@simpleapps-com/augur-api 0.1.4 → 0.1.6

package/dist/esm/services/customers/client.d.ts

@@ -54,7 +54,7 @@ export declare class CustomersClient extends BaseServiceClient {
          * ```
          */
         list: (params?: {
-            edgeCache?: 3 | 2 | 4 | 1 | 5 | 8 | undefined;
+            edgeCache?: 3 | 1 | 2 | 4 | 5 | 8 | undefined;
             limit?: number | undefined;
             offset?: number | undefined;
             q?: string | undefined;
@@ -63,40 +63,28 @@ export declare class CustomersClient extends BaseServiceClient {
         } | undefined) => Promise<{
             data: {
                 customerId: number;
-                dateCreated: string;
-                dateLastModified: string;
-                companyId: string;
-                customerName: string;
-                salesrepId: string;
                 deleteFlag: string;
-                updateCd?: number | undefined;
-                customerUid?: number | undefined;
-                class1Id?: string | undefined;
-                class2Id?: string | undefined;
-                class3Id?: string | undefined;
-                class4Id?: string | undefined;
-                class5Id?: string | undefined;
-                sicCode?: number | undefined;
-                poNoRequired?: string | undefined;
-                defaultBranchId?: string | undefined;
-                webEnabledFlag?: string | undefined;
-                useLastMarginPricingFlag?: string | undefined;
-                sourcePriceCd?: number | undefined;
-                jobPricing?: string | undefined;
-                alwaysUseJobPrice?: string | undefined;
-                allowNonJobItem?: string | undefined;
-                jobNumberRequiredFlag?: string | undefined;
-                creditLimit?: number | undefined;
-                paymentTerms?: string | undefined;
-                taxExemptFlag?: string | undefined;
-                addresses?: unknown[] | undefined;
-                contacts?: unknown[] | undefined;
-                shipToAddresses?: unknown[] | undefined;
+                userDefined: {} & {
+                    [k: string]: unknown;
+                };
+                companyId: string;
+                customerName: string | null;
+                class1Id: string | null;
+                class2Id: string | null;
+                class3Id: string | null;
+                class4Id: string | null;
+                class5Id: string | null;
+                webEnabledFlag: string;
+                salesRepId: string | null;
+                poNoRequired: string;
+                termsId: string | null;
+                taxableFlag: string;
+                termsDesc: string | null;
             }[];
             status: number;
+            totalResults: number;
             options?: Record<string, unknown>[] | undefined;
             message?: string | undefined;
-            totalResults?: number | undefined;
             count?: number | undefined;
         }>;
         /**
@@ -114,35 +102,23 @@ export declare class CustomersClient extends BaseServiceClient {
         get: (id: string | number, params?: import("../../core/base-client").CacheParams | undefined) => Promise<{
             data: {
                 customerId: number;
-                dateCreated: string;
-                dateLastModified: string;
-                companyId: string;
-                customerName: string;
-                salesrepId: string;
                 deleteFlag: string;
-                updateCd?: number | undefined;
-                customerUid?: number | undefined;
-                class1Id?: string | undefined;
-                class2Id?: string | undefined;
-                class3Id?: string | undefined;
-                class4Id?: string | undefined;
-                class5Id?: string | undefined;
-                sicCode?: number | undefined;
-                poNoRequired?: string | undefined;
-                defaultBranchId?: string | undefined;
-                webEnabledFlag?: string | undefined;
-                useLastMarginPricingFlag?: string | undefined;
-                sourcePriceCd?: number | undefined;
-                jobPricing?: string | undefined;
-                alwaysUseJobPrice?: string | undefined;
-                allowNonJobItem?: string | undefined;
-                jobNumberRequiredFlag?: string | undefined;
-                creditLimit?: number | undefined;
-                paymentTerms?: string | undefined;
-                taxExemptFlag?: string | undefined;
-                addresses?: unknown[] | undefined;
-                contacts?: unknown[] | undefined;
-                shipToAddresses?: unknown[] | undefined;
+                userDefined: {} & {
+                    [k: string]: unknown;
+                };
+                companyId: string;
+                customerName: string | null;
+                class1Id: string | null;
+                class2Id: string | null;
+                class3Id: string | null;
+                class4Id: string | null;
+                class5Id: string | null;
+                webEnabledFlag: string;
+                salesRepId: string | null;
+                poNoRequired: string;
+                termsId: string | null;
+                taxableFlag: string;
+                termsDesc: string | null;
             };
             status: number;
             options?: Record<string, unknown>[] | undefined;
@@ -162,15 +138,25 @@ export declare class CustomersClient extends BaseServiceClient {
          * ```
          */
         lookup: (params: CustomerLookupParams) => Promise<{
+            options: {
+                filterList: {
+                    delete_flag?: string[] | undefined;
+                    customer_type_cd?: number | undefined;
+                } & {
+                    [k: string]: unknown;
+                };
+                limit?: number | undefined;
+                offset?: number | undefined;
+            };
             data: {
                 customerId: number;
-                customerName: string;
+                customerName: string | null;
             }[];
             status: number;
-            options?: Record<string, unknown>[] | undefined;
+            count: number;
+            total: number;
             message?: string | undefined;
             totalResults?: number | undefined;
-            count?: number | undefined;
         }>;
         /**
          * Customer address management
@@ -194,11 +180,11 @@ export declare class CustomersClient extends BaseServiceClient {
                     state: string;
                     customerId: number;
                     city: string;
+                    zipCode: string;
+                    country: string;
                     addressId: number;
                     addressName: string;
                     address1: string;
-                    zipCode: string;
-                    country: string;
                     phoneNumber?: string | undefined;
                     isPrimary?: boolean | undefined;
                     address2?: string | undefined;
@@ -330,26 +316,32 @@ export declare class CustomersClient extends BaseServiceClient {
              */
             list: (customerId: number, params?: ShipToAddressListParams) => Promise<{
                 data: {
-                    state: string;
                     customerId: number;
-                    city: string;
-                    shipToName: string;
+                    address: {
+                        id: number;
+                        name: string | null;
+                        physState: string | null;
+                        mailState: string | null;
+                        mailAddress1: string | null;
+                        mailAddress2: string | null;
+                        mailCity: string | null;
+                        mailPostalCode: string | null;
+                        mailCountry: string | null;
+                        physAddress1: string | null;
+                        physAddress2: string | null;
+                        physCity: string | null;
+                        physPostalCode: string | null;
+                        physCountry: string | null;
+                    };
                     shipToId: number;
-                    address1: string;
-                    zipCode: string;
-                    country: string;
-                    dateCreated?: string | undefined;
-                    phoneNumber?: string | undefined;
-                    address2?: string | undefined;
-                    contactName?: string | undefined;
-                    deliveryInstructions?: string | undefined;
-                    isDefault?: boolean | undefined;
+                    companyId: string;
+                    defaultBranch: string;
+                    defaultCarrierId: number | null;
                 }[];
-                status: number;
-                options?: Record<string, unknown>[] | undefined;
-                message?: string | undefined;
-                totalResults?: number | undefined;
-                count?: number | undefined;
+                status: 200;
+                message: "Ok";
+                count: number;
+                total: number;
             }>;
             /**
              * Create a new ship-to address for a customer
@@ -372,20 +364,27 @@ export declare class CustomersClient extends BaseServiceClient {
              */
             create: (customerId: number, data: ShipToAddressCreateParams) => Promise<{
                 data: {
-                    state: string;
                     customerId: number;
-                    city: string;
-                    shipToName: string;
+                    address: {
+                        id: number;
+                        name: string | null;
+                        physState: string | null;
+                        mailState: string | null;
+                        mailAddress1: string | null;
+                        mailAddress2: string | null;
+                        mailCity: string | null;
+                        mailPostalCode: string | null;
+                        mailCountry: string | null;
+                        physAddress1: string | null;
+                        physAddress2: string | null;
+                        physCity: string | null;
+                        physPostalCode: string | null;
+                        physCountry: string | null;
+                    };
                     shipToId: number;
-                    address1: string;
-                    zipCode: string;
-                    country: string;
-                    dateCreated?: string | undefined;
-                    phoneNumber?: string | undefined;
-                    address2?: string | undefined;
-                    contactName?: string | undefined;
-                    deliveryInstructions?: string | undefined;
-                    isDefault?: boolean | undefined;
+                    companyId: string;
+                    defaultBranch: string;
+                    defaultCarrierId: number | null;
                 };
                 status: number;
                 options?: Record<string, unknown>[] | undefined;
@@ -459,35 +458,57 @@ export declare class CustomersClient extends BaseServiceClient {
              */
             list: (customerId: number, params: InvoiceListParams) => Promise<{
                 data: {
-                    status: string;
                     customerId: number;
-                    invoiceNo: number;
-                    invoiceDate: string;
-                    dueDate: string;
-                    totalAmount: number;
-                    balanceAmount: number;
-                    shipToId?: number | undefined;
-                    orderNo?: number | undefined;
-                    invoiceLines?: {
+                    taxAmount: number;
+                    lines: {
                         lineNo: number;
-                        quantity: number;
+                        invMastUid: number | null;
+                        unitOfMeasure: string | null;
                         unitPrice: number;
-                        itemId: string;
-                        description: string;
+                        itemId: string | null;
+                        itemDesc: string;
                         extendedPrice: number;
-                    }[] | undefined;
-                    payments?: {
-                        method: string;
-                        paymentDate: string;
-                        amount: number;
-                        reference: string;
-                    }[] | undefined;
+                        qtyRequested: number;
+                        qtyShipped: number;
+                        oderNo: string | null;
+                        oeLineNumber: number | null;
+                    }[];
+                    poNo: string | null;
+                    customerName: string;
+                    orderNo: string | null;
+                    invoiceNo: string;
+                    ship2Name: string | null;
+                    ship2City: string | null;
+                    ship2State: string | null;
+                    ship2Country: string | null;
+                    ship2EmailAddress: string | null;
+                    shipToPhone: string | null;
+                    invoiceDate: string;
+                    ship2Contact: string | null;
+                    ship2Address1: string | null;
+                    ship2Address2: string | null;
+                    ship2Address3: string | null;
+                    ship2PostalCode: string | null;
+                    bill2Name: string | null;
+                    bill2Contact: string | null;
+                    bill2Address1: string | null;
+                    bill2Address2: string | null;
+                    bill2Address3: string | null;
+                    bill2City: string | null;
+                    bill2State: string | null;
+                    bill2PostalCode: string | null;
+                    bill2Country: string | null;
+                    totalAmount: number;
+                    amountPaid: number;
+                    paidInFullFlag: string | null;
+                    taxAmountPaid: number;
+                    shippingCost: number | null;
+                    datePaid: string | null;
                 }[];
                 status: number;
-                options?: Record<string, unknown>[] | undefined;
-                message?: string | undefined;
-                totalResults?: number | undefined;
-                count?: number | undefined;
+                message: string;
+                count: number;
+                total: number;
             }>;
             /**
              * Get specific customer invoice details
@@ -503,35 +524,55 @@ export declare class CustomersClient extends BaseServiceClient {
              */
             get: (customerId: number, invoiceNo: number) => Promise<{
                 data: {
-                    status: string;
                     customerId: number;
-                    invoiceNo: number;
-                    invoiceDate: string;
-                    dueDate: string;
-                    totalAmount: number;
-                    balanceAmount: number;
-                    shipToId?: number | undefined;
-                    orderNo?: number | undefined;
-                    invoiceLines?: {
+                    taxAmount: number;
+                    lines: {
                         lineNo: number;
-                        quantity: number;
+                        invMastUid: number | null;
+                        unitOfMeasure: string | null;
                         unitPrice: number;
-                        itemId: string;
-                        description: string;
+                        itemId: string | null;
+                        itemDesc: string;
                         extendedPrice: number;
-                    }[] | undefined;
-                    payments?: {
-                        method: string;
-                        paymentDate: string;
-                        amount: number;
-                        reference: string;
-                    }[] | undefined;
+                        qtyRequested: number;
+                        qtyShipped: number;
+                        oderNo: string | null;
+                        oeLineNumber: number | null;
+                    }[];
+                    poNo: string | null;
+                    customerName: string;
+                    orderNo: string | null;
+                    invoiceNo: string;
+                    ship2Name: string | null;
+                    ship2City: string | null;
+                    ship2State: string | null;
+                    ship2Country: string | null;
+                    ship2EmailAddress: string | null;
+                    shipToPhone: string | null;
+                    invoiceDate: string;
+                    ship2Contact: string | null;
+                    ship2Address1: string | null;
+                    ship2Address2: string | null;
+                    ship2Address3: string | null;
+                    ship2PostalCode: string | null;
+                    bill2Name: string | null;
+                    bill2Contact: string | null;
+                    bill2Address1: string | null;
+                    bill2Address2: string | null;
+                    bill2Address3: string | null;
+                    bill2City: string | null;
+                    bill2State: string | null;
+                    bill2PostalCode: string | null;
+                    bill2Country: string | null;
+                    totalAmount: number;
+                    amountPaid: number;
+                    paidInFullFlag: string | null;
+                    taxAmountPaid: number;
+                    shippingCost: number | null;
+                    datePaid: string | null;
                 };
                 status: number;
-                options?: Record<string, unknown>[] | undefined;
-                message?: string | undefined;
-                totalResults?: number | undefined;
-                count?: number | undefined;
+                message: string;
             }>;
         };
         /**
@@ -553,31 +594,95 @@ export declare class CustomersClient extends BaseServiceClient {
              */
             list: (customerId: number, params?: QuoteListParams) => Promise<{
                 data: {
-                    status: string;
                     customerId: number;
-                    expirationDate: string;
-                    salesRepId: string;
-                    totalAmount: number;
-                    quoteNo: number;
-                    quoteDate: string;
-                    notes?: string | undefined;
-                    quoteLines?: {
-                        lineNo: number;
-                        quantity: number;
-                        unitPrice: number;
-                        itemId: string;
-                        description: string;
-                        extendedPrice: number;
-                        margin?: number | undefined;
-                    }[] | undefined;
-                    terms?: string | undefined;
-                    validUntil?: string | undefined;
+                    contactId: string | null;
+                    taker: string | null;
+                    lines: {
+                        lineNo: number | null;
+                        invMastUid: number;
+                        unitOfMeasure: string | null;
+                        unitPrice: number | null;
+                        itemId: string | null;
+                        unitQuantity: number | null;
+                        unitSize: string | null;
+                        itemDesc: string | null;
+                        displayDesc: string | null;
+                        deleteFlag: "Y" | "N" | null;
+                        qtyAllocated: number | null;
+                        cancelFlag: "Y" | "N" | null;
+                        complete: "Y" | "N" | null;
+                        disposition: string | null;
+                        orderNo: string | null;
+                        originalQtyOrdered: number | null;
+                        qtyCanceled: number | null;
+                        qtyInvoiced: number | null;
+                        qtyOnPickTickets: number | null;
+                        qtyOrdered: number | null;
+                        extendedPrice: number | null;
+                        trinityItemId: string | null;
+                        trinityItemDesc: string | null;
+                        agentItemId: string | null;
+                        agentItemDesc: string | null;
+                    }[];
+                    poNo: string | null;
+                    customerName: string | null;
+                    class1Id: string | null;
+                    class2Id: string | null;
+                    class3Id: string | null;
+                    class4Id: string | null;
+                    class5Id: string | null;
+                    deliveryInstructions: string | null;
+                    orderNo: string;
+                    carrierId: number | null;
+                    carrierName: string | null;
+                    jobName: string | null;
+                    orderDate: string | null;
+                    requestedDate: string | null;
+                    completed: string | null;
+                    ship2Name: string | null;
+                    ship2Add1: string | null;
+                    ship2Add2: string | null;
+                    ship2Add3: string | null;
+                    ship2City: string | null;
+                    ship2State: string | null;
+                    ship2Zip: string | null;
+                    ship2Country: string | null;
+                    ship2EmailAddress: string | null;
+                    shipToPhone: string | null;
+                    webReferenceNo: string | null;
+                    orderStatus: string;
+                    contactFirstName: string | null;
+                    contactLastName: string | null;
+                    pickTickets: {
+                        lines: {
+                            invMastUid: number;
+                            itemId: string;
+                            lineNumber: number;
+                            itemDesc?: string | null | undefined;
+                            displayDesc?: unknown;
+                            trinityItemId?: string | undefined;
+                            trinityItemDesc?: string | undefined;
+                            agentItemId?: string | undefined;
+                            agentItemDesc?: string | undefined;
+                            shipQuantity?: number | null | undefined;
+                            qtyRequested?: number | null | undefined;
+                        }[];
+                        orderNo: string;
+                        pickTicketNo: string;
+                        carrierName: string;
+                        trackingNo?: string | null | undefined;
+                        invoiceNo?: string | null | undefined;
+                        shipDate?: string | null | undefined;
+                        printedFlag?: string | null | undefined;
+                        printDate?: string | null | undefined;
+                        instructions?: string | null | undefined;
+                        carrierId?: number | null | undefined;
+                    }[];
                 }[];
-                status: number;
-                options?: Record<string, unknown>[] | undefined;
-                message?: string | undefined;
-                totalResults?: number | undefined;
-                count?: number | undefined;
+                status: 200;
+                message: "Ok";
+                count: number;
+                total: number;
             }>;
             /**
              * Get specific customer quote details
@@ -593,31 +698,93 @@ export declare class CustomersClient extends BaseServiceClient {
              */
             get: (customerId: number, quoteNo: number) => Promise<{
                 data: {
-                    status: string;
                     customerId: number;
-                    expirationDate: string;
-                    salesRepId: string;
-                    totalAmount: number;
-                    quoteNo: number;
-                    quoteDate: string;
-                    notes?: string | undefined;
-                    quoteLines?: {
-                        lineNo: number;
-                        quantity: number;
-                        unitPrice: number;
-                        itemId: string;
-                        description: string;
-                        extendedPrice: number;
-                        margin?: number | undefined;
-                    }[] | undefined;
-                    terms?: string | undefined;
-                    validUntil?: string | undefined;
+                    contactId: string | null;
+                    taker: string | null;
+                    lines: {
+                        lineNo: number | null;
+                        invMastUid: number;
+                        unitOfMeasure: string | null;
+                        unitPrice: number | null;
+                        itemId: string | null;
+                        unitQuantity: number | null;
+                        unitSize: string | null;
+                        itemDesc: string | null;
+                        displayDesc: string | null;
+                        deleteFlag: "Y" | "N" | null;
+                        qtyAllocated: number | null;
+                        cancelFlag: "Y" | "N" | null;
+                        complete: "Y" | "N" | null;
+                        disposition: string | null;
+                        orderNo: string | null;
+                        originalQtyOrdered: number | null;
+                        qtyCanceled: number | null;
+                        qtyInvoiced: number | null;
+                        qtyOnPickTickets: number | null;
+                        qtyOrdered: number | null;
+                        extendedPrice: number | null;
+                        trinityItemId: string | null;
+                        trinityItemDesc: string | null;
+                        agentItemId: string | null;
+                        agentItemDesc: string | null;
+                    }[];
+                    poNo: string | null;
+                    customerName: string;
+                    class1Id: string | null;
+                    class2Id: string | null;
+                    class3Id: string | null;
+                    class4Id: string | null;
+                    class5Id: string | null;
+                    deliveryInstructions: string | null;
+                    orderNo: string;
+                    carrierId: number | null;
+                    carrierName: string;
+                    jobName: string | null;
+                    orderDate: string | null;
+                    requestedDate: string | null;
+                    completed: "Y" | "N" | null;
+                    ship2Name: string | null;
+                    ship2Add1: string | null;
+                    ship2Add2: string | null;
+                    ship2Add3: string | null;
+                    ship2City: string | null;
+                    ship2State: string | null;
+                    ship2Zip: string | null;
+                    ship2Country: string | null;
+                    ship2EmailAddress: string | null;
+                    shipToPhone: string | null;
+                    webReferenceNo: string | null;
+                    orderStatus: "PENDING" | "SHIPPED" | "ON HOLD" | "IN PROCESS" | "SUBMITTED";
+                    contactFirstName: string | null;
+                    contactLastName: string | null;
+                    pickTickets: {
+                        lines: {
+                            invMastUid: number;
+                            itemId: string;
+                            lineNumber: number;
+                            itemDesc?: string | null | undefined;
+                            displayDesc?: unknown;
+                            trinityItemId?: string | undefined;
+                            trinityItemDesc?: string | undefined;
+                            agentItemId?: string | undefined;
+                            agentItemDesc?: string | undefined;
+                            shipQuantity?: number | null | undefined;
+                            qtyRequested?: number | null | undefined;
+                        }[];
+                        orderNo: string;
+                        pickTicketNo: string;
+                        carrierName: string;
+                        trackingNo?: string | null | undefined;
+                        invoiceNo?: string | null | undefined;
+                        shipDate?: string | null | undefined;
+                        printedFlag?: string | null | undefined;
+                        printDate?: string | null | undefined;
+                        instructions?: string | null | undefined;
+                        carrierId?: number | null | undefined;
+                    }[];
                 };
-                status: number;
-                options?: Record<string, unknown>[] | undefined;
-                message?: string | undefined;
-                totalResults?: number | undefined;
-                count?: number | undefined;
+                status: 200;
+                message: "Ok";
             }>;
         };
         /**
@@ -641,22 +808,20 @@ export declare class CustomersClient extends BaseServiceClient {
              */
             list: (customerId: number, params?: PurchasedItemListParams) => Promise<{
                 data: {
+                    count: number;
+                    customerId: number;
+                    invMastUid: number;
                     itemId: string;
-                    itemDescription: string;
-                    lastPurchaseDate: string;
-                    lastPurchasePrice: number;
-                    totalQuantityPurchased: number;
-                    totalAmountPurchased: number;
-                    firstPurchaseDate: string;
-                    lastOrderNo: number;
-                    averagePrice: number;
-                    purchaseFrequency: string;
+                    itemDesc: string | null;
+                    displayDesc: string | null;
+                    invoices: number;
+                    lastOrderNo: string | null;
+                    dateLastPurchased: string | null;
                 }[];
-                status: number;
-                options?: Record<string, unknown>[] | undefined;
-                message?: string | undefined;
-                totalResults?: number | undefined;
-                count?: number | undefined;
+                status: 200;
+                message: string;
+                count: number;
+                total: number;
             }>;
         };
     };
@@ -724,10 +889,7 @@ export declare class CustomersClient extends BaseServiceClient {
                 id: string;
                 customerId: number;
                 webAllowance: number;
-                orderStartDate: string;
-                currentUsage: number;
-                remainingAllowance: number;
-                lastUpdated: string;
+                orderStartDate: string | null;
             };
             status: number;
             options?: Record<string, unknown>[] | undefined;
@@ -779,12 +941,12 @@ export declare class CustomersClient extends BaseServiceClient {
         getUserDefinedFields: (contactId: number) => Promise<{
             data: {
                 contactId: number;
-                lastUpdated: string;
                 customFields: {
                     fieldName: string;
                     fieldValue: string;
                     fieldType: string;
                 }[];
+                lastUpdated: string;
             };
             status: number;
             options?: Record<string, unknown>[] | undefined;