Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: modified list to include filter #1354

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions packages/restapi/src/lib/channels/getChannels.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import CONSTANTS from '../constantsV2';
import { getAPIBaseUrls, getCAIPAddress } from '../helpers';
import { axiosGet } from '../utils/axiosUtil';
import { parseSettings } from '../utils/parseSettings';

import { SOURCE_TYPES } from '../payloads/constants';
/**
* GET /v1/channels/{addressinCAIP}
*/
Expand All @@ -16,20 +16,22 @@ type getChannelsOptionsType = {
limit?: number;
sort?: string;
order?: string;
}
filter?: keyof typeof SOURCE_TYPES | 'ALL';
};

export const getChannels = async (options: getChannelsOptionsType) => {
const {
env = CONSTANTS.ENV.PROD,
page = 1,
limit = 10,
const {
env = CONSTANTS.ENV.PROD,
page = 1,
limit = 10,
sort = CONSTANTS.FILTER.CHANNEL_LIST.SORT.SUBSCRIBER,
order = CONSTANTS.FILTER.CHANNEL_LIST.ORDER.DESCENDING,
filter = 'ALL',
} = options || {};

const API_BASE_URL = getAPIBaseUrls(env);
const apiEndpoint = `${API_BASE_URL}/v1/channels`;
const requestUrl = `${apiEndpoint}?page=${page}&limit=${limit}&sort=${sort}&order=${order}`;
const requestUrl = `${apiEndpoint}?page=${page}&limit=${limit}&sort=${sort}&order=${order}&filter=${filter}`;

return await axiosGet(requestUrl)
.then((response) => {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { ADDITIONAL_META_TYPE } from '../../lib/payloads/constants';
import { GetAliasInfoOptionsType } from '../alias';
import { NotifictaionType, ProgressHookType } from '../types';
import { SOURCE_TYPES } from '../payloads/constants';

export type SubscriptionOptions = {
account?: string;
Expand Down Expand Up @@ -151,6 +152,7 @@ export type ChannelListOptions = {
limit?: number;
sort?: ChannelListSortType;
order?: ChannelListOrderType;
filter?: keyof typeof SOURCE_TYPES | 'ALL';
};


Expand Down
2 changes: 2 additions & 0 deletions packages/restapi/src/lib/pushNotification/channel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -444,6 +444,7 @@ export class Channel extends PushNotificationBaseClass {
limit,
sort = ChannelListSortType.SUBSCRIBER,
order = ChannelListOrderType.DESCENDING,
filter = 'ALL',
} = options || {};

return await PUSH_CHANNEL.getChannels({
Expand All @@ -452,6 +453,7 @@ export class Channel extends PushNotificationBaseClass {
limit,
sort,
order,
filter
});
} catch (error) {
throw new Error(`Push SDK Error: Contract : channel::list : ${error}`);
Expand Down
12 changes: 12 additions & 0 deletions packages/restapi/tests/lib/notification/channel.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -586,4 +586,16 @@ describe('PushAPI.channel functionality', () => {
expect(res).not.null;
});
});

describe('list', async () => {
it('Should the channel details', async () => {
const res = await userAlice.channel.list({});
expect(res).not.null;
});

it('Should fetch channel details based on the filter', async () => {
const res = await userAlice.channel.list({ filter: 'POLYGON_TEST_AMOY' });
expect(res).not.null;
});
});
});
Loading