@hectare/platform.clients.customers 1.1.1

package/models/UserProfile.d.ts

@@ -0,0 +1,253 @@
+export type UserProfile = {
+    organisation: {
+        id?: string;
+        location?: {
+            what3words: string | null;
+            address: {
+                name?: string | null;
+                line1: string;
+                line2?: string | null;
+                line3?: string | null;
+                city?: string | null;
+                region?: string | null;
+                regionISO?: string | null;
+                postcode: string;
+                countryName?: string | null;
+                countryISO: 'GB' | 'US' | 'ZA' | 'FR';
+            };
+            coordinates: {
+                lat: number;
+                lon: number;
+            };
+        } | null;
+        company?: {
+            assurances?: Array<{
+                id: string | null;
+                body: 'RT' | 'SQC';
+                assured: boolean;
+            }>;
+            assurance?: {
+                id: string | null;
+                body: 'RT' | 'SQC';
+            };
+            id?: string | null;
+            bio?: string | null;
+            website?: string | null;
+            holdingNumber?: string | null;
+            number?: string | null;
+            salesTaxId?: string | null;
+            logo?: {
+                id: string;
+                url: string | null;
+            } | null;
+        };
+        companyNumber?: string | null;
+        countryISO?: 'GB' | 'US' | 'ZA' | 'FR';
+        name?: string;
+        ownerContact?: {
+            id?: string;
+            email?: string;
+            phone?: {
+                callingCode: string;
+                number: string;
+            };
+            familyName?: string;
+            givenName?: string;
+            authPlatformId?: string;
+        };
+        sqc?: {
+            number: string;
+            isAssured: boolean;
+        } | null;
+        assuranceScheme?: 'RT' | 'SQC';
+        settlementContacts?: Array<{
+            name: string;
+            email: string;
+        }>;
+        status?: 'active' | 'pending' | 'suspended';
+        statusMessage?: string;
+        businessUnits?: Array<{
+            id: string;
+            name: string;
+            type: string;
+            business: string;
+            region: string;
+            tags: Array<string>;
+        }>;
+        businessConnections?: Array<{
+            organisationId?: string;
+            organisationName?: string;
+            relationship?: Array<string>;
+            contacts?: Array<{
+                givenName?: string;
+                familyName?: string;
+                phone?: {
+                    callingCode: string;
+                    number: string;
+                };
+                email?: string;
+                id?: string;
+                authPlatformId?: string;
+            }>;
+            location?: {
+                what3words: string | null;
+                address: {
+                    name?: string | null;
+                    line1: string;
+                    line2?: string | null;
+                    line3?: string | null;
+                    city?: string | null;
+                    region?: string | null;
+                    regionISO?: string | null;
+                    postcode: string;
+                    countryName?: string | null;
+                    countryISO: 'GB' | 'US' | 'ZA' | 'FR';
+                };
+                coordinates: {
+                    lat: number;
+                    lon: number;
+                };
+            } | null;
+            countryISO?: 'GB' | 'US' | 'ZA' | 'FR';
+            ownerContact?: {
+                id?: string;
+                email?: string;
+                familyName?: string;
+                givenName?: string;
+                phone?: {
+                    callingCode: string;
+                    number: string;
+                };
+            };
+        }>;
+        billing?: {
+            amount: number;
+            currency: string;
+            period: 'month' | 'quarter' | 'year';
+        } | null;
+        modules?: Array<{
+            id: string;
+            name?: string | null;
+            price: {
+                amount: number;
+                currency: string;
+            } | null;
+        }>;
+        vetted?: boolean;
+        isMerchant?: boolean;
+        createdAtUTC?: string;
+        advancePay?: {
+            accountName: string;
+            sortCode: string;
+            accountNumber: string;
+            enabled: boolean;
+            eligible: boolean;
+        } | null;
+        salesforceId?: string;
+    };
+    user: {
+        id?: string;
+        givenName?: string;
+        type?: 'internal' | 'external';
+        familyName?: string;
+        name?: string;
+        countryISO?: 'GB' | 'US' | 'ZA' | 'FR';
+        email?: string;
+        pushToken?: string;
+        external?: boolean;
+        impersonating?: boolean;
+        settings?: {
+            terms: boolean;
+            marketing?: boolean;
+            marketingPreferences: {
+                marketUpdates: boolean;
+                communications: boolean;
+            };
+            whatsApp: boolean;
+            sms: boolean;
+            onboardingProgress: Array<(number | string)> | null;
+            harvestNotificationDismissed: boolean;
+            harvestDialogDismissed: boolean;
+            listingsWelcomeRead: boolean;
+        };
+        tokens?: {
+            id?: string;
+            access?: string;
+            refresh?: string;
+            expiresIn?: number;
+        };
+        groups?: Array<string>;
+        roles?: Array<string>;
+        profiles?: Array<{
+            organisationId: string;
+            businessUnits: Array<string>;
+            roles: Array<string>;
+        }>;
+        preferences?: Array<{
+            commodity: number;
+            grades: Array<number>;
+            regions: Array<string>;
+        }>;
+        phone?: {
+            callingCode: string;
+            number: string;
+        };
+        phoneLandline?: {
+            callingCode: string;
+            number: string;
+        };
+        avatar?: {
+            name?: string;
+            id: string;
+            url?: string | null;
+            userId?: string | null;
+            userName?: string | null;
+            organisationId?: string | null;
+            createdAtUTC?: string | null;
+        } | null;
+        organisationId?: string;
+        organisationName?: string;
+        authPlatformId?: string;
+        status?: 'active' | 'pending' | 'inactive' | 'deleted';
+        businessUnits?: Array<{
+            id: string;
+            name: string;
+            type: string;
+            business: string;
+            region: string;
+            tags: Array<string>;
+        }>;
+        notificationsEnabled?: boolean;
+    };
+    access: {
+        administrator: boolean;
+        menu: boolean;
+        system: Record<string, {
+            read?: boolean;
+            write?: boolean;
+        }>;
+        inventory: Record<string, {
+            read?: boolean;
+            write?: boolean;
+        }>;
+        account: Record<string, {
+            read?: boolean;
+            write?: boolean;
+        }>;
+        trading: Record<string, {
+            read?: boolean;
+            write?: boolean;
+        }>;
+        logistics: Record<string, {
+            read?: boolean;
+            write?: boolean;
+        }>;
+    };
+    features?: Record<string, boolean>;
+    tokens?: {
+        id?: string;
+        access?: string;
+        refresh?: string;
+        expiresIn?: number;
+    } | null;
+};

package/models/UserProfile.js

@@ -0,0 +1 @@
+export {};

package/models/VerifyMagicLogin.d.ts

@@ -0,0 +1,3 @@
+export type VerifyMagicLogin = {
+    id: string;
+};

package/models/VerifyMagicLogin.js

@@ -0,0 +1 @@
+export {};

package/models/VerifyUpdate.d.ts

@@ -0,0 +1,4 @@
+export type VerifyUpdate = {
+    username: string;
+    confirmationCode: string;
+};

package/models/VerifyUpdate.js

@@ -0,0 +1 @@
+export {};

package/models/VerifyUserAttribute.d.ts

@@ -0,0 +1,3 @@
+export type VerifyUserAttribute = {
+    code: string;
+};

package/models/VerifyUserAttribute.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@hectare/platform.clients.customers",
+  "version": "1.1.1",
+  "main": "index.js",
+  "exported": true,
+  "types": "index.d.ts",
+  "type": "commonjs",
+  "author": "engineering@wearehectare.com",
+  "source": "index.js",
+  "publishConfig": {
+    "access": "public"
+  }
+}