bungie-net-core
Version:
An easy way to interact with the Bungie.net API
41 lines (40 loc) • 1.57 kB
TypeScript
/**
* Bungie.Net API
* These endpoints constitute the functionality exposed by Bungie.net, both for more traditional website functionality and for connectivity to Bungie video games and their related functionality.
*
* Contact: support@bungie.com
*
* NOTE: This class is auto generated by the bungie-net-core code generator program
* Repository: {@link https://github.com/owens1127/bungie-net-core}
* Do not edit these files manually.
*/
import { GroupType } from './GroupType';
import { GroupDateRange } from './GroupDateRange';
import { GroupSortBy } from './GroupSortBy';
/**
* NOTE: GroupQuery, as of Destiny 2, has essentially two totally different and
* incompatible "modes".
*
* If you are querying for a group, you can pass any of the properties below.
*
* If you are querying for a Clan, you MUST NOT pass any of the following
* properties (they must be null or undefined in your request, not just empty
* string/default values):
*
* - groupMemberCountFilter - localeFilter - tagText
*
* If you pass these, you will get a useless InvalidParameters error.
* @see {@link https://bungie-net.github.io/#/components/schemas/GroupsV2.GroupQuery}
*/
export interface GroupQuery {
readonly name: string;
readonly groupType: GroupType;
readonly creationDate: GroupDateRange;
readonly sortBy: GroupSortBy;
readonly groupMemberCountFilter?: number;
readonly localeFilter: string;
readonly tagText: string;
readonly itemsPerPage: number;
readonly currentPage: number;
readonly requestContinuationToken: string;
}