reach-api-sdk 1.0.229 → 1.0.231
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/reach-sdk.d.ts +575 -1
- package/dist/reach-sdk.js +451 -1
- package/package.json +1 -1
- package/src/apiClient.ts +3 -0
- package/src/definition/swagger.yaml +2009 -546
- package/src/index.ts +5 -0
- package/src/models/CustomerAccountInviteSchedule.ts +54 -0
- package/src/models/CustomerAccountInviteSchedulePage.ts +12 -0
- package/src/models/CustomerAccountInviteSchedulePatch.ts +18 -0
- package/src/models/CustomerAccountInviteSchedulePost.ts +14 -0
- package/src/models/CustomerStats.ts +8 -0
- package/src/models/TenantSetting.ts +6 -0
- package/src/models/TenantStorefrontSettingsPatch.ts +6 -0
- package/src/services/CustomerAccountInviteSchedulesService.ts +859 -0
|
@@ -17703,6 +17703,1354 @@ paths:
|
|
|
17703
17703
|
text/json:
|
|
17704
17704
|
schema:
|
|
17705
17705
|
$ref: '#/components/schemas/ValidationResultModel'
|
|
17706
|
+
/api/customer-account-invite-schedules/send-batch:
|
|
17707
|
+
get:
|
|
17708
|
+
tags:
|
|
17709
|
+
- CustomerAccountInviteSchedules
|
|
17710
|
+
summary: Sends due customer account invite emails.
|
|
17711
|
+
operationId: SendDueInvites
|
|
17712
|
+
responses:
|
|
17713
|
+
'200':
|
|
17714
|
+
description: OK
|
|
17715
|
+
'400':
|
|
17716
|
+
description: Bad Request
|
|
17717
|
+
content:
|
|
17718
|
+
text/plain:
|
|
17719
|
+
schema:
|
|
17720
|
+
$ref: '#/components/schemas/ReachError'
|
|
17721
|
+
application/json:
|
|
17722
|
+
schema:
|
|
17723
|
+
$ref: '#/components/schemas/ReachError'
|
|
17724
|
+
text/json:
|
|
17725
|
+
schema:
|
|
17726
|
+
$ref: '#/components/schemas/ReachError'
|
|
17727
|
+
'500':
|
|
17728
|
+
description: Internal Server Error
|
|
17729
|
+
content:
|
|
17730
|
+
text/plain:
|
|
17731
|
+
schema:
|
|
17732
|
+
$ref: '#/components/schemas/ReachError'
|
|
17733
|
+
application/json:
|
|
17734
|
+
schema:
|
|
17735
|
+
$ref: '#/components/schemas/ReachError'
|
|
17736
|
+
text/json:
|
|
17737
|
+
schema:
|
|
17738
|
+
$ref: '#/components/schemas/ReachError'
|
|
17739
|
+
'422':
|
|
17740
|
+
description: Unprocessable Content
|
|
17741
|
+
content:
|
|
17742
|
+
text/plain:
|
|
17743
|
+
schema:
|
|
17744
|
+
$ref: '#/components/schemas/ValidationResultModel'
|
|
17745
|
+
application/json:
|
|
17746
|
+
schema:
|
|
17747
|
+
$ref: '#/components/schemas/ValidationResultModel'
|
|
17748
|
+
text/json:
|
|
17749
|
+
schema:
|
|
17750
|
+
$ref: '#/components/schemas/ValidationResultModel'
|
|
17751
|
+
/api/customer-account-invite-schedules/v2-temporary-route:
|
|
17752
|
+
post:
|
|
17753
|
+
tags:
|
|
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
|
+
responses:
|
|
17770
|
+
'200':
|
|
17771
|
+
description: OK
|
|
17772
|
+
content:
|
|
17773
|
+
text/plain:
|
|
17774
|
+
schema:
|
|
17775
|
+
$ref: '#/components/schemas/CustomerAccountInviteSchedule'
|
|
17776
|
+
application/json:
|
|
17777
|
+
schema:
|
|
17778
|
+
$ref: '#/components/schemas/CustomerAccountInviteSchedule'
|
|
17779
|
+
text/json:
|
|
17780
|
+
schema:
|
|
17781
|
+
$ref: '#/components/schemas/CustomerAccountInviteSchedule'
|
|
17782
|
+
'400':
|
|
17783
|
+
description: Bad Request
|
|
17784
|
+
content:
|
|
17785
|
+
text/plain:
|
|
17786
|
+
schema:
|
|
17787
|
+
$ref: '#/components/schemas/ReachError'
|
|
17788
|
+
application/json:
|
|
17789
|
+
schema:
|
|
17790
|
+
$ref: '#/components/schemas/ReachError'
|
|
17791
|
+
text/json:
|
|
17792
|
+
schema:
|
|
17793
|
+
$ref: '#/components/schemas/ReachError'
|
|
17794
|
+
'500':
|
|
17795
|
+
description: Internal Server Error
|
|
17796
|
+
content:
|
|
17797
|
+
text/plain:
|
|
17798
|
+
schema:
|
|
17799
|
+
$ref: '#/components/schemas/ReachError'
|
|
17800
|
+
application/json:
|
|
17801
|
+
schema:
|
|
17802
|
+
$ref: '#/components/schemas/ReachError'
|
|
17803
|
+
text/json:
|
|
17804
|
+
schema:
|
|
17805
|
+
$ref: '#/components/schemas/ReachError'
|
|
17806
|
+
'422':
|
|
17807
|
+
description: Unprocessable Content
|
|
17808
|
+
content:
|
|
17809
|
+
text/plain:
|
|
17810
|
+
schema:
|
|
17811
|
+
$ref: '#/components/schemas/ValidationResultModel'
|
|
17812
|
+
application/json:
|
|
17813
|
+
schema:
|
|
17814
|
+
$ref: '#/components/schemas/ValidationResultModel'
|
|
17815
|
+
text/json:
|
|
17816
|
+
schema:
|
|
17817
|
+
$ref: '#/components/schemas/ValidationResultModel'
|
|
17818
|
+
patch:
|
|
17819
|
+
tags:
|
|
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'
|
|
17835
|
+
responses:
|
|
17836
|
+
'200':
|
|
17837
|
+
description: OK
|
|
17838
|
+
content:
|
|
17839
|
+
text/plain:
|
|
17840
|
+
schema:
|
|
17841
|
+
$ref: '#/components/schemas/CustomerAccountInviteSchedule'
|
|
17842
|
+
application/json:
|
|
17843
|
+
schema:
|
|
17844
|
+
$ref: '#/components/schemas/CustomerAccountInviteSchedule'
|
|
17845
|
+
text/json:
|
|
17846
|
+
schema:
|
|
17847
|
+
$ref: '#/components/schemas/CustomerAccountInviteSchedule'
|
|
17848
|
+
'400':
|
|
17849
|
+
description: Bad Request
|
|
17850
|
+
content:
|
|
17851
|
+
text/plain:
|
|
17852
|
+
schema:
|
|
17853
|
+
$ref: '#/components/schemas/ReachError'
|
|
17854
|
+
application/json:
|
|
17855
|
+
schema:
|
|
17856
|
+
$ref: '#/components/schemas/ReachError'
|
|
17857
|
+
text/json:
|
|
17858
|
+
schema:
|
|
17859
|
+
$ref: '#/components/schemas/ReachError'
|
|
17860
|
+
'500':
|
|
17861
|
+
description: Internal Server Error
|
|
17862
|
+
content:
|
|
17863
|
+
text/plain:
|
|
17864
|
+
schema:
|
|
17865
|
+
$ref: '#/components/schemas/ReachError'
|
|
17866
|
+
application/json:
|
|
17867
|
+
schema:
|
|
17868
|
+
$ref: '#/components/schemas/ReachError'
|
|
17869
|
+
text/json:
|
|
17870
|
+
schema:
|
|
17871
|
+
$ref: '#/components/schemas/ReachError'
|
|
17872
|
+
'422':
|
|
17873
|
+
description: Unprocessable Content
|
|
17874
|
+
content:
|
|
17875
|
+
text/plain:
|
|
17876
|
+
schema:
|
|
17877
|
+
$ref: '#/components/schemas/ValidationResultModel'
|
|
17878
|
+
application/json:
|
|
17879
|
+
schema:
|
|
17880
|
+
$ref: '#/components/schemas/ValidationResultModel'
|
|
17881
|
+
text/json:
|
|
17882
|
+
schema:
|
|
17883
|
+
$ref: '#/components/schemas/ValidationResultModel'
|
|
17884
|
+
/api/customer-account-invite-schedules/v2-temporary-route/list:
|
|
17885
|
+
post:
|
|
17886
|
+
tags:
|
|
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'
|
|
17908
|
+
responses:
|
|
17909
|
+
'200':
|
|
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'
|
|
17927
|
+
'400':
|
|
17928
|
+
description: Bad Request
|
|
17929
|
+
content:
|
|
17930
|
+
text/plain:
|
|
17931
|
+
schema:
|
|
17932
|
+
$ref: '#/components/schemas/ReachError'
|
|
17933
|
+
application/json:
|
|
17934
|
+
schema:
|
|
17935
|
+
$ref: '#/components/schemas/ReachError'
|
|
17936
|
+
text/json:
|
|
17937
|
+
schema:
|
|
17938
|
+
$ref: '#/components/schemas/ReachError'
|
|
17939
|
+
'500':
|
|
17940
|
+
description: Internal Server Error
|
|
17941
|
+
content:
|
|
17942
|
+
text/plain:
|
|
17943
|
+
schema:
|
|
17944
|
+
$ref: '#/components/schemas/ReachError'
|
|
17945
|
+
application/json:
|
|
17946
|
+
schema:
|
|
17947
|
+
$ref: '#/components/schemas/ReachError'
|
|
17948
|
+
text/json:
|
|
17949
|
+
schema:
|
|
17950
|
+
$ref: '#/components/schemas/ReachError'
|
|
17951
|
+
'422':
|
|
17952
|
+
description: Unprocessable Content
|
|
17953
|
+
content:
|
|
17954
|
+
text/plain:
|
|
17955
|
+
schema:
|
|
17956
|
+
$ref: '#/components/schemas/ValidationResultModel'
|
|
17957
|
+
application/json:
|
|
17958
|
+
schema:
|
|
17959
|
+
$ref: '#/components/schemas/ValidationResultModel'
|
|
17960
|
+
text/json:
|
|
17961
|
+
schema:
|
|
17962
|
+
$ref: '#/components/schemas/ValidationResultModel'
|
|
17963
|
+
/api/customer-account-invite-schedules/v2-temporary-route/with-references:
|
|
17964
|
+
patch:
|
|
17965
|
+
tags:
|
|
17966
|
+
- CustomerAccountInviteSchedules
|
|
17967
|
+
summary: Patches the resource.
|
|
17968
|
+
operationId: PatchWithReferences
|
|
17969
|
+
requestBody:
|
|
17970
|
+
description: The <typeparamref name="TObject" /> model.
|
|
17971
|
+
content:
|
|
17972
|
+
application/json:
|
|
17973
|
+
schema:
|
|
17974
|
+
$ref: '#/components/schemas/CustomerAccountInviteSchedulePatch'
|
|
17975
|
+
text/json:
|
|
17976
|
+
schema:
|
|
17977
|
+
$ref: '#/components/schemas/CustomerAccountInviteSchedulePatch'
|
|
17978
|
+
application/*+json:
|
|
17979
|
+
schema:
|
|
17980
|
+
$ref: '#/components/schemas/CustomerAccountInviteSchedulePatch'
|
|
17981
|
+
responses:
|
|
17982
|
+
'200':
|
|
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'
|
|
17994
|
+
'400':
|
|
17995
|
+
description: Bad Request
|
|
17996
|
+
content:
|
|
17997
|
+
text/plain:
|
|
17998
|
+
schema:
|
|
17999
|
+
$ref: '#/components/schemas/ReachError'
|
|
18000
|
+
application/json:
|
|
18001
|
+
schema:
|
|
18002
|
+
$ref: '#/components/schemas/ReachError'
|
|
18003
|
+
text/json:
|
|
18004
|
+
schema:
|
|
18005
|
+
$ref: '#/components/schemas/ReachError'
|
|
18006
|
+
'500':
|
|
18007
|
+
description: Internal Server Error
|
|
18008
|
+
content:
|
|
18009
|
+
text/plain:
|
|
18010
|
+
schema:
|
|
18011
|
+
$ref: '#/components/schemas/ReachError'
|
|
18012
|
+
application/json:
|
|
18013
|
+
schema:
|
|
18014
|
+
$ref: '#/components/schemas/ReachError'
|
|
18015
|
+
text/json:
|
|
18016
|
+
schema:
|
|
18017
|
+
$ref: '#/components/schemas/ReachError'
|
|
18018
|
+
'422':
|
|
18019
|
+
description: Unprocessable Content
|
|
18020
|
+
content:
|
|
18021
|
+
text/plain:
|
|
18022
|
+
schema:
|
|
18023
|
+
$ref: '#/components/schemas/ValidationResultModel'
|
|
18024
|
+
application/json:
|
|
18025
|
+
schema:
|
|
18026
|
+
$ref: '#/components/schemas/ValidationResultModel'
|
|
18027
|
+
text/json:
|
|
18028
|
+
schema:
|
|
18029
|
+
$ref: '#/components/schemas/ValidationResultModel'
|
|
18030
|
+
/api/customer-account-invite-schedules:
|
|
18031
|
+
delete:
|
|
18032
|
+
tags:
|
|
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'
|
|
17706
19054
|
/api/auth/customer/authorize-debug:
|
|
17707
19055
|
get:
|
|
17708
19056
|
tags:
|
|
@@ -160448,80 +161796,648 @@ components:
|
|
|
160448
161796
|
type: boolean
|
|
160449
161797
|
description: Gets or sets a value indicating whether the record is live and available for use within the application.
|
|
160450
161798
|
default: false
|
|
160451
|
-
entityType:
|
|
160452
|
-
$ref: '#/components/schemas/CustomFieldValueEntityType'
|
|
160453
|
-
label:
|
|
160454
|
-
type: string
|
|
160455
|
-
description: Gets or sets the custom field label.
|
|
160456
|
-
nullable: true
|
|
160457
|
-
description:
|
|
160458
|
-
type: string
|
|
160459
|
-
description: Gets or sets the custom field description.
|
|
160460
|
-
nullable: true
|
|
160461
|
-
dataType:
|
|
160462
|
-
$ref: '#/components/schemas/CustomFieldDataType'
|
|
160463
|
-
required:
|
|
160464
|
-
type: boolean
|
|
160465
|
-
description: Gets or sets a value indicating whether the field is required.
|
|
160466
|
-
nullable: true
|
|
160467
|
-
publicVisibility:
|
|
160468
|
-
type: boolean
|
|
160469
|
-
description: Gets or sets a value indicating whether the field has public visibility.
|
|
160470
|
-
nullable: true
|
|
160471
|
-
displayOrder:
|
|
160472
|
-
type: integer
|
|
160473
|
-
description: Gets or sets the display order.
|
|
160474
|
-
format: int32
|
|
160475
|
-
nullable: true
|
|
160476
|
-
archived:
|
|
160477
|
-
type: boolean
|
|
160478
|
-
description: Gets or sets a value indicating whether the field is archived.
|
|
160479
|
-
nullable: true
|
|
160480
|
-
validationJson:
|
|
160481
|
-
type: string
|
|
160482
|
-
description: Gets or sets the validation JSON (min/max/regex etc).
|
|
160483
|
-
nullable: true
|
|
160484
|
-
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:
|
|
160485
162419
|
type: string
|
|
160486
|
-
description: Gets or sets the
|
|
160487
|
-
|
|
160488
|
-
|
|
160489
|
-
type: integer
|
|
160490
|
-
description: Gets or sets the default number value.
|
|
160491
|
-
format: int64
|
|
160492
|
-
nullable: true
|
|
160493
|
-
defaultValueDecimal:
|
|
160494
|
-
type: number
|
|
160495
|
-
description: Gets or sets the default decimal value.
|
|
160496
|
-
format: double
|
|
160497
|
-
nullable: true
|
|
160498
|
-
defaultValueBit:
|
|
160499
|
-
type: boolean
|
|
160500
|
-
description: Gets or sets the default bit value.
|
|
160501
|
-
nullable: true
|
|
160502
|
-
defaultValueDate:
|
|
162420
|
+
description: Gets or sets the customer id.
|
|
162421
|
+
format: uuid
|
|
162422
|
+
walletCreditPeriodId:
|
|
160503
162423
|
type: string
|
|
160504
|
-
description: Gets or sets the
|
|
160505
|
-
format:
|
|
160506
|
-
|
|
160507
|
-
defaultValueDatetimeoffset:
|
|
162424
|
+
description: Gets or sets the wallet credit period id that triggered this invite schedule.
|
|
162425
|
+
format: uuid
|
|
162426
|
+
dateScheduled:
|
|
160508
162427
|
type: string
|
|
160509
|
-
description: Gets or sets the
|
|
162428
|
+
description: Gets or sets the date the invite is scheduled to send.
|
|
160510
162429
|
format: date-time
|
|
160511
|
-
|
|
160512
|
-
|
|
160513
|
-
|
|
160514
|
-
|
|
160515
|
-
|
|
160516
|
-
|
|
160517
|
-
|
|
160518
|
-
|
|
160519
|
-
$ref: '#/components/schemas/CustomFieldOption'
|
|
160520
|
-
description: Gets or sets the options for this custom field definition.
|
|
160521
|
-
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
|
|
160522
162438
|
additionalProperties: false
|
|
160523
|
-
description: Represents a
|
|
160524
|
-
|
|
162439
|
+
description: Represents a scheduled customer account invite email tied to a wallet credit period.
|
|
162440
|
+
CustomerAccountInviteSchedulePage:
|
|
160525
162441
|
required:
|
|
160526
162442
|
- items
|
|
160527
162443
|
- pagination
|
|
@@ -160532,10 +162448,10 @@ components:
|
|
|
160532
162448
|
items:
|
|
160533
162449
|
type: array
|
|
160534
162450
|
items:
|
|
160535
|
-
$ref: '#/components/schemas/
|
|
162451
|
+
$ref: '#/components/schemas/CustomerAccountInviteSchedule'
|
|
160536
162452
|
readOnly: true
|
|
160537
162453
|
additionalProperties: false
|
|
160538
|
-
|
|
162454
|
+
CustomerAccountInviteSchedulePatch:
|
|
160539
162455
|
required:
|
|
160540
162456
|
- id
|
|
160541
162457
|
- tenantId
|
|
@@ -160549,466 +162465,10 @@ components:
|
|
|
160549
162465
|
type: string
|
|
160550
162466
|
description: Gets or sets the Id.
|
|
160551
162467
|
format: uuid
|
|
160552
|
-
entityType:
|
|
160553
|
-
$ref: '#/components/schemas/CustomFieldValueEntityType'
|
|
160554
|
-
label:
|
|
160555
|
-
type: string
|
|
160556
|
-
description: Gets or sets the custom field label.
|
|
160557
|
-
nullable: true
|
|
160558
|
-
description:
|
|
160559
|
-
type: string
|
|
160560
|
-
description: Gets or sets the custom field description.
|
|
160561
|
-
nullable: true
|
|
160562
|
-
dataType:
|
|
160563
|
-
$ref: '#/components/schemas/CustomFieldDataType'
|
|
160564
|
-
required:
|
|
160565
|
-
type: boolean
|
|
160566
|
-
description: Gets or sets a value indicating whether the field is required.
|
|
160567
|
-
nullable: true
|
|
160568
|
-
publicVisibility:
|
|
160569
|
-
type: boolean
|
|
160570
|
-
description: Gets or sets a value indicating whether the field has public visibility.
|
|
160571
|
-
nullable: true
|
|
160572
|
-
displayOrder:
|
|
160573
|
-
type: integer
|
|
160574
|
-
description: Gets or sets the display order.
|
|
160575
|
-
format: int32
|
|
160576
|
-
nullable: true
|
|
160577
|
-
validationJson:
|
|
160578
|
-
type: string
|
|
160579
|
-
description: Gets or sets the validation JSON.
|
|
160580
|
-
nullable: true
|
|
160581
|
-
defaultValueText:
|
|
160582
|
-
type: string
|
|
160583
|
-
description: Gets or sets the default text value.
|
|
160584
|
-
nullable: true
|
|
160585
|
-
defaultValueNumber:
|
|
160586
|
-
type: integer
|
|
160587
|
-
description: Gets or sets the default number value.
|
|
160588
|
-
format: int64
|
|
160589
|
-
nullable: true
|
|
160590
|
-
defaultValueDecimal:
|
|
160591
|
-
type: number
|
|
160592
|
-
description: Gets or sets the default decimal value.
|
|
160593
|
-
format: double
|
|
160594
|
-
nullable: true
|
|
160595
|
-
defaultValueBit:
|
|
160596
|
-
type: boolean
|
|
160597
|
-
description: Gets or sets the default bit value.
|
|
160598
|
-
nullable: true
|
|
160599
|
-
defaultValueDate:
|
|
160600
|
-
type: string
|
|
160601
|
-
description: Gets or sets the default date value.
|
|
160602
|
-
format: date-time
|
|
160603
|
-
nullable: true
|
|
160604
|
-
defaultValueDatetimeoffset:
|
|
160605
|
-
type: string
|
|
160606
|
-
description: Gets or sets the default datetimeoffset value.
|
|
160607
|
-
format: date-time
|
|
160608
|
-
nullable: true
|
|
160609
|
-
defaultValueJson:
|
|
160610
|
-
type: string
|
|
160611
|
-
description: Gets or sets the default JSON value.
|
|
160612
|
-
nullable: true
|
|
160613
|
-
archived:
|
|
160614
|
-
type: boolean
|
|
160615
|
-
description: Gets or sets a value indicating whether the field is archived.
|
|
160616
|
-
nullable: true
|
|
160617
|
-
options:
|
|
160618
|
-
type: array
|
|
160619
|
-
items:
|
|
160620
|
-
$ref: '#/components/schemas/UpdateCustomFieldOption'
|
|
160621
|
-
description: Gets or sets the custom field options.
|
|
160622
|
-
nullable: true
|
|
160623
|
-
additionalProperties: false
|
|
160624
|
-
description: Patch model for the custom field definition.
|
|
160625
|
-
CustomFieldDefinitionPost:
|
|
160626
|
-
required:
|
|
160627
|
-
- tenantId
|
|
160628
|
-
type: object
|
|
160629
|
-
properties:
|
|
160630
|
-
tenantId:
|
|
160631
|
-
type: string
|
|
160632
|
-
description: Gets or sets the tenant Id.
|
|
160633
|
-
format: uuid
|
|
160634
|
-
entityType:
|
|
160635
|
-
$ref: '#/components/schemas/CustomFieldValueEntityType'
|
|
160636
|
-
label:
|
|
160637
|
-
type: string
|
|
160638
|
-
description: Gets or sets the custom field label.
|
|
160639
|
-
nullable: true
|
|
160640
|
-
description:
|
|
160641
|
-
type: string
|
|
160642
|
-
description: Gets or sets the custom field description.
|
|
160643
|
-
nullable: true
|
|
160644
|
-
dataType:
|
|
160645
|
-
$ref: '#/components/schemas/CustomFieldDataType'
|
|
160646
|
-
required:
|
|
160647
|
-
type: boolean
|
|
160648
|
-
description: Gets or sets a value indicating whether the field is required.
|
|
160649
|
-
nullable: true
|
|
160650
|
-
publicVisibility:
|
|
160651
|
-
type: boolean
|
|
160652
|
-
description: Gets or sets a value indicating whether the field has public visibility.
|
|
160653
|
-
nullable: true
|
|
160654
|
-
displayOrder:
|
|
160655
|
-
type: integer
|
|
160656
|
-
description: Gets or sets the display order.
|
|
160657
|
-
format: int32
|
|
160658
|
-
nullable: true
|
|
160659
|
-
validationJson:
|
|
160660
|
-
type: string
|
|
160661
|
-
description: Gets or sets the validation JSON.
|
|
160662
|
-
nullable: true
|
|
160663
|
-
defaultValueText:
|
|
160664
|
-
type: string
|
|
160665
|
-
description: Gets or sets the default text value.
|
|
160666
|
-
nullable: true
|
|
160667
|
-
defaultValueNumber:
|
|
160668
|
-
type: integer
|
|
160669
|
-
description: Gets or sets the default number value.
|
|
160670
|
-
format: int64
|
|
160671
|
-
nullable: true
|
|
160672
|
-
defaultValueDecimal:
|
|
160673
|
-
type: number
|
|
160674
|
-
description: Gets or sets the default decimal value.
|
|
160675
|
-
format: double
|
|
160676
|
-
nullable: true
|
|
160677
|
-
defaultValueBit:
|
|
160678
|
-
type: boolean
|
|
160679
|
-
description: Gets or sets the default bit value.
|
|
160680
|
-
nullable: true
|
|
160681
|
-
defaultValueDate:
|
|
160682
|
-
type: string
|
|
160683
|
-
description: Gets or sets the default date value.
|
|
160684
|
-
format: date-time
|
|
160685
|
-
nullable: true
|
|
160686
|
-
defaultValueDatetimeoffset:
|
|
160687
|
-
type: string
|
|
160688
|
-
description: Gets or sets the default datetimeoffset value.
|
|
160689
|
-
format: date-time
|
|
160690
|
-
nullable: true
|
|
160691
|
-
defaultValueJson:
|
|
160692
|
-
type: string
|
|
160693
|
-
description: Gets or sets the default JSON value.
|
|
160694
|
-
nullable: true
|
|
160695
|
-
options:
|
|
160696
|
-
type: array
|
|
160697
|
-
items:
|
|
160698
|
-
$ref: '#/components/schemas/CustomFieldOptionPost'
|
|
160699
|
-
description: Gets or sets the options for select types.
|
|
160700
|
-
nullable: true
|
|
160701
|
-
archived:
|
|
160702
|
-
type: boolean
|
|
160703
|
-
description: Gets or sets a value indicating whether the field is archived.
|
|
160704
|
-
nullable: true
|
|
160705
|
-
additionalProperties: false
|
|
160706
|
-
description: Post model for the custom field definition.
|
|
160707
|
-
CustomFieldDefinitionWithValue:
|
|
160708
|
-
type: object
|
|
160709
|
-
properties:
|
|
160710
|
-
tenantId:
|
|
160711
|
-
type: string
|
|
160712
|
-
description: Gets or sets the tenant id.
|
|
160713
|
-
format: uuid
|
|
160714
|
-
definitionId:
|
|
160715
|
-
type: string
|
|
160716
|
-
description: Gets or sets the definition id.
|
|
160717
|
-
format: uuid
|
|
160718
|
-
nullable: true
|
|
160719
|
-
label:
|
|
160720
|
-
type: string
|
|
160721
|
-
description: Gets or sets the custom field label.
|
|
160722
|
-
nullable: true
|
|
160723
|
-
description:
|
|
160724
|
-
type: string
|
|
160725
|
-
description: Gets or sets the custom field description.
|
|
160726
|
-
nullable: true
|
|
160727
|
-
dataType:
|
|
160728
|
-
$ref: '#/components/schemas/CustomFieldDataType'
|
|
160729
|
-
required:
|
|
160730
|
-
type: boolean
|
|
160731
|
-
description: Gets or sets a value indicating whether the field is required.
|
|
160732
|
-
nullable: true
|
|
160733
|
-
publicVisibility:
|
|
160734
|
-
type: boolean
|
|
160735
|
-
description: Gets or sets a value indicating whether the field has public visibility.
|
|
160736
|
-
nullable: true
|
|
160737
|
-
displayOrder:
|
|
160738
|
-
type: integer
|
|
160739
|
-
description: Gets or sets the display order.
|
|
160740
|
-
format: int32
|
|
160741
|
-
nullable: true
|
|
160742
|
-
validationJson:
|
|
160743
|
-
type: string
|
|
160744
|
-
description: Gets or sets the validation JSON.
|
|
160745
|
-
nullable: true
|
|
160746
|
-
defaultValueText:
|
|
160747
|
-
type: string
|
|
160748
|
-
description: Gets or sets the default text value.
|
|
160749
|
-
nullable: true
|
|
160750
|
-
defaultValueNumber:
|
|
160751
|
-
type: integer
|
|
160752
|
-
description: Gets or sets the default number value.
|
|
160753
|
-
format: int64
|
|
160754
|
-
nullable: true
|
|
160755
|
-
defaultValueDecimal:
|
|
160756
|
-
type: number
|
|
160757
|
-
description: Gets or sets the default decimal value.
|
|
160758
|
-
format: double
|
|
160759
|
-
nullable: true
|
|
160760
|
-
defaultValueBit:
|
|
160761
|
-
type: boolean
|
|
160762
|
-
description: Gets or sets the default bit value.
|
|
160763
|
-
nullable: true
|
|
160764
|
-
defaultValueDate:
|
|
160765
|
-
type: string
|
|
160766
|
-
description: Gets or sets the default date value.
|
|
160767
|
-
format: date-time
|
|
160768
|
-
nullable: true
|
|
160769
|
-
defaultValueDatetimeoffset:
|
|
160770
|
-
type: string
|
|
160771
|
-
description: Gets or sets the default datetimeoffset value.
|
|
160772
|
-
format: date-time
|
|
160773
|
-
nullable: true
|
|
160774
|
-
defaultValueJson:
|
|
160775
|
-
type: string
|
|
160776
|
-
description: Gets or sets the default JSON value.
|
|
160777
|
-
nullable: true
|
|
160778
|
-
options:
|
|
160779
|
-
type: array
|
|
160780
|
-
items:
|
|
160781
|
-
$ref: '#/components/schemas/CustomFieldOptionDto'
|
|
160782
|
-
description: Gets or sets the options for select types.
|
|
160783
|
-
nullable: true
|
|
160784
|
-
value:
|
|
160785
|
-
description: 'Gets or sets the current value (can be text, number, decimal, bit, date, datetimeoffset, or json).'
|
|
160786
|
-
nullable: true
|
|
160787
|
-
additionalProperties: false
|
|
160788
|
-
description: Represents a custom field definition with its current value for editing.
|
|
160789
|
-
CustomFieldOption:
|
|
160790
|
-
required:
|
|
160791
|
-
- dateCreated
|
|
160792
|
-
- dateModified
|
|
160793
|
-
- isLive
|
|
160794
|
-
- tenantId
|
|
160795
|
-
type: object
|
|
160796
|
-
properties:
|
|
160797
|
-
id:
|
|
160798
|
-
type: string
|
|
160799
|
-
description: Gets or sets the entities Id.
|
|
160800
|
-
format: uuid
|
|
160801
|
-
tenantId:
|
|
160802
|
-
type: string
|
|
160803
|
-
description: Gets or sets the tenant Id.
|
|
160804
|
-
format: uuid
|
|
160805
|
-
dateCreated:
|
|
160806
|
-
type: string
|
|
160807
|
-
description: Gets or sets the created date of this entity.
|
|
160808
|
-
format: date-time
|
|
160809
|
-
dateModified:
|
|
160810
|
-
type: string
|
|
160811
|
-
description: Gets or sets the last modified date of this entity.
|
|
160812
|
-
format: date-time
|
|
160813
|
-
modifiedById:
|
|
160814
|
-
type: string
|
|
160815
|
-
description: Gets or sets the modified by Id.
|
|
160816
|
-
format: uuid
|
|
160817
|
-
nullable: true
|
|
160818
|
-
isLive:
|
|
160819
|
-
type: boolean
|
|
160820
|
-
description: Gets or sets a value indicating whether the record is live and available for use within the application.
|
|
160821
|
-
default: false
|
|
160822
|
-
customFieldDefinitionId:
|
|
160823
|
-
type: string
|
|
160824
|
-
description: Gets or sets the custom field definition id.
|
|
160825
|
-
format: uuid
|
|
160826
|
-
nullable: true
|
|
160827
|
-
label:
|
|
160828
|
-
type: string
|
|
160829
|
-
description: Gets or sets the option label.
|
|
160830
|
-
nullable: true
|
|
160831
|
-
displayOrder:
|
|
160832
|
-
type: integer
|
|
160833
|
-
description: Gets or sets the display order.
|
|
160834
|
-
format: int32
|
|
160835
|
-
nullable: true
|
|
160836
|
-
archived:
|
|
160837
|
-
type: boolean
|
|
160838
|
-
description: Gets or sets a value indicating whether the option is archived.
|
|
160839
|
-
nullable: true
|
|
160840
|
-
additionalProperties: false
|
|
160841
|
-
description: Represents a custom field option within the Reach application.
|
|
160842
|
-
CustomFieldOptionDto:
|
|
160843
|
-
type: object
|
|
160844
|
-
properties:
|
|
160845
|
-
label:
|
|
160846
|
-
type: string
|
|
160847
|
-
description: Gets or sets the option label.
|
|
160848
|
-
nullable: true
|
|
160849
|
-
additionalProperties: false
|
|
160850
|
-
description: Represents a custom field option DTO.
|
|
160851
|
-
CustomFieldOptionPost:
|
|
160852
|
-
type: object
|
|
160853
|
-
properties:
|
|
160854
|
-
label:
|
|
160855
|
-
type: string
|
|
160856
|
-
description: Gets or sets the option label.
|
|
160857
|
-
nullable: true
|
|
160858
|
-
displayOrder:
|
|
160859
|
-
type: integer
|
|
160860
|
-
description: Gets or sets the display order.
|
|
160861
|
-
format: int32
|
|
160862
|
-
nullable: true
|
|
160863
|
-
additionalProperties: false
|
|
160864
|
-
description: Post model for the custom field option.
|
|
160865
|
-
CustomFieldValueEntityType:
|
|
160866
|
-
enum:
|
|
160867
|
-
- Venue
|
|
160868
|
-
- Course
|
|
160869
|
-
- Session
|
|
160870
|
-
type: string
|
|
160871
|
-
description: Controls the entity type for custom field values.
|
|
160872
|
-
CustomFieldValueUpdate:
|
|
160873
|
-
type: object
|
|
160874
|
-
properties:
|
|
160875
|
-
definitionId:
|
|
160876
|
-
type: string
|
|
160877
|
-
description: Gets or sets the custom field definition id.
|
|
160878
|
-
format: uuid
|
|
160879
|
-
value:
|
|
160880
|
-
description: Gets or sets the value to set.
|
|
160881
|
-
nullable: true
|
|
160882
|
-
additionalProperties: false
|
|
160883
|
-
description: Represents a single custom field value update.
|
|
160884
|
-
CustomFieldsBulkUpdate:
|
|
160885
|
-
type: object
|
|
160886
|
-
properties:
|
|
160887
|
-
values:
|
|
160888
|
-
type: array
|
|
160889
|
-
items:
|
|
160890
|
-
$ref: '#/components/schemas/CustomFieldValueUpdate'
|
|
160891
|
-
description: Gets or sets the list of custom field values to update.
|
|
160892
|
-
nullable: true
|
|
160893
|
-
additionalProperties: false
|
|
160894
|
-
description: Represents a bulk update request for custom fields.
|
|
160895
|
-
Customer:
|
|
160896
|
-
required:
|
|
160897
|
-
- dateCreated
|
|
160898
|
-
- dateModified
|
|
160899
|
-
- isLive
|
|
160900
|
-
- nameAbbreviation
|
|
160901
|
-
- tenantId
|
|
160902
|
-
type: object
|
|
160903
|
-
properties:
|
|
160904
|
-
id:
|
|
160905
|
-
type: string
|
|
160906
|
-
description: Gets or sets the entities Id.
|
|
160907
|
-
format: uuid
|
|
160908
|
-
tenantId:
|
|
160909
|
-
type: string
|
|
160910
|
-
description: Gets or sets the tenant Id.
|
|
160911
|
-
format: uuid
|
|
160912
|
-
dateCreated:
|
|
160913
|
-
type: string
|
|
160914
|
-
description: Gets or sets the created date of this entity.
|
|
160915
|
-
format: date-time
|
|
160916
|
-
dateModified:
|
|
160917
|
-
type: string
|
|
160918
|
-
description: Gets or sets the last modified date of this entity.
|
|
160919
|
-
format: date-time
|
|
160920
|
-
modifiedById:
|
|
160921
|
-
type: string
|
|
160922
|
-
description: Gets or sets the modified by Id.
|
|
160923
|
-
format: uuid
|
|
160924
|
-
nullable: true
|
|
160925
|
-
isLive:
|
|
160926
|
-
type: boolean
|
|
160927
|
-
description: Gets or sets a value indicating whether the record is live and available for use within the application.
|
|
160928
|
-
default: false
|
|
160929
|
-
type:
|
|
160930
|
-
$ref: '#/components/schemas/CustomerType'
|
|
160931
|
-
firstName:
|
|
160932
|
-
type: string
|
|
160933
|
-
description: Gets or sets the first name.
|
|
160934
|
-
nullable: true
|
|
160935
|
-
lastName:
|
|
160936
|
-
type: string
|
|
160937
|
-
description: Gets or sets the last name.
|
|
160938
|
-
nullable: true
|
|
160939
|
-
nameAbbreviation:
|
|
160940
|
-
minLength: 1
|
|
160941
|
-
type: string
|
|
160942
|
-
description: Gets the attendees abbreviated name.
|
|
160943
|
-
readOnly: true
|
|
160944
|
-
name:
|
|
160945
|
-
type: string
|
|
160946
|
-
description: Gets or sets the organisation name.
|
|
160947
|
-
nullable: true
|
|
160948
|
-
displayEmail:
|
|
160949
|
-
type: string
|
|
160950
|
-
description: Gets or sets the email.
|
|
160951
|
-
nullable: true
|
|
160952
|
-
phone:
|
|
160953
|
-
type: string
|
|
160954
|
-
description: Gets or sets the phone number.
|
|
160955
|
-
nullable: true
|
|
160956
|
-
streetAddress:
|
|
160957
|
-
type: string
|
|
160958
|
-
description: Gets or sets the customer street address.
|
|
160959
|
-
nullable: true
|
|
160960
|
-
addressLocality:
|
|
160961
|
-
type: string
|
|
160962
|
-
description: Gets or sets the customer locality.
|
|
160963
|
-
nullable: true
|
|
160964
|
-
addressRegion:
|
|
160965
|
-
type: string
|
|
160966
|
-
description: Gets or sets the customer region.
|
|
160967
|
-
nullable: true
|
|
160968
|
-
addressPostalcode:
|
|
160969
|
-
type: string
|
|
160970
|
-
description: Gets or sets the customer postcode.
|
|
160971
|
-
nullable: true
|
|
160972
|
-
countryId:
|
|
160973
|
-
type: integer
|
|
160974
|
-
description: Gets or sets the customer country id.
|
|
160975
|
-
format: int32
|
|
160976
|
-
nullable: true
|
|
160977
|
-
marketingOptIn:
|
|
160978
|
-
type: boolean
|
|
160979
|
-
description: Gets or sets a value indicating whether the customer is opted into marketing.
|
|
160980
|
-
default: false
|
|
160981
|
-
country:
|
|
160982
|
-
$ref: '#/components/schemas/Country'
|
|
160983
|
-
isActiveCustomer:
|
|
160984
|
-
type: boolean
|
|
160985
|
-
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.'
|
|
160986
|
-
default: false
|
|
160987
|
-
bookingCount:
|
|
160988
|
-
type: integer
|
|
160989
|
-
description: Gets or sets how many times the customer has booked with the organisation.
|
|
160990
|
-
format: int32
|
|
160991
|
-
nullable: true
|
|
160992
|
-
endUserIdentityId:
|
|
160993
|
-
type: string
|
|
160994
|
-
description: Gets or sets the customers end user identity id.
|
|
160995
|
-
format: uuid
|
|
160996
|
-
nullable: true
|
|
160997
|
-
stats:
|
|
160998
|
-
$ref: '#/components/schemas/CustomerStats'
|
|
160999
|
-
attendees:
|
|
161000
|
-
type: array
|
|
161001
|
-
items:
|
|
161002
|
-
$ref: '#/components/schemas/Attendee'
|
|
161003
|
-
description: Gets or sets the attendees registered by the customer.
|
|
161004
|
-
nullable: true
|
|
161005
|
-
wallet:
|
|
161006
|
-
$ref: '#/components/schemas/Wallet'
|
|
161007
162468
|
additionalProperties: false
|
|
161008
|
-
description:
|
|
161009
|
-
|
|
162469
|
+
description: Patch model for customer account invite schedule updates.
|
|
162470
|
+
CustomerAccountInviteSchedulePost:
|
|
161010
162471
|
required:
|
|
161011
|
-
- id
|
|
161012
162472
|
- tenantId
|
|
161013
162473
|
type: object
|
|
161014
162474
|
properties:
|
|
@@ -161016,24 +162476,8 @@ components:
|
|
|
161016
162476
|
type: string
|
|
161017
162477
|
description: Gets or sets the tenant Id.
|
|
161018
162478
|
format: uuid
|
|
161019
|
-
id:
|
|
161020
|
-
type: string
|
|
161021
|
-
description: Gets or sets the Id.
|
|
161022
|
-
format: uuid
|
|
161023
|
-
acceptanceCode:
|
|
161024
|
-
type: string
|
|
161025
|
-
description: Gets or sets the acceptance code for the account invite.
|
|
161026
|
-
nullable: true
|
|
161027
|
-
baseDomain:
|
|
161028
|
-
type: string
|
|
161029
|
-
description: 'Gets or sets the base domain for the invite link. If not provided, will use configuration value.'
|
|
161030
|
-
nullable: true
|
|
161031
|
-
registrationUrl:
|
|
161032
|
-
type: string
|
|
161033
|
-
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.'
|
|
161034
|
-
nullable: true
|
|
161035
162479
|
additionalProperties: false
|
|
161036
|
-
description:
|
|
162480
|
+
description: Post model for customer account invite schedule inserts.
|
|
161037
162481
|
CustomerCancellationOption:
|
|
161038
162482
|
enum:
|
|
161039
162483
|
- Cancellable
|
|
@@ -161273,6 +162717,15 @@ components:
|
|
|
161273
162717
|
type: number
|
|
161274
162718
|
description: Gets or sets the total amount refunded to the customer.
|
|
161275
162719
|
format: double
|
|
162720
|
+
pendingAccountInviteScheduledDate:
|
|
162721
|
+
type: string
|
|
162722
|
+
description: 'Gets or sets the earliest date a wallet credit period account invite is scheduled to send, if any are pending.'
|
|
162723
|
+
format: date-time
|
|
162724
|
+
nullable: true
|
|
162725
|
+
hasErroredAccountInviteSchedule:
|
|
162726
|
+
type: boolean
|
|
162727
|
+
description: Gets or sets a value indicating whether a scheduled account invite failed to send and still needs attention.
|
|
162728
|
+
default: false
|
|
161276
162729
|
additionalProperties: false
|
|
161277
162730
|
description: Model for customer stats.
|
|
161278
162731
|
CustomerType:
|
|
@@ -174012,6 +175465,11 @@ components:
|
|
|
174012
175465
|
type: boolean
|
|
174013
175466
|
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."
|
|
174014
175467
|
default: false
|
|
175468
|
+
walletCreditPeriodAccountInviteDaysBefore:
|
|
175469
|
+
type: integer
|
|
175470
|
+
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."
|
|
175471
|
+
format: int32
|
|
175472
|
+
nullable: true
|
|
174015
175473
|
customerLoginRequiresPreprovision:
|
|
174016
175474
|
type: boolean
|
|
174017
175475
|
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."
|
|
@@ -174060,6 +175518,11 @@ components:
|
|
|
174060
175518
|
type: boolean
|
|
174061
175519
|
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."
|
|
174062
175520
|
nullable: true
|
|
175521
|
+
walletCreditPeriodAccountInviteDaysBefore:
|
|
175522
|
+
type: integer
|
|
175523
|
+
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."
|
|
175524
|
+
format: int32
|
|
175525
|
+
nullable: true
|
|
174063
175526
|
additionalProperties: false
|
|
174064
175527
|
description: Partial update for storefront-related tenant settings (partner API).
|
|
174065
175528
|
TenantTier:
|