/** * UBill API * UBill API - provides programmatic access to our resources. You will be able to integrate our service into your system and communicate with clients easily. * * The version of the OpenAPI document: 2.1.8 * Contact: info@ubill.ge * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from '../configuration'; import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios'; import { type RequestArgs, BaseAPI } from '../base'; import type { BrandNamesResponse } from '../model'; import type { CreateBrandNameRequest } from '../model'; import type { CreateBrandNameResponse } from '../model'; import type { DeliveryReportResponse } from '../model'; import type { SMSBalanceResponse } from '../model'; import type { SendSMSRequest } from '../model'; import type { SendSMSResponse } from '../model'; /** * SmsApi - axios parameter creator * @export */ export declare const SmsApiAxiosParamCreator: (configuration?: Configuration) => { /** * Register a new brand name for SMS messaging. Brand names are used to identify the sender of SMS messages (e.g., \"ubill-info\"). * @summary Create Brand Name * @param {CreateBrandNameRequest} createBrandNameRequest Brand Name payload to create * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBrandName: (createBrandNameRequest: CreateBrandNameRequest, options?: RawAxiosRequestConfig) => Promise; /** * Fetch the delivery status of a previously sent SMS using its unique identifier. * @summary Get Delivery Report * @param {number} smsID Unique identifier of the SMS * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDeliveryReport: (smsID: number, options?: RawAxiosRequestConfig) => Promise; /** * Retrieve your current SMS balance, indicating how many messages you can send. * @summary Get SMS Balance * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSMSBalance: (options?: RawAxiosRequestConfig) => Promise; /** * Retrieve a list of all registered brand names associated with your account. * @summary Get All Brand Names * @param {*} [options] Override http request option. * @throws {RequiredError} */ listBrandNames: (options?: RawAxiosRequestConfig) => Promise; /** * Send SMS messages to one or multiple recipients using a registered brand name. * @summary Send SMS * @param {SendSMSRequest} sendSMSRequest SMS payload for sending messages * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendSMS: (sendSMSRequest: SendSMSRequest, options?: RawAxiosRequestConfig) => Promise; }; /** * SmsApi - functional programming interface * @export */ export declare const SmsApiFp: (configuration?: Configuration) => { /** * Register a new brand name for SMS messaging. Brand names are used to identify the sender of SMS messages (e.g., \"ubill-info\"). * @summary Create Brand Name * @param {CreateBrandNameRequest} createBrandNameRequest Brand Name payload to create * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBrandName(createBrandNameRequest: CreateBrandNameRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Fetch the delivery status of a previously sent SMS using its unique identifier. * @summary Get Delivery Report * @param {number} smsID Unique identifier of the SMS * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDeliveryReport(smsID: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve your current SMS balance, indicating how many messages you can send. * @summary Get SMS Balance * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSMSBalance(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve a list of all registered brand names associated with your account. * @summary Get All Brand Names * @param {*} [options] Override http request option. * @throws {RequiredError} */ listBrandNames(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Send SMS messages to one or multiple recipients using a registered brand name. * @summary Send SMS * @param {SendSMSRequest} sendSMSRequest SMS payload for sending messages * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendSMS(sendSMSRequest: SendSMSRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * SmsApi - factory interface * @export */ export declare const SmsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Register a new brand name for SMS messaging. Brand names are used to identify the sender of SMS messages (e.g., \"ubill-info\"). * @summary Create Brand Name * @param {SmsApiCreateBrandNameRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createBrandName(requestParameters: SmsApiCreateBrandNameRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetch the delivery status of a previously sent SMS using its unique identifier. * @summary Get Delivery Report * @param {SmsApiGetDeliveryReportRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDeliveryReport(requestParameters: SmsApiGetDeliveryReportRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve your current SMS balance, indicating how many messages you can send. * @summary Get SMS Balance * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSMSBalance(options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a list of all registered brand names associated with your account. * @summary Get All Brand Names * @param {*} [options] Override http request option. * @throws {RequiredError} */ listBrandNames(options?: RawAxiosRequestConfig): AxiosPromise; /** * Send SMS messages to one or multiple recipients using a registered brand name. * @summary Send SMS * @param {SmsApiSendSMSRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendSMS(requestParameters: SmsApiSendSMSRequest, options?: RawAxiosRequestConfig): AxiosPromise; }; /** * SmsApi - interface * @export * @interface SmsApi */ export interface SmsApiInterface { /** * Register a new brand name for SMS messaging. Brand names are used to identify the sender of SMS messages (e.g., \"ubill-info\"). * @summary Create Brand Name * @param {SmsApiCreateBrandNameRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SmsApiInterface */ createBrandName(requestParameters: SmsApiCreateBrandNameRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Fetch the delivery status of a previously sent SMS using its unique identifier. * @summary Get Delivery Report * @param {SmsApiGetDeliveryReportRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SmsApiInterface */ getDeliveryReport(requestParameters: SmsApiGetDeliveryReportRequest, options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve your current SMS balance, indicating how many messages you can send. * @summary Get SMS Balance * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SmsApiInterface */ getSMSBalance(options?: RawAxiosRequestConfig): AxiosPromise; /** * Retrieve a list of all registered brand names associated with your account. * @summary Get All Brand Names * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SmsApiInterface */ listBrandNames(options?: RawAxiosRequestConfig): AxiosPromise; /** * Send SMS messages to one or multiple recipients using a registered brand name. * @summary Send SMS * @param {SmsApiSendSMSRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SmsApiInterface */ sendSMS(requestParameters: SmsApiSendSMSRequest, options?: RawAxiosRequestConfig): AxiosPromise; } /** * Request parameters for createBrandName operation in SmsApi. * @export * @interface SmsApiCreateBrandNameRequest */ export interface SmsApiCreateBrandNameRequest { /** * Brand Name payload to create * @type {CreateBrandNameRequest} * @memberof SmsApiCreateBrandName */ readonly createBrandNameRequest: CreateBrandNameRequest; } /** * Request parameters for getDeliveryReport operation in SmsApi. * @export * @interface SmsApiGetDeliveryReportRequest */ export interface SmsApiGetDeliveryReportRequest { /** * Unique identifier of the SMS * @type {number} * @memberof SmsApiGetDeliveryReport */ readonly smsID: number; } /** * Request parameters for sendSMS operation in SmsApi. * @export * @interface SmsApiSendSMSRequest */ export interface SmsApiSendSMSRequest { /** * SMS payload for sending messages * @type {SendSMSRequest} * @memberof SmsApiSendSMS */ readonly sendSMSRequest: SendSMSRequest; } /** * SmsApi - object-oriented interface * @export * @class SmsApi * @extends {BaseAPI} */ export declare class SmsApi extends BaseAPI implements SmsApiInterface { /** * Register a new brand name for SMS messaging. Brand names are used to identify the sender of SMS messages (e.g., \"ubill-info\"). * @summary Create Brand Name * @param {SmsApiCreateBrandNameRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SmsApi */ createBrandName(requestParameters: SmsApiCreateBrandNameRequest, options?: RawAxiosRequestConfig): Promise>; /** * Fetch the delivery status of a previously sent SMS using its unique identifier. * @summary Get Delivery Report * @param {SmsApiGetDeliveryReportRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SmsApi */ getDeliveryReport(requestParameters: SmsApiGetDeliveryReportRequest, options?: RawAxiosRequestConfig): Promise>; /** * Retrieve your current SMS balance, indicating how many messages you can send. * @summary Get SMS Balance * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SmsApi */ getSMSBalance(options?: RawAxiosRequestConfig): Promise>; /** * Retrieve a list of all registered brand names associated with your account. * @summary Get All Brand Names * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SmsApi */ listBrandNames(options?: RawAxiosRequestConfig): Promise>; /** * Send SMS messages to one or multiple recipients using a registered brand name. * @summary Send SMS * @param {SmsApiSendSMSRequest} requestParameters Request parameters. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SmsApi */ sendSMS(requestParameters: SmsApiSendSMSRequest, options?: RawAxiosRequestConfig): Promise>; }