reach-api-sdk 1.0.200 → 1.0.202

package/src/definition/swagger.yaml

@@ -38551,6 +38551,14 @@ paths:
       summary: Gets a list of resources.
       operationId: GetPage
       parameters:
+        - name: Ids
+          in: query
+          description: Gets or sets the queryable ids.
+          schema:
+            type: array
+            items:
+              type: string
+              format: uuid
         - name: FacilityId
           in: query
           description: Gets or sets the queryable facility id.
@@ -38937,6 +38945,14 @@ paths:
       summary: Returns a value indicating whether the resource exists in the database given the provided search params.
       operationId: Exists
       parameters:
+        - name: Ids
+          in: query
+          description: Gets or sets the queryable ids.
+          schema:
+            type: array
+            items:
+              type: string
+              format: uuid
         - name: FacilityId
           in: query
           description: Gets or sets the queryable facility id.
@@ -39145,6 +39161,14 @@ paths:
       summary: Returns the number of results in the database given the provided search params.
       operationId: Count
       parameters:
+        - name: Ids
+          in: query
+          description: Gets or sets the queryable ids.
+          schema:
+            type: array
+            items:
+              type: string
+              format: uuid
         - name: FacilityId
           in: query
           description: Gets or sets the queryable facility id.
@@ -39356,6 +39380,14 @@ paths:
       summary: Gets a list of resources unpaged and without references.
       operationId: GetListWithoutReferences
       parameters:
+        - name: Ids
+          in: query
+          description: Gets or sets the queryable ids.
+          schema:
+            type: array
+            items:
+              type: string
+              format: uuid
         - name: FacilityId
           in: query
           description: Gets or sets the queryable facility id.
@@ -39570,6 +39602,14 @@ paths:
       summary: Gets a list of resources.
       operationId: GetListIdName
       parameters:
+        - name: Ids
+          in: query
+          description: Gets or sets the queryable ids.
+          schema:
+            type: array
+            items:
+              type: string
+              format: uuid
         - name: FacilityId
           in: query
           description: Gets or sets the queryable facility id.
@@ -44015,6 +44055,162 @@ paths:
             text/json:
               schema:
                 $ref: '#/components/schemas/ValidationResultModel'
+  /api/order-items-report/summary:
+    get:
+      tags:
+        - OrderItemReport
+      summary: Get summary for order items.
+      operationId: GetSummary
+      parameters:
+        - name: VenueId
+          in: query
+          description: Gets or sets the Venue Id.
+          schema:
+            type: string
+            format: uuid
+        - name: UserId
+          in: query
+          description: Gets or sets the User Id.
+          schema:
+            type: string
+            format: uuid
+        - name: ProgrammeId
+          in: query
+          description: Gets or sets the Programme Id.
+          schema:
+            type: string
+            format: uuid
+        - name: StartDateGTE
+          in: query
+          description: Gets or sets the starting date greater than or equal to.
+          schema:
+            type: string
+            format: date-time
+        - name: StartDateLTE
+          in: query
+          description: Gets or sets the starting date less than or equal to.
+          schema:
+            type: string
+            format: date-time
+        - name: DateRange
+          in: query
+          description: Gets or sets a custom date range.
+          schema:
+            $ref: '#/components/schemas/CustomDateRange'
+        - name: PageNumber
+          in: query
+          description: Gets or sets the page number for paged queries.
+          schema:
+            type: integer
+            format: int32
+        - name: Take
+          in: query
+          description: 'Gets or sets the result count limit, always applicable Paged queries, only applicable to List queries if LimitListRequests is set to true.'
+          schema:
+            type: integer
+            format: int32
+        - name: Skip
+          in: query
+          description: 'Gets or sets how much items to skip from begining of db table, when this is set page is always 1.'
+          schema:
+            type: integer
+            format: int32
+        - name: LimitListRequests
+          in: query
+          description: Gets or sets a value indicating whether to apply a limit to the number of results returned in a GetList request.
+          schema:
+            type: boolean
+        - name: TenantId
+          in: query
+          description: Gets or sets the Tenant Id.
+          schema:
+            type: string
+            format: uuid
+        - name: ModifiedById
+          in: query
+          description: Gets or sets the Modifed By Id.
+          schema:
+            type: string
+            format: uuid
+        - name: ModifiedByIds
+          in: query
+          description: Gets or sets the Modifed By Ids.
+          schema:
+            type: array
+            items:
+              type: string
+              format: uuid
+        - name: DateCreatedGTE
+          in: query
+          description: Gets or sets the Date Created greater than equal to.
+          schema:
+            type: string
+            format: date-time
+        - name: DateCreatedLTE
+          in: query
+          description: Gets or sets the Date Created less than equal to.
+          schema:
+            type: string
+            format: date-time
+        - name: IsLive
+          in: query
+          description: Gets or sets the queryable only is live status.
+          schema:
+            type: boolean
+        - name: SortOrderDirection
+          in: query
+          description: Gets or sets the sort order direction.
+          schema:
+            $ref: '#/components/schemas/SearchSortOrderDirection'
+      responses:
+        '200':
+          description: OK
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/OrderItemReportSummary'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/OrderItemReportSummary'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/OrderItemReportSummary'
+        '400':
+          description: Bad Request
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+        '500':
+          description: Internal Server Error
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+        '422':
+          description: Unprocessable Content
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
   /api/order-items-report/v2-temporary-route:
     post:
       tags:
