@hectare/platform.clients.customers 1.1.34 → 1.1.36

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.
Files changed (18) hide show
  1. package/index.d.ts +0 -1
  2. package/models/BusinessDetail.d.ts +20 -2
  3. package/models/BusinessUnitsDetail.d.ts +20 -2
  4. package/models/BusinessUnitsDetails.d.ts +20 -2
  5. package/models/CreateBusinessUnit.d.ts +20 -2
  6. package/models/CreateBusinessUnits.d.ts +20 -2
  7. package/models/CreateOrganisation.d.ts +1 -0
  8. package/models/CreateOrganisationResponse.d.ts +1 -51
  9. package/models/OrganisationDetail.d.ts +1 -51
  10. package/models/OrganisationExists.d.ts +1 -51
  11. package/models/OrganisationSummary.d.ts +6 -0
  12. package/models/PatchBusinessUnit.d.ts +20 -2
  13. package/models/PatchOrganisation.d.ts +1 -0
  14. package/models/SearchResultsOrganisationDetailSchema.d.ts +1 -51
  15. package/models/UserProfile.d.ts +1 -52
  16. package/package.json +1 -1
  17. package/models/RedTractorCertificate.d.ts +0 -20
  18. package/models/RedTractorCertificate.js +0 -1
package/index.d.ts CHANGED
@@ -31,7 +31,6 @@ export type { PatchBusinessUnit } from './models/PatchBusinessUnit.js';
31
31
  export type { PatchOrganisation } from './models/PatchOrganisation.js';
32
32
  export type { PatchOrganisationAdvancePay } from './models/PatchOrganisationAdvancePay.js';
33
33
  export type { PatchUser } from './models/PatchUser.js';
34
- export type { RedTractorCertificate } from './models/RedTractorCertificate.js';
35
34
  export type { Role } from './models/Role.js';
36
35
  export type { RoleGroup } from './models/RoleGroup.js';
37
36
  export type { SearchResultsOrganisationDetailSchema } from './models/SearchResultsOrganisationDetailSchema.js';
package/models/BusinessDetail.d.ts CHANGED
@@ -22,6 +22,25 @@ export type BusinessDetail = {
22
22
  lon: number;
23
23
  } | null;
24
24
  } | null;
25
+ collectionLocation?: {
26
+ what3words: string | null;
27
+ address: {
28
+ name?: string | null;
29
+ line1: string;
30
+ line2?: string | null;
31
+ line3?: string | null;
32
+ city?: string | null;
33
+ region?: string | null;
34
+ regionISO?: string | null;
35
+ postcode: string;
36
+ countryName?: string | null;
37
+ countryISO: 'GB' | 'US' | 'ZA' | 'FR';
38
+ };
39
+ coordinates: {
40
+ lat: number;
41
+ lon: number;
42
+ } | null;
43
+ } | null;
25
44
  businessName?: string;
26
45
  name?: string;
27
46
  phone?: {
@@ -30,12 +49,11 @@ export type BusinessDetail = {
30
49
  };
31
50
  email?: string;
32
51
  tags?: Array<string>;
33
- locationTag?: string;
34
- managementTag?: string;
35
52
  holdingNumber?: string;
36
53
  assurance?: {
37
54
  id: string | null;
38
55
  key?: string | null;
39
56
  body: 'RT' | 'SQC';
57
+ location?: string | null;
40
58
  } | null;
41
59
  };
package/models/BusinessUnitsDetail.d.ts CHANGED
@@ -28,6 +28,25 @@ export type BusinessUnitsDetail = {
28
28
  lon: number;
29
29
  } | null;
30
30
  } | null;
31
+ collectionLocation?: {
32
+ what3words: string | null;
33
+ address: {
34
+ name?: string | null;
35
+ line1: string;
36
+ line2?: string | null;
37
+ line3?: string | null;
38
+ city?: string | null;
39
+ region?: string | null;
40
+ regionISO?: string | null;
41
+ postcode: string;
42
+ countryName?: string | null;
43
+ countryISO: 'GB' | 'US' | 'ZA' | 'FR';
44
+ };
45
+ coordinates: {
46
+ lat: number;
47
+ lon: number;
48
+ } | null;
49
+ } | null;
31
50
  businessName?: string;
32
51
  name?: string;
33
52
  phone?: {
@@ -36,13 +55,12 @@ export type BusinessUnitsDetail = {
36
55
  };
37
56
  email?: string;
38
57
  tags?: Array<string>;
39
- locationTag?: string;
40
- managementTag?: string;
41
58
  holdingNumber?: string;
42
59
  assurance?: {
43
60
  id: string | null;
44
61
  key?: string | null;
45
62
  body: 'RT' | 'SQC';
63
+ location?: string | null;
46
64
  } | null;
47
65
  };
