reach-api-sdk 1.0.0

package/src/services/PublicSessionsService.ts

@@ -0,0 +1,697 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { BookingStatus } from '../models/BookingStatus';
+import type { ScheduledSessionSearchSortBy } from '../models/ScheduledSessionSearchSortBy';
+import type { SearchSortOrderDirection } from '../models/SearchSortOrderDirection';
+import type { Session } from '../models/Session';
+import type { SessionPage } from '../models/SessionPage';
+import type { SlotStatus } from '../models/SlotStatus';
+
+import type { CancelablePromise } from '../core/CancelablePromise';
+import type { BaseHttpRequest } from '../core/BaseHttpRequest';
+
+export class PublicSessionsService {
+  constructor(public readonly httpRequest: BaseHttpRequest) {}
+
+  /**
+   * @returns Session Success
+   * @throws ApiError
+   */
+  public getObject({
+    id,
+    xTenantSubdomain,
+  }: {
+    id: string;
+    xTenantSubdomain?: string;
+  }): CancelablePromise<Session> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/public/sessions/{id}',
+      path: {
+        id: id,
+      },
+      headers: {
+        x_tenant_subdomain: xTenantSubdomain,
+      },
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Deletes the resource.
+   * @returns any Success
+   * @throws ApiError
+   */
+  public deleteById({
+    id,
+    xTenantSubdomain,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> id.
+     */
+    id: string;
+    /**
+     * The tenants subdomain.
+     */
+    xTenantSubdomain?: string;
+  }): CancelablePromise<any> {
+    return this.httpRequest.request({
+      method: 'DELETE',
+      url: '/api/public/sessions/{id}',
+      path: {
+        id: id,
+      },
+      headers: {
+        x_tenant_subdomain: xTenantSubdomain,
+      },
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * @returns SessionPage Success
+   * @throws ApiError
+   */
+  public getPage({
+    xTenantSubdomain,
+    ids,
+    venueId,
+    futureOnly,
+    online,
+    programmeId,
+    includeNextOpportunity,
+    allowTemplating,
+    archived,
+    deleted,
+    pageNumber,
+    take,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    xTenantSubdomain?: string;
+    /**
+     * Gets or sets the queryable session ids.
+     */
+    ids?: Array<string>;
+    /**
+     * Gets or sets the queryable Venue Id.
+     */
+    venueId?: string;
+    /**
+     * Gets or sets a value indicating whether to only return sessions with future slots available.
+     */
+    futureOnly?: boolean;
+    /**
+     * Gets or sets a value indicating whether return online sessions.
+     */
+    online?: boolean;
+    /**
+     * Gets or sets the queryable Programme Id.
+     */
+    programmeId?: string;
+    /**
+     * Gets or sets a value indicating whether to inlcude the sessions next availability.
+     */
+    includeNextOpportunity?: boolean;
+    /**
+     * Gets or sets a value indicating whether to include templatable sessions.
+     */
+    allowTemplating?: boolean;
+    /**
+     * Gets or sets a value indicating whether to include archived sessions.
+     */
+    archived?: boolean;
+    /**
+     * Gets or sets a value indicating whether to include deleted sessions.
+     */
+    deleted?: boolean;
+    /**
+     * 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 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<SessionPage> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/public/sessions',
+      headers: {
+        x_tenant_subdomain: xTenantSubdomain,
+      },
+      query: {
+        Ids: ids,
+        VenueId: venueId,
+        FutureOnly: futureOnly,
+        Online: online,
+        ProgrammeId: programmeId,
+        IncludeNextOpportunity: includeNextOpportunity,
+        AllowTemplating: allowTemplating,
+        Archived: archived,
+        Deleted: deleted,
+        PageNumber: pageNumber,
+        Take: take,
+        LimitListRequests: limitListRequests,
+        TenantId: tenantId,
+        ModifiedById: modifiedById,
+        ModifiedByIds: modifiedByIds,
+        DateCreatedGTE: dateCreatedGte,
+        DateCreatedLTE: dateCreatedLte,
+        IsLive: isLive,
+        SortOrderDirection: sortOrderDirection,
+      },
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Inserts a new resource. The Id will be automatically generated and will be ignored if provided.
+   * @returns Session Success
+   * @throws ApiError
+   */
+  public post({
+    xTenantSubdomain,
+    requestBody,
+  }: {
+    /**
+     * The tenants subdomain.
+     */
+    xTenantSubdomain?: string;
+    /**
+     * The <typeparamref name="TObject" /> model.
+     */
+    requestBody?: Session;
+  }): CancelablePromise<Session> {
+    return this.httpRequest.request({
+      method: 'POST',
+      url: '/api/public/sessions',
+      headers: {
+        x_tenant_subdomain: xTenantSubdomain,
+      },
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Patches the resource.
+   * @returns Session Success
+   * @throws ApiError
+   */
+  public patch({
+    xTenantSubdomain,
+    requestBody,
+  }: {
+    /**
+     * The tenants subdomain.
+     */
+    xTenantSubdomain?: string;
+    /**
+     * The <typeparamref name="TObject" /> model.
+     */
+    requestBody?: Session;
+  }): CancelablePromise<Session> {
+    return this.httpRequest.request({
+      method: 'PATCH',
+      url: '/api/public/sessions',
+      headers: {
+        x_tenant_subdomain: xTenantSubdomain,
+      },
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Deletes the resource.
+   * @returns any Success
+   * @throws ApiError
+   */
+  public deleteByObject({
+    xTenantSubdomain,
+    requestBody,
+  }: {
+    /**
+     * The tenants subdomain.
+     */
+    xTenantSubdomain?: string;
+    /**
+     * The <typeparamref name="TObject" /> model.
+     */
+    requestBody?: Session;
+  }): CancelablePromise<any> {
+    return this.httpRequest.request({
+      method: 'DELETE',
+      url: '/api/public/sessions',
+      headers: {
+        x_tenant_subdomain: xTenantSubdomain,
+      },
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Returns distinct slot dates without time information.
+   * @returns any Success
+   * @throws ApiError
+   */
+  public getDistinctSlotDates({
+    xTenantSubdomain,
+    ids,
+    venueId,
+    sessionId,
+    sessionIds,
+    scheduleId,
+    status,
+    statuses,
+    bookingStatus,
+    startDateTimeLte,
+    startDateTimeGte,
+    endDateTimeLte,
+    endDateTimeGte,
+    remainingUsesLte,
+    remainingUsesGte,
+    futureOnly,
+    hasAvailability,
+    orderFirstNameContains,
+    orderLastNameContains,
+    sortBy,
+    postCompletionEmailSent,
+    pageNumber,
+    take,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * The tenants subdomain.
+     */
+    xTenantSubdomain?: string;
+    /**
+     * Gets or sets the queryable scheduled session ids.
+     */
+    ids?: Array<string>;
+    /**
+     * Gets or sets the queryable scheduled session venue Id.
+     */
+    venueId?: string;
+    /**
+     * Gets or sets the queryable scheduled session facility Id.
+     */
+    sessionId?: string;
+    /**
+     * Gets or sets the queryable scheduled session facility Ids.
+     */
+    sessionIds?: Array<string>;
+    /**
+     * Gets or sets the queryable scheduled session facility individual Id.
+     */
+    scheduleId?: string;
+    /**
+     * Gets or sets the queryable scheduled session active status.
+     */
+    status?: SlotStatus;
+    /**
+     * Gets or sets the queryable scheduled session active status.
+     */
+    statuses?: Array<SlotStatus>;
+    /**
+     * Gets or sets the queryable booking status.
+     */
+    bookingStatus?: BookingStatus;
+    /**
+     * Gets or sets the queryable scheduled session start date time is less than or equal to.
+     */
+    startDateTimeLte?: string;
+    /**
+     * Gets or sets the queryable scheduled session start date time is greater than or equal to.
+     */
+    startDateTimeGte?: string;
+    /**
+     * Gets or sets the queryable scheduled session end date time is less than or equal to.
+     */
+    endDateTimeLte?: string;
+    /**
+     * Gets or sets the queryable scheduled session end date time is greater than or equal to.
+     */
+    endDateTimeGte?: string;
+    /**
+     * Gets or sets the queryable slot remaining uses is less than or equal to.
+     */
+    remainingUsesLte?: number;
+    /**
+     * Gets or sets the queryable slot remaining uses is greater than or equal to.
+     */
+    remainingUsesGte?: number;
+    /**
+     * Gets or sets a value indicating whether to only return future scheduled session.
+     */
+    futureOnly?: boolean;
+    /**
+     * Gets or sets a value indicating whether the scheduled session has availability.
+     */
+    hasAvailability?: boolean;
+    /**
+     * Gets or sets a value indicating whether the scheduled session has an order where the orders first name contains the given value.
+     */
+    orderFirstNameContains?: string;
+    /**
+     * Gets or sets a value indicating whether the scheduled session has an order where the orders last name contains the given value.
+     */
+    orderLastNameContains?: string;
+    /**
+     * Gets or sets which field to sort by.
+     */
+    sortBy?: ScheduledSessionSearchSortBy;
+    /**
+     * Gets or sets a value indicating whether the scheduled session post completion email has been sent.
+     */
+    postCompletionEmailSent?: boolean;
+    /**
+     * 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 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<any> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/public/sessions/distinct-dates',
+      headers: {
+        x_tenant_subdomain: xTenantSubdomain,
+      },
+      query: {
+        Ids: ids,
+        VenueId: venueId,
+        SessionId: sessionId,
+        SessionIds: sessionIds,
+        ScheduleId: scheduleId,
+        Status: status,
+        Statuses: statuses,
+        BookingStatus: bookingStatus,
+        StartDateTimeLTE: startDateTimeLte,
+        StartDateTimeGTE: startDateTimeGte,
+        EndDateTimeLTE: endDateTimeLte,
+        EndDateTimeGTE: endDateTimeGte,
+        RemainingUsesLTE: remainingUsesLte,
+        RemainingUsesGTE: remainingUsesGte,
+        FutureOnly: futureOnly,
+        HasAvailability: hasAvailability,
+        OrderFirstNameContains: orderFirstNameContains,
+        OrderLastNameContains: orderLastNameContains,
+        SortBy: sortBy,
+        PostCompletionEmailSent: postCompletionEmailSent,
+        PageNumber: pageNumber,
+        Take: take,
+        LimitListRequests: limitListRequests,
+        TenantId: tenantId,
+        ModifiedById: modifiedById,
+        ModifiedByIds: modifiedByIds,
+        DateCreatedGTE: dateCreatedGte,
+        DateCreatedLTE: dateCreatedLte,
+        IsLive: isLive,
+        SortOrderDirection: sortOrderDirection,
+      },
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Returns a value indicating whether the resource exists in the database given the provided search params.
+   * @returns boolean Success
+   * @throws ApiError
+   */
+  public exists({
+    xTenantSubdomain,
+    ids,
+    venueId,
+    futureOnly,
+    online,
+    programmeId,
+    includeNextOpportunity,
+    allowTemplating,
+    archived,
+    deleted,
+    pageNumber,
+    take,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * The tenants subdomain.
+     */
+    xTenantSubdomain?: string;
+    /**
+     * Gets or sets the queryable session ids.
+     */
+    ids?: Array<string>;
+    /**
+     * Gets or sets the queryable Venue Id.
+     */
+    venueId?: string;
+    /**
+     * Gets or sets a value indicating whether to only return sessions with future slots available.
+     */
+    futureOnly?: boolean;
+    /**
+     * Gets or sets a value indicating whether return online sessions.
+     */
+    online?: boolean;
+    /**
+     * Gets or sets the queryable Programme Id.
+     */
+    programmeId?: string;
+    /**
+     * Gets or sets a value indicating whether to inlcude the sessions next availability.
+     */
+    includeNextOpportunity?: boolean;
+    /**
+     * Gets or sets a value indicating whether to include templatable sessions.
+     */
+    allowTemplating?: boolean;
+    /**
+     * Gets or sets a value indicating whether to include archived sessions.
+     */
+    archived?: boolean;
+    /**
+     * Gets or sets a value indicating whether to include deleted sessions.
+     */
+    deleted?: boolean;
+    /**
+     * 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 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<boolean> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/public/sessions/exists',
+      headers: {
+        x_tenant_subdomain: xTenantSubdomain,
+      },
+      query: {
+        Ids: ids,
+        VenueId: venueId,
+        FutureOnly: futureOnly,
+        Online: online,
+        ProgrammeId: programmeId,
+        IncludeNextOpportunity: includeNextOpportunity,
+        AllowTemplating: allowTemplating,
+        Archived: archived,
+        Deleted: deleted,
+        PageNumber: pageNumber,
+        Take: take,
+        LimitListRequests: limitListRequests,
+        TenantId: tenantId,
+        ModifiedById: modifiedById,
+        ModifiedByIds: modifiedByIds,
+        DateCreatedGTE: dateCreatedGte,
+        DateCreatedLTE: dateCreatedLte,
+        IsLive: isLive,
+        SortOrderDirection: sortOrderDirection,
+      },
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Inserts a list of resources.
+   * @returns Session Success
+   * @throws ApiError
+   */
+  public postList({
+    xTenantSubdomain,
+    requestBody,
+  }: {
+    /**
+     * The tenants subdomain.
+     */
+    xTenantSubdomain?: string;
+    /**
+     * The list of <typeparamref name="TObject" />.
+     */
+    requestBody?: Array<Session>;
+  }): CancelablePromise<Array<Session>> {
+    return this.httpRequest.request({
+      method: 'POST',
+      url: '/api/public/sessions/list',
+      headers: {
+        x_tenant_subdomain: xTenantSubdomain,
+      },
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+}