@@ -45772,6 +45968,12 @@ paths:
           schema:
             type: string
             format: uuid
+        - name: OfferId
+          in: query
+          description: Gets or sets the queryable offer id.
+          schema:
+            type: string
+            format: uuid
         - name: Status
           in: query
           description: Gets or sets the queryable order item status id.
@@ -46137,6 +46339,12 @@ paths:
           schema:
             type: string
             format: uuid
+        - name: OfferId
+          in: query
+          description: Gets or sets the queryable offer id.
+          schema:
+            type: string
+            format: uuid
         - name: Status
           in: query
           description: Gets or sets the queryable order item status id.
@@ -46324,6 +46532,12 @@ paths:
           schema:
             type: string
             format: uuid
+        - name: OfferId
+          in: query
+          description: Gets or sets the queryable offer id.
+          schema:
+            type: string
+            format: uuid
         - name: Status
           in: query
           description: Gets or sets the queryable order item status id.
@@ -46514,6 +46728,12 @@ paths:
           schema:
             type: string
             format: uuid
+        - name: OfferId
+          in: query
+          description: Gets or sets the queryable offer id.
+          schema:
+            type: string
+            format: uuid
         - name: Status
           in: query
           description: Gets or sets the queryable order item status id.
@@ -46707,6 +46927,12 @@ paths:
           schema:
             type: string
             format: uuid
+        - name: OfferId
+          in: query
+          description: Gets or sets the queryable offer id.
+          schema:
+            type: string
+            format: uuid
         - name: Status
           in: query
           description: Gets or sets the queryable order item status id.
@@ -54601,6 +54827,91 @@ paths:
             text/json:
               schema:
                 $ref: '#/components/schemas/ValidationResultModel'
+  /api/external/places/static-map:
+    get:
+      tags:
+        - Places
+      summary: GetPrediction.
+      operationId: GetStaticMap
+      parameters:
+        - name: lat
+          in: query
+          description: lat.
+          schema:
+            type: number
+            format: float
+        - name: lng
+          in: query
+          description: lng.
+          schema:
+            type: number
+            format: float
+        - name: zoom
+          in: query
+          description: zoom.
+          schema:
+            type: integer
+            format: int32
+            default: 14
+        - name: width
+          in: query
+          description: width.
+          schema:
+            type: integer
+            format: int32
+            default: 400
+        - name: height
+          in: query
+          description: height.
+          schema:
+            type: integer
+            format: int32
+            default: 287
+        - name: type
+          in: query
+          description: type.
+          schema:
+            type: string
+            default: roadmap
+      responses:
+        '200':
+          description: OK
+        '400':
+          description: Bad Request
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+        '500':
+          description: Internal Server Error
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ReachError'
+        '422':
+          description: Unprocessable Content
+          content:
+            text/plain:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
+            text/json:
+              schema:
+                $ref: '#/components/schemas/ValidationResultModel'
   /api/platform-payouts/send-batch:
     get:
       tags:
