@hectare/platform.clients.customers 1.1.1

package/models/CreateOrganisationResponse.d.ts

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

package/models/CreateOrganisationResponse.js

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

package/models/CreateUnvettedOrganisationSchema.d.ts

@@ -0,0 +1,11 @@
+export type CreateUnvettedOrganisationSchema = {
+    givenName: string;
+    familyName: string;
+    email: string;
+    phone: string | null;
+    businessName: string;
+    referralCode?: string;
+    holdingOrMembershipNumber?: string | null;
+    modules: Array<string>;
+    signupPurpose?: Array<number>;
+};

package/models/CreateUnvettedOrganisationSchema.js

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

package/models/CreateUser.d.ts

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

package/models/CreateUser.js

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

package/models/CustomerConfig.d.ts

@@ -0,0 +1,6 @@
+export type CustomerConfig = {
+    signupPurposes?: Array<{
+        id?: number;
+        description?: string;
+    }>;
+};

package/models/CustomerConfig.js

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

package/models/ForgottenPassword.d.ts

@@ -0,0 +1,3 @@
+export type ForgottenPassword = {
+    username: string;
+};

package/models/ForgottenPassword.js

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

package/models/ForgottenPasswordConfirm.d.ts

@@ -0,0 +1,6 @@
+export type ForgottenPasswordConfirm = {
+    username: string;
+    password?: string;
+    passwordConfirm?: string;
+    confirmationCode?: string;
+};

package/models/ForgottenPasswordConfirm.js

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

package/models/LoginForm.d.ts

@@ -0,0 +1,5 @@
+export type LoginForm = {
+    username: string;
+    password: string;
+    newPassword?: string;
+};

package/models/LoginForm.js

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

package/models/LoginSuccess.d.ts

@@ -0,0 +1,16 @@
+export type LoginSuccess = {
+    tokens?: {
+        id?: string;
+        access?: string;
+        refresh?: string;
+        expiresIn?: number;
+    };
+    challenge?: {
+        session: string;
+        challengeParameters: {
+            missingAttributes?: Array<string>;
+            authPlatformId: string;
+        };
+        challengeName: string;
+    } | null;
+};

package/models/LoginSuccess.js

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

package/models/LoginTokens.d.ts

@@ -0,0 +1,6 @@
+export type LoginTokens = {
+    id?: string;
+    access?: string;
+    refresh?: string;
+    expiresIn?: number;
+};

package/models/LoginTokens.js

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

package/models/LookupUserByTelephoneSchema.d.ts

@@ -0,0 +1,3 @@
+export type LookupUserByTelephoneSchema = {
+    phone?: string | null;
+};

package/models/LookupUserByTelephoneSchema.js

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

package/models/OrganisationDetail.d.ts

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

package/models/OrganisationDetail.js

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

package/models/OrganisationExists.d.ts

@@ -0,0 +1,150 @@
+export type OrganisationExists = {
+    status?: 'ok' | 'user-exists' | 'organisation-exists';
+    blockNewConnection?: boolean;
+    organisations?: Array<{
+        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;
+    }>;
+};

package/models/OrganisationExists.js

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