reach-api-sdk 1.0.205 → 1.0.206

package/src/index.ts

@@ -75,6 +75,18 @@ export type { CustomerPatch } from './models/CustomerPatch';
 export type { CustomerPost } from './models/CustomerPost';
 export type { CustomerStats } from './models/CustomerStats';
 export { CustomerType } from './models/CustomerType';
+export { CustomFieldDataType } from './models/CustomFieldDataType';
+export type { CustomFieldDefinition } from './models/CustomFieldDefinition';
+export type { CustomFieldDefinitionPage } from './models/CustomFieldDefinitionPage';
+export type { CustomFieldDefinitionPatch } from './models/CustomFieldDefinitionPatch';
+export type { CustomFieldDefinitionPost } from './models/CustomFieldDefinitionPost';
+export type { CustomFieldDefinitionWithValue } from './models/CustomFieldDefinitionWithValue';
+export type { CustomFieldOption } from './models/CustomFieldOption';
+export type { CustomFieldOptionDto } from './models/CustomFieldOptionDto';
+export type { CustomFieldOptionPost } from './models/CustomFieldOptionPost';
+export type { CustomFieldsBulkUpdate } from './models/CustomFieldsBulkUpdate';
+export { CustomFieldValueEntityType } from './models/CustomFieldValueEntityType';
+export type { CustomFieldValueUpdate } from './models/CustomFieldValueUpdate';
 export type { DatabaseState } from './models/DatabaseState';
 export { DayOfWeek } from './models/DayOfWeek';
 export type { Deal } from './models/Deal';
@@ -391,6 +403,7 @@ export type { TotalRevenueReportPatch } from './models/TotalRevenueReportPatch';
 export type { TotalRevenueReportPost } from './models/TotalRevenueReportPost';
 export type { UnsplashSearchResponse } from './models/UnsplashSearchResponse';
 export { UpcomingLayout } from './models/UpcomingLayout';
+export type { UpdateCustomFieldOption } from './models/UpdateCustomFieldOption';
 export type { UpdateEmailSettings } from './models/UpdateEmailSettings';
 export type { UpdateOffer } from './models/UpdateOffer';
 export type { User } from './models/User';
@@ -470,6 +483,7 @@ export { CoursesService } from './services/CoursesService';
 export { CourseSessionsService } from './services/CourseSessionsService';
 export { CourseSessionSchedulesService } from './services/CourseSessionSchedulesService';
 export { CustomersService } from './services/CustomersService';
+export { CustomFieldsService } from './services/CustomFieldsService';
 export { DealActivitiesService } from './services/DealActivitiesService';
 export { DealsService } from './services/DealsService';
 export { DiscountCodeUsesService } from './services/DiscountCodeUsesService';

package/src/models/CustomFieldDataType.ts

@@ -0,0 +1,22 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Controls the data type for custom field definitions.
+ */
+export enum CustomFieldDataType {
+  TEXT = 'Text',
+  MULTI_LINE_TEXT = 'MultiLineText',
+  NUMBER = 'Number',
+  DECIMAL = 'Decimal',
+  BOOL = 'Bool',
+  DATE = 'Date',
+  DATE_TIME = 'DateTime',
+  URL = 'Url',
+  EMAIL = 'Email',
+  PHONE = 'Phone',
+  SINGLE_SELECT = 'SingleSelect',
+  MULTI_SELECT = 'MultiSelect',
+}

package/src/models/CustomFieldDefinition.ts

