reach-api-sdk 1.0.228 → 1.0.229

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.
@@ -6321,6 +6321,10 @@ type Attendee = {
6321
6321
  * Gets or sets the last name.
6322
6322
  */
6323
6323
  lastName: string;
6324
+ /**
6325
+ * Gets or sets the tenant-scoped external reference for integration with external systems.
6326
+ */
6327
+ externalReference?: string | null;
6324
6328
  /**
6325
6329
  * Gets the attendees abbreviated name.
6326
6330
  */
@@ -6364,6 +6368,11 @@ type AttendeePatch = {
6364
6368
  * patch fields are applied to that record as well as to the attendee row where applicable.
6365
6369
  */
6366
6370
  dateOfBirth?: string | null;
6371
+ /**
6372
+ * Gets or sets the tenant-scoped external reference for integration with external systems.
6373
+ * Only applicable when enable_attendee_external_reference is enabled for the tenant.
6374
+ */
6375
+ externalReference?: string | null;
6367
6376
  };
6368
6377
 
6369
6378
  /**
@@ -6416,6 +6425,11 @@ type AttendeePost = {
6416
6425
  * This is used to resolve or create the linked end_user_identity record for person-level identity tracking.
6417
6426
  */
6418
6427
  dateOfBirth?: string | null;
6428
+ /**
6429
+ * Gets or sets the tenant-scoped external reference for integration with external systems.
6430
+ * Only applicable when enable_attendee_external_reference is enabled for the tenant.
6431
+ */
6432
+ externalReference?: string | null;
6419
6433
  };
6420
6434
 
