reach-api-sdk 1.0.190 → 1.0.192

package/src/services/PublicOrdersService.ts

@@ -78,6 +78,239 @@ export class PublicOrdersService {
     });
   }
 
+  /**
+   * @returns OrderPage OK
+   * @throws ApiError
+   */
+  public getPage({
+    xTenantSubdomain,
+    wildcard,
+    accessCode,
+    customerName,
+    email,
+    providerId,
+    venueId,
+    programmeId,
+    customerId,
+    orderIds,
+    sessionId,
+    facilityId,
+    courseId,
+    orderStage,
+    isBookedOrPendingPayment,
+    orderStages,
+    orderDateGte,
+    orderDateLte,
+    endUserIdentityId,
+    pageNumber,
+    take,
+    skip,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    xTenantSubdomain?: string;
+    /**
+     * Gets or sets the wildcard for use in a query search.
+     */
+    wildcard?: string;
+    /**
+     * Gets or sets the access code for use in a query search.
+     */
+    accessCode?: string;
+    /**
+     * Gets or sets the customer name for use in a query search.
+     */
+    customerName?: string;
+    /**
+     * Gets or sets the email for use in a query search.
+     */
+    email?: string;
+    /**
+     * Gets or sets the provider Id for use in a query search.
+     */
+    providerId?: 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.
+     */
+    programmeId?: string;
+    /**
+     * Gets or sets the customer Id for use in a query search.
+     */
+    customerId?: string;
+    /**
+     * Gets or sets the queryable order ids.
+     */
+    orderIds?: Array<string>;
+    /**
+     * Gets or sets the session Id for use in a query search.
+     */
+    sessionId?: string;
+    /**
+     * Gets or sets the facility Id for use in a query search.
+     */
+    facilityId?: string;
+    /**
+     * Gets or sets the course Id for use in a query search.
+     */
+    courseId?: string;
+    /**
+     * Gets or sets the queryable order stage. This cannot be used in conjunction with IsBookedOrPendingPayment.
+     */
+    orderStage?: OrderStage;
+    /**
+     * Gets or sets a value indicating whether to return orders that are either booked or pending payment. This cannot be used in conjunction with OrderStage.
+     */
+    isBookedOrPendingPayment?: boolean;
+    /**
+     * Gets or sets the queryable order stages.
+     */
+    orderStages?: Array<OrderStage>;
+    /**
+     * Gets or sets the queryable order date creted is greater than or equal to.
+     */
+    orderDateGte?: string;
+    /**
+     * Gets or sets the queryable order date created is less than or equal to.
+     */
+    orderDateLte?: string;
+    /**
+     * Gets or sets the end user identity Id for use in a query search.
+     */
+    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<OrderPage> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/public/orders',
+      headers: {
+        x_tenant_subdomain: xTenantSubdomain,
+      },
+      query: {
+        Wildcard: wildcard,
+        AccessCode: accessCode,
+        CustomerName: customerName,
+        Email: email,
+        ProviderId: providerId,
+        VenueId: venueId,
+        ProgrammeId: programmeId,
+        CustomerId: customerId,
+        OrderIds: orderIds,
+        SessionId: sessionId,
+        FacilityId: facilityId,
+        CourseId: courseId,
+        OrderStage: orderStage,
+        IsBookedOrPendingPayment: isBookedOrPendingPayment,
+        OrderStages: orderStages,
+        OrderDateGTE: orderDateGte,
+        OrderDateLTE: orderDateLte,
+        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`,
+      },
+    });
+  }
+
+  /**
+   * Deletes the resource.
+   * @returns any OK
+   * @throws ApiError
+   */
+  public deleteByObject({
+    xTenantSubdomain,
+    requestBody,
+  }: {
+    /**
+     * The tenants subdomain.
+     */
+    xTenantSubdomain?: string;
+    /**
+     * The <typeparamref name="TObject" /> model.
+     */
+    requestBody?: Order;
+  }): CancelablePromise<any> {
+    return this.httpRequest.request({
+      method: 'DELETE',
+      url: '/api/public/orders',
+      headers: {
+        x_tenant_subdomain: xTenantSubdomain,
+      },
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
   /**
    * Gets an Order and includes checks to ensure it is bookable.
    * @returns Order OK
@@ -333,237 +566,6 @@ export class PublicOrdersService {
     });
   }
 
-  /**
-   * Deletes the resource.
-   * @returns any OK
-   * @throws ApiError
-   */
-  public deleteByObject({
-    xTenantSubdomain,
-    requestBody,
-  }: {
-    /**
-     * The tenants subdomain.
-     */
-    xTenantSubdomain?: string;
-    /**
-     * The <typeparamref name="TObject" /> model.
-     */
-    requestBody?: Order;
-  }): CancelablePromise<any> {
-    return this.httpRequest.request({
-      method: 'DELETE',
-      url: '/api/public/orders',
-      headers: {
-        x_tenant_subdomain: xTenantSubdomain,
-      },
-      body: requestBody,
-      mediaType: 'application/json',
-      errors: {
-        400: `Bad Request`,
-        422: `Unprocessable Content`,
-        500: `Internal Server Error`,
-      },
-    });
-  }
-
-  /**
-   * Gets a list of resources.
-   * @returns OrderPage OK
-   * @throws ApiError
-   */
-  public getPage({
-    xTenantSubdomain,
-    wildcard,
-    accessCode,
-    customerName,
-    email,
-    providerId,
-    venueId,
-    programmeId,
-    customerId,
-    orderIds,
-    sessionId,
-    facilityId,
-    courseId,
-    orderStage,
-    isBookedOrPendingPayment,
-    orderStages,
-    orderDateGte,
-    orderDateLte,
-    pageNumber,
-    take,
-    skip,
-    limitListRequests,
-    tenantId,
-    modifiedById,
-    modifiedByIds,
-    dateCreatedGte,
-    dateCreatedLte,
-    isLive,
-    sortOrderDirection,
-  }: {
-    /**
-     * The tenants subdomain.
-     */
-    xTenantSubdomain?: string;
-    /**
-     * Gets or sets the wildcard for use in a query search.
-     */
-    wildcard?: string;
-    /**
-     * Gets or sets the access code for use in a query search.
-     */
-    accessCode?: string;
-    /**
-     * Gets or sets the customer name for use in a query search.
-     */
-    customerName?: string;
-    /**
-     * Gets or sets the email for use in a query search.
-     */
-    email?: string;
-    /**
-     * Gets or sets the provider Id for use in a query search.
-     */
-    providerId?: 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.
-     */
-    programmeId?: string;
-    /**
-     * Gets or sets the customer Id for use in a query search.
-     */
-    customerId?: string;
-    /**
-     * Gets or sets the queryable order ids.
-     */
-    orderIds?: Array<string>;
-    /**
-     * Gets or sets the session Id for use in a query search.
-     */
-    sessionId?: string;
-    /**
-     * Gets or sets the facility Id for use in a query search.
-     */
-    facilityId?: string;
-    /**
-     * Gets or sets the course Id for use in a query search.
-     */
-    courseId?: string;
-    /**
-     * Gets or sets the queryable order stage. This cannot be used in conjunction with IsBookedOrPendingPayment.
-     */
-    orderStage?: OrderStage;
-    /**
-     * Gets or sets a value indicating whether to return orders that are either booked or pending payment. This cannot be used in conjunction with OrderStage.
-     */
-    isBookedOrPendingPayment?: boolean;
-    /**
-     * Gets or sets the queryable order stages.
-     */
-    orderStages?: Array<OrderStage>;
-    /**
-     * Gets or sets the queryable order date creted is greater than or equal to.
-     */
-    orderDateGte?: string;
-    /**
-     * Gets or sets the queryable order date created is less than or equal to.
-     */
-    orderDateLte?: 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<OrderPage> {
-    return this.httpRequest.request({
-      method: 'GET',
-      url: '/api/public/orders',
-      headers: {
-        x_tenant_subdomain: xTenantSubdomain,
-      },
-      query: {
-        Wildcard: wildcard,
-        AccessCode: accessCode,
-        CustomerName: customerName,
-        Email: email,
-        ProviderId: providerId,
-        VenueId: venueId,
-        ProgrammeId: programmeId,
-        CustomerId: customerId,
-        OrderIds: orderIds,
-        SessionId: sessionId,
-        FacilityId: facilityId,
-        CourseId: courseId,
-        OrderStage: orderStage,
-        IsBookedOrPendingPayment: isBookedOrPendingPayment,
-        OrderStages: orderStages,
-        OrderDateGTE: orderDateGte,
-        OrderDateLTE: orderDateLte,
-        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 a value indicating whether the resource exists in the database given the provided search params.
    * @returns boolean OK
@@ -588,6 +590,7 @@ export class PublicOrdersService {
     orderStages,
     orderDateGte,
     orderDateLte,
+    endUserIdentityId,
     pageNumber,
     take,
     skip,
@@ -672,6 +675,10 @@ export class PublicOrdersService {
      * Gets or sets the queryable order date created is less than or equal to.
      */
     orderDateLte?: string;
+    /**
+     * Gets or sets the end user identity Id for use in a query search.
+     */
+    endUserIdentityId?: string;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -741,6 +748,7 @@ export class PublicOrdersService {
         OrderStages: orderStages,
         OrderDateGTE: orderDateGte,
         OrderDateLTE: orderDateLte,
+        EndUserIdentityId: endUserIdentityId,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,

package/src/services/PublicScheduledSessionsService.ts

@@ -102,6 +102,7 @@ export class PublicScheduledSessionsService {
     remainingUsesLte,
     remainingUsesGte,
     futureOnly,
+    bookableOnly,
     includeImages,
     includeVenue,
     includeOrders,
@@ -188,6 +189,10 @@ export class PublicScheduledSessionsService {
      * Gets or sets a value indicating whether to only return future scheduled session.
      */
     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 image detail in the results.
      */
@@ -292,6 +297,7 @@ export class PublicScheduledSessionsService {
         RemainingUsesLTE: remainingUsesLte,
         RemainingUsesGTE: remainingUsesGte,
         FutureOnly: futureOnly,
+        BookableOnly: bookableOnly,
         IncludeImages: includeImages,
         IncludeVenue: includeVenue,
         IncludeOrders: includeOrders,
@@ -480,6 +486,7 @@ export class PublicScheduledSessionsService {
     remainingUsesLte,
     remainingUsesGte,
     futureOnly,
+    bookableOnly,
     includeImages,
     includeVenue,
     includeOrders,
@@ -569,6 +576,10 @@ export class PublicScheduledSessionsService {
      * Gets or sets a value indicating whether to only return future scheduled session.
      */
     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 image detail in the results.
      */
@@ -673,6 +684,7 @@ export class PublicScheduledSessionsService {
         RemainingUsesLTE: remainingUsesLte,
         RemainingUsesGTE: remainingUsesGte,
         FutureOnly: futureOnly,
+        BookableOnly: bookableOnly,
         IncludeImages: includeImages,
         IncludeVenue: includeVenue,
         IncludeOrders: includeOrders,

package/src/services/PublicSessionsService.ts

@@ -96,6 +96,7 @@ export class PublicSessionsService {
     paymentPolicyId,
     futureOnly,
     online,
+    featured,
     programmeId,
     includeNextOpportunity,
     allowTemplating,
@@ -159,6 +160,10 @@ export class PublicSessionsService {
      * Gets or sets a value indicating whether return online sessions.
      */
     online?: boolean;
+    /**
+     * Gets or sets a value indicating whether the session is featured on the storefront.
+     */
+    featured?: boolean;
     /**
      * Gets or sets the queryable Programme Id.
      */
@@ -306,6 +311,7 @@ export class PublicSessionsService {
         PaymentPolicyId: paymentPolicyId,
         FutureOnly: futureOnly,
         Online: online,
+        Featured: featured,
         ProgrammeId: programmeId,
         IncludeNextOpportunity: includeNextOpportunity,
         AllowTemplating: allowTemplating,
@@ -446,6 +452,7 @@ export class PublicSessionsService {
     remainingUsesLte,
     remainingUsesGte,
     futureOnly,
+    bookableOnly,
     includeImages,
     includeVenue,
     includeOrders,
@@ -535,6 +542,10 @@ export class PublicSessionsService {
      * Gets or sets a value indicating whether to only return future scheduled session.
      */
     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 image detail in the results.
      */
@@ -639,6 +650,7 @@ export class PublicSessionsService {
         RemainingUsesLTE: remainingUsesLte,
         RemainingUsesGTE: remainingUsesGte,
         FutureOnly: futureOnly,
+        BookableOnly: bookableOnly,
         IncludeImages: includeImages,
         IncludeVenue: includeVenue,
         IncludeOrders: includeOrders,
@@ -784,6 +796,7 @@ export class PublicSessionsService {
     paymentPolicyId,
     futureOnly,
     online,
+    featured,
     programmeId,
     includeNextOpportunity,
     allowTemplating,
@@ -850,6 +863,10 @@ export class PublicSessionsService {
      * Gets or sets a value indicating whether return online sessions.
      */
     online?: boolean;
+    /**
+     * Gets or sets a value indicating whether the session is featured on the storefront.
+     */
+    featured?: boolean;
     /**
      * Gets or sets the queryable Programme Id.
      */
@@ -997,6 +1014,7 @@ export class PublicSessionsService {
         PaymentPolicyId: paymentPolicyId,
         FutureOnly: futureOnly,
         Online: online,
+        Featured: featured,
         ProgrammeId: programmeId,
         IncludeNextOpportunity: includeNextOpportunity,
         AllowTemplating: allowTemplating,