@@ -0,0 +1,100 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { CustomFieldDataType } from './CustomFieldDataType';
+import type { CustomFieldOption } from './CustomFieldOption';
+import type { CustomFieldValueEntityType } from './CustomFieldValueEntityType';
+
+/**
+ * Represents a custom field definition within the Reach application.
+ */
+export type CustomFieldDefinition = {
+  /**
+   * Gets or sets the entities Id.
+   */
+  id?: string;
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets the created date of this entity.
+   */
+  dateCreated: string;
+  /**
+   * Gets or sets the last modified date of this entity.
+   */
+  dateModified: string;
+  /**
+   * Gets or sets the modified by Id.
+   */
+  modifiedById?: string | null;
+  /**
+   * Gets or sets a value indicating whether the record is live and available for use within the application.
+   */
+  isLive: boolean;
+  entityType?: CustomFieldValueEntityType;
+  /**
+   * Gets or sets the custom field label.
+   */
+  label?: string | null;
+  /**
+   * Gets or sets the custom field description.
+   */
+  description?: string | null;
+  dataType?: CustomFieldDataType;
+  /**
+   * Gets or sets a value indicating whether the field is required.
+   */
+  required?: boolean | null;
+  /**
+   * Gets or sets a value indicating whether the field has public visibility.
+   */
+  publicVisibility?: boolean | null;
+  /**
+   * Gets or sets the display order.
+   */
+  displayOrder?: number | null;
+  /**
+   * Gets or sets a value indicating whether the field is archived.
+   */
+  archived?: boolean | null;
+  /**
+   * Gets or sets the validation JSON (min/max/regex etc).
+   */
+  validationJson?: string | null;
+  /**
+   * Gets or sets the default text value.
+   */
+  defaultValueText?: string | null;
+  /**
+   * Gets or sets the default number value.
+   */
+  defaultValueNumber?: number | null;
+  /**
+   * Gets or sets the default decimal value.
+   */
+  defaultValueDecimal?: number | null;
+  /**
+   * Gets or sets the default bit value.
+   */
+  defaultValueBit?: boolean | null;
+  /**
+   * Gets or sets the default date value.
+   */
+  defaultValueDate?: string | null;
+  /**
+   * Gets or sets the default datetimeoffset value.
+   */
+  defaultValueDatetimeoffset?: string | null;
+  /**
+   * Gets or sets the default JSON value.
+   */
+  defaultValueJson?: string | null;
+  /**
+   * Gets or sets the options for this custom field definition.
+   */
+  options?: Array<CustomFieldOption> | null;
+};

package/src/models/CustomFieldDefinitionPage.ts

@@ -0,0 +1,12 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { CustomFieldDefinition } from './CustomFieldDefinition';
+import type { Pagination } from './Pagination';
+
+export type CustomFieldDefinitionPage = {
+  pagination: Pagination;
+  readonly items: Array<CustomFieldDefinition>;
+};

package/src/models/CustomFieldDefinitionPatch.ts

@@ -0,0 +1,84 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { CustomFieldDataType } from './CustomFieldDataType';
+import type { CustomFieldValueEntityType } from './CustomFieldValueEntityType';
+import type { UpdateCustomFieldOption } from './UpdateCustomFieldOption';
+
+/**
+ * Patch model for the custom field definition.
+ */
+export type CustomFieldDefinitionPatch = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets the Id.
+   */
+  id: string;
+  entityType?: CustomFieldValueEntityType;
+  /**
+   * Gets or sets the custom field label.
+   */
+  label?: string | null;
+  /**
+   * Gets or sets the custom field description.
+   */
+  description?: string | null;
+  dataType?: CustomFieldDataType;
+  /**
+   * Gets or sets a value indicating whether the field is required.
+   */
+  required?: boolean | null;
+  /**
+   * Gets or sets a value indicating whether the field has public visibility.
+   */
+  publicVisibility?: boolean | null;
+  /**
+   * Gets or sets the display order.
+   */
+  displayOrder?: number | null;
+  /**
+   * Gets or sets the validation JSON.
+   */
+  validationJson?: string | null;
+  /**
+   * Gets or sets the default text value.
+   */
+  defaultValueText?: string | null;
+  /**
+   * Gets or sets the default number value.
+   */
+  defaultValueNumber?: number | null;
+  /**
+   * Gets or sets the default decimal value.
+   */
+  defaultValueDecimal?: number | null;
+  /**
+   * Gets or sets the default bit value.
+   */
+  defaultValueBit?: boolean | null;
+  /**
+   * Gets or sets the default date value.
+   */
+  defaultValueDate?: string | null;
+  /**
+   * Gets or sets the default datetimeoffset value.
+   */
+  defaultValueDatetimeoffset?: string | null;
+  /**
+   * Gets or sets the default JSON value.
+   */
+  defaultValueJson?: string | null;
+  /**
+   * Gets or sets a value indicating whether the field is archived.
+   */
+  archived?: boolean | null;
+  /**
+   * Gets or sets the custom field options.
+   */
+  options?: Array<UpdateCustomFieldOption> | null;
+};

package/src/models/CustomFieldDefinitionPost.ts

