reach-api-sdk 1.0.189 → 1.0.191

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.
@@ -2,6 +2,7 @@
2
2
  /* istanbul ignore file */
3
3
  /* tslint:disable */
4
4
  /* eslint-disable */
5
+ import type { EventTiming } from '../models/EventTiming';
5
6
  import type { OrderItem } from '../models/OrderItem';
6
7
  import type { OrderItemPage } from '../models/OrderItemPage';
7
8
  import type { OrderItemPatch } from '../models/OrderItemPatch';
@@ -16,38 +17,148 @@ export class PublicOrderItemsService {
16
17
  constructor(public readonly httpRequest: BaseHttpRequest) {}
17
18
 
18
19
  /**
19
- * Reschedules the order item to another scheduled session.
20
- * @returns OrderItem OK
20
+ * @returns OrderItemPage OK
21
21
  * @throws ApiError
22
22
  */
23
- public reschedule({
24
- orderItemId,
25
- scheduledSessionId,
23
+ public getPage({
26
24
  xTenantSubdomain,
25
+ ids,
26
+ orderId,
27
+ scheduledSessionId,
28
+ slotId,
29
+ courseId,
30
+ status,
31
+ statuses,
32
+ parentOrderItemId,
33
+ orderByOpportunityStartdate,
34
+ eventTiming,
35
+ pageNumber,
36
+ take,
37
+ skip,
38
+ limitListRequests,
39
+ tenantId,
40
+ modifiedById,
41
+ modifiedByIds,
42
+ dateCreatedGte,
43
+ dateCreatedLte,
44
+ isLive,
45
+ sortOrderDirection,
27
46
  }: {
47
+ xTenantSubdomain?: string;
28
48
  /**
29
- * The current register the attendee is assigned to.
49
+ * Gets or sets the queryable order item ids.
30
50
  */
31
- orderItemId: string;
51
+ ids?: Array<string>;
32
52
  /**
33
- * The scheduled session the attendee needs to be moved to.
53
+ * Gets or sets the queryable order id.
34
54
  */
35
- scheduledSessionId: string;
55
+ orderId?: string;
36
56
  /**
37
- * The tenants subdomain.
57
+ * Gets or sets the queryable scheduled session id.
38
58
  */
39
- xTenantSubdomain?: string;
40
- }): CancelablePromise<OrderItem> {
59
+ scheduledSessionId?: string;
60
+ /**
61
+ * Gets or sets the queryable slot id.
62
+ */
63
+ slotId?: string;
64
+ /**
65
+ * Gets or sets the queryable course id.
66
+ */
67
+ courseId?: string;
68
+ /**
69
+ * Gets or sets the queryable order item status id.
70
+ */
71
+ status?: OrderItemStatus;
72
+ /**
73
+ * Gets or sets the queryable order statuses.
74
+ */
75
+ statuses?: Array<OrderItemStatus>;
76
+ /**
77
+ * Gets or sets the queryable parent order item id id.
78
+ */
79
+ parentOrderItemId?: string;
80
+ /**
81
+ * Gets or sets the queryable order by opportunity start date value.
82
+ */
83
+ orderByOpportunityStartdate?: boolean;
84
+ /**
85
+ * Gets or sets the queryable event timing.
86
+ */
87
+ eventTiming?: EventTiming;
88
+ /**
89
+ * Gets or sets the page number for paged queries.
90
+ */
91
+ pageNumber?: number;
92
+ /**
93
+ * Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
94
+ */
95
+ take?: number;
96
+ /**
97
+ * Gets or sets how much items to skip from begining of db table, when this is set page is always 1.
98
+ */
99
+ skip?: number;
100
+ /**
101
+ * Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
102
+ */
103
+ limitListRequests?: boolean;
104
+ /**
105
+ * Gets or sets the Tenant Id.
106
+ */
107
+ tenantId?: string;
108
+ /**
109
+ * Gets or sets the Modifed By Id.
110
+ */
111
+ modifiedById?: string;
112
+ /**
113
+ * Gets or sets the Modifed By Ids.
114
+ */
115
+ modifiedByIds?: Array<string>;
116
+ /**
117
+ * Gets or sets the Date Created greater than equal to.
118
+ */
119
+ dateCreatedGte?: string;
120
+ /**
121
+ * Gets or sets the Date Created less than equal to.
122
+ */
123
+ dateCreatedLte?: string;
124
+ /**
125
+ * Gets or sets the queryable only is live status.
126
+ */
127
+ isLive?: boolean;
128
+ /**
129
+ * Gets or sets the sort order direction.
130
+ */
131
+ sortOrderDirection?: SearchSortOrderDirection;
132
+ }): CancelablePromise<OrderItemPage> {
41
133
  return this.httpRequest.request({
42
134
  method: 'GET',
43
- url: '/api/public/order-items/{orderItemId}/reschedule-to/{scheduledSessionId}',
44
- path: {
45
- orderItemId: orderItemId,
46
- scheduledSessionId: scheduledSessionId,
47
- },
135
+ url: '/api/public/order-items',
48
136
  headers: {
49
137
  x_tenant_subdomain: xTenantSubdomain,
50
138
  },
139
+ query: {
140
+ Ids: ids,
141
+ OrderId: orderId,
142
+ ScheduledSessionId: scheduledSessionId,
143
+ SlotId: slotId,
144
+ CourseId: courseId,
145
+ Status: status,
146
+ Statuses: statuses,
147
+ ParentOrderItemId: parentOrderItemId,
148
+ OrderByOpportunityStartdate: orderByOpportunityStartdate,
149
+ EventTiming: eventTiming,
150
+ PageNumber: pageNumber,
151
+ Take: take,
152
+ Skip: skip,
153
+ LimitListRequests: limitListRequests,
154
+ TenantId: tenantId,
155
+ ModifiedById: modifiedById,
156
+ ModifiedByIds: modifiedByIds,
157
+ DateCreatedGTE: dateCreatedGte,
158
+ DateCreatedLTE: dateCreatedLte,
159
+ IsLive: isLive,
160
+ SortOrderDirection: sortOrderDirection,
161
+ },
51
162
  errors: {
52
163
  400: `Bad Request`,
53
164
  422: `Unprocessable Content`,
@@ -57,11 +168,11 @@ export class PublicOrderItemsService {
57
168
  }
58
169
 
59
170
  /**
60
- * Inserts a new resource. The Id will be automatically generated and will be ignored if provided.
61
- * @returns OrderItem OK
171
+ * Deletes the resource.
172
+ * @returns any OK
62
173
  * @throws ApiError
63
174
  */
64
- public post({
175
+ public deleteByObject({
65
176
  xTenantSubdomain,
66
177
  requestBody,
67
178
  }: {
@@ -72,11 +183,11 @@ export class PublicOrderItemsService {
72
183
  /**
73
184
  * The <typeparamref name="TObject" /> model.
74
185
  */
75
- requestBody?: OrderItemPost;
76
- }): CancelablePromise<OrderItem> {
186
+ requestBody?: OrderItem;
187
+ }): CancelablePromise<any> {
77
188
  return this.httpRequest.request({
78
- method: 'POST',
79
- url: '/api/public/order-items/v2-temporary-route',
189
+ method: 'DELETE',
190
+ url: '/api/public/order-items',
80
191
  headers: {
81
192
  x_tenant_subdomain: xTenantSubdomain,
82
193
  },
@@ -91,31 +202,38 @@ export class PublicOrderItemsService {
91
202
  }
92
203
 
93
204
  /**
94
- * Patches the resource.
205
+ * Reschedules the order item to another scheduled session.
95
206
  * @returns OrderItem OK
96
207
  * @throws ApiError
97
208
  */
98
- public patch({
209
+ public reschedule({
210
+ orderItemId,
211
+ scheduledSessionId,
99
212
  xTenantSubdomain,
100
- requestBody,
101
213
  }: {
102
214
  /**
103
- * The tenants subdomain.
215
+ * The current register the attendee is assigned to.
104
216
  */
105
- xTenantSubdomain?: string;
217
+ orderItemId: string;
106
218
  /**
107
- * The <typeparamref name="TObject" /> model.
219
+ * The scheduled session the attendee needs to be moved to.
108
220
  */
109
- requestBody?: OrderItemPatch;
221
+ scheduledSessionId: string;
222
+ /**
223
+ * The tenants subdomain.
224
+ */
225
+ xTenantSubdomain?: string;
110
226
  }): CancelablePromise<OrderItem> {
111
227
  return this.httpRequest.request({
112
- method: 'PATCH',
113
- url: '/api/public/order-items/v2-temporary-route',
228
+ method: 'GET',
229
+ url: '/api/public/order-items/{orderItemId}/reschedule-to/{scheduledSessionId}',
230
+ path: {
231
+ orderItemId: orderItemId,
232
+ scheduledSessionId: scheduledSessionId,
233
+ },
114
234
  headers: {
115
235
  x_tenant_subdomain: xTenantSubdomain,
116
236
  },
117
- body: requestBody,
118
- mediaType: 'application/json',
119
237
  errors: {
120
238
  400: `Bad Request`,
121
239
  422: `Unprocessable Content`,
@@ -125,11 +243,11 @@ export class PublicOrderItemsService {
125
243
  }
126
244
 
127
245
  /**
128
- * Inserts a list of resources.
246
+ * Inserts a new resource. The Id will be automatically generated and will be ignored if provided.
129
247
  * @returns OrderItem OK
130
248
  * @throws ApiError
131
249
  */
132
- public postList({
250
+ public post({
133
251
  xTenantSubdomain,
134
252
  requestBody,
135
253
  }: {
@@ -138,13 +256,13 @@ export class PublicOrderItemsService {
138
256
  */
139
257
  xTenantSubdomain?: string;
140
258
  /**
141
- * The list of <typeparamref name="TObject" />.
259
+ * The <typeparamref name="TObject" /> model.
142
260
  */
143
- requestBody?: Array<OrderItemPost>;
144
- }): CancelablePromise<Array<OrderItem>> {
261
+ requestBody?: OrderItemPost;
262
+ }): CancelablePromise<OrderItem> {
145
263
  return this.httpRequest.request({
146
264
  method: 'POST',
147
- url: '/api/public/order-items/v2-temporary-route/list',
265
+ url: '/api/public/order-items/v2-temporary-route',
148
266
  headers: {
149
267
  x_tenant_subdomain: xTenantSubdomain,
150
268
  },
@@ -159,11 +277,11 @@ export class PublicOrderItemsService {
159
277
  }
160
278
 
161
279
  /**
162
- * Deletes the resource.
163
- * @returns any OK
280
+ * Patches the resource.
281
+ * @returns OrderItem OK
164
282
  * @throws ApiError
165
283
  */
166
- public deleteByObject({
284
+ public patch({
167
285
  xTenantSubdomain,
168
286
  requestBody,
169
287
  }: {
@@ -174,11 +292,11 @@ export class PublicOrderItemsService {
174
292
  /**
175
293
  * The <typeparamref name="TObject" /> model.
176
294
  */
177
- requestBody?: OrderItem;
178
- }): CancelablePromise<any> {
295
+ requestBody?: OrderItemPatch;
296
+ }): CancelablePromise<OrderItem> {
179
297
  return this.httpRequest.request({
180
- method: 'DELETE',
181
- url: '/api/public/order-items',
298
+ method: 'PATCH',
299
+ url: '/api/public/order-items/v2-temporary-route',
182
300
  headers: {
183
301
  x_tenant_subdomain: xTenantSubdomain,
184
302
  },
@@ -193,140 +311,31 @@ export class PublicOrderItemsService {
193
311
  }
194
312
 
195
313
  /**
196
- * Gets a list of resources.
197
- * @returns OrderItemPage OK
314
+ * Inserts a list of resources.
315
+ * @returns OrderItem OK
198
316
  * @throws ApiError
199
317
  */
200
- public getPage({
318
+ public postList({
201
319
  xTenantSubdomain,
202
- ids,
203
- orderId,
204
- scheduledSessionId,
205
- slotId,
206
- courseId,
207
- status,
208
- statuses,
209
- parentOrderItemId,
210
- pageNumber,
211
- take,
212
- skip,
213
- limitListRequests,
214
- tenantId,
215
- modifiedById,
216
- modifiedByIds,
217
- dateCreatedGte,
218
- dateCreatedLte,
219
- isLive,
220
- sortOrderDirection,
320
+ requestBody,
221
321
  }: {
222
322
  /**
223
323
  * The tenants subdomain.
224
324
  */
225
325
  xTenantSubdomain?: string;
226
326
  /**
227
- * Gets or sets the queryable order item ids.
228
- */
229
- ids?: Array<string>;
230
- /**
231
- * Gets or sets the queryable order id.
232
- */
233
- orderId?: string;
234
- /**
235
- * Gets or sets the queryable scheduled session id.
236
- */
237
- scheduledSessionId?: string;
238
- /**
239
- * Gets or sets the queryable slot id.
240
- */
241
- slotId?: string;
242
- /**
243
- * Gets or sets the queryable course id.
244
- */
245
- courseId?: string;
246
- /**
247
- * Gets or sets the queryable order item status id.
248
- */
249
- status?: OrderItemStatus;
250
- /**
251
- * Gets or sets the queryable order statuses.
252
- */
253
- statuses?: Array<OrderItemStatus>;
254
- /**
255
- * Gets or sets the queryable parent order item id id.
256
- */
257
- parentOrderItemId?: string;
258
- /**
259
- * Gets or sets the page number for paged queries.
260
- */
261
- pageNumber?: number;
262
- /**
263
- * Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
264
- */
265
- take?: number;
266
- /**
267
- * Gets or sets how much items to skip from begining of db table, when this is set page is always 1.
268
- */
269
- skip?: number;
270
- /**
271
- * Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
272
- */
273
- limitListRequests?: boolean;
274
- /**
275
- * Gets or sets the Tenant Id.
276
- */
277
- tenantId?: string;
278
- /**
279
- * Gets or sets the Modifed By Id.
280
- */
281
- modifiedById?: string;
282
- /**
283
- * Gets or sets the Modifed By Ids.
284
- */
285
- modifiedByIds?: Array<string>;
286
- /**
287
- * Gets or sets the Date Created greater than equal to.
288
- */
289
- dateCreatedGte?: string;
290
- /**
291
- * Gets or sets the Date Created less than equal to.
292
- */
293
- dateCreatedLte?: string;
294
- /**
295
- * Gets or sets the queryable only is live status.
296
- */
297
- isLive?: boolean;
298
- /**
299
- * Gets or sets the sort order direction.
327
+ * The list of <typeparamref name="TObject" />.
300
328
  */
301
- sortOrderDirection?: SearchSortOrderDirection;
302
- }): CancelablePromise<OrderItemPage> {
329
+ requestBody?: Array<OrderItemPost>;
330
+ }): CancelablePromise<Array<OrderItem>> {
303
331
  return this.httpRequest.request({
304
- method: 'GET',
305
- url: '/api/public/order-items',
332
+ method: 'POST',
333
+ url: '/api/public/order-items/v2-temporary-route/list',
306
334
  headers: {
307
335
  x_tenant_subdomain: xTenantSubdomain,
308
336
  },
309
- query: {
310
- Ids: ids,
311
- OrderId: orderId,
312
- ScheduledSessionId: scheduledSessionId,
313
- SlotId: slotId,
314
- CourseId: courseId,
315
- Status: status,
316
- Statuses: statuses,
317
- ParentOrderItemId: parentOrderItemId,
318
- PageNumber: pageNumber,
319
- Take: take,
320
- Skip: skip,
321
- LimitListRequests: limitListRequests,
322
- TenantId: tenantId,
323
- ModifiedById: modifiedById,
324
- ModifiedByIds: modifiedByIds,
325
- DateCreatedGTE: dateCreatedGte,
326
- DateCreatedLTE: dateCreatedLte,
327
- IsLive: isLive,
328
- SortOrderDirection: sortOrderDirection,
329
- },
337
+ body: requestBody,
338
+ mediaType: 'application/json',
330
339
  errors: {
331
340
  400: `Bad Request`,
332
341
  422: `Unprocessable Content`,
@@ -420,6 +429,8 @@ export class PublicOrderItemsService {
420
429
  status,
421
430
  statuses,
422
431
  parentOrderItemId,
432
+ orderByOpportunityStartdate,
433
+ eventTiming,
423
434
  pageNumber,
424
435
  take,
425
436
  skip,
@@ -468,6 +479,14 @@ export class PublicOrderItemsService {
468
479
  * Gets or sets the queryable parent order item id id.
469
480
  */
470
481
  parentOrderItemId?: string;
482
+ /**
483
+ * Gets or sets the queryable order by opportunity start date value.
484
+ */
485
+ orderByOpportunityStartdate?: boolean;
486
+ /**
487
+ * Gets or sets the queryable event timing.
488
+ */
489
+ eventTiming?: EventTiming;
471
490
  /**
472
491
  * Gets or sets the page number for paged queries.
473
492
  */
@@ -528,6 +547,8 @@ export class PublicOrderItemsService {
528
547
  Status: status,
529
548
  Statuses: statuses,
530
549
  ParentOrderItemId: parentOrderItemId,
550
+ OrderByOpportunityStartdate: orderByOpportunityStartdate,
551
+ EventTiming: eventTiming,
531
552
  PageNumber: pageNumber,
532
553
  Take: take,
533
554
  Skip: skip,