@@ -67003,6 +67314,12 @@ paths:
           schema:
             type: string
             format: uuid
+        - name: OfferId
+          in: query
+          description: Gets or sets the queryable offer id.
+          schema:
+            type: string
+            format: uuid
         - name: Status
           in: query
           description: Gets or sets the queryable order item status id.
@@ -67686,6 +68003,12 @@ paths:
           schema:
             type: string
             format: uuid
+        - name: OfferId
+          in: query
+          description: Gets or sets the queryable offer id.
+          schema:
+            type: string
+            format: uuid
         - name: Status
           in: query
           description: Gets or sets the queryable order item status id.
@@ -135937,6 +136260,25 @@ components:
           type: number
           description: Gets or sets the offer total/gross price.
           format: double
+        maxAvailablePerOpportunity:
+          type: integer
+          description: Gets or sets the maximum number of this offer that can be sold per opportunity.
+          format: int32
+          nullable: true
+        availableFrom:
+          type: string
+          description: Gets or sets when this offer becomes available for booking.
+          format: date-time
+          nullable: true
+        availableUntil:
+          type: string
+          description: Gets or sets when this offer stops being available for booking.
+          format: date-time
+          nullable: true
+        description:
+          type: string
+          description: Gets or sets the offer description.
+          nullable: true
       additionalProperties: false
       description: Post model for session offers.
     CreateQuestion:
@@ -138023,6 +138365,18 @@ components:
           type: string
           description: Gets or sets the description.
           nullable: true
+        scheduleDescription:
+          type: string
+          description: Gets or sets a description of the schedule.
+          nullable: true
+        scheduleSummary:
+          type: string
+          description: Gets or sets a summary of the schedule.
+          nullable: true
+        hasScheduleSummary:
+          type: boolean
+          description: Gets or sets a value indicating whether the session has a schedule summary.
+          nullable: true
         imageUrl:
           type: string
           description: Gets or sets the image url.
@@ -139351,6 +139705,35 @@ components:
         active:
           type: boolean
           description: Gets or sets a value indicating whether the offer is private (available to relevant authenticated users and NOT visible to the public).
+        maxAvailablePerOpportunity:
+          type: integer
+          description: Gets or sets the maximum number of this offer that can be sold per opportunity.
+          format: int32
+          nullable: true
+        availableFrom:
+          type: string
+          description: Gets or sets when this offer becomes available for booking.
+          format: date-time
+          nullable: true
+        availableUntil:
+          type: string
+          description: Gets or sets when this offer stops being available for booking.
+          format: date-time
+          nullable: true
+        description:
+          type: string
+          description: Gets or sets the offer description.
+          nullable: true
+        isAvailable:
+          type: boolean
+          description: Gets a value indicating whether the offer is currently available based on AvailableFrom and AvailableUntil dates.
+          default: false
+          readOnly: true
+        totalAvailable:
+          type: integer
+          description: "Gets or sets the total number of spots available for this offer based on MaxAvailablePerOpportunity and existing bookings.\r\nThis property is calculated by the processors when loading offers."
+          format: int32
+          default: 0
         label:
           type: string
           description: Gets or sets the offers label.
@@ -139468,6 +139851,25 @@ components:
           type: boolean
           description: Gets or sets a value indicating whether the offer is private (available to relevant authenticated users and NOT visible to the public).
           nullable: true
+        maxAvailablePerOpportunity:
+          type: integer
+          description: Gets or sets the maximum number of this offer that can be sold per opportunity.
+          format: int32
+          nullable: true
+        availableFrom:
+          type: string
+          description: Gets or sets when this offer becomes available for booking.
+          format: date-time
+          nullable: true
+        availableUntil:
+          type: string
+          description: Gets or sets when this offer stops being available for booking.
+          format: date-time
+          nullable: true
+        description:
+          type: string
+          description: Gets or sets the offer description.
+          nullable: true
       additionalProperties: false
       description: Post model for offer inserts.
     OpenactiveFeedIntermediate:
