reach-api-sdk 1.0.0

package/src/services/OrdersService.ts

@@ -0,0 +1,862 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Order } from '../models/Order';
+import type { OrderPage } from '../models/OrderPage';
+import type { OrderStage } from '../models/OrderStage';
+import type { SearchSortOrderDirection } from '../models/SearchSortOrderDirection';
+
+import type { CancelablePromise } from '../core/CancelablePromise';
+import type { BaseHttpRequest } from '../core/BaseHttpRequest';
+
+export class OrdersService {
+  constructor(public readonly httpRequest: BaseHttpRequest) {}
+
+  /**
+   * Cancels the order.
+   * @returns Order Success
+   * @throws ApiError
+   */
+  public cancel({
+    id,
+  }: {
+    /**
+     * The Order id.
+     */
+    id: string;
+  }): CancelablePromise<Order> {
+    return this.httpRequest.request({
+      method: 'POST',
+      url: '/api/orders/{id}/cancel',
+      path: {
+        id: id,
+      },
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Requests  a refund for the order.
+   * @returns Order Success
+   * @throws ApiError
+   */
+  public refund({
+    id,
+  }: {
+    /**
+     * The Order id.
+     */
+    id: string;
+  }): CancelablePromise<Order> {
+    return this.httpRequest.request({
+      method: 'POST',
+      url: '/api/orders/{id}/refund',
+      path: {
+        id: id,
+      },
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Cancels the order and requests a refund.
+   * @returns Order Success
+   * @throws ApiError
+   */
+  public cancelWithRefund({
+    id,
+  }: {
+    /**
+     * The Order id.
+     */
+    id: string;
+  }): CancelablePromise<Order> {
+    return this.httpRequest.request({
+      method: 'POST',
+      url: '/api/orders/{id}/cancel-with-refund',
+      path: {
+        id: id,
+      },
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Cancels the order.
+   * @returns Order Success
+   * @throws ApiError
+   */
+  public setPaidOffline({
+    id,
+  }: {
+    /**
+     * The Order id.
+     */
+    id: string;
+  }): CancelablePromise<Order> {
+    return this.httpRequest.request({
+      method: 'POST',
+      url: '/api/orders/{id}/set-paid-offline',
+      path: {
+        id: id,
+      },
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Update the contact details on the order.
+   * @returns Order Success
+   * @throws ApiError
+   */
+  public updateOrderContact({
+    id,
+    requestBody,
+  }: {
+    /**
+     * The Order id.
+     */
+    id: string;
+    /**
+     * The altered order details.
+     */
+    requestBody?: Order;
+  }): CancelablePromise<Order> {
+    return this.httpRequest.request({
+      method: 'PATCH',
+      url: '/api/orders/{id}/update-contact',
+      path: {
+        id: id,
+      },
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Update the contact details on the order.
+   * @returns any Success
+   * @throws ApiError
+   */
+  public resendOrderConfirmation({
+    id,
+  }: {
+    /**
+     * The Order id.
+     */
+    id: string;
+  }): CancelablePromise<any> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/orders/{id}/resend-confirmation',
+      path: {
+        id: id,
+      },
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Send a make payment email.
+   * @returns any Success
+   * @throws ApiError
+   */
+  public sendMakePayment({
+    id,
+  }: {
+    /**
+     * The Order id.
+     */
+    id: string;
+  }): CancelablePromise<any> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/orders/{id}/send-make-payment',
+      path: {
+        id: id,
+      },
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Gets the resource by its Id.
+   * @returns Order Success
+   * @throws ApiError
+   */
+  public getObject({
+    id,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> id.
+     */
+    id: string;
+  }): CancelablePromise<Order> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/orders/{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/orders/{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({
+    wildcard,
+    accessCode,
+    venueId,
+    orderIds,
+    sessionId,
+    facilityId,
+    courseId,
+    orderStage,
+    isBookedOrPendingPayment,
+    orderStages,
+    orderDateGte,
+    orderDateLte,
+    pageNumber,
+    take,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * Gets or sets the wildcard for use in a query search.
+     */
+    wildcard?: string;
+    /**
+     * Gets or sets the access code for use in a query search.
+     */
+    accessCode?: string;
+    /**
+     * Gets or sets the venue Id for use in a query search.
+     */
+    venueId?: string;
+    /**
+     * Gets or sets the queryable order ids.
+     */
+    orderIds?: Array<string>;
+    /**
+     * Gets or sets the session Id for use in a query search.
+     */
+    sessionId?: string;
+    /**
+     * Gets or sets the facility Id for use in a query search.
+     */
+    facilityId?: string;
+    /**
+     * Gets or sets the course Id for use in a query search.
+     */
+    courseId?: string;
+    /**
+     * Gets or sets the queryable order stage. This cannot be used in conjunction with IsBookedOrPendingPayment.
+     */
+    orderStage?: OrderStage;
+    /**
+     * Gets or sets a value indicating whether to return orders that are either booked or pending payment. This cannot be used in conjunction with OrderStage.
+     */
+    isBookedOrPendingPayment?: boolean;
+    /**
+     * Gets or sets the queryable order stages.
+     */
+    orderStages?: Array<OrderStage>;
+    /**
+     * Gets or sets the queryable order date creted is greater than or equal to.
+     */
+    orderDateGte?: string;
+    /**
+     * Gets or sets the queryable order date created is less than or equal to.
+     */
+    orderDateLte?: string;
+    /**
+     * 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/orders/exists',
+      query: {
+        Wildcard: wildcard,
+        AccessCode: accessCode,
+        VenueId: venueId,
+        OrderIds: orderIds,
+        SessionId: sessionId,
+        FacilityId: facilityId,
+        CourseId: courseId,
+        OrderStage: orderStage,
+        IsBookedOrPendingPayment: isBookedOrPendingPayment,
+        OrderStages: orderStages,
+        OrderDateGTE: orderDateGte,
+        OrderDateLTE: orderDateLte,
+        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 OrderPage Success
+   * @throws ApiError
+   */
+  public getPage({
+    wildcard,
+    accessCode,
+    venueId,
+    orderIds,
+    sessionId,
+    facilityId,
+    courseId,
+    orderStage,
+    isBookedOrPendingPayment,
+    orderStages,
+    orderDateGte,
+    orderDateLte,
+    pageNumber,
+    take,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * Gets or sets the wildcard for use in a query search.
+     */
+    wildcard?: string;
+    /**
+     * Gets or sets the access code for use in a query search.
+     */
+    accessCode?: string;
+    /**
+     * Gets or sets the venue Id for use in a query search.
+     */
+    venueId?: string;
+    /**
+     * Gets or sets the queryable order ids.
+     */
+    orderIds?: Array<string>;
+    /**
+     * Gets or sets the session Id for use in a query search.
+     */
+    sessionId?: string;
+    /**
+     * Gets or sets the facility Id for use in a query search.
+     */
+    facilityId?: string;
+    /**
+     * Gets or sets the course Id for use in a query search.
+     */
+    courseId?: string;
+    /**
+     * Gets or sets the queryable order stage. This cannot be used in conjunction with IsBookedOrPendingPayment.
+     */
+    orderStage?: OrderStage;
+    /**
+     * Gets or sets a value indicating whether to return orders that are either booked or pending payment. This cannot be used in conjunction with OrderStage.
+     */
+    isBookedOrPendingPayment?: boolean;
+    /**
+     * Gets or sets the queryable order stages.
+     */
+    orderStages?: Array<OrderStage>;
+    /**
+     * Gets or sets the queryable order date creted is greater than or equal to.
+     */
+    orderDateGte?: string;
+    /**
+     * Gets or sets the queryable order date created is less than or equal to.
+     */
+    orderDateLte?: string;
+    /**
+     * 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<OrderPage> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/orders',
+      query: {
+        Wildcard: wildcard,
+        AccessCode: accessCode,
+        VenueId: venueId,
+        OrderIds: orderIds,
+        SessionId: sessionId,
+        FacilityId: facilityId,
+        CourseId: courseId,
+        OrderStage: orderStage,
+        IsBookedOrPendingPayment: isBookedOrPendingPayment,
+        OrderStages: orderStages,
+        OrderDateGTE: orderDateGte,
+        OrderDateLTE: orderDateLte,
+        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 Order Success
+   * @throws ApiError
+   */
+  public post({
+    requestBody,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> model.
+     */
+    requestBody?: Order;
+  }): CancelablePromise<Order> {
+    return this.httpRequest.request({
+      method: 'POST',
+      url: '/api/orders',
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Patches the resource.
+   * @returns Order Success
+   * @throws ApiError
+   */
+  public patch({
+    requestBody,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> model.
+     */
+    requestBody?: Order;
+  }): CancelablePromise<Order> {
+    return this.httpRequest.request({
+      method: 'PATCH',
+      url: '/api/orders',
+      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?: Order;
+  }): CancelablePromise<any> {
+    return this.httpRequest.request({
+      method: 'DELETE',
+      url: '/api/orders',
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Gets a list of resources.
+   * @returns Order Success
+   * @throws ApiError
+   */
+  public getListIdName({
+    wildcard,
+    accessCode,
+    venueId,
+    orderIds,
+    sessionId,
+    facilityId,
+    courseId,
+    orderStage,
+    isBookedOrPendingPayment,
+    orderStages,
+    orderDateGte,
+    orderDateLte,
+    pageNumber,
+    take,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * Gets or sets the wildcard for use in a query search.
+     */
+    wildcard?: string;
+    /**
+     * Gets or sets the access code for use in a query search.
+     */
+    accessCode?: string;
+    /**
+     * Gets or sets the venue Id for use in a query search.
+     */
+    venueId?: string;
+    /**
+     * Gets or sets the queryable order ids.
+     */
+    orderIds?: Array<string>;
+    /**
+     * Gets or sets the session Id for use in a query search.
+     */
+    sessionId?: string;
+    /**
+     * Gets or sets the facility Id for use in a query search.
+     */
+    facilityId?: string;
+    /**
+     * Gets or sets the course Id for use in a query search.
+     */
+    courseId?: string;
+    /**
+     * Gets or sets the queryable order stage. This cannot be used in conjunction with IsBookedOrPendingPayment.
+     */
+    orderStage?: OrderStage;
+    /**
+     * Gets or sets a value indicating whether to return orders that are either booked or pending payment. This cannot be used in conjunction with OrderStage.
+     */
+    isBookedOrPendingPayment?: boolean;
+    /**
+     * Gets or sets the queryable order stages.
+     */
+    orderStages?: Array<OrderStage>;
+    /**
+     * Gets or sets the queryable order date creted is greater than or equal to.
+     */
+    orderDateGte?: string;
+    /**
+     * Gets or sets the queryable order date created is less than or equal to.
+     */
+    orderDateLte?: string;
+    /**
+     * 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<Order>> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/orders/id-name',
+      query: {
+        Wildcard: wildcard,
+        AccessCode: accessCode,
+        VenueId: venueId,
+        OrderIds: orderIds,
+        SessionId: sessionId,
+        FacilityId: facilityId,
+        CourseId: courseId,
+        OrderStage: orderStage,
+        IsBookedOrPendingPayment: isBookedOrPendingPayment,
+        OrderStages: orderStages,
+        OrderDateGTE: orderDateGte,
+        OrderDateLTE: orderDateLte,
+        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 Order Success
+   * @throws ApiError
+   */
+  public postList({
+    requestBody,
+  }: {
+    /**
+     * The list of <typeparamref name="TObject" />.
+     */
+    requestBody?: Array<Order>;
+  }): CancelablePromise<Array<Order>> {
+    return this.httpRequest.request({
+      method: 'POST',
+      url: '/api/orders/list',
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Patches the resource.
+   * @returns Order Success
+   * @throws ApiError
+   */
+  public patchWithReferences({
+    requestBody,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> model.
+     */
+    requestBody?: Order;
+  }): CancelablePromise<Order> {
+    return this.httpRequest.request({
+      method: 'PATCH',
+      url: '/api/orders/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/orders/{id}/deletable',
+      path: {
+        id: id,
+      },
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+}