@ringer-tel/telique
Version:
TypeScript SDK for Ringer APIs
83 lines (72 loc) • 2.45 kB
text/typescript
/* 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 { mapValues } from '../runtime';
/**
*
* @export
* @interface CICResponse
*/
export interface CICResponse {
/**
* Carrier Identification Code
* @type {string}
* @memberof CICResponse
*/
carrier: string;
/**
* Additional data from the interpretation
* @type {object}
* @memberof CICResponse
*/
data?: object;
/**
* Interpretation result data structure
* @type {object}
* @memberof CICResponse
*/
ir?: object;
}
/**
* Check if a given object implements the CICResponse interface.
*/
export function instanceOfCICResponse(value: object): value is CICResponse {
if (!('carrier' in value) || value['carrier'] === undefined) return false;
return true;
}
export function CICResponseFromJSON(json: any): CICResponse {
return CICResponseFromJSONTyped(json, false);
}
export function CICResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): CICResponse {
if (json == null) {
return json;
}
return {
'carrier': json['carrier'],
'data': json['data'] == null ? undefined : json['data'],
'ir': json['ir'] == null ? undefined : json['ir'],
};
}
export function CICResponseToJSON(json: any): CICResponse {
return CICResponseToJSONTyped(json, false);
}
export function CICResponseToJSONTyped(value?: CICResponse | null, ignoreDiscriminator: boolean = false): any {
if (value == null) {
return value;
}
return {
'carrier': value['carrier'],
'data': value['data'],
'ir': value['ir'],
};
}