@@ -0,0 +1,80 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { CustomFieldDataType } from './CustomFieldDataType';
+import type { CustomFieldOptionPost } from './CustomFieldOptionPost';
+import type { CustomFieldValueEntityType } from './CustomFieldValueEntityType';
+
+/**
+ * Post model for the custom field definition.
+ */
+export type CustomFieldDefinitionPost = {
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  entityType?: CustomFieldValueEntityType;
+  /**
+   * Gets or sets the custom field label.
+   */
+  label?: string | null;
+  /**
+   * Gets or sets the custom field description.
+   */
+  description?: string | null;
+  dataType?: CustomFieldDataType;
+  /**
+   * Gets or sets a value indicating whether the field is required.
+   */
+  required?: boolean | null;
+  /**
+   * Gets or sets a value indicating whether the field has public visibility.
+   */
+  publicVisibility?: boolean | null;
+  /**
+   * Gets or sets the display order.
+   */
+  displayOrder?: number | null;
+  /**
+   * Gets or sets the validation JSON.
+   */
+  validationJson?: string | null;
+  /**
+   * Gets or sets the default text value.
+   */
+  defaultValueText?: string | null;
+  /**
+   * Gets or sets the default number value.
+   */
+  defaultValueNumber?: number | null;
+  /**
+   * Gets or sets the default decimal value.
+   */
+  defaultValueDecimal?: number | null;
+  /**
+   * Gets or sets the default bit value.
+   */
+  defaultValueBit?: boolean | null;
+  /**
+   * Gets or sets the default date value.
+   */
+  defaultValueDate?: string | null;
+  /**
+   * Gets or sets the default datetimeoffset value.
+   */
+  defaultValueDatetimeoffset?: string | null;
+  /**
+   * Gets or sets the default JSON value.
+   */
+  defaultValueJson?: string | null;
+  /**
+   * Gets or sets the options for select types.
+   */
+  options?: Array<CustomFieldOptionPost> | null;
+  /**
+   * Gets or sets a value indicating whether the field is archived.
+   */
+  archived?: boolean | null;
+};

package/src/models/CustomFieldDefinitionWithValue.ts

@@ -0,0 +1,82 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { CustomFieldDataType } from './CustomFieldDataType';
+import type { CustomFieldOptionDto } from './CustomFieldOptionDto';
+
+/**
+ * Represents a custom field definition with its current value for editing.
+ */
+export type CustomFieldDefinitionWithValue = {
+  /**
+   * Gets or sets the tenant id.
+   */
+  tenantId?: string;
+  /**
+   * Gets or sets the definition id.
+   */
+  definitionId?: string | null;
+  /**
+   * Gets or sets the custom field label.
+   */
+  label?: string | null;
+  /**
+   * Gets or sets the custom field description.
+   */
+  description?: string | null;
+  dataType?: CustomFieldDataType;
+  /**
+   * Gets or sets a value indicating whether the field is required.
+   */
+  required?: boolean | null;
+  /**
+   * Gets or sets a value indicating whether the field has public visibility.
+   */
+  publicVisibility?: boolean | null;
+  /**
+   * Gets or sets the display order.
+   */
+  displayOrder?: number | null;
+  /**
+   * Gets or sets the validation JSON.
+   */
+  validationJson?: string | null;
+  /**
+   * Gets or sets the default text value.
+   */
+  defaultValueText?: string | null;
+  /**
+   * Gets or sets the default number value.
+   */
+  defaultValueNumber?: number | null;
+  /**
+   * Gets or sets the default decimal value.
+   */
+  defaultValueDecimal?: number | null;
+  /**
+   * Gets or sets the default bit value.
+   */
+  defaultValueBit?: boolean | null;
+  /**
+   * Gets or sets the default date value.
+   */
+  defaultValueDate?: string | null;
+  /**
+   * Gets or sets the default datetimeoffset value.
+   */
+  defaultValueDatetimeoffset?: string | null;
+  /**
+   * Gets or sets the default JSON value.
+   */
+  defaultValueJson?: string | null;
+  /**
+   * Gets or sets the options for select types.
+   */
+  options?: Array<CustomFieldOptionDto> | null;
+  /**
+   * Gets or sets the current value (can be text, number, decimal, bit, date, datetimeoffset, or json).
+   */
+  value?: any;
+};

package/src/models/CustomFieldOption.ts

@@ -0,0 +1,50 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Represents a custom field option within the Reach application.
+ */
+export type CustomFieldOption = {
+  /**
+   * Gets or sets the entities Id.
+   */
+  id?: string;
+  /**
+   * Gets or sets the tenant Id.
+   */
+  tenantId: string;
+  /**
+   * Gets or sets the created date of this entity.
+   */
+  dateCreated: string;
+  /**
+   * Gets or sets the last modified date of this entity.
+   */
+  dateModified: string;
+  /**
+   * Gets or sets the modified by Id.
+   */
+  modifiedById?: string | null;
+  /**
+   * Gets or sets a value indicating whether the record is live and available for use within the application.
+   */
+  isLive: boolean;
+  /**
+   * Gets or sets the custom field definition id.
+   */
+  customFieldDefinitionId?: string | null;
+  /**
+   * Gets or sets the option label.
+   */
+  label?: string | null;
+  /**
+   * Gets or sets the display order.
+   */
+  displayOrder?: number | null;
+  /**
+   * Gets or sets a value indicating whether the option is archived.
+   */
+  archived?: boolean | null;
+};

