@forestvpn/forestvpn_api
Advanced tools
Comparing version 3.3.3 to 3.3.4
@@ -25,4 +25,4 @@ /* tslint:disable */ | ||
export * from './apis/google-api'; | ||
export * from './apis/notifications-api'; | ||
export * from './apis/news-api'; | ||
export * from './apis/wireguard-api'; | ||
@@ -29,3 +29,3 @@ /* tslint:disable */ | ||
* @summary Data Usage Stats | ||
* @param {string} [aggr_interval] No more than 3 days for hour aggregation type | ||
* @param {string} aggr_interval No more than 3 days for hour aggregation type | ||
* @param {string} [date_after] No more than 3 months between date_after and date_before | ||
@@ -39,3 +39,7 @@ * @param {string} [date_before] No more than 3 months between date_after and date_before | ||
*/ | ||
getDataUsageStats: async (aggr_interval?: string, date_after?: string, date_before?: string, device_type__in?: Array<string>, device__in?: Array<string>, sort_by?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { | ||
getDataUsageStats: async (aggr_interval: string, date_after?: string, date_before?: string, device_type__in?: Array<string>, device__in?: Array<string>, sort_by?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { | ||
// verify required parameter 'aggr_interval' is not null or undefined | ||
if (aggr_interval === null || aggr_interval === undefined) { | ||
throw new RequiredError('aggr_interval','Required parameter aggr_interval was null or undefined when calling getDataUsageStats.'); | ||
} | ||
const localVarPath = `/analytics/data-usage/`; | ||
@@ -110,3 +114,3 @@ // use dummy base URL string because the URL constructor only accepts absolute URLs. | ||
* @summary Data Usage Stats | ||
* @param {string} [aggr_interval] No more than 3 days for hour aggregation type | ||
* @param {string} aggr_interval No more than 3 days for hour aggregation type | ||
* @param {string} [date_after] No more than 3 months between date_after and date_before | ||
@@ -120,3 +124,3 @@ * @param {string} [date_before] No more than 3 months between date_after and date_before | ||
*/ | ||
async getDataUsageStats(aggr_interval?: string, date_after?: string, date_before?: string, device_type__in?: Array<string>, device__in?: Array<string>, sort_by?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<AggregatedDataUsageStats>>>> { | ||
async getDataUsageStats(aggr_interval: string, date_after?: string, date_before?: string, device_type__in?: Array<string>, device__in?: Array<string>, sort_by?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<AggregatedDataUsageStats>>>> { | ||
const localVarAxiosArgs = await AnalyticsApiAxiosParamCreator(configuration).getDataUsageStats(aggr_interval, date_after, date_before, device_type__in, device__in, sort_by, options); | ||
@@ -140,3 +144,3 @@ return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { | ||
* @summary Data Usage Stats | ||
* @param {string} [aggr_interval] No more than 3 days for hour aggregation type | ||
* @param {string} aggr_interval No more than 3 days for hour aggregation type | ||
* @param {string} [date_after] No more than 3 months between date_after and date_before | ||
@@ -150,3 +154,3 @@ * @param {string} [date_before] No more than 3 months between date_after and date_before | ||
*/ | ||
async getDataUsageStats(aggr_interval?: string, date_after?: string, date_before?: string, device_type__in?: Array<string>, device__in?: Array<string>, sort_by?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<AggregatedDataUsageStats>>> { | ||
async getDataUsageStats(aggr_interval: string, date_after?: string, date_before?: string, device_type__in?: Array<string>, device__in?: Array<string>, sort_by?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<AggregatedDataUsageStats>>> { | ||
return AnalyticsApiFp(configuration).getDataUsageStats(aggr_interval, date_after, date_before, device_type__in, device__in, sort_by, options).then((request) => request(axios, basePath)); | ||
@@ -167,3 +171,3 @@ }, | ||
* @summary Data Usage Stats | ||
* @param {string} [aggr_interval] No more than 3 days for hour aggregation type | ||
* @param {string} aggr_interval No more than 3 days for hour aggregation type | ||
* @param {string} [date_after] No more than 3 months between date_after and date_before | ||
@@ -178,5 +182,5 @@ * @param {string} [date_before] No more than 3 months between date_after and date_before | ||
*/ | ||
public async getDataUsageStats(aggr_interval?: string, date_after?: string, date_before?: string, device_type__in?: Array<string>, device__in?: Array<string>, sort_by?: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<Array<AggregatedDataUsageStats>>> { | ||
public async getDataUsageStats(aggr_interval: string, date_after?: string, date_before?: string, device_type__in?: Array<string>, device__in?: Array<string>, sort_by?: string, options?: AxiosRequestConfig) : Promise<AxiosResponse<Array<AggregatedDataUsageStats>>> { | ||
return AnalyticsApiFp(this.configuration).getDataUsageStats(aggr_interval, date_after, date_before, device_type__in, device__in, sort_by, options).then((request) => request(this.axios, this.basePath)); | ||
} | ||
} |
@@ -20,2 +20,4 @@ /* tslint:disable */ | ||
import { Notification } from '../models'; | ||
import { NotificationDetail } from '../models'; | ||
import { NotificationUnreadCount } from '../models'; | ||
/** | ||
@@ -29,9 +31,87 @@ * NewsApi - axios parameter creator | ||
* | ||
* @summary Get notification content | ||
* @param {number} notificationID | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
getNotification: async (notificationID: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { | ||
// verify required parameter 'notificationID' is not null or undefined | ||
if (notificationID === null || notificationID === undefined) { | ||
throw new RequiredError('notificationID','Required parameter notificationID was null or undefined when calling getNotification.'); | ||
} | ||
const localVarPath = `/news/notifications/{notificationID}/` | ||
.replace(`{${"notificationID"}}`, encodeURIComponent(String(notificationID))); | ||
// use dummy base URL string because the URL constructor only accepts absolute URLs. | ||
const localVarUrlObj = new URL(localVarPath, 'https://example.com'); | ||
let baseOptions; | ||
if (configuration) { | ||
baseOptions = configuration.baseOptions; | ||
} | ||
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options}; | ||
const localVarHeaderParameter = {} as any; | ||
const localVarQueryParameter = {} as any; | ||
// authentication bearerAuth required | ||
const query = new URLSearchParams(localVarUrlObj.search); | ||
for (const key in localVarQueryParameter) { | ||
query.set(key, localVarQueryParameter[key]); | ||
} | ||
for (const key in options.params) { | ||
query.set(key, options.params[key]); | ||
} | ||
localVarUrlObj.search = (new URLSearchParams(query)).toString(); | ||
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; | ||
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; | ||
return { | ||
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash, | ||
options: localVarRequestOptions, | ||
}; | ||
}, | ||
/** | ||
* | ||
* @summary Get unread notifications count | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
getNotificationsUnreadCount: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => { | ||
const localVarPath = `/news/unread_count/`; | ||
// use dummy base URL string because the URL constructor only accepts absolute URLs. | ||
const localVarUrlObj = new URL(localVarPath, 'https://example.com'); | ||
let baseOptions; | ||
if (configuration) { | ||
baseOptions = configuration.baseOptions; | ||
} | ||
const localVarRequestOptions :AxiosRequestConfig = { method: 'GET', ...baseOptions, ...options}; | ||
const localVarHeaderParameter = {} as any; | ||
const localVarQueryParameter = {} as any; | ||
// authentication bearerAuth required | ||
const query = new URLSearchParams(localVarUrlObj.search); | ||
for (const key in localVarQueryParameter) { | ||
query.set(key, localVarQueryParameter[key]); | ||
} | ||
for (const key in options.params) { | ||
query.set(key, options.params[key]); | ||
} | ||
localVarUrlObj.search = (new URLSearchParams(query)).toString(); | ||
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; | ||
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; | ||
return { | ||
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash, | ||
options: localVarRequestOptions, | ||
}; | ||
}, | ||
/** | ||
* | ||
* @summary Get notifications list | ||
* @param {number} [max] | ||
* @param {boolean} [is_published] | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
listNotifications: async (max?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { | ||
const localVarPath = `/notifications/api/unread_list/`; | ||
listNotifications: async (is_published?: boolean, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { | ||
const localVarPath = `/news/notifications/`; | ||
// use dummy base URL string because the URL constructor only accepts absolute URLs. | ||
@@ -49,4 +129,4 @@ const localVarUrlObj = new URL(localVarPath, 'https://example.com'); | ||
if (max !== undefined) { | ||
localVarQueryParameter['max'] = max; | ||
if (is_published !== undefined) { | ||
localVarQueryParameter['is_published'] = is_published; | ||
} | ||
@@ -70,2 +150,80 @@ | ||
}, | ||
/** | ||
* | ||
* @summary Mark notification as read by user | ||
* @param {number} notificationID | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
updateNotificationMarkRead: async (notificationID: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => { | ||
// verify required parameter 'notificationID' is not null or undefined | ||
if (notificationID === null || notificationID === undefined) { | ||
throw new RequiredError('notificationID','Required parameter notificationID was null or undefined when calling updateNotificationMarkRead.'); | ||
} | ||
const localVarPath = `/news/notifications/{notificationID}/mark_read/` | ||
.replace(`{${"notificationID"}}`, encodeURIComponent(String(notificationID))); | ||
// use dummy base URL string because the URL constructor only accepts absolute URLs. | ||
const localVarUrlObj = new URL(localVarPath, 'https://example.com'); | ||
let baseOptions; | ||
if (configuration) { | ||
baseOptions = configuration.baseOptions; | ||
} | ||
const localVarRequestOptions :AxiosRequestConfig = { method: 'PATCH', ...baseOptions, ...options}; | ||
const localVarHeaderParameter = {} as any; | ||
const localVarQueryParameter = {} as any; | ||
// authentication bearerAuth required | ||
const query = new URLSearchParams(localVarUrlObj.search); | ||
for (const key in localVarQueryParameter) { | ||
query.set(key, localVarQueryParameter[key]); | ||
} | ||
for (const key in options.params) { | ||
query.set(key, options.params[key]); | ||
} | ||
localVarUrlObj.search = (new URLSearchParams(query)).toString(); | ||
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; | ||
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; | ||
return { | ||
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash, | ||
options: localVarRequestOptions, | ||
}; | ||
}, | ||
/** | ||
* | ||
* @summary Mark all notifications as read by user | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
updateNotificationMarkReadAll: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => { | ||
const localVarPath = `/news/notifications/mark_read_all/`; | ||
// use dummy base URL string because the URL constructor only accepts absolute URLs. | ||
const localVarUrlObj = new URL(localVarPath, 'https://example.com'); | ||
let baseOptions; | ||
if (configuration) { | ||
baseOptions = configuration.baseOptions; | ||
} | ||
const localVarRequestOptions :AxiosRequestConfig = { method: 'PATCH', ...baseOptions, ...options}; | ||
const localVarHeaderParameter = {} as any; | ||
const localVarQueryParameter = {} as any; | ||
// authentication bearerAuth required | ||
const query = new URLSearchParams(localVarUrlObj.search); | ||
for (const key in localVarQueryParameter) { | ||
query.set(key, localVarQueryParameter[key]); | ||
} | ||
for (const key in options.params) { | ||
query.set(key, options.params[key]); | ||
} | ||
localVarUrlObj.search = (new URLSearchParams(query)).toString(); | ||
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; | ||
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers}; | ||
return { | ||
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash, | ||
options: localVarRequestOptions, | ||
}; | ||
}, | ||
} | ||
@@ -82,9 +240,36 @@ }; | ||
* | ||
* @summary Get notification content | ||
* @param {number} notificationID | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
async getNotification(notificationID: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<NotificationDetail>>> { | ||
const localVarAxiosArgs = await NewsApiAxiosParamCreator(configuration).getNotification(notificationID, options); | ||
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { | ||
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; | ||
return axios.request(axiosRequestArgs); | ||
}; | ||
}, | ||
/** | ||
* | ||
* @summary Get unread notifications count | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
async getNotificationsUnreadCount(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<NotificationUnreadCount>>> { | ||
const localVarAxiosArgs = await NewsApiAxiosParamCreator(configuration).getNotificationsUnreadCount(options); | ||
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { | ||
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; | ||
return axios.request(axiosRequestArgs); | ||
}; | ||
}, | ||
/** | ||
* | ||
* @summary Get notifications list | ||
* @param {number} [max] | ||
* @param {boolean} [is_published] | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
async listNotifications(max?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Notification>>>> { | ||
const localVarAxiosArgs = await NewsApiAxiosParamCreator(configuration).listNotifications(max, options); | ||
async listNotifications(is_published?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Notification>>>> { | ||
const localVarAxiosArgs = await NewsApiAxiosParamCreator(configuration).listNotifications(is_published, options); | ||
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { | ||
@@ -95,2 +280,29 @@ const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; | ||
}, | ||
/** | ||
* | ||
* @summary Mark notification as read by user | ||
* @param {number} notificationID | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
async updateNotificationMarkRead(notificationID: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>> { | ||
const localVarAxiosArgs = await NewsApiAxiosParamCreator(configuration).updateNotificationMarkRead(notificationID, options); | ||
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { | ||
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; | ||
return axios.request(axiosRequestArgs); | ||
}; | ||
}, | ||
/** | ||
* | ||
* @summary Mark all notifications as read by user | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
async updateNotificationMarkReadAll(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>> { | ||
const localVarAxiosArgs = await NewsApiAxiosParamCreator(configuration).updateNotificationMarkReadAll(options); | ||
return (axios: AxiosInstance = globalAxios, basePath: string = BASE_PATH) => { | ||
const axiosRequestArgs :AxiosRequestConfig = {...localVarAxiosArgs.options, url: basePath + localVarAxiosArgs.url}; | ||
return axios.request(axiosRequestArgs); | ||
}; | ||
}, | ||
} | ||
@@ -107,10 +319,48 @@ }; | ||
* | ||
* @summary Get notification content | ||
* @param {number} notificationID | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
async getNotification(notificationID: number, options?: AxiosRequestConfig): Promise<AxiosResponse<NotificationDetail>> { | ||
return NewsApiFp(configuration).getNotification(notificationID, options).then((request) => request(axios, basePath)); | ||
}, | ||
/** | ||
* | ||
* @summary Get unread notifications count | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
async getNotificationsUnreadCount(options?: AxiosRequestConfig): Promise<AxiosResponse<NotificationUnreadCount>> { | ||
return NewsApiFp(configuration).getNotificationsUnreadCount(options).then((request) => request(axios, basePath)); | ||
}, | ||
/** | ||
* | ||
* @summary Get notifications list | ||
* @param {number} [max] | ||
* @param {boolean} [is_published] | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
async listNotifications(max?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Notification>>> { | ||
return NewsApiFp(configuration).listNotifications(max, options).then((request) => request(axios, basePath)); | ||
async listNotifications(is_published?: boolean, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Notification>>> { | ||
return NewsApiFp(configuration).listNotifications(is_published, options).then((request) => request(axios, basePath)); | ||
}, | ||
/** | ||
* | ||
* @summary Mark notification as read by user | ||
* @param {number} notificationID | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
async updateNotificationMarkRead(notificationID: number, options?: AxiosRequestConfig): Promise<AxiosResponse<void>> { | ||
return NewsApiFp(configuration).updateNotificationMarkRead(notificationID, options).then((request) => request(axios, basePath)); | ||
}, | ||
/** | ||
* | ||
* @summary Mark all notifications as read by user | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
async updateNotificationMarkReadAll(options?: AxiosRequestConfig): Promise<AxiosResponse<void>> { | ||
return NewsApiFp(configuration).updateNotificationMarkReadAll(options).then((request) => request(axios, basePath)); | ||
}, | ||
}; | ||
@@ -128,4 +378,25 @@ }; | ||
* | ||
* @summary Get notification content | ||
* @param {number} notificationID | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
* @memberof NewsApi | ||
*/ | ||
public async getNotification(notificationID: number, options?: AxiosRequestConfig) : Promise<AxiosResponse<NotificationDetail>> { | ||
return NewsApiFp(this.configuration).getNotification(notificationID, options).then((request) => request(this.axios, this.basePath)); | ||
} | ||
/** | ||
* | ||
* @summary Get unread notifications count | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
* @memberof NewsApi | ||
*/ | ||
public async getNotificationsUnreadCount(options?: AxiosRequestConfig) : Promise<AxiosResponse<NotificationUnreadCount>> { | ||
return NewsApiFp(this.configuration).getNotificationsUnreadCount(options).then((request) => request(this.axios, this.basePath)); | ||
} | ||
/** | ||
* | ||
* @summary Get notifications list | ||
* @param {number} [max] | ||
* @param {boolean} [is_published] | ||
* @param {*} [options] Override http request option. | ||
@@ -135,5 +406,26 @@ * @throws {RequiredError} | ||
*/ | ||
public async listNotifications(max?: number, options?: AxiosRequestConfig) : Promise<AxiosResponse<Array<Notification>>> { | ||
return NewsApiFp(this.configuration).listNotifications(max, options).then((request) => request(this.axios, this.basePath)); | ||
public async listNotifications(is_published?: boolean, options?: AxiosRequestConfig) : Promise<AxiosResponse<Array<Notification>>> { | ||
return NewsApiFp(this.configuration).listNotifications(is_published, options).then((request) => request(this.axios, this.basePath)); | ||
} | ||
/** | ||
* | ||
* @summary Mark notification as read by user | ||
* @param {number} notificationID | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
* @memberof NewsApi | ||
*/ | ||
public async updateNotificationMarkRead(notificationID: number, options?: AxiosRequestConfig) : Promise<AxiosResponse<void>> { | ||
return NewsApiFp(this.configuration).updateNotificationMarkRead(notificationID, options).then((request) => request(this.axios, this.basePath)); | ||
} | ||
/** | ||
* | ||
* @summary Mark all notifications as read by user | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
* @memberof NewsApi | ||
*/ | ||
public async updateNotificationMarkReadAll(options?: AxiosRequestConfig) : Promise<AxiosResponse<void>> { | ||
return NewsApiFp(this.configuration).updateNotificationMarkReadAll(options).then((request) => request(this.axios, this.basePath)); | ||
} | ||
} |
@@ -23,3 +23,3 @@ /** | ||
export * from './apis/google-api'; | ||
export * from './apis/notifications-api'; | ||
export * from './apis/news-api'; | ||
export * from './apis/wireguard-api'; |
@@ -37,3 +37,3 @@ "use strict"; | ||
__exportStar(require("./apis/google-api"), exports); | ||
__exportStar(require("./apis/notifications-api"), exports); | ||
__exportStar(require("./apis/news-api"), exports); | ||
__exportStar(require("./apis/wireguard-api"), exports); |
@@ -24,3 +24,3 @@ /** | ||
* @summary Data Usage Stats | ||
* @param {string} [aggr_interval] No more than 3 days for hour aggregation type | ||
* @param {string} aggr_interval No more than 3 days for hour aggregation type | ||
* @param {string} [date_after] No more than 3 months between date_after and date_before | ||
@@ -34,3 +34,3 @@ * @param {string} [date_before] No more than 3 months between date_after and date_before | ||
*/ | ||
getDataUsageStats: (aggr_interval?: string, date_after?: string, date_before?: string, device_type__in?: Array<string>, device__in?: Array<string>, sort_by?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; | ||
getDataUsageStats: (aggr_interval: string, date_after?: string, date_before?: string, device_type__in?: Array<string>, device__in?: Array<string>, sort_by?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>; | ||
}; | ||
@@ -45,3 +45,3 @@ /** | ||
* @summary Data Usage Stats | ||
* @param {string} [aggr_interval] No more than 3 days for hour aggregation type | ||
* @param {string} aggr_interval No more than 3 days for hour aggregation type | ||
* @param {string} [date_after] No more than 3 months between date_after and date_before | ||
@@ -55,3 +55,3 @@ * @param {string} [date_before] No more than 3 months between date_after and date_before | ||
*/ | ||
getDataUsageStats(aggr_interval?: string, date_after?: string, date_before?: string, device_type__in?: Array<string>, device__in?: Array<string>, sort_by?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<AggregatedDataUsageStats>>>>; | ||
getDataUsageStats(aggr_interval: string, date_after?: string, date_before?: string, device_type__in?: Array<string>, device__in?: Array<string>, sort_by?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<AggregatedDataUsageStats>>>>; | ||
}; | ||
@@ -66,3 +66,3 @@ /** | ||
* @summary Data Usage Stats | ||
* @param {string} [aggr_interval] No more than 3 days for hour aggregation type | ||
* @param {string} aggr_interval No more than 3 days for hour aggregation type | ||
* @param {string} [date_after] No more than 3 months between date_after and date_before | ||
@@ -76,3 +76,3 @@ * @param {string} [date_before] No more than 3 months between date_after and date_before | ||
*/ | ||
getDataUsageStats(aggr_interval?: string, date_after?: string, date_before?: string, device_type__in?: Array<string>, device__in?: Array<string>, sort_by?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<AggregatedDataUsageStats>>>; | ||
getDataUsageStats(aggr_interval: string, date_after?: string, date_before?: string, device_type__in?: Array<string>, device__in?: Array<string>, sort_by?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<AggregatedDataUsageStats>>>; | ||
}; | ||
@@ -89,3 +89,3 @@ /** | ||
* @summary Data Usage Stats | ||
* @param {string} [aggr_interval] No more than 3 days for hour aggregation type | ||
* @param {string} aggr_interval No more than 3 days for hour aggregation type | ||
* @param {string} [date_after] No more than 3 months between date_after and date_before | ||
@@ -100,3 +100,3 @@ * @param {string} [date_before] No more than 3 months between date_after and date_before | ||
*/ | ||
getDataUsageStats(aggr_interval?: string, date_after?: string, date_before?: string, device_type__in?: Array<string>, device__in?: Array<string>, sort_by?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<AggregatedDataUsageStats>>>; | ||
getDataUsageStats(aggr_interval: string, date_after?: string, date_before?: string, device_type__in?: Array<string>, device__in?: Array<string>, sort_by?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<AggregatedDataUsageStats>>>; | ||
} |
@@ -91,3 +91,3 @@ "use strict"; | ||
* @summary Data Usage Stats | ||
* @param {string} [aggr_interval] No more than 3 days for hour aggregation type | ||
* @param {string} aggr_interval No more than 3 days for hour aggregation type | ||
* @param {string} [date_after] No more than 3 months between date_after and date_before | ||
@@ -106,2 +106,6 @@ * @param {string} [date_before] No more than 3 months between date_after and date_before | ||
return __generator(this, function (_a) { | ||
// verify required parameter 'aggr_interval' is not null or undefined | ||
if (aggr_interval === null || aggr_interval === undefined) { | ||
throw new base_1.RequiredError('aggr_interval', 'Required parameter aggr_interval was null or undefined when calling getDataUsageStats.'); | ||
} | ||
localVarPath = "/analytics/data-usage/"; | ||
@@ -166,3 +170,3 @@ localVarUrlObj = new URL(localVarPath, 'https://example.com'); | ||
* @summary Data Usage Stats | ||
* @param {string} [aggr_interval] No more than 3 days for hour aggregation type | ||
* @param {string} aggr_interval No more than 3 days for hour aggregation type | ||
* @param {string} [date_after] No more than 3 months between date_after and date_before | ||
@@ -205,3 +209,3 @@ * @param {string} [date_before] No more than 3 months between date_after and date_before | ||
* @summary Data Usage Stats | ||
* @param {string} [aggr_interval] No more than 3 days for hour aggregation type | ||
* @param {string} aggr_interval No more than 3 days for hour aggregation type | ||
* @param {string} [date_after] No more than 3 months between date_after and date_before | ||
@@ -238,3 +242,3 @@ * @param {string} [date_before] No more than 3 months between date_after and date_before | ||
* @summary Data Usage Stats | ||
* @param {string} [aggr_interval] No more than 3 days for hour aggregation type | ||
* @param {string} aggr_interval No more than 3 days for hour aggregation type | ||
* @param {string} [date_after] No more than 3 months between date_after and date_before | ||
@@ -241,0 +245,0 @@ * @param {string} [date_before] No more than 3 months between date_after and date_before |
@@ -16,2 +16,4 @@ /** | ||
import { Notification } from '../models'; | ||
import { NotificationDetail } from '../models'; | ||
import { NotificationUnreadCount } from '../models'; | ||
/** | ||
@@ -24,8 +26,38 @@ * NewsApi - axios parameter creator | ||
* | ||
* @summary Get notification content | ||
* @param {number} notificationID | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
getNotification: (notificationID: number, options?: AxiosRequestConfig) => Promise<RequestArgs>; | ||
/** | ||
* | ||
* @summary Get unread notifications count | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
getNotificationsUnreadCount: (options?: AxiosRequestConfig) => Promise<RequestArgs>; | ||
/** | ||
* | ||
* @summary Get notifications list | ||
* @param {number} [max] | ||
* @param {boolean} [is_published] | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
listNotifications: (max?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>; | ||
listNotifications: (is_published?: boolean, options?: AxiosRequestConfig) => Promise<RequestArgs>; | ||
/** | ||
* | ||
* @summary Mark notification as read by user | ||
* @param {number} notificationID | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
updateNotificationMarkRead: (notificationID: number, options?: AxiosRequestConfig) => Promise<RequestArgs>; | ||
/** | ||
* | ||
* @summary Mark all notifications as read by user | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
updateNotificationMarkReadAll: (options?: AxiosRequestConfig) => Promise<RequestArgs>; | ||
}; | ||
@@ -39,8 +71,38 @@ /** | ||
* | ||
* @summary Get notification content | ||
* @param {number} notificationID | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
getNotification(notificationID: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<NotificationDetail>>>; | ||
/** | ||
* | ||
* @summary Get unread notifications count | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
getNotificationsUnreadCount(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<NotificationUnreadCount>>>; | ||
/** | ||
* | ||
* @summary Get notifications list | ||
* @param {number} [max] | ||
* @param {boolean} [is_published] | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
listNotifications(max?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Notification>>>>; | ||
listNotifications(is_published?: boolean, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Notification>>>>; | ||
/** | ||
* | ||
* @summary Mark notification as read by user | ||
* @param {number} notificationID | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
updateNotificationMarkRead(notificationID: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>; | ||
/** | ||
* | ||
* @summary Mark all notifications as read by user | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
updateNotificationMarkReadAll(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<void>>>; | ||
}; | ||
@@ -54,8 +116,38 @@ /** | ||
* | ||
* @summary Get notification content | ||
* @param {number} notificationID | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
getNotification(notificationID: number, options?: AxiosRequestConfig): Promise<AxiosResponse<NotificationDetail>>; | ||
/** | ||
* | ||
* @summary Get unread notifications count | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
getNotificationsUnreadCount(options?: AxiosRequestConfig): Promise<AxiosResponse<NotificationUnreadCount>>; | ||
/** | ||
* | ||
* @summary Get notifications list | ||
* @param {number} [max] | ||
* @param {boolean} [is_published] | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
listNotifications(max?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Notification>>>; | ||
listNotifications(is_published?: boolean, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Notification>>>; | ||
/** | ||
* | ||
* @summary Mark notification as read by user | ||
* @param {number} notificationID | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
updateNotificationMarkRead(notificationID: number, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>; | ||
/** | ||
* | ||
* @summary Mark all notifications as read by user | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
updateNotificationMarkReadAll(options?: AxiosRequestConfig): Promise<AxiosResponse<void>>; | ||
}; | ||
@@ -71,4 +163,21 @@ /** | ||
* | ||
* @summary Get notification content | ||
* @param {number} notificationID | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
* @memberof NewsApi | ||
*/ | ||
getNotification(notificationID: number, options?: AxiosRequestConfig): Promise<AxiosResponse<NotificationDetail>>; | ||
/** | ||
* | ||
* @summary Get unread notifications count | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
* @memberof NewsApi | ||
*/ | ||
getNotificationsUnreadCount(options?: AxiosRequestConfig): Promise<AxiosResponse<NotificationUnreadCount>>; | ||
/** | ||
* | ||
* @summary Get notifications list | ||
* @param {number} [max] | ||
* @param {boolean} [is_published] | ||
* @param {*} [options] Override http request option. | ||
@@ -78,3 +187,20 @@ * @throws {RequiredError} | ||
*/ | ||
listNotifications(max?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Notification>>>; | ||
listNotifications(is_published?: boolean, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Notification>>>; | ||
/** | ||
* | ||
* @summary Mark notification as read by user | ||
* @param {number} notificationID | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
* @memberof NewsApi | ||
*/ | ||
updateNotificationMarkRead(notificationID: number, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>; | ||
/** | ||
* | ||
* @summary Mark all notifications as read by user | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
* @memberof NewsApi | ||
*/ | ||
updateNotificationMarkReadAll(options?: AxiosRequestConfig): Promise<AxiosResponse<void>>; | ||
} |
@@ -90,8 +90,86 @@ "use strict"; | ||
* | ||
* @summary Get notification content | ||
* @param {number} notificationID | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
getNotification: function (notificationID, options) { | ||
if (options === void 0) { options = {}; } | ||
return __awaiter(_this, void 0, void 0, function () { | ||
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, query, key, key, headersFromBaseOptions; | ||
return __generator(this, function (_a) { | ||
// verify required parameter 'notificationID' is not null or undefined | ||
if (notificationID === null || notificationID === undefined) { | ||
throw new base_1.RequiredError('notificationID', 'Required parameter notificationID was null or undefined when calling getNotification.'); | ||
} | ||
localVarPath = "/news/notifications/{notificationID}/" | ||
.replace("{" + "notificationID" + "}", encodeURIComponent(String(notificationID))); | ||
localVarUrlObj = new URL(localVarPath, 'https://example.com'); | ||
if (configuration) { | ||
baseOptions = configuration.baseOptions; | ||
} | ||
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options); | ||
localVarHeaderParameter = {}; | ||
localVarQueryParameter = {}; | ||
query = new URLSearchParams(localVarUrlObj.search); | ||
for (key in localVarQueryParameter) { | ||
query.set(key, localVarQueryParameter[key]); | ||
} | ||
for (key in options.params) { | ||
query.set(key, options.params[key]); | ||
} | ||
localVarUrlObj.search = (new URLSearchParams(query)).toString(); | ||
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; | ||
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers); | ||
return [2 /*return*/, { | ||
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash, | ||
options: localVarRequestOptions, | ||
}]; | ||
}); | ||
}); | ||
}, | ||
/** | ||
* | ||
* @summary Get unread notifications count | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
getNotificationsUnreadCount: function (options) { | ||
if (options === void 0) { options = {}; } | ||
return __awaiter(_this, void 0, void 0, function () { | ||
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, query, key, key, headersFromBaseOptions; | ||
return __generator(this, function (_a) { | ||
localVarPath = "/news/unread_count/"; | ||
localVarUrlObj = new URL(localVarPath, 'https://example.com'); | ||
if (configuration) { | ||
baseOptions = configuration.baseOptions; | ||
} | ||
localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options); | ||
localVarHeaderParameter = {}; | ||
localVarQueryParameter = {}; | ||
query = new URLSearchParams(localVarUrlObj.search); | ||
for (key in localVarQueryParameter) { | ||
query.set(key, localVarQueryParameter[key]); | ||
} | ||
for (key in options.params) { | ||
query.set(key, options.params[key]); | ||
} | ||
localVarUrlObj.search = (new URLSearchParams(query)).toString(); | ||
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; | ||
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers); | ||
return [2 /*return*/, { | ||
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash, | ||
options: localVarRequestOptions, | ||
}]; | ||
}); | ||
}); | ||
}, | ||
/** | ||
* | ||
* @summary Get notifications list | ||
* @param {number} [max] | ||
* @param {boolean} [is_published] | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
listNotifications: function (max, options) { | ||
listNotifications: function (is_published, options) { | ||
if (options === void 0) { options = {}; } | ||
@@ -101,3 +179,3 @@ return __awaiter(_this, void 0, void 0, function () { | ||
return __generator(this, function (_a) { | ||
localVarPath = "/notifications/api/unread_list/"; | ||
localVarPath = "/news/notifications/"; | ||
localVarUrlObj = new URL(localVarPath, 'https://example.com'); | ||
@@ -111,4 +189,4 @@ if (configuration) { | ||
// authentication bearerAuth required | ||
if (max !== undefined) { | ||
localVarQueryParameter['max'] = max; | ||
if (is_published !== undefined) { | ||
localVarQueryParameter['is_published'] = is_published; | ||
} | ||
@@ -132,2 +210,80 @@ query = new URLSearchParams(localVarUrlObj.search); | ||
}, | ||
/** | ||
* | ||
* @summary Mark notification as read by user | ||
* @param {number} notificationID | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
updateNotificationMarkRead: function (notificationID, options) { | ||
if (options === void 0) { options = {}; } | ||
return __awaiter(_this, void 0, void 0, function () { | ||
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, query, key, key, headersFromBaseOptions; | ||
return __generator(this, function (_a) { | ||
// verify required parameter 'notificationID' is not null or undefined | ||
if (notificationID === null || notificationID === undefined) { | ||
throw new base_1.RequiredError('notificationID', 'Required parameter notificationID was null or undefined when calling updateNotificationMarkRead.'); | ||
} | ||
localVarPath = "/news/notifications/{notificationID}/mark_read/" | ||
.replace("{" + "notificationID" + "}", encodeURIComponent(String(notificationID))); | ||
localVarUrlObj = new URL(localVarPath, 'https://example.com'); | ||
if (configuration) { | ||
baseOptions = configuration.baseOptions; | ||
} | ||
localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), options); | ||
localVarHeaderParameter = {}; | ||
localVarQueryParameter = {}; | ||
query = new URLSearchParams(localVarUrlObj.search); | ||
for (key in localVarQueryParameter) { | ||
query.set(key, localVarQueryParameter[key]); | ||
} | ||
for (key in options.params) { | ||
query.set(key, options.params[key]); | ||
} | ||
localVarUrlObj.search = (new URLSearchParams(query)).toString(); | ||
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; | ||
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers); | ||
return [2 /*return*/, { | ||
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash, | ||
options: localVarRequestOptions, | ||
}]; | ||
}); | ||
}); | ||
}, | ||
/** | ||
* | ||
* @summary Mark all notifications as read by user | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
updateNotificationMarkReadAll: function (options) { | ||
if (options === void 0) { options = {}; } | ||
return __awaiter(_this, void 0, void 0, function () { | ||
var localVarPath, localVarUrlObj, baseOptions, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, query, key, key, headersFromBaseOptions; | ||
return __generator(this, function (_a) { | ||
localVarPath = "/news/notifications/mark_read_all/"; | ||
localVarUrlObj = new URL(localVarPath, 'https://example.com'); | ||
if (configuration) { | ||
baseOptions = configuration.baseOptions; | ||
} | ||
localVarRequestOptions = __assign(__assign({ method: 'PATCH' }, baseOptions), options); | ||
localVarHeaderParameter = {}; | ||
localVarQueryParameter = {}; | ||
query = new URLSearchParams(localVarUrlObj.search); | ||
for (key in localVarQueryParameter) { | ||
query.set(key, localVarQueryParameter[key]); | ||
} | ||
for (key in options.params) { | ||
query.set(key, options.params[key]); | ||
} | ||
localVarUrlObj.search = (new URLSearchParams(query)).toString(); | ||
headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {}; | ||
localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers); | ||
return [2 /*return*/, { | ||
url: localVarUrlObj.pathname + localVarUrlObj.search + localVarUrlObj.hash, | ||
options: localVarRequestOptions, | ||
}]; | ||
}); | ||
}); | ||
}, | ||
}; | ||
@@ -143,8 +299,57 @@ }; | ||
* | ||
* @summary Get notification content | ||
* @param {number} notificationID | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
getNotification: function (notificationID, options) { | ||
return __awaiter(this, void 0, void 0, function () { | ||
var localVarAxiosArgs; | ||
return __generator(this, function (_a) { | ||
switch (_a.label) { | ||
case 0: return [4 /*yield*/, exports.NewsApiAxiosParamCreator(configuration).getNotification(notificationID, options)]; | ||
case 1: | ||
localVarAxiosArgs = _a.sent(); | ||
return [2 /*return*/, function (axios, basePath) { | ||
if (axios === void 0) { axios = axios_1.default; } | ||
if (basePath === void 0) { basePath = base_1.BASE_PATH; } | ||
var axiosRequestArgs = __assign(__assign({}, localVarAxiosArgs.options), { url: basePath + localVarAxiosArgs.url }); | ||
return axios.request(axiosRequestArgs); | ||
}]; | ||
} | ||
}); | ||
}); | ||
}, | ||
/** | ||
* | ||
* @summary Get unread notifications count | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
getNotificationsUnreadCount: function (options) { | ||
return __awaiter(this, void 0, void 0, function () { | ||
var localVarAxiosArgs; | ||
return __generator(this, function (_a) { | ||
switch (_a.label) { | ||
case 0: return [4 /*yield*/, exports.NewsApiAxiosParamCreator(configuration).getNotificationsUnreadCount(options)]; | ||
case 1: | ||
localVarAxiosArgs = _a.sent(); | ||
return [2 /*return*/, function (axios, basePath) { | ||
if (axios === void 0) { axios = axios_1.default; } | ||
if (basePath === void 0) { basePath = base_1.BASE_PATH; } | ||
var axiosRequestArgs = __assign(__assign({}, localVarAxiosArgs.options), { url: basePath + localVarAxiosArgs.url }); | ||
return axios.request(axiosRequestArgs); | ||
}]; | ||
} | ||
}); | ||
}); | ||
}, | ||
/** | ||
* | ||
* @summary Get notifications list | ||
* @param {number} [max] | ||
* @param {boolean} [is_published] | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
listNotifications: function (max, options) { | ||
listNotifications: function (is_published, options) { | ||
return __awaiter(this, void 0, void 0, function () { | ||
@@ -154,3 +359,3 @@ var localVarAxiosArgs; | ||
switch (_a.label) { | ||
case 0: return [4 /*yield*/, exports.NewsApiAxiosParamCreator(configuration).listNotifications(max, options)]; | ||
case 0: return [4 /*yield*/, exports.NewsApiAxiosParamCreator(configuration).listNotifications(is_published, options)]; | ||
case 1: | ||
@@ -168,2 +373,51 @@ localVarAxiosArgs = _a.sent(); | ||
}, | ||
/** | ||
* | ||
* @summary Mark notification as read by user | ||
* @param {number} notificationID | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
updateNotificationMarkRead: function (notificationID, options) { | ||
return __awaiter(this, void 0, void 0, function () { | ||
var localVarAxiosArgs; | ||
return __generator(this, function (_a) { | ||
switch (_a.label) { | ||
case 0: return [4 /*yield*/, exports.NewsApiAxiosParamCreator(configuration).updateNotificationMarkRead(notificationID, options)]; | ||
case 1: | ||
localVarAxiosArgs = _a.sent(); | ||
return [2 /*return*/, function (axios, basePath) { | ||
if (axios === void 0) { axios = axios_1.default; } | ||
if (basePath === void 0) { basePath = base_1.BASE_PATH; } | ||
var axiosRequestArgs = __assign(__assign({}, localVarAxiosArgs.options), { url: basePath + localVarAxiosArgs.url }); | ||
return axios.request(axiosRequestArgs); | ||
}]; | ||
} | ||
}); | ||
}); | ||
}, | ||
/** | ||
* | ||
* @summary Mark all notifications as read by user | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
updateNotificationMarkReadAll: function (options) { | ||
return __awaiter(this, void 0, void 0, function () { | ||
var localVarAxiosArgs; | ||
return __generator(this, function (_a) { | ||
switch (_a.label) { | ||
case 0: return [4 /*yield*/, exports.NewsApiAxiosParamCreator(configuration).updateNotificationMarkReadAll(options)]; | ||
case 1: | ||
localVarAxiosArgs = _a.sent(); | ||
return [2 /*return*/, function (axios, basePath) { | ||
if (axios === void 0) { axios = axios_1.default; } | ||
if (basePath === void 0) { basePath = base_1.BASE_PATH; } | ||
var axiosRequestArgs = __assign(__assign({}, localVarAxiosArgs.options), { url: basePath + localVarAxiosArgs.url }); | ||
return axios.request(axiosRequestArgs); | ||
}]; | ||
} | ||
}); | ||
}); | ||
}, | ||
}; | ||
@@ -179,14 +433,68 @@ }; | ||
* | ||
* @summary Get notification content | ||
* @param {number} notificationID | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
getNotification: function (notificationID, options) { | ||
return __awaiter(this, void 0, void 0, function () { | ||
return __generator(this, function (_a) { | ||
return [2 /*return*/, exports.NewsApiFp(configuration).getNotification(notificationID, options).then(function (request) { return request(axios, basePath); })]; | ||
}); | ||
}); | ||
}, | ||
/** | ||
* | ||
* @summary Get unread notifications count | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
getNotificationsUnreadCount: function (options) { | ||
return __awaiter(this, void 0, void 0, function () { | ||
return __generator(this, function (_a) { | ||
return [2 /*return*/, exports.NewsApiFp(configuration).getNotificationsUnreadCount(options).then(function (request) { return request(axios, basePath); })]; | ||
}); | ||
}); | ||
}, | ||
/** | ||
* | ||
* @summary Get notifications list | ||
* @param {number} [max] | ||
* @param {boolean} [is_published] | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
listNotifications: function (max, options) { | ||
listNotifications: function (is_published, options) { | ||
return __awaiter(this, void 0, void 0, function () { | ||
return __generator(this, function (_a) { | ||
return [2 /*return*/, exports.NewsApiFp(configuration).listNotifications(max, options).then(function (request) { return request(axios, basePath); })]; | ||
return [2 /*return*/, exports.NewsApiFp(configuration).listNotifications(is_published, options).then(function (request) { return request(axios, basePath); })]; | ||
}); | ||
}); | ||
}, | ||
/** | ||
* | ||
* @summary Mark notification as read by user | ||
* @param {number} notificationID | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
updateNotificationMarkRead: function (notificationID, options) { | ||
return __awaiter(this, void 0, void 0, function () { | ||
return __generator(this, function (_a) { | ||
return [2 /*return*/, exports.NewsApiFp(configuration).updateNotificationMarkRead(notificationID, options).then(function (request) { return request(axios, basePath); })]; | ||
}); | ||
}); | ||
}, | ||
/** | ||
* | ||
* @summary Mark all notifications as read by user | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
*/ | ||
updateNotificationMarkReadAll: function (options) { | ||
return __awaiter(this, void 0, void 0, function () { | ||
return __generator(this, function (_a) { | ||
return [2 /*return*/, exports.NewsApiFp(configuration).updateNotificationMarkReadAll(options).then(function (request) { return request(axios, basePath); })]; | ||
}); | ||
}); | ||
}, | ||
}; | ||
@@ -207,4 +515,35 @@ }; | ||
* | ||
* @summary Get notification content | ||
* @param {number} notificationID | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
* @memberof NewsApi | ||
*/ | ||
NewsApi.prototype.getNotification = function (notificationID, options) { | ||
return __awaiter(this, void 0, void 0, function () { | ||
var _this = this; | ||
return __generator(this, function (_a) { | ||
return [2 /*return*/, exports.NewsApiFp(this.configuration).getNotification(notificationID, options).then(function (request) { return request(_this.axios, _this.basePath); })]; | ||
}); | ||
}); | ||
}; | ||
/** | ||
* | ||
* @summary Get unread notifications count | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
* @memberof NewsApi | ||
*/ | ||
NewsApi.prototype.getNotificationsUnreadCount = function (options) { | ||
return __awaiter(this, void 0, void 0, function () { | ||
var _this = this; | ||
return __generator(this, function (_a) { | ||
return [2 /*return*/, exports.NewsApiFp(this.configuration).getNotificationsUnreadCount(options).then(function (request) { return request(_this.axios, _this.basePath); })]; | ||
}); | ||
}); | ||
}; | ||
/** | ||
* | ||
* @summary Get notifications list | ||
* @param {number} [max] | ||
* @param {boolean} [is_published] | ||
* @param {*} [options] Override http request option. | ||
@@ -214,12 +553,43 @@ * @throws {RequiredError} | ||
*/ | ||
NewsApi.prototype.listNotifications = function (max, options) { | ||
NewsApi.prototype.listNotifications = function (is_published, options) { | ||
return __awaiter(this, void 0, void 0, function () { | ||
var _this = this; | ||
return __generator(this, function (_a) { | ||
return [2 /*return*/, exports.NewsApiFp(this.configuration).listNotifications(max, options).then(function (request) { return request(_this.axios, _this.basePath); })]; | ||
return [2 /*return*/, exports.NewsApiFp(this.configuration).listNotifications(is_published, options).then(function (request) { return request(_this.axios, _this.basePath); })]; | ||
}); | ||
}); | ||
}; | ||
/** | ||
* | ||
* @summary Mark notification as read by user | ||
* @param {number} notificationID | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
* @memberof NewsApi | ||
*/ | ||
NewsApi.prototype.updateNotificationMarkRead = function (notificationID, options) { | ||
return __awaiter(this, void 0, void 0, function () { | ||
var _this = this; | ||
return __generator(this, function (_a) { | ||
return [2 /*return*/, exports.NewsApiFp(this.configuration).updateNotificationMarkRead(notificationID, options).then(function (request) { return request(_this.axios, _this.basePath); })]; | ||
}); | ||
}); | ||
}; | ||
/** | ||
* | ||
* @summary Mark all notifications as read by user | ||
* @param {*} [options] Override http request option. | ||
* @throws {RequiredError} | ||
* @memberof NewsApi | ||
*/ | ||
NewsApi.prototype.updateNotificationMarkReadAll = function (options) { | ||
return __awaiter(this, void 0, void 0, function () { | ||
var _this = this; | ||
return __generator(this, function (_a) { | ||
return [2 /*return*/, exports.NewsApiFp(this.configuration).updateNotificationMarkReadAll(options).then(function (request) { return request(_this.axios, _this.basePath); })]; | ||
}); | ||
}); | ||
}; | ||
return NewsApi; | ||
}(base_1.BaseAPI)); | ||
exports.NewsApi = NewsApi; |
@@ -15,3 +15,3 @@ /** | ||
import { RequestArgs, BaseAPI } from '../base'; | ||
import { Notification } from '../models'; | ||
import { ModelObject } from '../models'; | ||
import { NotificationUnreadCount } from '../models'; | ||
@@ -75,3 +75,3 @@ /** | ||
*/ | ||
listNotifications(max?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<Array<Notification>>>>; | ||
listNotifications(max?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => Promise<AxiosResponse<ModelObject>>>; | ||
/** | ||
@@ -114,3 +114,3 @@ * | ||
*/ | ||
listNotifications(max?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Notification>>>; | ||
listNotifications(max?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<ModelObject>>; | ||
/** | ||
@@ -157,3 +157,3 @@ * | ||
*/ | ||
listNotifications(max?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<Array<Notification>>>; | ||
listNotifications(max?: number, options?: AxiosRequestConfig): Promise<AxiosResponse<ModelObject>>; | ||
/** | ||
@@ -160,0 +160,0 @@ * |
@@ -35,4 +35,6 @@ export * from './ad-placement'; | ||
export * from './device-type'; | ||
export * from './discount'; | ||
export * from './environment'; | ||
export * from './fcmdevice'; | ||
export * from './featured-image'; | ||
export * from './friendship'; | ||
@@ -45,2 +47,3 @@ export * from './friendship-invitation'; | ||
export * from './notification'; | ||
export * from './notification-detail'; | ||
export * from './notification-unread-count'; | ||
@@ -47,0 +50,0 @@ export * from './payment-method'; |
@@ -47,4 +47,6 @@ "use strict"; | ||
__exportStar(require("./device-type"), exports); | ||
__exportStar(require("./discount"), exports); | ||
__exportStar(require("./environment"), exports); | ||
__exportStar(require("./fcmdevice"), exports); | ||
__exportStar(require("./featured-image"), exports); | ||
__exportStar(require("./friendship"), exports); | ||
@@ -57,2 +59,3 @@ __exportStar(require("./friendship-invitation"), exports); | ||
__exportStar(require("./notification"), exports); | ||
__exportStar(require("./notification-detail"), exports); | ||
__exportStar(require("./notification-unread-count"), exports); | ||
@@ -59,0 +62,0 @@ __exportStar(require("./payment-method"), exports); |
@@ -23,3 +23,3 @@ /** | ||
*/ | ||
unread_count: number; | ||
count: number; | ||
} |
@@ -12,2 +12,3 @@ /** | ||
*/ | ||
import { FeaturedImage } from './featured-image'; | ||
/** | ||
@@ -27,6 +28,6 @@ * | ||
* | ||
* @type {number} | ||
* @type {Date} | ||
* @memberof Notification | ||
*/ | ||
slug: number; | ||
created_at: Date; | ||
/** | ||
@@ -43,24 +44,21 @@ * | ||
*/ | ||
description: string; | ||
summary: string; | ||
/** | ||
* | ||
* @type {FeaturedImage} | ||
* @memberof Notification | ||
*/ | ||
featured_image: FeaturedImage; | ||
/** | ||
* | ||
* @type {boolean} | ||
* @memberof Notification | ||
*/ | ||
unread: boolean; | ||
is_unread: boolean; | ||
/** | ||
* | ||
* @type {string} | ||
* @type {boolean} | ||
* @memberof Notification | ||
*/ | ||
type: NotificationTypeEnum; | ||
is_featured: boolean; | ||
} | ||
/** | ||
* @export | ||
* @enum {string} | ||
*/ | ||
export declare enum NotificationTypeEnum { | ||
SystemUpdate = "system_update", | ||
ProductUpdate = "product_update", | ||
NonPaper = "non_paper" | ||
} |
"use strict"; | ||
Object.defineProperty(exports, "__esModule", { value: true }); | ||
exports.NotificationTypeEnum = void 0; | ||
/** | ||
* @export | ||
* @enum {string} | ||
*/ | ||
var NotificationTypeEnum; | ||
(function (NotificationTypeEnum) { | ||
NotificationTypeEnum["SystemUpdate"] = "system_update"; | ||
NotificationTypeEnum["ProductUpdate"] = "product_update"; | ||
NotificationTypeEnum["NonPaper"] = "non_paper"; | ||
})(NotificationTypeEnum = exports.NotificationTypeEnum || (exports.NotificationTypeEnum = {})); |
@@ -13,2 +13,3 @@ /** | ||
import { Bundle } from './bundle'; | ||
import { Discount } from './discount'; | ||
import { Price } from './price'; | ||
@@ -58,2 +59,14 @@ import { Recurring } from './recurring'; | ||
recurring?: Recurring; | ||
/** | ||
* | ||
* @type {Discount} | ||
* @memberof Product | ||
*/ | ||
discount?: Discount; | ||
/** | ||
* | ||
* @type {boolean} | ||
* @memberof Product | ||
*/ | ||
is_most_popular?: boolean; | ||
} |
@@ -35,4 +35,6 @@ export * from './ad-placement'; | ||
export * from './device-type'; | ||
export * from './discount'; | ||
export * from './environment'; | ||
export * from './fcmdevice'; | ||
export * from './featured-image'; | ||
export * from './friendship'; | ||
@@ -45,2 +47,3 @@ export * from './friendship-invitation'; | ||
export * from './notification'; | ||
export * from './notification-detail'; | ||
export * from './notification-unread-count'; | ||
@@ -47,0 +50,0 @@ export * from './payment-method'; |
@@ -25,3 +25,3 @@ /* tslint:disable */ | ||
*/ | ||
unread_count: number; | ||
count: number; | ||
} |
@@ -14,2 +14,3 @@ /* tslint:disable */ | ||
*/ | ||
import { FeaturedImage } from './featured-image'; | ||
/** | ||
@@ -29,6 +30,6 @@ * | ||
* | ||
* @type {number} | ||
* @type {Date} | ||
* @memberof Notification | ||
*/ | ||
slug: number; | ||
created_at: Date; | ||
/** | ||
@@ -45,26 +46,21 @@ * | ||
*/ | ||
description: string; | ||
summary: string; | ||
/** | ||
* | ||
* @type {FeaturedImage} | ||
* @memberof Notification | ||
*/ | ||
featured_image: FeaturedImage; | ||
/** | ||
* | ||
* @type {boolean} | ||
* @memberof Notification | ||
*/ | ||
unread: boolean; | ||
is_unread: boolean; | ||
/** | ||
* | ||
* @type {string} | ||
* @type {boolean} | ||
* @memberof Notification | ||
*/ | ||
type: NotificationTypeEnum; | ||
is_featured: boolean; | ||
} | ||
/** | ||
* @export | ||
* @enum {string} | ||
*/ | ||
export enum NotificationTypeEnum { | ||
SystemUpdate = 'system_update', | ||
ProductUpdate = 'product_update', | ||
NonPaper = 'non_paper' | ||
} | ||
@@ -15,2 +15,3 @@ /* tslint:disable */ | ||
import { Bundle } from './bundle'; | ||
import { Discount } from './discount'; | ||
import { Price } from './price'; | ||
@@ -60,2 +61,14 @@ import { Recurring } from './recurring'; | ||
recurring?: Recurring; | ||
/** | ||
* | ||
* @type {Discount} | ||
* @memberof Product | ||
*/ | ||
discount?: Discount; | ||
/** | ||
* | ||
* @type {boolean} | ||
* @memberof Product | ||
*/ | ||
is_most_popular?: boolean; | ||
} |
{ | ||
"name": "@forestvpn/forestvpn_api", | ||
"version": "3.3.3", | ||
"version": "3.3.4", | ||
"description": "A package to interact api.forestvpn.com (manage vpn profiles, check usage statistics, manage locations, ...)", | ||
@@ -5,0 +5,0 @@ "author": "ForestVPN", |
1058879
275
24983