aves-sdk 1.2.16 → 1.3.1
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/dist/index.cjs +2 -2
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +537 -96
- package/dist/index.d.ts +537 -96
- package/dist/index.js +2 -2
- package/dist/index.js.map +1 -1
- package/package.json +7 -9
package/dist/index.d.ts
CHANGED
|
@@ -1,42 +1,54 @@
|
|
|
1
1
|
import * as v from 'valibot';
|
|
2
2
|
import { InferInput, InferOutput } from 'valibot';
|
|
3
3
|
|
|
4
|
+
declare const ERROR_KINDS: {
|
|
5
|
+
readonly VALIDATION: "validation";
|
|
6
|
+
readonly API: "api";
|
|
7
|
+
readonly UNKNOWN: "unknown";
|
|
8
|
+
};
|
|
9
|
+
type ErrorKind = (typeof ERROR_KINDS)[keyof typeof ERROR_KINDS];
|
|
10
|
+
/**
|
|
11
|
+
* Error thrown by AVES API operations
|
|
12
|
+
*/
|
|
13
|
+
declare class AvesError extends Error {
|
|
14
|
+
readonly kind: ErrorKind;
|
|
15
|
+
readonly message: string;
|
|
16
|
+
readonly status?: string | undefined;
|
|
17
|
+
readonly code?: number | string | undefined;
|
|
18
|
+
constructor(kind: ErrorKind, message: string, status?: string | undefined, code?: number | string | undefined);
|
|
19
|
+
private parseCode;
|
|
20
|
+
}
|
|
21
|
+
|
|
4
22
|
/**
|
|
5
23
|
* Request header schema with authentication credentials
|
|
6
24
|
*/
|
|
7
25
|
declare const RqHeaderSchema: v.ObjectSchema<{
|
|
8
|
-
readonly
|
|
9
|
-
readonly
|
|
10
|
-
readonly
|
|
11
|
-
readonly
|
|
12
|
-
readonly
|
|
26
|
+
readonly "@HostID": v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 6, undefined>, v.MaxLengthAction<string, 6, undefined>]>;
|
|
27
|
+
readonly "@Xtoken": v.StringSchema<undefined>;
|
|
28
|
+
readonly "@Interface": v.LiteralSchema<"WEB", undefined>;
|
|
29
|
+
readonly "@UserName": v.LiteralSchema<"WEB", undefined>;
|
|
30
|
+
readonly "@LanguageCode": v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 2, undefined>, v.MaxLengthAction<string, 2, undefined>]>, undefined>;
|
|
13
31
|
}, undefined>;
|
|
14
32
|
/**
|
|
15
33
|
* Response status schema indicating success, error, or warning
|
|
16
34
|
*/
|
|
17
35
|
declare const RsStatusSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
18
|
-
readonly
|
|
36
|
+
readonly "@Status": v.UnionSchema<[v.LiteralSchema<"OK", undefined>, v.LiteralSchema<"ERROR", undefined>, v.LiteralSchema<"WARNING", undefined>, v.LiteralSchema<"TIMEOUT", undefined>], undefined>;
|
|
19
37
|
readonly ErrorCode: v.OptionalSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<string | number, number>]>, undefined>;
|
|
20
38
|
readonly ErrorDescription: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
21
39
|
readonly Warnings: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TransformAction<string, string[]>]>, undefined>;
|
|
22
40
|
}, undefined>, v.TransformAction<{
|
|
23
|
-
|
|
41
|
+
"@Status": "WARNING" | "OK" | "ERROR" | "TIMEOUT";
|
|
24
42
|
ErrorCode?: number | undefined;
|
|
25
43
|
ErrorDescription?: string | undefined;
|
|
26
44
|
Warnings?: string[] | undefined;
|
|
27
45
|
}, {
|
|
28
|
-
status: "
|
|
46
|
+
status: "WARNING" | "OK" | "ERROR" | "TIMEOUT";
|
|
29
47
|
errorCode: number | undefined;
|
|
30
48
|
errorDescription: string | undefined;
|
|
31
49
|
warnings: string[] | undefined;
|
|
32
50
|
}>]>;
|
|
33
51
|
|
|
34
|
-
type CamelFromDelimiter<S extends string> = S extends `${infer H}_${infer T}` ? `${H}${Capitalize<CamelFromDelimiter<T>>}` : S extends `${infer H}-${infer T}` ? `${H}${Capitalize<CamelFromDelimiter<T>>}` : S;
|
|
35
|
-
type ToCamelCase<S extends string> = CamelFromDelimiter<S> extends `${infer F}${infer R}` ? `${Lowercase<F>}${R}` : CamelFromDelimiter<S>;
|
|
36
|
-
type Camelize<T> = T extends readonly (infer U)[] ? Camelize<U>[] : T extends object ? {
|
|
37
|
-
[K in keyof T as K extends `@${infer Rest}` ? ToCamelCase<Rest> : ToCamelCase<K & string>]: Camelize<T[K]>;
|
|
38
|
-
} : T;
|
|
39
|
-
|
|
40
52
|
/**
|
|
41
53
|
* Financial detail schema for API requests (transforms to PascalCase)
|
|
42
54
|
*/
|
|
@@ -68,6 +80,60 @@ declare const FinancialDetailSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
|
68
80
|
EnableElectronicInvoicing?: boolean | "true" | "false" | undefined;
|
|
69
81
|
ElectronicInvoicingType?: string | undefined;
|
|
70
82
|
}>]>;
|
|
83
|
+
/**
|
|
84
|
+
* ID document detail schema for API requests (transforms to PascalCase)
|
|
85
|
+
*/
|
|
86
|
+
declare const IdDocumentDetailSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
87
|
+
readonly idType: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
88
|
+
readonly idCode: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
89
|
+
readonly idIssueLocation: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
90
|
+
readonly idIssueCounty: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
91
|
+
readonly idIssueDate: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
92
|
+
readonly idExpireDate: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
93
|
+
}, undefined>, v.TransformAction<{
|
|
94
|
+
idType?: string | undefined;
|
|
95
|
+
idCode?: string | undefined;
|
|
96
|
+
idIssueLocation?: string | undefined;
|
|
97
|
+
idIssueCounty?: string | undefined;
|
|
98
|
+
idIssueDate?: string | undefined;
|
|
99
|
+
idExpireDate?: string | undefined;
|
|
100
|
+
}, {
|
|
101
|
+
IdType?: string | undefined;
|
|
102
|
+
IdCode?: string | undefined;
|
|
103
|
+
IdIssueLocation?: string | undefined;
|
|
104
|
+
IdIssueCounty?: string | undefined;
|
|
105
|
+
IdIssueDate?: string | undefined;
|
|
106
|
+
IdExpireDate?: string | undefined;
|
|
107
|
+
}>]>;
|
|
108
|
+
/**
|
|
109
|
+
* Dynamic fields schema for API requests (transforms to PascalCase)
|
|
110
|
+
*/
|
|
111
|
+
declare const DynamicFieldsSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
112
|
+
readonly key: v.StringSchema<undefined>;
|
|
113
|
+
readonly value: v.StringSchema<undefined>;
|
|
114
|
+
}, undefined>, v.TransformAction<{
|
|
115
|
+
key: string;
|
|
116
|
+
value: string;
|
|
117
|
+
}, {
|
|
118
|
+
Key: string;
|
|
119
|
+
Value: string;
|
|
120
|
+
}>]>;
|
|
121
|
+
/**
|
|
122
|
+
* Account policies schema for API requests (transforms to PascalCase with @ attributes)
|
|
123
|
+
*/
|
|
124
|
+
declare const AccountPoliciesSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
125
|
+
readonly acceptProfilingPolicies: v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<0, undefined>, v.LiteralSchema<1, undefined>], undefined>, undefined>;
|
|
126
|
+
readonly acceptPrivacyPolicies: v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<0, undefined>, v.LiteralSchema<1, undefined>], undefined>, undefined>;
|
|
127
|
+
readonly acceptNewsletterPolicies: v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<0, undefined>, v.LiteralSchema<1, undefined>], undefined>, undefined>;
|
|
128
|
+
}, undefined>, v.TransformAction<{
|
|
129
|
+
acceptProfilingPolicies?: 0 | 1 | undefined;
|
|
130
|
+
acceptPrivacyPolicies?: 0 | 1 | undefined;
|
|
131
|
+
acceptNewsletterPolicies?: 0 | 1 | undefined;
|
|
132
|
+
}, {
|
|
133
|
+
AcceptProfilingPolicies?: 0 | 1 | undefined;
|
|
134
|
+
AcceptPrivacyPolicies?: 0 | 1 | undefined;
|
|
135
|
+
AcceptNewsletterPolicies?: 0 | 1 | undefined;
|
|
136
|
+
}>]>;
|
|
71
137
|
/**
|
|
72
138
|
* Master record detail input schema (camelCase)
|
|
73
139
|
*/
|
|
@@ -96,6 +162,15 @@ declare const MasterRecordDetailSchema: v.ObjectSchema<{
|
|
|
96
162
|
readonly birthCounty: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
97
163
|
readonly fiscalCode: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
98
164
|
readonly vatCode: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
165
|
+
readonly thirdPartRecordCode: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
166
|
+
readonly idDocumentDetail: v.OptionalSchema<v.ObjectSchema<{
|
|
167
|
+
readonly idType: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
168
|
+
readonly idCode: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
169
|
+
readonly idIssueLocation: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
170
|
+
readonly idIssueCounty: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
171
|
+
readonly idIssueDate: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
172
|
+
readonly idExpireDate: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
173
|
+
}, undefined>, undefined>;
|
|
99
174
|
readonly accountPolicies: v.OptionalSchema<v.ObjectSchema<{
|
|
100
175
|
readonly acceptProfilingPolicies: v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<0, undefined>, v.LiteralSchema<1, undefined>], undefined>, undefined>;
|
|
101
176
|
readonly acceptPrivacyPolicies: v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<0, undefined>, v.LiteralSchema<1, undefined>], undefined>, undefined>;
|
|
@@ -144,6 +219,15 @@ declare const MasterRecordDetailResponseSchema: v.SchemaWithPipe<readonly [v.Sch
|
|
|
144
219
|
readonly birthCounty: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
145
220
|
readonly fiscalCode: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
146
221
|
readonly vatCode: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
222
|
+
readonly thirdPartRecordCode: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
223
|
+
readonly idDocumentDetail: v.OptionalSchema<v.ObjectSchema<{
|
|
224
|
+
readonly idType: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
225
|
+
readonly idCode: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
226
|
+
readonly idIssueLocation: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
227
|
+
readonly idIssueCounty: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
228
|
+
readonly idIssueDate: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
229
|
+
readonly idExpireDate: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
230
|
+
}, undefined>, undefined>;
|
|
147
231
|
readonly accountPolicies: v.OptionalSchema<v.ObjectSchema<{
|
|
148
232
|
readonly acceptProfilingPolicies: v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<0, undefined>, v.LiteralSchema<1, undefined>], undefined>, undefined>;
|
|
149
233
|
readonly acceptPrivacyPolicies: v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<0, undefined>, v.LiteralSchema<1, undefined>], undefined>, undefined>;
|
|
@@ -168,7 +252,7 @@ declare const MasterRecordDetailResponseSchema: v.SchemaWithPipe<readonly [v.Sch
|
|
|
168
252
|
insertCriteria?: "S" | "N" | "T" | "M" | undefined;
|
|
169
253
|
createdDate?: string | undefined;
|
|
170
254
|
recordType?: "CUSTOMER" | "SUPPLIER" | "GENERAL" | undefined;
|
|
171
|
-
recordStatus?: "
|
|
255
|
+
recordStatus?: "ENABLED" | "DISABLED" | "WARNING" | "BLACKLISTED" | undefined;
|
|
172
256
|
moniker?: string | undefined;
|
|
173
257
|
name?: string | undefined;
|
|
174
258
|
extraInfo?: string | undefined;
|
|
@@ -188,6 +272,15 @@ declare const MasterRecordDetailResponseSchema: v.SchemaWithPipe<readonly [v.Sch
|
|
|
188
272
|
birthCounty?: string | undefined;
|
|
189
273
|
fiscalCode?: string | undefined;
|
|
190
274
|
vatCode?: string | undefined;
|
|
275
|
+
thirdPartRecordCode?: string | undefined;
|
|
276
|
+
idDocumentDetail?: {
|
|
277
|
+
idType?: string | undefined;
|
|
278
|
+
idCode?: string | undefined;
|
|
279
|
+
idIssueLocation?: string | undefined;
|
|
280
|
+
idIssueCounty?: string | undefined;
|
|
281
|
+
idIssueDate?: string | undefined;
|
|
282
|
+
idExpireDate?: string | undefined;
|
|
283
|
+
} | undefined;
|
|
191
284
|
accountPolicies?: {
|
|
192
285
|
acceptProfilingPolicies?: 0 | 1 | undefined;
|
|
193
286
|
acceptPrivacyPolicies?: 0 | 1 | undefined;
|
|
@@ -212,7 +305,7 @@ declare const MasterRecordDetailResponseSchema: v.SchemaWithPipe<readonly [v.Sch
|
|
|
212
305
|
InsertCriteria?: "S" | "N" | "T" | "M" | undefined;
|
|
213
306
|
CreatedDate?: string | undefined;
|
|
214
307
|
RecordType?: "CUSTOMER" | "SUPPLIER" | "GENERAL" | undefined;
|
|
215
|
-
RecordStatus?: "
|
|
308
|
+
RecordStatus?: "ENABLED" | "DISABLED" | "WARNING" | "BLACKLISTED" | undefined;
|
|
216
309
|
Moniker?: string | undefined;
|
|
217
310
|
Name?: string | undefined;
|
|
218
311
|
ExtraInfo?: string | undefined;
|
|
@@ -232,6 +325,15 @@ declare const MasterRecordDetailResponseSchema: v.SchemaWithPipe<readonly [v.Sch
|
|
|
232
325
|
BirthCounty?: string | undefined;
|
|
233
326
|
FiscalCode?: string | undefined;
|
|
234
327
|
VatCode?: string | undefined;
|
|
328
|
+
ThirdPartRecordCode?: string | undefined;
|
|
329
|
+
IdDocumentDetail?: {
|
|
330
|
+
IdType?: string | undefined;
|
|
331
|
+
IdCode?: string | undefined;
|
|
332
|
+
IdIssueLocation?: string | undefined;
|
|
333
|
+
IdIssueCounty?: string | undefined;
|
|
334
|
+
IdIssueDate?: string | undefined;
|
|
335
|
+
IdExpireDate?: string | undefined;
|
|
336
|
+
} | undefined;
|
|
235
337
|
AccountPolicies?: {
|
|
236
338
|
AcceptProfilingPolicies?: 0 | 1 | undefined;
|
|
237
339
|
AcceptPrivacyPolicies?: 0 | 1 | undefined;
|
|
@@ -256,7 +358,7 @@ declare const MasterRecordDetailResponseSchema: v.SchemaWithPipe<readonly [v.Sch
|
|
|
256
358
|
InsertCriteria?: "S" | "N" | "T" | "M" | undefined;
|
|
257
359
|
CreatedDate?: string | undefined;
|
|
258
360
|
RecordType?: "CUSTOMER" | "SUPPLIER" | "GENERAL" | undefined;
|
|
259
|
-
RecordStatus?: "
|
|
361
|
+
RecordStatus?: "ENABLED" | "DISABLED" | "WARNING" | "BLACKLISTED" | undefined;
|
|
260
362
|
Moniker?: string | undefined;
|
|
261
363
|
Name?: string | undefined;
|
|
262
364
|
ExtraInfo?: string | undefined;
|
|
@@ -276,6 +378,15 @@ declare const MasterRecordDetailResponseSchema: v.SchemaWithPipe<readonly [v.Sch
|
|
|
276
378
|
BirthCounty?: string | undefined;
|
|
277
379
|
FiscalCode?: string | undefined;
|
|
278
380
|
VatCode?: string | undefined;
|
|
381
|
+
ThirdPartRecordCode?: string | undefined;
|
|
382
|
+
IdDocumentDetail?: {
|
|
383
|
+
IdType?: string | undefined;
|
|
384
|
+
IdCode?: string | undefined;
|
|
385
|
+
IdIssueLocation?: string | undefined;
|
|
386
|
+
IdIssueCounty?: string | undefined;
|
|
387
|
+
IdIssueDate?: string | undefined;
|
|
388
|
+
IdExpireDate?: string | undefined;
|
|
389
|
+
} | undefined;
|
|
279
390
|
AccountPolicies?: {
|
|
280
391
|
AcceptProfilingPolicies?: 0 | 1 | undefined;
|
|
281
392
|
AcceptPrivacyPolicies?: 0 | 1 | undefined;
|
|
@@ -300,7 +411,7 @@ declare const MasterRecordDetailResponseSchema: v.SchemaWithPipe<readonly [v.Sch
|
|
|
300
411
|
insertCriteria?: "S" | "N" | "T" | "M" | undefined;
|
|
301
412
|
createdDate?: string | undefined;
|
|
302
413
|
recordType?: "CUSTOMER" | "SUPPLIER" | "GENERAL" | undefined;
|
|
303
|
-
recordStatus?: "
|
|
414
|
+
recordStatus?: "ENABLED" | "DISABLED" | "WARNING" | "BLACKLISTED" | undefined;
|
|
304
415
|
moniker?: string | undefined;
|
|
305
416
|
name?: string | undefined;
|
|
306
417
|
extraInfo?: string | undefined;
|
|
@@ -320,6 +431,15 @@ declare const MasterRecordDetailResponseSchema: v.SchemaWithPipe<readonly [v.Sch
|
|
|
320
431
|
birthCounty?: string | undefined;
|
|
321
432
|
fiscalCode?: string | undefined;
|
|
322
433
|
vatCode?: string | undefined;
|
|
434
|
+
thirdPartRecordCode?: string | undefined;
|
|
435
|
+
idDocumentDetail?: {
|
|
436
|
+
idType?: string | undefined;
|
|
437
|
+
idCode?: string | undefined;
|
|
438
|
+
idIssueLocation?: string | undefined;
|
|
439
|
+
idIssueCounty?: string | undefined;
|
|
440
|
+
idIssueDate?: string | undefined;
|
|
441
|
+
idExpireDate?: string | undefined;
|
|
442
|
+
} | undefined;
|
|
323
443
|
accountPolicies?: {
|
|
324
444
|
acceptProfilingPolicies?: 0 | 1 | undefined;
|
|
325
445
|
acceptPrivacyPolicies?: 0 | 1 | undefined;
|
|
@@ -394,25 +514,25 @@ declare const SearchMasterRecordSchema: v.UnionSchema<[v.ObjectSchema<{
|
|
|
394
514
|
*/
|
|
395
515
|
declare const SearchMasterRecordResponseSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
396
516
|
readonly RsStatus: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
397
|
-
readonly
|
|
517
|
+
readonly "@Status": v.UnionSchema<[v.LiteralSchema<"OK", undefined>, v.LiteralSchema<"ERROR", undefined>, v.LiteralSchema<"WARNING", undefined>, v.LiteralSchema<"TIMEOUT", undefined>], undefined>;
|
|
398
518
|
readonly ErrorCode: v.OptionalSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<string | number, number>]>, undefined>;
|
|
399
519
|
readonly ErrorDescription: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
400
520
|
readonly Warnings: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TransformAction<string, string[]>]>, undefined>;
|
|
401
521
|
}, undefined>, v.TransformAction<{
|
|
402
|
-
|
|
522
|
+
"@Status": "WARNING" | "OK" | "ERROR" | "TIMEOUT";
|
|
403
523
|
ErrorCode?: number | undefined;
|
|
404
524
|
ErrorDescription?: string | undefined;
|
|
405
525
|
Warnings?: string[] | undefined;
|
|
406
526
|
}, {
|
|
407
|
-
status: "
|
|
527
|
+
status: "WARNING" | "OK" | "ERROR" | "TIMEOUT";
|
|
408
528
|
errorCode: number | undefined;
|
|
409
529
|
errorDescription: string | undefined;
|
|
410
530
|
warnings: string[] | undefined;
|
|
411
531
|
}>]>;
|
|
412
532
|
readonly MasterRecordList: v.OptionalSchema<v.ObjectSchema<{
|
|
413
533
|
readonly MasterRecordDetail: v.OptionalSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.ArraySchema<v.ObjectSchema<{
|
|
414
|
-
readonly
|
|
415
|
-
readonly
|
|
534
|
+
readonly "@RecordCode": v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 6, undefined>, v.MaxLengthAction<string, 6, undefined>]>, undefined>;
|
|
535
|
+
readonly "@InsertCriteria": v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<"S", undefined>, v.LiteralSchema<"N", undefined>, v.LiteralSchema<"T", undefined>, v.LiteralSchema<"M", undefined>], undefined>, undefined>;
|
|
416
536
|
readonly CreatedDate: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
417
537
|
readonly ModifiedDate: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
418
538
|
readonly RecordType: v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<"CUSTOMER", undefined>, v.LiteralSchema<"SUPPLIER", undefined>, v.LiteralSchema<"GENERAL", undefined>], undefined>, undefined>;
|
|
@@ -439,6 +559,15 @@ declare const SearchMasterRecordResponseSchema: v.SchemaWithPipe<readonly [v.Obj
|
|
|
439
559
|
readonly EncryptedPassword: v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<"true", undefined>, v.LiteralSchema<"false", undefined>, v.BooleanSchema<undefined>], undefined>, undefined>;
|
|
440
560
|
readonly FiscalCode: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
441
561
|
readonly VatCode: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
562
|
+
readonly ThirdPartRecordCode: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
563
|
+
readonly IdDocumentDetail: v.OptionalSchema<v.ObjectSchema<{
|
|
564
|
+
readonly idType: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
565
|
+
readonly idCode: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
566
|
+
readonly idIssueLocation: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
567
|
+
readonly idIssueCounty: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
568
|
+
readonly idIssueDate: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
569
|
+
readonly idExpireDate: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
570
|
+
}, undefined>, undefined>;
|
|
442
571
|
readonly NewsletterDisabled: v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<"true", undefined>, v.LiteralSchema<"false", undefined>, v.BooleanSchema<undefined>], undefined>, undefined>;
|
|
443
572
|
readonly SupplierRefMasterRecords: v.OptionalSchema<v.AnySchema, undefined>;
|
|
444
573
|
readonly AccountPolicies: v.OptionalSchema<v.ObjectSchema<{
|
|
@@ -456,13 +585,13 @@ declare const SearchMasterRecordResponseSchema: v.SchemaWithPipe<readonly [v.Obj
|
|
|
456
585
|
readonly enableElectronicInvoicing: v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<"true", undefined>, v.LiteralSchema<"false", undefined>, v.BooleanSchema<undefined>], undefined>, undefined>;
|
|
457
586
|
readonly electronicInvoicingType: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
458
587
|
}, undefined>, undefined>;
|
|
459
|
-
readonly DynamicFields: v.OptionalSchema<v.
|
|
588
|
+
readonly DynamicFields: v.OptionalSchema<v.ObjectSchema<{
|
|
460
589
|
readonly key: v.StringSchema<undefined>;
|
|
461
590
|
readonly value: v.StringSchema<undefined>;
|
|
462
|
-
}, undefined>, undefined
|
|
591
|
+
}, undefined>, undefined>;
|
|
463
592
|
}, undefined>, undefined>, v.ObjectSchema<{
|
|
464
|
-
readonly
|
|
465
|
-
readonly
|
|
593
|
+
readonly "@RecordCode": v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 6, undefined>, v.MaxLengthAction<string, 6, undefined>]>, undefined>;
|
|
594
|
+
readonly "@InsertCriteria": v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<"S", undefined>, v.LiteralSchema<"N", undefined>, v.LiteralSchema<"T", undefined>, v.LiteralSchema<"M", undefined>], undefined>, undefined>;
|
|
466
595
|
readonly CreatedDate: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
467
596
|
readonly ModifiedDate: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
468
597
|
readonly RecordType: v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<"CUSTOMER", undefined>, v.LiteralSchema<"SUPPLIER", undefined>, v.LiteralSchema<"GENERAL", undefined>], undefined>, undefined>;
|
|
@@ -489,6 +618,15 @@ declare const SearchMasterRecordResponseSchema: v.SchemaWithPipe<readonly [v.Obj
|
|
|
489
618
|
readonly EncryptedPassword: v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<"true", undefined>, v.LiteralSchema<"false", undefined>, v.BooleanSchema<undefined>], undefined>, undefined>;
|
|
490
619
|
readonly FiscalCode: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
491
620
|
readonly VatCode: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
621
|
+
readonly ThirdPartRecordCode: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
622
|
+
readonly IdDocumentDetail: v.OptionalSchema<v.ObjectSchema<{
|
|
623
|
+
readonly idType: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
624
|
+
readonly idCode: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
625
|
+
readonly idIssueLocation: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
626
|
+
readonly idIssueCounty: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
627
|
+
readonly idIssueDate: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
628
|
+
readonly idExpireDate: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
629
|
+
}, undefined>, undefined>;
|
|
492
630
|
readonly NewsletterDisabled: v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<"true", undefined>, v.LiteralSchema<"false", undefined>, v.BooleanSchema<undefined>], undefined>, undefined>;
|
|
493
631
|
readonly SupplierRefMasterRecords: v.OptionalSchema<v.AnySchema, undefined>;
|
|
494
632
|
readonly AccountPolicies: v.OptionalSchema<v.ObjectSchema<{
|
|
@@ -506,18 +644,18 @@ declare const SearchMasterRecordResponseSchema: v.SchemaWithPipe<readonly [v.Obj
|
|
|
506
644
|
readonly enableElectronicInvoicing: v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<"true", undefined>, v.LiteralSchema<"false", undefined>, v.BooleanSchema<undefined>], undefined>, undefined>;
|
|
507
645
|
readonly electronicInvoicingType: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
508
646
|
}, undefined>, undefined>;
|
|
509
|
-
readonly DynamicFields: v.OptionalSchema<v.
|
|
647
|
+
readonly DynamicFields: v.OptionalSchema<v.ObjectSchema<{
|
|
510
648
|
readonly key: v.StringSchema<undefined>;
|
|
511
649
|
readonly value: v.StringSchema<undefined>;
|
|
512
|
-
}, undefined>, undefined
|
|
650
|
+
}, undefined>, undefined>;
|
|
513
651
|
}, undefined>], undefined>, v.TransformAction<{
|
|
514
|
-
|
|
515
|
-
|
|
652
|
+
"@RecordCode"?: string | undefined;
|
|
653
|
+
"@InsertCriteria"?: "S" | "N" | "T" | "M" | undefined;
|
|
516
654
|
CreatedDate?: string | undefined;
|
|
517
655
|
ModifiedDate?: string | undefined;
|
|
518
656
|
RecordType?: "CUSTOMER" | "SUPPLIER" | "GENERAL" | undefined;
|
|
519
657
|
LoginType?: string | undefined;
|
|
520
|
-
RecordStatus?: "
|
|
658
|
+
RecordStatus?: "ENABLED" | "DISABLED" | "WARNING" | "BLACKLISTED" | undefined;
|
|
521
659
|
Moniker?: string | undefined;
|
|
522
660
|
Name?: string | undefined;
|
|
523
661
|
ExtraInfo?: string | undefined;
|
|
@@ -539,6 +677,15 @@ declare const SearchMasterRecordResponseSchema: v.SchemaWithPipe<readonly [v.Obj
|
|
|
539
677
|
EncryptedPassword?: boolean | "true" | "false" | undefined;
|
|
540
678
|
FiscalCode?: string | undefined;
|
|
541
679
|
VatCode?: string | undefined;
|
|
680
|
+
ThirdPartRecordCode?: string | undefined;
|
|
681
|
+
IdDocumentDetail?: {
|
|
682
|
+
idType?: string | undefined;
|
|
683
|
+
idCode?: string | undefined;
|
|
684
|
+
idIssueLocation?: string | undefined;
|
|
685
|
+
idIssueCounty?: string | undefined;
|
|
686
|
+
idIssueDate?: string | undefined;
|
|
687
|
+
idExpireDate?: string | undefined;
|
|
688
|
+
} | undefined;
|
|
542
689
|
NewsletterDisabled?: boolean | "true" | "false" | undefined;
|
|
543
690
|
SupplierRefMasterRecords?: any;
|
|
544
691
|
AccountPolicies?: {
|
|
@@ -559,15 +706,15 @@ declare const SearchMasterRecordResponseSchema: v.SchemaWithPipe<readonly [v.Obj
|
|
|
559
706
|
DynamicFields?: {
|
|
560
707
|
key: string;
|
|
561
708
|
value: string;
|
|
562
|
-
}
|
|
709
|
+
} | undefined;
|
|
563
710
|
} | {
|
|
564
|
-
|
|
565
|
-
|
|
711
|
+
"@RecordCode"?: string | undefined;
|
|
712
|
+
"@InsertCriteria"?: "S" | "N" | "T" | "M" | undefined;
|
|
566
713
|
CreatedDate?: string | undefined;
|
|
567
714
|
ModifiedDate?: string | undefined;
|
|
568
715
|
RecordType?: "CUSTOMER" | "SUPPLIER" | "GENERAL" | undefined;
|
|
569
716
|
LoginType?: string | undefined;
|
|
570
|
-
RecordStatus?: "
|
|
717
|
+
RecordStatus?: "ENABLED" | "DISABLED" | "WARNING" | "BLACKLISTED" | undefined;
|
|
571
718
|
Moniker?: string | undefined;
|
|
572
719
|
Name?: string | undefined;
|
|
573
720
|
ExtraInfo?: string | undefined;
|
|
@@ -589,6 +736,15 @@ declare const SearchMasterRecordResponseSchema: v.SchemaWithPipe<readonly [v.Obj
|
|
|
589
736
|
EncryptedPassword?: boolean | "true" | "false" | undefined;
|
|
590
737
|
FiscalCode?: string | undefined;
|
|
591
738
|
VatCode?: string | undefined;
|
|
739
|
+
ThirdPartRecordCode?: string | undefined;
|
|
740
|
+
IdDocumentDetail?: {
|
|
741
|
+
idType?: string | undefined;
|
|
742
|
+
idCode?: string | undefined;
|
|
743
|
+
idIssueLocation?: string | undefined;
|
|
744
|
+
idIssueCounty?: string | undefined;
|
|
745
|
+
idIssueDate?: string | undefined;
|
|
746
|
+
idExpireDate?: string | undefined;
|
|
747
|
+
} | undefined;
|
|
592
748
|
NewsletterDisabled?: boolean | "true" | "false" | undefined;
|
|
593
749
|
SupplierRefMasterRecords?: any;
|
|
594
750
|
AccountPolicies?: {
|
|
@@ -609,15 +765,15 @@ declare const SearchMasterRecordResponseSchema: v.SchemaWithPipe<readonly [v.Obj
|
|
|
609
765
|
DynamicFields?: {
|
|
610
766
|
key: string;
|
|
611
767
|
value: string;
|
|
612
|
-
}
|
|
768
|
+
} | undefined;
|
|
613
769
|
}[], {
|
|
614
|
-
|
|
615
|
-
|
|
770
|
+
"@RecordCode"?: string | undefined;
|
|
771
|
+
"@InsertCriteria"?: "S" | "N" | "T" | "M" | undefined;
|
|
616
772
|
CreatedDate?: string | undefined;
|
|
617
773
|
ModifiedDate?: string | undefined;
|
|
618
774
|
RecordType?: "CUSTOMER" | "SUPPLIER" | "GENERAL" | undefined;
|
|
619
775
|
LoginType?: string | undefined;
|
|
620
|
-
RecordStatus?: "
|
|
776
|
+
RecordStatus?: "ENABLED" | "DISABLED" | "WARNING" | "BLACKLISTED" | undefined;
|
|
621
777
|
Moniker?: string | undefined;
|
|
622
778
|
Name?: string | undefined;
|
|
623
779
|
ExtraInfo?: string | undefined;
|
|
@@ -639,6 +795,15 @@ declare const SearchMasterRecordResponseSchema: v.SchemaWithPipe<readonly [v.Obj
|
|
|
639
795
|
EncryptedPassword?: boolean | "true" | "false" | undefined;
|
|
640
796
|
FiscalCode?: string | undefined;
|
|
641
797
|
VatCode?: string | undefined;
|
|
798
|
+
ThirdPartRecordCode?: string | undefined;
|
|
799
|
+
IdDocumentDetail?: {
|
|
800
|
+
idType?: string | undefined;
|
|
801
|
+
idCode?: string | undefined;
|
|
802
|
+
idIssueLocation?: string | undefined;
|
|
803
|
+
idIssueCounty?: string | undefined;
|
|
804
|
+
idIssueDate?: string | undefined;
|
|
805
|
+
idExpireDate?: string | undefined;
|
|
806
|
+
} | undefined;
|
|
642
807
|
NewsletterDisabled?: boolean | "true" | "false" | undefined;
|
|
643
808
|
SupplierRefMasterRecords?: any;
|
|
644
809
|
AccountPolicies?: {
|
|
@@ -659,25 +824,25 @@ declare const SearchMasterRecordResponseSchema: v.SchemaWithPipe<readonly [v.Obj
|
|
|
659
824
|
DynamicFields?: {
|
|
660
825
|
key: string;
|
|
661
826
|
value: string;
|
|
662
|
-
}
|
|
827
|
+
} | undefined;
|
|
663
828
|
}[] | undefined>]>, undefined>;
|
|
664
829
|
}, undefined>, undefined>;
|
|
665
830
|
}, undefined>, v.TransformAction<{
|
|
666
831
|
RsStatus: {
|
|
667
|
-
status: "
|
|
832
|
+
status: "WARNING" | "OK" | "ERROR" | "TIMEOUT";
|
|
668
833
|
errorCode: number | undefined;
|
|
669
834
|
errorDescription: string | undefined;
|
|
670
835
|
warnings: string[] | undefined;
|
|
671
836
|
};
|
|
672
837
|
MasterRecordList?: {
|
|
673
838
|
MasterRecordDetail?: {
|
|
674
|
-
|
|
675
|
-
|
|
839
|
+
"@RecordCode"?: string | undefined;
|
|
840
|
+
"@InsertCriteria"?: "S" | "N" | "T" | "M" | undefined;
|
|
676
841
|
CreatedDate?: string | undefined;
|
|
677
842
|
ModifiedDate?: string | undefined;
|
|
678
843
|
RecordType?: "CUSTOMER" | "SUPPLIER" | "GENERAL" | undefined;
|
|
679
844
|
LoginType?: string | undefined;
|
|
680
|
-
RecordStatus?: "
|
|
845
|
+
RecordStatus?: "ENABLED" | "DISABLED" | "WARNING" | "BLACKLISTED" | undefined;
|
|
681
846
|
Moniker?: string | undefined;
|
|
682
847
|
Name?: string | undefined;
|
|
683
848
|
ExtraInfo?: string | undefined;
|
|
@@ -699,6 +864,15 @@ declare const SearchMasterRecordResponseSchema: v.SchemaWithPipe<readonly [v.Obj
|
|
|
699
864
|
EncryptedPassword?: boolean | "true" | "false" | undefined;
|
|
700
865
|
FiscalCode?: string | undefined;
|
|
701
866
|
VatCode?: string | undefined;
|
|
867
|
+
ThirdPartRecordCode?: string | undefined;
|
|
868
|
+
IdDocumentDetail?: {
|
|
869
|
+
idType?: string | undefined;
|
|
870
|
+
idCode?: string | undefined;
|
|
871
|
+
idIssueLocation?: string | undefined;
|
|
872
|
+
idIssueCounty?: string | undefined;
|
|
873
|
+
idIssueDate?: string | undefined;
|
|
874
|
+
idExpireDate?: string | undefined;
|
|
875
|
+
} | undefined;
|
|
702
876
|
NewsletterDisabled?: boolean | "true" | "false" | undefined;
|
|
703
877
|
SupplierRefMasterRecords?: any;
|
|
704
878
|
AccountPolicies?: {
|
|
@@ -719,12 +893,12 @@ declare const SearchMasterRecordResponseSchema: v.SchemaWithPipe<readonly [v.Obj
|
|
|
719
893
|
DynamicFields?: {
|
|
720
894
|
key: string;
|
|
721
895
|
value: string;
|
|
722
|
-
}
|
|
896
|
+
} | undefined;
|
|
723
897
|
}[] | undefined;
|
|
724
898
|
} | undefined;
|
|
725
899
|
}, {
|
|
726
900
|
rsStatus: {
|
|
727
|
-
status: "
|
|
901
|
+
status: "WARNING" | "OK" | "ERROR" | "TIMEOUT";
|
|
728
902
|
errorCode: number | undefined;
|
|
729
903
|
errorDescription: string | undefined;
|
|
730
904
|
warnings: string[] | undefined;
|
|
@@ -737,7 +911,7 @@ declare const SearchMasterRecordResponseSchema: v.SchemaWithPipe<readonly [v.Obj
|
|
|
737
911
|
modifiedDate?: string | undefined;
|
|
738
912
|
recordType?: "CUSTOMER" | "SUPPLIER" | "GENERAL" | undefined;
|
|
739
913
|
loginType?: string | undefined;
|
|
740
|
-
recordStatus?: "
|
|
914
|
+
recordStatus?: "ENABLED" | "DISABLED" | "WARNING" | "BLACKLISTED" | undefined;
|
|
741
915
|
moniker?: string | undefined;
|
|
742
916
|
name?: string | undefined;
|
|
743
917
|
extraInfo?: string | undefined;
|
|
@@ -759,6 +933,15 @@ declare const SearchMasterRecordResponseSchema: v.SchemaWithPipe<readonly [v.Obj
|
|
|
759
933
|
encryptedPassword?: boolean | "true" | "false" | undefined;
|
|
760
934
|
fiscalCode?: string | undefined;
|
|
761
935
|
vatCode?: string | undefined;
|
|
936
|
+
thirdPartRecordCode?: string | undefined;
|
|
937
|
+
idDocumentDetail?: {
|
|
938
|
+
idType?: string | undefined;
|
|
939
|
+
idCode?: string | undefined;
|
|
940
|
+
idIssueLocation?: string | undefined;
|
|
941
|
+
idIssueCounty?: string | undefined;
|
|
942
|
+
idIssueDate?: string | undefined;
|
|
943
|
+
idExpireDate?: string | undefined;
|
|
944
|
+
} | undefined;
|
|
762
945
|
newsletterDisabled?: boolean | "true" | "false" | undefined;
|
|
763
946
|
supplierRefMasterRecords?: any;
|
|
764
947
|
accountPolicies?: {
|
|
@@ -779,7 +962,7 @@ declare const SearchMasterRecordResponseSchema: v.SchemaWithPipe<readonly [v.Obj
|
|
|
779
962
|
dynamicFields?: {
|
|
780
963
|
key: string;
|
|
781
964
|
value: string;
|
|
782
|
-
}
|
|
965
|
+
} | undefined;
|
|
783
966
|
}[] | undefined;
|
|
784
967
|
} | undefined;
|
|
785
968
|
}>]>;
|
|
@@ -789,15 +972,15 @@ declare const SearchMasterRecordResponseSchema: v.SchemaWithPipe<readonly [v.Obj
|
|
|
789
972
|
*/
|
|
790
973
|
declare const ManageMasterRecordRequestSchema: v.ObjectSchema<{
|
|
791
974
|
readonly RqHeader: v.ObjectSchema<{
|
|
792
|
-
readonly
|
|
793
|
-
readonly
|
|
794
|
-
readonly
|
|
795
|
-
readonly
|
|
796
|
-
readonly
|
|
975
|
+
readonly "@HostID": v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 6, undefined>, v.MaxLengthAction<string, 6, undefined>]>;
|
|
976
|
+
readonly "@Xtoken": v.StringSchema<undefined>;
|
|
977
|
+
readonly "@Interface": v.LiteralSchema<"WEB", undefined>;
|
|
978
|
+
readonly "@UserName": v.LiteralSchema<"WEB", undefined>;
|
|
979
|
+
readonly "@LanguageCode": v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 2, undefined>, v.MaxLengthAction<string, 2, undefined>]>, undefined>;
|
|
797
980
|
}, undefined>;
|
|
798
981
|
readonly MasterRecordDetail: v.ObjectSchema<{
|
|
799
|
-
readonly
|
|
800
|
-
readonly
|
|
982
|
+
readonly "@RecordCode": v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 6, undefined>, v.MaxLengthAction<string, 6, undefined>]>, undefined>;
|
|
983
|
+
readonly "@InsertCriteria": v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<"S", undefined>, v.LiteralSchema<"N", undefined>, v.LiteralSchema<"T", undefined>, v.LiteralSchema<"M", undefined>], undefined>, undefined>;
|
|
801
984
|
readonly CreatedDate: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
802
985
|
readonly ModifiedDate: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
803
986
|
readonly RecordType: v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<"CUSTOMER", undefined>, v.LiteralSchema<"SUPPLIER", undefined>, v.LiteralSchema<"GENERAL", undefined>], undefined>, undefined>;
|
|
@@ -824,6 +1007,15 @@ declare const ManageMasterRecordRequestSchema: v.ObjectSchema<{
|
|
|
824
1007
|
readonly EncryptedPassword: v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<"true", undefined>, v.LiteralSchema<"false", undefined>, v.BooleanSchema<undefined>], undefined>, undefined>;
|
|
825
1008
|
readonly FiscalCode: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
826
1009
|
readonly VatCode: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
1010
|
+
readonly ThirdPartRecordCode: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
1011
|
+
readonly IdDocumentDetail: v.OptionalSchema<v.ObjectSchema<{
|
|
1012
|
+
readonly idType: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
1013
|
+
readonly idCode: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
1014
|
+
readonly idIssueLocation: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
1015
|
+
readonly idIssueCounty: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
1016
|
+
readonly idIssueDate: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
1017
|
+
readonly idExpireDate: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
1018
|
+
}, undefined>, undefined>;
|
|
827
1019
|
readonly NewsletterDisabled: v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<"true", undefined>, v.LiteralSchema<"false", undefined>, v.BooleanSchema<undefined>], undefined>, undefined>;
|
|
828
1020
|
readonly SupplierRefMasterRecords: v.OptionalSchema<v.AnySchema, undefined>;
|
|
829
1021
|
readonly AccountPolicies: v.OptionalSchema<v.ObjectSchema<{
|
|
@@ -841,10 +1033,10 @@ declare const ManageMasterRecordRequestSchema: v.ObjectSchema<{
|
|
|
841
1033
|
readonly enableElectronicInvoicing: v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<"true", undefined>, v.LiteralSchema<"false", undefined>, v.BooleanSchema<undefined>], undefined>, undefined>;
|
|
842
1034
|
readonly electronicInvoicingType: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
843
1035
|
}, undefined>, undefined>;
|
|
844
|
-
readonly DynamicFields: v.OptionalSchema<v.
|
|
1036
|
+
readonly DynamicFields: v.OptionalSchema<v.ObjectSchema<{
|
|
845
1037
|
readonly key: v.StringSchema<undefined>;
|
|
846
1038
|
readonly value: v.StringSchema<undefined>;
|
|
847
|
-
}, undefined>, undefined
|
|
1039
|
+
}, undefined>, undefined>;
|
|
848
1040
|
}, undefined>;
|
|
849
1041
|
}, undefined>;
|
|
850
1042
|
/**
|
|
@@ -852,24 +1044,24 @@ declare const ManageMasterRecordRequestSchema: v.ObjectSchema<{
|
|
|
852
1044
|
*/
|
|
853
1045
|
declare const ManageMasterRecordResponseSchema: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
854
1046
|
readonly RsStatus: v.SchemaWithPipe<readonly [v.ObjectSchema<{
|
|
855
|
-
readonly
|
|
1047
|
+
readonly "@Status": v.UnionSchema<[v.LiteralSchema<"OK", undefined>, v.LiteralSchema<"ERROR", undefined>, v.LiteralSchema<"WARNING", undefined>, v.LiteralSchema<"TIMEOUT", undefined>], undefined>;
|
|
856
1048
|
readonly ErrorCode: v.OptionalSchema<v.SchemaWithPipe<readonly [v.UnionSchema<[v.StringSchema<undefined>, v.NumberSchema<undefined>], undefined>, v.TransformAction<string | number, number>]>, undefined>;
|
|
857
1049
|
readonly ErrorDescription: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
858
1050
|
readonly Warnings: v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.TransformAction<string, string[]>]>, undefined>;
|
|
859
1051
|
}, undefined>, v.TransformAction<{
|
|
860
|
-
|
|
1052
|
+
"@Status": "WARNING" | "OK" | "ERROR" | "TIMEOUT";
|
|
861
1053
|
ErrorCode?: number | undefined;
|
|
862
1054
|
ErrorDescription?: string | undefined;
|
|
863
1055
|
Warnings?: string[] | undefined;
|
|
864
1056
|
}, {
|
|
865
|
-
status: "
|
|
1057
|
+
status: "WARNING" | "OK" | "ERROR" | "TIMEOUT";
|
|
866
1058
|
errorCode: number | undefined;
|
|
867
1059
|
errorDescription: string | undefined;
|
|
868
1060
|
warnings: string[] | undefined;
|
|
869
1061
|
}>]>;
|
|
870
1062
|
readonly MasterRecordDetail: v.OptionalSchema<v.ObjectSchema<{
|
|
871
|
-
readonly
|
|
872
|
-
readonly
|
|
1063
|
+
readonly "@RecordCode": v.OptionalSchema<v.SchemaWithPipe<readonly [v.StringSchema<undefined>, v.MinLengthAction<string, 6, undefined>, v.MaxLengthAction<string, 6, undefined>]>, undefined>;
|
|
1064
|
+
readonly "@InsertCriteria": v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<"S", undefined>, v.LiteralSchema<"N", undefined>, v.LiteralSchema<"T", undefined>, v.LiteralSchema<"M", undefined>], undefined>, undefined>;
|
|
873
1065
|
readonly CreatedDate: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
874
1066
|
readonly ModifiedDate: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
875
1067
|
readonly RecordType: v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<"CUSTOMER", undefined>, v.LiteralSchema<"SUPPLIER", undefined>, v.LiteralSchema<"GENERAL", undefined>], undefined>, undefined>;
|
|
@@ -896,6 +1088,15 @@ declare const ManageMasterRecordResponseSchema: v.SchemaWithPipe<readonly [v.Obj
|
|
|
896
1088
|
readonly EncryptedPassword: v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<"true", undefined>, v.LiteralSchema<"false", undefined>, v.BooleanSchema<undefined>], undefined>, undefined>;
|
|
897
1089
|
readonly FiscalCode: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
898
1090
|
readonly VatCode: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
1091
|
+
readonly ThirdPartRecordCode: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
1092
|
+
readonly IdDocumentDetail: v.OptionalSchema<v.ObjectSchema<{
|
|
1093
|
+
readonly idType: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
1094
|
+
readonly idCode: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
1095
|
+
readonly idIssueLocation: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
1096
|
+
readonly idIssueCounty: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
1097
|
+
readonly idIssueDate: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
1098
|
+
readonly idExpireDate: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
1099
|
+
}, undefined>, undefined>;
|
|
899
1100
|
readonly NewsletterDisabled: v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<"true", undefined>, v.LiteralSchema<"false", undefined>, v.BooleanSchema<undefined>], undefined>, undefined>;
|
|
900
1101
|
readonly SupplierRefMasterRecords: v.OptionalSchema<v.AnySchema, undefined>;
|
|
901
1102
|
readonly AccountPolicies: v.OptionalSchema<v.ObjectSchema<{
|
|
@@ -913,26 +1114,26 @@ declare const ManageMasterRecordResponseSchema: v.SchemaWithPipe<readonly [v.Obj
|
|
|
913
1114
|
readonly enableElectronicInvoicing: v.OptionalSchema<v.UnionSchema<[v.LiteralSchema<"true", undefined>, v.LiteralSchema<"false", undefined>, v.BooleanSchema<undefined>], undefined>, undefined>;
|
|
914
1115
|
readonly electronicInvoicingType: v.OptionalSchema<v.StringSchema<undefined>, undefined>;
|
|
915
1116
|
}, undefined>, undefined>;
|
|
916
|
-
readonly DynamicFields: v.OptionalSchema<v.
|
|
1117
|
+
readonly DynamicFields: v.OptionalSchema<v.ObjectSchema<{
|
|
917
1118
|
readonly key: v.StringSchema<undefined>;
|
|
918
1119
|
readonly value: v.StringSchema<undefined>;
|
|
919
|
-
}, undefined>, undefined
|
|
1120
|
+
}, undefined>, undefined>;
|
|
920
1121
|
}, undefined>, undefined>;
|
|
921
1122
|
}, undefined>, v.TransformAction<{
|
|
922
1123
|
RsStatus: {
|
|
923
|
-
status: "
|
|
1124
|
+
status: "WARNING" | "OK" | "ERROR" | "TIMEOUT";
|
|
924
1125
|
errorCode: number | undefined;
|
|
925
1126
|
errorDescription: string | undefined;
|
|
926
1127
|
warnings: string[] | undefined;
|
|
927
1128
|
};
|
|
928
1129
|
MasterRecordDetail?: {
|
|
929
|
-
|
|
930
|
-
|
|
1130
|
+
"@RecordCode"?: string | undefined;
|
|
1131
|
+
"@InsertCriteria"?: "S" | "N" | "T" | "M" | undefined;
|
|
931
1132
|
CreatedDate?: string | undefined;
|
|
932
1133
|
ModifiedDate?: string | undefined;
|
|
933
1134
|
RecordType?: "CUSTOMER" | "SUPPLIER" | "GENERAL" | undefined;
|
|
934
1135
|
LoginType?: string | undefined;
|
|
935
|
-
RecordStatus?: "
|
|
1136
|
+
RecordStatus?: "ENABLED" | "DISABLED" | "WARNING" | "BLACKLISTED" | undefined;
|
|
936
1137
|
Moniker?: string | undefined;
|
|
937
1138
|
Name?: string | undefined;
|
|
938
1139
|
ExtraInfo?: string | undefined;
|
|
@@ -954,6 +1155,15 @@ declare const ManageMasterRecordResponseSchema: v.SchemaWithPipe<readonly [v.Obj
|
|
|
954
1155
|
EncryptedPassword?: boolean | "true" | "false" | undefined;
|
|
955
1156
|
FiscalCode?: string | undefined;
|
|
956
1157
|
VatCode?: string | undefined;
|
|
1158
|
+
ThirdPartRecordCode?: string | undefined;
|
|
1159
|
+
IdDocumentDetail?: {
|
|
1160
|
+
idType?: string | undefined;
|
|
1161
|
+
idCode?: string | undefined;
|
|
1162
|
+
idIssueLocation?: string | undefined;
|
|
1163
|
+
idIssueCounty?: string | undefined;
|
|
1164
|
+
idIssueDate?: string | undefined;
|
|
1165
|
+
idExpireDate?: string | undefined;
|
|
1166
|
+
} | undefined;
|
|
957
1167
|
NewsletterDisabled?: boolean | "true" | "false" | undefined;
|
|
958
1168
|
SupplierRefMasterRecords?: any;
|
|
959
1169
|
AccountPolicies?: {
|
|
@@ -974,11 +1184,11 @@ declare const ManageMasterRecordResponseSchema: v.SchemaWithPipe<readonly [v.Obj
|
|
|
974
1184
|
DynamicFields?: {
|
|
975
1185
|
key: string;
|
|
976
1186
|
value: string;
|
|
977
|
-
}
|
|
1187
|
+
} | undefined;
|
|
978
1188
|
} | undefined;
|
|
979
1189
|
}, {
|
|
980
1190
|
rsStatus: {
|
|
981
|
-
status: "
|
|
1191
|
+
status: "WARNING" | "OK" | "ERROR" | "TIMEOUT";
|
|
982
1192
|
errorCode: number | undefined;
|
|
983
1193
|
errorDescription: string | undefined;
|
|
984
1194
|
warnings: string[] | undefined;
|
|
@@ -990,7 +1200,7 @@ declare const ManageMasterRecordResponseSchema: v.SchemaWithPipe<readonly [v.Obj
|
|
|
990
1200
|
modifiedDate?: string | undefined;
|
|
991
1201
|
recordType?: "CUSTOMER" | "SUPPLIER" | "GENERAL" | undefined;
|
|
992
1202
|
loginType?: string | undefined;
|
|
993
|
-
recordStatus?: "
|
|
1203
|
+
recordStatus?: "ENABLED" | "DISABLED" | "WARNING" | "BLACKLISTED" | undefined;
|
|
994
1204
|
moniker?: string | undefined;
|
|
995
1205
|
name?: string | undefined;
|
|
996
1206
|
extraInfo?: string | undefined;
|
|
@@ -1012,6 +1222,15 @@ declare const ManageMasterRecordResponseSchema: v.SchemaWithPipe<readonly [v.Obj
|
|
|
1012
1222
|
encryptedPassword?: boolean | "true" | "false" | undefined;
|
|
1013
1223
|
fiscalCode?: string | undefined;
|
|
1014
1224
|
vatCode?: string | undefined;
|
|
1225
|
+
thirdPartRecordCode?: string | undefined;
|
|
1226
|
+
idDocumentDetail?: {
|
|
1227
|
+
idType?: string | undefined;
|
|
1228
|
+
idCode?: string | undefined;
|
|
1229
|
+
idIssueLocation?: string | undefined;
|
|
1230
|
+
idIssueCounty?: string | undefined;
|
|
1231
|
+
idIssueDate?: string | undefined;
|
|
1232
|
+
idExpireDate?: string | undefined;
|
|
1233
|
+
} | undefined;
|
|
1015
1234
|
newsletterDisabled?: boolean | "true" | "false" | undefined;
|
|
1016
1235
|
supplierRefMasterRecords?: any;
|
|
1017
1236
|
accountPolicies?: {
|
|
@@ -1032,36 +1251,276 @@ declare const ManageMasterRecordResponseSchema: v.SchemaWithPipe<readonly [v.Obj
|
|
|
1032
1251
|
dynamicFields?: {
|
|
1033
1252
|
key: string;
|
|
1034
1253
|
value: string;
|
|
1035
|
-
}
|
|
1254
|
+
} | undefined;
|
|
1036
1255
|
} | undefined;
|
|
1037
1256
|
}>]>;
|
|
1038
1257
|
|
|
1258
|
+
type CamelFromDelimiter<S extends string> = S extends `${infer H}_${infer T}` ? `${H}${Capitalize<CamelFromDelimiter<T>>}` : S extends `${infer H}-${infer T}` ? `${H}${Capitalize<CamelFromDelimiter<T>>}` : S;
|
|
1259
|
+
type ToCamelCase<S extends string> = CamelFromDelimiter<S> extends `${infer F}${infer R}` ? `${Lowercase<F>}${R}` : CamelFromDelimiter<S>;
|
|
1260
|
+
type Camelize<T> = T extends readonly (infer U)[] ? Camelize<U>[] : T extends object ? {
|
|
1261
|
+
[K in keyof T as K extends `@${infer Rest}` ? ToCamelCase<Rest> : ToCamelCase<K & string>]: Camelize<T[K]>;
|
|
1262
|
+
} : T;
|
|
1263
|
+
|
|
1039
1264
|
/**
|
|
1040
|
-
*
|
|
1265
|
+
* Request header containing authentication credentials for AVES API calls.
|
|
1266
|
+
*
|
|
1267
|
+
* @property hostID - 6-digit identification code assigned to your organization
|
|
1268
|
+
* @property xtoken - Authentication token for API access
|
|
1269
|
+
* @property interface - Interface type, always 'WEB'
|
|
1270
|
+
* @property userName - Username for the request, always 'WEB'
|
|
1271
|
+
* @property languageCode - Optional 2-character ISO language code (e.g., '02' for Italian)
|
|
1041
1272
|
*/
|
|
1042
1273
|
type RqHeader = InferInput<typeof RqHeaderSchema>;
|
|
1274
|
+
/**
|
|
1275
|
+
* Response status returned by all AVES API operations.
|
|
1276
|
+
*
|
|
1277
|
+
* @property status - Result status: 'OK' (success), 'ERROR' (failure), 'WARNING' (partial success), 'TIMEOUT'
|
|
1278
|
+
* @property errorCode - Numeric error code when status is 'ERROR' (e.g., 1001, 1002)
|
|
1279
|
+
* @property errorDescription - Human-readable error message
|
|
1280
|
+
* @property warnings - Array of warning messages when status is 'WARNING'
|
|
1281
|
+
*
|
|
1282
|
+
* @example
|
|
1283
|
+
* ```typescript
|
|
1284
|
+
* if (response.rsStatus.status === 'OK') {
|
|
1285
|
+
* // Process successful response
|
|
1286
|
+
* } else {
|
|
1287
|
+
* console.error(response.rsStatus.errorDescription);
|
|
1288
|
+
* }
|
|
1289
|
+
* ```
|
|
1290
|
+
*/
|
|
1043
1291
|
type RsStatus = Camelize<InferOutput<typeof RsStatusSchema>>;
|
|
1044
1292
|
/**
|
|
1045
|
-
*
|
|
1293
|
+
* Financial and payment details for a master record.
|
|
1294
|
+
*
|
|
1295
|
+
* @property currencyCode - ISO currency code (e.g., 'EUR', 'USD')
|
|
1296
|
+
* @property creditLimit - Maximum credit amount as a string
|
|
1297
|
+
* @property c_PaymentType - Customer payment type: 'CASH' | 'BANK' | 'RID' | 'RIBA' | 'SPECIFIC_CODE'
|
|
1298
|
+
* @property c_SpecPaymentTypeCode - Specific payment code when c_PaymentType is 'SPECIFIC_CODE'
|
|
1299
|
+
* @property s_PaymentType - Supplier payment type: 'CASH' | 'BANK' | 'RID' | 'RIBA' | 'SPECIFIC_CODE'
|
|
1300
|
+
* @property s_SpecPaymentTypeCode - Specific payment code when s_PaymentType is 'SPECIFIC_CODE'
|
|
1301
|
+
* @property enableElectronicInvoicing - Enable electronic invoicing (accepts boolean or 'true'/'false' string)
|
|
1302
|
+
* @property electronicInvoicingType - Type of electronic invoicing when enabled
|
|
1046
1303
|
*/
|
|
1047
1304
|
type FinancialDetail = InferInput<typeof FinancialDetailSchema>;
|
|
1305
|
+
/**
|
|
1306
|
+
* Identity document details for a master record.
|
|
1307
|
+
*
|
|
1308
|
+
* @property idType - Document type code (e.g., 'PASSPORT', 'ID_CARD')
|
|
1309
|
+
* @property idCode - Document number/identifier
|
|
1310
|
+
* @property idIssueLocation - Location where the document was issued
|
|
1311
|
+
* @property idIssueCounty - County/region code where issued
|
|
1312
|
+
* @property idIssueDate - Issue date in ISO format (YYYY-MM-DD)
|
|
1313
|
+
* @property idExpireDate - Expiration date in ISO format (YYYY-MM-DD)
|
|
1314
|
+
*/
|
|
1315
|
+
type IdDocumentDetail = InferInput<typeof IdDocumentDetailSchema>;
|
|
1316
|
+
/**
|
|
1317
|
+
* Privacy and marketing policy acceptance flags.
|
|
1318
|
+
*
|
|
1319
|
+
* @property acceptProfilingPolicies - User consent for profiling (0 = not accepted, 1 = accepted)
|
|
1320
|
+
* @property acceptPrivacyPolicies - User consent for privacy policy (0 = not accepted, 1 = accepted)
|
|
1321
|
+
* @property acceptNewsletterPolicies - User consent for newsletter (0 = not accepted, 1 = accepted)
|
|
1322
|
+
*/
|
|
1323
|
+
type AccountPolicies = InferInput<typeof AccountPoliciesSchema>;
|
|
1324
|
+
/**
|
|
1325
|
+
* Custom key-value field for extending master record data.
|
|
1326
|
+
*
|
|
1327
|
+
* @property key - Unique identifier for the dynamic field
|
|
1328
|
+
* @property value - Value associated with the key
|
|
1329
|
+
*
|
|
1330
|
+
* @example
|
|
1331
|
+
* ```typescript
|
|
1332
|
+
* const dynamicField: DynamicFields = {
|
|
1333
|
+
* key: 'loyalty_tier',
|
|
1334
|
+
* value: 'gold'
|
|
1335
|
+
* };
|
|
1336
|
+
* ```
|
|
1337
|
+
*/
|
|
1338
|
+
type DynamicFields = InferInput<typeof DynamicFieldsSchema>;
|
|
1339
|
+
/**
|
|
1340
|
+
* Master record detail for creating or updating customer, supplier, or general records.
|
|
1341
|
+
*
|
|
1342
|
+
* This is the primary input type for the `upsertRecord` method.
|
|
1343
|
+
*
|
|
1344
|
+
* @property recordCode - 6-character unique identifier (auto-generated if not provided)
|
|
1345
|
+
* @property insertCriteria - Duplicate handling strategy:
|
|
1346
|
+
* - 'S' (Skip): Skip if duplicate exists
|
|
1347
|
+
* - 'N' (New): Always create new record
|
|
1348
|
+
* - 'T' (Throw): Error if duplicate exists
|
|
1349
|
+
* - 'M' (Merge): Merge with existing record
|
|
1350
|
+
* @property createdDate - Record creation date in ISO format
|
|
1351
|
+
* @property recordType - Classification: 'CUSTOMER' | 'SUPPLIER' | 'GENERAL' (defaults to 'CUSTOMER')
|
|
1352
|
+
* @property recordStatus - Status: 'ENABLED' | 'DISABLED' | 'WARNING' | 'BLACKLISTED' (defaults to 'ENABLED')
|
|
1353
|
+
* @property moniker - Short display name or alias
|
|
1354
|
+
* @property name - Full name (person or company)
|
|
1355
|
+
* @property extraInfo - Additional information field
|
|
1356
|
+
* @property languageCode - Required 2-character ISO language code (e.g., '02' for Italian, '01' for English)
|
|
1357
|
+
* @property address - Street address
|
|
1358
|
+
* @property zipCode - Postal/ZIP code
|
|
1359
|
+
* @property cityName - City name
|
|
1360
|
+
* @property countyCode - County/province code
|
|
1361
|
+
* @property stateCode - Country/state code
|
|
1362
|
+
* @property categoryCode - Category classification code
|
|
1363
|
+
* @property firstPhoneNumber - Primary phone number
|
|
1364
|
+
* @property mobilePhoneNumber - Mobile phone number
|
|
1365
|
+
* @property email - Email address
|
|
1366
|
+
* @property gender - Gender: 'M' (male) | 'F' (female)
|
|
1367
|
+
* @property birthDate - Date of birth in ISO format (YYYY-MM-DD)
|
|
1368
|
+
* @property birthCity - City of birth
|
|
1369
|
+
* @property birthCounty - County of birth
|
|
1370
|
+
* @property fiscalCode - Tax/fiscal identification code
|
|
1371
|
+
* @property vatCode - VAT number
|
|
1372
|
+
* @property thirdPartRecordCode - External system reference code
|
|
1373
|
+
* @property idDocumentDetail - Identity document information
|
|
1374
|
+
* @property accountPolicies - Privacy and marketing consent flags
|
|
1375
|
+
* @property financialDetail - Financial and payment details
|
|
1376
|
+
* @property dynamicFields - Custom key-value fields
|
|
1377
|
+
*
|
|
1378
|
+
* @example
|
|
1379
|
+
* ```typescript
|
|
1380
|
+
* const record: MasterRecordDetail = {
|
|
1381
|
+
* languageCode: '02',
|
|
1382
|
+
* name: 'Mario Rossi',
|
|
1383
|
+
* email: 'mario.rossi@example.com',
|
|
1384
|
+
* recordType: 'CUSTOMER',
|
|
1385
|
+
* insertCriteria: 'M',
|
|
1386
|
+
* accountPolicies: {
|
|
1387
|
+
* acceptPrivacyPolicies: 1,
|
|
1388
|
+
* acceptNewsletterPolicies: 0,
|
|
1389
|
+
* },
|
|
1390
|
+
* };
|
|
1391
|
+
* ```
|
|
1392
|
+
*/
|
|
1048
1393
|
type MasterRecordDetail = InferInput<typeof MasterRecordDetailSchema>;
|
|
1394
|
+
/**
|
|
1395
|
+
* Master record detail as returned by the API (camelCase transformed).
|
|
1396
|
+
*
|
|
1397
|
+
* Contains all fields from {@link MasterRecordDetail} plus additional read-only fields
|
|
1398
|
+
* populated by the server (e.g., `modifiedDate`, `loginType`).
|
|
1399
|
+
*/
|
|
1049
1400
|
type MasterRecordDetailResponse = InferOutput<typeof MasterRecordDetailResponseSchema>;
|
|
1050
1401
|
/**
|
|
1051
|
-
* Search
|
|
1402
|
+
* Search parameters for finding master records.
|
|
1403
|
+
*
|
|
1404
|
+
* This is a discriminated union based on `searchType`. Each search type requires
|
|
1405
|
+
* different parameters:
|
|
1406
|
+
*
|
|
1407
|
+
* | searchType | Required Fields | Optional Fields |
|
|
1408
|
+
* |------------|-----------------|-----------------|
|
|
1409
|
+
* | 'CODE' | recordCode | languageCode |
|
|
1410
|
+
* | 'NAME' | name | city, languageCode |
|
|
1411
|
+
* | 'VATCODE' | vatCode | phoneNumber, languageCode |
|
|
1412
|
+
* | 'ZONE' | zipCode, countyCode | city, languageCode |
|
|
1413
|
+
* | 'CATEGORY' | categoryCode | languageCode |
|
|
1414
|
+
* | 'EMAIL' | email | languageCode |
|
|
1415
|
+
* | 'LASTMODDATE' | lastModificationDate | languageCode |
|
|
1416
|
+
* | 'SEARCH_FIELD' | searchFieldValue | languageCode |
|
|
1417
|
+
* | 'EXTERNAL_REF_CODE' | searchFieldValue | languageCode |
|
|
1418
|
+
*
|
|
1419
|
+
* @example
|
|
1420
|
+
* ```typescript
|
|
1421
|
+
* // Search by customer code
|
|
1422
|
+
* const byCode: SearchMasterRecord = {
|
|
1423
|
+
* searchType: 'CODE',
|
|
1424
|
+
* recordCode: '508558',
|
|
1425
|
+
* };
|
|
1426
|
+
*
|
|
1427
|
+
* // Search by name and city
|
|
1428
|
+
* const byName: SearchMasterRecord = {
|
|
1429
|
+
* searchType: 'NAME',
|
|
1430
|
+
* name: 'Rossi',
|
|
1431
|
+
* city: 'Milano',
|
|
1432
|
+
* };
|
|
1433
|
+
*
|
|
1434
|
+
* // Search by last modification date range
|
|
1435
|
+
* const byDate: SearchMasterRecord = {
|
|
1436
|
+
* searchType: 'LASTMODDATE',
|
|
1437
|
+
* lastModificationDate: {
|
|
1438
|
+
* minDate: '2024-01-01',
|
|
1439
|
+
* maxDate: '2024-12-31',
|
|
1440
|
+
* },
|
|
1441
|
+
* };
|
|
1442
|
+
* ```
|
|
1052
1443
|
*/
|
|
1053
1444
|
type SearchMasterRecord = InferInput<typeof SearchMasterRecordSchema>;
|
|
1445
|
+
/**
|
|
1446
|
+
* Response from a master record search operation.
|
|
1447
|
+
*
|
|
1448
|
+
* @property rsStatus - Operation status (check for 'OK' before accessing results)
|
|
1449
|
+
* @property masterRecordList - Object containing array of matching records
|
|
1450
|
+
* @property masterRecordList.masterRecordDetail - Array of {@link MasterRecordDetailResponse} objects
|
|
1451
|
+
*
|
|
1452
|
+
* @example
|
|
1453
|
+
* ```typescript
|
|
1454
|
+
* const result = await client.search({ searchType: 'CODE', recordCode: '508558' });
|
|
1455
|
+
* if (result.success && result.data.rsStatus.status === 'OK') {
|
|
1456
|
+
* const records = result.data.masterRecordList?.masterRecordDetail ?? [];
|
|
1457
|
+
* records.forEach(record => console.log(record.name));
|
|
1458
|
+
* }
|
|
1459
|
+
* ```
|
|
1460
|
+
*/
|
|
1054
1461
|
type SearchMasterRecordRS = InferOutput<typeof SearchMasterRecordResponseSchema>;
|
|
1055
1462
|
/**
|
|
1056
|
-
*
|
|
1463
|
+
* Complete request structure for insert/update operations (internal use).
|
|
1464
|
+
*
|
|
1465
|
+
* @property RqHeader - Authentication header
|
|
1466
|
+
* @property MasterRecordDetail - Record data to insert or update
|
|
1467
|
+
*
|
|
1468
|
+
* @internal This type is primarily for internal SDK use. Use {@link MasterRecordDetail}
|
|
1469
|
+
* as the input type for `client.upsertRecord()`.
|
|
1057
1470
|
*/
|
|
1058
1471
|
type ManageMasterRecordRequest = InferInput<typeof ManageMasterRecordRequestSchema>;
|
|
1472
|
+
/**
|
|
1473
|
+
* Response from an insert/update operation.
|
|
1474
|
+
*
|
|
1475
|
+
* @property rsStatus - Operation status (check for 'OK' to confirm success)
|
|
1476
|
+
* @property masterRecordDetail - The created/updated record with server-assigned values
|
|
1477
|
+
* (e.g., `recordCode` for new records)
|
|
1478
|
+
*
|
|
1479
|
+
* @example
|
|
1480
|
+
* ```typescript
|
|
1481
|
+
* const result = await client.upsertRecord({
|
|
1482
|
+
* languageCode: '02',
|
|
1483
|
+
* name: 'New Customer',
|
|
1484
|
+
* insertCriteria: 'N',
|
|
1485
|
+
* });
|
|
1486
|
+
*
|
|
1487
|
+
* if (result.success) {
|
|
1488
|
+
* const newCode = result.data.masterRecordDetail?.recordCode;
|
|
1489
|
+
* console.log(`Created record with code: ${newCode}`);
|
|
1490
|
+
* }
|
|
1491
|
+
* ```
|
|
1492
|
+
*/
|
|
1059
1493
|
type ManageMasterRecordRS = InferOutput<typeof ManageMasterRecordResponseSchema>;
|
|
1494
|
+
/**
|
|
1495
|
+
* Configuration options for the AVES API client.
|
|
1496
|
+
*
|
|
1497
|
+
* @property baseURL - Base URL of the AVES API (e.g., 'https://api.aves.example.com')
|
|
1498
|
+
* @property hostID - 6-digit identification code assigned to your organization
|
|
1499
|
+
* @property xtoken - Authentication token for API access
|
|
1500
|
+
* @property languageCode - Optional default 2-character language code for all requests
|
|
1501
|
+
* @property timeoutMs - Optional request timeout in milliseconds (default: 30000)
|
|
1502
|
+
*
|
|
1503
|
+
* @example
|
|
1504
|
+
* ```typescript
|
|
1505
|
+
* const client = new AvesClient({
|
|
1506
|
+
* baseURL: 'https://api.aves.example.com',
|
|
1507
|
+
* hostID: '025706',
|
|
1508
|
+
* xtoken: 'TOKEN025706',
|
|
1509
|
+
* languageCode: '02',
|
|
1510
|
+
* timeoutMs: 10000,
|
|
1511
|
+
* });
|
|
1512
|
+
* ```
|
|
1513
|
+
*/
|
|
1060
1514
|
interface AvesClientOptions {
|
|
1515
|
+
/** Base URL of the AVES API (e.g., 'https://api.aves.example.com') */
|
|
1061
1516
|
baseURL: string;
|
|
1517
|
+
/** 6-digit identification code assigned to your organization */
|
|
1062
1518
|
hostID: string;
|
|
1519
|
+
/** Authentication token for API access */
|
|
1063
1520
|
xtoken: string;
|
|
1521
|
+
/** Optional default 2-character language code for all requests */
|
|
1064
1522
|
languageCode?: string;
|
|
1523
|
+
/** Optional request timeout in milliseconds (default: 30000) */
|
|
1065
1524
|
timeoutMs?: number;
|
|
1066
1525
|
}
|
|
1067
1526
|
|
|
@@ -1076,24 +1535,6 @@ type Result<T, E = Error> = {
|
|
|
1076
1535
|
error: E;
|
|
1077
1536
|
};
|
|
1078
1537
|
|
|
1079
|
-
declare const ERROR_KINDS: {
|
|
1080
|
-
readonly VALIDATION: "validation";
|
|
1081
|
-
readonly API: "api";
|
|
1082
|
-
readonly UNKNOWN: "unknown";
|
|
1083
|
-
};
|
|
1084
|
-
type ErrorKind = (typeof ERROR_KINDS)[keyof typeof ERROR_KINDS];
|
|
1085
|
-
/**
|
|
1086
|
-
* Error thrown by AVES API operations
|
|
1087
|
-
*/
|
|
1088
|
-
declare class AvesError extends Error {
|
|
1089
|
-
readonly kind: ErrorKind;
|
|
1090
|
-
readonly message: string;
|
|
1091
|
-
readonly status?: string | undefined;
|
|
1092
|
-
readonly code?: number | string | undefined;
|
|
1093
|
-
constructor(kind: ErrorKind, message: string, status?: string | undefined, code?: number | string | undefined);
|
|
1094
|
-
private parseCode;
|
|
1095
|
-
}
|
|
1096
|
-
|
|
1097
1538
|
/**
|
|
1098
1539
|
* AVES XML REST API client
|
|
1099
1540
|
*/
|
|
@@ -1127,4 +1568,4 @@ declare class AvesClient {
|
|
|
1127
1568
|
upsertRecord(record: MasterRecordDetail): Promise<Result<ManageMasterRecordRS, AvesError>>;
|
|
1128
1569
|
}
|
|
1129
1570
|
|
|
1130
|
-
export { AvesClient, type AvesClientOptions, AvesError, type FinancialDetail, type ManageMasterRecordRS, type ManageMasterRecordRequest, type MasterRecordDetail, type MasterRecordDetailResponse, type RqHeader, type RsStatus, type SearchMasterRecord, type SearchMasterRecordRS };
|
|
1571
|
+
export { type AccountPolicies, AvesClient, type AvesClientOptions, AvesError, type DynamicFields, type FinancialDetail, type IdDocumentDetail, type ManageMasterRecordRS, type ManageMasterRecordRequest, type MasterRecordDetail, type MasterRecordDetailResponse, type RqHeader, type RsStatus, type SearchMasterRecord, type SearchMasterRecordRS };
|