@@ -140321,6 +140723,21 @@ components:
           type: boolean
           description: Gets or sets a value indicating whether the order item is rescheduleable.
           nullable: true
+        unitPriceBeforeDiscount:
+          type: number
+          description: Gets or sets the unit price before discount.
+          format: double
+          nullable: true
+        unitPriceAfterDiscount:
+          type: number
+          description: Gets or sets the unit price after discount.
+          format: double
+          nullable: true
+        effectiveItemPrice:
+          type: number
+          description: Gets or sets the effective item price.
+          format: double
+          nullable: true
       additionalProperties: false
       description: Represents an Order of a currently available bookable Reach.Models.OrderItem.Slot within the Reach application.
     OrderItemDeal:
@@ -140572,6 +140989,45 @@ components:
           format: uuid
       additionalProperties: false
       description: Post model for order item report inserts.
+    OrderItemReportSummary:
+      required:
+        - dateCreated
+        - dateModified
+        - isLive
+        - tenantId
+      type: object
+      properties:
+        id:
+          type: string
+          description: Gets or sets the entities Id.
+          format: uuid
+        tenantId:
+          type: string
+          description: Gets or sets the tenant Id.
+          format: uuid
+        dateCreated:
+          type: string
+          description: Gets or sets the created date of this entity.
+          format: date-time
+        dateModified:
+          type: string
+          description: Gets or sets the last modified date of this entity.
+          format: date-time
+        modifiedById:
+          type: string
+          description: Gets or sets the modified by Id.
+          format: uuid
+          nullable: true
+        isLive:
+          type: boolean
+          description: Gets or sets a value indicating whether the record is live and available for use within the application.
+          default: false
+        revenueGenerated:
+          type: number
+          description: Gets or sets the total revenue generated from order items.
+          format: double
+      additionalProperties: false
+      description: Represents the order item report summary model.
     OrderItemStatus:
       enum:
         - SellerCancelled
@@ -143774,6 +144230,18 @@ components:
           $ref: '#/components/schemas/ActivityType'
         sessionType:
           $ref: '#/components/schemas/SessionType'
+        scheduleDescription:
+          type: string
+          description: Gets or sets a description of the schedule.
+          nullable: true
+        scheduleSummary:
+          type: string
+          description: Gets or sets a summary of the schedule.
+          nullable: true
+        hasScheduleSummary:
+          type: boolean
+          description: Gets or sets a value indicating whether the session has a schedule summary.
+          nullable: true
         openactiveActivityId:
           type: string
           description: Gets or sets the openactive activity Id.
@@ -147884,6 +148352,25 @@ components:
           type: number
           description: Gets or sets the offer total/gross price.
           format: double
+        maxAvailablePerOpportunity:
+          type: integer
+          description: Gets or sets the maximum number of this offer that can be sold per opportunity.
+          format: int32
+          nullable: true
+        availableFrom:
+          type: string
+          description: Gets or sets when this offer becomes available for booking.
+          format: date-time
+          nullable: true
+        availableUntil:
+          type: string
+          description: Gets or sets when this offer stops being available for booking.
+          format: date-time
+          nullable: true
+        description:
+          type: string
+          description: Gets or sets the offer description.
+          nullable: true
       additionalProperties: false
       description: Patch model for session offers.
     User:

package/src/index.ts

@@ -187,6 +187,7 @@ export type { OrderItemReport } from './models/OrderItemReport';
 export type { OrderItemReportPage } from './models/OrderItemReportPage';
 export type { OrderItemReportPatch } from './models/OrderItemReportPatch';
 export type { OrderItemReportPost } from './models/OrderItemReportPost';
+export type { OrderItemReportSummary } from './models/OrderItemReportSummary';
 export { OrderItemStatus } from './models/OrderItemStatus';
 export type { OrderPage } from './models/OrderPage';
 export type { OrderPatch } from './models/OrderPatch';

package/src/models/CreateOffer.ts

@@ -15,4 +15,20 @@ export type CreateOffer = {
    * 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/models/GenericActivity.ts

@@ -68,6 +68,18 @@ export type GenericActivity = {
    * Gets or sets the description.
    */
   description?: string | null;
+  /**
+   * 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 image url.
    */