reach-api-sdk 1.0.205 → 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.
Files changed (64) hide show
  1. package/dist/reach-sdk.d.ts +6254 -3934
  2. package/dist/reach-sdk.js +2737 -1127
  3. package/package.json +1 -1
  4. package/src/apiClient.ts +9 -0
  5. package/src/definition/swagger.yaml +9648 -3833
  6. package/src/index.ts +32 -0
  7. package/src/models/Attendee.ts +9 -4
  8. package/src/models/AttendeePatch.ts +13 -0
  9. package/src/models/AttendeePost.ts +14 -1
  10. package/src/models/AttendeeWalletDeductionPreview.ts +51 -0
  11. package/src/models/CoursePatch.ts +2 -0
  12. package/src/models/CoursePost.ts +2 -0
  13. package/src/models/CustomFieldDataType.ts +22 -0
  14. package/src/models/CustomFieldDefinition.ts +100 -0
  15. package/src/models/CustomFieldDefinitionPage.ts +12 -0
  16. package/src/models/CustomFieldDefinitionPatch.ts +84 -0
  17. package/src/models/CustomFieldDefinitionPost.ts +80 -0
  18. package/src/models/CustomFieldDefinitionWithValue.ts +82 -0
  19. package/src/models/CustomFieldOption.ts +50 -0
  20. package/src/models/CustomFieldOptionDto.ts +14 -0
  21. package/src/models/CustomFieldOptionPost.ts +18 -0
  22. package/src/models/CustomFieldValueEntityType.ts +13 -0
  23. package/src/models/CustomFieldValueUpdate.ts +18 -0
  24. package/src/models/CustomFieldsBulkUpdate.ts +16 -0
  25. package/src/models/Customer.ts +6 -6
  26. package/src/models/CustomerAccountInvitePatch.ts +26 -0
  27. package/src/models/CustomerPatch.ts +2 -2
  28. package/src/models/CustomerPost.ts +2 -2
  29. package/src/models/CustomerWalletDeductionPreview.ts +36 -0
  30. package/src/models/EndUserIdentity.ts +4 -0
  31. package/src/models/Order.ts +6 -0
  32. package/src/models/RecentOrderActivityReport.ts +4 -0
  33. package/src/models/SessionPatch.ts +2 -0
  34. package/src/models/SessionPost.ts +2 -0
  35. package/src/models/SurveySubmitAttendee.ts +4 -0
  36. package/src/models/TenantSetting.ts +8 -0
  37. package/src/models/TotalRevenueReport.ts +4 -0
  38. package/src/models/UpdateCustomFieldOption.ts +26 -0
  39. package/src/models/VenuePatch.ts +2 -0
  40. package/src/models/VenuePost.ts +3 -0
  41. package/src/models/Wallet.ts +60 -0
  42. package/src/models/WalletDeductionPreview.ts +44 -0
  43. package/src/models/WalletPage.ts +12 -0
  44. package/src/models/WalletPatch.ts +23 -0
  45. package/src/models/WalletPost.ts +29 -0
  46. package/src/models/WalletRemoveCreditPost.ts +19 -0
  47. package/src/models/WalletTopUpPost.ts +19 -0
  48. package/src/models/WalletTrackingLevel.ts +12 -0
  49. package/src/models/WalletTransaction.ts +61 -0
  50. package/src/models/WalletTransactionPage.ts +12 -0
  51. package/src/models/WalletTransactionPatch.ts +22 -0
  52. package/src/models/WalletTransactionPost.ts +33 -0
  53. package/src/models/WalletTransactionType.ts +14 -0
  54. package/src/services/AttendeesService.ts +0 -30
  55. package/src/services/CoursesService.ts +63 -0
  56. package/src/services/CustomFieldsService.ts +780 -0
  57. package/src/services/CustomersService.ts +35 -0
  58. package/src/services/PublicCoursesService.ts +36 -0
  59. package/src/services/PublicSessionsService.ts +36 -0
  60. package/src/services/PublicVenuesService.ts +36 -0
  61. package/src/services/SessionsService.ts +63 -0
  62. package/src/services/VenuesService.ts +63 -0
  63. package/src/services/WalletTransactionsService.ts +755 -0
  64. package/src/services/WalletsService.ts +901 -0
