@hectare/platform.clients.customers 1.1.1

package/models/OrganisationSummary.d.ts

@@ -0,0 +1,83 @@
+export type OrganisationSummary = {
+    id?: string;
+    createdAtUTC?: string;
+    name?: 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';
+    status?: 'active' | 'pending' | 'deleted';
+    companyId?: string;
+    companyHoldingNumber?: string;
+    bio?: string;
+    logo?: {
+        name?: string;
+        id: string;
+        url?: string | null;
+        userId?: string | null;
+        userName?: string | null;
+        organisationId?: string | null;
+        createdAtUTC?: string | null;
+    } | null;
+    ownerContact?: {
+        id?: string;
+        email?: string;
+        familyName?: string;
+        givenName?: string;
+        authPlatformId?: string;
+        organisationId?: string;
+        countryISO?: 'GB' | 'US' | 'ZA' | 'FR';
+        phone?: {
+            callingCode: string;
+            number: string;
+        };
+        pushToken?: string;
+    };
+    billing?: {
+        amount: number;
+        currency: string;
+        period: 'month' | 'quarter' | 'year';
+    } | null;
+    settlementContacts?: Array<{
+        name: string;
+        email: string;
+    }>;
+    modules?: Array<{
+        id: string;
+        name?: string | null;
+        price: {
+            amount: number;
+            currency: string;
+        } | null;
+    }>;
+    vetted?: boolean;
+    isMerchant?: boolean;
+    sqc?: {
+        number: string;
+        isAssured: boolean;
+    } | null;
+    assuranceScheme?: 'RT' | 'SQC';
+    advancePay?: {
+        accountName: string;
+        sortCode: string;
+        accountNumber: string;
+        enabled: boolean;
+        eligible: boolean;
+    } | null;
+};

package/models/OrganisationSummary.js

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

package/models/PatchBusinessUnit.d.ts

@@ -0,0 +1,44 @@
+export type PatchBusinessUnit = {
+    name?: string | null;
+    business?: {
+        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;
+        name?: string;
+        phoneNumber?: string | null;
+        email?: string;
+        locationTag?: string;
+        managementTag?: string;
+        holdingNumber?: string | null;
+        sqc?: {
+            number: string;
+            isAssured: boolean;
+        } | null;
+        assuranceScheme?: 'RT' | 'SQC';
+        assurances?: Array<{
+            id: string | null;
+            body: 'RT' | 'SQC';
+            assured: boolean;
+        }>;
+        assurance?: {
+            id: string | null;
+            body: 'RT' | 'SQC';
+        };
+    };
+};

package/models/PatchBusinessUnit.js

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

package/models/PatchOrganisation.d.ts

@@ -0,0 +1,91 @@
+export type PatchOrganisation = {
+    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;
+        sqc?: {
+            number: string;
+            isAssured: boolean;
+        } | null;
+        assuranceScheme?: 'RT' | 'SQC';
+    } | null;
+    name?: string | null;
+    countryISO?: 'GB' | 'US' | 'ZA' | 'FR';
+    ownerContact?: {
+        phone: string | null;
+        email: string;
+        familyName: string;
+        givenName: string;
+    } | null;
+    contacts?: Array<{
+        phone: string | null;
+        email: string;
+        familyName: string;
+        givenName: string;
+    } | null>;
+    organisers?: Array<string>;
+    salesforceId?: string | null;
+    billing?: {
+        amount: number;
+        currency: string;
+        period: 'month' | 'quarter' | 'year';
+    } | null;
+    modules?: Array<{
+        id: string;
+        name?: string | null;
+        price: {
+            amount: number;
+            currency: string;
+        } | null;
+    }>;
+    signupPurpose?: Array<number>;
+    companyNumber?: string | null;
+    companySalesTaxId?: string | null;
+    settlementContacts?: Array<{
+        name: string;
+        email: string;
+    }> | null;
+    logo?: {
+        id: string;
+        url: string | null;
+    } | null;
+    status?: string | null;
+    statusMessage?: string | null;
+    vetted?: boolean;
+    isMerchant?: boolean;
+};

package/models/PatchOrganisation.js

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

package/models/PatchOrganisationAdvancePay.d.ts

@@ -0,0 +1,6 @@
+export type PatchOrganisationAdvancePay = {
+    accountName: string;
+    sortCode: string;
+    accountNumber: string;
+    status?: boolean | null;
+};

package/models/PatchOrganisationAdvancePay.js

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

package/models/PatchUser.d.ts

