@neo-edi/types 1.0.14 → 1.0.18

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.d.mts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Customer entity types
3
3
  */
4
4
  interface EdiCustomer {
5
- customerId: string;
5
+ id: string;
6
6
  customerName: string;
7
7
  isActive: boolean;
8
8
  customerMetadata: Record<string, unknown>;
@@ -10,7 +10,6 @@ interface EdiCustomer {
10
10
  updatedAt: Date;
11
11
  }
12
12
  interface CreateCustomerRequest {
13
- customerId: string;
14
13
  customerName: string;
15
14
  isActive?: boolean;
16
15
  customerMetadata?: Record<string, unknown>;
@@ -26,6 +25,10 @@ interface ListCustomersParams {
26
25
  limit?: number;
27
26
  offset?: number;
28
27
  }
28
+ /**
29
+ * Customer identifier types for external lookups
30
+ */
31
+ type CustomerIdentifierType = "CODE" | "GLN" | "DUNS" | "ISA_ID" | "GS_ID" | "EXTERNAL";
29
32
 
30
33
  /**
31
34
  * Sub-customer (customer hierarchy) types
@@ -37,10 +40,24 @@ interface SubCustomer {
37
40
  isActive: boolean;
38
41
  createdAt: Date;
39
42
  }
43
+ interface SubCustomerIdentifier {
44
+ id: string;
45
+ identifierType: string;
46
+ identifierValue: string;
47
+ qualifier: string | null;
48
+ isPrimary: boolean;
49
+ }
50
+ interface SubCustomerWithIdentifiers extends SubCustomer {
51
+ identifiers: SubCustomerIdentifier[];
52
+ }
40
53
  interface SubCustomersResponse {
41
54
  parentCustomerId: string;
42
55
  subCustomers: SubCustomer[];
43
56
  }
57
+ interface SubCustomersWithIdentifiersResponse {
58
+ parentCustomerId: string;
59
+ subCustomers: SubCustomerWithIdentifiers[];
60
+ }
44
61
  interface AddSubCustomerRequest {
45
62
  childCustomerId: string;
46
63
  }
@@ -51,8 +68,27 @@ interface AddSubCustomerResponse {
51
68
  created: boolean;
52
69
  activated: boolean;
53
70
  }
71
+ interface CreateSubCustomerRequest {
72
+ customerName: string;
73
+ accountNumber?: string;
74
+ isActive?: boolean;
75
+ }
76
+ interface CreateSubCustomerIdentifier {
77
+ id: string;
78
+ identifierType: string;
79
+ identifierValue: string;
80
+ }
81
+ interface CreateSubCustomerResponse {
82
+ hierarchyId: string;
83
+ parentCustomerId: string;
84
+ childCustomerId: string;
85
+ childCustomerName: string;
86
+ identifier?: CreateSubCustomerIdentifier;
87
+ created: boolean;
88
+ }
54
89
  interface ListSubCustomersParams {
55
90
  includeInactive?: boolean;
91
+ includeIdentifiers?: boolean;
56
92
  }
57
93
 
58
94
  /**
@@ -471,4 +507,4 @@ interface ListExecutionsParams {
471
507
  offset?: number;
472
508
  }
473
509
 
474
- export type { AddSubCustomerRequest, AddSubCustomerResponse, Address, ApiErrorResponse, ApiResponse, ApiSuccessResponse, CreateCustomerRequest, CreateMappingTemplateRequest, CreatePartnerRequest, CsvAddHeadersStrategy, CsvAddHeadersTransformation, CsvDataTransformationConfig, CsvDataTransformationStep, CsvHeaderDefinition, CsvHeaderMappingCollection, CsvHeaderMappingConfig, CsvHeaderTableEntry, CustomerSubscription, CustomerSubscriptionsResponse, DryRunResult, Edi852DeliverySummary, Edi852Header, Edi852HeaderFilter, Edi852Item, Edi852Location, Edi852Status, EdiCustomer, EdiMappingTemplate, EdiPartner, EdiPartnerCustomer, ExecutionDetail, ExecutionSummary, GetIdentifierMappingsResponse, GetSubscriptionsParams, IdentifierPattern, IngestCsvRequest, IngestCsvResult, ListCustomersParams, ListExecutionsParams, ListMappingTemplatesParams, ListSubCustomersParams, PaginatedData, PaginatedResponse, PartnerCustomerRegistrationResult, RegisterPartnerCustomerRequest, SetIdentifierMappingsResponse, SubCustomer, SubCustomersResponse, UpdateCustomerRequest, UpdateMappingTemplateRequest, UpdatePartnerRequest };
510
+ export type { AddSubCustomerRequest, AddSubCustomerResponse, Address, ApiErrorResponse, ApiResponse, ApiSuccessResponse, CreateCustomerRequest, CreateMappingTemplateRequest, CreatePartnerRequest, CreateSubCustomerIdentifier, CreateSubCustomerRequest, CreateSubCustomerResponse, CsvAddHeadersStrategy, CsvAddHeadersTransformation, CsvDataTransformationConfig, CsvDataTransformationStep, CsvHeaderDefinition, CsvHeaderMappingCollection, CsvHeaderMappingConfig, CsvHeaderTableEntry, CustomerIdentifierType, CustomerSubscription, CustomerSubscriptionsResponse, DryRunResult, Edi852DeliverySummary, Edi852Header, Edi852HeaderFilter, Edi852Item, Edi852Location, Edi852Status, EdiCustomer, EdiMappingTemplate, EdiPartner, EdiPartnerCustomer, ExecutionDetail, ExecutionSummary, GetIdentifierMappingsResponse, GetSubscriptionsParams, IdentifierPattern, IngestCsvRequest, IngestCsvResult, ListCustomersParams, ListExecutionsParams, ListMappingTemplatesParams, ListSubCustomersParams, PaginatedData, PaginatedResponse, PartnerCustomerRegistrationResult, RegisterPartnerCustomerRequest, SetIdentifierMappingsResponse, SubCustomer, SubCustomerIdentifier, SubCustomerWithIdentifiers, SubCustomersResponse, SubCustomersWithIdentifiersResponse, UpdateCustomerRequest, UpdateMappingTemplateRequest, UpdatePartnerRequest };
package/dist/index.d.ts CHANGED
@@ -2,7 +2,7 @@
2
2
  * Customer entity types
3
3
  */
4
4
  interface EdiCustomer {
5
- customerId: string;
5
+ id: string;
6
6
  customerName: string;
7
7
  isActive: boolean;
8
8
  customerMetadata: Record<string, unknown>;
@@ -10,7 +10,6 @@ interface EdiCustomer {
10
10
  updatedAt: Date;
11
11
  }
12
12
  interface CreateCustomerRequest {
13
- customerId: string;
14
13
  customerName: string;
15
14
  isActive?: boolean;
16
15
  customerMetadata?: Record<string, unknown>;
@@ -26,6 +25,10 @@ interface ListCustomersParams {
26
25
  limit?: number;
27
26
  offset?: number;
28
27
  }
28
+ /**
29
+ * Customer identifier types for external lookups
30
+ */
31
+ type CustomerIdentifierType = "CODE" | "GLN" | "DUNS" | "ISA_ID" | "GS_ID" | "EXTERNAL";
29
32
 
30
33
  /**
31
34
  * Sub-customer (customer hierarchy) types
@@ -37,10 +40,24 @@ interface SubCustomer {
37
40
  isActive: boolean;
38
41
  createdAt: Date;
39
42
  }
43
+ interface SubCustomerIdentifier {
44
+ id: string;
45
+ identifierType: string;
46
+ identifierValue: string;
47
+ qualifier: string | null;
48
+ isPrimary: boolean;
49
+ }
50
+ interface SubCustomerWithIdentifiers extends SubCustomer {
51
+ identifiers: SubCustomerIdentifier[];
52
+ }
40
53
  interface SubCustomersResponse {
41
54
  parentCustomerId: string;
42
55
  subCustomers: SubCustomer[];
43
56
  }
57
+ interface SubCustomersWithIdentifiersResponse {
58
+ parentCustomerId: string;
59
+ subCustomers: SubCustomerWithIdentifiers[];
60
+ }
44
61
  interface AddSubCustomerRequest {
45
62
  childCustomerId: string;
46
63
  }
@@ -51,8 +68,27 @@ interface AddSubCustomerResponse {
51
68
  created: boolean;
52
69
  activated: boolean;
53
70
  }
71
+ interface CreateSubCustomerRequest {
72
+ customerName: string;
73
+ accountNumber?: string;
74
+ isActive?: boolean;
75
+ }
76
+ interface CreateSubCustomerIdentifier {
77
+ id: string;
78
+ identifierType: string;
79
+ identifierValue: string;
80
+ }
81
+ interface CreateSubCustomerResponse {
82
+ hierarchyId: string;
83
+ parentCustomerId: string;
84
+ childCustomerId: string;
85
+ childCustomerName: string;
86
+ identifier?: CreateSubCustomerIdentifier;
87
+ created: boolean;
88
+ }
54
89
  interface ListSubCustomersParams {
55
90
  includeInactive?: boolean;
91
+ includeIdentifiers?: boolean;
56
92
  }
57
93
 
58
94
  /**
@@ -471,4 +507,4 @@ interface ListExecutionsParams {
471
507
  offset?: number;
472
508
  }
473
509
 
474
- export type { AddSubCustomerRequest, AddSubCustomerResponse, Address, ApiErrorResponse, ApiResponse, ApiSuccessResponse, CreateCustomerRequest, CreateMappingTemplateRequest, CreatePartnerRequest, CsvAddHeadersStrategy, CsvAddHeadersTransformation, CsvDataTransformationConfig, CsvDataTransformationStep, CsvHeaderDefinition, CsvHeaderMappingCollection, CsvHeaderMappingConfig, CsvHeaderTableEntry, CustomerSubscription, CustomerSubscriptionsResponse, DryRunResult, Edi852DeliverySummary, Edi852Header, Edi852HeaderFilter, Edi852Item, Edi852Location, Edi852Status, EdiCustomer, EdiMappingTemplate, EdiPartner, EdiPartnerCustomer, ExecutionDetail, ExecutionSummary, GetIdentifierMappingsResponse, GetSubscriptionsParams, IdentifierPattern, IngestCsvRequest, IngestCsvResult, ListCustomersParams, ListExecutionsParams, ListMappingTemplatesParams, ListSubCustomersParams, PaginatedData, PaginatedResponse, PartnerCustomerRegistrationResult, RegisterPartnerCustomerRequest, SetIdentifierMappingsResponse, SubCustomer, SubCustomersResponse, UpdateCustomerRequest, UpdateMappingTemplateRequest, UpdatePartnerRequest };
510
+ export type { AddSubCustomerRequest, AddSubCustomerResponse, Address, ApiErrorResponse, ApiResponse, ApiSuccessResponse, CreateCustomerRequest, CreateMappingTemplateRequest, CreatePartnerRequest, CreateSubCustomerIdentifier, CreateSubCustomerRequest, CreateSubCustomerResponse, CsvAddHeadersStrategy, CsvAddHeadersTransformation, CsvDataTransformationConfig, CsvDataTransformationStep, CsvHeaderDefinition, CsvHeaderMappingCollection, CsvHeaderMappingConfig, CsvHeaderTableEntry, CustomerIdentifierType, CustomerSubscription, CustomerSubscriptionsResponse, DryRunResult, Edi852DeliverySummary, Edi852Header, Edi852HeaderFilter, Edi852Item, Edi852Location, Edi852Status, EdiCustomer, EdiMappingTemplate, EdiPartner, EdiPartnerCustomer, ExecutionDetail, ExecutionSummary, GetIdentifierMappingsResponse, GetSubscriptionsParams, IdentifierPattern, IngestCsvRequest, IngestCsvResult, ListCustomersParams, ListExecutionsParams, ListMappingTemplatesParams, ListSubCustomersParams, PaginatedData, PaginatedResponse, PartnerCustomerRegistrationResult, RegisterPartnerCustomerRequest, SetIdentifierMappingsResponse, SubCustomer, SubCustomerIdentifier, SubCustomerWithIdentifiers, SubCustomersResponse, SubCustomersWithIdentifiersResponse, UpdateCustomerRequest, UpdateMappingTemplateRequest, UpdatePartnerRequest };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@neo-edi/types",
3
- "version": "1.0.14",
3
+ "version": "1.0.18",
4
4
  "description": "TypeScript types for the Neo-EDI platform",
5
5
  "main": "./dist/index.js",
6
6
  "module": "./dist/index.mjs",