reach-api-sdk 1.0.36 → 1.0.38
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 +111 -18
- package/package.json +1 -1
- package/src/definition/swagger.yaml +111 -0
- package/src/models/CoursePatch.ts +91 -0
- package/src/models/DatabaseState.ts +4 -0
package/dist/reach-sdk.d.ts
CHANGED
|
@@ -4962,6 +4962,24 @@ type UpdateEmailSettings = {
|
|
|
4962
4962
|
postCompletionText?: string | null;
|
|
4963
4963
|
};
|
|
4964
4964
|
|
|
4965
|
+
/**
|
|
4966
|
+
* Patch model for session offers.
|
|
4967
|
+
*/
|
|
4968
|
+
type UpdateOffer = {
|
|
4969
|
+
/**
|
|
4970
|
+
* Gets or sets the offer id.
|
|
4971
|
+
*/
|
|
4972
|
+
id?: string | null;
|
|
4973
|
+
/**
|
|
4974
|
+
* Gets or sets the offer name.
|
|
4975
|
+
*/
|
|
4976
|
+
name?: string | null;
|
|
4977
|
+
/**
|
|
4978
|
+
* Gets or sets the offer total/gross price.
|
|
4979
|
+
*/
|
|
4980
|
+
priceTotal: number;
|
|
4981
|
+
};
|
|
4982
|
+
|
|
4965
4983
|
/**
|
|
4966
4984
|
* Post model for course updates.
|
|
4967
4985
|
*/
|
|
@@ -4974,7 +4992,96 @@ type CoursePatch = {
|
|
|
4974
4992
|
* Gets or sets the Id.
|
|
4975
4993
|
*/
|
|
4976
4994
|
id: string;
|
|
4995
|
+
/**
|
|
4996
|
+
* Gets or sets the venue id for the activity.
|
|
4997
|
+
*/
|
|
4998
|
+
venueId: string;
|
|
4999
|
+
/**
|
|
5000
|
+
* Gets or sets the Activity Id.
|
|
5001
|
+
*/
|
|
5002
|
+
activityId: number;
|
|
5003
|
+
/**
|
|
5004
|
+
* Gets or sets the Programme Id.
|
|
5005
|
+
*/
|
|
5006
|
+
programmeId?: string | null;
|
|
5007
|
+
/**
|
|
5008
|
+
* Gets or sets the post completion survey Id.
|
|
5009
|
+
*/
|
|
5010
|
+
postCompletionSurveyId?: string | null;
|
|
5011
|
+
/**
|
|
5012
|
+
* Gets or sets the survey Id.
|
|
5013
|
+
*/
|
|
5014
|
+
surveyId?: string | null;
|
|
5015
|
+
/**
|
|
5016
|
+
* Gets or sets the session name.
|
|
5017
|
+
*/
|
|
5018
|
+
name: string;
|
|
5019
|
+
/**
|
|
5020
|
+
* Gets or sets the session description.
|
|
5021
|
+
*/
|
|
5022
|
+
description?: string | null;
|
|
5023
|
+
/**
|
|
5024
|
+
* Gets or sets the session image url.
|
|
5025
|
+
*/
|
|
5026
|
+
imageUrl?: string | null;
|
|
5027
|
+
/**
|
|
5028
|
+
* Gets or sets the meeting instructions.
|
|
5029
|
+
*/
|
|
5030
|
+
meetingInstructions?: string | null;
|
|
5031
|
+
/**
|
|
5032
|
+
* Gets or sets the session capacity.
|
|
5033
|
+
*/
|
|
5034
|
+
capacity: number;
|
|
5035
|
+
gender?: SessionGender;
|
|
5036
|
+
/**
|
|
5037
|
+
* Gets or sets the min age.
|
|
5038
|
+
*/
|
|
5039
|
+
minAge?: number | null;
|
|
5040
|
+
/**
|
|
5041
|
+
* Gets or sets the max age.
|
|
5042
|
+
*/
|
|
5043
|
+
maxAge?: number | null;
|
|
5044
|
+
/**
|
|
5045
|
+
* Gets or sets a value indicating whether the session is online and can take bookings.
|
|
5046
|
+
*/
|
|
5047
|
+
online?: boolean | null;
|
|
5048
|
+
/**
|
|
5049
|
+
* Gets or sets additional support options.
|
|
5050
|
+
*/
|
|
5051
|
+
additionalSupport?: Array<string> | null;
|
|
5052
|
+
/**
|
|
5053
|
+
* Gets or sets the contact name.
|
|
5054
|
+
*/
|
|
5055
|
+
contactName?: string | null;
|
|
5056
|
+
/**
|
|
5057
|
+
* Gets or sets the contact phone.
|
|
5058
|
+
*/
|
|
5059
|
+
contactPhone?: string | null;
|
|
5060
|
+
/**
|
|
5061
|
+
* Gets or sets the contact email.
|
|
5062
|
+
*/
|
|
5063
|
+
contactEmail?: string | null;
|
|
5064
|
+
/**
|
|
5065
|
+
* Gets or sets the session that this course was originally copied from.
|
|
5066
|
+
*/
|
|
5067
|
+
copiedFrom?: string | null;
|
|
5068
|
+
/**
|
|
5069
|
+
* Gets or sets a value indicating whether the Session can be used as a template.
|
|
5070
|
+
*/
|
|
5071
|
+
allowTemplating?: boolean | null;
|
|
5072
|
+
/**
|
|
5073
|
+
* Gets or sets a value indicating whether the session is archived and should be ignored under normal operation.
|
|
5074
|
+
*/
|
|
5075
|
+
archived?: boolean | null;
|
|
5076
|
+
/**
|
|
5077
|
+
* Gets or sets a value indicating whether the session is deleted and should be ignored under normal operation.
|
|
5078
|
+
*/
|
|
5079
|
+
deleted?: boolean | null;
|
|
4977
5080
|
emailSettings?: UpdateEmailSettings;
|
|
5081
|
+
/**
|
|
5082
|
+
* Gets or sets the session offers.
|
|
5083
|
+
*/
|
|
5084
|
+
offers?: Array<UpdateOffer> | null;
|
|
4978
5085
|
};
|
|
4979
5086
|
|
|
4980
5087
|
/**
|
|
@@ -17297,24 +17404,6 @@ type SessionPage = {
|
|
|
17297
17404
|
readonly items?: Array<Session> | null;
|
|
17298
17405
|
};
|
|
17299
17406
|
|
|
17300
|
-
/**
|
|
17301
|
-
* Patch model for session offers.
|
|
17302
|
-
*/
|
|
17303
|
-
type UpdateOffer = {
|
|
17304
|
-
/**
|
|
17305
|
-
* Gets or sets the offer id.
|
|
17306
|
-
*/
|
|
17307
|
-
id?: string | null;
|
|
17308
|
-
/**
|
|
17309
|
-
* Gets or sets the offer name.
|
|
17310
|
-
*/
|
|
17311
|
-
name?: string | null;
|
|
17312
|
-
/**
|
|
17313
|
-
* Gets or sets the offer total/gross price.
|
|
17314
|
-
*/
|
|
17315
|
-
priceTotal: number;
|
|
17316
|
-
};
|
|
17317
|
-
|
|
17318
17407
|
/**
|
|
17319
17408
|
* Patch model for session updates.
|
|
17320
17409
|
*/
|
|
@@ -25709,6 +25798,10 @@ type DatabaseState = {
|
|
|
25709
25798
|
* Gets a value indicating whether activity database records exist.
|
|
25710
25799
|
*/
|
|
25711
25800
|
readonly activitiesExist: boolean;
|
|
25801
|
+
/**
|
|
25802
|
+
* Gets a value indicating whether multiple activity type database records exist.
|
|
25803
|
+
*/
|
|
25804
|
+
readonly multipleActivityTypesExist: boolean;
|
|
25712
25805
|
/**
|
|
25713
25806
|
* Gets or sets a value indicating whether location database records exist.
|
|
25714
25807
|
*/
|
package/package.json
CHANGED
|
@@ -66950,8 +66950,12 @@ components:
|
|
|
66950
66950
|
additionalProperties: false
|
|
66951
66951
|
CoursePatch:
|
|
66952
66952
|
required:
|
|
66953
|
+
- activityId
|
|
66954
|
+
- capacity
|
|
66953
66955
|
- id
|
|
66956
|
+
- name
|
|
66954
66957
|
- tenantId
|
|
66958
|
+
- venueId
|
|
66955
66959
|
type: object
|
|
66956
66960
|
properties:
|
|
66957
66961
|
tenantId:
|
|
@@ -66962,8 +66966,109 @@ components:
|
|
|
66962
66966
|
type: string
|
|
66963
66967
|
description: Gets or sets the Id.
|
|
66964
66968
|
format: uuid
|
|
66969
|
+
venueId:
|
|
66970
|
+
type: string
|
|
66971
|
+
description: Gets or sets the venue id for the activity.
|
|
66972
|
+
format: uuid
|
|
66973
|
+
activityId:
|
|
66974
|
+
type: integer
|
|
66975
|
+
description: Gets or sets the Activity Id.
|
|
66976
|
+
format: int32
|
|
66977
|
+
programmeId:
|
|
66978
|
+
type: string
|
|
66979
|
+
description: Gets or sets the Programme Id.
|
|
66980
|
+
format: uuid
|
|
66981
|
+
nullable: true
|
|
66982
|
+
postCompletionSurveyId:
|
|
66983
|
+
type: string
|
|
66984
|
+
description: Gets or sets the post completion survey Id.
|
|
66985
|
+
format: uuid
|
|
66986
|
+
nullable: true
|
|
66987
|
+
surveyId:
|
|
66988
|
+
type: string
|
|
66989
|
+
description: Gets or sets the survey Id.
|
|
66990
|
+
format: uuid
|
|
66991
|
+
nullable: true
|
|
66992
|
+
name:
|
|
66993
|
+
minLength: 1
|
|
66994
|
+
type: string
|
|
66995
|
+
description: Gets or sets the session name.
|
|
66996
|
+
description:
|
|
66997
|
+
type: string
|
|
66998
|
+
description: Gets or sets the session description.
|
|
66999
|
+
nullable: true
|
|
67000
|
+
imageUrl:
|
|
67001
|
+
type: string
|
|
67002
|
+
description: Gets or sets the session image url.
|
|
67003
|
+
format: uri
|
|
67004
|
+
nullable: true
|
|
67005
|
+
meetingInstructions:
|
|
67006
|
+
type: string
|
|
67007
|
+
description: Gets or sets the meeting instructions.
|
|
67008
|
+
nullable: true
|
|
67009
|
+
capacity:
|
|
67010
|
+
type: integer
|
|
67011
|
+
description: Gets or sets the session capacity.
|
|
67012
|
+
format: int32
|
|
67013
|
+
gender:
|
|
67014
|
+
$ref: '#/components/schemas/SessionGender'
|
|
67015
|
+
minAge:
|
|
67016
|
+
type: integer
|
|
67017
|
+
description: Gets or sets the min age.
|
|
67018
|
+
format: int32
|
|
67019
|
+
nullable: true
|
|
67020
|
+
maxAge:
|
|
67021
|
+
type: integer
|
|
67022
|
+
description: Gets or sets the max age.
|
|
67023
|
+
format: int32
|
|
67024
|
+
nullable: true
|
|
67025
|
+
online:
|
|
67026
|
+
type: boolean
|
|
67027
|
+
description: Gets or sets a value indicating whether the session is online and can take bookings.
|
|
67028
|
+
nullable: true
|
|
67029
|
+
additionalSupport:
|
|
67030
|
+
type: array
|
|
67031
|
+
items:
|
|
67032
|
+
type: string
|
|
67033
|
+
description: Gets or sets additional support options.
|
|
67034
|
+
nullable: true
|
|
67035
|
+
contactName:
|
|
67036
|
+
type: string
|
|
67037
|
+
description: Gets or sets the contact name.
|
|
67038
|
+
nullable: true
|
|
67039
|
+
contactPhone:
|
|
67040
|
+
type: string
|
|
67041
|
+
description: Gets or sets the contact phone.
|
|
67042
|
+
nullable: true
|
|
67043
|
+
contactEmail:
|
|
67044
|
+
type: string
|
|
67045
|
+
description: Gets or sets the contact email.
|
|
67046
|
+
nullable: true
|
|
67047
|
+
copiedFrom:
|
|
67048
|
+
type: string
|
|
67049
|
+
description: Gets or sets the session that this course was originally copied from.
|
|
67050
|
+
format: uuid
|
|
67051
|
+
nullable: true
|
|
67052
|
+
allowTemplating:
|
|
67053
|
+
type: boolean
|
|
67054
|
+
description: Gets or sets a value indicating whether the Session can be used as a template.
|
|
67055
|
+
nullable: true
|
|
67056
|
+
archived:
|
|
67057
|
+
type: boolean
|
|
67058
|
+
description: Gets or sets a value indicating whether the session is archived and should be ignored under normal operation.
|
|
67059
|
+
nullable: true
|
|
67060
|
+
deleted:
|
|
67061
|
+
type: boolean
|
|
67062
|
+
description: Gets or sets a value indicating whether the session is deleted and should be ignored under normal operation.
|
|
67063
|
+
nullable: true
|
|
66965
67064
|
emailSettings:
|
|
66966
67065
|
$ref: '#/components/schemas/UpdateEmailSettings'
|
|
67066
|
+
offers:
|
|
67067
|
+
type: array
|
|
67068
|
+
items:
|
|
67069
|
+
$ref: '#/components/schemas/UpdateOffer'
|
|
67070
|
+
description: Gets or sets the session offers.
|
|
67071
|
+
nullable: true
|
|
66967
67072
|
additionalProperties: false
|
|
66968
67073
|
description: Post model for course updates.
|
|
66969
67074
|
CoursePost:
|
|
@@ -67678,6 +67783,7 @@ components:
|
|
|
67678
67783
|
- customersExist
|
|
67679
67784
|
- facilitiesExist
|
|
67680
67785
|
- locationsExist
|
|
67786
|
+
- multipleActivityTypesExist
|
|
67681
67787
|
- ordersExist
|
|
67682
67788
|
- scheduledSessionsExist
|
|
67683
67789
|
- sessionsExist
|
|
@@ -67690,6 +67796,11 @@ components:
|
|
|
67690
67796
|
description: Gets a value indicating whether activity database records exist.
|
|
67691
67797
|
default: false
|
|
67692
67798
|
readOnly: true
|
|
67799
|
+
multipleActivityTypesExist:
|
|
67800
|
+
type: boolean
|
|
67801
|
+
description: Gets a value indicating whether multiple activity type database records exist.
|
|
67802
|
+
default: false
|
|
67803
|
+
readOnly: true
|
|
67693
67804
|
locationsExist:
|
|
67694
67805
|
type: boolean
|
|
67695
67806
|
description: Gets or sets a value indicating whether location database records exist.
|
|
@@ -3,7 +3,9 @@
|
|
|
3
3
|
/* tslint:disable */
|
|
4
4
|
/* eslint-disable */
|
|
5
5
|
|
|
6
|
+
import type { SessionGender } from './SessionGender';
|
|
6
7
|
import type { UpdateEmailSettings } from './UpdateEmailSettings';
|
|
8
|
+
import type { UpdateOffer } from './UpdateOffer';
|
|
7
9
|
|
|
8
10
|
/**
|
|
9
11
|
* Post model for course updates.
|
|
@@ -17,5 +19,94 @@ export type CoursePatch = {
|
|
|
17
19
|
* Gets or sets the Id.
|
|
18
20
|
*/
|
|
19
21
|
id: string;
|
|
22
|
+
/**
|
|
23
|
+
* Gets or sets the venue id for the activity.
|
|
24
|
+
*/
|
|
25
|
+
venueId: string;
|
|
26
|
+
/**
|
|
27
|
+
* Gets or sets the Activity Id.
|
|
28
|
+
*/
|
|
29
|
+
activityId: number;
|
|
30
|
+
/**
|
|
31
|
+
* Gets or sets the Programme Id.
|
|
32
|
+
*/
|
|
33
|
+
programmeId?: string | null;
|
|
34
|
+
/**
|
|
35
|
+
* Gets or sets the post completion survey Id.
|
|
36
|
+
*/
|
|
37
|
+
postCompletionSurveyId?: string | null;
|
|
38
|
+
/**
|
|
39
|
+
* Gets or sets the survey Id.
|
|
40
|
+
*/
|
|
41
|
+
surveyId?: string | null;
|
|
42
|
+
/**
|
|
43
|
+
* Gets or sets the session name.
|
|
44
|
+
*/
|
|
45
|
+
name: string;
|
|
46
|
+
/**
|
|
47
|
+
* Gets or sets the session description.
|
|
48
|
+
*/
|
|
49
|
+
description?: string | null;
|
|
50
|
+
/**
|
|
51
|
+
* Gets or sets the session image url.
|
|
52
|
+
*/
|
|
53
|
+
imageUrl?: string | null;
|
|
54
|
+
/**
|
|
55
|
+
* Gets or sets the meeting instructions.
|
|
56
|
+
*/
|
|
57
|
+
meetingInstructions?: string | null;
|
|
58
|
+
/**
|
|
59
|
+
* Gets or sets the session capacity.
|
|
60
|
+
*/
|
|
61
|
+
capacity: number;
|
|
62
|
+
gender?: SessionGender;
|
|
63
|
+
/**
|
|
64
|
+
* Gets or sets the min age.
|
|
65
|
+
*/
|
|
66
|
+
minAge?: number | null;
|
|
67
|
+
/**
|
|
68
|
+
* Gets or sets the max age.
|
|
69
|
+
*/
|
|
70
|
+
maxAge?: number | null;
|
|
71
|
+
/**
|
|
72
|
+
* Gets or sets a value indicating whether the session is online and can take bookings.
|
|
73
|
+
*/
|
|
74
|
+
online?: boolean | null;
|
|
75
|
+
/**
|
|
76
|
+
* Gets or sets additional support options.
|
|
77
|
+
*/
|
|
78
|
+
additionalSupport?: Array<string> | null;
|
|
79
|
+
/**
|
|
80
|
+
* Gets or sets the contact name.
|
|
81
|
+
*/
|
|
82
|
+
contactName?: string | null;
|
|
83
|
+
/**
|
|
84
|
+
* Gets or sets the contact phone.
|
|
85
|
+
*/
|
|
86
|
+
contactPhone?: string | null;
|
|
87
|
+
/**
|
|
88
|
+
* Gets or sets the contact email.
|
|
89
|
+
*/
|
|
90
|
+
contactEmail?: string | null;
|
|
91
|
+
/**
|
|
92
|
+
* Gets or sets the session that this course was originally copied from.
|
|
93
|
+
*/
|
|
94
|
+
copiedFrom?: string | null;
|
|
95
|
+
/**
|
|
96
|
+
* Gets or sets a value indicating whether the Session can be used as a template.
|
|
97
|
+
*/
|
|
98
|
+
allowTemplating?: boolean | null;
|
|
99
|
+
/**
|
|
100
|
+
* Gets or sets a value indicating whether the session is archived and should be ignored under normal operation.
|
|
101
|
+
*/
|
|
102
|
+
archived?: boolean | null;
|
|
103
|
+
/**
|
|
104
|
+
* Gets or sets a value indicating whether the session is deleted and should be ignored under normal operation.
|
|
105
|
+
*/
|
|
106
|
+
deleted?: boolean | null;
|
|
20
107
|
emailSettings?: UpdateEmailSettings;
|
|
108
|
+
/**
|
|
109
|
+
* Gets or sets the session offers.
|
|
110
|
+
*/
|
|
111
|
+
offers?: Array<UpdateOffer> | null;
|
|
21
112
|
};
|
|
@@ -11,6 +11,10 @@ export type DatabaseState = {
|
|
|
11
11
|
* Gets a value indicating whether activity database records exist.
|
|
12
12
|
*/
|
|
13
13
|
readonly activitiesExist: boolean;
|
|
14
|
+
/**
|
|
15
|
+
* Gets a value indicating whether multiple activity type database records exist.
|
|
16
|
+
*/
|
|
17
|
+
readonly multipleActivityTypesExist: boolean;
|
|
14
18
|
/**
|
|
15
19
|
* Gets or sets a value indicating whether location database records exist.
|
|
16
20
|
*/
|