@dakkitor/api-contracts 1.1.9 → 1.1.11

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 (92) hide show
  1. package/dist/actives/actives.contract.d.ts +263 -263
  2. package/dist/actives/actives.contract.d.ts.map +1 -1
  3. package/dist/actives/actives.contract.js +9 -17
  4. package/dist/agent-client-links/agent-client-links.contract.d.ts +1905 -0
  5. package/dist/agent-client-links/agent-client-links.contract.d.ts.map +1 -0
  6. package/dist/agent-client-links/agent-client-links.contract.js +127 -0
  7. package/dist/auth/auth.contract.d.ts +319 -0
  8. package/dist/auth/auth.contract.d.ts.map +1 -0
  9. package/dist/auth/auth.contract.js +63 -0
  10. package/dist/bookings/bookings.contract.d.ts +2183 -0
  11. package/dist/bookings/bookings.contract.d.ts.map +1 -0
  12. package/dist/bookings/bookings.contract.js +278 -0
  13. package/dist/call-history/call-history.contract.d.ts +1164 -0
  14. package/dist/call-history/call-history.contract.d.ts.map +1 -0
  15. package/dist/call-history/call-history.contract.js +254 -0
  16. package/dist/client-contacts/client-contacts.contract.d.ts +421 -472
  17. package/dist/client-contacts/client-contacts.contract.d.ts.map +1 -1
  18. package/dist/client-contacts/client-contacts.contract.js +26 -15
  19. package/dist/clients/clients.contract.d.ts +336 -308
  20. package/dist/clients/clients.contract.d.ts.map +1 -1
  21. package/dist/clients/clients.contract.js +49 -52
  22. package/dist/collaboration-checkings/collaboration-checkings.contract.d.ts +3013 -0
  23. package/dist/collaboration-checkings/collaboration-checkings.contract.d.ts.map +1 -0
  24. package/dist/collaboration-checkings/collaboration-checkings.contract.js +247 -0
  25. package/dist/collaborations/collaborations.contract.d.ts +2229 -0
  26. package/dist/collaborations/collaborations.contract.d.ts.map +1 -0
  27. package/dist/collaborations/collaborations.contract.js +284 -0
  28. package/dist/common/common-schemas.d.ts +120 -0
  29. package/dist/common/common-schemas.d.ts.map +1 -0
  30. package/dist/common/common-schemas.js +296 -0
  31. package/dist/common/error-schemas.d.ts +6 -6
  32. package/dist/common/openapi-metadata.d.ts +6 -0
  33. package/dist/common/openapi-metadata.d.ts.map +1 -1
  34. package/dist/common/pagination-query.schema.d.ts +17 -0
  35. package/dist/common/pagination-query.schema.d.ts.map +1 -0
  36. package/dist/common/pagination-query.schema.js +15 -0
  37. package/dist/common/pagination.schema.d.ts +2 -2
  38. package/dist/companies/companies.contract.d.ts +1108 -0
  39. package/dist/companies/companies.contract.d.ts.map +1 -0
  40. package/dist/companies/companies.contract.js +164 -0
  41. package/dist/cron-executions/cron-executions.contract.d.ts +1643 -0
  42. package/dist/cron-executions/cron-executions.contract.d.ts.map +1 -0
  43. package/dist/cron-executions/cron-executions.contract.js +271 -0
  44. package/dist/curated-workers/curated-workers.contract.d.ts +3183 -0
  45. package/dist/curated-workers/curated-workers.contract.d.ts.map +1 -0
  46. package/dist/curated-workers/curated-workers.contract.js +444 -0
  47. package/dist/dashboards/agent-daily-metrics.contract.d.ts +639 -0
  48. package/dist/dashboards/agent-daily-metrics.contract.d.ts.map +1 -0
  49. package/dist/dashboards/agent-daily-metrics.contract.js +118 -0
  50. package/dist/files/files.contract.d.ts +1258 -0
  51. package/dist/files/files.contract.d.ts.map +1 -0
  52. package/dist/files/files.contract.js +205 -0
  53. package/dist/health/health.contract.d.ts +161 -0
  54. package/dist/health/health.contract.d.ts.map +1 -0
  55. package/dist/health/health.contract.js +52 -0
  56. package/dist/index.d.ts +28596 -3088
  57. package/dist/index.d.ts.map +1 -1
  58. package/dist/index.js +68 -0
  59. package/dist/jobs/jobs.contract.d.ts +2303 -0
  60. package/dist/jobs/jobs.contract.d.ts.map +1 -0
  61. package/dist/jobs/jobs.contract.js +295 -0
  62. package/dist/lead-assignments/lead-assignments.contract.d.ts +1826 -0
  63. package/dist/lead-assignments/lead-assignments.contract.d.ts.map +1 -0
  64. package/dist/lead-assignments/lead-assignments.contract.js +187 -0
  65. package/dist/lead-distribution/agent-lead-distribution.contract.d.ts +1147 -0
  66. package/dist/lead-distribution/agent-lead-distribution.contract.d.ts.map +1 -0
  67. package/dist/lead-distribution/agent-lead-distribution.contract.js +154 -0
  68. package/dist/lead-distribution/lead-distribution-config.contract.d.ts +1085 -0
  69. package/dist/lead-distribution/lead-distribution-config.contract.d.ts.map +1 -0
  70. package/dist/lead-distribution/lead-distribution-config.contract.js +196 -0
  71. package/dist/leads/leads.contract.d.ts +1690 -0
  72. package/dist/leads/leads.contract.d.ts.map +1 -0
  73. package/dist/leads/leads.contract.js +328 -0
  74. package/dist/locations/locations.contract.d.ts +974 -0
  75. package/dist/locations/locations.contract.d.ts.map +1 -0
  76. package/dist/locations/locations.contract.js +154 -0
  77. package/dist/postcodes/postcodes.contract.d.ts +370 -0
  78. package/dist/postcodes/postcodes.contract.d.ts.map +1 -0
  79. package/dist/postcodes/postcodes.contract.js +90 -0
  80. package/dist/qualifications/qualifications.contract.d.ts +1489 -0
  81. package/dist/qualifications/qualifications.contract.d.ts.map +1 -0
  82. package/dist/qualifications/qualifications.contract.js +215 -0
  83. package/dist/trades/trades.contract.d.ts +799 -0
  84. package/dist/trades/trades.contract.d.ts.map +1 -0
  85. package/dist/trades/trades.contract.js +112 -0
  86. package/dist/users/users.contract.d.ts +315 -299
  87. package/dist/users/users.contract.d.ts.map +1 -1
  88. package/dist/users/users.contract.js +13 -29
  89. package/dist/workers/workers.contract.d.ts +3376 -0
  90. package/dist/workers/workers.contract.d.ts.map +1 -0
  91. package/dist/workers/workers.contract.js +363 -0
  92. package/package.json +4 -3
