bmlt-server-semantic-client 1.0.0

package/src/models/Meeting.ts

@@ -0,0 +1,364 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * BMLT Semantic API
+ * OpenAPI description of the Basic Meeting List Toolbox (BMLT) Semantic Interface 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  - **PHP array syntax** — repeatable array parameters use trailing `[]` in the name (`weekdays[]=2&weekdays[]=3`). The parameter names in this spec preserve the brackets so generated clients emit them. - **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 Meeting
+ */
+export interface Meeting {
+    [key: string]: any | any;
+    /**
+     * Numeric meeting ID, returned as a string.
+     * @type {string}
+     * @memberof Meeting
+     */
+    idBigint?: string;
+    /**
+     * NAWS world committee code.
+     * @type {string}
+     * @memberof Meeting
+     */
+    worldidMixed?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    sharedGroupIdBigint?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    serviceBodyBigint?: string;
+    /**
+     * 1=Sunday … 7=Saturday.
+     * @type {string}
+     * @memberof Meeting
+     */
+    weekdayTinyint?: string;
+    /**
+     * 1=In-person, 2=Virtual, 3=Hybrid.
+     * @type {string}
+     * @memberof Meeting
+     */
+    venueType?: string;
+    /**
+     * Local start time, HH:MM:SS.
+     * @type {string}
+     * @memberof Meeting
+     */
+    startTime?: string;
+    /**
+     * Duration, HH:MM:SS.
+     * @type {string}
+     * @memberof Meeting
+     */
+    durationTime?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    timeZone?: string;
+    /**
+     * Comma-separated format key strings.
+     * @type {string}
+     * @memberof Meeting
+     */
+    formats?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    langEnum?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    longitude?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    latitude?: string;
+    /**
+     * Present only when sorting by distance.
+     * @type {string}
+     * @memberof Meeting
+     */
+    distanceInKm?: string;
+    /**
+     * Present only when sorting by distance.
+     * @type {string}
+     * @memberof Meeting
+     */
+    distanceInMiles?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    meetingName?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    locationText?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    locationInfo?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    locationStreet?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    locationCitySubsection?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    locationNeighborhood?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    locationMunicipality?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    locationSubProvince?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    locationProvince?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    locationPostalCode1?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    locationNation?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    comments?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    trainLines?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    busLines?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    phoneMeetingNumber?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    virtualMeetingLink?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    virtualMeetingAdditionalInfo?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    contactName1?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    contactPhone1?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    contactEmail1?: string;
+    /**
+     * Aggregator mode only — ID of the root server this meeting came from.
+     * @type {string}
+     * @memberof Meeting
+     */
+    rootServerId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    rootServerUri?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof Meeting
+     */
+    formatSharedIdList?: string;
+}
+
+/**
+ * Check if a given object implements the Meeting interface.
+ */
+export function instanceOfMeeting(value: object): value is Meeting {
+    return true;
+}
+
+export function MeetingFromJSON(json: any): Meeting {
+    return MeetingFromJSONTyped(json, false);
+}
+
+export function MeetingFromJSONTyped(json: any, ignoreDiscriminator: boolean): Meeting {
+    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 MeetingToJSON(json: any): Meeting {
+    return MeetingToJSONTyped(json, false);
+}
+
+export function MeetingToJSONTyped(value?: Meeting | 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/MeetingChange.ts

@@ -0,0 +1,140 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * BMLT Semantic API
+ * OpenAPI description of the Basic Meeting List Toolbox (BMLT) Semantic Interface 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  - **PHP array syntax** — repeatable array parameters use trailing `[]` in the name (`weekdays[]=2&weekdays[]=3`). The parameter names in this spec preserve the brackets so generated clients emit them. - **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 MeetingChange
+ */
+export interface MeetingChange {
+    [key: string]: any | any;
+    /**
+     * Unix timestamp of the change.
+     * @type {string}
+     * @memberof MeetingChange
+     */
+    dateInt?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof MeetingChange
+     */
+    dateString?: string;
+    /**
+     * e.g. comdef_change_type_change, comdef_change_type_new, comdef_change_type_delete.
+     * @type {string}
+     * @memberof MeetingChange
+     */
+    changeType?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof MeetingChange
+     */
+    meetingId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof MeetingChange
+     */
+    meetingName?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof MeetingChange
+     */
+    userId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof MeetingChange
+     */
+    userName?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof MeetingChange
+     */
+    serviceBodyId?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof MeetingChange
+     */
+    serviceBodyName?: string;
+    /**
+     * Per-field before/after values for change events.
+     * @type {{ [key: string]: any; }}
+     * @memberof MeetingChange
+     */
+    details?: { [key: string]: any; };
+}
+
+/**
+ * Check if a given object implements the MeetingChange interface.
+ */
+export function instanceOfMeetingChange(value: object): value is MeetingChange {
+    return true;
+}
+
+export function MeetingChangeFromJSON(json: any): MeetingChange {
+    return MeetingChangeFromJSONTyped(json, false);
+}
+
+export function MeetingChangeFromJSONTyped(json: any, ignoreDiscriminator: boolean): MeetingChange {
+    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 MeetingChangeToJSON(json: any): MeetingChange {
+    return MeetingChangeToJSONTyped(json, false);
+}
+
+export function MeetingChangeToJSONTyped(value?: MeetingChange | 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'],
+    };
+}
+

package/src/models/ModelError.ts

@@ -0,0 +1,68 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * BMLT Semantic API
+ * OpenAPI description of the Basic Meeting List Toolbox (BMLT) Semantic Interface 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  - **PHP array syntax** — repeatable array parameters use trailing `[]` in the name (`weekdays[]=2&weekdays[]=3`). The parameter names in this spec preserve the brackets so generated clients emit them. - **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 ModelError
+ */
+export interface ModelError {
+    [key: string]: any | any;
+    /**
+     * Human-readable error message.
+     * @type {string}
+     * @memberof ModelError
+     */
+    error?: string;
+}
+
+/**
+ * Check if a given object implements the ModelError interface.
+ */
+export function instanceOfModelError(value: object): value is ModelError {
+    return true;
+}
+
+export function ModelErrorFromJSON(json: any): ModelError {
+    return ModelErrorFromJSONTyped(json, false);
+}
+
+export function ModelErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): ModelError {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+            ...json,
+        'error': json['error'] == null ? undefined : json['error'],
+    };
+}
+
+export function ModelErrorToJSON(json: any): ModelError {
+    return ModelErrorToJSONTyped(json, false);
+}
+
+export function ModelErrorToJSONTyped(value?: ModelError | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+            ...value,
+        'error': value['error'],
+    };
+}
+

package/src/models/SemanticError.ts

@@ -0,0 +1,68 @@
+/* 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 SemanticError
+ */
+export interface SemanticError {
+    [key: string]: any | any;
+    /**
+     * Human-readable error message.
+     * @type {string}
+     * @memberof SemanticError
+     */
+    error?: string;
+}
+
+/**
+ * Check if a given object implements the SemanticError interface.
+ */
+export function instanceOfSemanticError(value: object): value is SemanticError {
+    return true;
+}
+
+export function SemanticErrorFromJSON(json: any): SemanticError {
+    return SemanticErrorFromJSONTyped(json, false);
+}
+
+export function SemanticErrorFromJSONTyped(json: any, ignoreDiscriminator: boolean): SemanticError {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+            ...json,
+        'error': json['error'] == null ? undefined : json['error'],
+    };
+}
+
+export function SemanticErrorToJSON(json: any): SemanticError {
+    return SemanticErrorToJSONTyped(json, false);
+}
+
+export function SemanticErrorToJSONTyped(value?: SemanticError | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+            ...value,
+        'error': value['error'],
+    };
+}
+