reach-api-sdk 1.0.206 → 1.0.208
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 +16293 -14979
- package/dist/reach-sdk.js +1373 -417
- package/package.json +1 -1
- package/src/apiClient.ts +6 -0
- package/src/definition/swagger.yaml +3611 -267
- package/src/index.ts +18 -0
- package/src/models/Attendee.ts +9 -4
- package/src/models/AttendeePatch.ts +13 -0
- package/src/models/AttendeePost.ts +14 -1
- package/src/models/AttendeeWalletDeductionPreview.ts +51 -0
- package/src/models/CoursePatch.ts +2 -0
- package/src/models/CoursePost.ts +2 -0
- package/src/models/Customer.ts +6 -6
- package/src/models/CustomerAccountInvitePatch.ts +26 -0
- package/src/models/CustomerPatch.ts +2 -2
- package/src/models/CustomerPost.ts +2 -2
- package/src/models/CustomerWalletDeductionPreview.ts +36 -0
- package/src/models/EndUserIdentity.ts +4 -0
- package/src/models/Order.ts +6 -0
- package/src/models/RecentOrderActivityReport.ts +4 -0
- package/src/models/SessionPatch.ts +2 -0
- package/src/models/SessionPost.ts +2 -0
- package/src/models/SurveySubmitAttendee.ts +4 -0
- package/src/models/TenantSetting.ts +8 -0
- package/src/models/TotalRevenueReport.ts +4 -0
- package/src/models/VenuePatch.ts +2 -0
- package/src/models/VenuePost.ts +3 -0
- package/src/models/Wallet.ts +60 -0
- package/src/models/WalletDeductionPreview.ts +44 -0
- package/src/models/WalletPage.ts +12 -0
- package/src/models/WalletPatch.ts +23 -0
- package/src/models/WalletPost.ts +29 -0
- package/src/models/WalletRemoveCreditPost.ts +19 -0
- package/src/models/WalletTopUpPost.ts +19 -0
- package/src/models/WalletTrackingLevel.ts +12 -0
- package/src/models/WalletTransaction.ts +61 -0
- package/src/models/WalletTransactionPage.ts +12 -0
- package/src/models/WalletTransactionPatch.ts +22 -0
- package/src/models/WalletTransactionPost.ts +33 -0
- package/src/models/WalletTransactionType.ts +14 -0
- package/src/services/AttendeesService.ts +0 -30
- package/src/services/CustomersService.ts +35 -0
- package/src/services/WalletTransactionsService.ts +755 -0
- package/src/services/WalletsService.ts +901 -0
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/* generated using openapi-typescript-codegen -- do no edit */
|
|
2
|
+
/* istanbul ignore file */
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
/* eslint-disable */
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Post model for wallet credit removal operations.
|
|
8
|
+
*/
|
|
9
|
+
export type WalletRemoveCreditPost = {
|
|
10
|
+
/**
|
|
11
|
+
* Gets or sets the amount to remove from the wallet. Must be greater than zero and cannot exceed the wallet balance.
|
|
12
|
+
*/
|
|
13
|
+
amount: number;
|
|
14
|
+
/**
|
|
15
|
+
* Gets or sets the optional description for the transaction.
|
|
16
|
+
* If not provided, a default description will be generated.
|
|
17
|
+
*/
|
|
18
|
+
description?: string | null;
|
|
19
|
+
};
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/* generated using openapi-typescript-codegen -- do no edit */
|
|
2
|
+
/* istanbul ignore file */
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
/* eslint-disable */
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Post model for wallet top-up operations.
|
|
8
|
+
*/
|
|
9
|
+
export type WalletTopUpPost = {
|
|
10
|
+
/**
|
|
11
|
+
* Gets or sets the amount to add to the wallet. Must be greater than zero.
|
|
12
|
+
*/
|
|
13
|
+
amount: number;
|
|
14
|
+
/**
|
|
15
|
+
* Gets or sets the optional description for the transaction.
|
|
16
|
+
* If not provided, a default description will be generated.
|
|
17
|
+
*/
|
|
18
|
+
description?: string | null;
|
|
19
|
+
};
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/* generated using openapi-typescript-codegen -- do no edit */
|
|
2
|
+
/* istanbul ignore file */
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
/* eslint-disable */
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Controls the wallet tracking level (customer or attendee).
|
|
8
|
+
*/
|
|
9
|
+
export enum WalletTrackingLevel {
|
|
10
|
+
CUSTOMER = 'Customer',
|
|
11
|
+
ATTENDEE = 'Attendee',
|
|
12
|
+
}
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
/* generated using openapi-typescript-codegen -- do no edit */
|
|
2
|
+
/* istanbul ignore file */
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
/* eslint-disable */
|
|
5
|
+
|
|
6
|
+
import type { Order } from './Order';
|
|
7
|
+
import type { Wallet } from './Wallet';
|
|
8
|
+
import type { WalletTransactionType } from './WalletTransactionType';
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* Represents a wallet transaction within the Reach application.
|
|
12
|
+
*/
|
|
13
|
+
export type WalletTransaction = {
|
|
14
|
+
/**
|
|
15
|
+
* Gets or sets the entities Id.
|
|
16
|
+
*/
|
|
17
|
+
id?: string;
|
|
18
|
+
/**
|
|
19
|
+
* Gets or sets the tenant Id.
|
|
20
|
+
*/
|
|
21
|
+
tenantId: string;
|
|
22
|
+
/**
|
|
23
|
+
* Gets or sets the created date of this entity.
|
|
24
|
+
*/
|
|
25
|
+
dateCreated: string;
|
|
26
|
+
/**
|
|
27
|
+
* Gets or sets the last modified date of this entity.
|
|
28
|
+
*/
|
|
29
|
+
dateModified: string;
|
|
30
|
+
/**
|
|
31
|
+
* Gets or sets the modified by Id.
|
|
32
|
+
*/
|
|
33
|
+
modifiedById?: string | null;
|
|
34
|
+
/**
|
|
35
|
+
* Gets or sets a value indicating whether the record is live and available for use within the application.
|
|
36
|
+
*/
|
|
37
|
+
isLive: boolean;
|
|
38
|
+
/**
|
|
39
|
+
* Gets or sets the wallet id.
|
|
40
|
+
*/
|
|
41
|
+
walletId: string;
|
|
42
|
+
/**
|
|
43
|
+
* Gets or sets the order id. This is set when the transaction is related to an order (payment or refund).
|
|
44
|
+
*/
|
|
45
|
+
orderId?: string | null;
|
|
46
|
+
/**
|
|
47
|
+
* Gets or sets the transaction amount. Positive for credits (top-ups, refunds), negative for debits (payments).
|
|
48
|
+
*/
|
|
49
|
+
amount: number;
|
|
50
|
+
transactionType: WalletTransactionType;
|
|
51
|
+
/**
|
|
52
|
+
* Gets or sets the transaction description.
|
|
53
|
+
*/
|
|
54
|
+
description?: string | null;
|
|
55
|
+
/**
|
|
56
|
+
* Gets or sets the wallet balance after this transaction was applied.
|
|
57
|
+
*/
|
|
58
|
+
balanceAfter: number;
|
|
59
|
+
wallet?: Wallet;
|
|
60
|
+
order?: Order;
|
|
61
|
+
};
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/* generated using openapi-typescript-codegen -- do no edit */
|
|
2
|
+
/* istanbul ignore file */
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
/* eslint-disable */
|
|
5
|
+
|
|
6
|
+
import type { Pagination } from './Pagination';
|
|
7
|
+
import type { WalletTransaction } from './WalletTransaction';
|
|
8
|
+
|
|
9
|
+
export type WalletTransactionPage = {
|
|
10
|
+
pagination: Pagination;
|
|
11
|
+
readonly items: Array<WalletTransaction>;
|
|
12
|
+
};
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/* generated using openapi-typescript-codegen -- do no edit */
|
|
2
|
+
/* istanbul ignore file */
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
/* eslint-disable */
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Patch model for wallet transaction updates.
|
|
8
|
+
*/
|
|
9
|
+
export type WalletTransactionPatch = {
|
|
10
|
+
/**
|
|
11
|
+
* Gets or sets the tenant Id.
|
|
12
|
+
*/
|
|
13
|
+
tenantId: string;
|
|
14
|
+
/**
|
|
15
|
+
* Gets or sets the Id.
|
|
16
|
+
*/
|
|
17
|
+
id: string;
|
|
18
|
+
/**
|
|
19
|
+
* Gets or sets the transaction description.
|
|
20
|
+
*/
|
|
21
|
+
description?: string | null;
|
|
22
|
+
};
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
/* generated using openapi-typescript-codegen -- do no edit */
|
|
2
|
+
/* istanbul ignore file */
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
/* eslint-disable */
|
|
5
|
+
|
|
6
|
+
import type { WalletTransactionType } from './WalletTransactionType';
|
|
7
|
+
|
|
8
|
+
/**
|
|
9
|
+
* Post model for wallet transaction creation.
|
|
10
|
+
*/
|
|
11
|
+
export type WalletTransactionPost = {
|
|
12
|
+
/**
|
|
13
|
+
* Gets or sets the tenant Id.
|
|
14
|
+
*/
|
|
15
|
+
tenantId: string;
|
|
16
|
+
/**
|
|
17
|
+
* Gets or sets the wallet id.
|
|
18
|
+
*/
|
|
19
|
+
walletId?: string;
|
|
20
|
+
/**
|
|
21
|
+
* Gets or sets the order id. This is set when the transaction is related to an order (payment or refund).
|
|
22
|
+
*/
|
|
23
|
+
orderId?: string | null;
|
|
24
|
+
/**
|
|
25
|
+
* Gets or sets the transaction amount. Positive for credits (top-ups, refunds), negative for debits (payments).
|
|
26
|
+
*/
|
|
27
|
+
amount?: number;
|
|
28
|
+
transactionType?: WalletTransactionType;
|
|
29
|
+
/**
|
|
30
|
+
* Gets or sets the transaction description.
|
|
31
|
+
*/
|
|
32
|
+
description?: string | null;
|
|
33
|
+
};
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* generated using openapi-typescript-codegen -- do no edit */
|
|
2
|
+
/* istanbul ignore file */
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
/* eslint-disable */
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* Controls the wallet transaction type.
|
|
8
|
+
*/
|
|
9
|
+
export enum WalletTransactionType {
|
|
10
|
+
TOP_UP = 'TopUp',
|
|
11
|
+
PAYMENT = 'Payment',
|
|
12
|
+
REFUND = 'Refund',
|
|
13
|
+
ADJUSTMENT = 'Adjustment',
|
|
14
|
+
}
|
|
@@ -150,7 +150,6 @@ export class AttendeesService {
|
|
|
150
150
|
* @throws ApiError
|
|
151
151
|
*/
|
|
152
152
|
public getPage({
|
|
153
|
-
venueId,
|
|
154
153
|
customerId,
|
|
155
154
|
firstName,
|
|
156
155
|
lastName,
|
|
@@ -166,10 +165,6 @@ export class AttendeesService {
|
|
|
166
165
|
isLive,
|
|
167
166
|
sortOrderDirection,
|
|
168
167
|
}: {
|
|
169
|
-
/**
|
|
170
|
-
* Gets or sets the queryable venue id.
|
|
171
|
-
*/
|
|
172
|
-
venueId?: string;
|
|
173
168
|
/**
|
|
174
169
|
* Gets or sets the queryable customer id.
|
|
175
170
|
*/
|
|
@@ -231,7 +226,6 @@ export class AttendeesService {
|
|
|
231
226
|
method: 'GET',
|
|
232
227
|
url: '/api/attendees',
|
|
233
228
|
query: {
|
|
234
|
-
VenueId: venueId,
|
|
235
229
|
CustomerId: customerId,
|
|
236
230
|
FirstName: firstName,
|
|
237
231
|
LastName: lastName,
|
|
@@ -342,7 +336,6 @@ export class AttendeesService {
|
|
|
342
336
|
* @throws ApiError
|
|
343
337
|
*/
|
|
344
338
|
public exists({
|
|
345
|
-
venueId,
|
|
346
339
|
customerId,
|
|
347
340
|
firstName,
|
|
348
341
|
lastName,
|
|
@@ -358,10 +351,6 @@ export class AttendeesService {
|
|
|
358
351
|
isLive,
|
|
359
352
|
sortOrderDirection,
|
|
360
353
|
}: {
|
|
361
|
-
/**
|
|
362
|
-
* Gets or sets the queryable venue id.
|
|
363
|
-
*/
|
|
364
|
-
venueId?: string;
|
|
365
354
|
/**
|
|
366
355
|
* Gets or sets the queryable customer id.
|
|
367
356
|
*/
|
|
@@ -423,7 +412,6 @@ export class AttendeesService {
|
|
|
423
412
|
method: 'GET',
|
|
424
413
|
url: '/api/attendees/exists',
|
|
425
414
|
query: {
|
|
426
|
-
VenueId: venueId,
|
|
427
415
|
CustomerId: customerId,
|
|
428
416
|
FirstName: firstName,
|
|
429
417
|
LastName: lastName,
|
|
@@ -453,7 +441,6 @@ export class AttendeesService {
|
|
|
453
441
|
* @throws ApiError
|
|
454
442
|
*/
|
|
455
443
|
public count({
|
|
456
|
-
venueId,
|
|
457
444
|
customerId,
|
|
458
445
|
firstName,
|
|
459
446
|
lastName,
|
|
@@ -469,10 +456,6 @@ export class AttendeesService {
|
|
|
469
456
|
isLive,
|
|
470
457
|
sortOrderDirection,
|
|
471
458
|
}: {
|
|
472
|
-
/**
|
|
473
|
-
* Gets or sets the queryable venue id.
|
|
474
|
-
*/
|
|
475
|
-
venueId?: string;
|
|
476
459
|
/**
|
|
477
460
|
* Gets or sets the queryable customer id.
|
|
478
461
|
*/
|
|
@@ -534,7 +517,6 @@ export class AttendeesService {
|
|
|
534
517
|
method: 'GET',
|
|
535
518
|
url: '/api/attendees/count',
|
|
536
519
|
query: {
|
|
537
|
-
VenueId: venueId,
|
|
538
520
|
CustomerId: customerId,
|
|
539
521
|
FirstName: firstName,
|
|
540
522
|
LastName: lastName,
|
|
@@ -564,7 +546,6 @@ export class AttendeesService {
|
|
|
564
546
|
* @throws ApiError
|
|
565
547
|
*/
|
|
566
548
|
public getListWithoutReferences({
|
|
567
|
-
venueId,
|
|
568
549
|
customerId,
|
|
569
550
|
firstName,
|
|
570
551
|
lastName,
|
|
@@ -580,10 +561,6 @@ export class AttendeesService {
|
|
|
580
561
|
isLive,
|
|
581
562
|
sortOrderDirection,
|
|
582
563
|
}: {
|
|
583
|
-
/**
|
|
584
|
-
* Gets or sets the queryable venue id.
|
|
585
|
-
*/
|
|
586
|
-
venueId?: string;
|
|
587
564
|
/**
|
|
588
565
|
* Gets or sets the queryable customer id.
|
|
589
566
|
*/
|
|
@@ -645,7 +622,6 @@ export class AttendeesService {
|
|
|
645
622
|
method: 'GET',
|
|
646
623
|
url: '/api/attendees/without-references',
|
|
647
624
|
query: {
|
|
648
|
-
VenueId: venueId,
|
|
649
625
|
CustomerId: customerId,
|
|
650
626
|
FirstName: firstName,
|
|
651
627
|
LastName: lastName,
|
|
@@ -675,7 +651,6 @@ export class AttendeesService {
|
|
|
675
651
|
* @throws ApiError
|
|
676
652
|
*/
|
|
677
653
|
public getListIdName({
|
|
678
|
-
venueId,
|
|
679
654
|
customerId,
|
|
680
655
|
firstName,
|
|
681
656
|
lastName,
|
|
@@ -691,10 +666,6 @@ export class AttendeesService {
|
|
|
691
666
|
isLive,
|
|
692
667
|
sortOrderDirection,
|
|
693
668
|
}: {
|
|
694
|
-
/**
|
|
695
|
-
* Gets or sets the queryable venue id.
|
|
696
|
-
*/
|
|
697
|
-
venueId?: string;
|
|
698
669
|
/**
|
|
699
670
|
* Gets or sets the queryable customer id.
|
|
700
671
|
*/
|
|
@@ -756,7 +727,6 @@ export class AttendeesService {
|
|
|
756
727
|
method: 'GET',
|
|
757
728
|
url: '/api/attendees/id-name',
|
|
758
729
|
query: {
|
|
759
|
-
VenueId: venueId,
|
|
760
730
|
CustomerId: customerId,
|
|
761
731
|
FirstName: firstName,
|
|
762
732
|
LastName: lastName,
|
|
@@ -3,6 +3,7 @@
|
|
|
3
3
|
/* tslint:disable */
|
|
4
4
|
/* eslint-disable */
|
|
5
5
|
import type { Customer } from '../models/Customer';
|
|
6
|
+
import type { CustomerAccountInvitePatch } from '../models/CustomerAccountInvitePatch';
|
|
6
7
|
import type { CustomerEmailPatch } from '../models/CustomerEmailPatch';
|
|
7
8
|
import type { CustomerPage } from '../models/CustomerPage';
|
|
8
9
|
import type { CustomerPatch } from '../models/CustomerPatch';
|
|
@@ -49,6 +50,40 @@ export class CustomersService {
|
|
|
49
50
|
});
|
|
50
51
|
}
|
|
51
52
|
|
|
53
|
+
/**
|
|
54
|
+
* Sends an account invite email to the customer with their information, participant details, and wallet balances.
|
|
55
|
+
* @returns any OK
|
|
56
|
+
* @throws ApiError
|
|
57
|
+
*/
|
|
58
|
+
public sendAccountInvite({
|
|
59
|
+
customerId,
|
|
60
|
+
requestBody,
|
|
61
|
+
}: {
|
|
62
|
+
/**
|
|
63
|
+
* The customer Id.
|
|
64
|
+
*/
|
|
65
|
+
customerId: string;
|
|
66
|
+
/**
|
|
67
|
+
* The patch model containing acceptance code and base domain.
|
|
68
|
+
*/
|
|
69
|
+
requestBody?: CustomerAccountInvitePatch;
|
|
70
|
+
}): CancelablePromise<any> {
|
|
71
|
+
return this.httpRequest.request({
|
|
72
|
+
method: 'PATCH',
|
|
73
|
+
url: '/api/customers/{customerId}/send-account-invite',
|
|
74
|
+
path: {
|
|
75
|
+
customerId: customerId,
|
|
76
|
+
},
|
|
77
|
+
body: requestBody,
|
|
78
|
+
mediaType: 'application/json',
|
|
79
|
+
errors: {
|
|
80
|
+
400: `Bad Request`,
|
|
81
|
+
422: `Unprocessable Content`,
|
|
82
|
+
500: `Internal Server Error`,
|
|
83
|
+
},
|
|
84
|
+
});
|
|
85
|
+
}
|
|
86
|
+
|
|
52
87
|
/**
|
|
53
88
|
* Gets the customer with added stats.
|
|
54
89
|
* @returns Customer OK
|