bmlt-server-semantic-client 1.0.0

package/src/models/SemanticFormat.ts

@@ -0,0 +1,132 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * BMLT Semantic API
+ * OpenAPI description of the BMLT Semantic Interface (the read-only meeting-query API) for the JSON data format.  The semantic interface dispatches all operations from a single endpoint (`/client_interface/json/`) using a `switcher` query parameter. To keep each operation discoverable, this spec models each `switcher` value as a distinct path key with the query string baked in. Tools such as Swagger UI, Redoc, and openapi-generator handle these path keys correctly even though the OpenAPI spec technically expects unique URL paths.  ### Things that do not map cleanly onto OpenAPI  - **Sign-as-operator** — many filters (`formats`, `services`, `weekdays`, `venue_types`, `meeting_ids`, `root_server_ids`, `format_ids`) use *positive* values to include and *negative* values to exclude. JSON Schema cannot enforce that semantics; it is documented per parameter. - **Cross-parameter constraints** — in aggregator mode `GetSearchResults` requires at least one filter parameter. Invalid combinations typically return an empty array `[]` instead of an HTTP error. - **Empty-array errors** — many endpoints return `[]` for invalid input rather than a 4xx response body.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface SemanticFormat
+ */
+export interface SemanticFormat {
+    [key: string]: any | any;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticFormat
+     */
+    keyString?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticFormat
+     */
+    nameString?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticFormat
+     */
+    descriptionString?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticFormat
+     */
+    lang?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticFormat
+     */
+    id?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticFormat
+     */
+    worldId?: string;
+    /**
+     * Aggregator mode only.
+     * @type {string}
+     * @memberof SemanticFormat
+     */
+    rootServerId?: string;
+    /**
+     * Aggregator mode only.
+     * @type {string}
+     * @memberof SemanticFormat
+     */
+    rootServerUri?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticFormat
+     */
+    formatTypeEnum?: string;
+}
+
+/**
+ * Check if a given object implements the SemanticFormat interface.
+ */
+export function instanceOfSemanticFormat(value: object): value is SemanticFormat {
+    return true;
+}
+
+export function SemanticFormatFromJSON(json: any): SemanticFormat {
+    return SemanticFormatFromJSONTyped(json, false);
+}
+
+export function SemanticFormatFromJSONTyped(json: any, ignoreDiscriminator: boolean): SemanticFormat {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+            ...json,
+        'keyString': json['key_string'] == null ? undefined : json['key_string'],
+        'nameString': json['name_string'] == null ? undefined : json['name_string'],
+        'descriptionString': json['description_string'] == null ? undefined : json['description_string'],
+        'lang': json['lang'] == null ? undefined : json['lang'],
+        'id': json['id'] == null ? undefined : json['id'],
+        'worldId': json['world_id'] == null ? undefined : json['world_id'],
+        'rootServerId': json['root_server_id'] == null ? undefined : json['root_server_id'],
+        'rootServerUri': json['root_server_uri'] == null ? undefined : json['root_server_uri'],
+        'formatTypeEnum': json['format_type_enum'] == null ? undefined : json['format_type_enum'],
+    };
+}
+
+export function SemanticFormatToJSON(json: any): SemanticFormat {
+    return SemanticFormatToJSONTyped(json, false);
+}
+
+export function SemanticFormatToJSONTyped(value?: SemanticFormat | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+            ...value,
+        'key_string': value['keyString'],
+        'name_string': value['nameString'],
+        'description_string': value['descriptionString'],
+        'lang': value['lang'],
+        'id': value['id'],
+        'world_id': value['worldId'],
+        'root_server_id': value['rootServerId'],
+        'root_server_uri': value['rootServerUri'],
+        'format_type_enum': value['formatTypeEnum'],
+    };
+}
+

package/src/models/SemanticMeeting.ts

