reach-api-sdk 1.0.194 → 1.0.195
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 +6676 -871
- package/dist/reach-sdk.js +4290 -272
- package/package.json +1 -1
- package/src/definition/swagger.yaml +16349 -4310
- package/src/index.ts +1 -0
- package/src/models/Tenant.ts +2 -0
- package/src/models/TenantStatus.ts +12 -0
- package/src/services/ActivityPerformanceService.ts +129 -0
- package/src/services/AttendeesService.ts +111 -0
- package/src/services/BadEnglandReportService.ts +87 -0
- package/src/services/BookingService.ts +201 -0
- package/src/services/CancellationPoliciesService.ts +111 -0
- package/src/services/CourseSessionSchedulesService.ts +117 -0
- package/src/services/CourseSessionsService.ts +213 -0
- package/src/services/CoursesService.ts +273 -0
- package/src/services/CustomersService.ts +129 -0
- package/src/services/DealActivitiesService.ts +123 -0
- package/src/services/DealsService.ts +123 -0
- package/src/services/DiscountCodeUsesService.ts +105 -0
- package/src/services/EmailReminderSchedulesService.ts +117 -0
- package/src/services/EmailSettingsService.ts +117 -0
- package/src/services/FacilitiesService.ts +135 -0
- package/src/services/FacilityIndividualsService.ts +93 -0
- package/src/services/GenericActivityService.ts +316 -0
- package/src/services/ImageUploadHistoryService.ts +99 -0
- package/src/services/ImagesService.ts +147 -0
- package/src/services/LeasingService.ts +195 -0
- package/src/services/LocationsReportService.ts +105 -0
- package/src/services/NotificationQueueService.ts +99 -0
- package/src/services/NotificationSettingsService.ts +177 -0
- package/src/services/OffersService.ts +165 -0
- package/src/services/OpenactiveFeedIntermediateService.ts +93 -0
- package/src/services/OpenactiveFeedItemService.ts +99 -0
- package/src/services/OpportunityRegisterService.ts +147 -0
- package/src/services/OrderItemReportService.ts +123 -0
- package/src/services/OrderItemsService.ts +153 -24
- package/src/services/OrdersService.ts +195 -0
- package/src/services/OrgCourseUtilisationService.ts +147 -0
- package/src/services/PaymentPoliciesService.ts +111 -0
- package/src/services/PaymentsService.ts +93 -0
- package/src/services/PermissionsService.ts +87 -0
- package/src/services/PlatformPayoutsService.ts +99 -0
- package/src/services/ProgrammesService.ts +117 -0
- package/src/services/ProvidersService.ts +189 -0
- package/src/services/PublicGenericActivityService.ts +25 -0
- package/src/services/PublicOrderItemsService.ts +0 -12
- package/src/services/PublicVenuesService.ts +19 -0
- package/src/services/RecentOrderActivityReportService.ts +87 -0
- package/src/services/RegisterReportService.ts +117 -0
- package/src/services/RescheduleLogService.ts +99 -0
- package/src/services/ScheduledSessionsSchedulesService.ts +123 -0
- package/src/services/ScheduledSessionsService.ts +249 -0
- package/src/services/SessionsService.ts +273 -0
- package/src/services/SlotOffersService.ts +99 -0
- package/src/services/SlotScheduleOffersService.ts +99 -0
- package/src/services/SlotSchedulesService.ts +129 -0
- package/src/services/SlotsService.ts +207 -0
- package/src/services/StripeAccountService.ts +99 -0
- package/src/services/SurveyAnswersService.ts +129 -0
- package/src/services/SurveyCompletionLogService.ts +123 -0
- package/src/services/SurveyQuestionsService.ts +93 -0
- package/src/services/SurveyReportExtendedService.ts +105 -0
- package/src/services/SurveysService.ts +123 -0
- package/src/services/TemplateDetailsService.ts +93 -0
- package/src/services/TemplateFieldPermissionsService.ts +93 -0
- package/src/services/TemplateOffersService.ts +93 -0
- package/src/services/TemplatesService.ts +93 -0
- package/src/services/TenantWebsiteSettingsService.ts +87 -0
- package/src/services/TenantsService.ts +93 -0
- package/src/services/TotalRevenueReportService.ts +111 -0
- package/src/services/UserPermissionsService.ts +93 -0
- package/src/services/UserProgrammesService.ts +111 -0
- package/src/services/UserProvidersService.ts +111 -0
- package/src/services/UsersService.ts +123 -0
- package/src/services/VenueManagersService.ts +111 -0
- package/src/services/VenuePerformanceService.ts +129 -0
- package/src/services/VenuesReportService.ts +93 -0
- package/src/services/VenuesService.ts +238 -0
- package/src/services/WaitlistActivityReportService.ts +123 -0
- package/src/services/WaitlistActivityService.ts +123 -0
- package/src/services/WaitlistOpportunityReportService.ts +117 -0
- package/src/services/WaitlistOpportunityService.ts +117 -0
|
@@ -491,6 +491,117 @@ export class PaymentPoliciesService {
|
|
|
491
491
|
});
|
|
492
492
|
}
|
|
493
493
|
|
|
494
|
+
/**
|
|
495
|
+
* Returns the number of results in the database given the provided search params.
|
|
496
|
+
* @returns number OK
|
|
497
|
+
* @throws ApiError
|
|
498
|
+
*/
|
|
499
|
+
public count({
|
|
500
|
+
ids,
|
|
501
|
+
name,
|
|
502
|
+
isDefault,
|
|
503
|
+
isSystem,
|
|
504
|
+
pageNumber,
|
|
505
|
+
take,
|
|
506
|
+
skip,
|
|
507
|
+
limitListRequests,
|
|
508
|
+
tenantId,
|
|
509
|
+
modifiedById,
|
|
510
|
+
modifiedByIds,
|
|
511
|
+
dateCreatedGte,
|
|
512
|
+
dateCreatedLte,
|
|
513
|
+
isLive,
|
|
514
|
+
sortOrderDirection,
|
|
515
|
+
}: {
|
|
516
|
+
/**
|
|
517
|
+
* Gets or sets the queryable payment policy ids.
|
|
518
|
+
*/
|
|
519
|
+
ids?: Array<string>;
|
|
520
|
+
/**
|
|
521
|
+
* Gets or sets the queryable name.
|
|
522
|
+
*/
|
|
523
|
+
name?: string;
|
|
524
|
+
/**
|
|
525
|
+
* Gets or sets the queryable IsDefault value.
|
|
526
|
+
*/
|
|
527
|
+
isDefault?: boolean;
|
|
528
|
+
/**
|
|
529
|
+
* Gets or sets the queryable IsSystem value.
|
|
530
|
+
*/
|
|
531
|
+
isSystem?: boolean;
|
|
532
|
+
/**
|
|
533
|
+
* Gets or sets the page number for paged queries.
|
|
534
|
+
*/
|
|
535
|
+
pageNumber?: number;
|
|
536
|
+
/**
|
|
537
|
+
* Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
|
|
538
|
+
*/
|
|
539
|
+
take?: number;
|
|
540
|
+
/**
|
|
541
|
+
* Gets or sets how much items to skip from begining of db table, when this is set page is always 1.
|
|
542
|
+
*/
|
|
543
|
+
skip?: number;
|
|
544
|
+
/**
|
|
545
|
+
* Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
|
|
546
|
+
*/
|
|
547
|
+
limitListRequests?: boolean;
|
|
548
|
+
/**
|
|
549
|
+
* Gets or sets the Tenant Id.
|
|
550
|
+
*/
|
|
551
|
+
tenantId?: string;
|
|
552
|
+
/**
|
|
553
|
+
* Gets or sets the Modifed By Id.
|
|
554
|
+
*/
|
|
555
|
+
modifiedById?: string;
|
|
556
|
+
/**
|
|
557
|
+
* Gets or sets the Modifed By Ids.
|
|
558
|
+
*/
|
|
559
|
+
modifiedByIds?: Array<string>;
|
|
560
|
+
/**
|
|
561
|
+
* Gets or sets the Date Created greater than equal to.
|
|
562
|
+
*/
|
|
563
|
+
dateCreatedGte?: string;
|
|
564
|
+
/**
|
|
565
|
+
* Gets or sets the Date Created less than equal to.
|
|
566
|
+
*/
|
|
567
|
+
dateCreatedLte?: string;
|
|
568
|
+
/**
|
|
569
|
+
* Gets or sets the queryable only is live status.
|
|
570
|
+
*/
|
|
571
|
+
isLive?: boolean;
|
|
572
|
+
/**
|
|
573
|
+
* Gets or sets the sort order direction.
|
|
574
|
+
*/
|
|
575
|
+
sortOrderDirection?: SearchSortOrderDirection;
|
|
576
|
+
}): CancelablePromise<number> {
|
|
577
|
+
return this.httpRequest.request({
|
|
578
|
+
method: 'GET',
|
|
579
|
+
url: '/api/payment-policies/count',
|
|
580
|
+
query: {
|
|
581
|
+
Ids: ids,
|
|
582
|
+
Name: name,
|
|
583
|
+
IsDefault: isDefault,
|
|
584
|
+
IsSystem: isSystem,
|
|
585
|
+
PageNumber: pageNumber,
|
|
586
|
+
Take: take,
|
|
587
|
+
Skip: skip,
|
|
588
|
+
LimitListRequests: limitListRequests,
|
|
589
|
+
TenantId: tenantId,
|
|
590
|
+
ModifiedById: modifiedById,
|
|
591
|
+
ModifiedByIds: modifiedByIds,
|
|
592
|
+
DateCreatedGTE: dateCreatedGte,
|
|
593
|
+
DateCreatedLTE: dateCreatedLte,
|
|
594
|
+
IsLive: isLive,
|
|
595
|
+
SortOrderDirection: sortOrderDirection,
|
|
596
|
+
},
|
|
597
|
+
errors: {
|
|
598
|
+
400: `Bad Request`,
|
|
599
|
+
422: `Unprocessable Content`,
|
|
600
|
+
500: `Internal Server Error`,
|
|
601
|
+
},
|
|
602
|
+
});
|
|
603
|
+
}
|
|
604
|
+
|
|
494
605
|
/**
|
|
495
606
|
* Gets a list of resources unpaged and without references.
|
|
496
607
|
* @returns PaymentPolicy OK
|
|
@@ -411,6 +411,99 @@ export class PaymentsService {
|
|
|
411
411
|
});
|
|
412
412
|
}
|
|
413
413
|
|
|
414
|
+
/**
|
|
415
|
+
* Returns the number of results in the database given the provided search params.
|
|
416
|
+
* @returns number OK
|
|
417
|
+
* @throws ApiError
|
|
418
|
+
*/
|
|
419
|
+
public count({
|
|
420
|
+
orderId,
|
|
421
|
+
pageNumber,
|
|
422
|
+
take,
|
|
423
|
+
skip,
|
|
424
|
+
limitListRequests,
|
|
425
|
+
tenantId,
|
|
426
|
+
modifiedById,
|
|
427
|
+
modifiedByIds,
|
|
428
|
+
dateCreatedGte,
|
|
429
|
+
dateCreatedLte,
|
|
430
|
+
isLive,
|
|
431
|
+
sortOrderDirection,
|
|
432
|
+
}: {
|
|
433
|
+
/**
|
|
434
|
+
* Gets or sets the order Id for use in a query search.
|
|
435
|
+
*/
|
|
436
|
+
orderId?: string;
|
|
437
|
+
/**
|
|
438
|
+
* Gets or sets the page number for paged queries.
|
|
439
|
+
*/
|
|
440
|
+
pageNumber?: number;
|
|
441
|
+
/**
|
|
442
|
+
* Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
|
|
443
|
+
*/
|
|
444
|
+
take?: number;
|
|
445
|
+
/**
|
|
446
|
+
* Gets or sets how much items to skip from begining of db table, when this is set page is always 1.
|
|
447
|
+
*/
|
|
448
|
+
skip?: number;
|
|
449
|
+
/**
|
|
450
|
+
* Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
|
|
451
|
+
*/
|
|
452
|
+
limitListRequests?: boolean;
|
|
453
|
+
/**
|
|
454
|
+
* Gets or sets the Tenant Id.
|
|
455
|
+
*/
|
|
456
|
+
tenantId?: string;
|
|
457
|
+
/**
|
|
458
|
+
* Gets or sets the Modifed By Id.
|
|
459
|
+
*/
|
|
460
|
+
modifiedById?: string;
|
|
461
|
+
/**
|
|
462
|
+
* Gets or sets the Modifed By Ids.
|
|
463
|
+
*/
|
|
464
|
+
modifiedByIds?: Array<string>;
|
|
465
|
+
/**
|
|
466
|
+
* Gets or sets the Date Created greater than equal to.
|
|
467
|
+
*/
|
|
468
|
+
dateCreatedGte?: string;
|
|
469
|
+
/**
|
|
470
|
+
* Gets or sets the Date Created less than equal to.
|
|
471
|
+
*/
|
|
472
|
+
dateCreatedLte?: string;
|
|
473
|
+
/**
|
|
474
|
+
* Gets or sets the queryable only is live status.
|
|
475
|
+
*/
|
|
476
|
+
isLive?: boolean;
|
|
477
|
+
/**
|
|
478
|
+
* Gets or sets the sort order direction.
|
|
479
|
+
*/
|
|
480
|
+
sortOrderDirection?: SearchSortOrderDirection;
|
|
481
|
+
}): CancelablePromise<number> {
|
|
482
|
+
return this.httpRequest.request({
|
|
483
|
+
method: 'GET',
|
|
484
|
+
url: '/api/payments/count',
|
|
485
|
+
query: {
|
|
486
|
+
OrderId: orderId,
|
|
487
|
+
PageNumber: pageNumber,
|
|
488
|
+
Take: take,
|
|
489
|
+
Skip: skip,
|
|
490
|
+
LimitListRequests: limitListRequests,
|
|
491
|
+
TenantId: tenantId,
|
|
492
|
+
ModifiedById: modifiedById,
|
|
493
|
+
ModifiedByIds: modifiedByIds,
|
|
494
|
+
DateCreatedGTE: dateCreatedGte,
|
|
495
|
+
DateCreatedLTE: dateCreatedLte,
|
|
496
|
+
IsLive: isLive,
|
|
497
|
+
SortOrderDirection: sortOrderDirection,
|
|
498
|
+
},
|
|
499
|
+
errors: {
|
|
500
|
+
400: `Bad Request`,
|
|
501
|
+
422: `Unprocessable Content`,
|
|
502
|
+
500: `Internal Server Error`,
|
|
503
|
+
},
|
|
504
|
+
});
|
|
505
|
+
}
|
|
506
|
+
|
|
414
507
|
/**
|
|
415
508
|
* Gets a list of resources unpaged and without references.
|
|
416
509
|
* @returns Payment OK
|
|
@@ -399,6 +399,93 @@ export class PermissionsService {
|
|
|
399
399
|
});
|
|
400
400
|
}
|
|
401
401
|
|
|
402
|
+
/**
|
|
403
|
+
* Returns the number of results in the database given the provided search params.
|
|
404
|
+
* @returns number OK
|
|
405
|
+
* @throws ApiError
|
|
406
|
+
*/
|
|
407
|
+
public count({
|
|
408
|
+
pageNumber,
|
|
409
|
+
take,
|
|
410
|
+
skip,
|
|
411
|
+
limitListRequests,
|
|
412
|
+
tenantId,
|
|
413
|
+
modifiedById,
|
|
414
|
+
modifiedByIds,
|
|
415
|
+
dateCreatedGte,
|
|
416
|
+
dateCreatedLte,
|
|
417
|
+
isLive,
|
|
418
|
+
sortOrderDirection,
|
|
419
|
+
}: {
|
|
420
|
+
/**
|
|
421
|
+
* Gets or sets the page number for paged queries.
|
|
422
|
+
*/
|
|
423
|
+
pageNumber?: number;
|
|
424
|
+
/**
|
|
425
|
+
* Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
|
|
426
|
+
*/
|
|
427
|
+
take?: number;
|
|
428
|
+
/**
|
|
429
|
+
* Gets or sets how much items to skip from begining of db table, when this is set page is always 1.
|
|
430
|
+
*/
|
|
431
|
+
skip?: number;
|
|
432
|
+
/**
|
|
433
|
+
* Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
|
|
434
|
+
*/
|
|
435
|
+
limitListRequests?: boolean;
|
|
436
|
+
/**
|
|
437
|
+
* Gets or sets the Tenant Id.
|
|
438
|
+
*/
|
|
439
|
+
tenantId?: string;
|
|
440
|
+
/**
|
|
441
|
+
* Gets or sets the Modifed By Id.
|
|
442
|
+
*/
|
|
443
|
+
modifiedById?: string;
|
|
444
|
+
/**
|
|
445
|
+
* Gets or sets the Modifed By Ids.
|
|
446
|
+
*/
|
|
447
|
+
modifiedByIds?: Array<string>;
|
|
448
|
+
/**
|
|
449
|
+
* Gets or sets the Date Created greater than equal to.
|
|
450
|
+
*/
|
|
451
|
+
dateCreatedGte?: string;
|
|
452
|
+
/**
|
|
453
|
+
* Gets or sets the Date Created less than equal to.
|
|
454
|
+
*/
|
|
455
|
+
dateCreatedLte?: string;
|
|
456
|
+
/**
|
|
457
|
+
* Gets or sets the queryable only is live status.
|
|
458
|
+
*/
|
|
459
|
+
isLive?: boolean;
|
|
460
|
+
/**
|
|
461
|
+
* Gets or sets the sort order direction.
|
|
462
|
+
*/
|
|
463
|
+
sortOrderDirection?: SearchSortOrderDirection;
|
|
464
|
+
}): CancelablePromise<number> {
|
|
465
|
+
return this.httpRequest.request({
|
|
466
|
+
method: 'GET',
|
|
467
|
+
url: '/api/permissions/count',
|
|
468
|
+
query: {
|
|
469
|
+
PageNumber: pageNumber,
|
|
470
|
+
Take: take,
|
|
471
|
+
Skip: skip,
|
|
472
|
+
LimitListRequests: limitListRequests,
|
|
473
|
+
TenantId: tenantId,
|
|
474
|
+
ModifiedById: modifiedById,
|
|
475
|
+
ModifiedByIds: modifiedByIds,
|
|
476
|
+
DateCreatedGTE: dateCreatedGte,
|
|
477
|
+
DateCreatedLTE: dateCreatedLte,
|
|
478
|
+
IsLive: isLive,
|
|
479
|
+
SortOrderDirection: sortOrderDirection,
|
|
480
|
+
},
|
|
481
|
+
errors: {
|
|
482
|
+
400: `Bad Request`,
|
|
483
|
+
422: `Unprocessable Content`,
|
|
484
|
+
500: `Internal Server Error`,
|
|
485
|
+
},
|
|
486
|
+
});
|
|
487
|
+
}
|
|
488
|
+
|
|
402
489
|
/**
|
|
403
490
|
* Gets a list of resources unpaged and without references.
|
|
404
491
|
* @returns Permission OK
|
|
@@ -440,6 +440,105 @@ export class PlatformPayoutsService {
|
|
|
440
440
|
});
|
|
441
441
|
}
|
|
442
442
|
|
|
443
|
+
/**
|
|
444
|
+
* Returns the number of results in the database given the provided search params.
|
|
445
|
+
* @returns number OK
|
|
446
|
+
* @throws ApiError
|
|
447
|
+
*/
|
|
448
|
+
public count({
|
|
449
|
+
id,
|
|
450
|
+
sent,
|
|
451
|
+
pageNumber,
|
|
452
|
+
take,
|
|
453
|
+
skip,
|
|
454
|
+
limitListRequests,
|
|
455
|
+
tenantId,
|
|
456
|
+
modifiedById,
|
|
457
|
+
modifiedByIds,
|
|
458
|
+
dateCreatedGte,
|
|
459
|
+
dateCreatedLte,
|
|
460
|
+
isLive,
|
|
461
|
+
sortOrderDirection,
|
|
462
|
+
}: {
|
|
463
|
+
/**
|
|
464
|
+
* Gets or sets the queryable Refund Id.
|
|
465
|
+
*/
|
|
466
|
+
id?: string;
|
|
467
|
+
/**
|
|
468
|
+
* Gets or sets the queryable if platform payout is sent or no.
|
|
469
|
+
*/
|
|
470
|
+
sent?: boolean;
|
|
471
|
+
/**
|
|
472
|
+
* Gets or sets the page number for paged queries.
|
|
473
|
+
*/
|
|
474
|
+
pageNumber?: number;
|
|
475
|
+
/**
|
|
476
|
+
* Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
|
|
477
|
+
*/
|
|
478
|
+
take?: number;
|
|
479
|
+
/**
|
|
480
|
+
* Gets or sets how much items to skip from begining of db table, when this is set page is always 1.
|
|
481
|
+
*/
|
|
482
|
+
skip?: number;
|
|
483
|
+
/**
|
|
484
|
+
* Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
|
|
485
|
+
*/
|
|
486
|
+
limitListRequests?: boolean;
|
|
487
|
+
/**
|
|
488
|
+
* Gets or sets the Tenant Id.
|
|
489
|
+
*/
|
|
490
|
+
tenantId?: string;
|
|
491
|
+
/**
|
|
492
|
+
* Gets or sets the Modifed By Id.
|
|
493
|
+
*/
|
|
494
|
+
modifiedById?: string;
|
|
495
|
+
/**
|
|
496
|
+
* Gets or sets the Modifed By Ids.
|
|
497
|
+
*/
|
|
498
|
+
modifiedByIds?: Array<string>;
|
|
499
|
+
/**
|
|
500
|
+
* Gets or sets the Date Created greater than equal to.
|
|
501
|
+
*/
|
|
502
|
+
dateCreatedGte?: string;
|
|
503
|
+
/**
|
|
504
|
+
* Gets or sets the Date Created less than equal to.
|
|
505
|
+
*/
|
|
506
|
+
dateCreatedLte?: string;
|
|
507
|
+
/**
|
|
508
|
+
* Gets or sets the queryable only is live status.
|
|
509
|
+
*/
|
|
510
|
+
isLive?: boolean;
|
|
511
|
+
/**
|
|
512
|
+
* Gets or sets the sort order direction.
|
|
513
|
+
*/
|
|
514
|
+
sortOrderDirection?: SearchSortOrderDirection;
|
|
515
|
+
}): CancelablePromise<number> {
|
|
516
|
+
return this.httpRequest.request({
|
|
517
|
+
method: 'GET',
|
|
518
|
+
url: '/api/platform-payouts/count',
|
|
519
|
+
query: {
|
|
520
|
+
Id: id,
|
|
521
|
+
Sent: sent,
|
|
522
|
+
PageNumber: pageNumber,
|
|
523
|
+
Take: take,
|
|
524
|
+
Skip: skip,
|
|
525
|
+
LimitListRequests: limitListRequests,
|
|
526
|
+
TenantId: tenantId,
|
|
527
|
+
ModifiedById: modifiedById,
|
|
528
|
+
ModifiedByIds: modifiedByIds,
|
|
529
|
+
DateCreatedGTE: dateCreatedGte,
|
|
530
|
+
DateCreatedLTE: dateCreatedLte,
|
|
531
|
+
IsLive: isLive,
|
|
532
|
+
SortOrderDirection: sortOrderDirection,
|
|
533
|
+
},
|
|
534
|
+
errors: {
|
|
535
|
+
400: `Bad Request`,
|
|
536
|
+
422: `Unprocessable Content`,
|
|
537
|
+
500: `Internal Server Error`,
|
|
538
|
+
},
|
|
539
|
+
});
|
|
540
|
+
}
|
|
541
|
+
|
|
443
542
|
/**
|
|
444
543
|
* Gets a list of resources unpaged and without references.
|
|
445
544
|
* @returns PlatformPayout OK
|
|
@@ -513,6 +513,123 @@ export class ProgrammesService {
|
|
|
513
513
|
});
|
|
514
514
|
}
|
|
515
515
|
|
|
516
|
+
/**
|
|
517
|
+
* Returns the number of results in the database given the provided search params.
|
|
518
|
+
* @returns number OK
|
|
519
|
+
* @throws ApiError
|
|
520
|
+
*/
|
|
521
|
+
public count({
|
|
522
|
+
name,
|
|
523
|
+
nameLike,
|
|
524
|
+
slug,
|
|
525
|
+
includeOpportunityImages,
|
|
526
|
+
active,
|
|
527
|
+
pageNumber,
|
|
528
|
+
take,
|
|
529
|
+
skip,
|
|
530
|
+
limitListRequests,
|
|
531
|
+
tenantId,
|
|
532
|
+
modifiedById,
|
|
533
|
+
modifiedByIds,
|
|
534
|
+
dateCreatedGte,
|
|
535
|
+
dateCreatedLte,
|
|
536
|
+
isLive,
|
|
537
|
+
sortOrderDirection,
|
|
538
|
+
}: {
|
|
539
|
+
/**
|
|
540
|
+
* Gets or sets the queryable programme name.
|
|
541
|
+
*/
|
|
542
|
+
name?: string;
|
|
543
|
+
/**
|
|
544
|
+
* Gets or sets the queryable programme name wildcard.
|
|
545
|
+
*/
|
|
546
|
+
nameLike?: string;
|
|
547
|
+
/**
|
|
548
|
+
* Gets or sets the queryable programme url slug.
|
|
549
|
+
*/
|
|
550
|
+
slug?: string;
|
|
551
|
+
/**
|
|
552
|
+
* Gets or sets a value indicating whether to inlcude the programmes opportunity images.
|
|
553
|
+
*/
|
|
554
|
+
includeOpportunityImages?: boolean;
|
|
555
|
+
/**
|
|
556
|
+
* Gets or sets the queryable programme active status.
|
|
557
|
+
*/
|
|
558
|
+
active?: boolean;
|
|
559
|
+
/**
|
|
560
|
+
* Gets or sets the page number for paged queries.
|
|
561
|
+
*/
|
|
562
|
+
pageNumber?: number;
|
|
563
|
+
/**
|
|
564
|
+
* Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
|
|
565
|
+
*/
|
|
566
|
+
take?: number;
|
|
567
|
+
/**
|
|
568
|
+
* Gets or sets how much items to skip from begining of db table, when this is set page is always 1.
|
|
569
|
+
*/
|
|
570
|
+
skip?: number;
|
|
571
|
+
/**
|
|
572
|
+
* Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
|
|
573
|
+
*/
|
|
574
|
+
limitListRequests?: boolean;
|
|
575
|
+
/**
|
|
576
|
+
* Gets or sets the Tenant Id.
|
|
577
|
+
*/
|
|
578
|
+
tenantId?: string;
|
|
579
|
+
/**
|
|
580
|
+
* Gets or sets the Modifed By Id.
|
|
581
|
+
*/
|
|
582
|
+
modifiedById?: string;
|
|
583
|
+
/**
|
|
584
|
+
* Gets or sets the Modifed By Ids.
|
|
585
|
+
*/
|
|
586
|
+
modifiedByIds?: Array<string>;
|
|
587
|
+
/**
|
|
588
|
+
* Gets or sets the Date Created greater than equal to.
|
|
589
|
+
*/
|
|
590
|
+
dateCreatedGte?: string;
|
|
591
|
+
/**
|
|
592
|
+
* Gets or sets the Date Created less than equal to.
|
|
593
|
+
*/
|
|
594
|
+
dateCreatedLte?: string;
|
|
595
|
+
/**
|
|
596
|
+
* Gets or sets the queryable only is live status.
|
|
597
|
+
*/
|
|
598
|
+
isLive?: boolean;
|
|
599
|
+
/**
|
|
600
|
+
* Gets or sets the sort order direction.
|
|
601
|
+
*/
|
|
602
|
+
sortOrderDirection?: SearchSortOrderDirection;
|
|
603
|
+
}): CancelablePromise<number> {
|
|
604
|
+
return this.httpRequest.request({
|
|
605
|
+
method: 'GET',
|
|
606
|
+
url: '/api/programmes/count',
|
|
607
|
+
query: {
|
|
608
|
+
Name: name,
|
|
609
|
+
NameLike: nameLike,
|
|
610
|
+
Slug: slug,
|
|
611
|
+
IncludeOpportunityImages: includeOpportunityImages,
|
|
612
|
+
Active: active,
|
|
613
|
+
PageNumber: pageNumber,
|
|
614
|
+
Take: take,
|
|
615
|
+
Skip: skip,
|
|
616
|
+
LimitListRequests: limitListRequests,
|
|
617
|
+
TenantId: tenantId,
|
|
618
|
+
ModifiedById: modifiedById,
|
|
619
|
+
ModifiedByIds: modifiedByIds,
|
|
620
|
+
DateCreatedGTE: dateCreatedGte,
|
|
621
|
+
DateCreatedLTE: dateCreatedLte,
|
|
622
|
+
IsLive: isLive,
|
|
623
|
+
SortOrderDirection: sortOrderDirection,
|
|
624
|
+
},
|
|
625
|
+
errors: {
|
|
626
|
+
400: `Bad Request`,
|
|
627
|
+
422: `Unprocessable Content`,
|
|
628
|
+
500: `Internal Server Error`,
|
|
629
|
+
},
|
|
630
|
+
});
|
|
631
|
+
}
|
|
632
|
+
|
|
516
633
|
/**
|
|
517
634
|
* Gets a list of resources unpaged and without references.
|
|
518
635
|
* @returns Programme OK
|