Adds setting resource with accompanying tests

src/index.test.ts

@@ -1,4 +1,5 @@
 import OpenApi from './index';
+import Setting from './resources/setting';
 import User from './resources/user';
 
 it('will be constructed with appropriate required options', async () => {
@@ -32,3 +33,12 @@ it('can access the user resource', async () => {
   expect(instance).toHaveProperty('users');
   expect(instance.users).toBeInstanceOf(User.prototype.constructor);
 });
+
+it('can access the setting resource', async () => {
+  const instance = new OpenApi({
+    domain: 'admin',
+  });
+
+  expect(instance).toHaveProperty('settings');
+  expect(instance.settings).toBeInstanceOf(Setting.prototype.constructor);
+});

src/index.ts

@@ -1,21 +1,28 @@
 import { AxiosInstance } from 'axios';
 
 import Client from './client';
+import Setting from './resources/setting';
 import User from './resources/user';
 import { OpenApiOptions } from './types/options';
-import { UserResource } from './types/resources';
+import { Resource, UserResource } from './types/resources';
 
 export default class OpenApi {
   protected client: AxiosInstance;
   protected options: OpenApiOptions;
+  protected setting: Resource;
   protected user: UserResource;
 
   constructor({ domain, version = 'v2' }: OpenApiOptions) {
     this.client = Client({ domain, version });
     this.options = { domain, version };
+    this.setting = new Setting(this.client);
     this.user = new User(this.client);
   }
 
+  get settings(): Resource {
+    return this.setting;
+  }
+
   get users(): UserResource {
     return this.user;
   }

src/resources/setting.test.ts

@@ -0,0 +1,12 @@
+import mockAxios from 'axios';
+
+import Setting from './setting';
+
+it('can get settings', async () => {
+  const resource = new Setting(mockAxios);
+
+  await resource.get();
+
+  expect(mockAxios.get).toHaveBeenCalledTimes(1);
+  expect(mockAxios.get).toHaveBeenCalledWith('settings');
+});

src/resources/setting.ts

@@ -0,0 +1,15 @@
+import { AxiosInstance } from 'axios';
+
+import { Resource } from '../types/resources';
+
+export default class Setting implements Resource {
+  protected client: AxiosInstance;
+
+  constructor(client: AxiosInstance) {
+    this.client = client;
+  }
+
+  public async get(): Promise<any> {
+    return await this.client.get('settings');
+  }
+}

src/resources/user.test.ts

@@ -1,4 +1,5 @@
 import mockAxios from 'axios';
+
 import User from './user';
 
 it('will set assigned filter', async () => {

src/types/resources.d.ts

@@ -1,13 +1,15 @@
-export interface Resource {
-  get(): Promise<any>;
+export interface Pageable extends Sortable {
+  on(page: number): this;
 
-  sortBy(sortable: string): this;
+  take(limit: number): this;
 }
 
-export interface Pageable extends Resource {
-  on(page: number): this;
+export interface Resource {
+  get(): Promise<any>;
+}
 
-  take(limit: number): this;
+export interface Sortable extends Resource {
+  sortBy(sortable: string): this;
 }
 
 export interface UserResource extends Pageable {