package/src/index.ts CHANGED
@@ -26,6 +26,7 @@ export type { Attendee } from './models/Attendee';
26
26
  export type { AttendeePage } from './models/AttendeePage';
27
27
  export type { AttendeePatch } from './models/AttendeePatch';
28
28
  export type { AttendeePost } from './models/AttendeePost';
29
+ export type { AttendeeWalletDeductionPreview } from './models/AttendeeWalletDeductionPreview';
29
30
  export type { AutoCompleteResponseModel } from './models/AutoCompleteResponseModel';
30
31
  export { AvailabilityIndicator } from './models/AvailabilityIndicator';
31
32
  export { BookingStatus } from './models/BookingStatus';
@@ -68,6 +69,7 @@ export type { CreateVenue } from './models/CreateVenue';
68
69
  export { CustomDateRange } from './models/CustomDateRange';
69
70
  export type { CustomDateRangeOption } from './models/CustomDateRangeOption';
70
71
  export type { Customer } from './models/Customer';
72
+ export type { CustomerAccountInvitePatch } from './models/CustomerAccountInvitePatch';
71
73
  export { CustomerCancellationOption } from './models/CustomerCancellationOption';
72
74
  export type { CustomerEmailPatch } from './models/CustomerEmailPatch';
73
75
  export type { CustomerPage } from './models/CustomerPage';
@@ -75,6 +77,19 @@ export type { CustomerPatch } from './models/CustomerPatch';
75
77
  export type { CustomerPost } from './models/CustomerPost';
76
78
  export type { CustomerStats } from './models/CustomerStats';
77
79
  export { CustomerType } from './models/CustomerType';
80
+ export type { CustomerWalletDeductionPreview } from './models/CustomerWalletDeductionPreview';
81
+ export { CustomFieldDataType } from './models/CustomFieldDataType';
82
+ export type { CustomFieldDefinition } from './models/CustomFieldDefinition';
83
+ export type { CustomFieldDefinitionPage } from './models/CustomFieldDefinitionPage';
84
+ export type { CustomFieldDefinitionPatch } from './models/CustomFieldDefinitionPatch';
85
+ export type { CustomFieldDefinitionPost } from './models/CustomFieldDefinitionPost';
86
+ export type { CustomFieldDefinitionWithValue } from './models/CustomFieldDefinitionWithValue';
87
+ export type { CustomFieldOption } from './models/CustomFieldOption';
88
+ export type { CustomFieldOptionDto } from './models/CustomFieldOptionDto';
89
+ export type { CustomFieldOptionPost } from './models/CustomFieldOptionPost';
90
+ export type { CustomFieldsBulkUpdate } from './models/CustomFieldsBulkUpdate';
91
+ export { CustomFieldValueEntityType } from './models/CustomFieldValueEntityType';
92
+ export type { CustomFieldValueUpdate } from './models/CustomFieldValueUpdate';
78
93
  export type { DatabaseState } from './models/DatabaseState';
79
94
  export { DayOfWeek } from './models/DayOfWeek';
80
95
  export type { Deal } from './models/Deal';
@@ -391,6 +406,7 @@ export type { TotalRevenueReportPatch } from './models/TotalRevenueReportPatch';
391
406
  export type { TotalRevenueReportPost } from './models/TotalRevenueReportPost';
392
407
  export type { UnsplashSearchResponse } from './models/UnsplashSearchResponse';
393
408
  export { UpcomingLayout } from './models/UpcomingLayout';
409
+ export type { UpdateCustomFieldOption } from './models/UpdateCustomFieldOption';
394
410
  export type { UpdateEmailSettings } from './models/UpdateEmailSettings';
395
411
  export type { UpdateOffer } from './models/UpdateOffer';
396
412
  export type { User } from './models/User';
@@ -456,6 +472,19 @@ export type { WaitlistOpportunityReport } from './models/WaitlistOpportunityRepo
456
472
  export type { WaitlistOpportunityReportPage } from './models/WaitlistOpportunityReportPage';
457
473
  export type { WaitlistOpportunityReportPatch } from './models/WaitlistOpportunityReportPatch';
458
474
  export type { WaitlistOpportunityReportPost } from './models/WaitlistOpportunityReportPost';
