yellowgrid-api-ts 3.2.45 → 3.2.47-dev.0

package/dist/src/apis/SIPTrunksApi.d.ts

@@ -0,0 +1,315 @@
+/**
+ * Yellowgrid
+ * Welcome to the Yellowgrid API documentation.      This API provides secure and comprehensive access to the Yellowgrid platform, enabling developers and integrators to manage accounts, contacts, SIP trunks, SMS messaging, 3CX integrations, and provisioning services.      ## Key Features:    - **Accounts**: View and manage account details, contacts, client credentials, and verification.    - **Provisioning**: Automate setup and configuration of devices and groups.    - **SIP Trunks**: Manage trunk creation, changes, DDIs, diverts, and configuration.    - **Messaging**: Send SMS messages securely via the messaging gateway.    - **3CX Integrations**: Automate licence handling, installation, and multi-tenant setup.      ## Authentication:    The API supports OAuth 2.0 for authentication and authorization. Ensure you use a valid bearer token for all authenticated endpoints.            ## Base URL:    `http://api.yellowgrid.local`                  For questions or technical support, please contact support@yellowgrid.co.uk.
+ *
+ * The version of the OpenAPI document: 0
+ *
+ *
+ * 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 { AddressRequestModel, AreaCodeModel, DdiRangesRequestModel, DivertRequestModel, DivertResponseModel, SipTrunkChangeResponseModel, SipTrunkCreationRequestModel, SipTrunkEntity, SipTrunksResponseModel } from '../models/index';
+export interface DeleteGetSipTrunkRequest {
+    id: number;
+}
+export interface GetCanDivertRequest {
+    id: number;
+}
+export interface GetGetAddressRequest {
+    id: number;
+}
+export interface GetGetCliFlexibilityRequest {
+    id: number;
+}
+export interface GetGetDdisRequest {
+    id: number;
+}
+export interface GetGetDivertsRequest {
+    id: number;
+    enabled?: boolean;
+}
+export interface GetGetSipTrunkRequest {
+    id: number;
+}
+export interface GetGetSipTrunksRequest {
+    pageSize?: number;
+    page?: number;
+    search?: string;
+}
+export interface PatchGetCliFlexibilityRequest {
+    id: number;
+    enabled: boolean;
+}
+export interface PatchSetAsAvailableRequest {
+    id: number;
+}
+export interface PatchSetOwnershipRequest {
+    id: number;
+    ownerId: number;
+    billingCustomerId?: number;
+}
+export interface PatchUpdateChannelCountRequest {
+    id: number;
+    channels: number;
+}
+export interface PatchUpdateCompanyNameRequest {
+    id: number;
+    company: string;
+}
+export interface PatchUpdateMainTrunkNumberRequest {
+    id: number;
+    number: string;
+}
+export interface PatchUpdatePbxIPAddressRequest {
+    id: number;
+    ipAddress: string;
+}
+export interface PostGetDdisRequest {
+    id: number;
+    ddiRangesRequestModel?: DdiRangesRequestModel;
+}
+export interface PostGetRequestedDdisRequest {
+    sipTrunkChangeResponseModel?: SipTrunkChangeResponseModel;
+}
+export interface PostGetSipTrunksRequest {
+    sipTrunkCreationRequestModel?: SipTrunkCreationRequestModel;
+}
+export interface PostTrackChangeRequest {
+    sipTrunkChangeResponseModel?: SipTrunkChangeResponseModel;
+}
+export interface PutGetAddressRequest {
+    id: number;
+    addressRequestModel?: AddressRequestModel;
+}
+export interface PutGetDivertsRequest {
+    id: number;
+    enabled: boolean;
+    divertRequestModel?: DivertRequestModel;
+}
+/**
+ *
+ */
+export declare class SIPTrunksApi extends runtime.BaseAPI {
+    /**
+     * Delete SIP Trunk
+     * Delete SIP Trunk
+     */
+    deleteGetSipTrunkRaw(requestParameters: DeleteGetSipTrunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SipTrunkChangeResponseModel>>;
+    /**
+     * Delete SIP Trunk
+     * Delete SIP Trunk
+     */
+    deleteGetSipTrunk(requestParameters: DeleteGetSipTrunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SipTrunkChangeResponseModel>;
+    /**
+     * SIP Trunk Diverts Allowed
+     * SIP Trunk Diverts Allowed
+     */
+    getCanDivertRaw(requestParameters: GetCanDivertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
+    /**
+     * SIP Trunk Diverts Allowed
+     * SIP Trunk Diverts Allowed
+     */
+    getCanDivert(requestParameters: GetCanDivertRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
+    /**
+     * Get SIP Trunk Address
+     * Get SIP Trunk Address
+     */
+    getGetAddressRaw(requestParameters: GetGetAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AddressRequestModel>>;
+    /**
+     * Get SIP Trunk Address
+     * Get SIP Trunk Address
+     */
+    getGetAddress(requestParameters: GetGetAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AddressRequestModel>;
+    /**
+     * Get UK National Area Codes
+     * Get UK National Area Codes
+     */
+    getGetAreaCodesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AreaCodeModel>>>;
+    /**
+     * Get UK National Area Codes
+     * Get UK National Area Codes
+     */
+    getGetAreaCodes(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AreaCodeModel>>;
+    /**
+     * Get SIP Trunk CLI Flexibility Status
+     * Get SIP Trunk CLI Flexibility Status
+     */
+    getGetCliFlexibilityRaw(requestParameters: GetGetCliFlexibilityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<boolean>>;
+    /**
+     * Get SIP Trunk CLI Flexibility Status
+     * Get SIP Trunk CLI Flexibility Status
+     */
+    getGetCliFlexibility(requestParameters: GetGetCliFlexibilityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<boolean>;
+    /**
+     * Get SIP Trunk DDIs
+     * Get SIP Trunk DDIs
+     */
+    getGetDdisRaw(requestParameters: GetGetDdisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<string>>>;
+    /**
+     * Get SIP Trunk DDIs
+     * Get SIP Trunk DDIs
+     */
+    getGetDdis(requestParameters: GetGetDdisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<string>>;
+    /**
+     * Get SIP Trunk Diverts
+     * Get SIP Trunk Diverts
+     */
+    getGetDivertsRaw(requestParameters: GetGetDivertsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<DivertResponseModel>>>;
+    /**
+     * Get SIP Trunk Diverts
+     * Get SIP Trunk Diverts
+     */
+    getGetDiverts(requestParameters: GetGetDivertsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<DivertResponseModel>>;
+    /**
+     * Get SIP Trunk
+     * Get SIP Trunk
+     */
+    getGetSipTrunkRaw(requestParameters: GetGetSipTrunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SipTrunkEntity>>;
+    /**
+     * Get SIP Trunk
+     * Get SIP Trunk
+     */
+    getGetSipTrunk(requestParameters: GetGetSipTrunkRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SipTrunkEntity>;
+    /**
+     * Get SIP Trunks
+     * Get SIP Trunks
+     */
+    getGetSipTrunksRaw(requestParameters: GetGetSipTrunksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SipTrunksResponseModel>>;
+    /**
+     * Get SIP Trunks
+     * Get SIP Trunks
+     */
+    getGetSipTrunks(requestParameters?: GetGetSipTrunksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SipTrunksResponseModel>;
+    /**
+     * Update Get SIP Trunk CLI Flexibility Status
+     * Update Get SIP Trunk CLI Flexibility Status
+     */
+    patchGetCliFlexibilityRaw(requestParameters: PatchGetCliFlexibilityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SipTrunkChangeResponseModel>>;
+    /**
+     * Update Get SIP Trunk CLI Flexibility Status
+     * Update Get SIP Trunk CLI Flexibility Status
+     */
+    patchGetCliFlexibility(requestParameters: PatchGetCliFlexibilityRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SipTrunkChangeResponseModel>;
+    /**
+     * Set a SIP trunk as \'AVAILABLE\' for repurposing
+     * Set a SIP trunk as \'AVAILABLE\' for repurposing
+     */
+    patchSetAsAvailableRaw(requestParameters: PatchSetAsAvailableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Set a SIP trunk as \'AVAILABLE\' for repurposing
+     * Set a SIP trunk as \'AVAILABLE\' for repurposing
+     */
+    patchSetAsAvailable(requestParameters: PatchSetAsAvailableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Change SIP Trunk Owner
+     * Change SIP Trunk Owner
+     */
+    patchSetOwnershipRaw(requestParameters: PatchSetOwnershipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Change SIP Trunk Owner
+     * Change SIP Trunk Owner
+     */
+    patchSetOwnership(requestParameters: PatchSetOwnershipRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Increase SIP Trunk Channels
+     * Increase SIP Trunk Channels
+     */
+    patchUpdateChannelCountRaw(requestParameters: PatchUpdateChannelCountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SipTrunkChangeResponseModel>>;
+    /**
+     * Increase SIP Trunk Channels
+     * Increase SIP Trunk Channels
+     */
+    patchUpdateChannelCount(requestParameters: PatchUpdateChannelCountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SipTrunkChangeResponseModel>;
+    /**
+     * Update SIP Trunk Company Name
+     * Update SIP Trunk Company Name
+     */
+    patchUpdateCompanyNameRaw(requestParameters: PatchUpdateCompanyNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SipTrunkChangeResponseModel>>;
+    /**
+     * Update SIP Trunk Company Name
+     * Update SIP Trunk Company Name
+     */
+    patchUpdateCompanyName(requestParameters: PatchUpdateCompanyNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SipTrunkChangeResponseModel>;
+    /**
+     * Update SIP Trunk Main Trunk Number
+     * Update SIP Trunk Main Trunk Number
+     */
+    patchUpdateMainTrunkNumberRaw(requestParameters: PatchUpdateMainTrunkNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SipTrunkChangeResponseModel>>;
+    /**
+     * Update SIP Trunk Main Trunk Number
+     * Update SIP Trunk Main Trunk Number
+     */
+    patchUpdateMainTrunkNumber(requestParameters: PatchUpdateMainTrunkNumberRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SipTrunkChangeResponseModel>;
+    /**
+     * Update SIP Trunk PBX IP Address
+     * Update SIP Trunk PBX IP Address
+     */
+    patchUpdatePbxIPAddressRaw(requestParameters: PatchUpdatePbxIPAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SipTrunkChangeResponseModel>>;
+    /**
+     * Update SIP Trunk PBX IP Address
+     * Update SIP Trunk PBX IP Address
+     */
+    patchUpdatePbxIPAddress(requestParameters: PatchUpdatePbxIPAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SipTrunkChangeResponseModel>;
+    /**
+     * Add SIP Trunk DDIs
+     * Add SIP Trunk DDIs
+     */
+    postGetDdisRaw(requestParameters: PostGetDdisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SipTrunkChangeResponseModel>>;
+    /**
+     * Add SIP Trunk DDIs
+     * Add SIP Trunk DDIs
+     */
+    postGetDdis(requestParameters: PostGetDdisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SipTrunkChangeResponseModel>;
+    /**
+     * Get Requested DDIs
+     * Get Requested DDIs
+     */
+    postGetRequestedDdisRaw(requestParameters: PostGetRequestedDdisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Array<string>>>>;
+    /**
+     * Get Requested DDIs
+     * Get Requested DDIs
+     */
+    postGetRequestedDdis(requestParameters?: PostGetRequestedDdisRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Array<string>>>;
+    /**
+     * Create New SIP Trunk
+     * Create New SIP Trunk
+     */
+    postGetSipTrunksRaw(requestParameters: PostGetSipTrunksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SipTrunkChangeResponseModel>>;
+    /**
+     * Create New SIP Trunk
+     * Create New SIP Trunk
+     */
+    postGetSipTrunks(requestParameters?: PostGetSipTrunksRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SipTrunkChangeResponseModel>;
+    /**
+     * Track SIP Trunk Change Request
+     * Track SIP Trunk Change Request
+     */
+    postTrackChangeRaw(requestParameters: PostTrackChangeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SipTrunkChangeResponseModel>>;
+    /**
+     * Track SIP Trunk Change Request
+     * Track SIP Trunk Change Request
+     */
+    postTrackChange(requestParameters?: PostTrackChangeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SipTrunkChangeResponseModel>;
+    /**
+     * Update SIP Trunk Address
+     * Update SIP Trunk Address
+     */
+    putGetAddressRaw(requestParameters: PutGetAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SipTrunkChangeResponseModel>>;
+    /**
+     * Update SIP Trunk Address
+     * Update SIP Trunk Address
+     */
+    putGetAddress(requestParameters: PutGetAddressRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SipTrunkChangeResponseModel>;
+    /**
+     * SIP Trunk Diverts
+     * Update SIP Trunk Diverts
+     */
+    putGetDivertsRaw(requestParameters: PutGetDivertsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SipTrunkChangeResponseModel>>;
+    /**
+     * SIP Trunk Diverts
+     * Update SIP Trunk Diverts
+     */
+    putGetDiverts(requestParameters: PutGetDivertsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SipTrunkChangeResponseModel>;
+}