@ringer-tel/ivy/src/apis/SiteFeaturesE911Api.ts

TypeScript SDK for Ringer APIs

/* tslint:disable */
/* eslint-disable */
/**
 * Ringer Business API
 * This API provides comprehensive endpoints for the Ringer Business system. It includes functionality for managing customer accounts, addresses, sites, phone numbers, payments, users, and other business resources.  Operations typically require authentication and appropriate permissions. 
 *
 * The version of the OpenAPI document: 1.0.6
 * Contact: support@ringer.tel
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */


import * as runtime from '../runtime';
import type {
  E911ListResponse,
  E911Response,
  E911UpdateRequest,
} from '../models/index';
import {
    E911ListResponseFromJSON,
    E911ListResponseToJSON,
    E911ResponseFromJSON,
    E911ResponseToJSON,
    E911UpdateRequestFromJSON,
    E911UpdateRequestToJSON,
} from '../models/index';

export interface DeleteSiteE911RecordByIdRequest {
    siteId: number;
    id: number;
}

export interface GetSiteE911RecordByIdRequest {
    siteId: number;
    id: number;
}

export interface ListSiteE911RecordsRequest {
    siteId: number;
}

export interface UpdateSiteE911RecordByIdRequest {
    siteId: number;
    id: number;
    e911UpdateRequest: E911UpdateRequest;
}

/**
 * 
 */
export class SiteFeaturesE911Api extends runtime.BaseAPI {

    /**
     * Deletes a specific E911 record. This action may also unregister the associated address from emergency services. Ensure no phone numbers or devices are solely reliant on this E911 record for emergency calling. 
     * Delete E911 Record
     */
    async deleteSiteE911RecordByIdRaw(requestParameters: DeleteSiteE911RecordByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
        if (requestParameters['siteId'] == null) {
            throw new runtime.RequiredError(
                'siteId',
                'Required parameter "siteId" was null or undefined when calling deleteSiteE911RecordById().'
            );
        }

        if (requestParameters['id'] == null) {
            throw new runtime.RequiredError(
                'id',
                'Required parameter "id" was null or undefined when calling deleteSiteE911RecordById().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

        if (this.configuration && this.configuration.accessToken) {
            // oauth required
            headerParameters["Authorization"] = await this.configuration.accessToken("oAuth2", []);
        }

        const response = await this.request({
            path: `/sites/{site_id}/e911s/{id}`.replace(`{${"site_id"}}`, encodeURIComponent(String(requestParameters['siteId']))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
            method: 'DELETE',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

        return new runtime.VoidApiResponse(response);
    }

    /**
     * Deletes a specific E911 record. This action may also unregister the associated address from emergency services. Ensure no phone numbers or devices are solely reliant on this E911 record for emergency calling. 
     * Delete E911 Record
     */
    async deleteSiteE911RecordById(requestParameters: DeleteSiteE911RecordByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
        await this.deleteSiteE911RecordByIdRaw(requestParameters, initOverrides);
    }

    /**
     * Retrieves detailed information for a specific E911 record by its ID, belonging to the specified site.
     * Get E911 Record Details
     */
    async getSiteE911RecordByIdRaw(requestParameters: GetSiteE911RecordByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<E911Response>> {
        if (requestParameters['siteId'] == null) {
            throw new runtime.RequiredError(
                'siteId',
                'Required parameter "siteId" was null or undefined when calling getSiteE911RecordById().'
            );
        }

        if (requestParameters['id'] == null) {
            throw new runtime.RequiredError(
                'id',
                'Required parameter "id" was null or undefined when calling getSiteE911RecordById().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

        if (this.configuration && this.configuration.accessToken) {
            // oauth required
            headerParameters["Authorization"] = await this.configuration.accessToken("oAuth2", []);
        }

        const response = await this.request({
            path: `/sites/{site_id}/e911s/{id}`.replace(`{${"site_id"}}`, encodeURIComponent(String(requestParameters['siteId']))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

        return new runtime.JSONApiResponse(response, (jsonValue) => E911ResponseFromJSON(jsonValue));
    }

    /**
     * Retrieves detailed information for a specific E911 record by its ID, belonging to the specified site.
     * Get E911 Record Details
     */
    async getSiteE911RecordById(requestParameters: GetSiteE911RecordByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<E911Response> {
        const response = await this.getSiteE911RecordByIdRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Retrieves a list of all E911 records (validated emergency addresses) associated with the specified site.
     * List E911 Records for a Site
     */
    async listSiteE911RecordsRaw(requestParameters: ListSiteE911RecordsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<E911ListResponse>> {
        if (requestParameters['siteId'] == null) {
            throw new runtime.RequiredError(
                'siteId',
                'Required parameter "siteId" was null or undefined when calling listSiteE911Records().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

        if (this.configuration && this.configuration.accessToken) {
            // oauth required
            headerParameters["Authorization"] = await this.configuration.accessToken("oAuth2", []);
        }

        const response = await this.request({
            path: `/sites/{site_id}/e911s`.replace(`{${"site_id"}}`, encodeURIComponent(String(requestParameters['siteId']))),
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

        return new runtime.JSONApiResponse(response, (jsonValue) => E911ListResponseFromJSON(jsonValue));
    }

    /**
     * Retrieves a list of all E911 records (validated emergency addresses) associated with the specified site.
     * List E911 Records for a Site
     */
    async listSiteE911Records(requestParameters: ListSiteE911RecordsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<E911ListResponse> {
        const response = await this.listSiteE911RecordsRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Updates the details of an existing E911 record. This typically involves providing address information for validation with emergency services. 
     * Update E911 Record
     */
    async updateSiteE911RecordByIdRaw(requestParameters: UpdateSiteE911RecordByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<E911Response>> {
        if (requestParameters['siteId'] == null) {
            throw new runtime.RequiredError(
                'siteId',
                'Required parameter "siteId" was null or undefined when calling updateSiteE911RecordById().'
            );
        }

        if (requestParameters['id'] == null) {
            throw new runtime.RequiredError(
                'id',
                'Required parameter "id" was null or undefined when calling updateSiteE911RecordById().'
            );
        }

        if (requestParameters['e911UpdateRequest'] == null) {
            throw new runtime.RequiredError(
                'e911UpdateRequest',
                'Required parameter "e911UpdateRequest" was null or undefined when calling updateSiteE911RecordById().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

        headerParameters['Content-Type'] = 'application/json';

        if (this.configuration && this.configuration.accessToken) {
            // oauth required
            headerParameters["Authorization"] = await this.configuration.accessToken("oAuth2", []);
        }

        const response = await this.request({
            path: `/sites/{site_id}/e911s/{id}`.replace(`{${"site_id"}}`, encodeURIComponent(String(requestParameters['siteId']))).replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id']))),
            method: 'PUT',
            headers: headerParameters,
            query: queryParameters,
            body: E911UpdateRequestToJSON(requestParameters['e911UpdateRequest']),
        }, initOverrides);

        return new runtime.JSONApiResponse(response, (jsonValue) => E911ResponseFromJSON(jsonValue));
    }

    /**
     * Updates the details of an existing E911 record. This typically involves providing address information for validation with emergency services. 
     * Update E911 Record
     */
    async updateSiteE911RecordById(requestParameters: UpdateSiteE911RecordByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<E911Response> {
        const response = await this.updateSiteE911RecordByIdRaw(requestParameters, initOverrides);
        return await response.value();
    }

}