@ringer-tel/telique/teliport/src/apis/SOAOperationsSoaOperationsControllerApi.ts

TypeScript SDK for Ringer APIs

/* tslint:disable */
/* eslint-disable */
/**
 * Ringer Portability API
 * Service Order Acceptance (SOA) API for Local Number Portability (LNP) operations.  This API provides comprehensive functionality for managing telephone number porting operations including: - Port request creation and management - Number activation and disconnection - Conflict resolution - LRN (Location Routing Number) management - Real-time status queries - Event management and notifications  Authentication: Bearer token required for all endpoints
 *
 * The version of the OpenAPI document: 1.0.0
 * Contact: api-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';

export interface ActivatePortRequest {
    requestBody: { [key: string]: object; };
}

export interface CreateConflict1Request {
    requestBody: { [key: string]: object; };
}

export interface CreateNpanxxRequest {
    requestBody: { [key: string]: object; };
}

export interface CreatePortRequest {
    requestBody: { [key: string]: object; };
}

export interface GetActivationReadyRequest {
    requestBody: { [key: string]: object; };
}

export interface GetSpid1Request {
    tn: string;
}

export interface GetStatus1Request {
    tn: string;
}

export interface IntraSpRequest {
    requestBody: { [key: string]: object; };
}

export interface QueryPortRequest {
    requestBody: { [key: string]: object; };
}

export interface ReleasePortRequest {
    requestBody: { [key: string]: object; };
}

export interface RemoveConflict1Request {
    requestBody: { [key: string]: object; };
}

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

    /**
     */
    async activatePortRaw(requestParameters: ActivatePortRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{ [key: string]: object; }>> {
        if (requestParameters['requestBody'] == null) {
            throw new runtime.RequiredError(
                'requestBody',
                'Required parameter "requestBody" was null or undefined when calling activatePort().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

        const response = await this.request({
            path: `/api/v1/soa/activate`,
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: requestParameters['requestBody'],
        }, initOverrides);

        return new runtime.JSONApiResponse<any>(response);
    }

    /**
     */
    async activatePort(requestParameters: ActivatePortRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{ [key: string]: object; }> {
        const response = await this.activatePortRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     */
    async createConflict1Raw(requestParameters: CreateConflict1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{ [key: string]: object; }>> {
        if (requestParameters['requestBody'] == null) {
            throw new runtime.RequiredError(
                'requestBody',
                'Required parameter "requestBody" was null or undefined when calling createConflict1().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

        const response = await this.request({
            path: `/api/v1/soa/conflictcreate`,
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: requestParameters['requestBody'],
        }, initOverrides);

        return new runtime.JSONApiResponse<any>(response);
    }

    /**
     */
    async createConflict1(requestParameters: CreateConflict1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{ [key: string]: object; }> {
        const response = await this.createConflict1Raw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     */
    async createNpanxxRaw(requestParameters: CreateNpanxxRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{ [key: string]: object; }>> {
        if (requestParameters['requestBody'] == null) {
            throw new runtime.RequiredError(
                'requestBody',
                'Required parameter "requestBody" was null or undefined when calling createNpanxx().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

        const response = await this.request({
            path: `/api/v1/soa/npanxxcreate`,
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: requestParameters['requestBody'],
        }, initOverrides);

        return new runtime.JSONApiResponse<any>(response);
    }

    /**
     */
    async createNpanxx(requestParameters: CreateNpanxxRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{ [key: string]: object; }> {
        const response = await this.createNpanxxRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     */
    async createPortRaw(requestParameters: CreatePortRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{ [key: string]: object; }>> {
        if (requestParameters['requestBody'] == null) {
            throw new runtime.RequiredError(
                'requestBody',
                'Required parameter "requestBody" was null or undefined when calling createPort().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

        const response = await this.request({
            path: `/api/v1/soa/create`,
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: requestParameters['requestBody'],
        }, initOverrides);

        return new runtime.JSONApiResponse<any>(response);
    }

    /**
     */
    async createPort(requestParameters: CreatePortRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{ [key: string]: object; }> {
        const response = await this.createPortRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     */
    async getActivationReadyRaw(requestParameters: GetActivationReadyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{ [key: string]: object; }>> {
        if (requestParameters['requestBody'] == null) {
            throw new runtime.RequiredError(
                'requestBody',
                'Required parameter "requestBody" was null or undefined when calling getActivationReady().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

        const response = await this.request({
            path: `/api/v1/soa/actreadyget`,
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: requestParameters['requestBody'],
        }, initOverrides);

        return new runtime.JSONApiResponse<any>(response);
    }

    /**
     */
    async getActivationReady(requestParameters: GetActivationReadyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{ [key: string]: object; }> {
        const response = await this.getActivationReadyRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     */
    async getSpid1Raw(requestParameters: GetSpid1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{ [key: string]: object; }>> {
        if (requestParameters['tn'] == null) {
            throw new runtime.RequiredError(
                'tn',
                'Required parameter "tn" was null or undefined when calling getSpid1().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

        return new runtime.JSONApiResponse<any>(response);
    }

    /**
     */
    async getSpid1(requestParameters: GetSpid1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{ [key: string]: object; }> {
        const response = await this.getSpid1Raw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     */
    async getStatus1Raw(requestParameters: GetStatus1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{ [key: string]: object; }>> {
        if (requestParameters['tn'] == null) {
            throw new runtime.RequiredError(
                'tn',
                'Required parameter "tn" was null or undefined when calling getStatus1().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

        return new runtime.JSONApiResponse<any>(response);
    }

    /**
     */
    async getStatus1(requestParameters: GetStatus1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{ [key: string]: object; }> {
        const response = await this.getStatus1Raw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     */
    async intraSpRaw(requestParameters: IntraSpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{ [key: string]: object; }>> {
        if (requestParameters['requestBody'] == null) {
            throw new runtime.RequiredError(
                'requestBody',
                'Required parameter "requestBody" was null or undefined when calling intraSp().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

        const response = await this.request({
            path: `/api/v1/soa/intrasp`,
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: requestParameters['requestBody'],
        }, initOverrides);

        return new runtime.JSONApiResponse<any>(response);
    }

    /**
     */
    async intraSp(requestParameters: IntraSpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{ [key: string]: object; }> {
        const response = await this.intraSpRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     */
    async queryPortRaw(requestParameters: QueryPortRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{ [key: string]: object; }>> {
        if (requestParameters['requestBody'] == null) {
            throw new runtime.RequiredError(
                'requestBody',
                'Required parameter "requestBody" was null or undefined when calling queryPort().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

        const response = await this.request({
            path: `/api/v1/soa/query`,
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: requestParameters['requestBody'],
        }, initOverrides);

        return new runtime.JSONApiResponse<any>(response);
    }

    /**
     */
    async queryPort(requestParameters: QueryPortRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{ [key: string]: object; }> {
        const response = await this.queryPortRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     */
    async releasePortRaw(requestParameters: ReleasePortRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{ [key: string]: object; }>> {
        if (requestParameters['requestBody'] == null) {
            throw new runtime.RequiredError(
                'requestBody',
                'Required parameter "requestBody" was null or undefined when calling releasePort().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

        const response = await this.request({
            path: `/api/v1/soa/release`,
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: requestParameters['requestBody'],
        }, initOverrides);

        return new runtime.JSONApiResponse<any>(response);
    }

    /**
     */
    async releasePort(requestParameters: ReleasePortRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{ [key: string]: object; }> {
        const response = await this.releasePortRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     */
    async removeConflict1Raw(requestParameters: RemoveConflict1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{ [key: string]: object; }>> {
        if (requestParameters['requestBody'] == null) {
            throw new runtime.RequiredError(
                'requestBody',
                'Required parameter "requestBody" was null or undefined when calling removeConflict1().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

        const response = await this.request({
            path: `/api/v1/soa/conflictremove`,
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: requestParameters['requestBody'],
        }, initOverrides);

        return new runtime.JSONApiResponse<any>(response);
    }

    /**
     */
    async removeConflict1(requestParameters: RemoveConflict1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{ [key: string]: object; }> {
        const response = await this.removeConflict1Raw(requestParameters, initOverrides);
        return await response.value();
    }

}