reach-api-sdk 1.0.194 → 1.0.196

package/src/services/CourseSessionSchedulesService.ts

@@ -504,6 +504,123 @@ export class CourseSessionSchedulesService {
     });
   }
 
+  /**
+   * Returns the number of results in the database given the provided search params.
+   * @returns number OK
+   * @throws ApiError
+   */
+  public count({
+    courseId,
+    courseIds,
+    lastRunDateTimeLte,
+    status,
+    statuses,
+    pageNumber,
+    take,
+    skip,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * Gets or sets the queryable course id.
+     */
+    courseId?: string;
+    /**
+     * Gets or sets the queryable slot course Ids.
+     */
+    courseIds?: Array<string>;
+    /**
+     * Gets or sets the queryable slot schedule last run date.
+     */
+    lastRunDateTimeLte?: string;
+    /**
+     * Gets or sets the queryable schedule status.
+     */
+    status?: ScheduleStatus;
+    /**
+     * Gets or sets the queryable schedule statuses.
+     */
+    statuses?: Array<ScheduleStatus>;
+    /**
+     * Gets or sets the page number for paged queries.
+     */
+    pageNumber?: number;
+    /**
+     * Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
+     */
+    take?: number;
+    /**
+     * Gets or sets how much items to skip from begining of db table, when this is set page is always 1.
+     */
+    skip?: number;
+    /**
+     * Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
+     */
+    limitListRequests?: boolean;
+    /**
+     * Gets or sets the Tenant Id.
+     */
+    tenantId?: string;
+    /**
+     * Gets or sets the Modifed By Id.
+     */
+    modifiedById?: string;
+    /**
+     * Gets or sets the Modifed By Ids.
+     */
+    modifiedByIds?: Array<string>;
+    /**
+     * Gets or sets the Date Created greater than equal to.
+     */
+    dateCreatedGte?: string;
+    /**
+     * Gets or sets the Date Created less than equal to.
+     */
+    dateCreatedLte?: string;
+    /**
+     * Gets or sets the queryable only is live status.
+     */
+    isLive?: boolean;
+    /**
+     * Gets or sets the sort order direction.
+     */
+    sortOrderDirection?: SearchSortOrderDirection;
+  }): CancelablePromise<number> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/course-session-schedules/count',
+      query: {
+        CourseId: courseId,
+        CourseIds: courseIds,
+        LastRunDateTimeLTE: lastRunDateTimeLte,
+        Status: status,
+        Statuses: statuses,
+        PageNumber: pageNumber,
+        Take: take,
+        Skip: skip,
+        LimitListRequests: limitListRequests,
+        TenantId: tenantId,
+        ModifiedById: modifiedById,
+        ModifiedByIds: modifiedByIds,
+        DateCreatedGTE: dateCreatedGte,
+        DateCreatedLTE: dateCreatedLte,
+        IsLive: isLive,
+        SortOrderDirection: sortOrderDirection,
+      },
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
   /**
    * Gets a list of resources unpaged and without references.
    * @returns CourseSessionSchedule OK

package/src/services/CourseSessionsService.ts

@@ -243,6 +243,7 @@ export class CourseSessionsService {
     endDateTimeLte,
     endDateTimeGte,
     futureOnly,
+    bookableOnly,
     includeVenue,
     includeOffers,
     excludeArchived,
@@ -310,6 +311,10 @@ export class CourseSessionsService {
      * Gets or sets a value indicating whether to only return future course sessions.
      */
     futureOnly?: boolean;
+    /**
+     * Gets or sets a value indicating whether to only return bookable scheduled sessions.
+     */
+    bookableOnly?: boolean;
     /**
      * Gets or sets a value indicating whether to include venue detail in the results.
      */