@@ -0,0 +1,28 @@
+export type PatchUser = {
+    givenName?: string;
+    familyName?: string;
+    countryISO?: 'GB' | 'US' | 'ZA' | 'FR';
+    organisationId?: string;
+    email?: string;
+    phone?: string | null;
+    pushToken?: string | null;
+    roles?: Array<string> | null;
+    businessUnits?: Array<string> | null;
+    phoneLandline?: string | null;
+    avatar?: {
+        id: string;
+        url: string | null;
+    } | null;
+    termsAgreed?: boolean | null;
+    marketingEmails?: boolean | null;
+    marketingPreferences?: {
+        marketUpdates: boolean | null;
+        communications: boolean | null;
+    };
+    whatsAppNotifications?: boolean | null;
+    smsNotifications?: boolean | null;
+    onboardingProgress?: Array<(number | string)> | null;
+    harvestNotificationDismissed?: boolean | null;
+    harvestDialogDismissed?: boolean | null;
+    listingsWelcomeRead?: boolean | null;
+};

package/models/PatchUser.js

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

package/models/RedTractorCertificate.d.ts

@@ -0,0 +1,20 @@
+export type RedTractorCertificate = {
+    certificateStatus?: 'Valid' | 'Grace';
+    certificateIdentifier?: string;
+    certificateEnterprises?: Array<{
+        enterpriseIdentifier?: string;
+        enterprise?: string;
+    }>;
+    certificateExpiryDate?: string;
+    certifiedSites?: Array<{
+        siteIdentifiers?: {
+            identifierType?: string;
+            identifier?: string;
+        };
+        isPrimary?: boolean;
+        siteCountry?: string;
+        sitePostcode?: string;
+        siteAddress?: string;
+        siteName?: string;
+    }>;
+};

package/models/RedTractorCertificate.js

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

package/models/RequestFullAccountSchema.d.ts

@@ -0,0 +1,10 @@
+export type RequestFullAccountSchema = {
+    requestType: 'account' | 'tradingBuyerAccount';
+    firstName: string;
+    lastName: string;
+    businessName: string;
+    referralCode?: string;
+    companyNumber: string | null;
+    emailAddress: string;
+    phone: string | null;
+};

package/models/RequestFullAccountSchema.js

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

package/models/SendMagicLogin.d.ts

@@ -0,0 +1,4 @@
+export type SendMagicLogin = {
+    id: string;
+    redirect: string;
+};

package/models/SendMagicLogin.js

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

package/models/SetBuyerPreferences.d.ts

@@ -0,0 +1,6 @@
+export type SetBuyerPreferences = Array<{
+    commodity: number | null;
+    grades: Array<number>;
+    regions: Array<string>;
+    enabled?: boolean;
+}>;

package/models/SetBuyerPreferences.js

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

package/models/SwapCognitoUserPoolRequest.d.ts

@@ -0,0 +1,4 @@
+export type SwapCognitoUserPoolRequest = {
+    username: string;
+    password?: string;
+};

package/models/SwapCognitoUserPoolRequest.js

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

package/models/SwapCognitoUserPoolResponse.d.ts

@@ -0,0 +1,5 @@
+export type SwapCognitoUserPoolResponse = {
+    status?: 'not-found' | 'not-authorised' | 'success';
+    authenticated?: boolean;
+    id?: string;
+};

package/models/SwapCognitoUserPoolResponse.js

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

package/models/UserAccess.d.ts

@@ -0,0 +1,24 @@
+export type UserAccess = {
+    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;
+    }>;
+};

package/models/UserAccess.js

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

package/models/UserBasicInfo.d.ts

@@ -0,0 +1,71 @@
+export type UserBasicInfo = {
+    id: string;
+    givenName: string;
+    familyName: string;
+    countryISO: 'GB' | 'US' | 'ZA' | 'FR';
+    organisationName?: string;
+    organisationId?: string;
+    email: string;
+    phone: {
+        callingCode: string;
+        number: string;
+    };
+    pushToken?: string;
+    organisation: {
+        id: string;
+        name: string;
+        bio: string;
+        logo: {
+            id?: string;
+            url?: 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;
+        modules?: Array<{
+            id: string;
+            name?: string | null;
+            price: {
+                amount: number;
+                currency: string;
+            } | null;
+        }>;
+    };
+    preferences?: Array<{
+        commodity: number | null;
+        grades: Array<number>;
+        regions: Array<string>;
+        enabled?: 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;
+    };
+    authPlatformId?: string;
+};

package/models/UserBasicInfo.js

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

package/models/UserDetail.d.ts

@@ -0,0 +1,74 @@
+export type UserDetail = {
+    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;
+};

package/models/UserDetail.js

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