reach-api-sdk 1.0.192 → 1.0.194

package/src/services/ScheduledSessionsService.ts

@@ -390,6 +390,7 @@ export class ScheduledSessionsService {
     bookableOnly,
     includeImages,
     includeVenue,
+    includeOffers,
     includeOrders,
     hasAvailability,
     excludeArchived,
@@ -485,6 +486,10 @@ export class ScheduledSessionsService {
      * 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 include order detail in the results.
      */
@@ -581,6 +586,7 @@ export class ScheduledSessionsService {
         BookableOnly: bookableOnly,
         IncludeImages: includeImages,
         IncludeVenue: includeVenue,
+        IncludeOffers: includeOffers,
         IncludeOrders: includeOrders,
         HasAvailability: hasAvailability,
         ExcludeArchived: excludeArchived,
@@ -714,6 +720,7 @@ export class ScheduledSessionsService {
     bookableOnly,
     includeImages,
     includeVenue,
+    includeOffers,
     includeOrders,
     hasAvailability,
     excludeArchived,
@@ -809,6 +816,10 @@ export class ScheduledSessionsService {
      * 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 include order detail in the results.
      */
@@ -905,6 +916,7 @@ export class ScheduledSessionsService {
         BookableOnly: bookableOnly,
         IncludeImages: includeImages,
         IncludeVenue: includeVenue,
+        IncludeOffers: includeOffers,
         IncludeOrders: includeOrders,
         HasAvailability: hasAvailability,
         ExcludeArchived: excludeArchived,
@@ -957,6 +969,7 @@ export class ScheduledSessionsService {
     bookableOnly,
     includeImages,
     includeVenue,
+    includeOffers,
     includeOrders,
     hasAvailability,
     excludeArchived,
@@ -1052,6 +1065,10 @@ export class ScheduledSessionsService {
      * 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 include order detail in the results.
      */
@@ -1148,6 +1165,7 @@ export class ScheduledSessionsService {
         BookableOnly: bookableOnly,
         IncludeImages: includeImages,
         IncludeVenue: includeVenue,
+        IncludeOffers: includeOffers,
         IncludeOrders: includeOrders,
         HasAvailability: hasAvailability,
         ExcludeArchived: excludeArchived,
@@ -1200,6 +1218,7 @@ export class ScheduledSessionsService {
     bookableOnly,
     includeImages,
     includeVenue,
+    includeOffers,
     includeOrders,
     hasAvailability,
     excludeArchived,
@@ -1295,6 +1314,10 @@ export class ScheduledSessionsService {
      * 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 include order detail in the results.
      */
@@ -1391,6 +1414,7 @@ export class ScheduledSessionsService {
         BookableOnly: bookableOnly,
         IncludeImages: includeImages,
         IncludeVenue: includeVenue,
+        IncludeOffers: includeOffers,
         IncludeOrders: includeOrders,
         HasAvailability: hasAvailability,
         ExcludeArchived: excludeArchived,

package/src/services/SessionsService.ts

@@ -209,7 +209,7 @@ export class SessionsService {
   }
 
   /**
-   * Asign deal to session />.
+   * Assign deal to session.
    * @returns Session OK
    * @throws ApiError
    */
@@ -218,7 +218,7 @@ export class SessionsService {
     dealId,
   }: {
     /**
-     * The course Id.
+     * The session Id.
      */
     sessionId: string;
     /**
@@ -242,7 +242,7 @@ export class SessionsService {
   }
 
   /**
-   * Unasign deal from session />.
+   * Unassign deal from session.
    * @returns Session OK
    * @throws ApiError
    */
@@ -251,7 +251,7 @@ export class SessionsService {
     dealId,
   }: {
     /**
-     * The course Id.
+     * The session Id.
      */
     sessionId: string;
     /**
@@ -274,6 +274,60 @@ export class SessionsService {
     });
   }
 
+  /**
+   * Set the session as featured (displays more prominently on the storefront).
+   * @returns Session OK
+   * @throws ApiError
+   */
+  public setFeatured({
+    id,
+  }: {
+    /**
+     * The session Id.
+     */
+    id: string;
+  }): CancelablePromise<Session> {
+    return this.httpRequest.request({
+      method: 'PATCH',
+      url: '/api/sessions/{id}/set-featured',
+      path: {
+        id: id,
+      },
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Remove the session as featured (displays as standard on the storefront).
+   * @returns Session OK
+   * @throws ApiError
+   */
+  public removeFeatured({
+    id,
+  }: {
+    /**
+     * The session Id.
+     */
+    id: string;
+  }): CancelablePromise<Session> {
+    return this.httpRequest.request({
+      method: 'PATCH',
+      url: '/api/sessions/{id}/remove-featured',
+      path: {
+        id: id,
+      },
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
   /**
    * Inserts a new resource. The Id will be automatically generated and will be ignored if provided.
    * @returns Session OK
@@ -424,6 +478,7 @@ export class SessionsService {
     archived,
     deleted,
     openActiveUpdate,
+    dashboardRequest,
     networkId,
     distance,
     minAgeLte,
@@ -508,6 +563,10 @@ export class SessionsService {
      * 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 a value indicating whether to include only sessions by given NetworkId.
      */
@@ -635,6 +694,7 @@ export class SessionsService {
         Archived: archived,
         Deleted: deleted,
         OpenActiveUpdate: openActiveUpdate,
+        DashboardRequest: dashboardRequest,
         NetworkId: networkId,
         Distance: distance,
         MinAgeLTE: minAgeLte,
@@ -772,6 +832,7 @@ export class SessionsService {
     archived,
     deleted,
     openActiveUpdate,
+    dashboardRequest,
     networkId,
     distance,
     minAgeLte,
@@ -856,6 +917,10 @@ export class SessionsService {
      * 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 a value indicating whether to include only sessions by given NetworkId.
      */
@@ -983,6 +1048,7 @@ export class SessionsService {
         Archived: archived,
         Deleted: deleted,
         OpenActiveUpdate: openActiveUpdate,
+        DashboardRequest: dashboardRequest,
         NetworkId: networkId,
         Distance: distance,
         MinAgeLTE: minAgeLte,
@@ -1039,6 +1105,7 @@ export class SessionsService {
     archived,
     deleted,
     openActiveUpdate,
+    dashboardRequest,
     networkId,
     distance,
     minAgeLte,
@@ -1123,6 +1190,10 @@ export class SessionsService {
      * 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 a value indicating whether to include only sessions by given NetworkId.
      */
@@ -1250,6 +1321,7 @@ export class SessionsService {
         Archived: archived,
         Deleted: deleted,
         OpenActiveUpdate: openActiveUpdate,
+        DashboardRequest: dashboardRequest,
         NetworkId: networkId,
         Distance: distance,
         MinAgeLTE: minAgeLte,
@@ -1306,6 +1378,7 @@ export class SessionsService {
     archived,
     deleted,
     openActiveUpdate,
+    dashboardRequest,
     networkId,
     distance,
     minAgeLte,
@@ -1390,6 +1463,10 @@ export class SessionsService {
      * 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 a value indicating whether to include only sessions by given NetworkId.
      */
@@ -1517,6 +1594,7 @@ export class SessionsService {
         Archived: archived,
         Deleted: deleted,
         OpenActiveUpdate: openActiveUpdate,
+        DashboardRequest: dashboardRequest,
         NetworkId: networkId,
         Distance: distance,
         MinAgeLTE: minAgeLte,

package/src/services/VenuesService.ts

@@ -380,6 +380,8 @@ export class VenuesService {
     includeOpportunityOffers,
     includeNextOpportunity,
     distance,
+    dashboardRequest,
+    programmeIds,
     pageNumber,
     take,
     skip,
@@ -464,6 +466,14 @@ export class VenuesService {
      * Gets or sets Distance.
      */
     distance?: number;
+    /**
+     * 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 programme ids.
+     */
+    programmeIds?: Array<string>;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -531,6 +541,8 @@ export class VenuesService {
         IncludeOpportunityOffers: includeOpportunityOffers,
         IncludeNextOpportunity: includeNextOpportunity,
         Distance: distance,
+        DashboardRequest: dashboardRequest,
+        ProgrammeIds: programmeIds,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -656,6 +668,8 @@ export class VenuesService {
     includeOpportunityOffers,
     includeNextOpportunity,
     distance,
+    dashboardRequest,
+    programmeIds,
     pageNumber,
     take,
     skip,
@@ -740,6 +754,14 @@ export class VenuesService {
      * Gets or sets Distance.
      */
     distance?: number;
+    /**
+     * 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 programme ids.
+     */
+    programmeIds?: Array<string>;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -807,6 +829,8 @@ export class VenuesService {
         IncludeOpportunityOffers: includeOpportunityOffers,
         IncludeNextOpportunity: includeNextOpportunity,
         Distance: distance,
+        DashboardRequest: dashboardRequest,
+        ProgrammeIds: programmeIds,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -851,6 +875,8 @@ export class VenuesService {
     includeOpportunityOffers,
     includeNextOpportunity,
     distance,
+    dashboardRequest,
+    programmeIds,
     pageNumber,
     take,
     skip,
@@ -935,6 +961,14 @@ export class VenuesService {
      * Gets or sets Distance.
      */
     distance?: number;
+    /**
+     * 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 programme ids.
+     */
+    programmeIds?: Array<string>;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -1002,6 +1036,8 @@ export class VenuesService {
         IncludeOpportunityOffers: includeOpportunityOffers,
         IncludeNextOpportunity: includeNextOpportunity,
         Distance: distance,
+        DashboardRequest: dashboardRequest,
+        ProgrammeIds: programmeIds,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -1046,6 +1082,8 @@ export class VenuesService {
     includeOpportunityOffers,
     includeNextOpportunity,
     distance,
+    dashboardRequest,
+    programmeIds,
     pageNumber,
     take,
     skip,
@@ -1130,6 +1168,14 @@ export class VenuesService {
      * Gets or sets Distance.
      */
     distance?: number;
+    /**
+     * 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 programme ids.
+     */
+    programmeIds?: Array<string>;
     /**
      * Gets or sets the page number for paged queries.
      */
@@ -1197,6 +1243,8 @@ export class VenuesService {
         IncludeOpportunityOffers: includeOpportunityOffers,
         IncludeNextOpportunity: includeNextOpportunity,
         Distance: distance,
+        DashboardRequest: dashboardRequest,
+        ProgrammeIds: programmeIds,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,