6421
6435
  declare class AttendeesService {
@@ -6481,7 +6495,7 @@ declare class AttendeesService {
6481
6495
  * @returns AttendeePage OK
6482
6496
  * @throws ApiError
6483
6497
  */
6484
- getPage({ customerId, firstName, lastName, pageNumber, take, skip, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
6498
+ getPage({ customerId, firstName, lastName, externalReference, pageNumber, take, skip, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
6485
6499
  /**
6486
6500
  * Gets or sets the queryable customer id.
6487
6501
  */
@@ -6494,6 +6508,10 @@ declare class AttendeesService {
6494
6508
  * Gets or sets the queryable attendee last name.
6495
6509
  */
6496
6510
  lastName?: string;
6511
+ /**
6512
+ * Gets or sets the queryable attendee external reference.
6513
+ */
6514
+ externalReference?: string;
6497
6515
  /**
6498
6516
  * Gets or sets the page number for paged queries.
6499
6517
  */
@@ -6577,7 +6595,7 @@ declare class AttendeesService {
6577
6595
  * @returns boolean OK
6578
6596
  * @throws ApiError
6579
6597
  */
6580
- exists({ customerId, firstName, lastName, pageNumber, take, skip, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
6598
+ exists({ customerId, firstName, lastName, externalReference, pageNumber, take, skip, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
6581
6599
  /**
6582
6600
  * Gets or sets the queryable customer id.
6583
6601
  */
@@ -6590,6 +6608,10 @@ declare class AttendeesService {
6590
6608
  * Gets or sets the queryable attendee last name.
6591
6609
  */
6592
6610
  lastName?: string;
6611
+ /**
6612
+ * Gets or sets the queryable attendee external reference.
6613
+ */
6614
+ externalReference?: string;
6593
6615
  /**
6594
6616
  * Gets or sets the page number for paged queries.
6595
6617
  */
@@ -6640,7 +6662,7 @@ declare class AttendeesService {
6640
6662
  * @returns number OK
6641
6663
  * @throws ApiError
6642
6664
  */
6643
- count({ customerId, firstName, lastName, pageNumber, take, skip, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
6665
+ count({ customerId, firstName, lastName, externalReference, pageNumber, take, skip, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
6644
6666
  /**
6645
6667
  * Gets or sets the queryable customer id.
6646
6668
  */
@@ -6653,6 +6675,10 @@ declare class AttendeesService {
6653
6675
  * Gets or sets the queryable attendee last name.
6654
6676
  */
6655
6677
  lastName?: string;
6678
+ /**
6679
+ * Gets or sets the queryable attendee external reference.
6680
+ */
6681
+ externalReference?: string;
6656
6682
  /**
6657
6683
  * Gets or sets the page number for paged queries.
6658
6684
  */
@@ -6703,7 +6729,7 @@ declare class AttendeesService {
6703
6729
  * @returns Attendee OK
6704
6730
  * @throws ApiError
6705
6731
  */
6706
- getListWithoutReferences({ customerId, firstName, lastName, pageNumber, take, skip, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
6732
+ getListWithoutReferences({ customerId, firstName, lastName, externalReference, pageNumber, take, skip, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
6707
6733
  /**
6708
6734
  * Gets or sets the queryable customer id.
6709
6735
  */
@@ -6716,6 +6742,10 @@ declare class AttendeesService {
6716
6742
  * Gets or sets the queryable attendee last name.
6717
6743
  */
6718
6744
  lastName?: string;
6745
+ /**
6746
+ * Gets or sets the queryable attendee external reference.
6747
+ */
6748
+ externalReference?: string;
6719
6749
  /**
6720
6750
  * Gets or sets the page number for paged queries.
6721
6751
  */
@@ -6766,7 +6796,7 @@ declare class AttendeesService {
6766
6796
  * @returns Attendee OK
6767
6797
  * @throws ApiError
6768
6798
  */
6769
- getListIdName({ customerId, firstName, lastName, pageNumber, take, skip, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
6799
+ getListIdName({ customerId, firstName, lastName, externalReference, pageNumber, take, skip, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
6770
6800
  /**
6771
6801
  * Gets or sets the queryable customer id.
6772
6802
  */
@@ -6779,6 +6809,10 @@ declare class AttendeesService {
6779
6809
  * Gets or sets the queryable attendee last name.
6780
6810
  */
6781
6811
  lastName?: string;
6812
+ /**
6813
+ * Gets or sets the queryable attendee external reference.
6814
+ */
6815
+ externalReference?: string;
6782
6816
  /**
6783
6817
  * Gets or sets the page number for paged queries.
6784
6818
  */
@@ -46506,6 +46540,18 @@ type TenantSetting = {
46506
46540
  * When false (default), storefronts should hide WorkOS sign-in; use for phased rollout per tenant.
46507
46541
  */
46508
46542
  customerPortalWorkOsLoginEnabled?: boolean;
46543
+ /**
46544
+ * Gets or sets a value indicating whether attendee external references are enabled for the tenant.
46545
+ */
46546
+ enableAttendeeExternalReference?: boolean;
46547
+ /**
46548
+ * Gets or sets a value indicating whether external_reference is required when creating attendees.
46549
+ */
46550
+ requireAttendeeExternalReference?: boolean;
46551
+ /**
46552
+ * Gets or sets the label shown for the attendee external reference field in partner UI.
46553
+ */
46554
+ attendeeExternalReferenceLabel?: string | null;
46509
46555
  /**
46510
46556
  * Gets the next order number in the sequence.
46511
46557
  */
package/dist/reach-sdk.js CHANGED
@@ -1598,6 +1598,7 @@ const request = (config, options, axiosClient = axios) => {
1598
1598
  customerId,
1599
1599
  firstName,
1600
1600
  lastName,
1601
+ externalReference,
1601
1602
  pageNumber,
1602
1603
  take,
1603
1604
  skip,
@@ -1617,6 +1618,7 @@ const request = (config, options, axiosClient = axios) => {
1617
1618
  CustomerId: customerId,
1618
1619
  FirstName: firstName,
1619
1620
  LastName: lastName,
1621
+ ExternalReference: externalReference,
1620
1622
  PageNumber: pageNumber,
1621
1623
  Take: take,
1622
1624
  Skip: skip,
@@ -1708,6 +1710,7 @@ const request = (config, options, axiosClient = axios) => {
1708
1710
  customerId,
1709
1711
  firstName,
1710
1712
  lastName,
1713
+ externalReference,
1711
1714
  pageNumber,
1712
1715
  take,
1713
1716
  skip,
@@ -1727,6 +1730,7 @@ const request = (config, options, axiosClient = axios) => {
1727
1730
  CustomerId: customerId,
1728
1731
  FirstName: firstName,
1729
1732
  LastName: lastName,
1733
+ ExternalReference: externalReference,
1730
1734
  PageNumber: pageNumber,
1731
1735
  Take: take,
1732
1736
  Skip: skip,
@@ -1755,6 +1759,7 @@ const request = (config, options, axiosClient = axios) => {
1755
1759
  customerId,
1756
1760
  firstName,
1757
1761
  lastName,
1762
+ externalReference,
1758
1763
  pageNumber,
1759
1764
  take,
1760
1765
  skip,
@@ -1774,6 +1779,7 @@ const request = (config, options, axiosClient = axios) => {
1774
1779
  CustomerId: customerId,
1775
1780
  FirstName: firstName,
1776
1781
  LastName: lastName,
1782
+ ExternalReference: externalReference,
1777
1783
  PageNumber: pageNumber,
1778
1784
  Take: take,
1779
1785
  Skip: skip,
@@ -1802,6 +1808,7 @@ const request = (config, options, axiosClient = axios) => {
1802
1808
  customerId,
1803
1809
  firstName,
1804
1810
  lastName,
1811
+ externalReference,
1805
1812
  pageNumber,
1806
1813
  take,
1807
1814
  skip,
@@ -1821,6 +1828,7 @@ const request = (config, options, axiosClient = axios) => {
1821
1828
  CustomerId: customerId,
1822
1829
  FirstName: firstName,
1823
1830
  LastName: lastName,
1831
+ ExternalReference: externalReference,
1824
1832
  PageNumber: pageNumber,
1825
1833
  Take: take,
1826
1834
  Skip: skip,
@@ -1849,6 +1857,7 @@ const request = (config, options, axiosClient = axios) => {
1849
1857
  customerId,
1850
1858
  firstName,
1851
1859
  lastName,
1860
+ externalReference,
1852
1861
  pageNumber,
1853
1862
  take,
1854
1863
  skip,
@@ -1868,6 +1877,7 @@ const request = (config, options, axiosClient = axios) => {
1868
1877
  CustomerId: customerId,
1869
1878
  FirstName: firstName,
1870
1879
  LastName: lastName,
1880
+ ExternalReference: externalReference,
1871
1881
  PageNumber: pageNumber,
1872
1882
  Take: take,
1873
1883
  Skip: skip,
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "reach-api-sdk",
3
- "version": "1.0.228",
3
+ "version": "1.0.229",
4
4
  "description": "sdk for reach api",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -3745,6 +3745,11 @@ paths:
3745
3745
  description: Gets or sets the queryable attendee last name.
3746
3746
  schema:
3747
3747
  type: string
3748
+ - name: ExternalReference
3749
+ in: query
3750
+ description: Gets or sets the queryable attendee external reference.
3751
+ schema:
3752
+ type: string
3748
3753
  - name: PageNumber
3749
3754
  in: query
3750
3755
  description: Gets or sets the page number for paged queries.
@@ -4060,6 +4065,11 @@ paths:
4060
4065
  description: Gets or sets the queryable attendee last name.
4061
4066
  schema:
4062
4067
  type: string
4068
+ - name: ExternalReference
4069
+ in: query
4070
+ description: Gets or sets the queryable attendee external reference.
4071
+ schema:
4072
+ type: string
4063
4073
  - name: PageNumber
4064
4074
  in: query
4065
4075
  description: Gets or sets the page number for paged queries.
@@ -4197,6 +4207,11 @@ paths:
4197
4207
  description: Gets or sets the queryable attendee last name.
4198
4208
  schema:
4199
4209
  type: string
4210
+ - name: ExternalReference
4211
+ in: query
4212
+ description: Gets or sets the queryable attendee external reference.
4213
+ schema:
4214
+ type: string
4200
4215
  - name: PageNumber
4201
4216
  in: query
4202
4217
  description: Gets or sets the page number for paged queries.
@@ -4337,6 +4352,11 @@ paths:
4337
4352
  description: Gets or sets the queryable attendee last name.
4338
4353
  schema:
4339
4354
  type: string
4355
+ - name: ExternalReference
4356
+ in: query
4357
+ description: Gets or sets the queryable attendee external reference.
4358
+ schema:
4359
+ type: string
4340
4360
  - name: PageNumber
4341
4361
  in: query
4342
4362
  description: Gets or sets the page number for paged queries.
@@ -4480,6 +4500,11 @@ paths:
4480
4500
  description: Gets or sets the queryable attendee last name.
4481
4501
  schema:
4482
4502
  type: string
4503
+ - name: ExternalReference
4504
+ in: query
4505
+ description: Gets or sets the queryable attendee external reference.
4506
+ schema:
4507
+ type: string
4483
4508
  - name: PageNumber
4484
4509
  in: query
4485
4510
  description: Gets or sets the page number for paged queries.
@@ -157929,6 +157954,10 @@ components:
157929
157954
  minLength: 1
157930
157955
  type: string
157931
157956
  description: Gets or sets the last name.
157957
+ externalReference:
157958
+ type: string
157959
+ description: Gets or sets the tenant-scoped external reference for integration with external systems.
157960
+ nullable: true
157932
157961
  nameAbbreviation:
157933
157962
  minLength: 1
157934
157963
  type: string
@@ -157986,6 +158015,10 @@ components:
157986
158015
  description: "Gets or sets the attendee date of birth.\r\nWhen a linked `end_user_identity` exists, first name, last name, and date of birth\r\npatch fields are applied to that record as well as to the attendee row where applicable."
157987
158016
  format: date-time
157988
158017
  nullable: true
158018
+ externalReference:
158019
+ type: string
158020
+ description: "Gets or sets the tenant-scoped external reference for integration with external systems.\r\nOnly applicable when enable_attendee_external_reference is enabled for the tenant."
158021
+ nullable: true
157989
158022
  additionalProperties: false
157990
158023
  description: Post model for attendee updates.
157991
158024
  AttendeePost:
@@ -158041,6 +158074,10 @@ components:
158041
158074
  description: "Gets or sets the attendee date of birth.\r\nThis is used to resolve or create the linked end_user_identity record for person-level identity tracking."
158042
158075
  format: date-time
158043
158076
  nullable: true
158077
+ externalReference:
158078
+ type: string
158079
+ description: "Gets or sets the tenant-scoped external reference for integration with external systems.\r\nOnly applicable when enable_attendee_external_reference is enabled for the tenant."
158080
+ nullable: true
158044
158081
  additionalProperties: false
158045
158082
  description: Post model for attendee inserts.
158046
158083
  AttendeeWalletDeductionPreview:
@@ -173987,6 +174024,18 @@ components:
173987
174024
  type: boolean
173988
174025
  description: "Gets or sets a value indicating whether WorkOS customer-portal auth is enabled for this tenant.\r\nWhen false (default), storefronts should hide WorkOS sign-in; use for phased rollout per tenant."
173989
174026
  default: false
174027
+ enableAttendeeExternalReference:
174028
+ type: boolean
174029
+ description: Gets or sets a value indicating whether attendee external references are enabled for the tenant.
174030
+ default: false
174031
+ requireAttendeeExternalReference:
174032
+ type: boolean
174033
+ description: Gets or sets a value indicating whether external_reference is required when creating attendees.
174034
+ default: false
174035
+ attendeeExternalReferenceLabel:
174036
+ type: string
174037
+ description: Gets or sets the label shown for the attendee external reference field in partner UI.
174038
+ nullable: true
173990
174039
  orderNumber:
173991
174040
  type: string
173992
174041
  description: Gets the next order number in the sequence.
@@ -50,6 +50,10 @@ export type Attendee = {
50
50
  * Gets or sets the last name.
51
51
  */
52
52
  lastName: string;
53
+ /**
54
+ * Gets or sets the tenant-scoped external reference for integration with external systems.
55
+ */
56
+ externalReference?: string | null;
53
57
  /**
54
58
  * Gets the attendees abbreviated name.
55
59
  */
@@ -29,4 +29,9 @@ export type AttendeePatch = {
29
29
  * patch fields are applied to that record as well as to the attendee row where applicable.
30
30
  */
31
31
  dateOfBirth?: string | null;
32
+ /**
33
+ * Gets or sets the tenant-scoped external reference for integration with external systems.
34
+ * Only applicable when enable_attendee_external_reference is enabled for the tenant.
35
+ */
36
+ externalReference?: string | null;
32
37
  };
@@ -53,4 +53,9 @@ export type AttendeePost = {
53
53
  * This is used to resolve or create the linked end_user_identity record for person-level identity tracking.
54
54
  */
55
55
  dateOfBirth?: string | null;
56
+ /**
57
+ * Gets or sets the tenant-scoped external reference for integration with external systems.
58
+ * Only applicable when enable_attendee_external_reference is enabled for the tenant.
59
+ */
60
+ externalReference?: string | null;
56
61
  };
@@ -83,6 +83,18 @@ export type TenantSetting = {
83
83
  * When false (default), storefronts should hide WorkOS sign-in; use for phased rollout per tenant.
84
84
  */
85
85
  customerPortalWorkOsLoginEnabled?: boolean;
86
+ /**
87
+ * Gets or sets a value indicating whether attendee external references are enabled for the tenant.
88
+ */
89
+ enableAttendeeExternalReference?: boolean;
90
+ /**
91
+ * Gets or sets a value indicating whether external_reference is required when creating attendees.
92
+ */
93
+ requireAttendeeExternalReference?: boolean;
94
+ /**
95
+ * Gets or sets the label shown for the attendee external reference field in partner UI.
96
+ */
97
+ attendeeExternalReferenceLabel?: string | null;
86
98
  /**
87
99
  * Gets the next order number in the sequence.
88
100
  */
@@ -153,6 +153,7 @@ export class AttendeesService {
153
153
  customerId,
154
154
  firstName,
155
155
  lastName,
156
+ externalReference,
156
157
  pageNumber,
157
158
  take,
158
159
  skip,
@@ -177,6 +178,10 @@ export class AttendeesService {
177
178
  * Gets or sets the queryable attendee last name.
178
179
  */
179
180
  lastName?: string;
181
+ /**
182
+ * Gets or sets the queryable attendee external reference.
183
+ */
184
+ externalReference?: string;
180
185
  /**
181
186
  * Gets or sets the page number for paged queries.
182
187
  */
@@ -229,6 +234,7 @@ export class AttendeesService {
229
234
  CustomerId: customerId,
230
235
  FirstName: firstName,
231
236
  LastName: lastName,
237
+ ExternalReference: externalReference,
232
238
  PageNumber: pageNumber,
233
239
  Take: take,
234
240
  Skip: skip,
@@ -339,6 +345,7 @@ export class AttendeesService {
339
345
  customerId,
340
346
  firstName,
341
347
  lastName,
348
+ externalReference,
342
349
  pageNumber,
343
350
  take,
344
351
  skip,
@@ -363,6 +370,10 @@ export class AttendeesService {
363
370
  * Gets or sets the queryable attendee last name.
364
371
  */
365
372
  lastName?: string;
373
+ /**
374
+ * Gets or sets the queryable attendee external reference.
375
+ */
376
+ externalReference?: string;
366
377
  /**
367
378
  * Gets or sets the page number for paged queries.
368
379
  */
@@ -415,6 +426,7 @@ export class AttendeesService {
415
426
  CustomerId: customerId,
416
427
  FirstName: firstName,
417
428
  LastName: lastName,
429
+ ExternalReference: externalReference,
418
430
  PageNumber: pageNumber,
419
431
  Take: take,
420
432
  Skip: skip,
@@ -444,6 +456,7 @@ export class AttendeesService {
444
456
  customerId,
445
457
  firstName,
446
458
  lastName,
459
+ externalReference,
447
460
  pageNumber,
448
461
  take,
449
462
  skip,
@@ -468,6 +481,10 @@ export class AttendeesService {
468
481
  * Gets or sets the queryable attendee last name.
469
482
  */
470
483
  lastName?: string;
484
+ /**
485
+ * Gets or sets the queryable attendee external reference.
486
+ */
487
+ externalReference?: string;
471
488
  /**
472
489
  * Gets or sets the page number for paged queries.
473
490
  */
@@ -520,6 +537,7 @@ export class AttendeesService {
520
537
  CustomerId: customerId,
521
538
  FirstName: firstName,
522
539
  LastName: lastName,
540
+ ExternalReference: externalReference,
523
541
  PageNumber: pageNumber,
524
542
  Take: take,
525
543
  Skip: skip,
@@ -549,6 +567,7 @@ export class AttendeesService {
549
567
  customerId,
550
568
  firstName,
551
569
  lastName,
570
+ externalReference,
552
571
  pageNumber,
553
572
  take,
554
573
  skip,
@@ -573,6 +592,10 @@ export class AttendeesService {
573
592
  * Gets or sets the queryable attendee last name.
574
593
  */
575
594
  lastName?: string;
595
+ /**
596
+ * Gets or sets the queryable attendee external reference.
597
+ */
598
+ externalReference?: string;
576
599
  /**
577
600
  * Gets or sets the page number for paged queries.
578
601
  */
@@ -625,6 +648,7 @@ export class AttendeesService {
625
648
  CustomerId: customerId,
626
649
  FirstName: firstName,
627
650
  LastName: lastName,
651
+ ExternalReference: externalReference,
628
652
  PageNumber: pageNumber,
629
653
  Take: take,
630
654
  Skip: skip,
@@ -654,6 +678,7 @@ export class AttendeesService {
654
678
  customerId,
655
679
  firstName,
656
680
  lastName,
681
+ externalReference,
657
682
  pageNumber,
658
683
  take,
659
684
  skip,
@@ -678,6 +703,10 @@ export class AttendeesService {
678
703
  * Gets or sets the queryable attendee last name.
679
704
  */
680
705
  lastName?: string;
706
+ /**
707
+ * Gets or sets the queryable attendee external reference.
708
+ */
709
+ externalReference?: string;
681
710
  /**
682
711
  * Gets or sets the page number for paged queries.
683
712
  */
@@ -730,6 +759,7 @@ export class AttendeesService {
730
759
  CustomerId: customerId,
731
760
  FirstName: firstName,
732
761
  LastName: lastName,
762
+ ExternalReference: externalReference,
733
763
  PageNumber: pageNumber,
734
764
  Take: take,
735
765
  Skip: skip,