@hectare/platform.clients.customers 1.1.122 → 1.1.124

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.d.ts CHANGED
@@ -12,8 +12,7 @@ export type { ContactDetail } from './models/ContactDetail.js';
12
12
  export type { CreateBusinessLocation } from './models/CreateBusinessLocation.js';
13
13
  export type { CreateBusinessSchema } from './models/CreateBusinessSchema.js';
14
14
  export type { CreateBusinessUnit } from './models/CreateBusinessUnit.js';
15
- export type { CreateOrganisation } from './models/CreateOrganisation.js';
16
- export type { CreateOrganisationResponse } from './models/CreateOrganisationResponse.js';
15
+ export type { CreateDriverUser } from './models/CreateDriverUser.js';
17
16
  export type { CreateOrUpdatePriceAlertsSchema } from './models/CreateOrUpdatePriceAlertsSchema.js';
18
17
  export type { CreateUser } from './models/CreateUser.js';
19
18
  export type { CustomerConfig } from './models/CustomerConfig.js';
@@ -39,8 +38,6 @@ export type { RoleGroup } from './models/RoleGroup.js';
39
38
  export type { SearchResultsOrganisationSummarySchema } from './models/SearchResultsOrganisationSummarySchema.js';
40
39
  export type { SearchResultsUserDetailSchema } from './models/SearchResultsUserDetailSchema.js';
41
40
  export type { SendMagicLogin } from './models/SendMagicLogin.js';
42
- export type { SwapCognitoUserPoolRequest } from './models/SwapCognitoUserPoolRequest.js';
43
- export type { SwapCognitoUserPoolResponse } from './models/SwapCognitoUserPoolResponse.js';
44
41
  export type { UserAccess } from './models/UserAccess.js';
45
42
  export type { UserBasicInfo } from './models/UserBasicInfo.js';
46
43
  export type { UserBasicInfoWithStatsSchema } from './models/UserBasicInfoWithStatsSchema.js';