package/dist/locations/locations.contract.d.ts ADDED
@@ -0,0 +1,974 @@
1
+ import { z } from 'zod';
2
+ import { CreateLocationSchema } from '../common/common-schemas';
3
+ export declare const PostcodeLevelSchema: z.ZodEnum<["POSTCODE", "SECTOR", "DISTRICT", "AREA"]>;
4
+ export declare const LocationSchema: z.ZodObject<{
5
+ id: z.ZodString;
6
+ address: z.ZodOptional<z.ZodNullable<z.ZodString>>;
7
+ type: z.ZodEnum<["POSTCODE", "SECTOR", "DISTRICT", "AREA"]>;
8
+ postcode: z.ZodOptional<z.ZodString>;
9
+ county: z.ZodOptional<z.ZodNullable<z.ZodString>>;
10
+ adminDistrict: z.ZodOptional<z.ZodNullable<z.ZodString>>;
11
+ builtUpArea: z.ZodOptional<z.ZodNullable<z.ZodString>>;
12
+ postTown: z.ZodOptional<z.ZodNullable<z.ZodString>>;
13
+ areaCovered: z.ZodOptional<z.ZodNullable<z.ZodString>>;
14
+ country: z.ZodOptional<z.ZodNullable<z.ZodString>>;
15
+ region: z.ZodOptional<z.ZodNullable<z.ZodString>>;
16
+ createdAt: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodDate]>, string, string | Date>;
17
+ updatedAt: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodDate]>, string, string | Date>;
18
+ }, "strip", z.ZodTypeAny, {
19
+ type: "POSTCODE" | "SECTOR" | "DISTRICT" | "AREA";
20
+ id: string;
21
+ createdAt: string;
22
+ updatedAt: string;
23
+ address?: string | null | undefined;
24
+ postcode?: string | undefined;
25
+ county?: string | null | undefined;
26
+ adminDistrict?: string | null | undefined;
27
+ builtUpArea?: string | null | undefined;
28
+ postTown?: string | null | undefined;
29
+ areaCovered?: string | null | undefined;
30
+ country?: string | null | undefined;
31
+ region?: string | null | undefined;
32
+ }, {
33
+ type: "POSTCODE" | "SECTOR" | "DISTRICT" | "AREA";
34
+ id: string;
35
+ createdAt: string | Date;
36
+ updatedAt: string | Date;
37
+ address?: string | null | undefined;
38
+ postcode?: string | undefined;
39
+ county?: string | null | undefined;
40
+ adminDistrict?: string | null | undefined;
41
+ builtUpArea?: string | null | undefined;
42
+ postTown?: string | null | undefined;
43
+ areaCovered?: string | null | undefined;
44
+ country?: string | null | undefined;
45
+ region?: string | null | undefined;
46
+ }>;
47
+ export declare const UpdateLocationSchema: z.ZodObject<{
48
+ address: z.ZodOptional<z.ZodString>;
49
+ postcode: z.ZodOptional<z.ZodString>;
50
+ }, "strip", z.ZodTypeAny, {
51
+ address?: string | undefined;
52
+ postcode?: string | undefined;
53
+ }, {
54
+ address?: string | undefined;
55
+ postcode?: string | undefined;
56
+ }>;
57
+ export declare const FilterLocationSchema: z.ZodObject<{
58
+ limit: z.ZodDefault<z.ZodNumber>;
59
+ page: z.ZodDefault<z.ZodNumber>;
60
+ }, "strip", z.ZodTypeAny, {
61
+ limit: number;
62
+ page: number;
63
+ }, {
64
+ limit?: number | undefined;
65
+ page?: number | undefined;
66
+ }>;
67
+ export type Location = z.infer<typeof LocationSchema>;
68
+ export type UpdateLocation = z.infer<typeof UpdateLocationSchema>;
69
+ export type FilterLocation = z.infer<typeof FilterLocationSchema>;
70
+ export type PostcodeLevel = z.infer<typeof PostcodeLevelSchema>;
71
+ export type { CreateLocation } from '../common/common-schemas';
72
+ export { CreateLocationSchema };
73
+ export declare const locationsContract: {
74
+ create: {
75
+ metadata: {
76
+ tags: string[];
77
+ };
78
+ summary: "Create a new location";
79
+ method: "POST";
80
+ body: z.ZodObject<{
81
+ address: z.ZodOptional<z.ZodString>;
82
+ postcode: z.ZodOptional<z.ZodString>;
83
+ }, "strip", z.ZodTypeAny, {
84
+ address?: string | undefined;
85
+ postcode?: string | undefined;
86
+ }, {
87
+ address?: string | undefined;
88
+ postcode?: string | undefined;
89
+ }>;
90
+ path: "/v2/locations";
91
+ responses: {
92
+ 400: z.ZodObject<{
93
+ statusCode: z.ZodNumber;
94
+ message: z.ZodString;
95
+ code: z.ZodString;
96
+ details: z.ZodOptional<z.ZodUnknown>;
97
+ timestamp: z.ZodString;
98
+ path: z.ZodString;
99
+ correlationId: z.ZodOptional<z.ZodString>;
100
+ }, "strip", z.ZodTypeAny, {
101
+ code: string;
102
+ path: string;
103
+ message: string;
104
+ statusCode: number;
105
+ timestamp: string;
106
+ details?: unknown;
107
+ correlationId?: string | undefined;
108
+ }, {
109
+ code: string;
110
+ path: string;
111
+ message: string;
112
+ statusCode: number;
113
+ timestamp: string;
114
+ details?: unknown;
115
+ correlationId?: string | undefined;
116
+ }>;
117
+ 401: z.ZodObject<{
118
+ statusCode: z.ZodNumber;
119
+ message: z.ZodString;
120
+ code: z.ZodString;
121
+ details: z.ZodOptional<z.ZodUnknown>;
122
+ timestamp: z.ZodString;
123
+ path: z.ZodString;
124
+ correlationId: z.ZodOptional<z.ZodString>;
125
+ }, "strip", z.ZodTypeAny, {
126
+ code: string;
127
+ path: string;
128
+ message: string;
129
+ statusCode: number;
130
+ timestamp: string;
131
+ details?: unknown;
132
+ correlationId?: string | undefined;
133
+ }, {
134
+ code: string;
135
+ path: string;
136
+ message: string;
137
+ statusCode: number;
138
+ timestamp: string;
139
+ details?: unknown;
140
+ correlationId?: string | undefined;
141
+ }>;
142
+ 403: z.ZodObject<{
143
+ statusCode: z.ZodNumber;
144
+ message: z.ZodString;
145
+ code: z.ZodString;
146
+ details: z.ZodOptional<z.ZodUnknown>;
147
+ timestamp: z.ZodString;
148
+ path: z.ZodString;
149
+ correlationId: z.ZodOptional<z.ZodString>;
150
+ }, "strip", z.ZodTypeAny, {
151
+ code: string;
152
+ path: string;
153
+ message: string;
154
+ statusCode: number;
155
+ timestamp: string;
156
+ details?: unknown;
157
+ correlationId?: string | undefined;
158
+ }, {
159
+ code: string;
160
+ path: string;
161
+ message: string;
162
+ statusCode: number;
163
+ timestamp: string;
164
+ details?: unknown;
165
+ correlationId?: string | undefined;
166
+ }>;
167
+ 500: z.ZodObject<{
168
+ statusCode: z.ZodNumber;
169
+ message: z.ZodString;
170
+ code: z.ZodString;
171
+ details: z.ZodOptional<z.ZodUnknown>;
172
+ timestamp: z.ZodString;
173
+ path: z.ZodString;
174
+ correlationId: z.ZodOptional<z.ZodString>;
175
+ }, "strip", z.ZodTypeAny, {
176
+ code: string;
177
+ path: string;
178
+ message: string;
179
+ statusCode: number;
180
+ timestamp: string;
181
+ details?: unknown;
182
+ correlationId?: string | undefined;
183
+ }, {
184
+ code: string;
185
+ path: string;
186
+ message: string;
187
+ statusCode: number;
188
+ timestamp: string;
189
+ details?: unknown;
190
+ correlationId?: string | undefined;
191
+ }>;
192
+ 201: z.ZodObject<{
193
+ id: z.ZodString;
194
+ address: z.ZodOptional<z.ZodNullable<z.ZodString>>;
195
+ type: z.ZodEnum<["POSTCODE", "SECTOR", "DISTRICT", "AREA"]>;
196
+ postcode: z.ZodOptional<z.ZodString>;
197
+ county: z.ZodOptional<z.ZodNullable<z.ZodString>>;
198
+ adminDistrict: z.ZodOptional<z.ZodNullable<z.ZodString>>;
199
+ builtUpArea: z.ZodOptional<z.ZodNullable<z.ZodString>>;
200
+ postTown: z.ZodOptional<z.ZodNullable<z.ZodString>>;
201
+ areaCovered: z.ZodOptional<z.ZodNullable<z.ZodString>>;
202
+ country: z.ZodOptional<z.ZodNullable<z.ZodString>>;
203
+ region: z.ZodOptional<z.ZodNullable<z.ZodString>>;
204
+ createdAt: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodDate]>, string, string | Date>;
205
+ updatedAt: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodDate]>, string, string | Date>;
206
+ }, "strip", z.ZodTypeAny, {
207
+ type: "POSTCODE" | "SECTOR" | "DISTRICT" | "AREA";
208
+ id: string;
209
+ createdAt: string;
210
+ updatedAt: string;
211
+ address?: string | null | undefined;
212
+ postcode?: string | undefined;
213
+ county?: string | null | undefined;
214
+ adminDistrict?: string | null | undefined;
215
+ builtUpArea?: string | null | undefined;
216
+ postTown?: string | null | undefined;
217
+ areaCovered?: string | null | undefined;
218
+ country?: string | null | undefined;
219
+ region?: string | null | undefined;
220
+ }, {
221
+ type: "POSTCODE" | "SECTOR" | "DISTRICT" | "AREA";
222
+ id: string;
223
+ createdAt: string | Date;
224
+ updatedAt: string | Date;
225
+ address?: string | null | undefined;
226
+ postcode?: string | undefined;
227
+ county?: string | null | undefined;
228
+ adminDistrict?: string | null | undefined;
229
+ builtUpArea?: string | null | undefined;
230
+ postTown?: string | null | undefined;
231
+ areaCovered?: string | null | undefined;
232
+ country?: string | null | undefined;
233
+ region?: string | null | undefined;
234
+ }>;
235
+ };
236
+ };
237
+ findAll: {
238
+ query: z.ZodObject<{
239
+ limit: z.ZodDefault<z.ZodNumber>;
240
+ page: z.ZodDefault<z.ZodNumber>;
241
+ }, "strip", z.ZodTypeAny, {
242
+ limit: number;
243
+ page: number;
244
+ }, {
245
+ limit?: number | undefined;
246
+ page?: number | undefined;
247
+ }>;
248
+ metadata: {
249
+ tags: string[];
250
+ };
251
+ summary: "Get all locations";
252
+ method: "GET";
253
+ path: "/v2/locations";
254
+ responses: {
255
+ 400: z.ZodObject<{
256
+ statusCode: z.ZodNumber;
257
+ message: z.ZodString;
258
+ code: z.ZodString;
259
+ details: z.ZodOptional<z.ZodUnknown>;
260
+ timestamp: z.ZodString;
261
+ path: z.ZodString;
262
+ correlationId: z.ZodOptional<z.ZodString>;
263
+ }, "strip", z.ZodTypeAny, {
264
+ code: string;
265
+ path: string;
266
+ message: string;
267
+ statusCode: number;
268
+ timestamp: string;
269
+ details?: unknown;
270
+ correlationId?: string | undefined;
271
+ }, {
272
+ code: string;
273
+ path: string;
274
+ message: string;
275
+ statusCode: number;
276
+ timestamp: string;
277
+ details?: unknown;
278
+ correlationId?: string | undefined;
279
+ }>;
280
+ 401: z.ZodObject<{
281
+ statusCode: z.ZodNumber;
282
+ message: z.ZodString;
283
+ code: z.ZodString;
284
+ details: z.ZodOptional<z.ZodUnknown>;
285
+ timestamp: z.ZodString;
286
+ path: z.ZodString;
287
+ correlationId: z.ZodOptional<z.ZodString>;
288
+ }, "strip", z.ZodTypeAny, {
289
+ code: string;
290
+ path: string;
291
+ message: string;
292
+ statusCode: number;
293
+ timestamp: string;
294
+ details?: unknown;
295
+ correlationId?: string | undefined;
296
+ }, {
297
+ code: string;
298
+ path: string;
299
+ message: string;
300
+ statusCode: number;
301
+ timestamp: string;
302
+ details?: unknown;
303
+ correlationId?: string | undefined;
304
+ }>;
305
+ 403: z.ZodObject<{
306
+ statusCode: z.ZodNumber;
307
+ message: z.ZodString;
308
+ code: z.ZodString;
309
+ details: z.ZodOptional<z.ZodUnknown>;
310
+ timestamp: z.ZodString;
311
+ path: z.ZodString;
312
+ correlationId: z.ZodOptional<z.ZodString>;
313
+ }, "strip", z.ZodTypeAny, {
314
+ code: string;
315
+ path: string;
316
+ message: string;
317
+ statusCode: number;
318
+ timestamp: string;
319
+ details?: unknown;
320
+ correlationId?: string | undefined;
321
+ }, {
322
+ code: string;
323
+ path: string;
324
+ message: string;
325
+ statusCode: number;
326
+ timestamp: string;
327
+ details?: unknown;
328
+ correlationId?: string | undefined;
329
+ }>;
330
+ 500: z.ZodObject<{
331
+ statusCode: z.ZodNumber;
332
+ message: z.ZodString;
333
+ code: z.ZodString;
334
+ details: z.ZodOptional<z.ZodUnknown>;
335
+ timestamp: z.ZodString;
336
+ path: z.ZodString;
337
+ correlationId: z.ZodOptional<z.ZodString>;
338
+ }, "strip", z.ZodTypeAny, {
339
+ code: string;
340
+ path: string;
341
+ message: string;
342
+ statusCode: number;
343
+ timestamp: string;
344
+ details?: unknown;
345
+ correlationId?: string | undefined;
346
+ }, {
347
+ code: string;
348
+ path: string;
349
+ message: string;
350
+ statusCode: number;
351
+ timestamp: string;
352
+ details?: unknown;
353
+ correlationId?: string | undefined;
354
+ }>;
355
+ 200: z.ZodObject<{
356
+ items: z.ZodArray<z.ZodObject<{
357
+ id: z.ZodString;
358
+ address: z.ZodOptional<z.ZodNullable<z.ZodString>>;
359
+ type: z.ZodEnum<["POSTCODE", "SECTOR", "DISTRICT", "AREA"]>;
360
+ postcode: z.ZodOptional<z.ZodString>;
361
+ county: z.ZodOptional<z.ZodNullable<z.ZodString>>;
362
+ adminDistrict: z.ZodOptional<z.ZodNullable<z.ZodString>>;
363
+ builtUpArea: z.ZodOptional<z.ZodNullable<z.ZodString>>;
364
+ postTown: z.ZodOptional<z.ZodNullable<z.ZodString>>;
365
+ areaCovered: z.ZodOptional<z.ZodNullable<z.ZodString>>;
366
+ country: z.ZodOptional<z.ZodNullable<z.ZodString>>;
367
+ region: z.ZodOptional<z.ZodNullable<z.ZodString>>;
368
+ createdAt: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodDate]>, string, string | Date>;
369
+ updatedAt: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodDate]>, string, string | Date>;
370
+ }, "strip", z.ZodTypeAny, {
371
+ type: "POSTCODE" | "SECTOR" | "DISTRICT" | "AREA";
372
+ id: string;
373
+ createdAt: string;
374
+ updatedAt: string;
375
+ address?: string | null | undefined;
376
+ postcode?: string | undefined;
377
+ county?: string | null | undefined;
378
+ adminDistrict?: string | null | undefined;
379
+ builtUpArea?: string | null | undefined;
380
+ postTown?: string | null | undefined;
381
+ areaCovered?: string | null | undefined;
382
+ country?: string | null | undefined;
383
+ region?: string | null | undefined;
384
+ }, {
385
+ type: "POSTCODE" | "SECTOR" | "DISTRICT" | "AREA";
386
+ id: string;
387
+ createdAt: string | Date;
388
+ updatedAt: string | Date;
389
+ address?: string | null | undefined;
390
+ postcode?: string | undefined;
391
+ county?: string | null | undefined;
392
+ adminDistrict?: string | null | undefined;
393
+ builtUpArea?: string | null | undefined;
394
+ postTown?: string | null | undefined;
395
+ areaCovered?: string | null | undefined;
396
+ country?: string | null | undefined;
397
+ region?: string | null | undefined;
398
+ }>, "many">;
399
+ totalCount: z.ZodNumber;
400
+ limit: z.ZodNumber;
401
+ skip: z.ZodNumber;
402
+ currentPage: z.ZodNumber;
403
+ totalPages: z.ZodNumber;
404
+ }, "strip", z.ZodTypeAny, {
405
+ limit: number;
406
+ items: {
407
+ type: "POSTCODE" | "SECTOR" | "DISTRICT" | "AREA";
408
+ id: string;
409
+ createdAt: string;
410
+ updatedAt: string;
411
+ address?: string | null | undefined;
412
+ postcode?: string | undefined;
413
+ county?: string | null | undefined;
414
+ adminDistrict?: string | null | undefined;
415
+ builtUpArea?: string | null | undefined;
416
+ postTown?: string | null | undefined;
417
+ areaCovered?: string | null | undefined;
418
+ country?: string | null | undefined;
419
+ region?: string | null | undefined;
420
+ }[];
421
+ totalCount: number;
422
+ skip: number;
423
+ currentPage: number;
424
+ totalPages: number;
425
+ }, {
426
+ limit: number;
427
+ items: {
428
+ type: "POSTCODE" | "SECTOR" | "DISTRICT" | "AREA";
429
+ id: string;
430
+ createdAt: string | Date;
431
+ updatedAt: string | Date;
432
+ address?: string | null | undefined;
433
+ postcode?: string | undefined;
434
+ county?: string | null | undefined;
435
+ adminDistrict?: string | null | undefined;
436
+ builtUpArea?: string | null | undefined;
437
+ postTown?: string | null | undefined;
438
+ areaCovered?: string | null | undefined;
439
+ country?: string | null | undefined;
440
+ region?: string | null | undefined;
441
+ }[];
442
+ totalCount: number;
443
+ skip: number;
444
+ currentPage: number;
445
+ totalPages: number;
446
+ }>;
447
+ };
448
+ };
449
+ findOne: {
450
+ metadata: {
451
+ tags: string[];
452
+ };
453
+ pathParams: z.ZodObject<{
454
+ id: z.ZodString;
455
+ }, "strip", z.ZodTypeAny, {
456
+ id: string;
457
+ }, {
458
+ id: string;
459
+ }>;
460
+ summary: "Get a location by ID";
461
+ method: "GET";
462
+ path: "/v2/locations/:id";
463
+ responses: {
464
+ 400: z.ZodObject<{
465
+ statusCode: z.ZodNumber;
466
+ message: z.ZodString;
467
+ code: z.ZodString;
468
+ details: z.ZodOptional<z.ZodUnknown>;
469
+ timestamp: z.ZodString;
470
+ path: z.ZodString;
471
+ correlationId: z.ZodOptional<z.ZodString>;
472
+ }, "strip", z.ZodTypeAny, {
473
+ code: string;
474
+ path: string;
475
+ message: string;
476
+ statusCode: number;
477
+ timestamp: string;
478
+ details?: unknown;
479
+ correlationId?: string | undefined;
480
+ }, {
481
+ code: string;
482
+ path: string;
483
+ message: string;
484
+ statusCode: number;
485
+ timestamp: string;
486
+ details?: unknown;
487
+ correlationId?: string | undefined;
488
+ }>;
489
+ 401: z.ZodObject<{
490
+ statusCode: z.ZodNumber;
491
+ message: z.ZodString;
492
+ code: z.ZodString;
493
+ details: z.ZodOptional<z.ZodUnknown>;
494
+ timestamp: z.ZodString;
495
+ path: z.ZodString;
496
+ correlationId: z.ZodOptional<z.ZodString>;
497
+ }, "strip", z.ZodTypeAny, {
498
+ code: string;
499
+ path: string;
500
+ message: string;
501
+ statusCode: number;
502
+ timestamp: string;
503
+ details?: unknown;
504
+ correlationId?: string | undefined;
505
+ }, {
506
+ code: string;
507
+ path: string;
508
+ message: string;
509
+ statusCode: number;
510
+ timestamp: string;
511
+ details?: unknown;
512
+ correlationId?: string | undefined;
513
+ }>;
514
+ 403: z.ZodObject<{
515
+ statusCode: z.ZodNumber;
516
+ message: z.ZodString;
517
+ code: z.ZodString;
518
+ details: z.ZodOptional<z.ZodUnknown>;
519
+ timestamp: z.ZodString;
520
+ path: z.ZodString;
521
+ correlationId: z.ZodOptional<z.ZodString>;
522
+ }, "strip", z.ZodTypeAny, {
523
+ code: string;
524
+ path: string;
525
+ message: string;
526
+ statusCode: number;
527
+ timestamp: string;
528
+ details?: unknown;
529
+ correlationId?: string | undefined;
530
+ }, {
531
+ code: string;
532
+ path: string;
533
+ message: string;
534
+ statusCode: number;
535
+ timestamp: string;
536
+ details?: unknown;
537
+ correlationId?: string | undefined;
538
+ }>;
539
+ 500: z.ZodObject<{
540
+ statusCode: z.ZodNumber;
541
+ message: z.ZodString;
542
+ code: z.ZodString;
543
+ details: z.ZodOptional<z.ZodUnknown>;
544
+ timestamp: z.ZodString;
545
+ path: z.ZodString;
546
+ correlationId: z.ZodOptional<z.ZodString>;
547
+ }, "strip", z.ZodTypeAny, {
548
+ code: string;
549
+ path: string;
550
+ message: string;
551
+ statusCode: number;
552
+ timestamp: string;
553
+ details?: unknown;
554
+ correlationId?: string | undefined;
555
+ }, {
556
+ code: string;
557
+ path: string;
558
+ message: string;
559
+ statusCode: number;
560
+ timestamp: string;
561
+ details?: unknown;
562
+ correlationId?: string | undefined;
563
+ }>;
564
+ 200: z.ZodObject<{
565
+ id: z.ZodString;
566
+ address: z.ZodOptional<z.ZodNullable<z.ZodString>>;
567
+ type: z.ZodEnum<["POSTCODE", "SECTOR", "DISTRICT", "AREA"]>;
568
+ postcode: z.ZodOptional<z.ZodString>;
569
+ county: z.ZodOptional<z.ZodNullable<z.ZodString>>;
570
+ adminDistrict: z.ZodOptional<z.ZodNullable<z.ZodString>>;
571
+ builtUpArea: z.ZodOptional<z.ZodNullable<z.ZodString>>;
572
+ postTown: z.ZodOptional<z.ZodNullable<z.ZodString>>;
573
+ areaCovered: z.ZodOptional<z.ZodNullable<z.ZodString>>;
574
+ country: z.ZodOptional<z.ZodNullable<z.ZodString>>;
575
+ region: z.ZodOptional<z.ZodNullable<z.ZodString>>;
576
+ createdAt: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodDate]>, string, string | Date>;
577
+ updatedAt: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodDate]>, string, string | Date>;
578
+ }, "strip", z.ZodTypeAny, {
579
+ type: "POSTCODE" | "SECTOR" | "DISTRICT" | "AREA";
580
+ id: string;
581
+ createdAt: string;
582
+ updatedAt: string;
583
+ address?: string | null | undefined;
584
+ postcode?: string | undefined;
585
+ county?: string | null | undefined;
586
+ adminDistrict?: string | null | undefined;
587
+ builtUpArea?: string | null | undefined;
588
+ postTown?: string | null | undefined;
589
+ areaCovered?: string | null | undefined;
590
+ country?: string | null | undefined;
591
+ region?: string | null | undefined;
592
+ }, {
593
+ type: "POSTCODE" | "SECTOR" | "DISTRICT" | "AREA";
594
+ id: string;
595
+ createdAt: string | Date;
596
+ updatedAt: string | Date;
597
+ address?: string | null | undefined;
598
+ postcode?: string | undefined;
599
+ county?: string | null | undefined;
600
+ adminDistrict?: string | null | undefined;
601
+ builtUpArea?: string | null | undefined;
602
+ postTown?: string | null | undefined;
603
+ areaCovered?: string | null | undefined;
604
+ country?: string | null | undefined;
605
+ region?: string | null | undefined;
606
+ }>;
607
+ 404: z.ZodObject<{
608
+ statusCode: z.ZodNumber;
609
+ message: z.ZodString;
610
+ code: z.ZodString;
611
+ details: z.ZodOptional<z.ZodUnknown>;
612
+ timestamp: z.ZodString;
613
+ path: z.ZodString;
614
+ correlationId: z.ZodOptional<z.ZodString>;
615
+ }, "strip", z.ZodTypeAny, {
616
+ code: string;
617
+ path: string;
618
+ message: string;
619
+ statusCode: number;
620
+ timestamp: string;
621
+ details?: unknown;
622
+ correlationId?: string | undefined;
623
+ }, {
624
+ code: string;
625
+ path: string;
626
+ message: string;
627
+ statusCode: number;
628
+ timestamp: string;
629
+ details?: unknown;
630
+ correlationId?: string | undefined;
631
+ }>;
632
+ };
633
+ };
634
+ update: {
635
+ metadata: {
636
+ tags: string[];
637
+ };
638
+ pathParams: z.ZodObject<{
639
+ id: z.ZodString;
640
+ }, "strip", z.ZodTypeAny, {
641
+ id: string;
642
+ }, {
643
+ id: string;
644
+ }>;
645
+ summary: "Update a location by ID";
646
+ method: "PATCH";
647
+ body: z.ZodObject<{
648
+ address: z.ZodOptional<z.ZodString>;
649
+ postcode: z.ZodOptional<z.ZodString>;
650
+ }, "strip", z.ZodTypeAny, {
651
+ address?: string | undefined;
652
+ postcode?: string | undefined;
653
+ }, {
654
+ address?: string | undefined;
655
+ postcode?: string | undefined;
656
+ }>;
657
+ path: "/v2/locations/:id";
658
+ responses: {
659
+ 400: z.ZodObject<{
660
+ statusCode: z.ZodNumber;
661
+ message: z.ZodString;
662
+ code: z.ZodString;
663
+ details: z.ZodOptional<z.ZodUnknown>;
664
+ timestamp: z.ZodString;
665
+ path: z.ZodString;
666
+ correlationId: z.ZodOptional<z.ZodString>;
667
+ }, "strip", z.ZodTypeAny, {
668
+ code: string;
669
+ path: string;
670
+ message: string;
671
+ statusCode: number;
672
+ timestamp: string;
673
+ details?: unknown;
674
+ correlationId?: string | undefined;
675
+ }, {
676
+ code: string;
677
+ path: string;
678
+ message: string;
679
+ statusCode: number;
680
+ timestamp: string;
681
+ details?: unknown;
682
+ correlationId?: string | undefined;
683
+ }>;
684
+ 401: z.ZodObject<{
685
+ statusCode: z.ZodNumber;
686
+ message: z.ZodString;
687
+ code: z.ZodString;
688
+ details: z.ZodOptional<z.ZodUnknown>;
689
+ timestamp: z.ZodString;
690
+ path: z.ZodString;
691
+ correlationId: z.ZodOptional<z.ZodString>;
692
+ }, "strip", z.ZodTypeAny, {
693
+ code: string;
694
+ path: string;
695
+ message: string;
696
+ statusCode: number;
697
+ timestamp: string;
698
+ details?: unknown;
699
+ correlationId?: string | undefined;
700
+ }, {
701
+ code: string;
702
+ path: string;
703
+ message: string;
704
+ statusCode: number;
705
+ timestamp: string;
706
+ details?: unknown;
707
+ correlationId?: string | undefined;
708
+ }>;
709
+ 403: z.ZodObject<{
710
+ statusCode: z.ZodNumber;
711
+ message: z.ZodString;
712
+ code: z.ZodString;
713
+ details: z.ZodOptional<z.ZodUnknown>;
714
+ timestamp: z.ZodString;
715
+ path: z.ZodString;
716
+ correlationId: z.ZodOptional<z.ZodString>;
717
+ }, "strip", z.ZodTypeAny, {
718
+ code: string;
719
+ path: string;
720
+ message: string;
721
+ statusCode: number;
722
+ timestamp: string;
723
+ details?: unknown;
724
+ correlationId?: string | undefined;
725
+ }, {
726
+ code: string;
727
+ path: string;
728
+ message: string;
729
+ statusCode: number;
730
+ timestamp: string;
731
+ details?: unknown;
732
+ correlationId?: string | undefined;
733
+ }>;
734
+ 500: z.ZodObject<{
735
+ statusCode: z.ZodNumber;
736
+ message: z.ZodString;
737
+ code: z.ZodString;
738
+ details: z.ZodOptional<z.ZodUnknown>;
739
+ timestamp: z.ZodString;
740
+ path: z.ZodString;
741
+ correlationId: z.ZodOptional<z.ZodString>;
742
+ }, "strip", z.ZodTypeAny, {
743
+ code: string;
744
+ path: string;
745
+ message: string;
746
+ statusCode: number;
747
+ timestamp: string;
748
+ details?: unknown;
749
+ correlationId?: string | undefined;
750
+ }, {
751
+ code: string;
752
+ path: string;
753
+ message: string;
754
+ statusCode: number;
755
+ timestamp: string;
756
+ details?: unknown;
757
+ correlationId?: string | undefined;
758
+ }>;
759
+ 200: z.ZodObject<{
760
+ id: z.ZodString;
761
+ address: z.ZodOptional<z.ZodNullable<z.ZodString>>;
762
+ type: z.ZodEnum<["POSTCODE", "SECTOR", "DISTRICT", "AREA"]>;
763
+ postcode: z.ZodOptional<z.ZodString>;
764
+ county: z.ZodOptional<z.ZodNullable<z.ZodString>>;
765
+ adminDistrict: z.ZodOptional<z.ZodNullable<z.ZodString>>;
766
+ builtUpArea: z.ZodOptional<z.ZodNullable<z.ZodString>>;
767
+ postTown: z.ZodOptional<z.ZodNullable<z.ZodString>>;
768
+ areaCovered: z.ZodOptional<z.ZodNullable<z.ZodString>>;
769
+ country: z.ZodOptional<z.ZodNullable<z.ZodString>>;
770
+ region: z.ZodOptional<z.ZodNullable<z.ZodString>>;
771
+ createdAt: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodDate]>, string, string | Date>;
772
+ updatedAt: z.ZodEffects<z.ZodUnion<[z.ZodString, z.ZodDate]>, string, string | Date>;
773
+ }, "strip", z.ZodTypeAny, {
774
+ type: "POSTCODE" | "SECTOR" | "DISTRICT" | "AREA";
775
+ id: string;
776
+ createdAt: string;
777
+ updatedAt: string;
778
+ address?: string | null | undefined;
779
+ postcode?: string | undefined;
780
+ county?: string | null | undefined;
781
+ adminDistrict?: string | null | undefined;
782
+ builtUpArea?: string | null | undefined;
783
+ postTown?: string | null | undefined;
784
+ areaCovered?: string | null | undefined;
785
+ country?: string | null | undefined;
786
+ region?: string | null | undefined;
787
+ }, {
788
+ type: "POSTCODE" | "SECTOR" | "DISTRICT" | "AREA";
789
+ id: string;
790
+ createdAt: string | Date;
791
+ updatedAt: string | Date;
792
+ address?: string | null | undefined;
793
+ postcode?: string | undefined;
794
+ county?: string | null | undefined;
795
+ adminDistrict?: string | null | undefined;
796
+ builtUpArea?: string | null | undefined;
797
+ postTown?: string | null | undefined;
798
+ areaCovered?: string | null | undefined;
799
+ country?: string | null | undefined;
800
+ region?: string | null | undefined;
801
+ }>;
802
+ 404: z.ZodObject<{
803
+ statusCode: z.ZodNumber;
804
+ message: z.ZodString;
805
+ code: z.ZodString;
806
+ details: z.ZodOptional<z.ZodUnknown>;
807
+ timestamp: z.ZodString;
808
+ path: z.ZodString;
809
+ correlationId: z.ZodOptional<z.ZodString>;
810
+ }, "strip", z.ZodTypeAny, {
811
+ code: string;
812
+ path: string;
813
+ message: string;
814
+ statusCode: number;
815
+ timestamp: string;
816
+ details?: unknown;
817
+ correlationId?: string | undefined;
818
+ }, {
819
+ code: string;
820
+ path: string;
821
+ message: string;
822
+ statusCode: number;
823
+ timestamp: string;
824
+ details?: unknown;
825
+ correlationId?: string | undefined;
826
+ }>;
827
+ };
828
+ };
829
+ remove: {
830
+ metadata: {
831
+ tags: string[];
832
+ };
833
+ pathParams: z.ZodObject<{
834
+ id: z.ZodString;
835
+ }, "strip", z.ZodTypeAny, {
836
+ id: string;
837
+ }, {
838
+ id: string;
839
+ }>;
840
+ summary: "Delete a location by ID";
841
+ method: "DELETE";
842
+ body: typeof import("@ts-rest/core").ContractNoBody;
843
+ path: "/v2/locations/:id";
844
+ responses: {
845
+ 400: z.ZodObject<{
846
+ statusCode: z.ZodNumber;
847
+ message: z.ZodString;
848
+ code: z.ZodString;
849
+ details: z.ZodOptional<z.ZodUnknown>;
850
+ timestamp: z.ZodString;
851
+ path: z.ZodString;
852
+ correlationId: z.ZodOptional<z.ZodString>;
853
+ }, "strip", z.ZodTypeAny, {
854
+ code: string;
855
+ path: string;
856
+ message: string;
857
+ statusCode: number;
858
+ timestamp: string;
859
+ details?: unknown;
860
+ correlationId?: string | undefined;
861
+ }, {
862
+ code: string;
863
+ path: string;
864
+ message: string;
865
+ statusCode: number;
866
+ timestamp: string;
867
+ details?: unknown;
868
+ correlationId?: string | undefined;
869
+ }>;
870
+ 401: z.ZodObject<{
871
+ statusCode: z.ZodNumber;
872
+ message: z.ZodString;
873
+ code: z.ZodString;
874
+ details: z.ZodOptional<z.ZodUnknown>;
875
+ timestamp: z.ZodString;
876
+ path: z.ZodString;
877
+ correlationId: z.ZodOptional<z.ZodString>;
878
+ }, "strip", z.ZodTypeAny, {
879
+ code: string;
880
+ path: string;
881
+ message: string;
882
+ statusCode: number;
883
+ timestamp: string;
884
+ details?: unknown;
885
+ correlationId?: string | undefined;
886
+ }, {
887
+ code: string;
888
+ path: string;
889
+ message: string;
890
+ statusCode: number;
891
+ timestamp: string;
892
+ details?: unknown;
893
+ correlationId?: string | undefined;
894
+ }>;
895
+ 403: z.ZodObject<{
896
+ statusCode: z.ZodNumber;
897
+ message: z.ZodString;
898
+ code: z.ZodString;
899
+ details: z.ZodOptional<z.ZodUnknown>;
900
+ timestamp: z.ZodString;
901
+ path: z.ZodString;
902
+ correlationId: z.ZodOptional<z.ZodString>;
903
+ }, "strip", z.ZodTypeAny, {
904
+ code: string;
905
+ path: string;
906
+ message: string;
907
+ statusCode: number;
908
+ timestamp: string;
909
+ details?: unknown;
910
+ correlationId?: string | undefined;
911
+ }, {
912
+ code: string;
913
+ path: string;
914
+ message: string;
915
+ statusCode: number;
916
+ timestamp: string;
917
+ details?: unknown;
918
+ correlationId?: string | undefined;
919
+ }>;
920
+ 500: z.ZodObject<{
921
+ statusCode: z.ZodNumber;
922
+ message: z.ZodString;
923
+ code: z.ZodString;
924
+ details: z.ZodOptional<z.ZodUnknown>;
925
+ timestamp: z.ZodString;
926
+ path: z.ZodString;
927
+ correlationId: z.ZodOptional<z.ZodString>;
928
+ }, "strip", z.ZodTypeAny, {
929
+ code: string;
930
+ path: string;
931
+ message: string;
932
+ statusCode: number;
933
+ timestamp: string;
934
+ details?: unknown;
935
+ correlationId?: string | undefined;
936
+ }, {
937
+ code: string;
938
+ path: string;
939
+ message: string;
940
+ statusCode: number;
941
+ timestamp: string;
942
+ details?: unknown;
943
+ correlationId?: string | undefined;
944
+ }>;
945
+ 204: z.ZodUndefined;
946
+ 404: z.ZodObject<{
947
+ statusCode: z.ZodNumber;
948
+ message: z.ZodString;
949
+ code: z.ZodString;
950
+ details: z.ZodOptional<z.ZodUnknown>;
951
+ timestamp: z.ZodString;
952
+ path: z.ZodString;
953
+ correlationId: z.ZodOptional<z.ZodString>;
954
+ }, "strip", z.ZodTypeAny, {
955
+ code: string;
956
+ path: string;
957
+ message: string;
958
+ statusCode: number;
959
+ timestamp: string;
960
+ details?: unknown;
961
+ correlationId?: string | undefined;
962
+ }, {
963
+ code: string;
964
+ path: string;
965
+ message: string;
966
+ statusCode: number;
967
+ timestamp: string;
968
+ details?: unknown;
969
+ correlationId?: string | undefined;
970
+ }>;
971
+ };
972
+ };
973
+ };
974
+ //# sourceMappingURL=locations.contract.d.ts.map