reach-api-sdk 1.0.0

package/src/services/SessionsService.ts

@@ -0,0 +1,670 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { SearchSortOrderDirection } from '../models/SearchSortOrderDirection';
+import type { Session } from '../models/Session';
+import type { SessionPage } from '../models/SessionPage';
+
+import type { CancelablePromise } from '../core/CancelablePromise';
+import type { BaseHttpRequest } from '../core/BaseHttpRequest';
+
+export class SessionsService {
+  constructor(public readonly httpRequest: BaseHttpRequest) {}
+
+  /**
+   * Takes the session offline />.
+   * @returns Session Success
+   * @throws ApiError
+   */
+  public takeOffline({
+    sessionId,
+  }: {
+    /**
+     * The session Id.
+     */
+    sessionId: string;
+  }): CancelablePromise<Session> {
+    return this.httpRequest.request({
+      method: 'PATCH',
+      url: '/api/sessions/{sessionId}/take-offline',
+      path: {
+        sessionId: sessionId,
+      },
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Brings the session online />.
+   * @returns Session Success
+   * @throws ApiError
+   */
+  public bringOnline({
+    sessionId,
+  }: {
+    /**
+     * The session Id.
+     */
+    sessionId: string;
+  }): CancelablePromise<Session> {
+    return this.httpRequest.request({
+      method: 'PATCH',
+      url: '/api/sessions/{sessionId}/bring-online',
+      path: {
+        sessionId: sessionId,
+      },
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Gets the resource by its Id.
+   * @returns Session Success
+   * @throws ApiError
+   */
+  public getObject({
+    id,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> id.
+     */
+    id: string;
+  }): CancelablePromise<Session> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/sessions/{id}',
+      path: {
+        id: id,
+      },
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Deletes the resource.
+   * @returns any Success
+   * @throws ApiError
+   */
+  public deleteById({
+    id,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> id.
+     */
+    id: string;
+  }): CancelablePromise<any> {
+    return this.httpRequest.request({
+      method: 'DELETE',
+      url: '/api/sessions/{id}',
+      path: {
+        id: id,
+      },
+      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({
+    ids,
+    venueId,
+    futureOnly,
+    online,
+    programmeId,
+    includeNextOpportunity,
+    allowTemplating,
+    archived,
+    deleted,
+    pageNumber,
+    take,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * 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/sessions/exists',
+      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`,
+      },
+    });
+  }
+
+  /**
+   * Gets a list of resources.
+   * @returns SessionPage Success
+   * @throws ApiError
+   */
+  public getPage({
+    ids,
+    venueId,
+    futureOnly,
+    online,
+    programmeId,
+    includeNextOpportunity,
+    allowTemplating,
+    archived,
+    deleted,
+    pageNumber,
+    take,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * 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/sessions',
+      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({
+    requestBody,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> model.
+     */
+    requestBody?: Session;
+  }): CancelablePromise<Session> {
+    return this.httpRequest.request({
+      method: 'POST',
+      url: '/api/sessions',
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Patches the resource.
+   * @returns Session Success
+   * @throws ApiError
+   */
+  public patch({
+    requestBody,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> model.
+     */
+    requestBody?: Session;
+  }): CancelablePromise<Session> {
+    return this.httpRequest.request({
+      method: 'PATCH',
+      url: '/api/sessions',
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Deletes the resource.
+   * @returns any Success
+   * @throws ApiError
+   */
+  public deleteByObject({
+    requestBody,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> model.
+     */
+    requestBody?: Session;
+  }): CancelablePromise<any> {
+    return this.httpRequest.request({
+      method: 'DELETE',
+      url: '/api/sessions',
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Gets a list of resources.
+   * @returns Session Success
+   * @throws ApiError
+   */
+  public getListIdName({
+    ids,
+    venueId,
+    futureOnly,
+    online,
+    programmeId,
+    includeNextOpportunity,
+    allowTemplating,
+    archived,
+    deleted,
+    pageNumber,
+    take,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * 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<Array<Session>> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/sessions/id-name',
+      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({
+    requestBody,
+  }: {
+    /**
+     * The list of <typeparamref name="TObject" />.
+     */
+    requestBody?: Array<Session>;
+  }): CancelablePromise<Array<Session>> {
+    return this.httpRequest.request({
+      method: 'POST',
+      url: '/api/sessions/list',
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Patches the resource.
+   * @returns Session Success
+   * @throws ApiError
+   */
+  public patchWithReferences({
+    requestBody,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> model.
+     */
+    requestBody?: Session;
+  }): CancelablePromise<Session> {
+    return this.httpRequest.request({
+      method: 'PATCH',
+      url: '/api/sessions/with-references',
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Returns a value indicating whether the resource is deletable.
+   * @returns boolean Success
+   * @throws ApiError
+   */
+  public canDelete({
+    id,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> id.
+     */
+    id: string;
+  }): CancelablePromise<boolean> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/sessions/{id}/deletable',
+      path: {
+        id: id,
+      },
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+}