@@ -384,6 +389,7 @@ export class CourseSessionsService {
         EndDateTimeLTE: endDateTimeLte,
         EndDateTimeGTE: endDateTimeGte,
         FutureOnly: futureOnly,
+        BookableOnly: bookableOnly,
         IncludeVenue: includeVenue,
         IncludeOffers: includeOffers,
         ExcludeArchived: excludeArchived,
@@ -507,6 +513,7 @@ export class CourseSessionsService {
     endDateTimeLte,
     endDateTimeGte,
     futureOnly,
+    bookableOnly,
     includeVenue,
     includeOffers,
     excludeArchived,
@@ -574,6 +581,10 @@ export class CourseSessionsService {
      * Gets or sets a value indicating whether to only return future course sessions.
      */
     futureOnly?: boolean;
+    /**
+     * Gets or sets a value indicating whether to only return bookable scheduled sessions.
+     */
+    bookableOnly?: boolean;
     /**
      * Gets or sets a value indicating whether to include venue detail in the results.
      */
@@ -648,6 +659,196 @@ export class CourseSessionsService {
         EndDateTimeLTE: endDateTimeLte,
         EndDateTimeGTE: endDateTimeGte,
         FutureOnly: futureOnly,
+        BookableOnly: bookableOnly,
+        IncludeVenue: includeVenue,
+        IncludeOffers: includeOffers,
+        ExcludeArchived: excludeArchived,
+        PageNumber: pageNumber,
+        Take: take,
+        Skip: skip,
+        LimitListRequests: limitListRequests,
+        TenantId: tenantId,
+        ModifiedById: modifiedById,
+        ModifiedByIds: modifiedByIds,
+        DateCreatedGTE: dateCreatedGte,
+        DateCreatedLTE: dateCreatedLte,
+        IsLive: isLive,
+        SortOrderDirection: sortOrderDirection,
+      },
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Returns the number of results in the database given the provided search params.
+   * @returns number OK
+   * @throws ApiError
+   */
+  public count({
+    ids,
+    venueId,
+    programmeId,
+    courseId,
+    courseIds,
+    scheduleId,
+    status,
+    statuses,
+    startDateTimeLte,
+    startDateTimeGte,
+    endDateTimeLte,
+    endDateTimeGte,
+    futureOnly,
+    bookableOnly,
+    includeVenue,
+    includeOffers,
+    excludeArchived,
+    pageNumber,
+    take,
+    skip,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * Gets or sets the queryable course session ids.
+     */
+    ids?: Array<string>;
+    /**
+     * Gets or sets the queryable course session venue Id.
+     */
+    venueId?: string;
+    /**
+     * Gets or sets the queryable course sessions programme Id.
+     */
+    programmeId?: string;
+    /**
+     * Gets or sets the queryable course session Id.
+     */
+    courseId?: string;
+    /**
+     * Gets or sets the queryable course session Ids.
+     */
+    courseIds?: Array<string>;
+    /**
+     * Gets or sets the queryable course session schedule Id.
+     */
+    scheduleId?: string;
+    /**
+     * Gets or sets the queryable course session active status.
+     */
+    status?: SlotStatus;
+    /**
+     * Gets or sets the queryable course session active status.
+     */
+    statuses?: Array<SlotStatus>;
+    /**
+     * Gets or sets the queryable course session start date time is less than or equal to.
+     */
+    startDateTimeLte?: string;
+    /**
+     * Gets or sets the queryable course session start date time is greater than or equal to.
+     */
+    startDateTimeGte?: string;
+    /**
+     * Gets or sets the queryable course session end date time is less than or equal to.
+     */
+    endDateTimeLte?: string;
+    /**
+     * Gets or sets the queryable course session end date time is greater than or equal to.
+     */
+    endDateTimeGte?: string;
+    /**
+     * Gets or sets a value indicating whether to only return future course sessions.
+     */
+    futureOnly?: boolean;
+    /**
+     * Gets or sets a value indicating whether to only return bookable scheduled sessions.
+     */
+    bookableOnly?: boolean;
+    /**
+     * Gets or sets a value indicating whether to include venue detail in the results.
+     */
+    includeVenue?: boolean;
+    /**
+     * Gets or sets a value indicating whether to include offer detail in the results.
+     */
+    includeOffers?: boolean;
+    /**
+     * Gets or sets a value indicating whether to exclude course sessions whose courses have been archived.
+     */
+    excludeArchived?: boolean;
+    /**
+     * Gets or sets the page number for paged queries.
+     */
+    pageNumber?: number;
+    /**
+     * Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
+     */
+    take?: number;
+    /**
+     * Gets or sets how much items to skip from begining of db table, when this is set page is always 1.
+     */
+    skip?: number;
+    /**
+     * Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
+     */
+    limitListRequests?: boolean;
+    /**
+     * Gets or sets the Tenant Id.
+     */
+    tenantId?: string;
+    /**
+     * Gets or sets the Modifed By Id.
+     */
+    modifiedById?: string;
+    /**
+     * Gets or sets the Modifed By Ids.
+     */
+    modifiedByIds?: Array<string>;
+    /**
+     * Gets or sets the Date Created greater than equal to.
+     */
+    dateCreatedGte?: string;
+    /**
+     * Gets or sets the Date Created less than equal to.
+     */
+    dateCreatedLte?: string;
+    /**
+     * Gets or sets the queryable only is live status.
+     */
+    isLive?: boolean;
+    /**
+     * Gets or sets the sort order direction.
+     */
+    sortOrderDirection?: SearchSortOrderDirection;
+  }): CancelablePromise<number> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/course-sessions/count',
+      query: {
+        Ids: ids,
+        VenueId: venueId,
+        ProgrammeId: programmeId,
+        CourseId: courseId,
+        CourseIds: courseIds,
+        ScheduleId: scheduleId,
+        Status: status,
+        Statuses: statuses,
+        StartDateTimeLTE: startDateTimeLte,
+        StartDateTimeGTE: startDateTimeGte,
+        EndDateTimeLTE: endDateTimeLte,
+        EndDateTimeGTE: endDateTimeGte,
+        FutureOnly: futureOnly,
+        BookableOnly: bookableOnly,
         IncludeVenue: includeVenue,
         IncludeOffers: includeOffers,
         ExcludeArchived: excludeArchived,
@@ -690,6 +891,7 @@ export class CourseSessionsService {
     endDateTimeLte,
     endDateTimeGte,
     futureOnly,
+    bookableOnly,
     includeVenue,
     includeOffers,
     excludeArchived,
@@ -757,6 +959,10 @@ export class CourseSessionsService {
      * Gets or sets a value indicating whether to only return future course sessions.
      */
     futureOnly?: boolean;
+    /**
+     * Gets or sets a value indicating whether to only return bookable scheduled sessions.
+     */
+    bookableOnly?: boolean;
     /**
      * Gets or sets a value indicating whether to include venue detail in the results.
      */
@@ -831,6 +1037,7 @@ export class CourseSessionsService {
         EndDateTimeLTE: endDateTimeLte,
         EndDateTimeGTE: endDateTimeGte,
         FutureOnly: futureOnly,
+        BookableOnly: bookableOnly,
         IncludeVenue: includeVenue,
         IncludeOffers: includeOffers,
         ExcludeArchived: excludeArchived,
@@ -873,6 +1080,7 @@ export class CourseSessionsService {
     endDateTimeLte,
     endDateTimeGte,
     futureOnly,
+    bookableOnly,
     includeVenue,
     includeOffers,
     excludeArchived,
@@ -940,6 +1148,10 @@ export class CourseSessionsService {
      * Gets or sets a value indicating whether to only return future course sessions.
      */
     futureOnly?: boolean;
+    /**
+     * Gets or sets a value indicating whether to only return bookable scheduled sessions.
+     */
+    bookableOnly?: boolean;
     /**
      * Gets or sets a value indicating whether to include venue detail in the results.
      */
@@ -1014,6 +1226,7 @@ export class CourseSessionsService {
         EndDateTimeLTE: endDateTimeLte,
         EndDateTimeGTE: endDateTimeGte,
         FutureOnly: futureOnly,
+        BookableOnly: bookableOnly,
         IncludeVenue: includeVenue,
         IncludeOffers: includeOffers,
         ExcludeArchived: excludeArchived,

package/src/services/CoursesService.ts

@@ -1158,6 +1158,279 @@ export class CoursesService {
     });
   }
 
+  /**
+   * Returns the number of results in the database given the provided search params.
+   * @returns number OK
+   * @throws ApiError
+   */
+  public count({
+    id,
+    ids,
+    venueId,
+    programmeId,
+    surveyId,
+    cancellationPolicyId,
+    paymentPolicyId,
+    allowTemplating,
+    archived,
+    deleted,
+    openActiveUpdate,
+    dashboardRequest,
+    bookingStatus,
+    startDateTimeLte,
+    startDateTimeGte,
+    endDateTimeLte,
+    endDateTimeGte,
+    remainingUsesLte,
+    remainingUsesGte,
+    futureOnly,
+    online,
+    featured,
+    hasAvailability,
+    orderFirstNameContains,
+    orderLastNameContains,
+    sortBy,
+    postCompletionEmailSent,
+    searchGeoCenter,
+    distance,
+    templateFieldPermissionsId,
+    templateFieldPermissionsIds,
+    pageNumber,
+    take,
+    skip,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * Gets or sets the queryable Course Id.
+     */
+    id?: string;
+    /**
+     * Gets or sets the queryable course ids.
+     */
+    ids?: Array<string>;
+    /**
+     * Gets or sets the queryable Venue Id.
+     */
+    venueId?: string;
+    /**
+     * Gets or sets the queryable Programme Id.
+     */
+    programmeId?: string;
+    /**
+     * Gets or sets the queryable Survey Id.
+     */
+    surveyId?: string;
+    /**
+     * Gets or sets the queryable Cancellation policy Id.
+     */
+    cancellationPolicyId?: string;
+    /**
+     * Gets or sets the queryable Payment policy Id.
+     */
+    paymentPolicyId?: string;
+    /**
+     * Gets or sets a value indicating whether to include templatable courses.
+     */
+    allowTemplating?: boolean;
+    /**
+     * Gets or sets a value indicating whether to include archived courses.
+     */
+    archived?: boolean;
+    /**
+     * Gets or sets a value indicating whether to include deleted courses.
+     */
+    deleted?: boolean;
+    /**
+     * Gets or sets a value indicating this an openactive reaquest.
+     */
+    openActiveUpdate?: boolean;
+    /**
+     * Gets or sets a value indicating this a request from the storefront dashboard.Needs replacing with token middleware and DI.
+     */
+    dashboardRequest?: boolean;
+    /**
+     * Gets or sets the queryable booking status.
+     */
+    bookingStatus?: BookingStatus;
+    /**
+     * Gets or sets the queryable scheduled session start date time is less than or equal to.
+     */
+    startDateTimeLte?: string;
+    /**
+     * Gets or sets the queryable scheduled session start date time is greater than or equal to.
+     */
+    startDateTimeGte?: string;
+    /**
+     * Gets or sets the queryable scheduled session end date time is less than or equal to.
+     */
+    endDateTimeLte?: string;
+    /**
+     * Gets or sets the queryable scheduled session end date time is greater than or equal to.
+     */
+    endDateTimeGte?: string;
+    /**
+     * Gets or sets the queryable slot remaining uses is less than or equal to.
+     */
+    remainingUsesLte?: number;
+    /**
+     * Gets or sets the queryable slot remaining uses is greater than or equal to.
+     */
+    remainingUsesGte?: number;
+    /**
+     * Gets or sets a value indicating whether to only return future scheduled session.
+     */
+    futureOnly?: boolean;
+    /**
+     * Gets or sets a value indicating whether return online courses.
+     */
+    online?: boolean;
+    /**
+     * Gets or sets a value indicating whether the course is featured on the storefront.
+     */
+    featured?: boolean;
+    /**
+     * Gets or sets a value indicating whether the scheduled session has availability.
+     */
+    hasAvailability?: boolean;
+    /**
+     * Gets or sets a value indicating whether the scheduled session has an order where the orders first name contains the given value.
+     */
+    orderFirstNameContains?: string;
+    /**
+     * Gets or sets a value indicating whether the scheduled session has an order where the orders last name contains the given value.
+     */
+    orderLastNameContains?: string;
+    /**
+     * Gets or sets which field to sort by.
+     */
+    sortBy?: CourseSearchSortBy;
+    /**
+     * Gets or sets a value indicating whether the course post completion email has been sent.
+     */
+    postCompletionEmailSent?: boolean;
+    /**
+     * Gets or sets SearchGeoCenter.
+     */
+    searchGeoCenter?: string;
+    /**
+     * Gets or sets Distance.
+     */
+    distance?: number;
+    /**
+     * Gets or sets the queryable course template field permissions Id.
+     */
+    templateFieldPermissionsId?: string;
+    /**
+     * Gets or sets the queryable course template field permission ids.
+     */
+    templateFieldPermissionsIds?: Array<string>;
+    /**
+     * Gets or sets the page number for paged queries.
+     */
+    pageNumber?: number;
+    /**
+     * Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.
+     */
+    take?: number;
+    /**
+     * Gets or sets how much items to skip from begining of db table, when this is set page is always 1.
+     */
+    skip?: number;
+    /**
+     * Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
+     */
+    limitListRequests?: boolean;
+    /**
+     * Gets or sets the Tenant Id.
+     */
+    tenantId?: string;
+    /**
+     * Gets or sets the Modifed By Id.
+     */
+    modifiedById?: string;
+    /**
+     * Gets or sets the Modifed By Ids.
+     */
+    modifiedByIds?: Array<string>;
+    /**
+     * Gets or sets the Date Created greater than equal to.
+     */
+    dateCreatedGte?: string;
+    /**
+     * Gets or sets the Date Created less than equal to.
+     */
+    dateCreatedLte?: string;
+    /**
+     * Gets or sets the queryable only is live status.
+     */
+    isLive?: boolean;
+    /**
+     * Gets or sets the sort order direction.
+     */
+    sortOrderDirection?: SearchSortOrderDirection;
+  }): CancelablePromise<number> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/courses/count',
+      query: {
+        Id: id,
+        Ids: ids,
+        VenueId: venueId,
+        ProgrammeId: programmeId,
+        SurveyId: surveyId,
+        CancellationPolicyId: cancellationPolicyId,
+        PaymentPolicyId: paymentPolicyId,
+        AllowTemplating: allowTemplating,
+        Archived: archived,
+        Deleted: deleted,
+        OpenActiveUpdate: openActiveUpdate,
+        DashboardRequest: dashboardRequest,
+        BookingStatus: bookingStatus,
+        StartDateTimeLTE: startDateTimeLte,
+        StartDateTimeGTE: startDateTimeGte,
+        EndDateTimeLTE: endDateTimeLte,
+        EndDateTimeGTE: endDateTimeGte,
+        RemainingUsesLTE: remainingUsesLte,
+        RemainingUsesGTE: remainingUsesGte,
+        FutureOnly: futureOnly,
+        Online: online,
+        Featured: featured,
+        HasAvailability: hasAvailability,
+        OrderFirstNameContains: orderFirstNameContains,
+        OrderLastNameContains: orderLastNameContains,
+        SortBy: sortBy,
+        PostCompletionEmailSent: postCompletionEmailSent,
+        SearchGeoCenter: searchGeoCenter,
+        Distance: distance,
+        TemplateFieldPermissionsId: templateFieldPermissionsId,
+        TemplateFieldPermissionsIds: templateFieldPermissionsIds,
+        PageNumber: pageNumber,
+        Take: take,
+        Skip: skip,
+        LimitListRequests: limitListRequests,
+        TenantId: tenantId,
+        ModifiedById: modifiedById,
+        ModifiedByIds: modifiedByIds,
+        DateCreatedGTE: dateCreatedGte,
+        DateCreatedLTE: dateCreatedLte,
+        IsLive: isLive,
+        SortOrderDirection: sortOrderDirection,
+      },
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
   /**
    * Gets a list of resources unpaged and without references.
    * @returns Course OK