@ringer-tel/telique/teliport/src/apis/SOAOperationsSOAOperationsApi.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';
import type {
  SoaActReadyResponse,
  SoaActivateRequest,
  SoaCancelRequest,
  SoaConflictCreateRequest,
  SoaConflictRemoveRequest,
  SoaCreateRequest,
  SoaDisconnectRequest,
  SoaEventsResponse,
  SoaLrnCreateRequest,
  SoaLrnRemoveRequest,
  SoaQueryResponse,
  SoaReleaseRequest,
  SoaResponse,
  SoaSpidResponse,
  SoaStatusResponse,
} from '../models/index';
import {
    SoaActReadyResponseFromJSON,
    SoaActReadyResponseToJSON,
    SoaActivateRequestFromJSON,
    SoaActivateRequestToJSON,
    SoaCancelRequestFromJSON,
    SoaCancelRequestToJSON,
    SoaConflictCreateRequestFromJSON,
    SoaConflictCreateRequestToJSON,
    SoaConflictRemoveRequestFromJSON,
    SoaConflictRemoveRequestToJSON,
    SoaCreateRequestFromJSON,
    SoaCreateRequestToJSON,
    SoaDisconnectRequestFromJSON,
    SoaDisconnectRequestToJSON,
    SoaEventsResponseFromJSON,
    SoaEventsResponseToJSON,
    SoaLrnCreateRequestFromJSON,
    SoaLrnCreateRequestToJSON,
    SoaLrnRemoveRequestFromJSON,
    SoaLrnRemoveRequestToJSON,
    SoaQueryResponseFromJSON,
    SoaQueryResponseToJSON,
    SoaReleaseRequestFromJSON,
    SoaReleaseRequestToJSON,
    SoaResponseFromJSON,
    SoaResponseToJSON,
    SoaSpidResponseFromJSON,
    SoaSpidResponseToJSON,
    SoaStatusResponseFromJSON,
    SoaStatusResponseToJSON,
} from '../models/index';

export interface AcknowledgeEventRequest {
    recno: number;
}

export interface ActivateRequest {
    body: SoaActivateRequest;
}

export interface CancelRequest {
    body: SoaCancelRequest;
}

export interface CreateRequest {
    body: SoaCreateRequest;
}

export interface CreateConflictRequest {
    body: SoaConflictCreateRequest;
}

export interface CreateLrnRequest {
    body: SoaLrnCreateRequest;
}

export interface DisconnectRequest {
    body: SoaDisconnectRequest;
}

export interface GetActivationReady1Request {
    newspid: string;
}

export interface GetSpidRequest {
    tn: string;
}

export interface GetStatusRequest {
    tn: string;
}

export interface QueryRequest {
    tn: string;
    newspid?: string;
    region?: string;
}

export interface ReleaseRequest {
    body: SoaReleaseRequest;
}

export interface RemoveConflictRequest {
    body: SoaConflictRemoveRequest;
}