475
+ export type { Wallet } from './models/Wallet';
476
+ export type { WalletDeductionPreview } from './models/WalletDeductionPreview';
477
+ export type { WalletPage } from './models/WalletPage';
478
+ export type { WalletPatch } from './models/WalletPatch';
479
+ export type { WalletPost } from './models/WalletPost';
480
+ export type { WalletRemoveCreditPost } from './models/WalletRemoveCreditPost';
481
+ export type { WalletTopUpPost } from './models/WalletTopUpPost';
482
+ export { WalletTrackingLevel } from './models/WalletTrackingLevel';
483
+ export type { WalletTransaction } from './models/WalletTransaction';
484
+ export type { WalletTransactionPage } from './models/WalletTransactionPage';
485
+ export type { WalletTransactionPatch } from './models/WalletTransactionPatch';
486
+ export type { WalletTransactionPost } from './models/WalletTransactionPost';
487
+ export { WalletTransactionType } from './models/WalletTransactionType';
459
488
 
460
489
  export { ActivityService } from './services/ActivityService';
461
490
  export { ActivityPerformanceService } from './services/ActivityPerformanceService';
@@ -470,6 +499,7 @@ export { CoursesService } from './services/CoursesService';
470
499
  export { CourseSessionsService } from './services/CourseSessionsService';
471
500
  export { CourseSessionSchedulesService } from './services/CourseSessionSchedulesService';
472
501
  export { CustomersService } from './services/CustomersService';
502
+ export { CustomFieldsService } from './services/CustomFieldsService';
473
503
  export { DealActivitiesService } from './services/DealActivitiesService';
474
504
  export { DealsService } from './services/DealsService';
475
505
  export { DiscountCodeUsesService } from './services/DiscountCodeUsesService';
@@ -576,3 +606,5 @@ export { WaitlistActivityService } from './services/WaitlistActivityService';
576
606
  export { WaitlistActivityReportService } from './services/WaitlistActivityReportService';
577
607
  export { WaitlistOpportunityService } from './services/WaitlistOpportunityService';
578
608
  export { WaitlistOpportunityReportService } from './services/WaitlistOpportunityReportService';
609
+ export { WalletsService } from './services/WalletsService';
610
+ export { WalletTransactionsService } from './services/WalletTransactionsService';
@@ -3,6 +3,9 @@
3
3
  /* tslint:disable */
4
4
  /* eslint-disable */
5
5
 
6
+ import type { EndUserIdentity } from './EndUserIdentity';
7
+ import type { Wallet } from './Wallet';
8
+
6
9
  /**
7
10
  * Represents a Attendee within the Reach application.
8
11
  */
