reach-api-sdk 1.0.193 → 1.0.195

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

package/src/services/CustomersService.ts

@@ -823,6 +823,135 @@ export class CustomersService {
     });
   }
 
+  /**
+   * Returns the number of results in the database given the provided search params.
+   * @returns number OK
+   * @throws ApiError
+   */
+  public count({
+    wildcard,
+    displayEmail,
+    venueId,
+    programmeId,
+    marketingOptIn,
+    isActiveCustomer,
+    endUserIdentityId,
+    pageNumber,
+    take,
+    skip,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * Gets or sets the wildcard for use in a query search.
+     */
+    wildcard?: string;
+    /**
+     * Gets or sets the customers email for use in a query search.
+     */
+    displayEmail?: string;
+    /**
+     * Gets or sets the venue id for use in a query search.
+     */
+    venueId?: string;
+    /**
+     * Gets or sets the programme id for use in a query search - filtering for customers who have touch points with the programme.
+     */
+    programmeId?: string;
+    /**
+     * Gets or sets if the customer is marketing opted in or out.
+     */
+    marketingOptIn?: boolean;
+    /**
+     * 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.
+     */
+    isActiveCustomer?: boolean;
+    /**
+     * Gets or sets the customers end user identity id.
+     */
+    endUserIdentityId?: 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/customers/count',
+      query: {
+        Wildcard: wildcard,
+        DisplayEmail: displayEmail,
+        VenueId: venueId,
+        ProgrammeId: programmeId,
+        MarketingOptIn: marketingOptIn,
+        IsActiveCustomer: isActiveCustomer,
+        EndUserIdentityId: endUserIdentityId,
+        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 Customer OK

package/src/services/DealActivitiesService.ts

@@ -539,6 +539,129 @@ export class DealActivitiesService {
     });
   }
 
+  /**
+   * Returns the number of results in the database given the provided search params.
+   * @returns number OK
+   * @throws ApiError
+   */
+  public count({
+    dealId,
+    dealIds,
+    courseId,
+    courseIds,
+    sessionId,
+    sessionIds,
+    pageNumber,
+    take,
+    skip,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * Gets or sets the queryable deal id.
+     */
+    dealId?: string;
+    /**
+     * Gets or sets the queryable dealids.
+     */
+    dealIds?: Array<string>;
+    /**
+     * Gets or sets the queryable course id.
+     */
+    courseId?: string;
+    /**
+     * Gets or sets the queryable course ids.
+     */
+    courseIds?: Array<string>;
+    /**
+     * Gets or sets the queryable session id.
+     */
+    sessionId?: string;
+    /**
+     * Gets or sets the queryable session ids.
+     */
+    sessionIds?: 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/deal-activities/count',
+      query: {
+        DealId: dealId,
+        DealIds: dealIds,
+        CourseId: courseId,
+        CourseIds: courseIds,
+        SessionId: sessionId,
+        SessionIds: sessionIds,
+        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 DealActivity OK

package/src/services/DealsService.ts

@@ -517,6 +517,129 @@ export class DealsService {
     });
   }
 
+  /**
+   * Returns the number of results in the database given the provided search params.
+   * @returns number OK
+   * @throws ApiError
+   */
+  public count({
+    id,
+    ids,
+    target,
+    type,
+    types,
+    discountCode,
+    pageNumber,
+    take,
+    skip,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * Gets or sets the queryable Deal Id.
+     */
+    id?: string;
+    /**
+     * Gets or sets the queryable Deal ids.
+     */
+    ids?: Array<string>;
+    /**
+     * Gets or sets the queryable target.
+     */
+    target?: DealTarget;
+    /**
+     * Gets or sets the queryable type.
+     */
+    type?: DealType;
+    /**
+     * Gets or sets the queryable Deal types.
+     */
+    types?: Array<DealType>;
+    /**
+     * Gets or sets the queryable discount code.
+     */
+    discountCode?: 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/deals/count',
+      query: {
+        Id: id,
+        Ids: ids,
+        Target: target,
+        Type: type,
+        Types: types,
+        DiscountCode: discountCode,
+        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 Deal OK