yellowgrid-api-ts 3.2.220-dev.0 → 3.2.221-dev.0

package/dist/api.d.ts

@@ -2112,6 +2112,37 @@ export interface CallTariffPlan {
      */
     'closed'?: boolean;
 }
+/**
+ *
+ * @export
+ * @interface CallTariffResponse
+ */
+export interface CallTariffResponse {
+    /**
+     *
+     * @type {number}
+     * @memberof CallTariffResponse
+     */
+    'id'?: number;
+    /**
+     *
+     * @type {number}
+     * @memberof CallTariffResponse
+     */
+    'priceGroupId'?: number;
+    /**
+     *
+     * @type {PriceGroupResponse}
+     * @memberof CallTariffResponse
+     */
+    'priceGroup'?: PriceGroupResponse;
+    /**
+     *
+     * @type {TariffRate}
+     * @memberof CallTariffResponse
+     */
+    'tariffRate'?: TariffRate;
+}
 /**
  *
  * @export
@@ -2518,6 +2549,67 @@ export interface CompanyContractModel {
      */
     'timeRemaining'?: string;
 }
+/**
+ *
+ * @export
+ * @interface ConnectionRequest
+ */
+export interface ConnectionRequest {
+    /**
+     *
+     * @type {number}
+     * @memberof ConnectionRequest
+     */
+    'customerId': number;
+    /**
+     *
+     * @type {string}
+     * @memberof ConnectionRequest
+     */
+    'reference': string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ConnectionRequest
+     */
+    'connectionDate': string;
+    /**
+     *
+     * @type {number}
+     * @memberof ConnectionRequest
+     */
+    'servicePlanId': number;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ConnectionRequest
+     */
+    'zeroRated'?: boolean | null;
+    /**
+     *
+     * @type {number}
+     * @memberof ConnectionRequest
+     */
+    'callTariffPlanId'?: number | null;
+    /**
+     *
+     * @type {number}
+     * @memberof ConnectionRequest
+     */
+    'inboundTariffPlanId'?: number | null;
+    /**
+     *
+     * @type {string}
+     * @memberof ConnectionRequest
+     */
+    'invoiceDescription'?: string | null;
+    /**
+     *
+     * @type {MultiTenantSipTrunkRequest}
+     * @memberof ConnectionRequest
+     */
+    'mtSipTrunkRequest'?: MultiTenantSipTrunkRequest;
+}
 /**
  *
  * @export
@@ -5291,6 +5383,43 @@ export interface InboundTariffPlan {
      */
     'closed'?: boolean;
 }
+/**
+ *
+ * @export
+ * @interface InboundTariffPlanResponse
+ */
+export interface InboundTariffPlanResponse {
+    /**
+     *
+     * @type {number}
+     * @memberof InboundTariffPlanResponse
+     */
+    'id'?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof InboundTariffPlanResponse
+     */
+    'name'?: string | null;
+    /**
+     *
+     * @type {TariffRate}
+     * @memberof InboundTariffPlanResponse
+     */
+    'rate'?: TariffRate;
+    /**
+     *
+     * @type {Array<CallTariffResponse>}
+     * @memberof InboundTariffPlanResponse
+     */
+    'callTariffs'?: Array<CallTariffResponse> | null;
+    /**
+     *
+     * @type {boolean}
+     * @memberof InboundTariffPlanResponse
+     */
+    'closed'?: boolean;
+}
 /**
  * Installation Passwords
  * @export
@@ -6268,6 +6397,25 @@ export declare const MultiTenantChangeResponseModelTypeEnum: {
     readonly CallBarring: "Call Barring";
 };
 export type MultiTenantChangeResponseModelTypeEnum = typeof MultiTenantChangeResponseModelTypeEnum[keyof typeof MultiTenantChangeResponseModelTypeEnum];
+/**
+ *
+ * @export
+ * @interface MultiTenantSipTrunkRequest
+ */
+export interface MultiTenantSipTrunkRequest {
+    /**
+     *
+     * @type {boolean}
+     * @memberof MultiTenantSipTrunkRequest
+     */
+    'isPrimary': boolean;
+    /**
+     *
+     * @type {number}
+     * @memberof MultiTenantSipTrunkRequest
+     */
+    'mtPrimarySipTrunkId'?: number | null;
+}
 /**
  * Navigation Endpoint
  * @export
@@ -9144,6 +9292,31 @@ export interface PriceGroup {
      */
     'filePeriod'?: string | null;
 }
