reach-api-sdk 1.0.228 → 1.0.230

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.
@@ -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.
@@ -17678,18 +17703,12 @@ paths:
17678
17703
  text/json:
17679
17704
  schema:
17680
17705
  $ref: '#/components/schemas/ValidationResultModel'
17681
- /api/auth/customer/authorize-debug:
17706
+ /api/customer-account-invite-schedules/send-batch:
17682
17707
  get:
17683
17708
  tags:
17684
- - CustomerAuth
17685
- summary: Debug endpoint to view authorization URL and redirect URI details without redirecting.
17686
- operationId: AuthorizeDebug
17687
- parameters:
17688
- - name: tenantSubdomain
17689
- in: query
17690
- description: The tenant subdomain (defaults to "testtenant" if not provided).
17691
- schema:
17692
- type: string
17709
+ - CustomerAccountInviteSchedules
17710
+ summary: Sends due customer account invite emails.
17711
+ operationId: SendDueInvites
17693
17712
  responses:
17694
17713
  '200':
17695
17714
  description: OK
@@ -17729,102 +17748,37 @@ paths:
17729
17748
  text/json:
17730
17749
  schema:
17731
17750
  $ref: '#/components/schemas/ValidationResultModel'
17732
- /api/auth/customer/authorize:
17733
- get:
17751
+ /api/customer-account-invite-schedules/v2-temporary-route:
17752
+ post:
17734
17753
  tags:
