reach-api-sdk 1.0.0

package/src/services/CountryService.ts

@@ -0,0 +1,118 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { Country } from '../models/Country';
+import type { SearchSortOrderDirection } from '../models/SearchSortOrderDirection';
+
+import type { CancelablePromise } from '../core/CancelablePromise';
+import type { BaseHttpRequest } from '../core/BaseHttpRequest';
+
+export class CountryService {
+  constructor(public readonly httpRequest: BaseHttpRequest) {}
+
+  /**
+   * Gets a Reach.Models.Country by its Id.
+   * @returns Country Success
+   * @throws ApiError
+   */
+  public getObject({
+    id,
+  }: {
+    /**
+     * The Reach.Models.Country id.
+     */
+    id: number;
+  }): CancelablePromise<Country> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/countries/{id}',
+      path: {
+        id: id,
+      },
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Gets a list of Reach.Models.Country.
+   * @returns Country Success
+   * @throws ApiError
+   */
+  public getList({
+    pageNumber,
+    take,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * 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<Country>> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/countries',
+      query: {
+        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`,
+      },
+    });
+  }
+}

package/src/services/CourseSessionSchedulesService.ts

@@ -0,0 +1,589 @@
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+import type { CourseSessionSchedule } from '../models/CourseSessionSchedule';
+import type { CourseSessionSchedulePage } from '../models/CourseSessionSchedulePage';
+import type { ScheduleStatus } from '../models/ScheduleStatus';
+import type { SearchSortOrderDirection } from '../models/SearchSortOrderDirection';
+
+import type { CancelablePromise } from '../core/CancelablePromise';
+import type { BaseHttpRequest } from '../core/BaseHttpRequest';
+
+export class CourseSessionSchedulesService {
+  constructor(public readonly httpRequest: BaseHttpRequest) {}
+
+  /**
+   * Makes the given schedule Id Active />.
+   * @returns CourseSessionSchedule Success
+   * @throws ApiError
+   */
+  public makeActive({
+    courseSessionScheduleId,
+  }: {
+    /**
+     * The course session schedule Id.
+     */
+    courseSessionScheduleId: string;
+  }): CancelablePromise<CourseSessionSchedule> {
+    return this.httpRequest.request({
+      method: 'PATCH',
+      url: '/api/course-session-schedules/{courseSessionScheduleId}/make-active',
+      path: {
+        courseSessionScheduleId: courseSessionScheduleId,
+      },
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Cleans table of unconfirmed schedules.
+   * @returns number Success
+   * @throws ApiError
+   */
+  public clean(): CancelablePromise<number> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/course-session-schedules/clean',
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Gets the resource by its Id.
+   * @returns CourseSessionSchedule Success
+   * @throws ApiError
+   */
+  public getObject({
+    id,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> id.
+     */
+    id: string;
+  }): CancelablePromise<CourseSessionSchedule> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/course-session-schedules/{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/course-session-schedules/{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({
+    courseId,
+    courseIds,
+    lastRunDateTimeLte,
+    status,
+    statuses,
+    pageNumber,
+    take,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * Gets or sets the queryable course id.
+     */
+    courseId?: string;
+    /**
+     * Gets or sets the queryable slot course Ids.
+     */
+    courseIds?: Array<string>;
+    /**
+     * Gets or sets the queryable slot schedule last run date.
+     */
+    lastRunDateTimeLte?: string;
+    /**
+     * Gets or sets the queryable schedule status.
+     */
+    status?: ScheduleStatus;
+    /**
+     * Gets or sets the queryable schedule statuses.
+     */
+    statuses?: Array<ScheduleStatus>;
+    /**
+     * 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/course-session-schedules/exists',
+      query: {
+        CourseId: courseId,
+        CourseIds: courseIds,
+        LastRunDateTimeLTE: lastRunDateTimeLte,
+        Status: status,
+        Statuses: statuses,
+        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 CourseSessionSchedulePage Success
+   * @throws ApiError
+   */
+  public getPage({
+    courseId,
+    courseIds,
+    lastRunDateTimeLte,
+    status,
+    statuses,
+    pageNumber,
+    take,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * Gets or sets the queryable course id.
+     */
+    courseId?: string;
+    /**
+     * Gets or sets the queryable slot course Ids.
+     */
+    courseIds?: Array<string>;
+    /**
+     * Gets or sets the queryable slot schedule last run date.
+     */
+    lastRunDateTimeLte?: string;
+    /**
+     * Gets or sets the queryable schedule status.
+     */
+    status?: ScheduleStatus;
+    /**
+     * Gets or sets the queryable schedule statuses.
+     */
+    statuses?: Array<ScheduleStatus>;
+    /**
+     * 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<CourseSessionSchedulePage> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/course-session-schedules',
+      query: {
+        CourseId: courseId,
+        CourseIds: courseIds,
+        LastRunDateTimeLTE: lastRunDateTimeLte,
+        Status: status,
+        Statuses: statuses,
+        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 CourseSessionSchedule Success
+   * @throws ApiError
+   */
+  public post({
+    requestBody,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> model.
+     */
+    requestBody?: CourseSessionSchedule;
+  }): CancelablePromise<CourseSessionSchedule> {
+    return this.httpRequest.request({
+      method: 'POST',
+      url: '/api/course-session-schedules',
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Patches the resource.
+   * @returns CourseSessionSchedule Success
+   * @throws ApiError
+   */
+  public patch({
+    requestBody,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> model.
+     */
+    requestBody?: CourseSessionSchedule;
+  }): CancelablePromise<CourseSessionSchedule> {
+    return this.httpRequest.request({
+      method: 'PATCH',
+      url: '/api/course-session-schedules',
+      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?: CourseSessionSchedule;
+  }): CancelablePromise<any> {
+    return this.httpRequest.request({
+      method: 'DELETE',
+      url: '/api/course-session-schedules',
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Gets a list of resources.
+   * @returns CourseSessionSchedule Success
+   * @throws ApiError
+   */
+  public getListIdName({
+    courseId,
+    courseIds,
+    lastRunDateTimeLte,
+    status,
+    statuses,
+    pageNumber,
+    take,
+    limitListRequests,
+    tenantId,
+    modifiedById,
+    modifiedByIds,
+    dateCreatedGte,
+    dateCreatedLte,
+    isLive,
+    sortOrderDirection,
+  }: {
+    /**
+     * Gets or sets the queryable course id.
+     */
+    courseId?: string;
+    /**
+     * Gets or sets the queryable slot course Ids.
+     */
+    courseIds?: Array<string>;
+    /**
+     * Gets or sets the queryable slot schedule last run date.
+     */
+    lastRunDateTimeLte?: string;
+    /**
+     * Gets or sets the queryable schedule status.
+     */
+    status?: ScheduleStatus;
+    /**
+     * Gets or sets the queryable schedule statuses.
+     */
+    statuses?: Array<ScheduleStatus>;
+    /**
+     * 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<CourseSessionSchedule>> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/course-session-schedules/id-name',
+      query: {
+        CourseId: courseId,
+        CourseIds: courseIds,
+        LastRunDateTimeLTE: lastRunDateTimeLte,
+        Status: status,
+        Statuses: statuses,
+        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 CourseSessionSchedule Success
+   * @throws ApiError
+   */
+  public postList({
+    requestBody,
+  }: {
+    /**
+     * The list of <typeparamref name="TObject" />.
+     */
+    requestBody?: Array<CourseSessionSchedule>;
+  }): CancelablePromise<Array<CourseSessionSchedule>> {
+    return this.httpRequest.request({
+      method: 'POST',
+      url: '/api/course-session-schedules/list',
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Patches the resource.
+   * @returns CourseSessionSchedule Success
+   * @throws ApiError
+   */
+  public patchWithReferences({
+    requestBody,
+  }: {
+    /**
+     * The <typeparamref name="TObject" /> model.
+     */
+    requestBody?: CourseSessionSchedule;
+  }): CancelablePromise<CourseSessionSchedule> {
+    return this.httpRequest.request({
+      method: 'PATCH',
+      url: '/api/course-session-schedules/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/course-session-schedules/{id}/deletable',
+      path: {
+        id: id,
+      },
+      errors: {
+        400: `Bad Request`,
+        500: `Server Error`,
+      },
+    });
+  }
+}