reach-api-sdk 1.0.188 → 1.0.190
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/reach-sdk.d.ts +190 -9
- package/dist/reach-sdk.js +148 -1
- package/package.json +1 -1
- package/src/apiClient.ts +3 -0
- package/src/definition/swagger.yaml +458 -0
- package/src/index.ts +3 -0
- package/src/models/Customer.ts +4 -0
- package/src/models/EndUserIdentitySecureToken.ts +37 -0
- package/src/models/ResolveSecureAccessTokenRequest.ts +14 -0
- package/src/services/CustomersService.ts +36 -0
- package/src/services/EndUserIdentitySecureTokenService.ts +177 -0
- package/src/services/PublicCustomersService.ts +47 -0
|
@@ -89,6 +89,7 @@ export class CustomersService {
|
|
|
89
89
|
programmeId,
|
|
90
90
|
marketingOptIn,
|
|
91
91
|
isActiveCustomer,
|
|
92
|
+
endUserIdentityId,
|
|
92
93
|
pageNumber,
|
|
93
94
|
take,
|
|
94
95
|
skip,
|
|
@@ -126,6 +127,10 @@ export class CustomersService {
|
|
|
126
127
|
* Gets or sets a value indicating whether the customer is an active customer, that is, they have completed at least 1 order through to the 'Booked' stage.
|
|
127
128
|
*/
|
|
128
129
|
isActiveCustomer?: boolean;
|
|
130
|
+
/**
|
|
131
|
+
* Gets or sets the customers end user identity id.
|
|
132
|
+
*/
|
|
133
|
+
endUserIdentityId?: string;
|
|
129
134
|
/**
|
|
130
135
|
* Gets or sets the page number for paged queries.
|
|
131
136
|
*/
|
|
@@ -187,6 +192,7 @@ export class CustomersService {
|
|
|
187
192
|
ProgrammeId: programmeId,
|
|
188
193
|
MarketingOptIn: marketingOptIn,
|
|
189
194
|
IsActiveCustomer: isActiveCustomer,
|
|
195
|
+
EndUserIdentityId: endUserIdentityId,
|
|
190
196
|
PageNumber: pageNumber,
|
|
191
197
|
Take: take,
|
|
192
198
|
Skip: skip,
|
|
@@ -222,6 +228,7 @@ export class CustomersService {
|
|
|
222
228
|
programmeId,
|
|
223
229
|
marketingOptIn,
|
|
224
230
|
isActiveCustomer,
|
|
231
|
+
endUserIdentityId,
|
|
225
232
|
pageNumber,
|
|
226
233
|
take,
|
|
227
234
|
skip,
|
|
@@ -259,6 +266,10 @@ export class CustomersService {
|
|
|
259
266
|
* Gets or sets a value indicating whether the customer is an active customer, that is, they have completed at least 1 order through to the 'Booked' stage.
|
|
260
267
|
*/
|
|
261
268
|
isActiveCustomer?: boolean;
|
|
269
|
+
/**
|
|
270
|
+
* Gets or sets the customers end user identity id.
|
|
271
|
+
*/
|
|
272
|
+
endUserIdentityId?: string;
|
|
262
273
|
/**
|
|
263
274
|
* Gets or sets the page number for paged queries.
|
|
264
275
|
*/
|
|
@@ -320,6 +331,7 @@ export class CustomersService {
|
|
|
320
331
|
ProgrammeId: programmeId,
|
|
321
332
|
MarketingOptIn: marketingOptIn,
|
|
322
333
|
IsActiveCustomer: isActiveCustomer,
|
|
334
|
+
EndUserIdentityId: endUserIdentityId,
|
|
323
335
|
PageNumber: pageNumber,
|
|
324
336
|
Take: take,
|
|
325
337
|
Skip: skip,
|
|
@@ -484,6 +496,7 @@ export class CustomersService {
|
|
|
484
496
|
programmeId,
|
|
485
497
|
marketingOptIn,
|
|
486
498
|
isActiveCustomer,
|
|
499
|
+
endUserIdentityId,
|
|
487
500
|
pageNumber,
|
|
488
501
|
take,
|
|
489
502
|
skip,
|
|
@@ -520,6 +533,10 @@ export class CustomersService {
|
|
|
520
533
|
* Gets or sets a value indicating whether the customer is an active customer, that is, they have completed at least 1 order through to the 'Booked' stage.
|
|
521
534
|
*/
|
|
522
535
|
isActiveCustomer?: boolean;
|
|
536
|
+
/**
|
|
537
|
+
* Gets or sets the customers end user identity id.
|
|
538
|
+
*/
|
|
539
|
+
endUserIdentityId?: string;
|
|
523
540
|
/**
|
|
524
541
|
* Gets or sets the page number for paged queries.
|
|
525
542
|
*/
|
|
@@ -575,6 +592,7 @@ export class CustomersService {
|
|
|
575
592
|
ProgrammeId: programmeId,
|
|
576
593
|
MarketingOptIn: marketingOptIn,
|
|
577
594
|
IsActiveCustomer: isActiveCustomer,
|
|
595
|
+
EndUserIdentityId: endUserIdentityId,
|
|
578
596
|
PageNumber: pageNumber,
|
|
579
597
|
Take: take,
|
|
580
598
|
Skip: skip,
|
|
@@ -688,6 +706,7 @@ export class CustomersService {
|
|
|
688
706
|
programmeId,
|
|
689
707
|
marketingOptIn,
|
|
690
708
|
isActiveCustomer,
|
|
709
|
+
endUserIdentityId,
|
|
691
710
|
pageNumber,
|
|
692
711
|
take,
|
|
693
712
|
skip,
|
|
@@ -724,6 +743,10 @@ export class CustomersService {
|
|
|
724
743
|
* Gets or sets a value indicating whether the customer is an active customer, that is, they have completed at least 1 order through to the 'Booked' stage.
|
|
725
744
|
*/
|
|
726
745
|
isActiveCustomer?: boolean;
|
|
746
|
+
/**
|
|
747
|
+
* Gets or sets the customers end user identity id.
|
|
748
|
+
*/
|
|
749
|
+
endUserIdentityId?: string;
|
|
727
750
|
/**
|
|
728
751
|
* Gets or sets the page number for paged queries.
|
|
729
752
|
*/
|
|
@@ -779,6 +802,7 @@ export class CustomersService {
|
|
|
779
802
|
ProgrammeId: programmeId,
|
|
780
803
|
MarketingOptIn: marketingOptIn,
|
|
781
804
|
IsActiveCustomer: isActiveCustomer,
|
|
805
|
+
EndUserIdentityId: endUserIdentityId,
|
|
782
806
|
PageNumber: pageNumber,
|
|
783
807
|
Take: take,
|
|
784
808
|
Skip: skip,
|
|
@@ -811,6 +835,7 @@ export class CustomersService {
|
|
|
811
835
|
programmeId,
|
|
812
836
|
marketingOptIn,
|
|
813
837
|
isActiveCustomer,
|
|
838
|
+
endUserIdentityId,
|
|
814
839
|
pageNumber,
|
|
815
840
|
take,
|
|
816
841
|
skip,
|
|
@@ -847,6 +872,10 @@ export class CustomersService {
|
|
|
847
872
|
* Gets or sets a value indicating whether the customer is an active customer, that is, they have completed at least 1 order through to the 'Booked' stage.
|
|
848
873
|
*/
|
|
849
874
|
isActiveCustomer?: boolean;
|
|
875
|
+
/**
|
|
876
|
+
* Gets or sets the customers end user identity id.
|
|
877
|
+
*/
|
|
878
|
+
endUserIdentityId?: string;
|
|
850
879
|
/**
|
|
851
880
|
* Gets or sets the page number for paged queries.
|
|
852
881
|
*/
|
|
@@ -902,6 +931,7 @@ export class CustomersService {
|
|
|
902
931
|
ProgrammeId: programmeId,
|
|
903
932
|
MarketingOptIn: marketingOptIn,
|
|
904
933
|
IsActiveCustomer: isActiveCustomer,
|
|
934
|
+
EndUserIdentityId: endUserIdentityId,
|
|
905
935
|
PageNumber: pageNumber,
|
|
906
936
|
Take: take,
|
|
907
937
|
Skip: skip,
|
|
@@ -934,6 +964,7 @@ export class CustomersService {
|
|
|
934
964
|
programmeId,
|
|
935
965
|
marketingOptIn,
|
|
936
966
|
isActiveCustomer,
|
|
967
|
+
endUserIdentityId,
|
|
937
968
|
pageNumber,
|
|
938
969
|
take,
|
|
939
970
|
skip,
|
|
@@ -970,6 +1001,10 @@ export class CustomersService {
|
|
|
970
1001
|
* Gets or sets a value indicating whether the customer is an active customer, that is, they have completed at least 1 order through to the 'Booked' stage.
|
|
971
1002
|
*/
|
|
972
1003
|
isActiveCustomer?: boolean;
|
|
1004
|
+
/**
|
|
1005
|
+
* Gets or sets the customers end user identity id.
|
|
1006
|
+
*/
|
|
1007
|
+
endUserIdentityId?: string;
|
|
973
1008
|
/**
|
|
974
1009
|
* Gets or sets the page number for paged queries.
|
|
975
1010
|
*/
|
|
@@ -1025,6 +1060,7 @@ export class CustomersService {
|
|
|
1025
1060
|
ProgrammeId: programmeId,
|
|
1026
1061
|
MarketingOptIn: marketingOptIn,
|
|
1027
1062
|
IsActiveCustomer: isActiveCustomer,
|
|
1063
|
+
EndUserIdentityId: endUserIdentityId,
|
|
1028
1064
|
PageNumber: pageNumber,
|
|
1029
1065
|
Take: take,
|
|
1030
1066
|
Skip: skip,
|
|
@@ -0,0 +1,177 @@
|
|
|
1
|
+
/* generated using openapi-typescript-codegen -- do no edit */
|
|
2
|
+
/* istanbul ignore file */
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
/* eslint-disable */
|
|
5
|
+
import type { EndUserIdentitySecureToken } from '../models/EndUserIdentitySecureToken';
|
|
6
|
+
import type { ResolveSecureAccessTokenRequest } from '../models/ResolveSecureAccessTokenRequest';
|
|
7
|
+
import type { SearchSortOrderDirection } from '../models/SearchSortOrderDirection';
|
|
8
|
+
|
|
9
|
+
import type { CancelablePromise } from '../core/CancelablePromise';
|
|
10
|
+
import type { BaseHttpRequest } from '../core/BaseHttpRequest';
|
|
11
|
+
|
|
12
|
+
export class EndUserIdentitySecureTokenService {
|
|
13
|
+
constructor(public readonly httpRequest: BaseHttpRequest) {}
|
|
14
|
+
|
|
15
|
+
/**
|
|
16
|
+
* Gets a Reach.Models.EndUserIdentitySecureToken by its Id.
|
|
17
|
+
* @returns EndUserIdentitySecureToken OK
|
|
18
|
+
* @throws ApiError
|
|
19
|
+
*/
|
|
20
|
+
public getObject({
|
|
21
|
+
id,
|
|
22
|
+
}: {
|
|
23
|
+
/**
|
|
24
|
+
* The Reach.Models.EndUserIdentitySecureToken id.
|
|
25
|
+
*/
|
|
26
|
+
id: string;
|
|
27
|
+
}): CancelablePromise<EndUserIdentitySecureToken> {
|
|
28
|
+
return this.httpRequest.request({
|
|
29
|
+
method: 'GET',
|
|
30
|
+
url: '/api/end-user-identity-secure-tokens/{id}',
|
|
31
|
+
path: {
|
|
32
|
+
id: id,
|
|
33
|
+
},
|
|
34
|
+
errors: {
|
|
35
|
+
400: `Bad Request`,
|
|
36
|
+
422: `Unprocessable Content`,
|
|
37
|
+
500: `Internal Server Error`,
|
|
38
|
+
},
|
|
39
|
+
});
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
/**
|
|
43
|
+
* Gets a Reach.Models.EndUserIdentitySecureToken by its secure token string.
|
|
44
|
+
* @returns EndUserIdentitySecureToken OK
|
|
45
|
+
* @throws ApiError
|
|
46
|
+
*/
|
|
47
|
+
public getObjectByToken({
|
|
48
|
+
requestBody,
|
|
49
|
+
}: {
|
|
50
|
+
/**
|
|
51
|
+
* The secure token.
|
|
52
|
+
*/
|
|
53
|
+
requestBody?: ResolveSecureAccessTokenRequest;
|
|
54
|
+
}): CancelablePromise<EndUserIdentitySecureToken> {
|
|
55
|
+
return this.httpRequest.request({
|
|
56
|
+
method: 'POST',
|
|
57
|
+
url: '/api/end-user-identity-secure-tokens/resolve',
|
|
58
|
+
body: requestBody,
|
|
59
|
+
mediaType: 'application/json',
|
|
60
|
+
errors: {
|
|
61
|
+
400: `Bad Request`,
|
|
62
|
+
422: `Unprocessable Content`,
|
|
63
|
+
500: `Internal Server Error`,
|
|
64
|
+
},
|
|
65
|
+
});
|
|
66
|
+
}
|
|
67
|
+
|
|
68
|
+
/**
|
|
69
|
+
* Gets a list of Reach.Models.EndUserIdentitySecureToken.
|
|
70
|
+
* @returns EndUserIdentitySecureToken OK
|
|
71
|
+
* @throws ApiError
|
|
72
|
+
*/
|
|
73
|
+
public getList({
|
|
74
|
+
token,
|
|
75
|
+
pageNumber,
|
|
76
|
+
take,
|
|
77
|
+
skip,
|
|
78
|
+
limitListRequests,
|
|
79
|
+
tenantId,
|
|
80
|
+
modifiedById,
|
|
81
|
+
modifiedByIds,
|
|
82
|
+
dateCreatedGte,
|
|
83
|
+
dateCreatedLte,
|
|
84
|
+
isLive,
|
|
85
|
+
sortOrderDirection,
|
|
86
|
+
}: {
|
|
87
|
+
/**
|
|
88
|
+
* Gets or sets the queryable token.
|
|
89
|
+
*/
|
|
90
|
+
token?: string;
|
|
91
|
+
/**
|
|
92
|
+
* Gets or sets the page number for paged queries.
|
|
93
|
+
*/
|
|
94
|
+
pageNumber?: number;
|
|
95
|
+
/**
|
|
96
|
+
* Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
|
|
97
|
+
*/
|
|
98
|
+
take?: number;
|
|
99
|
+
/**
|
|
100
|
+
* Gets or sets how much items to skip from begining of db table, when this is set page is always 1.
|
|
101
|
+
*/
|
|
102
|
+
skip?: number;
|
|
103
|
+
/**
|
|
104
|
+
* Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
|
|
105
|
+
*/
|
|
106
|
+
limitListRequests?: boolean;
|
|
107
|
+
/**
|
|
108
|
+
* Gets or sets the Tenant Id.
|
|
109
|
+
*/
|
|
110
|
+
tenantId?: string;
|
|
111
|
+
/**
|
|
112
|
+
* Gets or sets the Modifed By Id.
|
|
113
|
+
*/
|
|
114
|
+
modifiedById?: string;
|
|
115
|
+
/**
|
|
116
|
+
* Gets or sets the Modifed By Ids.
|
|
117
|
+
*/
|
|
118
|
+
modifiedByIds?: Array<string>;
|
|
119
|
+
/**
|
|
120
|
+
* Gets or sets the Date Created greater than equal to.
|
|
121
|
+
*/
|
|
122
|
+
dateCreatedGte?: string;
|
|
123
|
+
/**
|
|
124
|
+
* Gets or sets the Date Created less than equal to.
|
|
125
|
+
*/
|
|
126
|
+
dateCreatedLte?: string;
|
|
127
|
+
/**
|
|
128
|
+
* Gets or sets the queryable only is live status.
|
|
129
|
+
*/
|
|
130
|
+
isLive?: boolean;
|
|
131
|
+
/**
|
|
132
|
+
* Gets or sets the sort order direction.
|
|
133
|
+
*/
|
|
134
|
+
sortOrderDirection?: SearchSortOrderDirection;
|
|
135
|
+
}): CancelablePromise<Array<EndUserIdentitySecureToken>> {
|
|
136
|
+
return this.httpRequest.request({
|
|
137
|
+
method: 'GET',
|
|
138
|
+
url: '/api/end-user-identity-secure-tokens',
|
|
139
|
+
query: {
|
|
140
|
+
Token: token,
|
|
141
|
+
PageNumber: pageNumber,
|
|
142
|
+
Take: take,
|
|
143
|
+
Skip: skip,
|
|
144
|
+
LimitListRequests: limitListRequests,
|
|
145
|
+
TenantId: tenantId,
|
|
146
|
+
ModifiedById: modifiedById,
|
|
147
|
+
ModifiedByIds: modifiedByIds,
|
|
148
|
+
DateCreatedGTE: dateCreatedGte,
|
|
149
|
+
DateCreatedLTE: dateCreatedLte,
|
|
150
|
+
IsLive: isLive,
|
|
151
|
+
SortOrderDirection: sortOrderDirection,
|
|
152
|
+
},
|
|
153
|
+
errors: {
|
|
154
|
+
400: `Bad Request`,
|
|
155
|
+
422: `Unprocessable Content`,
|
|
156
|
+
500: `Internal Server Error`,
|
|
157
|
+
},
|
|
158
|
+
});
|
|
159
|
+
}
|
|
160
|
+
|
|
161
|
+
/**
|
|
162
|
+
* Backfills the secure access tokens for all end user identities. Should only be run once and by existing developers whos db structure is outdated with relevance to end user identities.
|
|
163
|
+
* @returns any OK
|
|
164
|
+
* @throws ApiError
|
|
165
|
+
*/
|
|
166
|
+
public backfillTokens(): CancelablePromise<any> {
|
|
167
|
+
return this.httpRequest.request({
|
|
168
|
+
method: 'GET',
|
|
169
|
+
url: '/api/end-user-identity-secure-tokens/back-fill',
|
|
170
|
+
errors: {
|
|
171
|
+
400: `Bad Request`,
|
|
172
|
+
422: `Unprocessable Content`,
|
|
173
|
+
500: `Internal Server Error`,
|
|
174
|
+
},
|
|
175
|
+
});
|
|
176
|
+
}
|
|
177
|
+
}
|
|
@@ -89,6 +89,7 @@ export class PublicCustomersService {
|
|
|
89
89
|
programmeId,
|
|
90
90
|
marketingOptIn,
|
|
91
91
|
isActiveCustomer,
|
|
92
|
+
endUserIdentityId,
|
|
92
93
|
pageNumber,
|
|
93
94
|
take,
|
|
94
95
|
skip,
|
|
@@ -126,6 +127,10 @@ export class PublicCustomersService {
|
|
|
126
127
|
* Gets or sets a value indicating whether the customer is an active customer, that is, they have completed at least 1 order through to the 'Booked' stage.
|
|
127
128
|
*/
|
|
128
129
|
isActiveCustomer?: boolean;
|
|
130
|
+
/**
|
|
131
|
+
* Gets or sets the customers end user identity id.
|
|
132
|
+
*/
|
|
133
|
+
endUserIdentityId?: string;
|
|
129
134
|
/**
|
|
130
135
|
* Gets or sets the page number for paged queries.
|
|
131
136
|
*/
|
|
@@ -184,6 +189,7 @@ export class PublicCustomersService {
|
|
|
184
189
|
ProgrammeId: programmeId,
|
|
185
190
|
MarketingOptIn: marketingOptIn,
|
|
186
191
|
IsActiveCustomer: isActiveCustomer,
|
|
192
|
+
EndUserIdentityId: endUserIdentityId,
|
|
187
193
|
PageNumber: pageNumber,
|
|
188
194
|
Take: take,
|
|
189
195
|
Skip: skip,
|
|
@@ -238,6 +244,41 @@ export class PublicCustomersService {
|
|
|
238
244
|
});
|
|
239
245
|
}
|
|
240
246
|
|
|
247
|
+
/**
|
|
248
|
+
* Returns the tenants accessible to the end user.
|
|
249
|
+
* @returns any OK
|
|
250
|
+
* @throws ApiError
|
|
251
|
+
*/
|
|
252
|
+
public getCustomerAccessibleTenants({
|
|
253
|
+
endUserIdentityId,
|
|
254
|
+
xTenantSubdomain,
|
|
255
|
+
}: {
|
|
256
|
+
/**
|
|
257
|
+
* The end user identity id.
|
|
258
|
+
*/
|
|
259
|
+
endUserIdentityId: string;
|
|
260
|
+
/**
|
|
261
|
+
* The tenants subdomain.
|
|
262
|
+
*/
|
|
263
|
+
xTenantSubdomain?: string;
|
|
264
|
+
}): CancelablePromise<any> {
|
|
265
|
+
return this.httpRequest.request({
|
|
266
|
+
method: 'GET',
|
|
267
|
+
url: '/api/public/customers/accessible-tenants/{endUserIdentityId}',
|
|
268
|
+
path: {
|
|
269
|
+
endUserIdentityId: endUserIdentityId,
|
|
270
|
+
},
|
|
271
|
+
headers: {
|
|
272
|
+
x_tenant_subdomain: xTenantSubdomain,
|
|
273
|
+
},
|
|
274
|
+
errors: {
|
|
275
|
+
400: `Bad Request`,
|
|
276
|
+
422: `Unprocessable Content`,
|
|
277
|
+
500: `Internal Server Error`,
|
|
278
|
+
},
|
|
279
|
+
});
|
|
280
|
+
}
|
|
281
|
+
|
|
241
282
|
/**
|
|
242
283
|
* Inserts a new resource. The Id will be automatically generated and will be ignored if provided.
|
|
243
284
|
* @returns Customer OK
|
|
@@ -353,6 +394,7 @@ export class PublicCustomersService {
|
|
|
353
394
|
programmeId,
|
|
354
395
|
marketingOptIn,
|
|
355
396
|
isActiveCustomer,
|
|
397
|
+
endUserIdentityId,
|
|
356
398
|
pageNumber,
|
|
357
399
|
take,
|
|
358
400
|
skip,
|
|
@@ -393,6 +435,10 @@ export class PublicCustomersService {
|
|
|
393
435
|
* Gets or sets a value indicating whether the customer is an active customer, that is, they have completed at least 1 order through to the 'Booked' stage.
|
|
394
436
|
*/
|
|
395
437
|
isActiveCustomer?: boolean;
|
|
438
|
+
/**
|
|
439
|
+
* Gets or sets the customers end user identity id.
|
|
440
|
+
*/
|
|
441
|
+
endUserIdentityId?: string;
|
|
396
442
|
/**
|
|
397
443
|
* Gets or sets the page number for paged queries.
|
|
398
444
|
*/
|
|
@@ -451,6 +497,7 @@ export class PublicCustomersService {
|
|
|
451
497
|
ProgrammeId: programmeId,
|
|
452
498
|
MarketingOptIn: marketingOptIn,
|
|
453
499
|
IsActiveCustomer: isActiveCustomer,
|
|
500
|
+
EndUserIdentityId: endUserIdentityId,
|
|
454
501
|
PageNumber: pageNumber,
|
|
455
502
|
Take: take,
|
|
456
503
|
Skip: skip,
|