@ringer-tel/telique/src/apis/CNAMApi.ts

TypeScript SDK for Ringer APIs

/* tslint:disable */
/* eslint-disable */
/**
 * Telique API
 * The Ringer Telique API provides access to telecommunications data,  including caller name (CNAM) data, line type information, and more.  The API also includes services for checking phone numbers against  Do Not Originate (DNO) and Do Not Call (DNC) databases, as well as  STIR/SHAKEN call authentication validation.  ## Authentication This API uses IP whitelist authentication. Your server\'s IP address must be registered with Ringer before making API calls. Contact support@ringer.tel to register your IP address. 
 *
 * The version of the OpenAPI document: 1.0.18
 * 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 {
  CNAMResponse,
} from '../models/index';
import {
    CNAMResponseFromJSON,
    CNAMResponseToJSON,
} from '../models/index';

export interface GetCNAMRequest {
    phoneNumber: string;
}

export interface PostCNAMRequest {
    number: string;
}

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

    /**
     * Retrieve Caller Name (CNAM) information for a phone number. This endpoint performs a CNAM (Caller Name) lookup for a specified phone number. It first checks the database cache for existing records, and if not found, performs an SS7 network lookup to retrieve the caller name information. 
     * CNAM Lookup
     */
    async getCNAMRaw(requestParameters: GetCNAMRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CNAMResponse>> {
        if (requestParameters['phoneNumber'] == null) {
            throw new runtime.RequiredError(
                'phoneNumber',
                'Required parameter "phoneNumber" was null or undefined when calling getCNAM().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

        if (this.configuration && this.configuration.apiKey) {
            headerParameters["X-Forwarded-For"] = await this.configuration.apiKey("X-Forwarded-For"); // ipWhitelist authentication
        }

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

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

    /**
     * Retrieve Caller Name (CNAM) information for a phone number. This endpoint performs a CNAM (Caller Name) lookup for a specified phone number. It first checks the database cache for existing records, and if not found, performs an SS7 network lookup to retrieve the caller name information. 
     * CNAM Lookup
     */
    async getCNAM(requestParameters: GetCNAMRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CNAMResponse> {
        const response = await this.getCNAMRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Alternative method to perform a CNAM lookup using a POST request with form data. 
     * CNAM Lookup (POST)
     */
    async postCNAMRaw(requestParameters: PostCNAMRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CNAMResponse>> {
        if (requestParameters['number'] == null) {
            throw new runtime.RequiredError(
                'number',
                'Required parameter "number" was null or undefined when calling postCNAM().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

        if (this.configuration && this.configuration.apiKey) {
            headerParameters["X-Forwarded-For"] = await this.configuration.apiKey("X-Forwarded-For"); // ipWhitelist authentication
        }

        const consumes: runtime.Consume[] = [
            { contentType: 'application/x-www-form-urlencoded' },
        ];
        // @ts-ignore: canConsumeForm may be unused
        const canConsumeForm = runtime.canConsumeForm(consumes);

        let formParams: { append(param: string, value: any): any };
        let useForm = false;
        if (useForm) {
            formParams = new FormData();
        } else {
            formParams = new URLSearchParams();
        }

        if (requestParameters['number'] != null) {
            formParams.append('number', requestParameters['number'] as any);
        }

        const response = await this.request({
            path: `/telique/cnam`,
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: formParams,
        }, initOverrides);

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

    /**
     * Alternative method to perform a CNAM lookup using a POST request with form data. 
     * CNAM Lookup (POST)
     */
    async postCNAM(requestParameters: PostCNAMRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CNAMResponse> {
        const response = await this.postCNAMRaw(requestParameters, initOverrides);
        return await response.value();
    }

}