@hectare/platform.clients.customers 1.1.1

package/index.d.ts

@@ -0,0 +1,49 @@
+export type { AssuranceDetail } from './models/AssuranceDetail.js';
+export type { BusinessConnectionDetail } from './models/BusinessConnectionDetail.js';
+export type { BusinessConnectionsSummary } from './models/BusinessConnectionsSummary.js';
+export type { BusinessDetail } from './models/BusinessDetail.js';
+export type { BusinessUnitsDetail } from './models/BusinessUnitsDetail.js';
+export type { BusinessUnitsDetails } from './models/BusinessUnitsDetails.js';
+export type { BusinessUnitsSummary } from './models/BusinessUnitsSummary.js';
+export type { BusinessUnitSummary } from './models/BusinessUnitSummary.js';
+export type { BuyerPreferencesSchema } from './models/BuyerPreferencesSchema.js';
+export type { ChangeOwner } from './models/ChangeOwner.js';
+export type { ChangePassword } from './models/ChangePassword.js';
+export type { CheckBusinessConnectionRequestSchema } from './models/CheckBusinessConnectionRequestSchema.js';
+export type { CheckBusinessConnectionResponseSchema } from './models/CheckBusinessConnectionResponseSchema.js';
+export type { ConfirmSignup } from './models/ConfirmSignup.js';
+export type { ContactDetail } from './models/ContactDetail.js';
+export type { CreateBusinessConnection } from './models/CreateBusinessConnection.js';
+export type { CreateBusinessUnit } from './models/CreateBusinessUnit.js';
+export type { CreateBusinessUnits } from './models/CreateBusinessUnits.js';
+export type { CreateOrganisation } from './models/CreateOrganisation.js';
+export type { CreateOrganisationResponse } from './models/CreateOrganisationResponse.js';
+export type { CreateUnvettedOrganisationSchema } from './models/CreateUnvettedOrganisationSchema.js';
+export type { CreateUser } from './models/CreateUser.js';
+export type { CustomerConfig } from './models/CustomerConfig.js';
+export type { ForgottenPassword } from './models/ForgottenPassword.js';
+export type { ForgottenPasswordConfirm } from './models/ForgottenPasswordConfirm.js';
+export type { LoginForm } from './models/LoginForm.js';
+export type { LoginSuccess } from './models/LoginSuccess.js';
+export type { LoginTokens } from './models/LoginTokens.js';
+export type { LookupUserByTelephoneSchema } from './models/LookupUserByTelephoneSchema.js';
+export type { OrganisationDetail } from './models/OrganisationDetail.js';
+export type { OrganisationExists } from './models/OrganisationExists.js';
+export type { OrganisationSummary } from './models/OrganisationSummary.js';
+export type { PatchBusinessUnit } from './models/PatchBusinessUnit.js';
+export type { PatchOrganisation } from './models/PatchOrganisation.js';
+export type { PatchOrganisationAdvancePay } from './models/PatchOrganisationAdvancePay.js';
+export type { PatchUser } from './models/PatchUser.js';
+export type { RedTractorCertificate } from './models/RedTractorCertificate.js';
+export type { RequestFullAccountSchema } from './models/RequestFullAccountSchema.js';
+export type { SendMagicLogin } from './models/SendMagicLogin.js';
+export type { SetBuyerPreferences } from './models/SetBuyerPreferences.js';
+export type { SwapCognitoUserPoolRequest } from './models/SwapCognitoUserPoolRequest.js';
+export type { SwapCognitoUserPoolResponse } from './models/SwapCognitoUserPoolResponse.js';
+export type { UserAccess } from './models/UserAccess.js';
+export type { UserBasicInfo } from './models/UserBasicInfo.js';
+export type { UserDetail } from './models/UserDetail.js';
+export type { UserProfile } from './models/UserProfile.js';
+export type { VerifyMagicLogin } from './models/VerifyMagicLogin.js';
+export type { VerifyUpdate } from './models/VerifyUpdate.js';
+export type { VerifyUserAttribute } from './models/VerifyUserAttribute.js';

package/index.js

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

package/models/AssuranceDetail.d.ts