17735
- - CustomerAuth
17736
- summary: Initiates WorkOS AuthKit authentication flow.
17737
- operationId: Authorize
17738
- parameters:
17739
- - name: tenantSubdomain
17740
- in: query
17741
- description: 'Optional tenant subdomain (from query, for sign-in page links).'
17742
- schema:
17743
- type: string
17744
- - name: returnTo
17745
- in: query
17746
- description: 'Optional path to redirect to after login (e.g. "/" for storefront, "/account" for account portal). Defaults to "/account" if omitted. Must start with "/" to prevent open redirects.'
17747
- schema:
17748
- type: string
17749
- - name: login_hint
17750
- in: query
17751
- description: Optional email hint for AuthKit sign-in UI.
17752
- schema:
17753
- type: string
17754
- - name: expected_email
17755
- in: query
17756
- description: 'Optional email that callback must match (state validation), even when AuthKit login hint is omitted.'
17757
- schema:
17758
- type: string
17759
- - name: screen_hint
17760
- in: query
17761
- description: Optional AuthKit screen (`sign-in` or `sign-up`).
17762
- schema:
17763
- type: string
17764
- - name: prompt
17765
- in: query
17766
- description: Optional OAuth prompt (e.g. `login` to reduce silent reuse of another WorkOS session in the browser).
17767
- schema:
17768
- type: string
17754
+ - CustomerAccountInviteSchedules
17755
+ summary: Inserts a new resource. The Id will be automatically generated and will be ignored if provided.
17756
+ operationId: Post
17757
+ requestBody:
17758
+ description: The <typeparamref name="TObject" /> model.
17759
+ content:
17760
+ application/json:
17761
+ schema:
17762
+ $ref: '#/components/schemas/CustomerAccountInviteSchedulePost'
17763
+ text/json:
17764
+ schema:
17765
+ $ref: '#/components/schemas/CustomerAccountInviteSchedulePost'
17766
+ application/*+json:
17767
+ schema:
17768
+ $ref: '#/components/schemas/CustomerAccountInviteSchedulePost'
17769
17769
  responses:
17770
17770
  '200':
17771
17771
  description: OK
17772
- '400':
17773
- description: Bad Request
17774
- content:
17775
- text/plain:
17776
- schema:
17777
- $ref: '#/components/schemas/ReachError'
17778
- application/json:
17779
- schema:
17780
- $ref: '#/components/schemas/ReachError'
17781
- text/json:
17782
- schema:
17783
- $ref: '#/components/schemas/ReachError'
17784
- '500':
17785
- description: Internal Server Error
17786
- content:
17787
- text/plain:
17788
- schema:
17789
- $ref: '#/components/schemas/ReachError'
17790
- application/json:
17791
- schema:
17792
- $ref: '#/components/schemas/ReachError'
17793
- text/json:
17794
- schema:
17795
- $ref: '#/components/schemas/ReachError'
17796
- '422':
17797
- description: Unprocessable Content
17798
17772
  content:
17799
17773
  text/plain:
17800
17774
  schema:
17801
- $ref: '#/components/schemas/ValidationResultModel'
17775
+ $ref: '#/components/schemas/CustomerAccountInviteSchedule'
17802
17776
  application/json:
17803
17777
  schema:
17804
- $ref: '#/components/schemas/ValidationResultModel'
17778
+ $ref: '#/components/schemas/CustomerAccountInviteSchedule'
17805
17779
  text/json:
17806
17780
  schema:
17807
- $ref: '#/components/schemas/ValidationResultModel'
17808
- /api/auth/customer/callback:
17809
- get:
17810
- tags:
17811
- - CustomerAuth
17812
- summary: Handles WorkOS AuthKit callback after user authentication.
17813
- operationId: Callback
17814
- parameters:
17815
- - name: code
17816
- in: query
17817
- description: Authorization code from WorkOS.
17818
- schema:
17819
- type: string
17820
- - name: state
17821
- in: query
17822
- description: State parameter for CSRF protection.
17823
- schema:
17824
- type: string
17825
- responses:
17826
- '200':
17827
- description: OK
17781
+ $ref: '#/components/schemas/CustomerAccountInviteSchedule'
17828
17782
  '400':
17829
17783
  description: Bad Request
17830
17784
  content:
@@ -17861,71 +17815,36 @@ paths:
17861
17815
  text/json:
17862
17816
  schema:
17863
17817
  $ref: '#/components/schemas/ValidationResultModel'
17864
- /api/auth/customer/logout:
17865
- get:
17818
+ patch:
17866
17819
  tags:
17867
- - CustomerAuth
17868
- summary: Handles customer logout.
17869
- operationId: Logout
17870
- parameters:
17871
- - name: sessionId
17872
- in: query
17873
- description: Optional WorkOS session ID (if using WorkOS session cookies).
17874
- schema:
17875
- type: string
17876
- - name: tenantSubdomain
17877
- in: query
17878
- description: 'Optional tenant subdomain (required when API host differs from storefront, e.g. cross-origin logout).'
17879
- schema:
17880
- type: string
17820
+ - CustomerAccountInviteSchedules
17821
+ summary: Patches the resource.
17822
+ operationId: Patch
17823
+ requestBody:
17824
+ description: The <typeparamref name="TObject" /> model.
17825
+ content:
17826
+ application/json:
17827
+ schema:
17828
+ $ref: '#/components/schemas/CustomerAccountInviteSchedulePatch'
17829
+ text/json:
17830
+ schema:
17831
+ $ref: '#/components/schemas/CustomerAccountInviteSchedulePatch'
17832
+ application/*+json:
17833
+ schema:
17834
+ $ref: '#/components/schemas/CustomerAccountInviteSchedulePatch'
17881
17835
  responses:
17882
17836
  '200':
17883
17837
  description: OK
17884
- '400':
17885
- description: Bad Request
17886
17838
  content:
17887
17839
  text/plain:
17888
17840
  schema:
17889
- $ref: '#/components/schemas/ReachError'
17841
+ $ref: '#/components/schemas/CustomerAccountInviteSchedule'
17890
17842
  application/json:
17891
17843
  schema:
17892
- $ref: '#/components/schemas/ReachError'
17844
+ $ref: '#/components/schemas/CustomerAccountInviteSchedule'
17893
17845
  text/json:
17894
17846
  schema:
17895
- $ref: '#/components/schemas/ReachError'
17896
- '500':
17897
- description: Internal Server Error
17898
- content:
17899
- text/plain:
17900
- schema:
17901
- $ref: '#/components/schemas/ReachError'
17902
- application/json:
17903
- schema:
17904
- $ref: '#/components/schemas/ReachError'
17905
- text/json:
17906
- schema:
17907
- $ref: '#/components/schemas/ReachError'
17908
- '422':
17909
- description: Unprocessable Content
17910
- content:
17911
- text/plain:
17912
- schema:
17913
- $ref: '#/components/schemas/ValidationResultModel'
17914
- application/json:
17915
- schema:
17916
- $ref: '#/components/schemas/ValidationResultModel'
17917
- text/json:
17918
- schema:
17919
- $ref: '#/components/schemas/ValidationResultModel'
17920
- /api/customer-portal/me:
17921
- get:
17922
- tags:
17923
- - CustomerPortal
17924
- summary: Returns the current authenticated customer's profile.
17925
- operationId: Me
17926
- responses:
17927
- '200':
17928
- description: OK
17847
+ $ref: '#/components/schemas/CustomerAccountInviteSchedule'
17929
17848
  '400':
17930
17849
  description: Bad Request
17931
17850
  content:
@@ -17962,15 +17881,49 @@ paths:
17962
17881
  text/json:
17963
17882
  schema:
17964
17883
  $ref: '#/components/schemas/ValidationResultModel'
17965
- /api/customer-portal/account:
17966
- get:
17884
+ /api/customer-account-invite-schedules/v2-temporary-route/list:
17885
+ post:
17967
17886
  tags:
17968
- - CustomerPortal
17969
- summary: 'Returns the authenticated customer''s account details for this tenant (fields editable via PATCH, except email which is read-only in the portal).'
17970
- operationId: GetAccount
17887
+ - CustomerAccountInviteSchedules
17888
+ summary: Inserts a list of resources.
17889
+ operationId: PostList
17890
+ requestBody:
17891
+ description: The list of <typeparamref name="TObject" />.
17892
+ content:
17893
+ application/json:
17894
+ schema:
17895
+ type: array
17896
+ items:
17897
+ $ref: '#/components/schemas/CustomerAccountInviteSchedulePost'
17898
+ text/json:
17899
+ schema:
17900
+ type: array
17901
+ items:
17902
+ $ref: '#/components/schemas/CustomerAccountInviteSchedulePost'
17903
+ application/*+json:
17904
+ schema:
17905
+ type: array
17906
+ items:
17907
+ $ref: '#/components/schemas/CustomerAccountInviteSchedulePost'
17971
17908
  responses:
17972
17909
  '200':
17973
17910
  description: OK
17911
+ content:
17912
+ text/plain:
17913
+ schema:
17914
+ type: array
17915
+ items:
17916
+ $ref: '#/components/schemas/CustomerAccountInviteSchedule'
17917
+ application/json:
17918
+ schema:
17919
+ type: array
17920
+ items:
17921
+ $ref: '#/components/schemas/CustomerAccountInviteSchedule'
17922
+ text/json:
17923
+ schema:
17924
+ type: array
17925
+ items:
17926
+ $ref: '#/components/schemas/CustomerAccountInviteSchedule'
17974
17927
  '400':
17975
17928
  description: Bad Request
17976
17929
  content:
@@ -18007,26 +17960,37 @@ paths:
18007
17960
  text/json:
18008
17961
  schema:
18009
17962
  $ref: '#/components/schemas/ValidationResultModel'
17963
+ /api/customer-account-invite-schedules/v2-temporary-route/with-references:
18010
17964
  patch:
18011
17965
  tags:
18012
- - CustomerPortal
18013
- summary: Updates the authenticated customer's account for this tenant (partial update). Email cannot be changed via this endpoint.
18014
- operationId: PatchAccount
17966
+ - CustomerAccountInviteSchedules
17967
+ summary: Patches the resource.
17968
+ operationId: PatchWithReferences
18015
17969
  requestBody:
18016
- description: Fields to update.
17970
+ description: The <typeparamref name="TObject" /> model.
18017
17971
  content:
18018
17972
  application/json:
18019
17973
  schema:
18020
- $ref: '#/components/schemas/CustomerPortalAccountPatch'
17974
+ $ref: '#/components/schemas/CustomerAccountInviteSchedulePatch'
18021
17975
  text/json:
18022
17976
  schema:
18023
- $ref: '#/components/schemas/CustomerPortalAccountPatch'
17977
+ $ref: '#/components/schemas/CustomerAccountInviteSchedulePatch'
18024
17978
  application/*+json:
18025
17979
  schema:
18026
- $ref: '#/components/schemas/CustomerPortalAccountPatch'
17980
+ $ref: '#/components/schemas/CustomerAccountInviteSchedulePatch'
18027
17981
  responses:
18028
17982
  '200':
18029
17983
  description: OK
17984
+ content:
17985
+ text/plain:
17986
+ schema:
17987
+ $ref: '#/components/schemas/CustomerAccountInviteSchedule'
17988
+ application/json:
17989
+ schema:
17990
+ $ref: '#/components/schemas/CustomerAccountInviteSchedule'
17991
+ text/json:
17992
+ schema:
17993
+ $ref: '#/components/schemas/CustomerAccountInviteSchedule'
18030
17994
  '400':
18031
17995
  description: Bad Request
18032
17996
  content:
@@ -18063,12 +18027,1421 @@ paths:
18063
18027
  text/json:
18064
18028
  schema:
18065
18029
  $ref: '#/components/schemas/ValidationResultModel'
18066
- /api/customer-portal/participants:
18067
- get:
18030
+ /api/customer-account-invite-schedules:
18031
+ delete:
18068
18032
  tags:
18069
- - CustomerPortal
18070
- summary: "Returns the participant profiles (attendees) for the authenticated customer in this tenant.\r\nResolves customer by end_user_identity_id (User -> Customer) with email fallback for unlinked users."
18071
- operationId: GetParticipants
18033
+ - CustomerAccountInviteSchedules
18034
+ summary: Deletes the resource.
18035
+ operationId: DeleteByObject
18036
+ requestBody:
18037
+ description: The <typeparamref name="TObject" /> model.
18038
+ content:
18039
+ application/json:
18040
+ schema:
18041
+ $ref: '#/components/schemas/CustomerAccountInviteSchedule'
18042
+ text/json:
18043
+ schema:
18044
+ $ref: '#/components/schemas/CustomerAccountInviteSchedule'
18045
+ application/*+json:
18046
+ schema:
18047
+ $ref: '#/components/schemas/CustomerAccountInviteSchedule'
18048
+ responses:
18049
+ '200':
18050
+ description: OK
18051
+ '400':
18052
+ description: Bad Request
18053
+ content:
18054
+ text/plain:
18055
+ schema:
18056
+ $ref: '#/components/schemas/ReachError'
18057
+ application/json:
18058
+ schema:
18059
+ $ref: '#/components/schemas/ReachError'
18060
+ text/json:
18061
+ schema:
18062
+ $ref: '#/components/schemas/ReachError'
18063
+ '500':
18064
+ description: Internal Server Error
18065
+ content:
18066
+ text/plain:
18067
+ schema:
18068
+ $ref: '#/components/schemas/ReachError'
18069
+ application/json:
18070
+ schema:
18071
+ $ref: '#/components/schemas/ReachError'
18072
+ text/json:
18073
+ schema:
18074
+ $ref: '#/components/schemas/ReachError'
18075
+ '422':
18076
+ description: Unprocessable Content
18077
+ content:
18078
+ text/plain:
18079
+ schema:
18080
+ $ref: '#/components/schemas/ValidationResultModel'
18081
+ application/json:
18082
+ schema:
18083
+ $ref: '#/components/schemas/ValidationResultModel'
18084
+ text/json:
18085
+ schema:
18086
+ $ref: '#/components/schemas/ValidationResultModel'
18087
+ get:
18088
+ tags:
18089
+ - CustomerAccountInviteSchedules
18090
+ summary: Gets a list of resources.
18091
+ operationId: GetPage
18092
+ parameters:
18093
+ - name: CustomerId
18094
+ in: query
18095
+ description: Gets or sets the queryable customer id.
18096
+ schema:
18097
+ type: string
18098
+ format: uuid
18099
+ - name: WalletCreditPeriodId
18100
+ in: query
18101
+ description: Gets or sets the queryable wallet credit period id.
18102
+ schema:
18103
+ type: string
18104
+ format: uuid
18105
+ - name: DateScheduledGTE
18106
+ in: query
18107
+ description: Gets or sets the queryable date scheduled greater than or equal to.
18108
+ schema:
18109
+ type: string
18110
+ format: date-time
18111
+ - name: DateScheduledLTE
18112
+ in: query
18113
+ description: Gets or sets the queryable date scheduled less than or equal to.
18114
+ schema:
18115
+ type: string
18116
+ format: date-time
18117
+ - name: Sent
18118
+ in: query
18119
+ description: Gets or sets the queryable sent flag.
18120
+ schema:
18121
+ type: boolean
18122
+ - name: Errored
18123
+ in: query
18124
+ description: Gets or sets the queryable errored flag.
18125
+ schema:
18126
+ type: boolean
18127
+ - name: PageNumber
18128
+ in: query
18129
+ description: Gets or sets the page number for paged queries.
18130
+ schema:
18131
+ type: integer
18132
+ format: int32
18133
+ - name: Take
18134
+ in: query
18135
+ description: 'Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.'
18136
+ schema:
18137
+ type: integer
18138
+ format: int32
18139
+ - name: Skip
18140
+ in: query
18141
+ description: 'Gets or sets how much items to skip from begining of db table, when this is set page is always 1.'
18142
+ schema:
18143
+ type: integer
18144
+ format: int32
18145
+ - name: LimitListRequests
18146
+ in: query
18147
+ description: Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
18148
+ schema:
18149
+ type: boolean
18150
+ - name: TenantId
18151
+ in: query
18152
+ description: Gets or sets the Tenant Id.
18153
+ schema:
18154
+ type: string
18155
+ format: uuid
18156
+ - name: ModifiedById
18157
+ in: query
18158
+ description: Gets or sets the Modifed By Id.
18159
+ schema:
18160
+ type: string
18161
+ format: uuid
18162
+ - name: ModifiedByIds
18163
+ in: query
18164
+ description: Gets or sets the Modifed By Ids.
18165
+ schema:
18166
+ type: array
18167
+ items:
18168
+ type: string
18169
+ format: uuid
18170
+ - name: DateCreatedGTE
18171
+ in: query
18172
+ description: Gets or sets the Date Created greater than equal to.
18173
+ schema:
18174
+ type: string
18175
+ format: date-time
18176
+ - name: DateCreatedLTE
18177
+ in: query
18178
+ description: Gets or sets the Date Created less than equal to.
18179
+ schema:
18180
+ type: string
18181
+ format: date-time
18182
+ - name: IsLive
18183
+ in: query
18184
+ description: Gets or sets the queryable only is live status.
18185
+ schema:
18186
+ type: boolean
18187
+ - name: SortOrderDirection
18188
+ in: query
18189
+ description: Gets or sets the sort order direction.
18190
+ schema:
18191
+ $ref: '#/components/schemas/SearchSortOrderDirection'
18192
+ responses:
18193
+ '200':
18194
+ description: OK
18195
+ content:
18196
+ text/plain:
18197
+ schema:
18198
+ $ref: '#/components/schemas/CustomerAccountInviteSchedulePage'
18199
+ application/json:
18200
+ schema:
18201
+ $ref: '#/components/schemas/CustomerAccountInviteSchedulePage'
18202
+ text/json:
18203
+ schema:
18204
+ $ref: '#/components/schemas/CustomerAccountInviteSchedulePage'
18205
+ '400':
18206
+ description: Bad Request
18207
+ content:
18208
+ text/plain:
18209
+ schema:
18210
+ $ref: '#/components/schemas/ReachError'
18211
+ application/json:
18212
+ schema:
18213
+ $ref: '#/components/schemas/ReachError'
18214
+ text/json:
18215
+ schema:
18216
+ $ref: '#/components/schemas/ReachError'
18217
+ '500':
18218
+ description: Internal Server Error
18219
+ content:
18220
+ text/plain:
18221
+ schema:
18222
+ $ref: '#/components/schemas/ReachError'
18223
+ application/json:
18224
+ schema:
18225
+ $ref: '#/components/schemas/ReachError'
18226
+ text/json:
18227
+ schema:
18228
+ $ref: '#/components/schemas/ReachError'
18229
+ '422':
18230
+ description: Unprocessable Content
18231
+ content:
18232
+ text/plain:
18233
+ schema:
18234
+ $ref: '#/components/schemas/ValidationResultModel'
18235
+ application/json:
18236
+ schema:
18237
+ $ref: '#/components/schemas/ValidationResultModel'
18238
+ text/json:
18239
+ schema:
18240
+ $ref: '#/components/schemas/ValidationResultModel'
18241
+ '/api/customer-account-invite-schedules/{id}':
18242
+ delete:
18243
+ tags:
18244
+ - CustomerAccountInviteSchedules
18245
+ summary: Deletes the resource.
18246
+ operationId: DeleteById
18247
+ parameters:
18248
+ - name: id
18249
+ in: path
18250
+ description: The <typeparamref name="TObject" /> id.
18251
+ required: true
18252
+ schema:
18253
+ type: string
18254
+ format: uuid
18255
+ responses:
18256
+ '200':
18257
+ description: OK
18258
+ '400':
18259
+ description: Bad Request
18260
+ content:
18261
+ text/plain:
18262
+ schema:
18263
+ $ref: '#/components/schemas/ReachError'
18264
+ application/json:
18265
+ schema:
18266
+ $ref: '#/components/schemas/ReachError'
18267
+ text/json:
18268
+ schema:
18269
+ $ref: '#/components/schemas/ReachError'
18270
+ '500':
18271
+ description: Internal Server Error
18272
+ content:
18273
+ text/plain:
18274
+ schema:
18275
+ $ref: '#/components/schemas/ReachError'
18276
+ application/json:
18277
+ schema:
18278
+ $ref: '#/components/schemas/ReachError'
18279
+ text/json:
18280
+ schema:
18281
+ $ref: '#/components/schemas/ReachError'
18282
+ '422':
18283
+ description: Unprocessable Content
18284
+ content:
18285
+ text/plain:
18286
+ schema:
18287
+ $ref: '#/components/schemas/ValidationResultModel'
18288
+ application/json:
18289
+ schema:
18290
+ $ref: '#/components/schemas/ValidationResultModel'
18291
+ text/json:
18292
+ schema:
18293
+ $ref: '#/components/schemas/ValidationResultModel'
18294
+ get:
18295
+ tags:
18296
+ - CustomerAccountInviteSchedules
18297
+ summary: Gets the resource by its Id.
18298
+ operationId: GetObject
18299
+ parameters:
18300
+ - name: id
18301
+ in: path
18302
+ description: The <typeparamref name="TObject" /> id.
18303
+ required: true
18304
+ schema:
18305
+ type: string
18306
+ format: uuid
18307
+ responses:
18308
+ '200':
18309
+ description: OK
18310
+ content:
18311
+ text/plain:
18312
+ schema:
18313
+ $ref: '#/components/schemas/CustomerAccountInviteSchedule'
18314
+ application/json:
18315
+ schema:
18316
+ $ref: '#/components/schemas/CustomerAccountInviteSchedule'
18317
+ text/json:
18318
+ schema:
18319
+ $ref: '#/components/schemas/CustomerAccountInviteSchedule'
18320
+ '400':
18321
+ description: Bad Request
18322
+ content:
18323
+ text/plain:
18324
+ schema:
18325
+ $ref: '#/components/schemas/ReachError'
18326
+ application/json:
18327
+ schema:
18328
+ $ref: '#/components/schemas/ReachError'
18329
+ text/json:
18330
+ schema:
18331
+ $ref: '#/components/schemas/ReachError'
18332
+ '500':
18333
+ description: Internal Server Error
18334
+ content:
18335
+ text/plain:
18336
+ schema:
18337
+ $ref: '#/components/schemas/ReachError'
18338
+ application/json:
18339
+ schema:
18340
+ $ref: '#/components/schemas/ReachError'
18341
+ text/json:
18342
+ schema:
18343
+ $ref: '#/components/schemas/ReachError'
18344
+ '422':
18345
+ description: Unprocessable Content
18346
+ content:
18347
+ text/plain:
18348
+ schema:
18349
+ $ref: '#/components/schemas/ValidationResultModel'
18350
+ application/json:
18351
+ schema:
18352
+ $ref: '#/components/schemas/ValidationResultModel'
18353
+ text/json:
18354
+ schema:
18355
+ $ref: '#/components/schemas/ValidationResultModel'
18356
+ '/api/customer-account-invite-schedules/{id}/deletable':
18357
+ get:
18358
+ tags:
18359
+ - CustomerAccountInviteSchedules
18360
+ summary: Returns a value indicating whether the resource is deletable.
18361
+ operationId: CanDelete
18362
+ parameters:
18363
+ - name: id
18364
+ in: path
18365
+ description: The <typeparamref name="TObject" /> id.
18366
+ required: true
18367
+ schema:
18368
+ type: string
18369
+ format: uuid
18370
+ responses:
18371
+ '200':
18372
+ description: OK
18373
+ content:
18374
+ text/plain:
18375
+ schema:
18376
+ type: boolean
18377
+ application/json:
18378
+ schema:
18379
+ type: boolean
18380
+ text/json:
18381
+ schema:
18382
+ type: boolean
18383
+ '400':
18384
+ description: Bad Request
18385
+ content:
18386
+ text/plain:
18387
+ schema:
18388
+ $ref: '#/components/schemas/ReachError'
18389
+ application/json:
18390
+ schema:
18391
+ $ref: '#/components/schemas/ReachError'
18392
+ text/json:
18393
+ schema:
18394
+ $ref: '#/components/schemas/ReachError'
18395
+ '500':
18396
+ description: Internal Server Error
18397
+ content:
18398
+ text/plain:
18399
+ schema:
18400
+ $ref: '#/components/schemas/ReachError'
18401
+ application/json:
18402
+ schema:
18403
+ $ref: '#/components/schemas/ReachError'
18404
+ text/json:
18405
+ schema:
18406
+ $ref: '#/components/schemas/ReachError'
18407
+ '422':
18408
+ description: Unprocessable Content
18409
+ content:
18410
+ text/plain:
18411
+ schema:
18412
+ $ref: '#/components/schemas/ValidationResultModel'
18413
+ application/json:
18414
+ schema:
18415
+ $ref: '#/components/schemas/ValidationResultModel'
18416
+ text/json:
18417
+ schema:
18418
+ $ref: '#/components/schemas/ValidationResultModel'
18419
+ /api/customer-account-invite-schedules/exists:
18420
+ get:
18421
+ tags:
18422
+ - CustomerAccountInviteSchedules
18423
+ summary: Returns a value indicating whether the resource exists in the database given the provided search params.
18424
+ operationId: Exists
18425
+ parameters:
18426
+ - name: CustomerId
18427
+ in: query
18428
+ description: Gets or sets the queryable customer id.
18429
+ schema:
18430
+ type: string
18431
+ format: uuid
18432
+ - name: WalletCreditPeriodId
18433
+ in: query
18434
+ description: Gets or sets the queryable wallet credit period id.
18435
+ schema:
18436
+ type: string
18437
+ format: uuid
18438
+ - name: DateScheduledGTE
18439
+ in: query
18440
+ description: Gets or sets the queryable date scheduled greater than or equal to.
18441
+ schema:
18442
+ type: string
18443
+ format: date-time
18444
+ - name: DateScheduledLTE
18445
+ in: query
18446
+ description: Gets or sets the queryable date scheduled less than or equal to.
18447
+ schema:
18448
+ type: string
18449
+ format: date-time
18450
+ - name: Sent
18451
+ in: query
18452
+ description: Gets or sets the queryable sent flag.
18453
+ schema:
18454
+ type: boolean
18455
+ - name: Errored
18456
+ in: query
18457
+ description: Gets or sets the queryable errored flag.
18458
+ schema:
18459
+ type: boolean
18460
+ - name: PageNumber
18461
+ in: query
18462
+ description: Gets or sets the page number for paged queries.
18463
+ schema:
18464
+ type: integer
18465
+ format: int32
18466
+ - name: Take
18467
+ in: query
18468
+ description: 'Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.'
18469
+ schema:
18470
+ type: integer
18471
+ format: int32
18472
+ - name: Skip
18473
+ in: query
18474
+ description: 'Gets or sets how much items to skip from begining of db table, when this is set page is always 1.'
18475
+ schema:
18476
+ type: integer
18477
+ format: int32
18478
+ - name: LimitListRequests
18479
+ in: query
18480
+ description: Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
18481
+ schema:
18482
+ type: boolean
18483
+ - name: TenantId
18484
+ in: query
18485
+ description: Gets or sets the Tenant Id.
18486
+ schema:
18487
+ type: string
18488
+ format: uuid
18489
+ - name: ModifiedById
18490
+ in: query
18491
+ description: Gets or sets the Modifed By Id.
18492
+ schema:
18493
+ type: string
18494
+ format: uuid
18495
+ - name: ModifiedByIds
18496
+ in: query
18497
+ description: Gets or sets the Modifed By Ids.
18498
+ schema:
18499
+ type: array
18500
+ items:
18501
+ type: string
18502
+ format: uuid
18503
+ - name: DateCreatedGTE
18504
+ in: query
18505
+ description: Gets or sets the Date Created greater than equal to.
18506
+ schema:
18507
+ type: string
18508
+ format: date-time
18509
+ - name: DateCreatedLTE
18510
+ in: query
18511
+ description: Gets or sets the Date Created less than equal to.
18512
+ schema:
18513
+ type: string
18514
+ format: date-time
18515
+ - name: IsLive
18516
+ in: query
18517
+ description: Gets or sets the queryable only is live status.
18518
+ schema:
18519
+ type: boolean
18520
+ - name: SortOrderDirection
18521
+ in: query
18522
+ description: Gets or sets the sort order direction.
18523
+ schema:
18524
+ $ref: '#/components/schemas/SearchSortOrderDirection'
18525
+ responses:
18526
+ '200':
18527
+ description: OK
18528
+ content:
18529
+ text/plain:
18530
+ schema:
18531
+ type: boolean
18532
+ application/json:
18533
+ schema:
18534
+ type: boolean
18535
+ text/json:
18536
+ schema:
18537
+ type: boolean
18538
+ '400':
18539
+ description: Bad Request
18540
+ content:
18541
+ text/plain:
18542
+ schema:
18543
+ $ref: '#/components/schemas/ReachError'
18544
+ application/json:
18545
+ schema:
18546
+ $ref: '#/components/schemas/ReachError'
18547
+ text/json:
18548
+ schema:
18549
+ $ref: '#/components/schemas/ReachError'
18550
+ '500':
18551
+ description: Internal Server Error
18552
+ content:
18553
+ text/plain:
18554
+ schema:
18555
+ $ref: '#/components/schemas/ReachError'
18556
+ application/json:
18557
+ schema:
18558
+ $ref: '#/components/schemas/ReachError'
18559
+ text/json:
18560
+ schema:
18561
+ $ref: '#/components/schemas/ReachError'
18562
+ '422':
18563
+ description: Unprocessable Content
18564
+ content:
18565
+ text/plain:
18566
+ schema:
18567
+ $ref: '#/components/schemas/ValidationResultModel'
18568
+ application/json:
18569
+ schema:
18570
+ $ref: '#/components/schemas/ValidationResultModel'
18571
+ text/json:
18572
+ schema:
18573
+ $ref: '#/components/schemas/ValidationResultModel'
18574
+ /api/customer-account-invite-schedules/count:
18575
+ get:
18576
+ tags:
18577
+ - CustomerAccountInviteSchedules
18578
+ summary: Returns the number of results in the database given the provided search params.
18579
+ operationId: Count
18580
+ parameters:
18581
+ - name: CustomerId
18582
+ in: query
18583
+ description: Gets or sets the queryable customer id.
18584
+ schema:
18585
+ type: string
18586
+ format: uuid
18587
+ - name: WalletCreditPeriodId
18588
+ in: query
18589
+ description: Gets or sets the queryable wallet credit period id.
18590
+ schema:
18591
+ type: string
18592
+ format: uuid
18593
+ - name: DateScheduledGTE
18594
+ in: query
18595
+ description: Gets or sets the queryable date scheduled greater than or equal to.
18596
+ schema:
18597
+ type: string
18598
+ format: date-time
18599
+ - name: DateScheduledLTE
18600
+ in: query
18601
+ description: Gets or sets the queryable date scheduled less than or equal to.
18602
+ schema:
18603
+ type: string
18604
+ format: date-time
18605
+ - name: Sent
18606
+ in: query
18607
+ description: Gets or sets the queryable sent flag.
18608
+ schema:
18609
+ type: boolean
18610
+ - name: Errored
18611
+ in: query
18612
+ description: Gets or sets the queryable errored flag.
18613
+ schema:
18614
+ type: boolean
18615
+ - name: PageNumber
18616
+ in: query
18617
+ description: Gets or sets the page number for paged queries.
18618
+ schema:
18619
+ type: integer
18620
+ format: int32
18621
+ - name: Take
18622
+ in: query
18623
+ description: 'Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.'
18624
+ schema:
18625
+ type: integer
18626
+ format: int32
18627
+ - name: Skip
18628
+ in: query
18629
+ description: 'Gets or sets how much items to skip from begining of db table, when this is set page is always 1.'
18630
+ schema:
18631
+ type: integer
18632
+ format: int32
18633
+ - name: LimitListRequests
18634
+ in: query
18635
+ description: Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
18636
+ schema:
18637
+ type: boolean
18638
+ - name: TenantId
18639
+ in: query
18640
+ description: Gets or sets the Tenant Id.
18641
+ schema:
18642
+ type: string
18643
+ format: uuid
18644
+ - name: ModifiedById
18645
+ in: query
18646
+ description: Gets or sets the Modifed By Id.
18647
+ schema:
18648
+ type: string
18649
+ format: uuid
18650
+ - name: ModifiedByIds
18651
+ in: query
18652
+ description: Gets or sets the Modifed By Ids.
18653
+ schema:
18654
+ type: array
18655
+ items:
18656
+ type: string
18657
+ format: uuid
18658
+ - name: DateCreatedGTE
18659
+ in: query
18660
+ description: Gets or sets the Date Created greater than equal to.
18661
+ schema:
18662
+ type: string
18663
+ format: date-time
18664
+ - name: DateCreatedLTE
18665
+ in: query
18666
+ description: Gets or sets the Date Created less than equal to.
18667
+ schema:
18668
+ type: string
18669
+ format: date-time
18670
+ - name: IsLive
18671
+ in: query
18672
+ description: Gets or sets the queryable only is live status.
18673
+ schema:
18674
+ type: boolean
18675
+ - name: SortOrderDirection
18676
+ in: query
18677
+ description: Gets or sets the sort order direction.
18678
+ schema:
18679
+ $ref: '#/components/schemas/SearchSortOrderDirection'
18680
+ responses:
18681
+ '200':
18682
+ description: OK
18683
+ content:
18684
+ text/plain:
18685
+ schema:
18686
+ type: integer
18687
+ format: int32
18688
+ application/json:
18689
+ schema:
18690
+ type: integer
18691
+ format: int32
18692
+ text/json:
18693
+ schema:
18694
+ type: integer
18695
+ format: int32
18696
+ '400':
18697
+ description: Bad Request
18698
+ content:
18699
+ text/plain:
18700
+ schema:
18701
+ $ref: '#/components/schemas/ReachError'
18702
+ application/json:
18703
+ schema:
18704
+ $ref: '#/components/schemas/ReachError'
18705
+ text/json:
18706
+ schema:
18707
+ $ref: '#/components/schemas/ReachError'
18708
+ '500':
18709
+ description: Internal Server Error
18710
+ content:
18711
+ text/plain:
18712
+ schema:
18713
+ $ref: '#/components/schemas/ReachError'
18714
+ application/json:
18715
+ schema:
18716
+ $ref: '#/components/schemas/ReachError'
18717
+ text/json:
18718
+ schema:
18719
+ $ref: '#/components/schemas/ReachError'
18720
+ '422':
18721
+ description: Unprocessable Content
18722
+ content:
18723
+ text/plain:
18724
+ schema:
18725
+ $ref: '#/components/schemas/ValidationResultModel'
18726
+ application/json:
18727
+ schema:
18728
+ $ref: '#/components/schemas/ValidationResultModel'
18729
+ text/json:
18730
+ schema:
18731
+ $ref: '#/components/schemas/ValidationResultModel'
18732
+ /api/customer-account-invite-schedules/without-references:
18733
+ get:
18734
+ tags:
18735
+ - CustomerAccountInviteSchedules
18736
+ summary: Gets a list of resources unpaged and without references.
18737
+ operationId: GetListWithoutReferences
18738
+ parameters:
18739
+ - name: CustomerId
18740
+ in: query
18741
+ description: Gets or sets the queryable customer id.
18742
+ schema:
18743
+ type: string
18744
+ format: uuid
18745
+ - name: WalletCreditPeriodId
18746
+ in: query
18747
+ description: Gets or sets the queryable wallet credit period id.
18748
+ schema:
18749
+ type: string
18750
+ format: uuid
18751
+ - name: DateScheduledGTE
18752
+ in: query
18753
+ description: Gets or sets the queryable date scheduled greater than or equal to.
18754
+ schema:
18755
+ type: string
18756
+ format: date-time
18757
+ - name: DateScheduledLTE
18758
+ in: query
18759
+ description: Gets or sets the queryable date scheduled less than or equal to.
18760
+ schema:
18761
+ type: string
18762
+ format: date-time
18763
+ - name: Sent
18764
+ in: query
18765
+ description: Gets or sets the queryable sent flag.
18766
+ schema:
18767
+ type: boolean
18768
+ - name: Errored
18769
+ in: query
18770
+ description: Gets or sets the queryable errored flag.
18771
+ schema:
18772
+ type: boolean
18773
+ - name: PageNumber
18774
+ in: query
18775
+ description: Gets or sets the page number for paged queries.
18776
+ schema:
18777
+ type: integer
18778
+ format: int32
18779
+ - name: Take
18780
+ in: query
18781
+ description: 'Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.'
18782
+ schema:
18783
+ type: integer
18784
+ format: int32
18785
+ - name: Skip
18786
+ in: query
18787
+ description: 'Gets or sets how much items to skip from begining of db table, when this is set page is always 1.'
18788
+ schema:
18789
+ type: integer
18790
+ format: int32
18791
+ - name: LimitListRequests
18792
+ in: query
18793
+ description: Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
18794
+ schema:
18795
+ type: boolean
18796
+ - name: TenantId
18797
+ in: query
18798
+ description: Gets or sets the Tenant Id.
18799
+ schema:
18800
+ type: string
18801
+ format: uuid
18802
+ - name: ModifiedById
18803
+ in: query
18804
+ description: Gets or sets the Modifed By Id.
18805
+ schema:
18806
+ type: string
18807
+ format: uuid
18808
+ - name: ModifiedByIds
18809
+ in: query
18810
+ description: Gets or sets the Modifed By Ids.
18811
+ schema:
18812
+ type: array
18813
+ items:
18814
+ type: string
18815
+ format: uuid
18816
+ - name: DateCreatedGTE
18817
+ in: query
18818
+ description: Gets or sets the Date Created greater than equal to.
18819
+ schema:
18820
+ type: string
18821
+ format: date-time
18822
+ - name: DateCreatedLTE
18823
+ in: query
18824
+ description: Gets or sets the Date Created less than equal to.
18825
+ schema:
18826
+ type: string
18827
+ format: date-time
18828
+ - name: IsLive
18829
+ in: query
18830
+ description: Gets or sets the queryable only is live status.
18831
+ schema:
18832
+ type: boolean
18833
+ - name: SortOrderDirection
18834
+ in: query
18835
+ description: Gets or sets the sort order direction.
18836
+ schema:
18837
+ $ref: '#/components/schemas/SearchSortOrderDirection'
18838
+ responses:
18839
+ '200':
18840
+ description: OK
18841
+ content:
18842
+ text/plain:
18843
+ schema:
18844
+ type: array
18845
+ items:
18846
+ $ref: '#/components/schemas/CustomerAccountInviteSchedule'
18847
+ application/json:
18848
+ schema:
18849
+ type: array
18850
+ items:
18851
+ $ref: '#/components/schemas/CustomerAccountInviteSchedule'
18852
+ text/json:
18853
+ schema:
18854
+ type: array
18855
+ items:
18856
+ $ref: '#/components/schemas/CustomerAccountInviteSchedule'
18857
+ '400':
18858
+ description: Bad Request
18859
+ content:
18860
+ text/plain:
18861
+ schema:
18862
+ $ref: '#/components/schemas/ReachError'
18863
+ application/json:
18864
+ schema:
18865
+ $ref: '#/components/schemas/ReachError'
18866
+ text/json:
18867
+ schema:
18868
+ $ref: '#/components/schemas/ReachError'
18869
+ '500':
18870
+ description: Internal Server Error
18871
+ content:
18872
+ text/plain:
18873
+ schema:
18874
+ $ref: '#/components/schemas/ReachError'
18875
+ application/json:
18876
+ schema:
18877
+ $ref: '#/components/schemas/ReachError'
18878
+ text/json:
18879
+ schema:
18880
+ $ref: '#/components/schemas/ReachError'
18881
+ '422':
18882
+ description: Unprocessable Content
18883
+ content:
18884
+ text/plain:
18885
+ schema:
18886
+ $ref: '#/components/schemas/ValidationResultModel'
18887
+ application/json:
18888
+ schema:
18889
+ $ref: '#/components/schemas/ValidationResultModel'
18890
+ text/json:
18891
+ schema:
18892
+ $ref: '#/components/schemas/ValidationResultModel'
18893
+ /api/customer-account-invite-schedules/id-name:
18894
+ get:
18895
+ tags:
18896
+ - CustomerAccountInviteSchedules
18897
+ summary: Gets a list of resources.
18898
+ operationId: GetListIdName
18899
+ parameters:
18900
+ - name: CustomerId
18901
+ in: query
18902
+ description: Gets or sets the queryable customer id.
18903
+ schema:
18904
+ type: string
18905
+ format: uuid
18906
+ - name: WalletCreditPeriodId
18907
+ in: query
18908
+ description: Gets or sets the queryable wallet credit period id.
18909
+ schema:
18910
+ type: string
18911
+ format: uuid
18912
+ - name: DateScheduledGTE
18913
+ in: query
18914
+ description: Gets or sets the queryable date scheduled greater than or equal to.
18915
+ schema:
18916
+ type: string
18917
+ format: date-time
18918
+ - name: DateScheduledLTE
18919
+ in: query
18920
+ description: Gets or sets the queryable date scheduled less than or equal to.
18921
+ schema:
18922
+ type: string
18923
+ format: date-time
18924
+ - name: Sent
18925
+ in: query
18926
+ description: Gets or sets the queryable sent flag.
18927
+ schema:
18928
+ type: boolean
18929
+ - name: Errored
18930
+ in: query
18931
+ description: Gets or sets the queryable errored flag.
18932
+ schema:
18933
+ type: boolean
18934
+ - name: PageNumber
18935
+ in: query
18936
+ description: Gets or sets the page number for paged queries.
18937
+ schema:
18938
+ type: integer
18939
+ format: int32
18940
+ - name: Take
18941
+ in: query
18942
+ description: 'Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.'
18943
+ schema:
18944
+ type: integer
18945
+ format: int32
18946
+ - name: Skip
18947
+ in: query
18948
+ description: 'Gets or sets how much items to skip from begining of db table, when this is set page is always 1.'
18949
+ schema:
18950
+ type: integer
18951
+ format: int32
18952
+ - name: LimitListRequests
18953
+ in: query
18954
+ description: Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
18955
+ schema:
18956
+ type: boolean
18957
+ - name: TenantId
18958
+ in: query
18959
+ description: Gets or sets the Tenant Id.
18960
+ schema:
18961
+ type: string
18962
+ format: uuid
18963
+ - name: ModifiedById
18964
+ in: query
18965
+ description: Gets or sets the Modifed By Id.
18966
+ schema:
18967
+ type: string
18968
+ format: uuid
18969
+ - name: ModifiedByIds
18970
+ in: query
18971
+ description: Gets or sets the Modifed By Ids.
18972
+ schema:
18973
+ type: array
18974
+ items:
18975
+ type: string
18976
+ format: uuid
18977
+ - name: DateCreatedGTE
18978
+ in: query
18979
+ description: Gets or sets the Date Created greater than equal to.
18980
+ schema:
18981
+ type: string
18982
+ format: date-time
18983
+ - name: DateCreatedLTE
18984
+ in: query
18985
+ description: Gets or sets the Date Created less than equal to.
18986
+ schema:
18987
+ type: string
18988
+ format: date-time
18989
+ - name: IsLive
18990
+ in: query
18991
+ description: Gets or sets the queryable only is live status.
18992
+ schema:
18993
+ type: boolean
18994
+ - name: SortOrderDirection
18995
+ in: query
18996
+ description: Gets or sets the sort order direction.
18997
+ schema:
18998
+ $ref: '#/components/schemas/SearchSortOrderDirection'
18999
+ responses:
19000
+ '200':
19001
+ description: OK
19002
+ content:
19003
+ text/plain:
19004
+ schema:
19005
+ type: array
19006
+ items:
19007
+ $ref: '#/components/schemas/CustomerAccountInviteSchedule'
19008
+ application/json:
19009
+ schema:
19010
+ type: array
19011
+ items:
19012
+ $ref: '#/components/schemas/CustomerAccountInviteSchedule'
19013
+ text/json:
19014
+ schema:
19015
+ type: array
19016
+ items:
19017
+ $ref: '#/components/schemas/CustomerAccountInviteSchedule'
19018
+ '400':
19019
+ description: Bad Request
19020
+ content:
19021
+ text/plain:
19022
+ schema:
19023
+ $ref: '#/components/schemas/ReachError'
19024
+ application/json:
19025
+ schema:
19026
+ $ref: '#/components/schemas/ReachError'
19027
+ text/json:
19028
+ schema:
19029
+ $ref: '#/components/schemas/ReachError'
19030
+ '500':
19031
+ description: Internal Server Error
19032
+ content:
19033
+ text/plain:
19034
+ schema:
19035
+ $ref: '#/components/schemas/ReachError'
19036
+ application/json:
19037
+ schema:
19038
+ $ref: '#/components/schemas/ReachError'
19039
+ text/json:
19040
+ schema:
19041
+ $ref: '#/components/schemas/ReachError'
19042
+ '422':
19043
+ description: Unprocessable Content
19044
+ content:
19045
+ text/plain:
19046
+ schema:
19047
+ $ref: '#/components/schemas/ValidationResultModel'
19048
+ application/json:
19049
+ schema:
19050
+ $ref: '#/components/schemas/ValidationResultModel'
19051
+ text/json:
19052
+ schema:
19053
+ $ref: '#/components/schemas/ValidationResultModel'
19054
+ /api/auth/customer/authorize-debug:
19055
+ get:
19056
+ tags:
19057
+ - CustomerAuth
19058
+ summary: Debug endpoint to view authorization URL and redirect URI details without redirecting.
19059
+ operationId: AuthorizeDebug
19060
+ parameters:
19061
+ - name: tenantSubdomain
19062
+ in: query
19063
+ description: The tenant subdomain (defaults to "testtenant" if not provided).
19064
+ schema:
19065
+ type: string
19066
+ responses:
19067
+ '200':
19068
+ description: OK
19069
+ '400':
19070
+ description: Bad Request
19071
+ content:
19072
+ text/plain:
19073
+ schema:
19074
+ $ref: '#/components/schemas/ReachError'
19075
+ application/json:
19076
+ schema:
19077
+ $ref: '#/components/schemas/ReachError'
19078
+ text/json:
19079
+ schema:
19080
+ $ref: '#/components/schemas/ReachError'
19081
+ '500':
19082
+ description: Internal Server Error
19083
+ content:
19084
+ text/plain:
19085
+ schema:
19086
+ $ref: '#/components/schemas/ReachError'
19087
+ application/json:
19088
+ schema:
19089
+ $ref: '#/components/schemas/ReachError'
19090
+ text/json:
19091
+ schema:
19092
+ $ref: '#/components/schemas/ReachError'
19093
+ '422':
19094
+ description: Unprocessable Content
19095
+ content:
19096
+ text/plain:
19097
+ schema:
19098
+ $ref: '#/components/schemas/ValidationResultModel'
19099
+ application/json:
19100
+ schema:
19101
+ $ref: '#/components/schemas/ValidationResultModel'
19102
+ text/json:
19103
+ schema:
19104
+ $ref: '#/components/schemas/ValidationResultModel'
19105
+ /api/auth/customer/authorize:
19106
+ get:
19107
+ tags:
19108
+ - CustomerAuth
19109
+ summary: Initiates WorkOS AuthKit authentication flow.
19110
+ operationId: Authorize
19111
+ parameters:
19112
+ - name: tenantSubdomain
19113
+ in: query
19114
+ description: 'Optional tenant subdomain (from query, for sign-in page links).'
19115
+ schema:
19116
+ type: string
19117
+ - name: returnTo
19118
+ in: query
19119
+ description: 'Optional path to redirect to after login (e.g. "/" for storefront, "/account" for account portal). Defaults to "/account" if omitted. Must start with "/" to prevent open redirects.'
19120
+ schema:
19121
+ type: string
19122
+ - name: login_hint
19123
+ in: query
19124
+ description: Optional email hint for AuthKit sign-in UI.
19125
+ schema:
19126
+ type: string
19127
+ - name: expected_email
19128
+ in: query
19129
+ description: 'Optional email that callback must match (state validation), even when AuthKit login hint is omitted.'
19130
+ schema:
19131
+ type: string
19132
+ - name: screen_hint
19133
+ in: query
19134
+ description: Optional AuthKit screen (`sign-in` or `sign-up`).
19135
+ schema:
19136
+ type: string
19137
+ - name: prompt
19138
+ in: query
19139
+ description: Optional OAuth prompt (e.g. `login` to reduce silent reuse of another WorkOS session in the browser).
19140
+ schema:
19141
+ type: string
19142
+ responses:
19143
+ '200':
19144
+ description: OK
19145
+ '400':
19146
+ description: Bad Request
19147
+ content:
19148
+ text/plain:
19149
+ schema:
19150
+ $ref: '#/components/schemas/ReachError'
19151
+ application/json:
19152
+ schema:
19153
+ $ref: '#/components/schemas/ReachError'
19154
+ text/json:
19155
+ schema:
19156
+ $ref: '#/components/schemas/ReachError'
19157
+ '500':
19158
+ description: Internal Server Error
19159
+ content:
19160
+ text/plain:
19161
+ schema:
19162
+ $ref: '#/components/schemas/ReachError'
19163
+ application/json:
19164
+ schema:
19165
+ $ref: '#/components/schemas/ReachError'
19166
+ text/json:
19167
+ schema:
19168
+ $ref: '#/components/schemas/ReachError'
19169
+ '422':
19170
+ description: Unprocessable Content
19171
+ content:
19172
+ text/plain:
19173
+ schema:
19174
+ $ref: '#/components/schemas/ValidationResultModel'
19175
+ application/json:
19176
+ schema:
19177
+ $ref: '#/components/schemas/ValidationResultModel'
19178
+ text/json:
19179
+ schema:
19180
+ $ref: '#/components/schemas/ValidationResultModel'
19181
+ /api/auth/customer/callback:
19182
+ get:
19183
+ tags:
19184
+ - CustomerAuth
19185
+ summary: Handles WorkOS AuthKit callback after user authentication.
19186
+ operationId: Callback
19187
+ parameters:
19188
+ - name: code
19189
+ in: query
19190
+ description: Authorization code from WorkOS.
19191
+ schema:
19192
+ type: string
19193
+ - name: state
19194
+ in: query
19195
+ description: State parameter for CSRF protection.
19196
+ schema:
19197
+ type: string
19198
+ responses:
19199
+ '200':
19200
+ description: OK
19201
+ '400':
19202
+ description: Bad Request
19203
+ content:
19204
+ text/plain:
19205
+ schema:
19206
+ $ref: '#/components/schemas/ReachError'
19207
+ application/json:
19208
+ schema:
19209
+ $ref: '#/components/schemas/ReachError'
19210
+ text/json:
19211
+ schema:
19212
+ $ref: '#/components/schemas/ReachError'
19213
+ '500':
19214
+ description: Internal Server Error
19215
+ content:
19216
+ text/plain:
19217
+ schema:
19218
+ $ref: '#/components/schemas/ReachError'
19219
+ application/json:
19220
+ schema:
19221
+ $ref: '#/components/schemas/ReachError'
19222
+ text/json:
19223
+ schema:
19224
+ $ref: '#/components/schemas/ReachError'
19225
+ '422':
19226
+ description: Unprocessable Content
19227
+ content:
19228
+ text/plain:
19229
+ schema:
19230
+ $ref: '#/components/schemas/ValidationResultModel'
19231
+ application/json:
19232
+ schema:
19233
+ $ref: '#/components/schemas/ValidationResultModel'
19234
+ text/json:
19235
+ schema:
19236
+ $ref: '#/components/schemas/ValidationResultModel'
19237
+ /api/auth/customer/logout:
19238
+ get:
19239
+ tags:
19240
+ - CustomerAuth
19241
+ summary: Handles customer logout.
19242
+ operationId: Logout
19243
+ parameters:
19244
+ - name: sessionId
19245
+ in: query
19246
+ description: Optional WorkOS session ID (if using WorkOS session cookies).
19247
+ schema:
19248
+ type: string
19249
+ - name: tenantSubdomain
19250
+ in: query
19251
+ description: 'Optional tenant subdomain (required when API host differs from storefront, e.g. cross-origin logout).'
19252
+ schema:
19253
+ type: string
19254
+ responses:
19255
+ '200':
19256
+ description: OK
19257
+ '400':
19258
+ description: Bad Request
19259
+ content:
19260
+ text/plain:
19261
+ schema:
19262
+ $ref: '#/components/schemas/ReachError'
19263
+ application/json:
19264
+ schema:
19265
+ $ref: '#/components/schemas/ReachError'
19266
+ text/json:
19267
+ schema:
19268
+ $ref: '#/components/schemas/ReachError'
19269
+ '500':
19270
+ description: Internal Server Error
19271
+ content:
19272
+ text/plain:
19273
+ schema:
19274
+ $ref: '#/components/schemas/ReachError'
19275
+ application/json:
19276
+ schema:
19277
+ $ref: '#/components/schemas/ReachError'
19278
+ text/json:
19279
+ schema:
19280
+ $ref: '#/components/schemas/ReachError'
19281
+ '422':
19282
+ description: Unprocessable Content
19283
+ content:
19284
+ text/plain:
19285
+ schema:
19286
+ $ref: '#/components/schemas/ValidationResultModel'
19287
+ application/json:
19288
+ schema:
19289
+ $ref: '#/components/schemas/ValidationResultModel'
19290
+ text/json:
19291
+ schema:
19292
+ $ref: '#/components/schemas/ValidationResultModel'
19293
+ /api/customer-portal/me:
19294
+ get:
19295
+ tags:
19296
+ - CustomerPortal
19297
+ summary: Returns the current authenticated customer's profile.
19298
+ operationId: Me
19299
+ responses:
19300
+ '200':
19301
+ description: OK
19302
+ '400':
19303
+ description: Bad Request
19304
+ content:
19305
+ text/plain:
19306
+ schema:
19307
+ $ref: '#/components/schemas/ReachError'
19308
+ application/json:
19309
+ schema:
19310
+ $ref: '#/components/schemas/ReachError'
19311
+ text/json:
19312
+ schema:
19313
+ $ref: '#/components/schemas/ReachError'
19314
+ '500':
19315
+ description: Internal Server Error
19316
+ content:
19317
+ text/plain:
19318
+ schema:
19319
+ $ref: '#/components/schemas/ReachError'
19320
+ application/json:
19321
+ schema:
19322
+ $ref: '#/components/schemas/ReachError'
19323
+ text/json:
19324
+ schema:
19325
+ $ref: '#/components/schemas/ReachError'
19326
+ '422':
19327
+ description: Unprocessable Content
19328
+ content:
19329
+ text/plain:
19330
+ schema:
19331
+ $ref: '#/components/schemas/ValidationResultModel'
19332
+ application/json:
19333
+ schema:
19334
+ $ref: '#/components/schemas/ValidationResultModel'
19335
+ text/json:
19336
+ schema:
19337
+ $ref: '#/components/schemas/ValidationResultModel'
19338
+ /api/customer-portal/account:
19339
+ get:
19340
+ tags:
19341
+ - CustomerPortal
19342
+ summary: 'Returns the authenticated customer''s account details for this tenant (fields editable via PATCH, except email which is read-only in the portal).'
19343
+ operationId: GetAccount
19344
+ responses:
19345
+ '200':
19346
+ description: OK
19347
+ '400':
19348
+ description: Bad Request
19349
+ content:
19350
+ text/plain:
19351
+ schema:
19352
+ $ref: '#/components/schemas/ReachError'
19353
+ application/json:
19354
+ schema:
19355
+ $ref: '#/components/schemas/ReachError'
19356
+ text/json:
19357
+ schema:
19358
+ $ref: '#/components/schemas/ReachError'
19359
+ '500':
19360
+ description: Internal Server Error
19361
+ content:
19362
+ text/plain:
19363
+ schema:
19364
+ $ref: '#/components/schemas/ReachError'
19365
+ application/json:
19366
+ schema:
19367
+ $ref: '#/components/schemas/ReachError'
19368
+ text/json:
19369
+ schema:
19370
+ $ref: '#/components/schemas/ReachError'
19371
+ '422':
19372
+ description: Unprocessable Content
19373
+ content:
19374
+ text/plain:
19375
+ schema:
19376
+ $ref: '#/components/schemas/ValidationResultModel'
19377
+ application/json:
19378
+ schema:
19379
+ $ref: '#/components/schemas/ValidationResultModel'
19380
+ text/json:
19381
+ schema:
19382
+ $ref: '#/components/schemas/ValidationResultModel'
19383
+ patch:
19384
+ tags:
19385
+ - CustomerPortal
19386
+ summary: Updates the authenticated customer's account for this tenant (partial update). Email cannot be changed via this endpoint.
19387
+ operationId: PatchAccount
19388
+ requestBody:
19389
+ description: Fields to update.
19390
+ content:
19391
+ application/json:
19392
+ schema:
19393
+ $ref: '#/components/schemas/CustomerPortalAccountPatch'
19394
+ text/json:
19395
+ schema:
19396
+ $ref: '#/components/schemas/CustomerPortalAccountPatch'
19397
+ application/*+json:
19398
+ schema:
19399
+ $ref: '#/components/schemas/CustomerPortalAccountPatch'
19400
+ responses:
19401
+ '200':
19402
+ description: OK
19403
+ '400':
19404
+ description: Bad Request
19405
+ content:
19406
+ text/plain:
19407
+ schema:
19408
+ $ref: '#/components/schemas/ReachError'
19409
+ application/json:
19410
+ schema:
19411
+ $ref: '#/components/schemas/ReachError'
19412
+ text/json:
19413
+ schema:
19414
+ $ref: '#/components/schemas/ReachError'
19415
+ '500':
19416
+ description: Internal Server Error
19417
+ content:
19418
+ text/plain:
19419
+ schema:
19420
+ $ref: '#/components/schemas/ReachError'
19421
+ application/json:
19422
+ schema:
19423
+ $ref: '#/components/schemas/ReachError'
19424
+ text/json:
19425
+ schema:
19426
+ $ref: '#/components/schemas/ReachError'
19427
+ '422':
19428
+ description: Unprocessable Content
19429
+ content:
19430
+ text/plain:
19431
+ schema:
19432
+ $ref: '#/components/schemas/ValidationResultModel'
19433
+ application/json:
19434
+ schema:
19435
+ $ref: '#/components/schemas/ValidationResultModel'
19436
+ text/json:
19437
+ schema:
19438
+ $ref: '#/components/schemas/ValidationResultModel'
19439
+ /api/customer-portal/participants:
19440
+ get:
19441
+ tags:
19442
+ - CustomerPortal
19443
+ summary: "Returns the participant profiles (attendees) for the authenticated customer in this tenant.\r\nResolves customer by end_user_identity_id (User -> Customer) with email fallback for unlinked users."
19444
+ operationId: GetParticipants
18072
19445
  responses:
18073
19446
  '200':
18074
19447
  description: OK
@@ -157929,6 +159302,10 @@ components:
157929
159302
  minLength: 1
157930
159303
  type: string
157931
159304
  description: Gets or sets the last name.
159305
+ externalReference:
159306
+ type: string
159307
+ description: Gets or sets the tenant-scoped external reference for integration with external systems.
159308
+ nullable: true
157932
159309
  nameAbbreviation:
157933
159310
  minLength: 1
157934
159311
  type: string
@@ -157986,6 +159363,10 @@ components:
157986
159363
  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
159364
  format: date-time
157988
159365
  nullable: true
159366
+ externalReference:
159367
+ type: string
159368
+ 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."
159369
+ nullable: true
157989
159370
  additionalProperties: false
157990
159371
  description: Post model for attendee updates.
157991
159372
  AttendeePost:
@@ -158041,6 +159422,10 @@ components:
158041
159422
  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
159423
  format: date-time
158043
159424
  nullable: true
159425
+ externalReference:
159426
+ type: string
159427
+ 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."
159428
+ nullable: true
158044
159429
  additionalProperties: false
158045
159430
  description: Post model for attendee inserts.
158046
159431
  AttendeeWalletDeductionPreview:
@@ -160411,80 +161796,648 @@ components:
160411
161796
  type: boolean
160412
161797
  description: Gets or sets a value indicating whether the record is live and available for use within the application.
160413
161798
  default: false
160414
- entityType:
160415
- $ref: '#/components/schemas/CustomFieldValueEntityType'
160416
- label:
160417
- type: string
160418
- description: Gets or sets the custom field label.
160419
- nullable: true
160420
- description:
160421
- type: string
160422
- description: Gets or sets the custom field description.
160423
- nullable: true
160424
- dataType:
160425
- $ref: '#/components/schemas/CustomFieldDataType'
160426
- required:
160427
- type: boolean
160428
- description: Gets or sets a value indicating whether the field is required.
160429
- nullable: true
160430
- publicVisibility:
160431
- type: boolean
160432
- description: Gets or sets a value indicating whether the field has public visibility.
160433
- nullable: true
160434
- displayOrder:
160435
- type: integer
160436
- description: Gets or sets the display order.
160437
- format: int32
160438
- nullable: true
160439
- archived:
160440
- type: boolean
160441
- description: Gets or sets a value indicating whether the field is archived.
160442
- nullable: true
160443
- validationJson:
160444
- type: string
160445
- description: Gets or sets the validation JSON (min/max/regex etc).
160446
- nullable: true
160447
- defaultValueText:
161799
+ entityType:
161800
+ $ref: '#/components/schemas/CustomFieldValueEntityType'
161801
+ label:
161802
+ type: string
161803
+ description: Gets or sets the custom field label.
161804
+ nullable: true
161805
+ description:
161806
+ type: string
161807
+ description: Gets or sets the custom field description.
161808
+ nullable: true
161809
+ dataType:
161810
+ $ref: '#/components/schemas/CustomFieldDataType'
161811
+ required:
161812
+ type: boolean
161813
+ description: Gets or sets a value indicating whether the field is required.
161814
+ nullable: true
161815
+ publicVisibility:
161816
+ type: boolean
161817
+ description: Gets or sets a value indicating whether the field has public visibility.
161818
+ nullable: true
161819
+ displayOrder:
161820
+ type: integer
161821
+ description: Gets or sets the display order.
161822
+ format: int32
161823
+ nullable: true
161824
+ archived:
161825
+ type: boolean
161826
+ description: Gets or sets a value indicating whether the field is archived.
161827
+ nullable: true
161828
+ validationJson:
161829
+ type: string
161830
+ description: Gets or sets the validation JSON (min/max/regex etc).
161831
+ nullable: true
161832
+ defaultValueText:
161833
+ type: string
161834
+ description: Gets or sets the default text value.
161835
+ nullable: true
161836
+ defaultValueNumber:
161837
+ type: integer
161838
+ description: Gets or sets the default number value.
161839
+ format: int64
161840
+ nullable: true
161841
+ defaultValueDecimal:
161842
+ type: number
161843
+ description: Gets or sets the default decimal value.
161844
+ format: double
161845
+ nullable: true
161846
+ defaultValueBit:
161847
+ type: boolean
161848
+ description: Gets or sets the default bit value.
161849
+ nullable: true
161850
+ defaultValueDate:
161851
+ type: string
161852
+ description: Gets or sets the default date value.
161853
+ format: date-time
161854
+ nullable: true
161855
+ defaultValueDatetimeoffset:
161856
+ type: string
161857
+ description: Gets or sets the default datetimeoffset value.
161858
+ format: date-time
161859
+ nullable: true
161860
+ defaultValueJson:
161861
+ type: string
161862
+ description: Gets or sets the default JSON value.
161863
+ nullable: true
161864
+ options:
161865
+ type: array
161866
+ items:
161867
+ $ref: '#/components/schemas/CustomFieldOption'
161868
+ description: Gets or sets the options for this custom field definition.
161869
+ nullable: true
161870
+ additionalProperties: false
161871
+ description: Represents a custom field definition within the Reach application.
161872
+ CustomFieldDefinitionPage:
161873
+ required:
161874
+ - items
161875
+ - pagination
161876
+ type: object
161877
+ properties:
161878
+ pagination:
161879
+ $ref: '#/components/schemas/Pagination'
161880
+ items:
161881
+ type: array
161882
+ items:
161883
+ $ref: '#/components/schemas/CustomFieldDefinition'
161884
+ readOnly: true
161885
+ additionalProperties: false
161886
+ CustomFieldDefinitionPatch:
161887
+ required:
161888
+ - id
161889
+ - tenantId
161890
+ type: object
161891
+ properties:
161892
+ tenantId:
161893
+ type: string
161894
+ description: Gets or sets the tenant Id.
161895
+ format: uuid
161896
+ id:
161897
+ type: string
161898
+ description: Gets or sets the Id.
161899
+ format: uuid
161900
+ entityType:
161901
+ $ref: '#/components/schemas/CustomFieldValueEntityType'
161902
+ label:
161903
+ type: string
161904
+ description: Gets or sets the custom field label.
161905
+ nullable: true
161906
+ description:
161907
+ type: string
161908
+ description: Gets or sets the custom field description.
161909
+ nullable: true
161910
+ dataType:
161911
+ $ref: '#/components/schemas/CustomFieldDataType'
161912
+ required:
161913
+ type: boolean
161914
+ description: Gets or sets a value indicating whether the field is required.
161915
+ nullable: true
161916
+ publicVisibility:
161917
+ type: boolean
161918
+ description: Gets or sets a value indicating whether the field has public visibility.
161919
+ nullable: true
161920
+ displayOrder:
161921
+ type: integer
161922
+ description: Gets or sets the display order.
161923
+ format: int32
161924
+ nullable: true
161925
+ validationJson:
161926
+ type: string
161927
+ description: Gets or sets the validation JSON.
161928
+ nullable: true
161929
+ defaultValueText:
161930
+ type: string
161931
+ description: Gets or sets the default text value.
161932
+ nullable: true
161933
+ defaultValueNumber:
161934
+ type: integer
161935
+ description: Gets or sets the default number value.
161936
+ format: int64
161937
+ nullable: true
161938
+ defaultValueDecimal:
161939
+ type: number
161940
+ description: Gets or sets the default decimal value.
161941
+ format: double
161942
+ nullable: true
161943
+ defaultValueBit:
161944
+ type: boolean
161945
+ description: Gets or sets the default bit value.
161946
+ nullable: true
161947
+ defaultValueDate:
161948
+ type: string
161949
+ description: Gets or sets the default date value.
161950
+ format: date-time
161951
+ nullable: true
161952
+ defaultValueDatetimeoffset:
161953
+ type: string
161954
+ description: Gets or sets the default datetimeoffset value.
161955
+ format: date-time
161956
+ nullable: true
161957
+ defaultValueJson:
161958
+ type: string
161959
+ description: Gets or sets the default JSON value.
161960
+ nullable: true
161961
+ archived:
161962
+ type: boolean
161963
+ description: Gets or sets a value indicating whether the field is archived.
161964
+ nullable: true
161965
+ options:
161966
+ type: array
161967
+ items:
161968
+ $ref: '#/components/schemas/UpdateCustomFieldOption'
161969
+ description: Gets or sets the custom field options.
161970
+ nullable: true
161971
+ additionalProperties: false
161972
+ description: Patch model for the custom field definition.
161973
+ CustomFieldDefinitionPost:
161974
+ required:
161975
+ - tenantId
161976
+ type: object
161977
+ properties:
161978
+ tenantId:
161979
+ type: string
161980
+ description: Gets or sets the tenant Id.
161981
+ format: uuid
161982
+ entityType:
161983
+ $ref: '#/components/schemas/CustomFieldValueEntityType'
161984
+ label:
161985
+ type: string
161986
+ description: Gets or sets the custom field label.
161987
+ nullable: true
161988
+ description:
161989
+ type: string
161990
+ description: Gets or sets the custom field description.
161991
+ nullable: true
161992
+ dataType:
161993
+ $ref: '#/components/schemas/CustomFieldDataType'
161994
+ required:
161995
+ type: boolean
161996
+ description: Gets or sets a value indicating whether the field is required.
161997
+ nullable: true
161998
+ publicVisibility:
161999
+ type: boolean
162000
+ description: Gets or sets a value indicating whether the field has public visibility.
162001
+ nullable: true
162002
+ displayOrder:
162003
+ type: integer
162004
+ description: Gets or sets the display order.
162005
+ format: int32
162006
+ nullable: true
162007
+ validationJson:
162008
+ type: string
162009
+ description: Gets or sets the validation JSON.
162010
+ nullable: true
162011
+ defaultValueText:
162012
+ type: string
162013
+ description: Gets or sets the default text value.
162014
+ nullable: true
162015
+ defaultValueNumber:
162016
+ type: integer
162017
+ description: Gets or sets the default number value.
162018
+ format: int64
162019
+ nullable: true
162020
+ defaultValueDecimal:
162021
+ type: number
162022
+ description: Gets or sets the default decimal value.
162023
+ format: double
162024
+ nullable: true
162025
+ defaultValueBit:
162026
+ type: boolean
162027
+ description: Gets or sets the default bit value.
162028
+ nullable: true
162029
+ defaultValueDate:
162030
+ type: string
162031
+ description: Gets or sets the default date value.
162032
+ format: date-time
162033
+ nullable: true
162034
+ defaultValueDatetimeoffset:
162035
+ type: string
162036
+ description: Gets or sets the default datetimeoffset value.
162037
+ format: date-time
162038
+ nullable: true
162039
+ defaultValueJson:
162040
+ type: string
162041
+ description: Gets or sets the default JSON value.
162042
+ nullable: true
162043
+ options:
162044
+ type: array
162045
+ items:
162046
+ $ref: '#/components/schemas/CustomFieldOptionPost'
162047
+ description: Gets or sets the options for select types.
162048
+ nullable: true
162049
+ archived:
162050
+ type: boolean
162051
+ description: Gets or sets a value indicating whether the field is archived.
162052
+ nullable: true
162053
+ additionalProperties: false
162054
+ description: Post model for the custom field definition.
162055
+ CustomFieldDefinitionWithValue:
162056
+ type: object
162057
+ properties:
162058
+ tenantId:
162059
+ type: string
162060
+ description: Gets or sets the tenant id.
162061
+ format: uuid
162062
+ definitionId:
162063
+ type: string
162064
+ description: Gets or sets the definition id.
162065
+ format: uuid
162066
+ nullable: true
162067
+ label:
162068
+ type: string
162069
+ description: Gets or sets the custom field label.
162070
+ nullable: true
162071
+ description:
162072
+ type: string
162073
+ description: Gets or sets the custom field description.
162074
+ nullable: true
162075
+ dataType:
162076
+ $ref: '#/components/schemas/CustomFieldDataType'
162077
+ required:
162078
+ type: boolean
162079
+ description: Gets or sets a value indicating whether the field is required.
162080
+ nullable: true
162081
+ publicVisibility:
162082
+ type: boolean
162083
+ description: Gets or sets a value indicating whether the field has public visibility.
162084
+ nullable: true
162085
+ displayOrder:
162086
+ type: integer
162087
+ description: Gets or sets the display order.
162088
+ format: int32
162089
+ nullable: true
162090
+ validationJson:
162091
+ type: string
162092
+ description: Gets or sets the validation JSON.
162093
+ nullable: true
162094
+ defaultValueText:
162095
+ type: string
162096
+ description: Gets or sets the default text value.
162097
+ nullable: true
162098
+ defaultValueNumber:
162099
+ type: integer
162100
+ description: Gets or sets the default number value.
162101
+ format: int64
162102
+ nullable: true
162103
+ defaultValueDecimal:
162104
+ type: number
162105
+ description: Gets or sets the default decimal value.
162106
+ format: double
162107
+ nullable: true
162108
+ defaultValueBit:
162109
+ type: boolean
162110
+ description: Gets or sets the default bit value.
162111
+ nullable: true
162112
+ defaultValueDate:
162113
+ type: string
162114
+ description: Gets or sets the default date value.
162115
+ format: date-time
162116
+ nullable: true
162117
+ defaultValueDatetimeoffset:
162118
+ type: string
162119
+ description: Gets or sets the default datetimeoffset value.
162120
+ format: date-time
162121
+ nullable: true
162122
+ defaultValueJson:
162123
+ type: string
162124
+ description: Gets or sets the default JSON value.
162125
+ nullable: true
162126
+ options:
162127
+ type: array
162128
+ items:
162129
+ $ref: '#/components/schemas/CustomFieldOptionDto'
162130
+ description: Gets or sets the options for select types.
162131
+ nullable: true
162132
+ value:
162133
+ description: 'Gets or sets the current value (can be text, number, decimal, bit, date, datetimeoffset, or json).'
162134
+ nullable: true
162135
+ additionalProperties: false
162136
+ description: Represents a custom field definition with its current value for editing.
162137
+ CustomFieldOption:
162138
+ required:
162139
+ - dateCreated
162140
+ - dateModified
162141
+ - isLive
162142
+ - tenantId
162143
+ type: object
162144
+ properties:
162145
+ id:
162146
+ type: string
162147
+ description: Gets or sets the entities Id.
162148
+ format: uuid
162149
+ tenantId:
162150
+ type: string
162151
+ description: Gets or sets the tenant Id.
162152
+ format: uuid
162153
+ dateCreated:
162154
+ type: string
162155
+ description: Gets or sets the created date of this entity.
162156
+ format: date-time
162157
+ dateModified:
162158
+ type: string
162159
+ description: Gets or sets the last modified date of this entity.
162160
+ format: date-time
162161
+ modifiedById:
162162
+ type: string
162163
+ description: Gets or sets the modified by Id.
162164
+ format: uuid
162165
+ nullable: true
162166
+ isLive:
162167
+ type: boolean
162168
+ description: Gets or sets a value indicating whether the record is live and available for use within the application.
162169
+ default: false
162170
+ customFieldDefinitionId:
162171
+ type: string
162172
+ description: Gets or sets the custom field definition id.
162173
+ format: uuid
162174
+ nullable: true
162175
+ label:
162176
+ type: string
162177
+ description: Gets or sets the option label.
162178
+ nullable: true
162179
+ displayOrder:
162180
+ type: integer
162181
+ description: Gets or sets the display order.
162182
+ format: int32
162183
+ nullable: true
162184
+ archived:
162185
+ type: boolean
162186
+ description: Gets or sets a value indicating whether the option is archived.
162187
+ nullable: true
162188
+ additionalProperties: false
162189
+ description: Represents a custom field option within the Reach application.
162190
+ CustomFieldOptionDto:
162191
+ type: object
162192
+ properties:
162193
+ label:
162194
+ type: string
162195
+ description: Gets or sets the option label.
162196
+ nullable: true
162197
+ additionalProperties: false
162198
+ description: Represents a custom field option DTO.
162199
+ CustomFieldOptionPost:
162200
+ type: object
162201
+ properties:
162202
+ label:
162203
+ type: string
162204
+ description: Gets or sets the option label.
162205
+ nullable: true
162206
+ displayOrder:
162207
+ type: integer
162208
+ description: Gets or sets the display order.
162209
+ format: int32
162210
+ nullable: true
162211
+ additionalProperties: false
162212
+ description: Post model for the custom field option.
162213
+ CustomFieldValueEntityType:
162214
+ enum:
162215
+ - Venue
162216
+ - Course
162217
+ - Session
162218
+ type: string
162219
+ description: Controls the entity type for custom field values.
162220
+ CustomFieldValueUpdate:
162221
+ type: object
162222
+ properties:
162223
+ definitionId:
162224
+ type: string
162225
+ description: Gets or sets the custom field definition id.
162226
+ format: uuid
162227
+ value:
162228
+ description: Gets or sets the value to set.
162229
+ nullable: true
162230
+ additionalProperties: false
162231
+ description: Represents a single custom field value update.
162232
+ CustomFieldsBulkUpdate:
162233
+ type: object
162234
+ properties:
162235
+ values:
162236
+ type: array
162237
+ items:
162238
+ $ref: '#/components/schemas/CustomFieldValueUpdate'
162239
+ description: Gets or sets the list of custom field values to update.
162240
+ nullable: true
162241
+ additionalProperties: false
162242
+ description: Represents a bulk update request for custom fields.
162243
+ Customer:
162244
+ required:
162245
+ - dateCreated
162246
+ - dateModified
162247
+ - isLive
162248
+ - nameAbbreviation
162249
+ - tenantId
162250
+ type: object
162251
+ properties:
162252
+ id:
162253
+ type: string
162254
+ description: Gets or sets the entities Id.
162255
+ format: uuid
162256
+ tenantId:
162257
+ type: string
162258
+ description: Gets or sets the tenant Id.
162259
+ format: uuid
162260
+ dateCreated:
162261
+ type: string
162262
+ description: Gets or sets the created date of this entity.
162263
+ format: date-time
162264
+ dateModified:
162265
+ type: string
162266
+ description: Gets or sets the last modified date of this entity.
162267
+ format: date-time
162268
+ modifiedById:
162269
+ type: string
162270
+ description: Gets or sets the modified by Id.
162271
+ format: uuid
162272
+ nullable: true
162273
+ isLive:
162274
+ type: boolean
162275
+ description: Gets or sets a value indicating whether the record is live and available for use within the application.
162276
+ default: false
162277
+ type:
162278
+ $ref: '#/components/schemas/CustomerType'
162279
+ firstName:
162280
+ type: string
162281
+ description: Gets or sets the first name.
162282
+ nullable: true
162283
+ lastName:
162284
+ type: string
162285
+ description: Gets or sets the last name.
162286
+ nullable: true
162287
+ nameAbbreviation:
162288
+ minLength: 1
162289
+ type: string
162290
+ description: Gets the attendees abbreviated name.
162291
+ readOnly: true
162292
+ name:
162293
+ type: string
162294
+ description: Gets or sets the organisation name.
162295
+ nullable: true
162296
+ displayEmail:
162297
+ type: string
162298
+ description: Gets or sets the email.
162299
+ nullable: true
162300
+ phone:
162301
+ type: string
162302
+ description: Gets or sets the phone number.
162303
+ nullable: true
162304
+ streetAddress:
162305
+ type: string
162306
+ description: Gets or sets the customer street address.
162307
+ nullable: true
162308
+ addressLocality:
162309
+ type: string
162310
+ description: Gets or sets the customer locality.
162311
+ nullable: true
162312
+ addressRegion:
162313
+ type: string
162314
+ description: Gets or sets the customer region.
162315
+ nullable: true
162316
+ addressPostalcode:
162317
+ type: string
162318
+ description: Gets or sets the customer postcode.
162319
+ nullable: true
162320
+ countryId:
162321
+ type: integer
162322
+ description: Gets or sets the customer country id.
162323
+ format: int32
162324
+ nullable: true
162325
+ marketingOptIn:
162326
+ type: boolean
162327
+ description: Gets or sets a value indicating whether the customer is opted into marketing.
162328
+ default: false
162329
+ country:
162330
+ $ref: '#/components/schemas/Country'
162331
+ isActiveCustomer:
162332
+ type: boolean
162333
+ description: '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.'
162334
+ default: false
162335
+ bookingCount:
162336
+ type: integer
162337
+ description: Gets or sets how many times the customer has booked with the organisation.
162338
+ format: int32
162339
+ nullable: true
162340
+ endUserIdentityId:
162341
+ type: string
162342
+ description: Gets or sets the customers end user identity id.
162343
+ format: uuid
162344
+ nullable: true
162345
+ stats:
162346
+ $ref: '#/components/schemas/CustomerStats'
162347
+ attendees:
162348
+ type: array
162349
+ items:
162350
+ $ref: '#/components/schemas/Attendee'
162351
+ description: Gets or sets the attendees registered by the customer.
162352
+ nullable: true
162353
+ wallet:
162354
+ $ref: '#/components/schemas/Wallet'
162355
+ additionalProperties: false
162356
+ description: Represents an organisation within the Reach application.
162357
+ CustomerAccountInvitePatch:
162358
+ required:
162359
+ - id
162360
+ - tenantId
162361
+ type: object
162362
+ properties:
162363
+ tenantId:
162364
+ type: string
162365
+ description: Gets or sets the tenant Id.
162366
+ format: uuid
162367
+ id:
162368
+ type: string
162369
+ description: Gets or sets the Id.
162370
+ format: uuid
162371
+ acceptanceCode:
162372
+ type: string
162373
+ description: Gets or sets the acceptance code for the account invite.
162374
+ nullable: true
162375
+ baseDomain:
162376
+ type: string
162377
+ description: 'Gets or sets the base domain for the invite link. If not provided, will use configuration value.'
162378
+ nullable: true
162379
+ registrationUrl:
162380
+ type: string
162381
+ description: 'Gets or sets an optional override for the customer WorkOS registration URL. If not provided, the API builds it from configuration and tenant subdomain.'
162382
+ nullable: true
162383
+ additionalProperties: false
162384
+ description: Patch model for sending account invite email to the customer.
162385
+ CustomerAccountInviteSchedule:
162386
+ required:
162387
+ - dateCreated
162388
+ - dateModified
162389
+ - isLive
162390
+ - tenantId
162391
+ type: object
162392
+ properties:
162393
+ id:
162394
+ type: string
162395
+ description: Gets or sets the entities Id.
162396
+ format: uuid
162397
+ tenantId:
162398
+ type: string
162399
+ description: Gets or sets the tenant Id.
162400
+ format: uuid
162401
+ dateCreated:
162402
+ type: string
162403
+ description: Gets or sets the created date of this entity.
162404
+ format: date-time
162405
+ dateModified:
162406
+ type: string
162407
+ description: Gets or sets the last modified date of this entity.
162408
+ format: date-time
162409
+ modifiedById:
162410
+ type: string
162411
+ description: Gets or sets the modified by Id.
162412
+ format: uuid
162413
+ nullable: true
162414
+ isLive:
162415
+ type: boolean
162416
+ description: Gets or sets a value indicating whether the record is live and available for use within the application.
162417
+ default: false
162418
+ customerId:
160448
162419
  type: string
160449
- description: Gets or sets the default text value.
160450
- nullable: true
160451
- defaultValueNumber:
160452
- type: integer
160453
- description: Gets or sets the default number value.
160454
- format: int64
160455
- nullable: true
160456
- defaultValueDecimal:
160457
- type: number
160458
- description: Gets or sets the default decimal value.
160459
- format: double
160460
- nullable: true
160461
- defaultValueBit:
160462
- type: boolean
160463
- description: Gets or sets the default bit value.
160464
- nullable: true
160465
- defaultValueDate:
162420
+ description: Gets or sets the customer id.
162421
+ format: uuid
162422
+ walletCreditPeriodId:
160466
162423
  type: string
160467
- description: Gets or sets the default date value.
160468
- format: date-time
160469
- nullable: true
160470
- defaultValueDatetimeoffset:
162424
+ description: Gets or sets the wallet credit period id that triggered this invite schedule.
162425
+ format: uuid
162426
+ dateScheduled:
160471
162427
  type: string
160472
- description: Gets or sets the default datetimeoffset value.
162428
+ description: Gets or sets the date the invite is scheduled to send.
160473
162429
  format: date-time
160474
- nullable: true
160475
- defaultValueJson:
160476
- type: string
160477
- description: Gets or sets the default JSON value.
160478
- nullable: true
160479
- options:
160480
- type: array
160481
- items:
160482
- $ref: '#/components/schemas/CustomFieldOption'
160483
- description: Gets or sets the options for this custom field definition.
160484
- nullable: true
162430
+ sent:
162431
+ type: boolean
162432
+ description: Gets or sets a value indicating whether the invite has been sent.
162433
+ default: false
162434
+ errored:
162435
+ type: boolean
162436
+ description: Gets or sets a value indicating whether sending the invite errored.
162437
+ default: false
160485
162438
  additionalProperties: false
160486
- description: Represents a custom field definition within the Reach application.
160487
- CustomFieldDefinitionPage:
162439
+ description: Represents a scheduled customer account invite email tied to a wallet credit period.
162440
+ CustomerAccountInviteSchedulePage:
160488
162441
  required:
160489
162442
  - items
160490
162443
  - pagination
@@ -160495,10 +162448,10 @@ components:
160495
162448
  items:
160496
162449
  type: array
160497
162450
  items:
160498
- $ref: '#/components/schemas/CustomFieldDefinition'
162451
+ $ref: '#/components/schemas/CustomerAccountInviteSchedule'
160499
162452
  readOnly: true
160500
162453
  additionalProperties: false
160501
- CustomFieldDefinitionPatch:
162454
+ CustomerAccountInviteSchedulePatch:
160502
162455
  required:
160503
162456
  - id
160504
162457
  - tenantId
@@ -160512,80 +162465,9 @@ components:
160512
162465
  type: string
160513
162466
  description: Gets or sets the Id.
160514
162467
  format: uuid
160515
- entityType:
160516
- $ref: '#/components/schemas/CustomFieldValueEntityType'
160517
- label:
160518
- type: string
160519
- description: Gets or sets the custom field label.
160520
- nullable: true
160521
- description:
160522
- type: string
160523
- description: Gets or sets the custom field description.
160524
- nullable: true
160525
- dataType:
160526
- $ref: '#/components/schemas/CustomFieldDataType'
160527
- required:
160528
- type: boolean
160529
- description: Gets or sets a value indicating whether the field is required.
160530
- nullable: true
160531
- publicVisibility:
160532
- type: boolean
160533
- description: Gets or sets a value indicating whether the field has public visibility.
160534
- nullable: true
160535
- displayOrder:
160536
- type: integer
160537
- description: Gets or sets the display order.
160538
- format: int32
160539
- nullable: true
160540
- validationJson:
160541
- type: string
160542
- description: Gets or sets the validation JSON.
160543
- nullable: true
160544
- defaultValueText:
160545
- type: string
160546
- description: Gets or sets the default text value.
160547
- nullable: true
160548
- defaultValueNumber:
160549
- type: integer
160550
- description: Gets or sets the default number value.
160551
- format: int64
160552
- nullable: true
160553
- defaultValueDecimal:
160554
- type: number
160555
- description: Gets or sets the default decimal value.
160556
- format: double
160557
- nullable: true
160558
- defaultValueBit:
160559
- type: boolean
160560
- description: Gets or sets the default bit value.
160561
- nullable: true
160562
- defaultValueDate:
160563
- type: string
160564
- description: Gets or sets the default date value.
160565
- format: date-time
160566
- nullable: true
160567
- defaultValueDatetimeoffset:
160568
- type: string
160569
- description: Gets or sets the default datetimeoffset value.
160570
- format: date-time
160571
- nullable: true
160572
- defaultValueJson:
160573
- type: string
160574
- description: Gets or sets the default JSON value.
160575
- nullable: true
160576
- archived:
160577
- type: boolean
160578
- description: Gets or sets a value indicating whether the field is archived.
160579
- nullable: true
160580
- options:
160581
- type: array
160582
- items:
160583
- $ref: '#/components/schemas/UpdateCustomFieldOption'
160584
- description: Gets or sets the custom field options.
160585
- nullable: true
160586
162468
  additionalProperties: false
160587
- description: Patch model for the custom field definition.
160588
- CustomFieldDefinitionPost:
162469
+ description: Patch model for customer account invite schedule updates.
162470
+ CustomerAccountInviteSchedulePost:
160589
162471
  required:
160590
162472
  - tenantId
160591
162473
  type: object
@@ -160594,409 +162476,8 @@ components:
160594
162476
  type: string
160595
162477
  description: Gets or sets the tenant Id.
160596
162478
  format: uuid
160597
- entityType:
160598
- $ref: '#/components/schemas/CustomFieldValueEntityType'
160599
- label:
160600
- type: string
160601
- description: Gets or sets the custom field label.
160602
- nullable: true
160603
- description:
160604
- type: string
160605
- description: Gets or sets the custom field description.
160606
- nullable: true
160607
- dataType:
160608
- $ref: '#/components/schemas/CustomFieldDataType'
160609
- required:
160610
- type: boolean
160611
- description: Gets or sets a value indicating whether the field is required.
160612
- nullable: true
160613
- publicVisibility:
160614
- type: boolean
160615
- description: Gets or sets a value indicating whether the field has public visibility.
160616
- nullable: true
160617
- displayOrder:
160618
- type: integer
160619
- description: Gets or sets the display order.
160620
- format: int32
160621
- nullable: true
160622
- validationJson:
160623
- type: string
160624
- description: Gets or sets the validation JSON.
160625
- nullable: true
160626
- defaultValueText:
160627
- type: string
160628
- description: Gets or sets the default text value.
160629
- nullable: true
160630
- defaultValueNumber:
160631
- type: integer
160632
- description: Gets or sets the default number value.
160633
- format: int64
160634
- nullable: true
160635
- defaultValueDecimal:
160636
- type: number
160637
- description: Gets or sets the default decimal value.
160638
- format: double
160639
- nullable: true
160640
- defaultValueBit:
160641
- type: boolean
160642
- description: Gets or sets the default bit value.
160643
- nullable: true
160644
- defaultValueDate:
160645
- type: string
160646
- description: Gets or sets the default date value.
160647
- format: date-time
160648
- nullable: true
160649
- defaultValueDatetimeoffset:
160650
- type: string
160651
- description: Gets or sets the default datetimeoffset value.
160652
- format: date-time
160653
- nullable: true
160654
- defaultValueJson:
160655
- type: string
160656
- description: Gets or sets the default JSON value.
160657
- nullable: true
160658
- options:
160659
- type: array
160660
- items:
160661
- $ref: '#/components/schemas/CustomFieldOptionPost'
160662
- description: Gets or sets the options for select types.
160663
- nullable: true
160664
- archived:
160665
- type: boolean
160666
- description: Gets or sets a value indicating whether the field is archived.
160667
- nullable: true
160668
162479
  additionalProperties: false
160669
- description: Post model for the custom field definition.
160670
- CustomFieldDefinitionWithValue:
160671
- type: object
160672
- properties:
160673
- tenantId:
160674
- type: string
160675
- description: Gets or sets the tenant id.
160676
- format: uuid
160677
- definitionId:
160678
- type: string
160679
- description: Gets or sets the definition id.
160680
- format: uuid
160681
- nullable: true
160682
- label:
160683
- type: string
160684
- description: Gets or sets the custom field label.
160685
- nullable: true
160686
- description:
160687
- type: string
160688
- description: Gets or sets the custom field description.
160689
- nullable: true
160690
- dataType:
160691
- $ref: '#/components/schemas/CustomFieldDataType'
160692
- required:
160693
- type: boolean
160694
- description: Gets or sets a value indicating whether the field is required.
160695
- nullable: true
160696
- publicVisibility:
160697
- type: boolean
160698
- description: Gets or sets a value indicating whether the field has public visibility.
160699
- nullable: true
160700
- displayOrder:
160701
- type: integer
160702
- description: Gets or sets the display order.
160703
- format: int32
160704
- nullable: true
160705
- validationJson:
160706
- type: string
160707
- description: Gets or sets the validation JSON.
160708
- nullable: true
160709
- defaultValueText:
160710
- type: string
160711
- description: Gets or sets the default text value.
160712
- nullable: true
160713
- defaultValueNumber:
160714
- type: integer
160715
- description: Gets or sets the default number value.
160716
- format: int64
160717
- nullable: true
160718
- defaultValueDecimal:
160719
- type: number
160720
- description: Gets or sets the default decimal value.
160721
- format: double
160722
- nullable: true
160723
- defaultValueBit:
160724
- type: boolean
160725
- description: Gets or sets the default bit value.
160726
- nullable: true
160727
- defaultValueDate:
160728
- type: string
160729
- description: Gets or sets the default date value.
160730
- format: date-time
160731
- nullable: true
160732
- defaultValueDatetimeoffset:
160733
- type: string
160734
- description: Gets or sets the default datetimeoffset value.
160735
- format: date-time
160736
- nullable: true
160737
- defaultValueJson:
160738
- type: string
160739
- description: Gets or sets the default JSON value.
160740
- nullable: true
160741
- options:
160742
- type: array
160743
- items:
160744
- $ref: '#/components/schemas/CustomFieldOptionDto'
160745
- description: Gets or sets the options for select types.
160746
- nullable: true
160747
- value:
160748
- description: 'Gets or sets the current value (can be text, number, decimal, bit, date, datetimeoffset, or json).'
160749
- nullable: true
160750
- additionalProperties: false
160751
- description: Represents a custom field definition with its current value for editing.
160752
- CustomFieldOption:
160753
- required:
160754
- - dateCreated
160755
- - dateModified
160756
- - isLive
160757
- - tenantId
160758
- type: object
160759
- properties:
160760
- id:
160761
- type: string
160762
- description: Gets or sets the entities Id.
160763
- format: uuid
160764
- tenantId:
160765
- type: string
160766
- description: Gets or sets the tenant Id.
160767
- format: uuid
160768
- dateCreated:
160769
- type: string
160770
- description: Gets or sets the created date of this entity.
160771
- format: date-time
160772
- dateModified:
160773
- type: string
160774
- description: Gets or sets the last modified date of this entity.
160775
- format: date-time
160776
- modifiedById:
160777
- type: string
160778
- description: Gets or sets the modified by Id.
160779
- format: uuid
160780
- nullable: true
160781
- isLive:
160782
- type: boolean
160783
- description: Gets or sets a value indicating whether the record is live and available for use within the application.
160784
- default: false
160785
- customFieldDefinitionId:
160786
- type: string
160787
- description: Gets or sets the custom field definition id.
160788
- format: uuid
160789
- nullable: true
160790
- label:
160791
- type: string
160792
- description: Gets or sets the option label.
160793
- nullable: true
160794
- displayOrder:
160795
- type: integer
160796
- description: Gets or sets the display order.
160797
- format: int32
160798
- nullable: true
160799
- archived:
160800
- type: boolean
160801
- description: Gets or sets a value indicating whether the option is archived.
160802
- nullable: true
160803
- additionalProperties: false
160804
- description: Represents a custom field option within the Reach application.
160805
- CustomFieldOptionDto:
160806
- type: object
160807
- properties:
160808
- label:
160809
- type: string
160810
- description: Gets or sets the option label.
160811
- nullable: true
160812
- additionalProperties: false
160813
- description: Represents a custom field option DTO.
160814
- CustomFieldOptionPost:
160815
- type: object
160816
- properties:
160817
- label:
160818
- type: string
160819
- description: Gets or sets the option label.
160820
- nullable: true
160821
- displayOrder:
160822
- type: integer
160823
- description: Gets or sets the display order.
160824
- format: int32
160825
- nullable: true
160826
- additionalProperties: false
160827
- description: Post model for the custom field option.
160828
- CustomFieldValueEntityType:
160829
- enum:
160830
- - Venue
160831
- - Course
160832
- - Session
160833
- type: string
160834
- description: Controls the entity type for custom field values.
160835
- CustomFieldValueUpdate:
160836
- type: object
160837
- properties:
160838
- definitionId:
160839
- type: string
160840
- description: Gets or sets the custom field definition id.
160841
- format: uuid
160842
- value:
160843
- description: Gets or sets the value to set.
160844
- nullable: true
160845
- additionalProperties: false
160846
- description: Represents a single custom field value update.
160847
- CustomFieldsBulkUpdate:
160848
- type: object
160849
- properties:
160850
- values:
160851
- type: array
160852
- items:
160853
- $ref: '#/components/schemas/CustomFieldValueUpdate'
160854
- description: Gets or sets the list of custom field values to update.
160855
- nullable: true
160856
- additionalProperties: false
160857
- description: Represents a bulk update request for custom fields.
160858
- Customer:
160859
- required:
160860
- - dateCreated
160861
- - dateModified
160862
- - isLive
160863
- - nameAbbreviation
160864
- - tenantId
160865
- type: object
160866
- properties:
160867
- id:
160868
- type: string
160869
- description: Gets or sets the entities Id.
160870
- format: uuid
160871
- tenantId:
160872
- type: string
160873
- description: Gets or sets the tenant Id.
160874
- format: uuid
160875
- dateCreated:
160876
- type: string
160877
- description: Gets or sets the created date of this entity.
160878
- format: date-time
160879
- dateModified:
160880
- type: string
160881
- description: Gets or sets the last modified date of this entity.
160882
- format: date-time
160883
- modifiedById:
160884
- type: string
160885
- description: Gets or sets the modified by Id.
160886
- format: uuid
160887
- nullable: true
160888
- isLive:
160889
- type: boolean
160890
- description: Gets or sets a value indicating whether the record is live and available for use within the application.
160891
- default: false
160892
- type:
160893
- $ref: '#/components/schemas/CustomerType'
160894
- firstName:
160895
- type: string
160896
- description: Gets or sets the first name.
160897
- nullable: true
160898
- lastName:
160899
- type: string
160900
- description: Gets or sets the last name.
160901
- nullable: true
160902
- nameAbbreviation:
160903
- minLength: 1
160904
- type: string
160905
- description: Gets the attendees abbreviated name.
160906
- readOnly: true
160907
- name:
160908
- type: string
160909
- description: Gets or sets the organisation name.
160910
- nullable: true
160911
- displayEmail:
160912
- type: string
160913
- description: Gets or sets the email.
160914
- nullable: true
160915
- phone:
160916
- type: string
160917
- description: Gets or sets the phone number.
160918
- nullable: true
160919
- streetAddress:
160920
- type: string
160921
- description: Gets or sets the customer street address.
160922
- nullable: true
160923
- addressLocality:
160924
- type: string
160925
- description: Gets or sets the customer locality.
160926
- nullable: true
160927
- addressRegion:
160928
- type: string
160929
- description: Gets or sets the customer region.
160930
- nullable: true
160931
- addressPostalcode:
160932
- type: string
160933
- description: Gets or sets the customer postcode.
160934
- nullable: true
160935
- countryId:
160936
- type: integer
160937
- description: Gets or sets the customer country id.
160938
- format: int32
160939
- nullable: true
160940
- marketingOptIn:
160941
- type: boolean
160942
- description: Gets or sets a value indicating whether the customer is opted into marketing.
160943
- default: false
160944
- country:
160945
- $ref: '#/components/schemas/Country'
160946
- isActiveCustomer:
160947
- type: boolean
160948
- description: '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.'
160949
- default: false
160950
- bookingCount:
160951
- type: integer
160952
- description: Gets or sets how many times the customer has booked with the organisation.
160953
- format: int32
160954
- nullable: true
160955
- endUserIdentityId:
160956
- type: string
160957
- description: Gets or sets the customers end user identity id.
160958
- format: uuid
160959
- nullable: true
160960
- stats:
160961
- $ref: '#/components/schemas/CustomerStats'
160962
- attendees:
160963
- type: array
160964
- items:
160965
- $ref: '#/components/schemas/Attendee'
160966
- description: Gets or sets the attendees registered by the customer.
160967
- nullable: true
160968
- wallet:
160969
- $ref: '#/components/schemas/Wallet'
160970
- additionalProperties: false
160971
- description: Represents an organisation within the Reach application.
160972
- CustomerAccountInvitePatch:
160973
- required:
160974
- - id
160975
- - tenantId
160976
- type: object
160977
- properties:
160978
- tenantId:
160979
- type: string
160980
- description: Gets or sets the tenant Id.
160981
- format: uuid
160982
- id:
160983
- type: string
160984
- description: Gets or sets the Id.
160985
- format: uuid
160986
- acceptanceCode:
160987
- type: string
160988
- description: Gets or sets the acceptance code for the account invite.
160989
- nullable: true
160990
- baseDomain:
160991
- type: string
160992
- description: 'Gets or sets the base domain for the invite link. If not provided, will use configuration value.'
160993
- nullable: true
160994
- registrationUrl:
160995
- type: string
160996
- description: 'Gets or sets an optional override for the customer WorkOS registration URL. If not provided, the API builds it from configuration and tenant subdomain.'
160997
- nullable: true
160998
- additionalProperties: false
160999
- description: Patch model for sending account invite email to the customer.
162480
+ description: Post model for customer account invite schedule inserts.
161000
162481
  CustomerCancellationOption:
161001
162482
  enum:
161002
162483
  - Cancellable
@@ -173975,6 +175456,11 @@ components:
173975
175456
  type: boolean
173976
175457
  description: "Gets or sets a value indicating whether wallet credit periods are enabled for the tenant.\r\nWhen enabled, attendee wallets require an active credit period for bookings and allocation management."
173977
175458
  default: false
175459
+ walletCreditPeriodAccountInviteDaysBefore:
175460
+ type: integer
175461
+ description: "Gets or sets how many days before a credit period start date to send the customer account invite.\r\nAllowed values: 0 (on period start), 7 (one week before), 14 (two weeks before).\r\nOnly applies when Reach.Models.TenantSetting.EnableWalletCreditPeriods is true."
175462
+ format: int32
175463
+ nullable: true
173978
175464
  customerLoginRequiresPreprovision:
173979
175465
  type: boolean
173980
175466
  description: "Gets or sets a value indicating whether customer portal WorkOS login is restricted to pre-provisioned customers only.\r\nWhen true, the authenticated email must match a live customer row (email or display_email) for this tenant."
@@ -173987,6 +175473,18 @@ components:
173987
175473
  type: boolean
173988
175474
  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
175475
  default: false
175476
+ enableAttendeeExternalReference:
175477
+ type: boolean
175478
+ description: Gets or sets a value indicating whether attendee external references are enabled for the tenant.
175479
+ default: false
175480
+ requireAttendeeExternalReference:
175481
+ type: boolean
175482
+ description: Gets or sets a value indicating whether external_reference is required when creating attendees.
175483
+ default: false
175484
+ attendeeExternalReferenceLabel:
175485
+ type: string
175486
+ description: Gets or sets the label shown for the attendee external reference field in partner UI.
175487
+ nullable: true
173990
175488
  orderNumber:
173991
175489
  type: string
173992
175490
  description: Gets the next order number in the sequence.
@@ -174011,6 +175509,11 @@ components:
174011
175509
  type: boolean
174012
175510
  description: "Gets or sets whether WorkOS customer sign-in is shown for this tenant (storefront rollout).\r\nWhen null, PATCH leaves the existing database value unchanged."
174013
175511
  nullable: true
175512
+ walletCreditPeriodAccountInviteDaysBefore:
175513
+ type: integer
175514
+ description: "Gets or sets how many days before a credit period start date to automatically send customer account invites.\r\nAllowed values: 0 (on period start), 7 (one week before), 14 (two weeks before).\r\nWhen null, PATCH leaves the existing database value unchanged."
175515
+ format: int32
175516
+ nullable: true
174014
175517
  additionalProperties: false
174015
175518
  description: Partial update for storefront-related tenant settings (partner API).
174016
175519
  TenantTier: