reach-api-sdk 1.0.200 → 1.0.202

package/src/models/Offer.ts

@@ -91,6 +91,31 @@ export type Offer = {
    * Gets or sets a value indicating whether the offer is private (available to relevant authenticated users and NOT visible to the public).
    */
   active: boolean;
+  /**
+   * Gets or sets the maximum number of this offer that can be sold per opportunity.
+   */
+  maxAvailablePerOpportunity?: number | null;
+  /**
+   * Gets or sets when this offer becomes available for booking.
+   */
+  availableFrom?: string | null;
+  /**
+   * Gets or sets when this offer stops being available for booking.
+   */
+  availableUntil?: string | null;
+  /**
+   * Gets or sets the offer description.
+   */
+  description?: string | null;
+  /**
+   * Gets a value indicating whether the offer is currently available based on AvailableFrom and AvailableUntil dates.
+   */
+  readonly isAvailable?: boolean;
+  /**
+   * Gets or sets the total number of spots available for this offer based on MaxAvailablePerOpportunity and existing bookings.
+   * This property is calculated by the processors when loading offers.
+   */
+  totalAvailable?: number;
   /**
    * Gets or sets the offers label.
    */

package/src/models/OfferPost.ts

@@ -39,4 +39,20 @@ export type OfferPost = {
    * Gets or sets a value indicating whether the offer is private (available to relevant authenticated users and NOT visible to the public).
    */
   active?: boolean | null;
+  /**
+   * Gets or sets the maximum number of this offer that can be sold per opportunity.
+   */
+  maxAvailablePerOpportunity?: number | null;
+  /**
+   * Gets or sets when this offer becomes available for booking.
+   */
+  availableFrom?: string | null;
+  /**
+   * Gets or sets when this offer stops being available for booking.
+   */
+  availableUntil?: string | null;
+  /**
+   * Gets or sets the offer description.
+   */
+  description?: string | null;
 };

package/src/models/OrderItem.ts

@@ -123,4 +123,16 @@ export type OrderItem = {
    * Gets or sets a value indicating whether the order item is rescheduleable.
    */
   rescheduleable?: boolean | null;
+  /**
+   * Gets or sets the unit price before discount.
+   */
+  unitPriceBeforeDiscount?: number | null;
+  /**
+   * Gets or sets the unit price after discount.
+   */
+  unitPriceAfterDiscount?: number | null;
+  /**
+   * Gets or sets the effective item price.
+   */
+  effectiveItemPrice?: number | null;
 };

package/src/models/OrderItemReportSummary.ts

@@ -0,0 +1,38 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Represents the order item report summary model.
+ */
+export type OrderItemReportSummary = {
+  /**
+   * Gets or sets the entities Id.
+   */
+  id?: string;
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets the created date of this entity.
+   */
+  dateCreated: string;
+  /**
+   * Gets or sets the last modified date of this entity.
+   */
+  dateModified: string;
+  /**
+   * Gets or sets the modified by Id.
+   */
+  modifiedById?: string | null;
+  /**
+   * Gets or sets a value indicating whether the record is live and available for use within the application.
+   */
+  isLive: boolean;
+  /**
+   * Gets or sets the total revenue generated from order items.
+   */
+  revenueGenerated?: number;
+};

package/src/models/Session.ts

@@ -203,6 +203,18 @@ export type Session = {
   deals?: Array<Deal> | null;
   activityType?: ActivityType;
   sessionType?: SessionType;
+  /**
+   * Gets or sets a description of the schedule.
+   */
+  scheduleDescription?: string | null;
+  /**
+   * Gets or sets a summary of the schedule.
+   */
+  scheduleSummary?: string | null;
+  /**
+   * Gets or sets a value indicating whether the session has a schedule summary.
+   */
+  hasScheduleSummary?: boolean | null;
   /**
    * Gets or sets the openactive activity Id.
    */

package/src/models/UpdateOffer.ts

@@ -19,4 +19,20 @@ export type UpdateOffer = {
    * Gets or sets the offer total/gross price.
    */
   priceTotal: number;
+  /**
+   * Gets or sets the maximum number of this offer that can be sold per opportunity.
+   */
+  maxAvailablePerOpportunity?: number | null;
+  /**
+   * Gets or sets when this offer becomes available for booking.
+   */
+  availableFrom?: string | null;
+  /**
+   * Gets or sets when this offer stops being available for booking.
+   */
+  availableUntil?: string | null;
+  /**
+   * Gets or sets the offer description.
+   */
+  description?: string | null;
 };

package/src/services/OffersService.ts

@@ -150,6 +150,7 @@ export class OffersService {
    * @throws ApiError
    */
   public getPage({
+    ids,
     facilityId,
     facilityIds,
     facilityIndividualId,
@@ -175,6 +176,10 @@ export class OffersService {
     isLive,
     sortOrderDirection,
   }: {
+    /**
+     * Gets or sets the queryable ids.
+     */
+    ids?: Array<string>;
     /**
      * Gets or sets the queryable facility id.
      */
@@ -276,6 +281,7 @@ export class OffersService {
       method: 'GET',
       url: '/api/offers',
       query: {
+        Ids: ids,
         FacilityId: facilityId,
         FacilityIds: facilityIds,
         FacilityIndividualId: facilityIndividualId,
@@ -396,6 +402,7 @@ export class OffersService {
    * @throws ApiError
    */
   public exists({
+    ids,
     facilityId,
     facilityIds,
     facilityIndividualId,
@@ -421,6 +428,10 @@ export class OffersService {
     isLive,
     sortOrderDirection,
   }: {
+    /**
+     * Gets or sets the queryable ids.
+     */
+    ids?: Array<string>;
     /**
      * Gets or sets the queryable facility id.
      */
@@ -522,6 +533,7 @@ export class OffersService {
       method: 'GET',
       url: '/api/offers/exists',
       query: {
+        Ids: ids,
         FacilityId: facilityId,
         FacilityIds: facilityIds,
         FacilityIndividualId: facilityIndividualId,
@@ -561,6 +573,7 @@ export class OffersService {
    * @throws ApiError
    */
   public count({
+    ids,
     facilityId,
     facilityIds,
     facilityIndividualId,
@@ -586,6 +599,10 @@ export class OffersService {
     isLive,
     sortOrderDirection,
   }: {
+    /**
+     * Gets or sets the queryable ids.
+     */
+    ids?: Array<string>;
     /**
      * Gets or sets the queryable facility id.
      */
@@ -687,6 +704,7 @@ export class OffersService {
       method: 'GET',
       url: '/api/offers/count',
       query: {
+        Ids: ids,
         FacilityId: facilityId,
         FacilityIds: facilityIds,
         FacilityIndividualId: facilityIndividualId,
@@ -726,6 +744,7 @@ export class OffersService {
    * @throws ApiError
    */
   public getListWithoutReferences({
+    ids,
     facilityId,
     facilityIds,
     facilityIndividualId,
@@ -751,6 +770,10 @@ export class OffersService {
     isLive,
     sortOrderDirection,
   }: {
+    /**
+     * Gets or sets the queryable ids.
+     */
+    ids?: Array<string>;
     /**
      * Gets or sets the queryable facility id.
      */
@@ -852,6 +875,7 @@ export class OffersService {
       method: 'GET',
       url: '/api/offers/without-references',
       query: {
+        Ids: ids,
         FacilityId: facilityId,
         FacilityIds: facilityIds,
         FacilityIndividualId: facilityIndividualId,
@@ -891,6 +915,7 @@ export class OffersService {
    * @throws ApiError
    */
   public getListIdName({
+    ids,
     facilityId,
     facilityIds,
     facilityIndividualId,
@@ -916,6 +941,10 @@ export class OffersService {
     isLive,
     sortOrderDirection,
   }: {
+    /**
+     * Gets or sets the queryable ids.
+     */
+    ids?: Array<string>;
     /**
      * Gets or sets the queryable facility id.
      */
@@ -1017,6 +1046,7 @@ export class OffersService {
       method: 'GET',
       url: '/api/offers/id-name',
       query: {
+        Ids: ids,
         FacilityId: facilityId,
         FacilityIds: facilityIds,
         FacilityIndividualId: facilityIndividualId,

package/src/services/OrderItemReportService.ts

@@ -7,6 +7,7 @@ import type { OrderItemReport } from '../models/OrderItemReport';
 import type { OrderItemReportPage } from '../models/OrderItemReportPage';
 import type { OrderItemReportPatch } from '../models/OrderItemReportPatch';
 import type { OrderItemReportPost } from '../models/OrderItemReportPost';
+import type { OrderItemReportSummary } from '../models/OrderItemReportSummary';
 import type { SearchSortOrderDirection } from '../models/SearchSortOrderDirection';
 
 import type { CancelablePromise } from '../core/CancelablePromise';
@@ -148,6 +149,129 @@ export class OrderItemReportService {
     });
   }
 
+  /**
+   * Get summary for order items.
+   * @returns OrderItemReportSummary OK
+   * @throws ApiError
+   */
+  public getSummary({
+    venueId,
+    userId,
+    programmeId,
+    startDateGte,
+    startDateLte,
+    dateRange,
+    pageNumber,
+    take,
+    skip,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * Gets or sets the Venue Id.
+     */
+    venueId?: string;
+    /**
+     * Gets or sets the User Id.
+     */
+    userId?: string;
+    /**
+     * Gets or sets the Programme Id.
+     */
+    programmeId?: string;
+    /**
+     * Gets or sets the starting date greater than or equal to.
+     */
+    startDateGte?: string;
+    /**
+     * Gets or sets the starting date less than or equal to.
+     */
+    startDateLte?: string;
+    /**
+     * Gets or sets a custom date range.
+     */
+    dateRange?: CustomDateRange;
+    /**
+     * 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<OrderItemReportSummary> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/order-items-report/summary',
+      query: {
+        VenueId: venueId,
+        UserId: userId,
+        ProgrammeId: programmeId,
+        StartDateGTE: startDateGte,
+        StartDateLTE: startDateLte,
+        DateRange: dateRange,
+        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`,
+      },
+    });
+  }
+
   /**
    * Inserts a new resource. The Id will be automatically generated and will be ignored if provided.
    * @returns OrderItemReport OK

package/src/services/OrderItemsService.ts

@@ -198,6 +198,7 @@ export class OrderItemsService {
     scheduledSessionId,
     slotId,
     courseId,
+    offerId,
     status,
     statuses,
     parentOrderItemId,
@@ -236,6 +237,10 @@ export class OrderItemsService {
      * Gets or sets the queryable course id.
      */
     courseId?: string;
+    /**
+     * Gets or sets the queryable offer id.
+     */
+    offerId?: string;
     /**
      * Gets or sets the queryable order item status id.
      */
@@ -314,6 +319,7 @@ export class OrderItemsService {
         ScheduledSessionId: scheduledSessionId,
         SlotId: slotId,
         CourseId: courseId,
+        OfferId: offerId,
         Status: status,
         Statuses: statuses,
         ParentOrderItemId: parentOrderItemId,
@@ -432,6 +438,7 @@ export class OrderItemsService {
     scheduledSessionId,
     slotId,
     courseId,
+    offerId,
     status,
     statuses,
     parentOrderItemId,
@@ -470,6 +477,10 @@ export class OrderItemsService {
      * Gets or sets the queryable course id.
      */
     courseId?: string;
+    /**
+     * Gets or sets the queryable offer id.
+     */
+    offerId?: string;
     /**
      * Gets or sets the queryable order item status id.
      */
@@ -548,6 +559,7 @@ export class OrderItemsService {
         ScheduledSessionId: scheduledSessionId,
         SlotId: slotId,
         CourseId: courseId,
+        OfferId: offerId,
         Status: status,
         Statuses: statuses,
         ParentOrderItemId: parentOrderItemId,
@@ -585,6 +597,7 @@ export class OrderItemsService {
     scheduledSessionId,
     slotId,
     courseId,
+    offerId,
     status,
     statuses,
     parentOrderItemId,
@@ -623,6 +636,10 @@ export class OrderItemsService {
      * Gets or sets the queryable course id.
      */
     courseId?: string;
+    /**
+     * Gets or sets the queryable offer id.
+     */
+    offerId?: string;
     /**
      * Gets or sets the queryable order item status id.
      */
@@ -701,6 +718,7 @@ export class OrderItemsService {
         ScheduledSessionId: scheduledSessionId,
         SlotId: slotId,
         CourseId: courseId,
+        OfferId: offerId,
         Status: status,
         Statuses: statuses,
         ParentOrderItemId: parentOrderItemId,
@@ -738,6 +756,7 @@ export class OrderItemsService {
     scheduledSessionId,
     slotId,
     courseId,
+    offerId,
     status,
     statuses,
     parentOrderItemId,
@@ -776,6 +795,10 @@ export class OrderItemsService {
      * Gets or sets the queryable course id.
      */
     courseId?: string;
+    /**
+     * Gets or sets the queryable offer id.
+     */
+    offerId?: string;
     /**
      * Gets or sets the queryable order item status id.
      */
@@ -854,6 +877,7 @@ export class OrderItemsService {
         ScheduledSessionId: scheduledSessionId,
         SlotId: slotId,
         CourseId: courseId,
+        OfferId: offerId,
         Status: status,
         Statuses: statuses,
         ParentOrderItemId: parentOrderItemId,
@@ -891,6 +915,7 @@ export class OrderItemsService {
     scheduledSessionId,
     slotId,
     courseId,
+    offerId,
     status,
     statuses,
     parentOrderItemId,
@@ -929,6 +954,10 @@ export class OrderItemsService {
      * Gets or sets the queryable course id.
      */
     courseId?: string;
+    /**
+     * Gets or sets the queryable offer id.
+     */
+    offerId?: string;
     /**
      * Gets or sets the queryable order item status id.
      */
@@ -1007,6 +1036,7 @@ export class OrderItemsService {
         ScheduledSessionId: scheduledSessionId,
         SlotId: slotId,
         CourseId: courseId,
+        OfferId: offerId,
         Status: status,
         Statuses: statuses,
         ParentOrderItemId: parentOrderItemId,

package/src/services/PlacesService.ts

@@ -70,4 +70,61 @@ export class PlacesService {
       },
     });
   }
+
+  /**
+   * GetPrediction.
+   * @returns any OK
+   * @throws ApiError
+   */
+  public getStaticMap({
+    lat,
+    lng,
+    zoom = 14,
+    width = 400,
+    height = 287,
+    type = 'roadmap',
+  }: {
+    /**
+     * lat.
+     */
+    lat?: number;
+    /**
+     * lng.
+     */
+    lng?: number;
+    /**
+     * zoom.
+     */
+    zoom?: number;
+    /**
+     * width.
+     */
+    width?: number;
+    /**
+     * height.
+     */
+    height?: number;
+    /**
+     * type.
+     */
+    type?: string;
+  }): CancelablePromise<any> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/external/places/static-map',
+      query: {
+        lat: lat,
+        lng: lng,
+        zoom: zoom,
+        width: width,
+        height: height,
+        type: type,
+      },
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
 }

package/src/services/PublicOrderItemsService.ts

@@ -27,6 +27,7 @@ export class PublicOrderItemsService {
     scheduledSessionId,
     slotId,
     courseId,
+    offerId,
     status,
     statuses,
     parentOrderItemId,
@@ -66,6 +67,10 @@ export class PublicOrderItemsService {
      * Gets or sets the queryable course id.
      */
     courseId?: string;
+    /**
+     * Gets or sets the queryable offer id.
+     */
+    offerId?: string;
     /**
      * Gets or sets the queryable order item status id.
      */
@@ -147,6 +152,7 @@ export class PublicOrderItemsService {
         ScheduledSessionId: scheduledSessionId,
         SlotId: slotId,
         CourseId: courseId,
+        OfferId: offerId,
         Status: status,
         Statuses: statuses,
         ParentOrderItemId: parentOrderItemId,
@@ -432,6 +438,7 @@ export class PublicOrderItemsService {
     scheduledSessionId,
     slotId,
     courseId,
+    offerId,
     status,
     statuses,
     parentOrderItemId,
@@ -474,6 +481,10 @@ export class PublicOrderItemsService {
      * Gets or sets the queryable course id.
      */
     courseId?: string;
+    /**
+     * Gets or sets the queryable offer id.
+     */
+    offerId?: string;
     /**
      * Gets or sets the queryable order item status id.
      */
@@ -555,6 +566,7 @@ export class PublicOrderItemsService {
         ScheduledSessionId: scheduledSessionId,
         SlotId: slotId,
         CourseId: courseId,
+        OfferId: offerId,
         Status: status,
         Statuses: statuses,
         ParentOrderItemId: parentOrderItemId,