48
66
  };
package/models/BusinessUnitsDetails.d.ts CHANGED
@@ -37,6 +37,25 @@ export type BusinessUnitsDetails = {
37
37
  lon: number;
38
38
  } | null;
39
39
  } | null;
40
+ collectionLocation?: {
41
+ what3words: string | null;
42
+ address: {
43
+ name?: string | null;
44
+ line1: string;
45
+ line2?: string | null;
46
+ line3?: string | null;
47
+ city?: string | null;
48
+ region?: string | null;
49
+ regionISO?: string | null;
50
+ postcode: string;
51
+ countryName?: string | null;
52
+ countryISO: 'GB' | 'US' | 'ZA' | 'FR';
53
+ };
54
+ coordinates: {
55
+ lat: number;
56
+ lon: number;
57
+ } | null;
58
+ } | null;
40
59
  businessName?: string;
41
60
  name?: string;
42
61
  phone?: {
@@ -45,13 +64,12 @@ export type BusinessUnitsDetails = {
45
64
  };
46
65
  email?: string;
47
66
  tags?: Array<string>;
48
- locationTag?: string;
49
- managementTag?: string;
50
67
  holdingNumber?: string;
51
68
  assurance?: {
52
69
  id: string | null;
53
70
  key?: string | null;
54
71
  body: 'RT' | 'SQC';
72
+ location?: string | null;
55
73
  } | null;
56
74
  };
57
75
  }>;
package/models/CreateBusinessUnit.d.ts CHANGED
@@ -22,16 +22,34 @@ export type CreateBusinessUnit = {
22
22
  lon: number;
23
23
  } | null;
24
24
  } | null;
25
+ collectionLocation?: {
26
+ what3words: string | null;
27
+ address: {
28
+ name?: string | null;
29
+ line1: string;
30
+ line2?: string | null;
31
+ line3?: string | null;
32
+ city?: string | null;
33
+ region?: string | null;
34
+ regionISO?: string | null;
35
+ postcode: string;
36
+ countryName?: string | null;
37
+ countryISO: 'GB' | 'US' | 'ZA' | 'FR';
38
+ };
39
+ coordinates: {
40
+ lat: number;
41
+ lon: number;
42
+ } | null;
43
+ } | null;
25
44
  name: string;
26
45
  phoneNumber: string | null;
27
46
  email: string;
28
- locationTag?: string;
29
- managementTag?: string;
30
47
  holdingNumber: string;
31
48
  assurance?: {
32
49
  id: string | null;
33
50
  key?: string | null;
34
51
  body: 'RT' | 'SQC';
52
+ location?: string | null;
35
53
  } | null;
36
54
  };
37
55
  };
package/models/CreateBusinessUnits.d.ts CHANGED
@@ -22,16 +22,34 @@ export type CreateBusinessUnits = Array<{
22
22
  lon: number;
23
23
  } | null;
24
24
  } | null;
25
+ collectionLocation?: {
26
+ what3words: string | null;
27
+ address: {
28
+ name?: string | null;
29
+ line1: string;
30
+ line2?: string | null;
31
+ line3?: string | null;
32
+ city?: string | null;
33
+ region?: string | null;
34
+ regionISO?: string | null;
35
+ postcode: string;
36
+ countryName?: string | null;
37
+ countryISO: 'GB' | 'US' | 'ZA' | 'FR';
38
+ };
39
+ coordinates: {
40
+ lat: number;
41
+ lon: number;
42
+ } | null;
43
+ } | null;
25
44
  name: string;
26
45
  phoneNumber: string | null;
27
46
  email: string;
28
- locationTag?: string;
29
- managementTag?: string;
30
47
  holdingNumber: string;
31
48
  assurance?: {
32
49
  id: string | null;
33
50
  key?: string | null;
34
51
  body: 'RT' | 'SQC';
52
+ location?: string | null;
35
53
  } | null;
36
54
  };
37
55
  }>;
package/models/CreateOrganisation.d.ts CHANGED
@@ -23,6 +23,7 @@ export type CreateOrganisation = {
23
23
  id: string | null;
24
24
  key?: string | null;
25
25
  body: 'RT' | 'SQC';
26
+ location?: string | null;
26
27
  } | null;
27
28
  id?: string | null;
28
29
  bio?: string | null;
