Skip to content
Permalink
Browse files

feat: implement new filters in search request

Also added a bit of docs~
  • Loading branch information
Supamiu committed Aug 3, 2018
1 parent 2e95b7a commit a15834f3a70ac1d57dc2fa4eb5e315417108e842
@@ -2,10 +2,13 @@

[![CircleCI](https://circleci.com/gh/xivapi/angular-client/tree/master.svg?style=shield)](https://circleci.com/gh/xivapi/angular-client/tree/master)

## Api documentation
## Documentation

Visit https://xivapi.com/docs for documentation about the web api mapped by this client.

Further documentation for this library available on documentation website: https://xivapi.github.io/angular-client/


## Quick start

Add `XivapiClientModule` to your `AppModule` imports:
@@ -43,7 +46,3 @@ export class FooComponent {
}
}
```

## Documentation

Further documentation available on documentation website: https://xivapi.github.io/angular-client/
@@ -1,9 +1,36 @@
export interface Pagination {
/**
* Current page number.
*/
page: number;

/**
* Next page number, equals false if there's no next page (when you're on the last one).
*/
page_next: number | boolean;

/**
* Previous page number, equals false if there's no previous page (when you're on the first one)
*/
page_prev: number | boolean;

/**
* Total amount of pages.
*/
page_total: number;

/**
* Total amount of results in the current page.
*/
results: number;

/**
* Current maximum amount of results per page.
*/
results_per_page: number;

/**
* Total amount of results.
*/
results_total: number;
}
@@ -1,4 +1,7 @@
export enum SearchAlgo {
/**
* A very basic wild card, for example: ard would match: b-ard-ing or h-ard etc.
*/
WILDCARD = 'wildcard',
MULTI_MATCH = 'multi_match',
QUERY_STRING = 'query_string',
@@ -1,9 +1,21 @@
/**
* Lists all the indexes one can search on /Search endpoint.
*/
export enum SearchIndex {
ACHIEVEMENT = 'achievement',
ACTION = 'action',
BNPCNAME = 'bnpcname', // Enemies
COMPANION = 'companion', // Minions
ENPCRESIDENT = 'enpcresident', // NPCs
/**
* Enemies index.
*/
BNPCNAME = 'bnpcname',
/**
* Minions index.
*/
COMPANION = 'companion',
/**
* NPCs index.
*/
ENPCRESIDENT = 'enpcresident',
EMOTE = 'emote',
FATE = 'fate',
INSTANCECONTENT = 'instancecontent',
@@ -1,7 +1,32 @@
import { XivapiOptions } from './xivapi-options';

/**
* Defines the options to be used for /Character endpoint
*/
export interface XivapiCharacterOptions extends XivapiOptions {
/**
* Elements you want on the character.
*
* | Parameters | Details |
* | --- | --- |
* | data | Get basic profile information (including Minions and Mounts) |
* | friends | Get a list of the characters friends |
* | achievements | Get the characters achievements (if they're public) |
* | record | Get record information of the character |
* | gear | Get Gearsets |
*/
files?: 'data' | 'friends' | 'achievements' | 'record' | 'gea' [];

/**
* Extends profile and gear data
*
* * For profile, this will include information about Grand Companies, full Minion/Mount information etc.
* * For gear, this will include equipment, dye, materia and glamour item details.
*/
extend?: 0 | 1;

/**
* Include characters Free Company information
*/
fc?: 0 | 1;
}

0 comments on commit a15834f

Please sign in to comment.
You can’t perform that action at this time.