@@ -0,0 +1,364 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * BMLT Semantic API
+ * OpenAPI description of the BMLT Semantic Interface (the read-only meeting-query API) for the JSON data format.  The semantic interface dispatches all operations from a single endpoint (`/client_interface/json/`) using a `switcher` query parameter. To keep each operation discoverable, this spec models each `switcher` value as a distinct path key with the query string baked in. Tools such as Swagger UI, Redoc, and openapi-generator handle these path keys correctly even though the OpenAPI spec technically expects unique URL paths.  ### Things that do not map cleanly onto OpenAPI  - **Sign-as-operator** — many filters (`formats`, `services`, `weekdays`, `venue_types`, `meeting_ids`, `root_server_ids`, `format_ids`) use *positive* values to include and *negative* values to exclude. JSON Schema cannot enforce that semantics; it is documented per parameter. - **Cross-parameter constraints** — in aggregator mode `GetSearchResults` requires at least one filter parameter. Invalid combinations typically return an empty array `[]` instead of an HTTP error. - **Empty-array errors** — many endpoints return `[]` for invalid input rather than a 4xx response body.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * A meeting record. The actual field set depends on the server's enabled fields and the `data_field_key` parameter.
+ * @export
+ * @interface SemanticMeeting
+ */
+export interface SemanticMeeting {
+    [key: string]: any | any;
+    /**
+     * Numeric meeting ID, returned as a string.
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    idBigint?: string;
+    /**
+     * NAWS world committee code.
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    worldidMixed?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    sharedGroupIdBigint?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    serviceBodyBigint?: string;
+    /**
+     * 1=Sunday … 7=Saturday.
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    weekdayTinyint?: string;
+    /**
+     * 1=In-person, 2=Virtual, 3=Hybrid.
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    venueType?: string;
+    /**
+     * Local start time, HH:MM:SS.
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    startTime?: string;
+    /**
+     * Duration, HH:MM:SS.
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    durationTime?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    timeZone?: string;
+    /**
+     * Comma-separated format key strings.
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    formats?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    langEnum?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    longitude?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    latitude?: string;
+    /**
+     * Present only when sorting by distance.
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    distanceInKm?: string;
+    /**
+     * Present only when sorting by distance.
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    distanceInMiles?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    meetingName?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    locationText?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    locationInfo?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    locationStreet?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    locationCitySubsection?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    locationNeighborhood?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    locationMunicipality?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    locationSubProvince?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    locationProvince?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    locationPostalCode1?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    locationNation?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    comments?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    trainLines?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    busLines?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    phoneMeetingNumber?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    virtualMeetingLink?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    virtualMeetingAdditionalInfo?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    contactName1?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    contactPhone1?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    contactEmail1?: string;
+    /**
+     * Aggregator mode only — ID of the root server this meeting came from.
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    rootServerId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    rootServerUri?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeeting
+     */
+    formatSharedIdList?: string;
+}
+
+/**
+ * Check if a given object implements the SemanticMeeting interface.
+ */
+export function instanceOfSemanticMeeting(value: object): value is SemanticMeeting {
+    return true;
+}
+
+export function SemanticMeetingFromJSON(json: any): SemanticMeeting {
+    return SemanticMeetingFromJSONTyped(json, false);
+}
+
+export function SemanticMeetingFromJSONTyped(json: any, ignoreDiscriminator: boolean): SemanticMeeting {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+            ...json,
+        'idBigint': json['id_bigint'] == null ? undefined : json['id_bigint'],
+        'worldidMixed': json['worldid_mixed'] == null ? undefined : json['worldid_mixed'],
+        'sharedGroupIdBigint': json['shared_group_id_bigint'] == null ? undefined : json['shared_group_id_bigint'],
+        'serviceBodyBigint': json['service_body_bigint'] == null ? undefined : json['service_body_bigint'],
+        'weekdayTinyint': json['weekday_tinyint'] == null ? undefined : json['weekday_tinyint'],
+        'venueType': json['venue_type'] == null ? undefined : json['venue_type'],
+        'startTime': json['start_time'] == null ? undefined : json['start_time'],
+        'durationTime': json['duration_time'] == null ? undefined : json['duration_time'],
+        'timeZone': json['time_zone'] == null ? undefined : json['time_zone'],
+        'formats': json['formats'] == null ? undefined : json['formats'],
+        'langEnum': json['lang_enum'] == null ? undefined : json['lang_enum'],
+        'longitude': json['longitude'] == null ? undefined : json['longitude'],
+        'latitude': json['latitude'] == null ? undefined : json['latitude'],
+        'distanceInKm': json['distance_in_km'] == null ? undefined : json['distance_in_km'],
+        'distanceInMiles': json['distance_in_miles'] == null ? undefined : json['distance_in_miles'],
+        'meetingName': json['meeting_name'] == null ? undefined : json['meeting_name'],
+        'locationText': json['location_text'] == null ? undefined : json['location_text'],
+        'locationInfo': json['location_info'] == null ? undefined : json['location_info'],
+        'locationStreet': json['location_street'] == null ? undefined : json['location_street'],
+        'locationCitySubsection': json['location_city_subsection'] == null ? undefined : json['location_city_subsection'],
+        'locationNeighborhood': json['location_neighborhood'] == null ? undefined : json['location_neighborhood'],
+        'locationMunicipality': json['location_municipality'] == null ? undefined : json['location_municipality'],
+        'locationSubProvince': json['location_sub_province'] == null ? undefined : json['location_sub_province'],
+        'locationProvince': json['location_province'] == null ? undefined : json['location_province'],
+        'locationPostalCode1': json['location_postal_code_1'] == null ? undefined : json['location_postal_code_1'],
+        'locationNation': json['location_nation'] == null ? undefined : json['location_nation'],
+        'comments': json['comments'] == null ? undefined : json['comments'],
+        'trainLines': json['train_lines'] == null ? undefined : json['train_lines'],
+        'busLines': json['bus_lines'] == null ? undefined : json['bus_lines'],
+        'phoneMeetingNumber': json['phone_meeting_number'] == null ? undefined : json['phone_meeting_number'],
+        'virtualMeetingLink': json['virtual_meeting_link'] == null ? undefined : json['virtual_meeting_link'],
+        'virtualMeetingAdditionalInfo': json['virtual_meeting_additional_info'] == null ? undefined : json['virtual_meeting_additional_info'],
+        'contactName1': json['contact_name_1'] == null ? undefined : json['contact_name_1'],
+        'contactPhone1': json['contact_phone_1'] == null ? undefined : json['contact_phone_1'],
+        'contactEmail1': json['contact_email_1'] == null ? undefined : json['contact_email_1'],
+        'rootServerId': json['root_server_id'] == null ? undefined : json['root_server_id'],
+        'rootServerUri': json['root_server_uri'] == null ? undefined : json['root_server_uri'],
+        'formatSharedIdList': json['format_shared_id_list'] == null ? undefined : json['format_shared_id_list'],
+    };
+}
+
+export function SemanticMeetingToJSON(json: any): SemanticMeeting {
+    return SemanticMeetingToJSONTyped(json, false);
+}
+
+export function SemanticMeetingToJSONTyped(value?: SemanticMeeting | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+            ...value,
+        'id_bigint': value['idBigint'],
+        'worldid_mixed': value['worldidMixed'],
+        'shared_group_id_bigint': value['sharedGroupIdBigint'],
+        'service_body_bigint': value['serviceBodyBigint'],
+        'weekday_tinyint': value['weekdayTinyint'],
+        'venue_type': value['venueType'],
+        'start_time': value['startTime'],
+        'duration_time': value['durationTime'],
+        'time_zone': value['timeZone'],
+        'formats': value['formats'],
+        'lang_enum': value['langEnum'],
+        'longitude': value['longitude'],
+        'latitude': value['latitude'],
+        'distance_in_km': value['distanceInKm'],
+        'distance_in_miles': value['distanceInMiles'],
+        'meeting_name': value['meetingName'],
+        'location_text': value['locationText'],
+        'location_info': value['locationInfo'],
+        'location_street': value['locationStreet'],
+        'location_city_subsection': value['locationCitySubsection'],
+        'location_neighborhood': value['locationNeighborhood'],
+        'location_municipality': value['locationMunicipality'],
+        'location_sub_province': value['locationSubProvince'],
+        'location_province': value['locationProvince'],
+        'location_postal_code_1': value['locationPostalCode1'],
+        'location_nation': value['locationNation'],
+        'comments': value['comments'],
+        'train_lines': value['trainLines'],
+        'bus_lines': value['busLines'],
+        'phone_meeting_number': value['phoneMeetingNumber'],
+        'virtual_meeting_link': value['virtualMeetingLink'],
+        'virtual_meeting_additional_info': value['virtualMeetingAdditionalInfo'],
+        'contact_name_1': value['contactName1'],
+        'contact_phone_1': value['contactPhone1'],
+        'contact_email_1': value['contactEmail1'],
+        'root_server_id': value['rootServerId'],
+        'root_server_uri': value['rootServerUri'],
+        'format_shared_id_list': value['formatSharedIdList'],
+    };
+}
+