package/models/CreateOrganisationResponse.d.ts CHANGED
@@ -25,6 +25,7 @@ export type CreateOrganisationResponse = {
25
25
  id: string | null;
26
26
  key?: string | null;
27
27
  body: 'RT' | 'SQC';
28
+ location?: string | null;
28
29
  } | null;
29
30
  id?: string | null;
30
31
  bio?: string | null;
@@ -66,57 +67,6 @@ export type CreateOrganisationResponse = {
66
67
  region: string | null;
67
68
  tags: Array<string>;
68
69
  }>;
69
- businessConnections?: Array<{
70
- organisationId?: string;
71
- organisationName?: string;
72
- relationship?: Array<string>;
73
- contacts?: Array<{
74
- givenName?: string;
75
- familyName?: string;
76
- phone?: {
77
- callingCode: string;
78
- number: string;
79
- };
80
- email?: string;
81
- id?: string;
82
- authPlatformId?: string;
83
- profile?: {
84
- organisationId: string;
85
- businessUnits: Array<string>;
86
- roles: Array<string>;
87
- } | null;
88
- }>;
89
- location?: {
90
- what3words: string | null;
91
- address: {
92
- name?: string | null;
93
- line1: string;
94
- line2?: string | null;
95
- line3?: string | null;
96
- city?: string | null;
97
- region?: string | null;
98
- regionISO?: string | null;
99
- postcode: string;
100
- countryName?: string | null;
101
- countryISO: 'GB' | 'US' | 'ZA' | 'FR';
102
- };
103
- coordinates: {
104
- lat: number;
105
- lon: number;
106
- } | null;
107
- } | null;
108
- countryISO?: 'GB' | 'US' | 'ZA' | 'FR';
109
- ownerContact?: {
110
- id?: string;
111
- email?: string;
112
- familyName?: string;
113
- givenName?: string;
114
- phone?: {
115
- callingCode: string;
116
- number: string;
117
- };
118
- };
119
- }>;
120
70
  billing?: {
121
71
  amount: number;
122
72
  currency: string;
package/models/OrganisationDetail.d.ts CHANGED
@@ -24,6 +24,7 @@ export type OrganisationDetail = {
24
24
  id: string | null;
25
25
  key?: string | null;
26
26
  body: 'RT' | 'SQC';
27
+ location?: string | null;
27
28
  } | null;
28
29
  id?: string | null;
29
30
  bio?: string | null;
@@ -65,57 +66,6 @@ export type OrganisationDetail = {
65
66
  region: string | null;
66
67
  tags: Array<string>;
67
68
  }>;
68
- businessConnections?: Array<{
69
- organisationId?: string;
70
- organisationName?: string;
71
- relationship?: Array<string>;
72
- contacts?: Array<{
73
- givenName?: string;
74
- familyName?: string;
75
- phone?: {
76
- callingCode: string;
77
- number: string;
78
- };
79
- email?: string;
80
- id?: string;
81
- authPlatformId?: string;
82
- profile?: {
83
- organisationId: string;
84
- businessUnits: Array<string>;
85
- roles: Array<string>;
86
- } | null;
87
- }>;
88
- location?: {
89
- what3words: string | null;
90
- address: {
91
- name?: string | null;
92
- line1: string;
93
- line2?: string | null;
94
- line3?: string | null;
95
- city?: string | null;
96
- region?: string | null;
97
- regionISO?: string | null;
98
- postcode: string;
99
- countryName?: string | null;
100
- countryISO: 'GB' | 'US' | 'ZA' | 'FR';
101
- };
102
- coordinates: {
103
- lat: number;
104
- lon: number;
105
- } | null;
106
- } | null;
107
- countryISO?: 'GB' | 'US' | 'ZA' | 'FR';
108
- ownerContact?: {
109
- id?: string;
110
- email?: string;
111
- familyName?: string;
112
- givenName?: string;
113
- phone?: {
114
- callingCode: string;
115
- number: string;
116
- };
117
- };
118
- }>;
119
69
  billing?: {
120
70
  amount: number;
121
71
  currency: string;
package/models/OrganisationExists.d.ts CHANGED
@@ -27,6 +27,7 @@ export type OrganisationExists = {
27
27
  id: string | null;
28
28
  key?: string | null;
29
29
  body: 'RT' | 'SQC';
30
+ location?: string | null;
30
31
  } | null;
31
32
  id?: string | null;
32
33
  bio?: string | null;
@@ -68,57 +69,6 @@ export type OrganisationExists = {
68
69
  region: string | null;
69
70
  tags: Array<string>;
70
71
  }>;
71
- businessConnections?: Array<{
72
- organisationId?: string;
73
- organisationName?: string;
74
- relationship?: Array<string>;
75
- contacts?: Array<{
76
- givenName?: string;
77
- familyName?: string;
78
- phone?: {
79
- callingCode: string;
80
- number: string;
81
- };
82
- email?: string;
83
- id?: string;
84
- authPlatformId?: string;
85
- profile?: {
86
- organisationId: string;
87
- businessUnits: Array<string>;
88
- roles: Array<string>;
89
- } | null;
90
- }>;
91
- location?: {
92
- what3words: string | null;
93
- address: {
94
- name?: string | null;
95
- line1: string;
96
- line2?: string | null;
97
- line3?: string | null;
98
- city?: string | null;
99
- region?: string | null;
100
- regionISO?: string | null;
101
- postcode: string;
102
- countryName?: string | null;
103
- countryISO: 'GB' | 'US' | 'ZA' | 'FR';
104
- };
105
- coordinates: {
106
- lat: number;
107
- lon: number;
108
- } | null;
109
- } | null;
110
- countryISO?: 'GB' | 'US' | 'ZA' | 'FR';
111
- ownerContact?: {
112
- id?: string;
113
- email?: string;
114
- familyName?: string;
115
- givenName?: string;
116
- phone?: {
117
- callingCode: string;
118
- number: string;
119
- };
120
- };
121
- }>;
122
72
  billing?: {
123
73
  amount: number;
124
74
  currency: string;
package/models/OrganisationSummary.d.ts CHANGED
@@ -69,6 +69,12 @@ export type OrganisationSummary = {
69
69
  vetted?: boolean;
70
70
  rejected?: boolean;
71
71
  isMerchant?: boolean;
72
+ assurance?: {
73
+ id: string | null;
74
+ key?: string | null;
75
+ body: 'RT' | 'SQC';
76
+ location?: string | null;
77
+ } | null;
72
78
  assuranceId?: string;
73
79
  assuranceScheme?: 'RT' | 'SQC';
74
80
  advancePay?: {
package/models/PatchBusinessUnit.d.ts CHANGED
@@ -20,17 +20,35 @@ export type PatchBusinessUnit = {
20
20
  lon: number;
21
21
  } | null;
22
22
  } | null;
23
+ collectionLocation?: {
24
+ what3words: string | null;
25
+ address: {
26
+ name?: string | null;
27
+ line1: string;
28
+ line2?: string | null;
29
+ line3?: string | null;
30
+ city?: string | null;
31
+ region?: string | null;
32
+ regionISO?: string | null;
33
+ postcode: string;
34
+ countryName?: string | null;
35
+ countryISO: 'GB' | 'US' | 'ZA' | 'FR';
36
+ };
37
+ coordinates: {
38
+ lat: number;
39
+ lon: number;
40
+ } | null;
41
+ } | null;
23
42
  name?: string;
24
43
  phoneNumber?: string | null;
25
44
  email?: string;
26
45
  primary?: boolean;
27
- locationTag?: string;
28
- managementTag?: string;
29
46
  holdingNumber?: string | null;
30
47
  assurance?: {
31
48
  id: string | null;
32
49
  key?: string | null;
33
50
  body: 'RT' | 'SQC';
51
+ location?: string | null;
34
52
  } | null;
35
53
  };
36
54
  };
package/models/PatchOrganisation.d.ts CHANGED
@@ -23,6 +23,7 @@ export type PatchOrganisation = {
23
23
  id: string | null;
24
24
  key?: string | null;
25
25
  body: 'RT' | 'SQC';
26
+ location?: string | null;
26
27
  } | null;
27
28
  id?: string | null;
28
29
  bio?: string | null;
package/models/SearchResultsOrganisationDetailSchema.d.ts CHANGED
@@ -25,6 +25,7 @@ export type SearchResultsOrganisationDetailSchema = {
25
25
  id: string | null;
26
26
  key?: string | null;
27
27
  body: 'RT' | 'SQC';
28
+ location?: string | null;
28
29
  } | null;
29
30
  id?: string | null;
30
31
  bio?: string | null;
@@ -66,57 +67,6 @@ export type SearchResultsOrganisationDetailSchema = {
66
67
  region: string | null;
67
68
  tags: Array<string>;
68
69
  }>;
69
- businessConnections?: Array<{
70
- organisationId?: string;
71
- organisationName?: string;
72
- relationship?: Array<string>;
73
- contacts?: Array<{
74
- givenName?: string;
75
- familyName?: string;
76
- phone?: {
77
- callingCode: string;
78
- number: string;
79
- };
80
- email?: string;
81
- id?: string;
82
- authPlatformId?: string;
83
- profile?: {
84
- organisationId: string;
85
- businessUnits: Array<string>;
86
- roles: Array<string>;
87
- } | null;
88
- }>;
89
- location?: {
90
- what3words: string | null;
91
- address: {
92
- name?: string | null;
93
- line1: string;
94
- line2?: string | null;
95
- line3?: string | null;
96
- city?: string | null;
97
- region?: string | null;
98
- regionISO?: string | null;
99
- postcode: string;
100
- countryName?: string | null;
101
- countryISO: 'GB' | 'US' | 'ZA' | 'FR';
102
- };
103
- coordinates: {
104
- lat: number;
105
- lon: number;
106
- } | null;
107
- } | null;
108
- countryISO?: 'GB' | 'US' | 'ZA' | 'FR';
109
- ownerContact?: {
110
- id?: string;
111
- email?: string;
112
- familyName?: string;
113
- givenName?: string;
114
- phone?: {
115
- callingCode: string;
116
- number: string;
117
- };
118
- };
119
- }>;
120
70
  billing?: {
121
71
  amount: number;
122
72
  currency: string;
package/models/UserProfile.d.ts CHANGED
@@ -25,6 +25,7 @@ export type UserProfile = {
25
25
  id: string | null;
26
26
  key?: string | null;
27
27
  body: 'RT' | 'SQC';
28
+ location?: string | null;
28
29
  } | null;
29
30
  id?: string | null;
30
31
  bio?: string | null;
@@ -66,57 +67,6 @@ export type UserProfile = {
66
67
  region: string | null;
67
68
  tags: Array<string>;
68
69
  }>;
69
- businessConnections?: Array<{
70
- organisationId?: string;
71
- organisationName?: string;
72
- relationship?: Array<string>;
73
- contacts?: Array<{
74
- givenName?: string;
75
- familyName?: string;
76
- phone?: {
77
- callingCode: string;
78
- number: string;
79
- };
80
- email?: string;
81
- id?: string;
82
- authPlatformId?: string;
83
- profile?: {
84
- organisationId: string;
85
- businessUnits: Array<string>;
86
- roles: Array<string>;
87
- } | null;
88
- }>;
89
- location?: {
90
- what3words: string | null;
91
- address: {
92
- name?: string | null;
93
- line1: string;
94
- line2?: string | null;
95
- line3?: string | null;
96
- city?: string | null;
97
- region?: string | null;
98
- regionISO?: string | null;
99
- postcode: string;
100
- countryName?: string | null;
101
- countryISO: 'GB' | 'US' | 'ZA' | 'FR';
102
- };
103
- coordinates: {
104
- lat: number;
105
- lon: number;
106
- } | null;
107
- } | null;
108
- countryISO?: 'GB' | 'US' | 'ZA' | 'FR';
109
- ownerContact?: {
110
- id?: string;
111
- email?: string;
112
- familyName?: string;
113
- givenName?: string;
114
- phone?: {
115
- callingCode: string;
116
- number: string;
117
- };
118
- };
119
- }>;
120
70
  billing?: {
121
71
  amount: number;
122
72
  currency: string;
@@ -237,7 +187,6 @@ export type UserProfile = {
237
187
  write?: boolean;
238
188
  }>;
239
189
  };
240
- features?: Record<string, boolean>;
241
190
  tokens?: {
242
191
  id?: string;
243
192
  access?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@hectare/platform.clients.customers",
3
- "version": "1.1.34",
3
+ "version": "1.1.36",
4
4
  "main": "index.js",
5
5
  "exported": true,
6
6
  "types": "index.d.ts",
package/models/RedTractorCertificate.d.ts DELETED
@@ -1,20 +0,0 @@
1
- export type RedTractorCertificate = {
2
- certificateStatus?: 'Valid' | 'Grace';
3
- certificateIdentifier?: string;
4
- certificateEnterprises?: Array<{
5
- enterpriseIdentifier?: string;
6
- enterprise?: string;
7
- }>;
8
- certificateExpiryDate?: string;
9
- certifiedSites?: Array<{
10
- siteIdentifiers?: {
11
- identifierType?: string;
12
- identifier?: string;
13
- };
14
- isPrimary?: boolean;
15
- siteCountry?: string;
16
- sitePostcode?: string;
17
- siteAddress?: string;
18
- siteName?: string;
19
- }>;
20
- };
package/models/RedTractorCertificate.js DELETED
@@ -1 +0,0 @@
1
- export {};