reach-api-sdk 1.0.107 → 1.0.109
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
CHANGED
|
@@ -1402,6 +1402,10 @@ type Customer = {
|
|
|
1402
1402
|
* Gets or sets a value indicating whether the customer is opted into marketing.
|
|
1403
1403
|
*/
|
|
1404
1404
|
marketingOptIn?: boolean;
|
|
1405
|
+
/**
|
|
1406
|
+
* 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.
|
|
1407
|
+
*/
|
|
1408
|
+
isActiveCustomer?: boolean;
|
|
1405
1409
|
/**
|
|
1406
1410
|
* Gets or sets how many times the customer has booked with the organisation.
|
|
1407
1411
|
*/
|
|
@@ -7798,7 +7802,7 @@ declare class CustomersService {
|
|
|
7798
7802
|
* @returns any Success
|
|
7799
7803
|
* @throws ApiError
|
|
7800
7804
|
*/
|
|
7801
|
-
exportToCsv({ wildcard, email, venueId, pageNumber, take, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, formData, }: {
|
|
7805
|
+
exportToCsv({ wildcard, email, venueId, marketingOptIn, isActiveCustomer, pageNumber, take, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, formData, }: {
|
|
7802
7806
|
/**
|
|
7803
7807
|
* Gets or sets the wildcard for use in a query search.
|
|
7804
7808
|
*/
|
|
@@ -7811,6 +7815,14 @@ declare class CustomersService {
|
|
|
7811
7815
|
* Gets or sets the customers venue id for use in a query search.
|
|
7812
7816
|
*/
|
|
7813
7817
|
venueId?: string;
|
|
7818
|
+
/**
|
|
7819
|
+
* Gets or sets if the customer is marketing opted in or out.
|
|
7820
|
+
*/
|
|
7821
|
+
marketingOptIn?: boolean;
|
|
7822
|
+
/**
|
|
7823
|
+
* 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.
|
|
7824
|
+
*/
|
|
7825
|
+
isActiveCustomer?: boolean;
|
|
7814
7826
|
/**
|
|
7815
7827
|
* Gets or sets the page number for paged queries.
|
|
7816
7828
|
*/
|
|
@@ -7864,7 +7876,7 @@ declare class CustomersService {
|
|
|
7864
7876
|
* @returns any Success
|
|
7865
7877
|
* @throws ApiError
|
|
7866
7878
|
*/
|
|
7867
|
-
exportToXlsx({ wildcard, email, venueId, pageNumber, take, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, formData, }: {
|
|
7879
|
+
exportToXlsx({ wildcard, email, venueId, marketingOptIn, isActiveCustomer, pageNumber, take, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, formData, }: {
|
|
7868
7880
|
/**
|
|
7869
7881
|
* Gets or sets the wildcard for use in a query search.
|
|
7870
7882
|
*/
|
|
@@ -7877,6 +7889,14 @@ declare class CustomersService {
|
|
|
7877
7889
|
* Gets or sets the customers venue id for use in a query search.
|
|
7878
7890
|
*/
|
|
7879
7891
|
venueId?: string;
|
|
7892
|
+
/**
|
|
7893
|
+
* Gets or sets if the customer is marketing opted in or out.
|
|
7894
|
+
*/
|
|
7895
|
+
marketingOptIn?: boolean;
|
|
7896
|
+
/**
|
|
7897
|
+
* 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.
|
|
7898
|
+
*/
|
|
7899
|
+
isActiveCustomer?: boolean;
|
|
7880
7900
|
/**
|
|
7881
7901
|
* Gets or sets the page number for paged queries.
|
|
7882
7902
|
*/
|
|
@@ -7984,7 +8004,7 @@ declare class CustomersService {
|
|
|
7984
8004
|
* @returns CustomerPage Success
|
|
7985
8005
|
* @throws ApiError
|
|
7986
8006
|
*/
|
|
7987
|
-
getPage({ wildcard, email, venueId, pageNumber, take, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
|
|
8007
|
+
getPage({ wildcard, email, venueId, marketingOptIn, isActiveCustomer, pageNumber, take, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
|
|
7988
8008
|
/**
|
|
7989
8009
|
* Gets or sets the wildcard for use in a query search.
|
|
7990
8010
|
*/
|
|
@@ -7997,6 +8017,14 @@ declare class CustomersService {
|
|
|
7997
8017
|
* Gets or sets the customers venue id for use in a query search.
|
|
7998
8018
|
*/
|
|
7999
8019
|
venueId?: string;
|
|
8020
|
+
/**
|
|
8021
|
+
* Gets or sets if the customer is marketing opted in or out.
|
|
8022
|
+
*/
|
|
8023
|
+
marketingOptIn?: boolean;
|
|
8024
|
+
/**
|
|
8025
|
+
* 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.
|
|
8026
|
+
*/
|
|
8027
|
+
isActiveCustomer?: boolean;
|
|
8000
8028
|
/**
|
|
8001
8029
|
* Gets or sets the page number for paged queries.
|
|
8002
8030
|
*/
|
|
@@ -8076,7 +8104,7 @@ declare class CustomersService {
|
|
|
8076
8104
|
* @returns boolean Success
|
|
8077
8105
|
* @throws ApiError
|
|
8078
8106
|
*/
|
|
8079
|
-
exists({ wildcard, email, venueId, pageNumber, take, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
|
|
8107
|
+
exists({ wildcard, email, venueId, marketingOptIn, isActiveCustomer, pageNumber, take, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
|
|
8080
8108
|
/**
|
|
8081
8109
|
* Gets or sets the wildcard for use in a query search.
|
|
8082
8110
|
*/
|
|
@@ -8089,6 +8117,14 @@ declare class CustomersService {
|
|
|
8089
8117
|
* Gets or sets the customers venue id for use in a query search.
|
|
8090
8118
|
*/
|
|
8091
8119
|
venueId?: string;
|
|
8120
|
+
/**
|
|
8121
|
+
* Gets or sets if the customer is marketing opted in or out.
|
|
8122
|
+
*/
|
|
8123
|
+
marketingOptIn?: boolean;
|
|
8124
|
+
/**
|
|
8125
|
+
* 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.
|
|
8126
|
+
*/
|
|
8127
|
+
isActiveCustomer?: boolean;
|
|
8092
8128
|
/**
|
|
8093
8129
|
* Gets or sets the page number for paged queries.
|
|
8094
8130
|
*/
|
|
@@ -8135,7 +8171,7 @@ declare class CustomersService {
|
|
|
8135
8171
|
* @returns Customer Success
|
|
8136
8172
|
* @throws ApiError
|
|
8137
8173
|
*/
|
|
8138
|
-
getListWithoutReferences({ wildcard, email, venueId, pageNumber, take, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
|
|
8174
|
+
getListWithoutReferences({ wildcard, email, venueId, marketingOptIn, isActiveCustomer, pageNumber, take, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
|
|
8139
8175
|
/**
|
|
8140
8176
|
* Gets or sets the wildcard for use in a query search.
|
|
8141
8177
|
*/
|
|
@@ -8148,6 +8184,14 @@ declare class CustomersService {
|
|
|
8148
8184
|
* Gets or sets the customers venue id for use in a query search.
|
|
8149
8185
|
*/
|
|
8150
8186
|
venueId?: string;
|
|
8187
|
+
/**
|
|
8188
|
+
* Gets or sets if the customer is marketing opted in or out.
|
|
8189
|
+
*/
|
|
8190
|
+
marketingOptIn?: boolean;
|
|
8191
|
+
/**
|
|
8192
|
+
* 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.
|
|
8193
|
+
*/
|
|
8194
|
+
isActiveCustomer?: boolean;
|
|
8151
8195
|
/**
|
|
8152
8196
|
* Gets or sets the page number for paged queries.
|
|
8153
8197
|
*/
|
|
@@ -8194,7 +8238,7 @@ declare class CustomersService {
|
|
|
8194
8238
|
* @returns Customer Success
|
|
8195
8239
|
* @throws ApiError
|
|
8196
8240
|
*/
|
|
8197
|
-
getListIdName({ wildcard, email, venueId, pageNumber, take, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
|
|
8241
|
+
getListIdName({ wildcard, email, venueId, marketingOptIn, isActiveCustomer, pageNumber, take, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
|
|
8198
8242
|
/**
|
|
8199
8243
|
* Gets or sets the wildcard for use in a query search.
|
|
8200
8244
|
*/
|
|
@@ -8207,6 +8251,14 @@ declare class CustomersService {
|
|
|
8207
8251
|
* Gets or sets the customers venue id for use in a query search.
|
|
8208
8252
|
*/
|
|
8209
8253
|
venueId?: string;
|
|
8254
|
+
/**
|
|
8255
|
+
* Gets or sets if the customer is marketing opted in or out.
|
|
8256
|
+
*/
|
|
8257
|
+
marketingOptIn?: boolean;
|
|
8258
|
+
/**
|
|
8259
|
+
* 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.
|
|
8260
|
+
*/
|
|
8261
|
+
isActiveCustomer?: boolean;
|
|
8210
8262
|
/**
|
|
8211
8263
|
* Gets or sets the page number for paged queries.
|
|
8212
8264
|
*/
|
|
@@ -20438,7 +20490,7 @@ declare class PublicCustomersService {
|
|
|
20438
20490
|
* @returns CustomerPage Success
|
|
20439
20491
|
* @throws ApiError
|
|
20440
20492
|
*/
|
|
20441
|
-
getPage({ xTenantSubdomain, wildcard, email, venueId, pageNumber, take, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
|
|
20493
|
+
getPage({ xTenantSubdomain, wildcard, email, venueId, marketingOptIn, isActiveCustomer, pageNumber, take, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
|
|
20442
20494
|
xTenantSubdomain?: string;
|
|
20443
20495
|
/**
|
|
20444
20496
|
* Gets or sets the wildcard for use in a query search.
|
|
@@ -20452,6 +20504,14 @@ declare class PublicCustomersService {
|
|
|
20452
20504
|
* Gets or sets the customers venue id for use in a query search.
|
|
20453
20505
|
*/
|
|
20454
20506
|
venueId?: string;
|
|
20507
|
+
/**
|
|
20508
|
+
* Gets or sets if the customer is marketing opted in or out.
|
|
20509
|
+
*/
|
|
20510
|
+
marketingOptIn?: boolean;
|
|
20511
|
+
/**
|
|
20512
|
+
* 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.
|
|
20513
|
+
*/
|
|
20514
|
+
isActiveCustomer?: boolean;
|
|
20455
20515
|
/**
|
|
20456
20516
|
* Gets or sets the page number for paged queries.
|
|
20457
20517
|
*/
|
|
@@ -20558,7 +20618,7 @@ declare class PublicCustomersService {
|
|
|
20558
20618
|
* @returns boolean Success
|
|
20559
20619
|
* @throws ApiError
|
|
20560
20620
|
*/
|
|
20561
|
-
exists({ xTenantSubdomain, wildcard, email, venueId, pageNumber, take, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
|
|
20621
|
+
exists({ xTenantSubdomain, wildcard, email, venueId, marketingOptIn, isActiveCustomer, pageNumber, take, limitListRequests, tenantId, modifiedById, modifiedByIds, dateCreatedGte, dateCreatedLte, isLive, sortOrderDirection, }: {
|
|
20562
20622
|
/**
|
|
20563
20623
|
* The tenants subdomain.
|
|
20564
20624
|
*/
|
|
@@ -20575,6 +20635,14 @@ declare class PublicCustomersService {
|
|
|
20575
20635
|
* Gets or sets the customers venue id for use in a query search.
|
|
20576
20636
|
*/
|
|
20577
20637
|
venueId?: string;
|
|
20638
|
+
/**
|
|
20639
|
+
* Gets or sets if the customer is marketing opted in or out.
|
|
20640
|
+
*/
|
|
20641
|
+
marketingOptIn?: boolean;
|
|
20642
|
+
/**
|
|
20643
|
+
* 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.
|
|
20644
|
+
*/
|
|
20645
|
+
isActiveCustomer?: boolean;
|
|
20578
20646
|
/**
|
|
20579
20647
|
* Gets or sets the page number for paged queries.
|
|
20580
20648
|
*/
|
package/dist/reach-sdk.js
CHANGED
|
@@ -3622,6 +3622,8 @@ const request = (config, options, axiosClient = axios) => {
|
|
|
3622
3622
|
wildcard,
|
|
3623
3623
|
email,
|
|
3624
3624
|
venueId,
|
|
3625
|
+
marketingOptIn,
|
|
3626
|
+
isActiveCustomer,
|
|
3625
3627
|
pageNumber,
|
|
3626
3628
|
take,
|
|
3627
3629
|
limitListRequests,
|
|
@@ -3641,6 +3643,8 @@ const request = (config, options, axiosClient = axios) => {
|
|
|
3641
3643
|
Wildcard: wildcard,
|
|
3642
3644
|
Email: email,
|
|
3643
3645
|
VenueId: venueId,
|
|
3646
|
+
MarketingOptIn: marketingOptIn,
|
|
3647
|
+
IsActiveCustomer: isActiveCustomer,
|
|
3644
3648
|
PageNumber: pageNumber,
|
|
3645
3649
|
Take: take,
|
|
3646
3650
|
LimitListRequests: limitListRequests,
|
|
@@ -3671,6 +3675,8 @@ const request = (config, options, axiosClient = axios) => {
|
|
|
3671
3675
|
wildcard,
|
|
3672
3676
|
email,
|
|
3673
3677
|
venueId,
|
|
3678
|
+
marketingOptIn,
|
|
3679
|
+
isActiveCustomer,
|
|
3674
3680
|
pageNumber,
|
|
3675
3681
|
take,
|
|
3676
3682
|
limitListRequests,
|
|
@@ -3690,6 +3696,8 @@ const request = (config, options, axiosClient = axios) => {
|
|
|
3690
3696
|
Wildcard: wildcard,
|
|
3691
3697
|
Email: email,
|
|
3692
3698
|
VenueId: venueId,
|
|
3699
|
+
MarketingOptIn: marketingOptIn,
|
|
3700
|
+
IsActiveCustomer: isActiveCustomer,
|
|
3693
3701
|
PageNumber: pageNumber,
|
|
3694
3702
|
Take: take,
|
|
3695
3703
|
LimitListRequests: limitListRequests,
|
|
@@ -3819,6 +3827,8 @@ const request = (config, options, axiosClient = axios) => {
|
|
|
3819
3827
|
wildcard,
|
|
3820
3828
|
email,
|
|
3821
3829
|
venueId,
|
|
3830
|
+
marketingOptIn,
|
|
3831
|
+
isActiveCustomer,
|
|
3822
3832
|
pageNumber,
|
|
3823
3833
|
take,
|
|
3824
3834
|
limitListRequests,
|
|
@@ -3837,6 +3847,8 @@ const request = (config, options, axiosClient = axios) => {
|
|
|
3837
3847
|
Wildcard: wildcard,
|
|
3838
3848
|
Email: email,
|
|
3839
3849
|
VenueId: venueId,
|
|
3850
|
+
MarketingOptIn: marketingOptIn,
|
|
3851
|
+
IsActiveCustomer: isActiveCustomer,
|
|
3840
3852
|
PageNumber: pageNumber,
|
|
3841
3853
|
Take: take,
|
|
3842
3854
|
LimitListRequests: limitListRequests,
|
|
@@ -3927,6 +3939,8 @@ const request = (config, options, axiosClient = axios) => {
|
|
|
3927
3939
|
wildcard,
|
|
3928
3940
|
email,
|
|
3929
3941
|
venueId,
|
|
3942
|
+
marketingOptIn,
|
|
3943
|
+
isActiveCustomer,
|
|
3930
3944
|
pageNumber,
|
|
3931
3945
|
take,
|
|
3932
3946
|
limitListRequests,
|
|
@@ -3945,6 +3959,8 @@ const request = (config, options, axiosClient = axios) => {
|
|
|
3945
3959
|
Wildcard: wildcard,
|
|
3946
3960
|
Email: email,
|
|
3947
3961
|
VenueId: venueId,
|
|
3962
|
+
MarketingOptIn: marketingOptIn,
|
|
3963
|
+
IsActiveCustomer: isActiveCustomer,
|
|
3948
3964
|
PageNumber: pageNumber,
|
|
3949
3965
|
Take: take,
|
|
3950
3966
|
LimitListRequests: limitListRequests,
|
|
@@ -3972,6 +3988,8 @@ const request = (config, options, axiosClient = axios) => {
|
|
|
3972
3988
|
wildcard,
|
|
3973
3989
|
email,
|
|
3974
3990
|
venueId,
|
|
3991
|
+
marketingOptIn,
|
|
3992
|
+
isActiveCustomer,
|
|
3975
3993
|
pageNumber,
|
|
3976
3994
|
take,
|
|
3977
3995
|
limitListRequests,
|
|
@@ -3990,6 +4008,8 @@ const request = (config, options, axiosClient = axios) => {
|
|
|
3990
4008
|
Wildcard: wildcard,
|
|
3991
4009
|
Email: email,
|
|
3992
4010
|
VenueId: venueId,
|
|
4011
|
+
MarketingOptIn: marketingOptIn,
|
|
4012
|
+
IsActiveCustomer: isActiveCustomer,
|
|
3993
4013
|
PageNumber: pageNumber,
|
|
3994
4014
|
Take: take,
|
|
3995
4015
|
LimitListRequests: limitListRequests,
|
|
@@ -4017,6 +4037,8 @@ const request = (config, options, axiosClient = axios) => {
|
|
|
4017
4037
|
wildcard,
|
|
4018
4038
|
email,
|
|
4019
4039
|
venueId,
|
|
4040
|
+
marketingOptIn,
|
|
4041
|
+
isActiveCustomer,
|
|
4020
4042
|
pageNumber,
|
|
4021
4043
|
take,
|
|
4022
4044
|
limitListRequests,
|
|
@@ -4035,6 +4057,8 @@ const request = (config, options, axiosClient = axios) => {
|
|
|
4035
4057
|
Wildcard: wildcard,
|
|
4036
4058
|
Email: email,
|
|
4037
4059
|
VenueId: venueId,
|
|
4060
|
+
MarketingOptIn: marketingOptIn,
|
|
4061
|
+
IsActiveCustomer: isActiveCustomer,
|
|
4038
4062
|
PageNumber: pageNumber,
|
|
4039
4063
|
Take: take,
|
|
4040
4064
|
LimitListRequests: limitListRequests,
|
|
@@ -13769,6 +13793,8 @@ const request = (config, options, axiosClient = axios) => {
|
|
|
13769
13793
|
wildcard,
|
|
13770
13794
|
email,
|
|
13771
13795
|
venueId,
|
|
13796
|
+
marketingOptIn,
|
|
13797
|
+
isActiveCustomer,
|
|
13772
13798
|
pageNumber,
|
|
13773
13799
|
take,
|
|
13774
13800
|
limitListRequests,
|
|
@@ -13790,6 +13816,8 @@ const request = (config, options, axiosClient = axios) => {
|
|
|
13790
13816
|
Wildcard: wildcard,
|
|
13791
13817
|
Email: email,
|
|
13792
13818
|
VenueId: venueId,
|
|
13819
|
+
MarketingOptIn: marketingOptIn,
|
|
13820
|
+
IsActiveCustomer: isActiveCustomer,
|
|
13793
13821
|
PageNumber: pageNumber,
|
|
13794
13822
|
Take: take,
|
|
13795
13823
|
LimitListRequests: limitListRequests,
|
|
@@ -13914,6 +13942,8 @@ const request = (config, options, axiosClient = axios) => {
|
|
|
13914
13942
|
wildcard,
|
|
13915
13943
|
email,
|
|
13916
13944
|
venueId,
|
|
13945
|
+
marketingOptIn,
|
|
13946
|
+
isActiveCustomer,
|
|
13917
13947
|
pageNumber,
|
|
13918
13948
|
take,
|
|
13919
13949
|
limitListRequests,
|
|
@@ -13935,6 +13965,8 @@ const request = (config, options, axiosClient = axios) => {
|
|
|
13935
13965
|
Wildcard: wildcard,
|
|
13936
13966
|
Email: email,
|
|
13937
13967
|
VenueId: venueId,
|
|
13968
|
+
MarketingOptIn: marketingOptIn,
|
|
13969
|
+
IsActiveCustomer: isActiveCustomer,
|
|
13938
13970
|
PageNumber: pageNumber,
|
|
13939
13971
|
Take: take,
|
|
13940
13972
|
LimitListRequests: limitListRequests,
|
package/package.json
CHANGED
|
@@ -9759,6 +9759,16 @@ paths:
|
|
|
9759
9759
|
schema:
|
|
9760
9760
|
type: string
|
|
9761
9761
|
format: uuid
|
|
9762
|
+
- name: MarketingOptIn
|
|
9763
|
+
in: query
|
|
9764
|
+
description: Gets or sets if the customer is marketing opted in or out.
|
|
9765
|
+
schema:
|
|
9766
|
+
type: boolean
|
|
9767
|
+
- name: IsActiveCustomer
|
|
9768
|
+
in: query
|
|
9769
|
+
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.'
|
|
9770
|
+
schema:
|
|
9771
|
+
type: boolean
|
|
9762
9772
|
- name: PageNumber
|
|
9763
9773
|
in: query
|
|
9764
9774
|
description: Gets or sets the page number for paged queries.
|
|
@@ -9893,6 +9903,16 @@ paths:
|
|
|
9893
9903
|
schema:
|
|
9894
9904
|
type: string
|
|
9895
9905
|
format: uuid
|
|
9906
|
+
- name: MarketingOptIn
|
|
9907
|
+
in: query
|
|
9908
|
+
description: Gets or sets if the customer is marketing opted in or out.
|
|
9909
|
+
schema:
|
|
9910
|
+
type: boolean
|
|
9911
|
+
- name: IsActiveCustomer
|
|
9912
|
+
in: query
|
|
9913
|
+
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.'
|
|
9914
|
+
schema:
|
|
9915
|
+
type: boolean
|
|
9896
9916
|
- name: PageNumber
|
|
9897
9917
|
in: query
|
|
9898
9918
|
description: Gets or sets the page number for paged queries.
|
|
@@ -10361,6 +10381,16 @@ paths:
|
|
|
10361
10381
|
schema:
|
|
10362
10382
|
type: string
|
|
10363
10383
|
format: uuid
|
|
10384
|
+
- name: MarketingOptIn
|
|
10385
|
+
in: query
|
|
10386
|
+
description: Gets or sets if the customer is marketing opted in or out.
|
|
10387
|
+
schema:
|
|
10388
|
+
type: boolean
|
|
10389
|
+
- name: IsActiveCustomer
|
|
10390
|
+
in: query
|
|
10391
|
+
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.'
|
|
10392
|
+
schema:
|
|
10393
|
+
type: boolean
|
|
10364
10394
|
- name: PageNumber
|
|
10365
10395
|
in: query
|
|
10366
10396
|
description: Gets or sets the page number for paged queries.
|
|
@@ -10670,6 +10700,16 @@ paths:
|
|
|
10670
10700
|
schema:
|
|
10671
10701
|
type: string
|
|
10672
10702
|
format: uuid
|
|
10703
|
+
- name: MarketingOptIn
|
|
10704
|
+
in: query
|
|
10705
|
+
description: Gets or sets if the customer is marketing opted in or out.
|
|
10706
|
+
schema:
|
|
10707
|
+
type: boolean
|
|
10708
|
+
- name: IsActiveCustomer
|
|
10709
|
+
in: query
|
|
10710
|
+
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.'
|
|
10711
|
+
schema:
|
|
10712
|
+
type: boolean
|
|
10673
10713
|
- name: PageNumber
|
|
10674
10714
|
in: query
|
|
10675
10715
|
description: Gets or sets the page number for paged queries.
|
|
@@ -10801,6 +10841,16 @@ paths:
|
|
|
10801
10841
|
schema:
|
|
10802
10842
|
type: string
|
|
10803
10843
|
format: uuid
|
|
10844
|
+
- name: MarketingOptIn
|
|
10845
|
+
in: query
|
|
10846
|
+
description: Gets or sets if the customer is marketing opted in or out.
|
|
10847
|
+
schema:
|
|
10848
|
+
type: boolean
|
|
10849
|
+
- name: IsActiveCustomer
|
|
10850
|
+
in: query
|
|
10851
|
+
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.'
|
|
10852
|
+
schema:
|
|
10853
|
+
type: boolean
|
|
10804
10854
|
- name: PageNumber
|
|
10805
10855
|
in: query
|
|
10806
10856
|
description: Gets or sets the page number for paged queries.
|
|
@@ -10938,6 +10988,16 @@ paths:
|
|
|
10938
10988
|
schema:
|
|
10939
10989
|
type: string
|
|
10940
10990
|
format: uuid
|
|
10991
|
+
- name: MarketingOptIn
|
|
10992
|
+
in: query
|
|
10993
|
+
description: Gets or sets if the customer is marketing opted in or out.
|
|
10994
|
+
schema:
|
|
10995
|
+
type: boolean
|
|
10996
|
+
- name: IsActiveCustomer
|
|
10997
|
+
in: query
|
|
10998
|
+
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.'
|
|
10999
|
+
schema:
|
|
11000
|
+
type: boolean
|
|
10941
11001
|
- name: PageNumber
|
|
10942
11002
|
in: query
|
|
10943
11003
|
description: Gets or sets the page number for paged queries.
|
|
@@ -40130,6 +40190,16 @@ paths:
|
|
|
40130
40190
|
schema:
|
|
40131
40191
|
type: string
|
|
40132
40192
|
format: uuid
|
|
40193
|
+
- name: MarketingOptIn
|
|
40194
|
+
in: query
|
|
40195
|
+
description: Gets or sets if the customer is marketing opted in or out.
|
|
40196
|
+
schema:
|
|
40197
|
+
type: boolean
|
|
40198
|
+
- name: IsActiveCustomer
|
|
40199
|
+
in: query
|
|
40200
|
+
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.'
|
|
40201
|
+
schema:
|
|
40202
|
+
type: boolean
|
|
40133
40203
|
- name: PageNumber
|
|
40134
40204
|
in: query
|
|
40135
40205
|
description: Gets or sets the page number for paged queries.
|
|
@@ -40558,6 +40628,16 @@ paths:
|
|
|
40558
40628
|
schema:
|
|
40559
40629
|
type: string
|
|
40560
40630
|
format: uuid
|
|
40631
|
+
- name: MarketingOptIn
|
|
40632
|
+
in: query
|
|
40633
|
+
description: Gets or sets if the customer is marketing opted in or out.
|
|
40634
|
+
schema:
|
|
40635
|
+
type: boolean
|
|
40636
|
+
- name: IsActiveCustomer
|
|
40637
|
+
in: query
|
|
40638
|
+
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.'
|
|
40639
|
+
schema:
|
|
40640
|
+
type: boolean
|
|
40561
40641
|
- name: PageNumber
|
|
40562
40642
|
in: query
|
|
40563
40643
|
description: Gets or sets the page number for paged queries.
|
|
@@ -94625,6 +94705,10 @@ components:
|
|
|
94625
94705
|
type: boolean
|
|
94626
94706
|
description: Gets or sets a value indicating whether the customer is opted into marketing.
|
|
94627
94707
|
default: false
|
|
94708
|
+
isActiveCustomer:
|
|
94709
|
+
type: boolean
|
|
94710
|
+
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.'
|
|
94711
|
+
default: false
|
|
94628
94712
|
bookingCount:
|
|
94629
94713
|
type: integer
|
|
94630
94714
|
description: Gets or sets how many times the customer has booked with the organisation.
|
package/src/models/Customer.ts
CHANGED
|
@@ -88,6 +88,10 @@ export type Customer = {
|
|
|
88
88
|
* Gets or sets a value indicating whether the customer is opted into marketing.
|
|
89
89
|
*/
|
|
90
90
|
marketingOptIn?: boolean;
|
|
91
|
+
/**
|
|
92
|
+
* 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.
|
|
93
|
+
*/
|
|
94
|
+
isActiveCustomer?: boolean;
|
|
91
95
|
/**
|
|
92
96
|
* Gets or sets how many times the customer has booked with the organisation.
|
|
93
97
|
*/
|
|
@@ -86,6 +86,8 @@ export class CustomersService {
|
|
|
86
86
|
wildcard,
|
|
87
87
|
email,
|
|
88
88
|
venueId,
|
|
89
|
+
marketingOptIn,
|
|
90
|
+
isActiveCustomer,
|
|
89
91
|
pageNumber,
|
|
90
92
|
take,
|
|
91
93
|
limitListRequests,
|
|
@@ -110,6 +112,14 @@ export class CustomersService {
|
|
|
110
112
|
* Gets or sets the customers venue id for use in a query search.
|
|
111
113
|
*/
|
|
112
114
|
venueId?: string;
|
|
115
|
+
/**
|
|
116
|
+
* Gets or sets if the customer is marketing opted in or out.
|
|
117
|
+
*/
|
|
118
|
+
marketingOptIn?: boolean;
|
|
119
|
+
/**
|
|
120
|
+
* 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.
|
|
121
|
+
*/
|
|
122
|
+
isActiveCustomer?: boolean;
|
|
113
123
|
/**
|
|
114
124
|
* Gets or sets the page number for paged queries.
|
|
115
125
|
*/
|
|
@@ -164,6 +174,8 @@ export class CustomersService {
|
|
|
164
174
|
Wildcard: wildcard,
|
|
165
175
|
Email: email,
|
|
166
176
|
VenueId: venueId,
|
|
177
|
+
MarketingOptIn: marketingOptIn,
|
|
178
|
+
IsActiveCustomer: isActiveCustomer,
|
|
167
179
|
PageNumber: pageNumber,
|
|
168
180
|
Take: take,
|
|
169
181
|
LimitListRequests: limitListRequests,
|
|
@@ -195,6 +207,8 @@ export class CustomersService {
|
|
|
195
207
|
wildcard,
|
|
196
208
|
email,
|
|
197
209
|
venueId,
|
|
210
|
+
marketingOptIn,
|
|
211
|
+
isActiveCustomer,
|
|
198
212
|
pageNumber,
|
|
199
213
|
take,
|
|
200
214
|
limitListRequests,
|
|
@@ -219,6 +233,14 @@ export class CustomersService {
|
|
|
219
233
|
* Gets or sets the customers venue id for use in a query search.
|
|
220
234
|
*/
|
|
221
235
|
venueId?: string;
|
|
236
|
+
/**
|
|
237
|
+
* Gets or sets if the customer is marketing opted in or out.
|
|
238
|
+
*/
|
|
239
|
+
marketingOptIn?: boolean;
|
|
240
|
+
/**
|
|
241
|
+
* 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.
|
|
242
|
+
*/
|
|
243
|
+
isActiveCustomer?: boolean;
|
|
222
244
|
/**
|
|
223
245
|
* Gets or sets the page number for paged queries.
|
|
224
246
|
*/
|
|
@@ -273,6 +295,8 @@ export class CustomersService {
|
|
|
273
295
|
Wildcard: wildcard,
|
|
274
296
|
Email: email,
|
|
275
297
|
VenueId: venueId,
|
|
298
|
+
MarketingOptIn: marketingOptIn,
|
|
299
|
+
IsActiveCustomer: isActiveCustomer,
|
|
276
300
|
PageNumber: pageNumber,
|
|
277
301
|
Take: take,
|
|
278
302
|
LimitListRequests: limitListRequests,
|
|
@@ -433,6 +457,8 @@ export class CustomersService {
|
|
|
433
457
|
wildcard,
|
|
434
458
|
email,
|
|
435
459
|
venueId,
|
|
460
|
+
marketingOptIn,
|
|
461
|
+
isActiveCustomer,
|
|
436
462
|
pageNumber,
|
|
437
463
|
take,
|
|
438
464
|
limitListRequests,
|
|
@@ -456,6 +482,14 @@ export class CustomersService {
|
|
|
456
482
|
* Gets or sets the customers venue id for use in a query search.
|
|
457
483
|
*/
|
|
458
484
|
venueId?: string;
|
|
485
|
+
/**
|
|
486
|
+
* Gets or sets if the customer is marketing opted in or out.
|
|
487
|
+
*/
|
|
488
|
+
marketingOptIn?: boolean;
|
|
489
|
+
/**
|
|
490
|
+
* 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.
|
|
491
|
+
*/
|
|
492
|
+
isActiveCustomer?: boolean;
|
|
459
493
|
/**
|
|
460
494
|
* Gets or sets the page number for paged queries.
|
|
461
495
|
*/
|
|
@@ -504,6 +538,8 @@ export class CustomersService {
|
|
|
504
538
|
Wildcard: wildcard,
|
|
505
539
|
Email: email,
|
|
506
540
|
VenueId: venueId,
|
|
541
|
+
MarketingOptIn: marketingOptIn,
|
|
542
|
+
IsActiveCustomer: isActiveCustomer,
|
|
507
543
|
PageNumber: pageNumber,
|
|
508
544
|
Take: take,
|
|
509
545
|
LimitListRequests: limitListRequests,
|
|
@@ -613,6 +649,8 @@ export class CustomersService {
|
|
|
613
649
|
wildcard,
|
|
614
650
|
email,
|
|
615
651
|
venueId,
|
|
652
|
+
marketingOptIn,
|
|
653
|
+
isActiveCustomer,
|
|
616
654
|
pageNumber,
|
|
617
655
|
take,
|
|
618
656
|
limitListRequests,
|
|
@@ -636,6 +674,14 @@ export class CustomersService {
|
|
|
636
674
|
* Gets or sets the customers venue id for use in a query search.
|
|
637
675
|
*/
|
|
638
676
|
venueId?: string;
|
|
677
|
+
/**
|
|
678
|
+
* Gets or sets if the customer is marketing opted in or out.
|
|
679
|
+
*/
|
|
680
|
+
marketingOptIn?: boolean;
|
|
681
|
+
/**
|
|
682
|
+
* 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.
|
|
683
|
+
*/
|
|
684
|
+
isActiveCustomer?: boolean;
|
|
639
685
|
/**
|
|
640
686
|
* Gets or sets the page number for paged queries.
|
|
641
687
|
*/
|
|
@@ -684,6 +730,8 @@ export class CustomersService {
|
|
|
684
730
|
Wildcard: wildcard,
|
|
685
731
|
Email: email,
|
|
686
732
|
VenueId: venueId,
|
|
733
|
+
MarketingOptIn: marketingOptIn,
|
|
734
|
+
IsActiveCustomer: isActiveCustomer,
|
|
687
735
|
PageNumber: pageNumber,
|
|
688
736
|
Take: take,
|
|
689
737
|
LimitListRequests: limitListRequests,
|
|
@@ -712,6 +760,8 @@ export class CustomersService {
|
|
|
712
760
|
wildcard,
|
|
713
761
|
email,
|
|
714
762
|
venueId,
|
|
763
|
+
marketingOptIn,
|
|
764
|
+
isActiveCustomer,
|
|
715
765
|
pageNumber,
|
|
716
766
|
take,
|
|
717
767
|
limitListRequests,
|
|
@@ -735,6 +785,14 @@ export class CustomersService {
|
|
|
735
785
|
* Gets or sets the customers venue id for use in a query search.
|
|
736
786
|
*/
|
|
737
787
|
venueId?: string;
|
|
788
|
+
/**
|
|
789
|
+
* Gets or sets if the customer is marketing opted in or out.
|
|
790
|
+
*/
|
|
791
|
+
marketingOptIn?: boolean;
|
|
792
|
+
/**
|
|
793
|
+
* 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.
|
|
794
|
+
*/
|
|
795
|
+
isActiveCustomer?: boolean;
|
|
738
796
|
/**
|
|
739
797
|
* Gets or sets the page number for paged queries.
|
|
740
798
|
*/
|
|
@@ -783,6 +841,8 @@ export class CustomersService {
|
|
|
783
841
|
Wildcard: wildcard,
|
|
784
842
|
Email: email,
|
|
785
843
|
VenueId: venueId,
|
|
844
|
+
MarketingOptIn: marketingOptIn,
|
|
845
|
+
IsActiveCustomer: isActiveCustomer,
|
|
786
846
|
PageNumber: pageNumber,
|
|
787
847
|
Take: take,
|
|
788
848
|
LimitListRequests: limitListRequests,
|
|
@@ -811,6 +871,8 @@ export class CustomersService {
|
|
|
811
871
|
wildcard,
|
|
812
872
|
email,
|
|
813
873
|
venueId,
|
|
874
|
+
marketingOptIn,
|
|
875
|
+
isActiveCustomer,
|
|
814
876
|
pageNumber,
|
|
815
877
|
take,
|
|
816
878
|
limitListRequests,
|
|
@@ -834,6 +896,14 @@ export class CustomersService {
|
|
|
834
896
|
* Gets or sets the customers venue id for use in a query search.
|
|
835
897
|
*/
|
|
836
898
|
venueId?: string;
|
|
899
|
+
/**
|
|
900
|
+
* Gets or sets if the customer is marketing opted in or out.
|
|
901
|
+
*/
|
|
902
|
+
marketingOptIn?: boolean;
|
|
903
|
+
/**
|
|
904
|
+
* 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.
|
|
905
|
+
*/
|
|
906
|
+
isActiveCustomer?: boolean;
|
|
837
907
|
/**
|
|
838
908
|
* Gets or sets the page number for paged queries.
|
|
839
909
|
*/
|
|
@@ -882,6 +952,8 @@ export class CustomersService {
|
|
|
882
952
|
Wildcard: wildcard,
|
|
883
953
|
Email: email,
|
|
884
954
|
VenueId: venueId,
|
|
955
|
+
MarketingOptIn: marketingOptIn,
|
|
956
|
+
IsActiveCustomer: isActiveCustomer,
|
|
885
957
|
PageNumber: pageNumber,
|
|
886
958
|
Take: take,
|
|
887
959
|
LimitListRequests: limitListRequests,
|
|
@@ -86,6 +86,8 @@ export class PublicCustomersService {
|
|
|
86
86
|
wildcard,
|
|
87
87
|
email,
|
|
88
88
|
venueId,
|
|
89
|
+
marketingOptIn,
|
|
90
|
+
isActiveCustomer,
|
|
89
91
|
pageNumber,
|
|
90
92
|
take,
|
|
91
93
|
limitListRequests,
|
|
@@ -110,6 +112,14 @@ export class PublicCustomersService {
|
|
|
110
112
|
* Gets or sets the customers venue id for use in a query search.
|
|
111
113
|
*/
|
|
112
114
|
venueId?: string;
|
|
115
|
+
/**
|
|
116
|
+
* Gets or sets if the customer is marketing opted in or out.
|
|
117
|
+
*/
|
|
118
|
+
marketingOptIn?: boolean;
|
|
119
|
+
/**
|
|
120
|
+
* 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.
|
|
121
|
+
*/
|
|
122
|
+
isActiveCustomer?: boolean;
|
|
113
123
|
/**
|
|
114
124
|
* Gets or sets the page number for paged queries.
|
|
115
125
|
*/
|
|
@@ -161,6 +171,8 @@ export class PublicCustomersService {
|
|
|
161
171
|
Wildcard: wildcard,
|
|
162
172
|
Email: email,
|
|
163
173
|
VenueId: venueId,
|
|
174
|
+
MarketingOptIn: marketingOptIn,
|
|
175
|
+
IsActiveCustomer: isActiveCustomer,
|
|
164
176
|
PageNumber: pageNumber,
|
|
165
177
|
Take: take,
|
|
166
178
|
LimitListRequests: limitListRequests,
|
|
@@ -326,6 +338,8 @@ export class PublicCustomersService {
|
|
|
326
338
|
wildcard,
|
|
327
339
|
email,
|
|
328
340
|
venueId,
|
|
341
|
+
marketingOptIn,
|
|
342
|
+
isActiveCustomer,
|
|
329
343
|
pageNumber,
|
|
330
344
|
take,
|
|
331
345
|
limitListRequests,
|
|
@@ -353,6 +367,14 @@ export class PublicCustomersService {
|
|
|
353
367
|
* Gets or sets the customers venue id for use in a query search.
|
|
354
368
|
*/
|
|
355
369
|
venueId?: string;
|
|
370
|
+
/**
|
|
371
|
+
* Gets or sets if the customer is marketing opted in or out.
|
|
372
|
+
*/
|
|
373
|
+
marketingOptIn?: boolean;
|
|
374
|
+
/**
|
|
375
|
+
* 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.
|
|
376
|
+
*/
|
|
377
|
+
isActiveCustomer?: boolean;
|
|
356
378
|
/**
|
|
357
379
|
* Gets or sets the page number for paged queries.
|
|
358
380
|
*/
|
|
@@ -404,6 +426,8 @@ export class PublicCustomersService {
|
|
|
404
426
|
Wildcard: wildcard,
|
|
405
427
|
Email: email,
|
|
406
428
|
VenueId: venueId,
|
|
429
|
+
MarketingOptIn: marketingOptIn,
|
|
430
|
+
IsActiveCustomer: isActiveCustomer,
|
|
407
431
|
PageNumber: pageNumber,
|
|
408
432
|
Take: take,
|
|
409
433
|
LimitListRequests: limitListRequests,
|