reach-api-sdk 1.0.194 → 1.0.196

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

package/src/services/DiscountCodeUsesService.ts

@@ -6,6 +6,7 @@ import type { DiscountCodeUse } from '../models/DiscountCodeUse';
 import type { DiscountCodeUsePage } from '../models/DiscountCodeUsePage';
 import type { DiscountCodeUsePatch } from '../models/DiscountCodeUsePatch';
 import type { DiscountCodeUsePost } from '../models/DiscountCodeUsePost';
+import type { OrderStage } from '../models/OrderStage';
 import type { SearchSortOrderDirection } from '../models/SearchSortOrderDirection';
 
 import type { CancelablePromise } from '../core/CancelablePromise';
@@ -153,6 +154,7 @@ export class DiscountCodeUsesService {
     dealId,
     orderId,
     customerId,
+    orderStages,
     pageNumber,
     take,
     skip,
@@ -177,6 +179,10 @@ export class DiscountCodeUsesService {
      * Gets or sets the customer id.
      */
     customerId?: string;
+    /**
+     * Gets or sets the queryable order stages.
+     */
+    orderStages?: Array<OrderStage>;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -229,6 +235,7 @@ export class DiscountCodeUsesService {
         DealId: dealId,
         OrderId: orderId,
         CustomerId: customerId,
+        OrderStages: orderStages,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -339,6 +346,7 @@ export class DiscountCodeUsesService {
     dealId,
     orderId,
     customerId,
+    orderStages,
     pageNumber,
     take,
     skip,
@@ -363,6 +371,10 @@ export class DiscountCodeUsesService {
      * Gets or sets the customer id.
      */
     customerId?: string;
+    /**
+     * Gets or sets the queryable order stages.
+     */
+    orderStages?: Array<OrderStage>;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -415,6 +427,118 @@ export class DiscountCodeUsesService {
         DealId: dealId,
         OrderId: orderId,
         CustomerId: customerId,
+        OrderStages: orderStages,
+        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({
+    dealId,
+    orderId,
+    customerId,
+    orderStages,
+    pageNumber,
+    take,
+    skip,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * Gets or sets the deal id.
+     */
+    dealId?: string;
+    /**
+     * Gets or sets the order id.
+     */
+    orderId?: string;
+    /**
+     * Gets or sets the customer id.
+     */
+    customerId?: string;
+    /**
+     * Gets or sets the queryable order stages.
+     */
+    orderStages?: Array<OrderStage>;
+    /**
+     * 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/discount-code-uses/count',
+      query: {
+        DealId: dealId,
+        OrderId: orderId,
+        CustomerId: customerId,
+        OrderStages: orderStages,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -444,6 +568,7 @@ export class DiscountCodeUsesService {
     dealId,
     orderId,
     customerId,
+    orderStages,
     pageNumber,
     take,
     skip,
@@ -468,6 +593,10 @@ export class DiscountCodeUsesService {
      * Gets or sets the customer id.
      */
     customerId?: string;
+    /**
+     * Gets or sets the queryable order stages.
+     */
+    orderStages?: Array<OrderStage>;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -520,6 +649,7 @@ export class DiscountCodeUsesService {
         DealId: dealId,
         OrderId: orderId,
         CustomerId: customerId,
+        OrderStages: orderStages,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -549,6 +679,7 @@ export class DiscountCodeUsesService {
     dealId,
     orderId,
     customerId,
+    orderStages,
     pageNumber,
     take,
     skip,
@@ -573,6 +704,10 @@ export class DiscountCodeUsesService {
      * Gets or sets the customer id.
      */
     customerId?: string;
+    /**
+     * Gets or sets the queryable order stages.
+     */
+    orderStages?: Array<OrderStage>;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -625,6 +760,7 @@ export class DiscountCodeUsesService {
         DealId: dealId,
         OrderId: orderId,
         CustomerId: customerId,
+        OrderStages: orderStages,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,