package/src/models/CustomFieldOptionDto.ts

@@ -0,0 +1,14 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Represents a custom field option DTO.
+ */
+export type CustomFieldOptionDto = {
+  /**
+   * Gets or sets the option label.
+   */
+  label?: string | null;
+};

package/src/models/CustomFieldOptionPost.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Post model for the custom field option.
+ */
+export type CustomFieldOptionPost = {
+  /**
+   * Gets or sets the option label.
+   */
+  label?: string | null;
+  /**
+   * Gets or sets the display order.
+   */
+  displayOrder?: number | null;
+};

package/src/models/CustomFieldValueEntityType.ts

@@ -0,0 +1,13 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Controls the entity type for custom field values.
+ */
+export enum CustomFieldValueEntityType {
+  VENUE = 'Venue',
+  COURSE = 'Course',
+  SESSION = 'Session',
+}

package/src/models/CustomFieldValueUpdate.ts

@@ -0,0 +1,18 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Represents a single custom field value update.
+ */
+export type CustomFieldValueUpdate = {
+  /**
+   * Gets or sets the custom field definition id.
+   */
+  definitionId?: string;
+  /**
+   * Gets or sets the value to set.
+   */
+  value?: any;
+};

package/src/models/CustomFieldsBulkUpdate.ts

@@ -0,0 +1,16 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+import type { CustomFieldValueUpdate } from './CustomFieldValueUpdate';
+
+/**
+ * Represents a bulk update request for custom fields.
+ */
+export type CustomFieldsBulkUpdate = {
+  /**
+   * Gets or sets the list of custom field values to update.
+   */
+  values?: Array<CustomFieldValueUpdate> | null;
+};

package/src/models/UpdateCustomFieldOption.ts

@@ -0,0 +1,26 @@
+/* generated using openapi-typescript-codegen -- do no edit */
+/* istanbul ignore file */
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * Patch model for custom field options.
+ */
+export type UpdateCustomFieldOption = {
+  /**
+   * Gets or sets the option id.
+   */
+  id?: string | null;
+  /**
+   * Gets or sets the option label.
+   */
+  label?: string | null;
+  /**
+   * Gets or sets the display order.
+   */
+  displayOrder?: number | null;
+  /**
+   * Gets or sets a value indicating whether the option is archived.
+   */
+  archived?: boolean | null;
+};

package/src/services/CoursesService.ts

@@ -11,6 +11,8 @@ import type { CoursePage } from '../models/CoursePage';
 import type { CoursePatch } from '../models/CoursePatch';
 import type { CoursePost } from '../models/CoursePost';
 import type { CourseSearchSortBy } from '../models/CourseSearchSortBy';
+import type { CustomFieldDefinitionWithValue } from '../models/CustomFieldDefinitionWithValue';
+import type { CustomFieldsBulkUpdate } from '../models/CustomFieldsBulkUpdate';
 import type { ScheduledSession } from '../models/ScheduledSession';
 import type { SearchSortOrderDirection } from '../models/SearchSortOrderDirection';
 
@@ -436,6 +438,67 @@ export class CoursesService {
     });
   }
 
+  /**
+   * Gets custom field definitions with their current values for a course.
+   * @returns CustomFieldDefinitionWithValue OK
+   * @throws ApiError
+   */
+  public getCustomFields({
+    courseId,
+  }: {
+    /**
+     * The course id.
+     */
+    courseId: string;
+  }): CancelablePromise<Array<CustomFieldDefinitionWithValue>> {
+    return this.httpRequest.request({
+      method: 'GET',
+      url: '/api/courses/{courseId}/custom-fields',
+      path: {
+        courseId: courseId,
+      },
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
+  /**
+   * Bulk updates custom field values for a course.
+   * @returns CustomFieldDefinitionWithValue OK
+   * @throws ApiError
+   */
+  public bulkUpdateCustomFields({
+    courseId,
+    requestBody,
+  }: {
+    /**
+     * The course id.
+     */
+    courseId: string;
+    /**
+     * The bulk update request containing all custom field values.
+     */
+    requestBody?: CustomFieldsBulkUpdate;
+  }): CancelablePromise<Array<CustomFieldDefinitionWithValue>> {
+    return this.httpRequest.request({
+      method: 'PUT',
+      url: '/api/courses/{courseId}/custom-fields',
+      path: {
+        courseId: courseId,
+      },
+      body: requestBody,
+      mediaType: 'application/json',
+      errors: {
+        400: `Bad Request`,
+        422: `Unprocessable Content`,
+        500: `Internal Server Error`,
+      },
+    });
+  }
+
   /**
    * Inserts a new resource. The Id will be automatically generated and will be ignored if provided.
    * @returns Course OK