@natch-the-storage/heathershaw-platform-types 1.14.3 → 1.15.1

package/build/validators.d.ts

@@ -590,6 +590,90 @@ export interface CDScript {
     };
     itemCount: number;
 }
+/**
+ * A customer object from Compound Direct
+ * @dateOfBirth IsoDateString, only date portion
+ * @createdDate IsoString with timestamp
+ * @modifiedDate IsoString with timestamp
+ * @address2 Usually empty
+ */
+export interface CDCustomer {
+    id: number;
+    customerId: number;
+    firstName: string;
+    lastName: string;
+    initials: string;
+    name: string;
+    mobile: string;
+    email: string;
+    createdDate: string;
+    modifiedDate: string;
+    isAnimal: false;
+    dateOfBirth: string;
+    isMobileInvalid: boolean;
+    note: string;
+    noteImportance: string;
+    barcode: string;
+    availableBarcodes: string[];
+    barcodeCheckDigit: number;
+    address1: string;
+    address2: string;
+    suburb: string;
+    state: string;
+    postCode: string;
+    formattedAddress: string;
+    address: string;
+    refillRemindersEnabled: boolean;
+    aus: {};
+    availableCount: number;
+    orderCount: number;
+    recentOrderCount: number;
+    additionalAddresses: CDAddress[];
+    notes: CDCustomerNote[];
+    activeRefillRemindersCount: number;
+}
+/**
+ * Object in the notes field of CDCustomer
+ * @modifiedDate iso string with timestamp
+ */
+export interface CDCustomerNote {
+    noteId: number;
+    customerId: number;
+    actionType: string;
+    actionMessage: string;
+    comments: string;
+    userName: string;
+    userSub: string;
+    createdDate: string;
+    changeSetId: number;
+    modifiedDate: string;
+    noteImportance: string;
+}
+/**
+ * Address object in the addtionalAddresses field of CDCustomer
+ * @createdDate IsoString with timestamp
+ * @modifiedDate IsoString with timestamp
+ */
+export interface CDAddress {
+    additionalAddressId: number;
+    addressGuid: string;
+    type: string;
+    deliveryInstructions: string;
+    createdDate: string;
+    modifiedDate: string;
+    customerId: number;
+    createdByUserName: string;
+    createdByUserSub: string;
+    modifiedByUserName: string;
+    modifiedByUserSub: string;
+    address1: string;
+    address2: string;
+    suburb: string;
+    state: string;
+    postCode: string;
+    formattedAddress: string;
+    address: string;
+}
 export interface CDCustomerCreate {
     firstName: string;
     lastName: string;
@@ -603,6 +687,12 @@ export interface CDCustomerCreate {
     animalSpecies?: typeof AnimalSpeciesKeys;
     animalOwnerName?: string;
 }
+/**
+ * Fields that can be updated on the portal for a CDCustomer
+ */
+export type CDCustomerUpdate = Partial<CDCustomerCreate> & {
+    id: number;
+};
 export interface CDCustomerSearch {
     query: string;
     dobStartDate: string;
@@ -753,6 +843,7 @@ export declare const ApiRoutes: {
     compoundDirect: {
         searchCustomers: string;
         createCustomer: string;
+        updateCustomer: string;
         getDraftScripts: string;
         getDraftScriptById: (id: number) => string;
         getHouseholdDraftScripts: string;

package/build/validators.js

@@ -229,7 +229,8 @@ export const ApiRoutes = {
     },
     compoundDirect: {
         searchCustomers: '/api/compound-direct/customers',
-        createCustomer: '/api/compound-direct/customer',
+        createCustomer: '/api/compound-direct/new-customers',
+        updateCustomer: '/api/compound-direct/customers',
         getDraftScripts: '/api/compound-direct/draft-scripts',
         getDraftScriptById: (id) => `/api/compound-direct/draft-scripts/${id}`,
         getHouseholdDraftScripts: '/api/compound-direct/scripts/households',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@natch-the-storage/heathershaw-platform-types",
-  "version": "1.14.3",
+  "version": "1.15.1",
   "description": "Interfaces and routes to use on the client",
   "license": "ISC",
   "author": "Natch Surana",