@@ -25,7 +25,7 @@ export type BasicSearchUserDetail = {
25
25
  purchases: Array<'insights'>;
26
26
  groups: Array<string>;
27
27
  roles: Array<string>;
28
- userTypes: Array<'seller' | 'buyer' | 'advisor'>;
28
+ userTypes: Array<'seller' | 'buyer' | 'advisor' | 'driver' | 'manager' | 'haulier'>;
29
29
  profiles: Array<{
30
30
  organisationId: string;
31
31
  businesses: Array<string>;
@@ -0,0 +1,5 @@
1
+ export type CreateDriverUser = {
2
+ phone: string | null;
3
+ givenName: string;
4
+ familyName: string;
5
+ };
@@ -4,7 +4,6 @@ export type OrganisationExists = {
4
4
  organisations?: Array<{
5
5
  id: string;
6
6
  businessId: string;
7
- businessUnitId: string;
8
7
  createdAtUTC: string;
9
8
  name: string;
10
9
  location: {
@@ -28,10 +27,8 @@ export type OrganisationExists = {
28
27
  } | null;
29
28
  countryISO: 'GB' | 'US' | 'ZA' | 'FR';
30
29
  status: 'active' | 'pending' | 'suspended';
31
- companyId: string;
32
- companyHoldingNumber?: string;
33
- vatNumber: string;
34
30
  bio: string;
31
+ companyId: string;
35
32
  logo: {
36
33
  name?: string;
37
34
  id: string;
@@ -55,27 +52,21 @@ export type OrganisationExists = {
55
52
  };
56
53
  pushToken?: string;
57
54
  };
58
- settlementContacts?: Array<{
59
- name: string;
60
- email: string;
61
- }>;
62
55
  modules: Array<{
63
56
  id: string;
64
57
  name?: string | null;
65
58
  }>;
66
59
  vetted: boolean;
67
- rejected?: boolean;
68
- isMerchant?: boolean;
69
- assurance?: {
60
+ rejected: boolean;
61
+ assurance: {
70
62
  id: string | null;
71
63
  key?: string | null;
72
64
  body: 'RT' | 'SQC';
73
65
  name?: string | null;
74
66
  location?: string | null;
75
67
  } | null;
76
- assuranceId?: string;
77
- assuranceScheme?: 'RT' | 'SQC';
78
- salesforceId?: string;
79
- salesforceUpdates?: Array<string>;
68
+ salesforceId: string;
69
+ salesforceUpdates: Array<string>;
70
+ managerIds: Array<string>;
80
71
  }>;
81
72
  };
@@ -1,7 +1,6 @@
1
1
  export type OrganisationSummary = {
2
2
  id: string;
3
3
  businessId: string;
4
- businessUnitId: string;
5
4
  createdAtUTC: string;
6
5
  name: string;
7
6
  location: {
@@ -25,10 +24,8 @@ export type OrganisationSummary = {
25
24
  } | null;
26
25
  countryISO: 'GB' | 'US' | 'ZA' | 'FR';
27
26
  status: 'active' | 'pending' | 'suspended';
28
- companyId: string;
29
- companyHoldingNumber?: string;
30
- vatNumber: string;
31
27
  bio: string;
28
+ companyId: string;
32
29
  logo: {
33
30
  name?: string;
34
31
  id: string;
@@ -52,26 +49,20 @@ export type OrganisationSummary = {
52
49
  };
53
50
  pushToken?: string;
54
51
  };
55
- settlementContacts?: Array<{
56
- name: string;
57
- email: string;
58
- }>;
59
52
  modules: Array<{
60
53
  id: string;
61
54
  name?: string | null;
62
55
  }>;
63
56
  vetted: boolean;
64
- rejected?: boolean;
65
- isMerchant?: boolean;
66
- assurance?: {
57
+ rejected: boolean;
58
+ assurance: {
67
59
  id: string | null;
68
60
  key?: string | null;
69
61
  body: 'RT' | 'SQC';
70
62
  name?: string | null;
71
63
  location?: string | null;
72
64
  } | null;
73
- assuranceId?: string;
74
- assuranceScheme?: 'RT' | 'SQC';
75
- salesforceId?: string;
76
- salesforceUpdates?: Array<string>;
65
+ salesforceId: string;
66
+ salesforceUpdates: Array<string>;
67
+ managerIds: Array<string>;
77
68
  };
@@ -1,77 +1,28 @@
1
1
  export type PatchOrganisation = {
2
- location?: {
3
- what3words: string | null;
4
- address: {
5
- name?: string | null;
6
- line1: string;
7
- line2?: string | null;
8
- line3?: string | null;
9
- city?: string | null;
10
- region?: string | null;
11
- regionISO?: string | null;
12
- postcode: string;
13
- countryName?: string | null;
14
- countryISO: 'GB' | 'US' | 'ZA' | 'FR';
15
- };
16
- coordinates: {
17
- lat: number;
18
- lon: number;
19
- } | null;
20
- } | null;
21
2
  company?: {
22
- assurance?: {
23
- id: string | null;
24
- key?: string | null;
25
- body: 'RT' | 'SQC';
26
- name?: string | null;
27
- location?: string | null;
28
- } | null;
29
3
  id?: string | null;
30
4
  bio?: string | null;
31
5
  website?: string | null;
32
- holdingNumber?: string | null;
33
- number?: string | null;
34
- salesTaxId?: string | null;
35
6
  logo?: {
36
7
  id: string;
37
8
  url: string | null;
38
9
  } | null;
39
10
  } | null;
40
11
  name?: string | null;
41
- countryISO?: 'GB' | 'US' | 'ZA' | 'FR';
42
12
  ownerContact?: {
43
13
  phone: string | null;
44
14
  email: string;
45
15
  familyName: string;
46
16
  givenName: string;
47
17
  } | null;
48
- contacts?: Array<{
49
- phone: string | null;
50
- email: string;
51
- familyName: string;
52
- givenName: string;
53
- } | null>;
54
- organisers?: Array<string>;
55
18
  salesforceId?: string | null;
56
19
  modules?: Array<{
57
20
  id: string;
58
21
  name?: string | null;
59
22
  }>;
60
23
  signupPurpose?: Array<number>;
61
- companyNumber?: string | null;
62
- companySalesTaxId?: string | null;
63
- settlementContacts?: Array<{
64
- name: string;
65
- email: string;
66
- }> | null;
67
- logo?: {
68
- id: string;
69
- url: string | null;
70
- } | null;
71
24
  status?: string | null;
72
- statusMessage?: string | null;
73
25
  salesforceUpdates?: Array<string> | null;
74
26
  vetted?: boolean;
75
- isMerchant?: boolean;
76
27
  rejected?: boolean;
77
28
  };
@@ -5,8 +5,8 @@ export type RegisterSchema = {
5
5
  phone: string | null;
6
6
  password?: string | null;
7
7
  businessName: string;
8
+ companyId?: string | null;
8
9
  referralCode?: string;
9
- farmSoftware?: string;
10
10
  modules: Array<string>;
11
11
  signupPurpose: Array<number>;
12
12
  };
@@ -2,7 +2,6 @@ export type SearchResultsOrganisationSummarySchema = {
2
2
  docs: Array<{
3
3
  id: string;
4
4
  businessId: string;
5
- businessUnitId: string;
6
5
  createdAtUTC: string;
7
6
  name: string;
8
7
  location: {
@@ -26,10 +25,8 @@ export type SearchResultsOrganisationSummarySchema = {
26
25
  } | null;
27
26
  countryISO: 'GB' | 'US' | 'ZA' | 'FR';
28
27
  status: 'active' | 'pending' | 'suspended';
29
- companyId: string;
30
- companyHoldingNumber?: string;
31
- vatNumber: string;
32
28
  bio: string;
29
+ companyId: string;
33
30
  logo: {
34
31
  name?: string;
35
32
  id: string;
@@ -53,28 +50,22 @@ export type SearchResultsOrganisationSummarySchema = {
53
50
  };
54
51
  pushToken?: string;
55
52
  };
56
- settlementContacts?: Array<{
57
- name: string;
58
- email: string;
59
- }>;
60
53
  modules: Array<{
61
54
  id: string;
62
55
  name?: string | null;
63
56
  }>;
64
57
  vetted: boolean;
65
- rejected?: boolean;
66
- isMerchant?: boolean;
67
- assurance?: {
58
+ rejected: boolean;
59
+ assurance: {
68
60
  id: string | null;
69
61
  key?: string | null;
70
62
  body: 'RT' | 'SQC';
71
63
  name?: string | null;
72
64
  location?: string | null;
73
65
  } | null;
74
- assuranceId?: string;
75
- assuranceScheme?: 'RT' | 'SQC';
76
- salesforceId?: string;
77
- salesforceUpdates?: Array<string>;
66
+ salesforceId: string;
67
+ salesforceUpdates: Array<string>;
68
+ managerIds: Array<string>;
78
69
  }>;
79
70
  custom?: any;
80
71
  totalDocs: number;
@@ -25,7 +25,7 @@ export type SearchResultsUserDetailSchema = {
25
25
  purchases: Array<'insights'>;
26
26
  groups: Array<string>;
27
27
  roles: Array<string>;
28
- userTypes: Array<'seller' | 'buyer' | 'advisor'>;
28
+ userTypes: Array<'seller' | 'buyer' | 'advisor' | 'driver' | 'manager' | 'haulier'>;
29
29
  profiles: Array<{
30
30
  organisationId: string;
31
31
  businesses: Array<string>;
@@ -3,7 +3,6 @@ export type UserBasicInfo = {
3
3
  givenName: string;
4
4
  familyName: string;
5
5
  countryISO: 'GB' | 'US' | 'ZA' | 'FR';
6
- organisationName?: string;
7
6
  organisationId?: string;
8
7
  email: string;
9
8
  phone: {
@@ -11,38 +10,6 @@ export type UserBasicInfo = {
11
10
  number: string;
12
11
  };
13
12
  pushToken?: string;
14
- organisation: {
15
- id: string;
16
- name: string;
17
- bio: string;
18
- logo: {
19
- id?: string;
20
- url?: string;
21
- };
22
- location: {
23
- what3words: string | null;
24
- address: {
25
- name?: string | null;
26
- line1: string;
27
- line2?: string | null;
28
- line3?: string | null;
29
- city?: string | null;
30
- region?: string | null;
31
- regionISO?: string | null;
32
- postcode: string;
33
- countryName?: string | null;
34
- countryISO: 'GB' | 'US' | 'ZA' | 'FR';
35
- };
36
- coordinates: {
37
- lat: number;
38
- lon: number;
39
- } | null;
40
- } | null;
41
- modules?: Array<{
42
- id: string;
43
- name?: string | null;
44
- }>;
45
- };
46
13
  buyerExFarmPreferences?: Array<{
47
14
  id: number;
48
15
  commodityId: number;
@@ -73,6 +40,6 @@ export type UserBasicInfo = {
73
40
  onboardingProgress: Array<string> | null;
74
41
  };
75
42
  authPlatformId: string;
76
- userTypes: Array<'seller' | 'buyer' | 'advisor'>;
43
+ userTypes: Array<'seller' | 'buyer' | 'advisor' | 'driver' | 'manager' | 'haulier'>;
77
44
  businesses: Array<string>;
78
45
  };
@@ -3,7 +3,6 @@ export type UserBasicInfoWithStatsSchema = {
3
3
  givenName: string;
4
4
  familyName: string;
5
5
  countryISO: 'GB' | 'US' | 'ZA' | 'FR';
6
- organisationName?: string;
7
6
  organisationId?: string;
8
7
  email: string;
9
8
  phone: {
@@ -11,38 +10,6 @@ export type UserBasicInfoWithStatsSchema = {
11
10
  number: string;
12
11
  };
13
12
  pushToken?: string;
14
- organisation: {
15
- id: string;
16
- name: string;
17
- bio: string;
18
- logo: {
19
- id?: string;
20
- url?: string;
21
- };
22
- location: {
23
- what3words: string | null;
24
- address: {
25
- name?: string | null;
26
- line1: string;
27
- line2?: string | null;
28
- line3?: string | null;
29
- city?: string | null;
30
- region?: string | null;
31
- regionISO?: string | null;
32
- postcode: string;
33
- countryName?: string | null;
34
- countryISO: 'GB' | 'US' | 'ZA' | 'FR';
35
- };
36
- coordinates: {
37
- lat: number;
38
- lon: number;
39
- } | null;
40
- } | null;
41
- modules?: Array<{
42
- id: string;
43
- name?: string | null;
44
- }>;
45
- };
46
13
  buyerExFarmPreferences?: Array<{
47
14
  id: number;
48
15
  commodityId: number;
@@ -73,7 +40,7 @@ export type UserBasicInfoWithStatsSchema = {
73
40
  onboardingProgress: Array<string> | null;
74
41
  };
75
42
  authPlatformId?: string;
76
- userTypes?: Array<'seller' | 'buyer' | 'advisor'>;
43
+ userTypes?: Array<'seller' | 'buyer' | 'advisor' | 'driver' | 'manager' | 'haulier'>;
77
44
  businesses?: Array<string>;
78
45
  stats: {
79
46
  numberOfBids?: number;
@@ -24,7 +24,7 @@ export type UserDetail = {
24
24
  purchases: Array<'insights'>;
25
25
  groups: Array<string>;
26
26
  roles: Array<string>;
27
- userTypes: Array<'seller' | 'buyer' | 'advisor'>;
27
+ userTypes: Array<'seller' | 'buyer' | 'advisor' | 'driver' | 'manager' | 'haulier'>;
28
28
  profiles: Array<{
29
29
  organisationId: string;
30
30
  businesses: Array<string>;
@@ -2,7 +2,6 @@ export type UserProfile = {
2
2
  organisation: {
3
3
  id: string;
4
4
  businessId: string;
5
- businessUnitId: string;
6
5
  createdAtUTC: string;
7
6
  name: string;
8
7
  location: {
@@ -26,10 +25,8 @@ export type UserProfile = {
26
25
  } | null;
27
26
  countryISO: 'GB' | 'US' | 'ZA' | 'FR';
28
27
  status: 'active' | 'pending' | 'suspended';
29
- companyId: string;
30
- companyHoldingNumber?: string;
31
- vatNumber: string;
32
28
  bio: string;
29
+ companyId: string;
33
30
  logo: {
34
31
  name?: string;
35
32
  id: string;
@@ -53,28 +50,22 @@ export type UserProfile = {
53
50
  };
54
51
  pushToken?: string;
55
52
  };
56
- settlementContacts?: Array<{
57
- name: string;
58
- email: string;
59
- }>;
60
53
  modules: Array<{
61
54
  id: string;
62
55
  name?: string | null;
63
56
  }>;
64
57
  vetted: boolean;
65
- rejected?: boolean;
66
- isMerchant?: boolean;
67
- assurance?: {
58
+ rejected: boolean;
59
+ assurance: {
68
60
  id: string | null;
69
61
  key?: string | null;
70
62
  body: 'RT' | 'SQC';
71
63
  name?: string | null;
72
64
  location?: string | null;
73
65
  } | null;
74
- assuranceId?: string;
75
- assuranceScheme?: 'RT' | 'SQC';
76
- salesforceId?: string;
77
- salesforceUpdates?: Array<string>;
66
+ salesforceId: string;
67
+ salesforceUpdates: Array<string>;
68
+ managerIds: Array<string>;
78
69
  } | null;
79
70
  user: {
80
71
  id: string;
@@ -102,7 +93,7 @@ export type UserProfile = {
102
93
  purchases: Array<'insights'>;
103
94
  groups: Array<string>;
104
95
  roles: Array<string>;
105
- userTypes: Array<'seller' | 'buyer' | 'advisor'>;
96
+ userTypes: Array<'seller' | 'buyer' | 'advisor' | 'driver' | 'manager' | 'haulier'>;
106
97
  profiles: Array<{
107
98
  organisationId: string;
108
99
  businesses: Array<string>;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hectare/platform.clients.customers",
3
- "version": "1.1.122",
3
+ "version": "1.1.124",
4
4
  "main": "index.js",
5
5
  "exported": true,
6
6
  "types": "index.d.ts",
@@ -1,61 +0,0 @@
1
- export type CreateOrganisation = {
2
- location: {
3
- what3words: string | null;
4
- address: {
5
- name?: string | null;
6
- line1: string;
7
- line2?: string | null;
8
- line3?: string | null;
9
- city?: string | null;
10
- region?: string | null;
11
- regionISO?: string | null;
12
- postcode: string;
13
- countryName?: string | null;
14
- countryISO: 'GB' | 'US' | 'ZA' | 'FR';
15
- };
16
- coordinates: {
17
- lat: number;
18
- lon: number;
19
- } | null;
20
- } | null;
21
- company?: {
22
- assurance?: {
23
- id: string | null;
24
- key?: string | null;
25
- body: 'RT' | 'SQC';
26
- name?: string | null;
27
- location?: string | null;
28
- } | null;
29
- id?: string | null;
30
- bio?: string | null;
31
- website?: string | null;
32
- holdingNumber?: string | null;
33
- number?: string | null;
34
- salesTaxId?: string | null;
35
- logo?: {
36
- id: string;
37
- url: string | null;
38
- } | null;
39
- };
40
- name: string | null;
41
- countryISO: 'GB' | 'US' | 'ZA' | 'FR';
42
- ownerContact: {
43
- phone: string | null;
44
- email: string;
45
- familyName: string;
46
- givenName: string;
47
- } | null;
48
- contacts?: Array<{
49
- phone: string | null;
50
- email: string;
51
- familyName: string;
52
- givenName: string;
53
- } | null>;
54
- organisers?: Array<string>;
55
- salesforceId?: string | null;
56
- modules: Array<{
57
- id: string;
58
- name?: string | null;
59
- }>;
60
- signupPurpose?: Array<number>;
61
- };
@@ -1,150 +0,0 @@
1
- export type CreateOrganisationResponse = {
2
- organisation?: {
3
- id: string;
4
- businessId: string;
5
- businessUnitId: string;
6
- createdAtUTC: string;
7
- name: string;
8
- location: {
9
- what3words: string | null;
10
- address: {
11
- name?: string | null;
12
- line1: string;
13
- line2?: string | null;
14
- line3?: string | null;
15
- city?: string | null;
16
- region?: string | null;
17
- regionISO?: string | null;
18
- postcode: string;
19
- countryName?: string | null;
20
- countryISO: 'GB' | 'US' | 'ZA' | 'FR';
21
- };
22
- coordinates: {
23
- lat: number;
24
- lon: number;
25
- } | null;
26
- } | null;
27
- countryISO: 'GB' | 'US' | 'ZA' | 'FR';
28
- status: 'active' | 'pending' | 'suspended';
29
- companyId: string;
30
- companyHoldingNumber?: string;
31
- vatNumber: string;
32
- bio: string;
33
- logo: {
34
- name?: string;
35
- id: string;
36
- url?: string | null;
37
- userId?: string | null;
38
- userName?: string | null;
39
- organisationId?: string | null;
40
- createdAtUTC?: string | null;
41
- } | null;
42
- ownerContact: {
43
- id: string;
44
- email: string;
45
- familyName: string;
46
- givenName: string;
47
- authPlatformId?: string;
48
- organisationId: string;
49
- countryISO: 'GB' | 'US' | 'ZA' | 'FR';
50
- phone?: {
51
- callingCode: string;
52
- number: string;
53
- };
54
- pushToken?: string;
55
- };
56
- settlementContacts?: Array<{
57
- name: string;
58
- email: string;
59
- }>;
60
- modules: Array<{
61
- id: string;
62
- name?: string | null;
63
- }>;
64
- vetted: boolean;
65
- rejected?: boolean;
66
- isMerchant?: boolean;
67
- assurance?: {
68
- id: string | null;
69
- key?: string | null;
70
- body: 'RT' | 'SQC';
71
- name?: string | null;
72
- location?: string | null;
73
- } | null;
74
- assuranceId?: string;
75
- assuranceScheme?: 'RT' | 'SQC';
76
- salesforceId?: string;
77
- salesforceUpdates?: Array<string>;
78
- };
79
- user?: {
80
- id: string;
81
- givenName: string;
82
- familyName: string;
83
- name: string;
84
- countryISO: 'GB' | 'US' | 'ZA' | 'FR';
85
- email: string;
86
- emailVerified: boolean;
87
- pushToken?: string;
88
- impersonating?: boolean;
89
- settings: {
90
- terms: boolean;
91
- termsOnce?: boolean;
92
- marketingPreferences: {
93
- marketingPlans: boolean;
94
- communications: boolean;
95
- };
96
- whatsApp: boolean;
97
- sms: boolean;
98
- push: boolean;
99
- biometrics: boolean;
100
- onboardingProgress: Array<string> | null;
101
- };
102
- purchases: Array<'insights'>;
103
- groups: Array<string>;
104
- roles: Array<string>;
105
- userTypes: Array<'seller' | 'buyer' | 'advisor'>;
106
- profiles: Array<{
107
- organisationId: string;
108
- businesses: Array<string>;
109
- roles: Array<string>;
110
- }>;
111
- buyerExFarmPreferences?: Array<{
112
- id: number;
113
- commodityId: number;
114
- name: string;
115
- grades: Array<number>;
116
- regionISOs?: Array<string>;
117
- ukRegions: Array<string>;
118
- }>;
119
- sellerExFarmPreferences?: Array<{
120
- id: number;
121
- commodityId: number;
122
- name: string;
123
- grades: Array<number>;
124
- regionISOs?: Array<string>;
125
- ukRegions: Array<string>;
126
- }>;
127
- phone: {
128
- callingCode: string;
129
- number: string;
130
- };
131
- phoneLandline?: {
132
- callingCode: string;
133
- number: string;
134
- };
135
- avatar?: {
136
- name?: string;
137
- id: string;
138
- url?: string | null;
139
- userId?: string | null;
140
- userName?: string | null;
141
- organisationId?: string | null;
142
- createdAtUTC?: string | null;
143
- } | null;
144
- organisationId: string;
145
- organisationName?: string;
146
- authPlatformId?: string;
147
- status: 'active' | 'pending' | 'inactive' | 'deleted';
148
- businesses: Array<string>;
149
- };
150
- };
@@ -1 +0,0 @@
1
- export {};
@@ -1,4 +0,0 @@
1
- export type SwapCognitoUserPoolRequest = {
2
- username: string;
3
- password?: string;
4
- };
@@ -1 +0,0 @@
1
- export {};
@@ -1,5 +0,0 @@
1
- export type SwapCognitoUserPoolResponse = {
2
- status?: 'not-found' | 'not-authorised' | 'success';
3
- authenticated?: boolean;
4
- id?: string;
5
- };
@@ -1 +0,0 @@
1
- export {};