@@ -0,0 +1,14 @@
+export type AssuranceDetail = {
+    membershipId: string;
+    name: string;
+    holdingNumber: string;
+    county: string;
+    postcode: string;
+    address: string;
+    contactName: string;
+    scheme: 'RT' | 'SQC';
+    assured: boolean;
+    certificationStartDate: string;
+    certificationEndDate: string;
+    certificateUrl: string;
+};

package/models/AssuranceDetail.js

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

package/models/BusinessConnectionDetail.d.ts

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

package/models/BusinessConnectionDetail.js

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

package/models/BusinessConnectionsSummary.d.ts

@@ -0,0 +1,49 @@
+export type BusinessConnectionsSummary = {
+    id?: string;
+    connectedOrganisations?: 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;
+            };
+        };
+    }>;
+};

package/models/BusinessConnectionsSummary.js

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

package/models/BusinessDetail.d.ts

@@ -0,0 +1,49 @@
+export type BusinessDetail = {
+    id?: string;
+    businessUnitId?: string;
+    organisationId?: 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;
+    businessName?: string;
+    name?: string;
+    phone?: {
+        callingCode: string;
+        number: string;
+    };
+    email?: string;
+    tags?: Array<string>;
+    locationTag?: string;
+    managementTag?: string;
+    assuranceScheme?: 'RT' | 'SQC';
+    holdingNumber?: string;
+    sqc?: {
+        number: string;
+        isAssured: boolean;
+    } | null;
+    assurances?: Array<{
+        id: string | null;
+        body: 'RT' | 'SQC';
+        assured: boolean;
+    }>;
+    assurance?: {
+        id: string | null;
+        body: 'RT' | 'SQC';
+    };
+};

package/models/BusinessDetail.js

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

package/models/BusinessUnitSummary.d.ts

@@ -0,0 +1,8 @@
+export type BusinessUnitSummary = {
+    id: string;
+    name: string;
+    type: string;
+    business: string;
+    region: string;
+    tags: Array<string>;
+};

package/models/BusinessUnitSummary.js

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

package/models/BusinessUnitsDetail.d.ts

@@ -0,0 +1,58 @@
+export type BusinessUnitsDetail = {
+    ordinal: number;
+    id: string;
+    name: string;
+    type: 'farm' | 'stores' | 'region';
+    tags: Array<string>;
+    business?: {
+        id?: string;
+        businessUnitId?: string;
+        organisationId?: 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;
+        businessName?: string;
+        name?: string;
+        phone?: {
+            callingCode: string;
+            number: string;
+        };
+        email?: string;
+        tags?: Array<string>;
+        locationTag?: string;
+        managementTag?: string;
+        assuranceScheme?: 'RT' | 'SQC';
+        holdingNumber?: string;
+        sqc?: {
+            number: string;
+            isAssured: boolean;
+        } | null;
+        assurances?: Array<{
+            id: string | null;
+            body: 'RT' | 'SQC';
+            assured: boolean;
+        }>;
+        assurance?: {
+            id: string | null;
+            body: 'RT' | 'SQC';
+        };
+    };
+    storeCount?: number;
+    fieldCount?: number;
+};

package/models/BusinessUnitsDetail.js

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

package/models/BusinessUnitsDetails.d.ts

@@ -0,0 +1,68 @@
+export type BusinessUnitsDetails = {
+    id: string;
+    organisationId: string;
+    organisationName: string;
+    organisationRegionISO?: string;
+    tagGroups?: Array<{
+        name: string;
+        tags: Array<string>;
+    }>;
+    businessUnits: Array<{
+        ordinal: number;
+        id: string;
+        name: string;
+        type: 'farm' | 'stores' | 'region';
+        tags: Array<string>;
+        business?: {
+            id?: string;
+            businessUnitId?: string;
+            organisationId?: 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;
+            businessName?: string;
+            name?: string;
+            phone?: {
+                callingCode: string;
+                number: string;
+            };
+            email?: string;
+            tags?: Array<string>;
+            locationTag?: string;
+            managementTag?: string;
+            assuranceScheme?: 'RT' | 'SQC';
+            holdingNumber?: string;
+            sqc?: {
+                number: string;
+                isAssured: boolean;
+            } | null;
+            assurances?: Array<{
+                id: string | null;
+                body: 'RT' | 'SQC';
+                assured: boolean;
+            }>;
+            assurance?: {
+                id: string | null;
+                body: 'RT' | 'SQC';
+            };
+        };
+        storeCount?: number;
+        fieldCount?: number;
+    }>;
+};

