feat: support for pvp team and schema updates

Author: Supamiu

index.ts

@@ -1,3 +1,2 @@
 // Public classes.
-export * from './src/model/index';
 export * from './src/index';

src/index.ts

@@ -1,2 +1,3 @@
 export { XivapiClientModule, XIVAPI_KEY } from './xivapi-client.module';
 export { XivapiService } from './xivapi.service';
+export * from './model/index';

src/model/character-search-result.ts

@@ -1,12 +1,8 @@
 import { CharacterSearchResultRow } from './character-search-result-row';
+import { Pagination } from './pagination';
 
 export interface CharacterSearchResult {
-    Characters: CharacterSearchResultRow[];
+    Results: CharacterSearchResultRow[];
 
-    // TODO change this for normalized pagination
-    PageCurrent: number;
-    PageNext: number;
-    PagePrevious: number;
-    PageTotal: number;
-    Total: number;
+    Pagination: Pagination;
 }

src/model/schema/character/character-response.ts

@@ -1,4 +1,5 @@
 import { Character } from './character';
+import { PvpTeam } from '../pvp-team';
 
 export interface CharacterResponse {
     // TODO
@@ -15,6 +16,5 @@ export interface CharacterResponse {
     // TODO
     Info: any;
 
-    // TODO
-    PvPTeam: any;
+    PvPTeam: PvpTeam;
 }

src/model/schema/index.ts

@@ -1 +1,2 @@
 export * from './character/index';
+export * from './pvp-team/index';

src/model/schema/pvp-team/index.ts

@@ -0,0 +1 @@
+export * from './pvp-team';

src/model/schema/pvp-team/pvp-team-member.ts

@@ -0,0 +1,9 @@
+export interface PvpTeamMember {
+    Avatar: string;
+    FeastMatches: number;
+    ID: number;
+    Name: string;
+    Rank: string;
+    RankIcon: string;
+    Server: string;
+}

src/model/schema/pvp-team/pvp-team.ts

@@ -0,0 +1,9 @@
+import { PvpTeamMember } from './pvp-team-member';
+
+export interface PvpTeam {
+    Crest: [string, string, string];
+    ID: string;
+    Members: PvpTeamMember[];
+    Name: string;
+    Server: string;
+}

src/xivapi.service.ts

@@ -3,6 +3,7 @@ import { HttpClient, HttpParams } from '@angular/common/http';
 import { Observable } from 'rxjs';
 import {
     CharacterSearchResult,
+    PvpTeam,
     XivapiCharacterOptions,
     XivapiEndpoint,
     XivapiList,
@@ -31,8 +32,8 @@ export class XivapiService {
      * @param id The id of the resource for the request.
      * @param options The options of the request, optional.
      */
-    public get(endpoint: XivapiEndpoint, id: number, options?: XivapiRequestOptions): Observable<any> {
-        return this.request<any>(`${XivapiService.API_BASE_URL}/${endpoint}/${id}`, options);
+    public get<T = any>(endpoint: XivapiEndpoint, id: number, options?: XivapiRequestOptions): Observable<T> {
+        return this.request<T>(`${XivapiService.API_BASE_URL}/${endpoint}/${id}`, options);
     }
 
     /**
@@ -41,8 +42,8 @@ export class XivapiService {
      * @param endpoint The endpoint to use for the request.
      * @param options The options of the request, optional.
      */
-    public getList(endpoint: XivapiEndpoint, options?: XivapiRequestOptions): Observable<XivapiList<any>> {
-        return this.request<XivapiList<any>>(`${XivapiService.API_BASE_URL}/${endpoint}`, options);
+    public getList<T = any>(endpoint: XivapiEndpoint, options?: XivapiRequestOptions): Observable<XivapiList<T>> {
+        return this.request<XivapiList<T>>(`${XivapiService.API_BASE_URL}/${endpoint}`, options);
     }
 
     /**
@@ -138,6 +139,15 @@ export class XivapiService {
         return this.request<any>(`${XivapiService.API_BASE_URL}/Linkshell/${lodestoneId}${details ? '/' + details : ''}`, options);
     }
 
+    /**
+     * Gets a PvP team based on its lodestone id (string)
+     *
+     * @param id the id of the team to get.
+     */
+    public getPvPTeam(id: string): Observable<PvpTeam> {
+        return this.request<PvpTeam>(`${XivapiService.API_BASE_URL}/PvPTeam/${id}`);
+    }
+
     /**
      * Gets the list of patches using the /PatchList endpoint.
      * @param options Options of the request.