@@ -31,14 +34,14 @@ export type Attendee = {
31
34
  * Gets or sets a value indicating whether the record is live and available for use within the application.
32
35
  */
33
36
  isLive: boolean;
34
- /**
35
- * Gets or sets the venue id.
36
- */
37
- venueId: string;
38
37
  /**
39
38
  * Gets or sets the customer id.
40
39
  */
41
40
  customerId: string;
41
+ /**
42
+ * Gets or sets the end user identity id.
43
+ */
44
+ endUserIdentityId?: string | null;
42
45
  /**
43
46
  * Gets or sets the first name.
44
47
  */
@@ -55,4 +58,6 @@ export type Attendee = {
55
58
  * Gets the attendees full name.
56
59
  */
57
60
  readonly fullName?: string | null;
61
+ wallet?: Wallet;
62
+ endUserIdentity?: EndUserIdentity;
58
63
  };
@@ -15,4 +15,17 @@ export type AttendeePatch = {
15
15
  * Gets or sets the Id.
16
16
  */
17
17
  id: string;
18
+ /**
19
+ * Gets or sets the attendee first name.
20
+ */
21
+ firstName?: string | null;
22
+ /**
23
+ * Gets or sets the attendee last name.
24
+ */
25
+ lastName?: string | null;
26
+ /**
27
+ * Gets or sets the attendee date of birth.
28
+ * This updates the linked end_user_identity record, not the attendee directly.
29
+ */
30
+ dateOfBirth?: string | null;
18
31
  };
@@ -20,7 +20,20 @@ export type AttendeePost = {
20
20
  */
21
21
  lastName: string;
22
22
  /**
23
- * Gets or sets the attendee last name.
23
+ * Gets or sets the customer id that the attendee belongs to.
24
24
  */
25
25
  customerId: string;
26
+ /**
27
+ * Gets or sets the initial wallet balance for the attendee.
28
+ * This is only applicable when wallet tracking level is set to Attendee.
29
+ * When wallet tracking level is Attendee, a wallet is always created for the attendee.
30
+ * If InitialWalletBalance is provided and greater than 0, the wallet will be topped up with this amount.
31
+ * If not provided or set to 0, the wallet will be created with a balance of 0.
32
+ */
33
+ initialWalletBalance?: number | null;
34
+ /**
35
+ * Gets or sets the attendee date of birth.
36
+ * This is used to resolve or create the linked end_user_identity record for person-level identity tracking.
37
+ */
38
+ dateOfBirth?: string | null;
26
39
  };
@@ -0,0 +1,51 @@
1
+ /* generated using openapi-typescript-codegen -- do no edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+
6
+ import type { Attendee } from './Attendee';
7
+
8
+ /**
9
+ * Represents attendee-level wallet deduction preview information.
10
+ */
11
+ export type AttendeeWalletDeductionPreview = {
12
+ /**
13
+ * Gets or sets the attendee id.
14
+ */
15
+ attendeeId?: string;
16
+ attendee?: Attendee;
17
+ /**
18
+ * Gets or sets the attendee's first name.
19
+ */
20
+ firstName?: string | null;
21
+ /**
22
+ * Gets or sets the attendee's last name.
23
+ */
24
+ lastName?: string | null;
25
+ /**
26
+ * Gets or sets the attendee's current wallet balance.
27
+ */
28
+ currentBalance?: number;
29
+ /**
30
+ * Gets or sets the amount that will be deducted from the attendee's wallet.
31
+ */
32
+ amountToDeduct?: number;
33
+ /**
34
+ * Gets or sets the wallet balance after deduction.
35
+ */
36
+ balanceAfterDeduction?: number;
37
+ /**
38
+ * Gets or sets the attendee's payment amount (their portion of the order total).
39
+ */
40
+ paymentAmount?: number;
41
+ /**
42
+ * Gets or sets a value indicating whether this attendee's wallet balance is sufficient to cover their payment amount.
43
+ * This is only relevant when wallet-only payments are enabled.
44
+ */
45
+ isWalletBalanceSufficient?: boolean;
46
+ /**
47
+ * Gets or sets a value indicating whether this attendee's portion of the order can be processed based on wallet-only payment requirements.
48
+ * Returns false if wallet-only payments are enabled and this attendee's wallet balance is insufficient.
49
+ */
50
+ canProcessAttendeeOrder?: boolean;
51
+ };
@@ -5,6 +5,7 @@
5
5
 
6
6
  import type { CheckoutPlatform } from './CheckoutPlatform';
7
7
  import type { CourseBookingCutoff } from './CourseBookingCutoff';
8
+ import type { CustomFieldsBulkUpdate } from './CustomFieldsBulkUpdate';
8
9
  import type { Gender } from './Gender';
9
10
  import type { UpdateEmailSettings } from './UpdateEmailSettings';
10
11
  import type { UpdateOffer } from './UpdateOffer';
@@ -157,4 +158,5 @@ export type CoursePatch = {
157
158
  * Gets or sets the course offers.
158
159
  */
159
160
  offers?: Array<UpdateOffer> | null;
161
+ customFields?: CustomFieldsBulkUpdate;
160
162
  };
@@ -3,6 +3,7 @@
3
3
  /* tslint:disable */
4
4
  /* eslint-disable */
5
5
 
6
+ import type { CustomFieldsBulkUpdate } from './CustomFieldsBulkUpdate';
6
7
  import type { UpdateEmailSettings } from './UpdateEmailSettings';
7
8
 
8
9
  /**
@@ -14,4 +15,5 @@ export type CoursePost = {
14
15
  */
15
16
  tenantId: string;
16
17
  emailSettings?: UpdateEmailSettings;
18
+ customFields?: CustomFieldsBulkUpdate;
17
19
  };
