reach-api-sdk 1.0.191 → 1.0.193

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
@@ -417,12 +471,14 @@ export class SessionsService {
     paymentPolicyId,
     futureOnly,
     online,
+    featured,
     programmeId,
     includeNextOpportunity,
     allowTemplating,
     archived,
     deleted,
     openActiveUpdate,
+    dashboardRequest,
     networkId,
     distance,
     minAgeLte,
@@ -479,6 +535,10 @@ export class SessionsService {
      * 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.
      */
@@ -503,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.
      */
@@ -623,12 +687,14 @@ export class SessionsService {
         PaymentPolicyId: paymentPolicyId,
         FutureOnly: futureOnly,
         Online: online,
+        Featured: featured,
         ProgrammeId: programmeId,
         IncludeNextOpportunity: includeNextOpportunity,
         AllowTemplating: allowTemplating,
         Archived: archived,
         Deleted: deleted,
         OpenActiveUpdate: openActiveUpdate,
+        DashboardRequest: dashboardRequest,
         NetworkId: networkId,
         Distance: distance,
         MinAgeLTE: minAgeLte,
@@ -759,12 +825,14 @@ export class SessionsService {
     paymentPolicyId,
     futureOnly,
     online,
+    featured,
     programmeId,
     includeNextOpportunity,
     allowTemplating,
     archived,
     deleted,
     openActiveUpdate,
+    dashboardRequest,
     networkId,
     distance,
     minAgeLte,
@@ -821,6 +889,10 @@ export class SessionsService {
      * 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.
      */
@@ -845,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.
      */
@@ -965,12 +1041,14 @@ export class SessionsService {
         PaymentPolicyId: paymentPolicyId,
         FutureOnly: futureOnly,
         Online: online,
+        Featured: featured,
         ProgrammeId: programmeId,
         IncludeNextOpportunity: includeNextOpportunity,
         AllowTemplating: allowTemplating,
         Archived: archived,
         Deleted: deleted,
         OpenActiveUpdate: openActiveUpdate,
+        DashboardRequest: dashboardRequest,
         NetworkId: networkId,
         Distance: distance,
         MinAgeLTE: minAgeLte,
@@ -1020,12 +1098,14 @@ export class SessionsService {
     paymentPolicyId,
     futureOnly,
     online,
+    featured,
     programmeId,
     includeNextOpportunity,
     allowTemplating,
     archived,
     deleted,
     openActiveUpdate,
+    dashboardRequest,
     networkId,
     distance,
     minAgeLte,
@@ -1082,6 +1162,10 @@ export class SessionsService {
      * 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.
      */
@@ -1106,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.
      */
@@ -1226,12 +1314,14 @@ export class SessionsService {
         PaymentPolicyId: paymentPolicyId,
         FutureOnly: futureOnly,
         Online: online,
+        Featured: featured,
         ProgrammeId: programmeId,
         IncludeNextOpportunity: includeNextOpportunity,
         AllowTemplating: allowTemplating,
         Archived: archived,
         Deleted: deleted,
         OpenActiveUpdate: openActiveUpdate,
+        DashboardRequest: dashboardRequest,
         NetworkId: networkId,
         Distance: distance,
         MinAgeLTE: minAgeLte,
@@ -1281,12 +1371,14 @@ export class SessionsService {
     paymentPolicyId,
     futureOnly,
     online,
+    featured,
     programmeId,
     includeNextOpportunity,
     allowTemplating,
     archived,
     deleted,
     openActiveUpdate,
+    dashboardRequest,
     networkId,
     distance,
     minAgeLte,
@@ -1343,6 +1435,10 @@ export class SessionsService {
      * 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.
      */
@@ -1367,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.
      */
@@ -1487,12 +1587,14 @@ export class SessionsService {
         PaymentPolicyId: paymentPolicyId,
         FutureOnly: futureOnly,
         Online: online,
+        Featured: featured,
         ProgrammeId: programmeId,
         IncludeNextOpportunity: includeNextOpportunity,
         AllowTemplating: allowTemplating,
         Archived: archived,
         Deleted: deleted,
         OpenActiveUpdate: openActiveUpdate,
+        DashboardRequest: dashboardRequest,
         NetworkId: networkId,
         Distance: distance,
         MinAgeLTE: minAgeLte,

package/src/services/VenuesService.ts

@@ -380,6 +380,7 @@ export class VenuesService {
     includeOpportunityOffers,
     includeNextOpportunity,
     distance,
+    dashboardRequest,
     pageNumber,
     take,
     skip,
@@ -464,6 +465,10 @@ 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 page number for paged queries.
      */
@@ -531,6 +536,7 @@ export class VenuesService {
         IncludeOpportunityOffers: includeOpportunityOffers,
         IncludeNextOpportunity: includeNextOpportunity,
         Distance: distance,
+        DashboardRequest: dashboardRequest,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -656,6 +662,7 @@ export class VenuesService {
     includeOpportunityOffers,
     includeNextOpportunity,
     distance,
+    dashboardRequest,
     pageNumber,
     take,
     skip,
@@ -740,6 +747,10 @@ 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 page number for paged queries.
      */
@@ -807,6 +818,7 @@ export class VenuesService {
         IncludeOpportunityOffers: includeOpportunityOffers,
         IncludeNextOpportunity: includeNextOpportunity,
         Distance: distance,
+        DashboardRequest: dashboardRequest,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -851,6 +863,7 @@ export class VenuesService {
     includeOpportunityOffers,
     includeNextOpportunity,
     distance,
+    dashboardRequest,
     pageNumber,
     take,
     skip,
@@ -935,6 +948,10 @@ 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 page number for paged queries.
      */
@@ -1002,6 +1019,7 @@ export class VenuesService {
         IncludeOpportunityOffers: includeOpportunityOffers,
         IncludeNextOpportunity: includeNextOpportunity,
         Distance: distance,
+        DashboardRequest: dashboardRequest,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,
@@ -1046,6 +1064,7 @@ export class VenuesService {
     includeOpportunityOffers,
     includeNextOpportunity,
     distance,
+    dashboardRequest,
     pageNumber,
     take,
     skip,
@@ -1130,6 +1149,10 @@ 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 page number for paged queries.
      */
@@ -1197,6 +1220,7 @@ export class VenuesService {
         IncludeOpportunityOffers: includeOpportunityOffers,
         IncludeNextOpportunity: includeNextOpportunity,
         Distance: distance,
+        DashboardRequest: dashboardRequest,
         PageNumber: pageNumber,
         Take: take,
         Skip: skip,