+/**
+ *
+ * @export
+ * @interface PriceGroupResponse
+ */
+export interface PriceGroupResponse {
+    /**
+     *
+     * @type {number}
+     * @memberof PriceGroupResponse
+     */
+    'id'?: number;
+    /**
+     *
+     * @type {string}
+     * @memberof PriceGroupResponse
+     */
+    'name'?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof PriceGroupResponse
+     */
+    'description'?: string | null;
+}
 /**
  * Price & Stock List
  * @export
@@ -17967,6 +18140,12 @@ export declare const BillingApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     getGetCallTariffs: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get Call Tariffs Detailed
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetCallTariffsDetails: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get Children
      * @param {number} [billCustomerId] Customer ID
@@ -17997,6 +18176,12 @@ export declare const BillingApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     getGetInboundTariffs: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get Inbound Tariffs Detailed
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetInboundTariffsDetails: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get Price Groups
      * @param {*} [options] Override http request option.
@@ -18016,6 +18201,12 @@ export declare const BillingApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     getGetServicePlans: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get Service Plans Detailed
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetServicesPlanDetails: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Get SIP Trunk List
      * @param {number} [billCustomerId] Customer ID
@@ -18118,6 +18309,14 @@ export declare const BillingApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     postGetCallTariffPlan: (putGetCallTariffPlanRequest: PutGetCallTariffPlanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Add Connection
+     * @param {number} [billCustomerId] Customer ID
+     * @param {ConnectionRequest} [connectionRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postGetConnections: (billCustomerId?: number, connectionRequest?: ConnectionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Add Price Group
      * @param {PostGetPriceGroupsRequest} postGetPriceGroupsRequest
@@ -18241,6 +18440,15 @@ export declare const BillingApiAxiosParamCreator: (configuration?: Configuration
      * @throws {RequiredError}
      */
     putGetCallTariffPlan: (callTariffPlanId: number, putGetCallTariffPlanRequest: PutGetCallTariffPlanRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Update Connection
+     * @param {number} connectionId Connection ID
+     * @param {number} [billCustomerId] Customer ID
+     * @param {ConnectionRequest} [connectionRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    putGetConnections: (connectionId: number, billCustomerId?: number, connectionRequest?: ConnectionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      * Update Price Group
      * @param {number} priceGroupId Price Group ID
@@ -18415,6 +18623,12 @@ export declare const BillingApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getGetCallTariffs(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CallTariffPlan>>>;
+    /**
+     * Get Call Tariffs Detailed
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetCallTariffsDetails(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CallTariffPlan>>>;
     /**
      * Get Children
      * @param {number} [billCustomerId] Customer ID
@@ -18445,6 +18659,12 @@ export declare const BillingApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getGetInboundTariffs(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<string>>>;
+    /**
+     * Get Inbound Tariffs Detailed
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetInboundTariffsDetails(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InboundTariffPlanResponse>>>;
     /**
      * Get Price Groups
      * @param {*} [options] Override http request option.
@@ -18464,6 +18684,12 @@ export declare const BillingApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     getGetServicePlans(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ServicePlan>>>;
+    /**
+     * Get Service Plans Detailed
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetServicesPlanDetails(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<ServicePlan>>>;
     /**
      * Get SIP Trunk List
      * @param {number} [billCustomerId] Customer ID
@@ -18566,6 +18792,14 @@ export declare const BillingApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     postGetCallTariffPlan(putGetCallTariffPlanRequest: PutGetCallTariffPlanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CallTariffPlan>>;
+    /**
+     * Add Connection
+     * @param {number} [billCustomerId] Customer ID
+     * @param {ConnectionRequest} [connectionRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postGetConnections(billCustomerId?: number, connectionRequest?: ConnectionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OutboundCli>>;
     /**
      * Add Price Group
      * @param {PostGetPriceGroupsRequest} postGetPriceGroupsRequest
@@ -18689,6 +18923,15 @@ export declare const BillingApiFp: (configuration?: Configuration) => {
      * @throws {RequiredError}
      */
     putGetCallTariffPlan(callTariffPlanId: number, putGetCallTariffPlanRequest: PutGetCallTariffPlanRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CallTariffPlan>>;
+    /**
+     * Update Connection
+     * @param {number} connectionId Connection ID
+     * @param {number} [billCustomerId] Customer ID
+     * @param {ConnectionRequest} [connectionRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    putGetConnections(connectionId: number, billCustomerId?: number, connectionRequest?: ConnectionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OutboundCli>>;
     /**
      * Update Price Group
      * @param {number} priceGroupId Price Group ID
@@ -18863,6 +19106,12 @@ export declare const BillingApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     getGetCallTariffs(options?: RawAxiosRequestConfig): AxiosPromise<Array<CallTariffPlan>>;
+    /**
+     * Get Call Tariffs Detailed
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetCallTariffsDetails(options?: RawAxiosRequestConfig): AxiosPromise<Array<CallTariffPlan>>;
     /**
      * Get Children
      * @param {number} [billCustomerId] Customer ID
@@ -18893,6 +19142,12 @@ export declare const BillingApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     getGetInboundTariffs(options?: RawAxiosRequestConfig): AxiosPromise<Array<string>>;
+    /**
+     * Get Inbound Tariffs Detailed
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetInboundTariffsDetails(options?: RawAxiosRequestConfig): AxiosPromise<Array<InboundTariffPlanResponse>>;
     /**
      * Get Price Groups
      * @param {*} [options] Override http request option.
@@ -18912,6 +19167,12 @@ export declare const BillingApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     getGetServicePlans(options?: RawAxiosRequestConfig): AxiosPromise<Array<ServicePlan>>;
+    /**
+     * Get Service Plans Detailed
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGetServicesPlanDetails(options?: RawAxiosRequestConfig): AxiosPromise<Array<ServicePlan>>;
     /**
      * Get SIP Trunk List
      * @param {number} [billCustomerId] Customer ID
@@ -19014,6 +19275,14 @@ export declare const BillingApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     postGetCallTariffPlan(putGetCallTariffPlanRequest: PutGetCallTariffPlanRequest, options?: RawAxiosRequestConfig): AxiosPromise<CallTariffPlan>;
+    /**
+     * Add Connection
+     * @param {number} [billCustomerId] Customer ID
+     * @param {ConnectionRequest} [connectionRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    postGetConnections(billCustomerId?: number, connectionRequest?: ConnectionRequest, options?: RawAxiosRequestConfig): AxiosPromise<OutboundCli>;
     /**
      * Add Price Group
      * @param {PostGetPriceGroupsRequest} postGetPriceGroupsRequest
@@ -19137,6 +19406,15 @@ export declare const BillingApiFactory: (configuration?: Configuration, basePath
      * @throws {RequiredError}
      */
     putGetCallTariffPlan(callTariffPlanId: number, putGetCallTariffPlanRequest: PutGetCallTariffPlanRequest, options?: RawAxiosRequestConfig): AxiosPromise<CallTariffPlan>;
+    /**
+     * Update Connection
+     * @param {number} connectionId Connection ID
+     * @param {number} [billCustomerId] Customer ID
+     * @param {ConnectionRequest} [connectionRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    putGetConnections(connectionId: number, billCustomerId?: number, connectionRequest?: ConnectionRequest, options?: RawAxiosRequestConfig): AxiosPromise<OutboundCli>;
     /**
      * Update Price Group
      * @param {number} priceGroupId Price Group ID
@@ -19335,6 +19613,13 @@ export declare class BillingApi extends BaseAPI {
      * @memberof BillingApi
      */
     getGetCallTariffs(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CallTariffPlan[], any, {}>>;
+    /**
+     * Get Call Tariffs Detailed
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BillingApi
+     */
+    getGetCallTariffsDetails(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CallTariffPlan[], any, {}>>;
     /**
      * Get Children
      * @param {number} [billCustomerId] Customer ID
@@ -19369,6 +19654,13 @@ export declare class BillingApi extends BaseAPI {
      * @memberof BillingApi
      */
     getGetInboundTariffs(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string[], any, {}>>;
+    /**
+     * Get Inbound Tariffs Detailed
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BillingApi
+     */
+    getGetInboundTariffsDetails(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InboundTariffPlanResponse[], any, {}>>;
     /**
      * Get Price Groups
      * @param {*} [options] Override http request option.
@@ -19391,6 +19683,13 @@ export declare class BillingApi extends BaseAPI {
      * @memberof BillingApi
      */
     getGetServicePlans(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ServicePlan[], any, {}>>;
+    /**
+     * Get Service Plans Detailed
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BillingApi
+     */
+    getGetServicesPlanDetails(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ServicePlan[], any, {}>>;
     /**
      * Get SIP Trunk List
      * @param {number} [billCustomerId] Customer ID
@@ -19507,6 +19806,15 @@ export declare class BillingApi extends BaseAPI {
      * @memberof BillingApi
      */
     postGetCallTariffPlan(putGetCallTariffPlanRequest: PutGetCallTariffPlanRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CallTariffPlan, any, {}>>;
+    /**
+     * Add Connection
+     * @param {number} [billCustomerId] Customer ID
+     * @param {ConnectionRequest} [connectionRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BillingApi
+     */
+    postGetConnections(billCustomerId?: number, connectionRequest?: ConnectionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OutboundCli, any, {}>>;
     /**
      * Add Price Group
      * @param {PostGetPriceGroupsRequest} postGetPriceGroupsRequest
@@ -19646,6 +19954,16 @@ export declare class BillingApi extends BaseAPI {
      * @memberof BillingApi
      */
     putGetCallTariffPlan(callTariffPlanId: number, putGetCallTariffPlanRequest: PutGetCallTariffPlanRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<CallTariffPlan, any, {}>>;
+    /**
+     * Update Connection
+     * @param {number} connectionId Connection ID
+     * @param {number} [billCustomerId] Customer ID
+     * @param {ConnectionRequest} [connectionRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BillingApi
+     */
+    putGetConnections(connectionId: number, billCustomerId?: number, connectionRequest?: ConnectionRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OutboundCli, any, {}>>;
     /**
      * Update Price Group
      * @param {number} priceGroupId Price Group ID