export interface RemoveLrnRequest {
    body: SoaLrnRemoveRequest;
}

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

    /**
     * Acknowledges a specific SOA event by record number
     * Acknowledge an event
     */
    async acknowledgeEventRaw(requestParameters: AcknowledgeEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SoaResponse>> {
        if (requestParameters['recno'] == null) {
            throw new runtime.RequiredError(
                'recno',
                'Required parameter "recno" was null or undefined when calling acknowledgeEvent().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

        const response = await this.request({
            path: `/v1/lnp/soa/events/{recno}/acknowledge`.replace(`{${"recno"}}`, encodeURIComponent(String(requestParameters['recno']))),
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

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

    /**
     * Acknowledges a specific SOA event by record number
     * Acknowledge an event
     */
    async acknowledgeEvent(requestParameters: AcknowledgeEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SoaResponse> {
        const response = await this.acknowledgeEventRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Activates a telephone number that has been ported
     * Activate a ported number
     */
    async activateRaw(requestParameters: ActivateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SoaResponse>> {
        if (requestParameters['body'] == null) {
            throw new runtime.RequiredError(
                'body',
                'Required parameter "body" was null or undefined when calling activate().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

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

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

    /**
     * Activates a telephone number that has been ported
     * Activate a ported number
     */
    async activate(requestParameters: ActivateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SoaResponse> {
        const response = await this.activateRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Cancels an existing port request for a telephone number
     * Cancel a port request
     */
    async cancelRaw(requestParameters: CancelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SoaResponse>> {
        if (requestParameters['body'] == null) {
            throw new runtime.RequiredError(
                'body',
                'Required parameter "body" was null or undefined when calling cancel().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

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

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

    /**
     * Cancels an existing port request for a telephone number
     * Cancel a port request
     */
    async cancel(requestParameters: CancelRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SoaResponse> {
        const response = await this.cancelRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Creates a new service order for porting a telephone number
     * Create a new port request
     */
    async createRaw(requestParameters: CreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SoaResponse>> {
        if (requestParameters['body'] == null) {
            throw new runtime.RequiredError(
                'body',
                'Required parameter "body" was null or undefined when calling create().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

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

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

    /**
     * Creates a new service order for porting a telephone number
     * Create a new port request
     */
    async create(requestParameters: CreateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SoaResponse> {
        const response = await this.createRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Places a telephone number into conflict status
     * Create a conflict
     */
    async createConflictRaw(requestParameters: CreateConflictRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SoaResponse>> {
        if (requestParameters['body'] == null) {
            throw new runtime.RequiredError(
                'body',
                'Required parameter "body" was null or undefined when calling createConflict().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

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

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

    /**
     * Places a telephone number into conflict status
     * Create a conflict
     */
    async createConflict(requestParameters: CreateConflictRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SoaResponse> {
        const response = await this.createConflictRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Creates a new Local Routing Number
     * Create an LRN
     */
    async createLrnRaw(requestParameters: CreateLrnRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SoaResponse>> {
        if (requestParameters['body'] == null) {
            throw new runtime.RequiredError(
                'body',
                'Required parameter "body" was null or undefined when calling createLrn().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

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

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

    /**
     * Creates a new Local Routing Number
     * Create an LRN
     */
    async createLrn(requestParameters: CreateLrnRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SoaResponse> {
        const response = await this.createLrnRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Disconnects a telephone number from service
     * Disconnect a number
     */
    async disconnectRaw(requestParameters: DisconnectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SoaResponse>> {
        if (requestParameters['body'] == null) {
            throw new runtime.RequiredError(
                'body',
                'Required parameter "body" was null or undefined when calling disconnect().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

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

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

    /**
     * Disconnects a telephone number from service
     * Disconnect a number
     */
    async disconnect(requestParameters: DisconnectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SoaResponse> {
        const response = await this.disconnectRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Gets all numbers ready for activation for a specific SPID
     * Get activation-ready numbers
     */
    async getActivationReady1Raw(requestParameters: GetActivationReady1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SoaActReadyResponse>> {
        if (requestParameters['newspid'] == null) {
            throw new runtime.RequiredError(
                'newspid',
                'Required parameter "newspid" was null or undefined when calling getActivationReady1().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

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

    /**
     * Gets all numbers ready for activation for a specific SPID
     * Get activation-ready numbers
     */
    async getActivationReady1(requestParameters: GetActivationReady1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SoaActReadyResponse> {
        const response = await this.getActivationReady1Raw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Retrieves unacknowledged SOA events
     * Get SOA events
     */
    async getEventsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SoaEventsResponse>> {
        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

        const response = await this.request({
            path: `/v1/lnp/soa/events`,
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

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

    /**
     * Retrieves unacknowledged SOA events
     * Get SOA events
     */
    async getEvents(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SoaEventsResponse> {
        const response = await this.getEventsRaw(initOverrides);
        return await response.value();
    }

    /**
     * Gets the current SPID information for a telephone number
     * Get SPID for number
     */
    async getSpidRaw(requestParameters: GetSpidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SoaSpidResponse>> {
        if (requestParameters['tn'] == null) {
            throw new runtime.RequiredError(
                'tn',
                'Required parameter "tn" was null or undefined when calling getSpid().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

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

    /**
     * Gets the current SPID information for a telephone number
     * Get SPID for number
     */
    async getSpid(requestParameters: GetSpidRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SoaSpidResponse> {
        const response = await this.getSpidRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Gets the current status of a telephone number
     * Get number status
     */
    async getStatusRaw(requestParameters: GetStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SoaStatusResponse>> {
        if (requestParameters['tn'] == null) {
            throw new runtime.RequiredError(
                'tn',
                'Required parameter "tn" was null or undefined when calling getStatus().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

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

    /**
     * Gets the current status of a telephone number
     * Get number status
     */
    async getStatus(requestParameters: GetStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SoaStatusResponse> {
        const response = await this.getStatusRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Queries the current status and details of a telephone number
     * Query port status
     */
    async queryRaw(requestParameters: QueryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SoaQueryResponse>> {
        if (requestParameters['tn'] == null) {
            throw new runtime.RequiredError(
                'tn',
                'Required parameter "tn" was null or undefined when calling query().'
            );
        }

        const queryParameters: any = {};

        if (requestParameters['newspid'] != null) {
            queryParameters['newspid'] = requestParameters['newspid'];
        }

        if (requestParameters['region'] != null) {
            queryParameters['region'] = requestParameters['region'];
        }

        const headerParameters: runtime.HTTPHeaders = {};

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

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

    /**
     * Queries the current status and details of a telephone number
     * Query port status
     */
    async query(requestParameters: QueryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SoaQueryResponse> {
        const response = await this.queryRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Releases a telephone number from a port request
     * Release a port request
     */
    async releaseRaw(requestParameters: ReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SoaResponse>> {
        if (requestParameters['body'] == null) {
            throw new runtime.RequiredError(
                'body',
                'Required parameter "body" was null or undefined when calling release().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

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

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

    /**
     * Releases a telephone number from a port request
     * Release a port request
     */
    async release(requestParameters: ReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SoaResponse> {
        const response = await this.releaseRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Removes a telephone number from conflict status
     * Remove a conflict
     */
    async removeConflictRaw(requestParameters: RemoveConflictRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SoaResponse>> {
        if (requestParameters['body'] == null) {
            throw new runtime.RequiredError(
                'body',
                'Required parameter "body" was null or undefined when calling removeConflict().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

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

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

    /**
     * Removes a telephone number from conflict status
     * Remove a conflict
     */
    async removeConflict(requestParameters: RemoveConflictRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SoaResponse> {
        const response = await this.removeConflictRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Removes an existing Local Routing Number
     * Remove an LRN
     */
    async removeLrnRaw(requestParameters: RemoveLrnRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SoaResponse>> {
        if (requestParameters['body'] == null) {
            throw new runtime.RequiredError(
                'body',
                'Required parameter "body" was null or undefined when calling removeLrn().'
            );
        }

        const queryParameters: any = {};

        const headerParameters: runtime.HTTPHeaders = {};

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

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

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

    /**
     * Removes an existing Local Routing Number
     * Remove an LRN
     */
    async removeLrn(requestParameters: RemoveLrnRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SoaResponse> {
        const response = await this.removeLrnRaw(requestParameters, initOverrides);
        return await response.value();
    }

}