@@ -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
+ * Controls the data type for custom field definitions.
8
+ */
9
+ export enum CustomFieldDataType {
10
+ TEXT = 'Text',
11
+ MULTI_LINE_TEXT = 'MultiLineText',
12
+ NUMBER = 'Number',
13
+ DECIMAL = 'Decimal',
14
+ BOOL = 'Bool',
15
+ DATE = 'Date',
16
+ DATE_TIME = 'DateTime',
17
+ URL = 'Url',
18
+ EMAIL = 'Email',
19
+ PHONE = 'Phone',
20
+ SINGLE_SELECT = 'SingleSelect',
21
+ MULTI_SELECT = 'MultiSelect',
22
+ }
@@ -0,0 +1,100 @@
1
+ /* generated using openapi-typescript-codegen -- do no edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+
6
+ import type { CustomFieldDataType } from './CustomFieldDataType';
7
+ import type { CustomFieldOption } from './CustomFieldOption';
8
+ import type { CustomFieldValueEntityType } from './CustomFieldValueEntityType';
9
+
10
+ /**
11
+ * Represents a custom field definition within the Reach application.
12
+ */
13
+ export type CustomFieldDefinition = {
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
+ entityType?: CustomFieldValueEntityType;
39
+ /**
40
+ * Gets or sets the custom field label.
41
+ */
42
+ label?: string | null;
43
+ /**
44
+ * Gets or sets the custom field description.
45
+ */
46
+ description?: string | null;
47
+ dataType?: CustomFieldDataType;
48
+ /**
49
+ * Gets or sets a value indicating whether the field is required.
50
+ */
51
+ required?: boolean | null;
52
+ /**
53
+ * Gets or sets a value indicating whether the field has public visibility.
54
+ */
55
+ publicVisibility?: boolean | null;
56
+ /**
57
+ * Gets or sets the display order.
58
+ */
59
+ displayOrder?: number | null;
60
+ /**
61
+ * Gets or sets a value indicating whether the field is archived.
62
+ */
63
+ archived?: boolean | null;
64
+ /**
65
+ * Gets or sets the validation JSON (min/max/regex etc).
66
+ */
67
+ validationJson?: string | null;
68
+ /**
69
+ * Gets or sets the default text value.
70
+ */
71
+ defaultValueText?: string | null;
72
+ /**
73
+ * Gets or sets the default number value.
74
+ */
75
+ defaultValueNumber?: number | null;
76
+ /**
77
+ * Gets or sets the default decimal value.
78
+ */
79
+ defaultValueDecimal?: number | null;
80
+ /**
81
+ * Gets or sets the default bit value.
82
+ */
83
+ defaultValueBit?: boolean | null;
84
+ /**
85
+ * Gets or sets the default date value.
86
+ */
87
+ defaultValueDate?: string | null;
88
+ /**
89
+ * Gets or sets the default datetimeoffset value.
90
+ */
91
+ defaultValueDatetimeoffset?: string | null;
92
+ /**
93
+ * Gets or sets the default JSON value.
94
+ */
95
+ defaultValueJson?: string | null;
96
+ /**
97
+ * Gets or sets the options for this custom field definition.
98
+ */
99
+ options?: Array<CustomFieldOption> | null;
100
+ };
@@ -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 { CustomFieldDefinition } from './CustomFieldDefinition';
7
+ import type { Pagination } from './Pagination';
8
+
9
+ export type CustomFieldDefinitionPage = {
10
+ pagination: Pagination;
11
+ readonly items: Array<CustomFieldDefinition>;
12
+ };
@@ -0,0 +1,84 @@
1
+ /* generated using openapi-typescript-codegen -- do no edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+
6
+ import type { CustomFieldDataType } from './CustomFieldDataType';
7
+ import type { CustomFieldValueEntityType } from './CustomFieldValueEntityType';
8
+ import type { UpdateCustomFieldOption } from './UpdateCustomFieldOption';
9
+
10
+ /**
11
+ * Patch model for the custom field definition.
12
+ */
13
+ export type CustomFieldDefinitionPatch = {
14
+ /**
15
+ * Gets or sets the tenant Id.
16
+ */
17
+ tenantId: string;
18
+ /**
19
+ * Gets or sets the Id.
20
+ */
21
+ id: string;
22
+ entityType?: CustomFieldValueEntityType;
23
+ /**
24
+ * Gets or sets the custom field label.
25
+ */
26
+ label?: string | null;
27
+ /**
28
+ * Gets or sets the custom field description.
29
+ */
30
+ description?: string | null;
31
+ dataType?: CustomFieldDataType;
32
+ /**
33
+ * Gets or sets a value indicating whether the field is required.
34
+ */
35
+ required?: boolean | null;
36
+ /**
37
+ * Gets or sets a value indicating whether the field has public visibility.
38
+ */
39
+ publicVisibility?: boolean | null;
40
+ /**
41
+ * Gets or sets the display order.
42
+ */
43
+ displayOrder?: number | null;
44
+ /**
45
+ * Gets or sets the validation JSON.
46
+ */
47
+ validationJson?: string | null;
48
+ /**
49
+ * Gets or sets the default text value.
50
+ */
51
+ defaultValueText?: string | null;
52
+ /**
53
+ * Gets or sets the default number value.
54
+ */
55
+ defaultValueNumber?: number | null;
56
+ /**
57
+ * Gets or sets the default decimal value.
58
+ */
59
+ defaultValueDecimal?: number | null;
60
+ /**
61
+ * Gets or sets the default bit value.
62
+ */
63
+ defaultValueBit?: boolean | null;
64
+ /**
65
+ * Gets or sets the default date value.
66
+ */
67
+ defaultValueDate?: string | null;
68
+ /**
69
+ * Gets or sets the default datetimeoffset value.
70
+ */
71
+ defaultValueDatetimeoffset?: string | null;
72
+ /**
73
+ * Gets or sets the default JSON value.
74
+ */
75
+ defaultValueJson?: string | null;
76
+ /**
77
+ * Gets or sets a value indicating whether the field is archived.
78
+ */
79
+ archived?: boolean | null;
80
+ /**
81
+ * Gets or sets the custom field options.
82
+ */
83
+ options?: Array<UpdateCustomFieldOption> | null;
84
+ };
@@ -0,0 +1,80 @@
1
+ /* generated using openapi-typescript-codegen -- do no edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+
6
+ import type { CustomFieldDataType } from './CustomFieldDataType';
7
+ import type { CustomFieldOptionPost } from './CustomFieldOptionPost';
8
+ import type { CustomFieldValueEntityType } from './CustomFieldValueEntityType';
9
+
10
+ /**
11
+ * Post model for the custom field definition.
12
+ */
13
+ export type CustomFieldDefinitionPost = {
14
+ /**
15
+ * Gets or sets the tenant Id.
16
+ */
17
+ tenantId: string;
18
+ entityType?: CustomFieldValueEntityType;
19
+ /**
20
+ * Gets or sets the custom field label.
21
+ */
22
+ label?: string | null;
23
+ /**
24
+ * Gets or sets the custom field description.
25
+ */
26
+ description?: string | null;
27
+ dataType?: CustomFieldDataType;
28
+ /**
29
+ * Gets or sets a value indicating whether the field is required.
30
+ */
31
+ required?: boolean | null;
32
+ /**
33
+ * Gets or sets a value indicating whether the field has public visibility.
34
+ */
35
+ publicVisibility?: boolean | null;
36
+ /**
37
+ * Gets or sets the display order.
38
+ */
39
+ displayOrder?: number | null;
40
+ /**
41
+ * Gets or sets the validation JSON.
42
+ */
43
+ validationJson?: string | null;
44
+ /**
45
+ * Gets or sets the default text value.
46
+ */
47
+ defaultValueText?: string | null;
48
+ /**
49
+ * Gets or sets the default number value.
50
+ */
51
+ defaultValueNumber?: number | null;
52
+ /**
53
+ * Gets or sets the default decimal value.
54
+ */
55
+ defaultValueDecimal?: number | null;
56
+ /**
57
+ * Gets or sets the default bit value.
58
+ */
59
+ defaultValueBit?: boolean | null;
60
+ /**
61
+ * Gets or sets the default date value.
62
+ */
63
+ defaultValueDate?: string | null;
64
+ /**
65
+ * Gets or sets the default datetimeoffset value.
66
+ */
67
+ defaultValueDatetimeoffset?: string | null;
68
+ /**
69
+ * Gets or sets the default JSON value.
70
+ */
71
+ defaultValueJson?: string | null;
72
+ /**
73
+ * Gets or sets the options for select types.
74
+ */
75
+ options?: Array<CustomFieldOptionPost> | null;
76
+ /**
77
+ * Gets or sets a value indicating whether the field is archived.
78
+ */
79
+ archived?: boolean | null;
80
+ };
@@ -0,0 +1,82 @@
1
+ /* generated using openapi-typescript-codegen -- do no edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+
6
+ import type { CustomFieldDataType } from './CustomFieldDataType';
7
+ import type { CustomFieldOptionDto } from './CustomFieldOptionDto';
8
+
9
+ /**
10
+ * Represents a custom field definition with its current value for editing.
11
+ */
12
+ export type CustomFieldDefinitionWithValue = {
13
+ /**
14
+ * Gets or sets the tenant id.
15
+ */
16
+ tenantId?: string;
17
+ /**
18
+ * Gets or sets the definition id.
19
+ */
20
+ definitionId?: string | null;
21
+ /**
22
+ * Gets or sets the custom field label.
23
+ */
24
+ label?: string | null;
25
+ /**
26
+ * Gets or sets the custom field description.
27
+ */
28
+ description?: string | null;
29
+ dataType?: CustomFieldDataType;
30
+ /**
31
+ * Gets or sets a value indicating whether the field is required.
32
+ */
33
+ required?: boolean | null;
34
+ /**
35
+ * Gets or sets a value indicating whether the field has public visibility.
36
+ */
37
+ publicVisibility?: boolean | null;
38
+ /**
39
+ * Gets or sets the display order.
40
+ */
41
+ displayOrder?: number | null;
42
+ /**
43
+ * Gets or sets the validation JSON.
44
+ */
45
+ validationJson?: string | null;
46
+ /**
47
+ * Gets or sets the default text value.
48
+ */
49
+ defaultValueText?: string | null;
50
+ /**
51
+ * Gets or sets the default number value.
52
+ */
53
+ defaultValueNumber?: number | null;
54
+ /**
55
+ * Gets or sets the default decimal value.
56
+ */
57
+ defaultValueDecimal?: number | null;
58
+ /**
59
+ * Gets or sets the default bit value.
60
+ */
61
+ defaultValueBit?: boolean | null;
62
+ /**
63
+ * Gets or sets the default date value.
64
+ */
65
+ defaultValueDate?: string | null;
66
+ /**
67
+ * Gets or sets the default datetimeoffset value.
68
+ */
69
+ defaultValueDatetimeoffset?: string | null;
70
+ /**
71
+ * Gets or sets the default JSON value.
72
+ */
73
+ defaultValueJson?: string | null;
74
+ /**
75
+ * Gets or sets the options for select types.
76
+ */
77
+ options?: Array<CustomFieldOptionDto> | null;
78
+ /**
79
+ * Gets or sets the current value (can be text, number, decimal, bit, date, datetimeoffset, or json).
80
+ */
81
+ value?: any;
82
+ };
@@ -0,0 +1,50 @@
1
+ /* generated using openapi-typescript-codegen -- do no edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+
6
+ /**
7
+ * Represents a custom field option within the Reach application.
8
+ */
9
+ export type CustomFieldOption = {
10
+ /**
11
+ * Gets or sets the entities Id.
12
+ */
13
+ id?: string;
14
+ /**
15
+ * Gets or sets the tenant Id.
16
+ */
17
+ tenantId: string;
18
+ /**
19
+ * Gets or sets the created date of this entity.
20
+ */
21
+ dateCreated: string;
22
+ /**
23
+ * Gets or sets the last modified date of this entity.
24
+ */
25
+ dateModified: string;
26
+ /**
27
+ * Gets or sets the modified by Id.
28
+ */
29
+ modifiedById?: string | null;
30
+ /**
31
+ * Gets or sets a value indicating whether the record is live and available for use within the application.
32
+ */
33
+ isLive: boolean;
34
+ /**
35
+ * Gets or sets the custom field definition id.
36
+ */
37
+ customFieldDefinitionId?: string | null;
38
+ /**
39
+ * Gets or sets the option label.
40
+ */
41
+ label?: string | null;
42
+ /**
43
+ * Gets or sets the display order.
44
+ */
45
+ displayOrder?: number | null;
46
+ /**
47
+ * Gets or sets a value indicating whether the option is archived.
48
+ */
49
+ archived?: boolean | null;
50
+ };
@@ -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
+ * Represents a custom field option DTO.
8
+ */
9
+ export type CustomFieldOptionDto = {
10
+ /**
11
+ * Gets or sets the option label.
12
+ */
13
+ label?: string | null;
14
+ };