package/models/BusinessUnitsDetails.js

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

package/models/BusinessUnitsSummary.d.ts

@@ -0,0 +1,16 @@
+export type BusinessUnitsSummary = {
+    organisationId: string;
+    organisationName: string;
+    tagGroups?: Array<{
+        name: string;
+        tags: Array<string>;
+    }>;
+    businessUnits: Array<{
+        id: string;
+        name: string;
+        type: string;
+        business: string;
+        region: string;
+        tags: Array<string>;
+    }>;
+};

package/models/BusinessUnitsSummary.js

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

package/models/BuyerPreferencesSchema.d.ts

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

package/models/BuyerPreferencesSchema.js

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

package/models/ChangeOwner.d.ts

@@ -0,0 +1,3 @@
+export type ChangeOwner = {
+    newOwnerUserId: string;
+};

package/models/ChangeOwner.js

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

package/models/ChangePassword.d.ts

@@ -0,0 +1,6 @@
+export type ChangePassword = {
+    email?: string | null;
+    oldPassword: string;
+    newPassword: string;
+    confirmNewPassword: string;
+};

package/models/ChangePassword.js

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

package/models/CheckBusinessConnectionRequestSchema.d.ts

@@ -0,0 +1,3 @@
+export type CheckBusinessConnectionRequestSchema = {
+    organisationId: string;
+};

package/models/CheckBusinessConnectionRequestSchema.js

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

package/models/CheckBusinessConnectionResponseSchema.d.ts

@@ -0,0 +1,3 @@
+export type CheckBusinessConnectionResponseSchema = {
+    isInNetwork: boolean;
+};

package/models/CheckBusinessConnectionResponseSchema.js

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

package/models/ConfirmSignup.d.ts

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

package/models/ConfirmSignup.js

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

package/models/ContactDetail.d.ts

@@ -0,0 +1,11 @@
+export type ContactDetail = {
+    givenName?: string;
+    familyName?: string;
+    phone?: {
+        callingCode: string;
+        number: string;
+    };
+    email?: string;
+    id?: string;
+    authPlatformId?: string;
+};

package/models/ContactDetail.js

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

package/models/CreateBusinessConnection.d.ts

@@ -0,0 +1,14 @@
+export type CreateBusinessConnection = {
+    id?: string | null;
+    companyNumber?: string | null;
+    countryISO?: 'GB' | 'US' | 'ZA' | 'FR';
+    name?: string;
+    relationship?: 'trading' | 'storage' | 'carrier' | 'organiser' | null;
+    contacts: Array<{
+        id?: string | null;
+        givenName: string;
+        familyName: string;
+        email: string;
+        phone: string | null;
+    }>;
+};

package/models/CreateBusinessConnection.js

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

package/models/CreateBusinessUnit.d.ts

@@ -0,0 +1,42 @@
+export type CreateBusinessUnit = {
+    organisationId: string;
+    name: string;
+    type: 'farm' | 'stores' | 'region';
+    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;
+        sqc?: {
+            number: string;
+            isAssured: boolean;
+        } | null;
+        assuranceScheme?: 'RT' | 'SQC';
+        assurances?: Array<{
+            id: string | null;
+            body: 'RT' | 'SQC';
+            assured: boolean;
+        }>;
+    };
+};

package/models/CreateBusinessUnit.js

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

package/models/CreateBusinessUnits.d.ts

@@ -0,0 +1,42 @@
+export type CreateBusinessUnits = Array<{
+    organisationId: string;
+    name: string;
+    type: 'farm' | 'stores' | 'region';
+    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;
+        sqc?: {
+            number: string;
+            isAssured: boolean;
+        } | null;
+        assuranceScheme?: 'RT' | 'SQC';
+        assurances?: Array<{
+            id: string | null;
+            body: 'RT' | 'SQC';
+            assured: boolean;
+        }>;
+    };
+}>;

package/models/CreateBusinessUnits.js

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

package/models/CreateOrganisation.d.ts

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

package/models/CreateOrganisation.js

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