package/src/models/SemanticMeetingChange.ts

@@ -0,0 +1,140 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * BMLT Semantic API
+ * OpenAPI description of the BMLT Semantic Interface (the read-only meeting-query API) for the JSON data format.  The semantic interface dispatches all operations from a single endpoint (`/client_interface/json/`) using a `switcher` query parameter. To keep each operation discoverable, this spec models each `switcher` value as a distinct path key with the query string baked in. Tools such as Swagger UI, Redoc, and openapi-generator handle these path keys correctly even though the OpenAPI spec technically expects unique URL paths.  ### Things that do not map cleanly onto OpenAPI  - **Sign-as-operator** — many filters (`formats`, `services`, `weekdays`, `venue_types`, `meeting_ids`, `root_server_ids`, `format_ids`) use *positive* values to include and *negative* values to exclude. JSON Schema cannot enforce that semantics; it is documented per parameter. - **Cross-parameter constraints** — in aggregator mode `GetSearchResults` requires at least one filter parameter. Invalid combinations typically return an empty array `[]` instead of an HTTP error. - **Empty-array errors** — many endpoints return `[]` for invalid input rather than a 4xx response body.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface SemanticMeetingChange
+ */
+export interface SemanticMeetingChange {
+    [key: string]: any | any;
+    /**
+     * Unix timestamp of the change.
+     * @type {string}
+     * @memberof SemanticMeetingChange
+     */
+    dateInt?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeetingChange
+     */
+    dateString?: string;
+    /**
+     * e.g. comdef_change_type_change, comdef_change_type_new, comdef_change_type_delete.
+     * @type {string}
+     * @memberof SemanticMeetingChange
+     */
+    changeType?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeetingChange
+     */
+    meetingId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeetingChange
+     */
+    meetingName?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeetingChange
+     */
+    userId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeetingChange
+     */
+    userName?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeetingChange
+     */
+    serviceBodyId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof SemanticMeetingChange
+     */
+    serviceBodyName?: string;
+    /**
+     * Per-field before/after values for change events.
+     * @type {{ [key: string]: any; }}
+     * @memberof SemanticMeetingChange
+     */
+    details?: { [key: string]: any; };
+}
+
+/**
+ * Check if a given object implements the SemanticMeetingChange interface.
+ */
+export function instanceOfSemanticMeetingChange(value: object): value is SemanticMeetingChange {
+    return true;
+}
+
+export function SemanticMeetingChangeFromJSON(json: any): SemanticMeetingChange {
+    return SemanticMeetingChangeFromJSONTyped(json, false);
+}
+
+export function SemanticMeetingChangeFromJSONTyped(json: any, ignoreDiscriminator: boolean): SemanticMeetingChange {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+            ...json,
+        'dateInt': json['date_int'] == null ? undefined : json['date_int'],
+        'dateString': json['date_string'] == null ? undefined : json['date_string'],
+        'changeType': json['change_type'] == null ? undefined : json['change_type'],
+        'meetingId': json['meeting_id'] == null ? undefined : json['meeting_id'],
+        'meetingName': json['meeting_name'] == null ? undefined : json['meeting_name'],
+        'userId': json['user_id'] == null ? undefined : json['user_id'],
+        'userName': json['user_name'] == null ? undefined : json['user_name'],
+        'serviceBodyId': json['service_body_id'] == null ? undefined : json['service_body_id'],
+        'serviceBodyName': json['service_body_name'] == null ? undefined : json['service_body_name'],
+        'details': json['details'] == null ? undefined : json['details'],
+    };
+}
+
+export function SemanticMeetingChangeToJSON(json: any): SemanticMeetingChange {
+    return SemanticMeetingChangeToJSONTyped(json, false);
+}
+
+export function SemanticMeetingChangeToJSONTyped(value?: SemanticMeetingChange | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+            ...value,
+        'date_int': value['dateInt'],
+        'date_string': value['dateString'],
+        'change_type': value['changeType'],
+        'meeting_id': value['meetingId'],
+        'meeting_name': value['meetingName'],
+        'user_id': value['userId'],
+        'user_name': value['userName'],
+        'service_body_id': value['serviceBodyId'],
+        'service_body_name': value['serviceBodyName'],
+        'details': value['details'],
+    };
+}
+