useresponse 0.0.1 → 1.0.0

package/README.md

@@ -1,6 +1,6 @@
 # useresponse [![npm version](https://img.shields.io/npm/v/useresponse.svg)](https://www.npmjs.com/package/useresponse)
 
-A [useresponse](https://useresponse) API client. For a documentation on the API see [https://api.useresponse.com](https://api.useresponse.com).
+A [useresponse](https://www.useresponse.com/) API client. For a documentation on the API see [https://api.useresponse.com](https://api.useresponse.com).
 
 ### Installation
 
@@ -15,16 +15,21 @@ A complete documentation is available at https://ffflorian.github.io/api-clients
 ```ts
 import {UseResponse} from 'useresponse';
 
-const useResponse = new UseResponse();
+const useResponse = new UseResponse({apiKey: 'your-api-key'});
 
 useResponse
-  .api.search.searchPackage('useresponse')
+  .api.objects.addObject({
+    content: 'How do I reset my password?',
+    object_type: 'ticket',
+    ownership: 'helpdesk',
+    title: 'Password reset help',
+  })
   .then(data => {
     ...
   });
 
 useResponse
-  .api.search.getSuggestions('useresponse')
+  .api.comments.getComments()
   .then(data => {
     ...
   });

package/dist/Endpoints.d.ts

@@ -0,0 +1,74 @@
+export declare const Endpoint: {
+    Additional: {
+        forums(): string;
+        statuses(): string;
+    };
+    Auth: {
+        login(): string;
+    };
+    Categories: {
+        categoryById(id: string): string;
+        listOfCategories(): string;
+    };
+    Changelog: {
+        objects(id: string): string;
+        users(id: string): string;
+    };
+    Chats: {
+        chat(id: string): string;
+        chats(): string;
+        messages(chatId: string): string;
+    };
+    Comments: {
+        comments(): string;
+        editComment(commentId: string): string;
+        objectComments(objectId: string): string;
+        recoveryComment(commentId: string): string;
+        toggleBestComment(commentId: string): string;
+        toggleVoteComment(commentId: string): string;
+        trashComment(commentId: string): string;
+    };
+    CustomFields: {
+        objectCustomFields(): string;
+        userCustomFields(): string;
+    };
+    Moderation: {
+        approveComment(commentId: string): string;
+        approveTopic(topicId: string): string;
+        declineComment(commentId: string): string;
+        declineTopic(topicId: string): string;
+    };
+    Objects: {
+        archive(id: string): string;
+        attachFile(id: string): string;
+        commentsToggle(id: string): string;
+        object(id: string): string;
+        objects(): string;
+        search(): string;
+        subscribe(id: string): string;
+        tickets(): string;
+        toggleVote(id: string): string;
+        trash(id: string): string;
+        unsubscribe(id: string): string;
+    };
+    Reports: {
+        reportObjects(reportId: string): string;
+        reportsList(): string;
+    };
+    UserNotes: {
+        add(userId: string): string;
+        delete(noteId: string): string;
+        edit(noteId: string): string;
+        notes(userId: string): string;
+    };
+    Users: {
+        activity(userId: string): string;
+        banUser(userId: string): string;
+        changePassword(userId: string): string;
+        me(): string;
+        searchUsers(): string;
+        updateProfile(): string;
+        user(id: string): string;
+        users(): string;
+    };
+};

package/dist/Endpoints.js

@@ -0,0 +1,173 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Endpoint = void 0;
+exports.Endpoint = {
+    Additional: {
+        forums() {
+            return '/forums.json';
+        },
+        statuses() {
+            return '/statuses.json';
+        },
+    },
+    Auth: {
+        login() {
+            return '/auth/login.json';
+        },
+    },
+    Categories: {
+        categoryById(id) {
+            return `/categories/${id}.json`;
+        },
+        listOfCategories() {
+            return '/categories.json';
+        },
+    },
+    Changelog: {
+        objects(id) {
+            return `/changelog/object/${id}.json`;
+        },
+        users(id) {
+            return `/changelog/user/${id}.json`;
+        },
+    },
+    Chats: {
+        chat(id) {
+            return `/chats/${id}.json`;
+        },
+        chats() {
+            return '/chats.json';
+        },
+        messages(chatId) {
+            return `/chats/${chatId}/messages.json`;
+        },
+    },
+    Comments: {
+        comments() {
+            return '/comments.json';
+        },
+        editComment(commentId) {
+            return `/comments/${commentId}/edit.json`;
+        },
+        objectComments(objectId) {
+            return `/objects/${objectId}/comments.json`;
+        },
+        recoveryComment(commentId) {
+            return `/comments/${commentId}/recovery.json`;
+        },
+        toggleBestComment(commentId) {
+            return `/comments/${commentId}/best/toggle.json`;
+        },
+        toggleVoteComment(commentId) {
+            return `/comments/${commentId}/votes/toggle.json`;
+        },
+        trashComment(commentId) {
+            return `/comments/${commentId}/trash.json`;
+        },
+    },
+    CustomFields: {
+        objectCustomFields() {
+            return '/objects/custom-fields/list.json';
+        },
+        userCustomFields() {
+            return '/users/custom-fields/list.json';
+        },
+    },
+    Moderation: {
+        approveComment(commentId) {
+            return `/comment/${commentId}/approve.json`;
+        },
+        approveTopic(topicId) {
+            return `/topic/${topicId}/approve.json`;
+        },
+        declineComment(commentId) {
+            return `/comment/${commentId}/decline.json`;
+        },
+        declineTopic(topicId) {
+            return `/topic/${topicId}/decline.json`;
+        },
+    },
+    Objects: {
+        archive(id) {
+            return `/objects/${id}/archive.json`;
+        },
+        attachFile(id) {
+            return `/objects/${id}/attach-file.json`;
+        },
+        commentsToggle(id) {
+            return `/objects/${id}/comments/toggle.json`;
+        },
+        object(id) {
+            return `/objects/${id}.json`;
+        },
+        objects() {
+            return '/objects.json';
+        },
+        search() {
+            return '/search.json';
+        },
+        subscribe(id) {
+            return `/objects/${id}/subscribe.json`;
+        },
+        tickets() {
+            return '/tickets.json';
+        },
+        toggleVote(id) {
+            return `/objects/${id}/votes/toggle.json`;
+        },
+        trash(id) {
+            return `/objects/${id}/trash.json`;
+        },
+        unsubscribe(id) {
+            return `/objects/${id}/unsubscribe.json`;
+        },
+    },
+    Reports: {
+        reportObjects(reportId) {
+            return `/report/${reportId}/objects.json`;
+        },
+        reportsList() {
+            return '/reports/list.json';
+        },
+    },
+    UserNotes: {
+        add(userId) {
+            return `/users/${userId}/notes/add.json`;
+        },
+        delete(noteId) {
+            return `/users/notes/${noteId}/delete.json`;
+        },
+        edit(noteId) {
+            return `/users/notes/${noteId}/edit.json`;
+        },
+        notes(userId) {
+            return `/users/${userId}/notes.json`;
+        },
+    },
+    Users: {
+        activity(userId) {
+            return `/users/${userId}/activity.json`;
+        },
+        banUser(userId) {
+            return `/users/${userId}/ban.json`;
+        },
+        changePassword(userId) {
+            return `/users/${userId}/change-password.json`;
+        },
+        me() {
+            return '/me.json';
+        },
+        searchUsers() {
+            return '/users/search.json';
+        },
+        updateProfile() {
+            return '/profile/update.json';
+        },
+        user(id) {
+            return `/users/${id}.json`;
+        },
+        users() {
+            return '/users.json';
+        },
+    },
+};

package/dist/UseResponse.d.ts

@@ -0,0 +1,11 @@
+import type { API, ClientOptions } from './interfaces';
+export declare class UseResponse {
+    readonly api: API;
+    private readonly apiClient;
+    constructor(options: ClientOptions);
+    /**
+     * Set a new API URL.
+     * @param newURL The new API url
+     */
+    setApiUrl(newURL: string): void;
+}

package/dist/UseResponse.js

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UseResponse = void 0;
+const api_client_1 = require("@ffflorian/api-client");
+const api_1 = require("./api");
+class UseResponse {
+    constructor(options) {
+        this.apiClient = new api_client_1.APIClient(options.apiUrl || 'https://api.useresponse.com/api/7.0');
+        this.apiClient.interceptors.request.push(config => {
+            if (options.apiKey) {
+                config.url.searchParams.set('api_key', options.apiKey);
+            }
+            return config;
+        });
+        this.api = {
+            additional: new api_1.AdditionalAPI(this.apiClient),
+            auth: new api_1.AuthAPI(this.apiClient),
+            categories: new api_1.CategoriesAPI(this.apiClient),
+            changelog: new api_1.ChangelogAPI(this.apiClient),
+            chats: new api_1.ChatsAPI(this.apiClient),
+            comments: new api_1.CommentsAPI(this.apiClient),
+            customFields: new api_1.CustomFieldsAPI(this.apiClient),
+            moderation: new api_1.ModerationAPI(this.apiClient),
+            objects: new api_1.ObjectsAPI(this.apiClient),
+            reports: new api_1.ReportsAPI(this.apiClient),
+            userNotes: new api_1.UserNotesAPI(this.apiClient),
+            users: new api_1.UsersAPI(this.apiClient),
+        };
+    }
+    /**
+     * Set a new API URL.
+     * @param newURL The new API url
+     */
+    setApiUrl(newURL) {
+        this.apiClient.setBaseURL(newURL);
+    }
+}
+exports.UseResponse = UseResponse;

package/dist/api/AdditionalAPI.d.ts

@@ -0,0 +1,8 @@
+import type { APIClient } from '@ffflorian/api-client';
+import type { Forum, Status } from '../interfaces';
+export declare class AdditionalAPI {
+    private readonly apiClient;
+    constructor(apiClient: APIClient);
+    getForums(): Promise<Forum[]>;
+    getStatuses(): Promise<Status[]>;
+}

package/dist/api/AdditionalAPI.js

@@ -0,0 +1,33 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AdditionalAPI = void 0;
+const Endpoints_1 = require("../Endpoints");
+class AdditionalAPI {
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    getForums() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Additional.forums();
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    getStatuses() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Additional.statuses();
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+}
+exports.AdditionalAPI = AdditionalAPI;

package/dist/api/AuthAPI.d.ts

@@ -0,0 +1,7 @@
+import type { APIClient } from '@ffflorian/api-client';
+import type { LoginData, User } from '../interfaces';
+export declare class AuthAPI {
+    private readonly apiClient;
+    constructor(apiClient: APIClient);
+    login(loginData: LoginData): Promise<User>;
+}

package/dist/api/AuthAPI.js

@@ -0,0 +1,26 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AuthAPI = void 0;
+const Endpoints_1 = require("../Endpoints");
+class AuthAPI {
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    login(loginData) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Auth.login();
+            const { data } = yield this.apiClient.post(endpoint, loginData);
+            return data;
+        });
+    }
+}
+exports.AuthAPI = AuthAPI;

package/dist/api/CategoriesAPI.d.ts

@@ -0,0 +1,13 @@
+import type { APIClient } from '@ffflorian/api-client';
+import type { Category } from '../interfaces';
+interface GetListOptions {
+    ownership?: string;
+    type?: string;
+}
+export declare class CategoriesAPI {
+    private readonly apiClient;
+    constructor(apiClient: APIClient);
+    getCategory(categoryId: string): Promise<Category>;
+    getList(options: GetListOptions): Promise<Category[]>;
+}
+export {};

package/dist/api/CategoriesAPI.js

@@ -0,0 +1,33 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CategoriesAPI = void 0;
+const Endpoints_1 = require("../Endpoints");
+class CategoriesAPI {
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    getCategory(categoryId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Categories.categoryById(categoryId);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    getList(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Categories.listOfCategories();
+            const { data } = yield this.apiClient.get(endpoint, { params: options });
+            return data;
+        });
+    }
+}
+exports.CategoriesAPI = CategoriesAPI;

package/dist/api/ChangelogAPI.d.ts

@@ -0,0 +1,8 @@
+import type { APIClient } from '@ffflorian/api-client';
+import type { Changelog } from '../interfaces';
+export declare class ChangelogAPI {
+    private readonly apiClient;
+    constructor(apiClient: APIClient);
+    getObjectsChangelog(objectId: string): Promise<Changelog[]>;
+    getUsersChangelog(userId: string): Promise<Changelog[]>;
+}

package/dist/api/ChangelogAPI.js

@@ -0,0 +1,33 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChangelogAPI = void 0;
+const Endpoints_1 = require("../Endpoints");
+class ChangelogAPI {
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    getObjectsChangelog(objectId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Changelog.objects(objectId);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    getUsersChangelog(userId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Changelog.users(userId);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+}
+exports.ChangelogAPI = ChangelogAPI;

package/dist/api/ChatsAPI.d.ts

@@ -0,0 +1,13 @@
+import type { APIClient } from '@ffflorian/api-client';
+import { APIResult, Chat, ChatMessagesPaginator } from '../interfaces';
+export interface GetAllChatOptions {
+    authorId?: string;
+    page?: number;
+}
+export declare class ChatsAPI {
+    private readonly apiClient;
+    constructor(apiClient: APIClient);
+    getAllChats(options?: GetAllChatOptions): Promise<APIResult<Chat[]>>;
+    getChat(chatId: string): Promise<APIResult<Chat>>;
+    getMessages(chatId: string): Promise<ChatMessagesPaginator>;
+}

package/dist/api/ChatsAPI.js

@@ -0,0 +1,40 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ChatsAPI = void 0;
+const Endpoints_1 = require("../Endpoints");
+class ChatsAPI {
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    getAllChats(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Chats.chats();
+            const { data } = yield this.apiClient.get(endpoint, { params: options });
+            return data;
+        });
+    }
+    getChat(chatId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Chats.chat(chatId);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    getMessages(chatId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Chats.messages(chatId);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+}
+exports.ChatsAPI = ChatsAPI;

package/dist/api/CommentsAPI.d.ts

@@ -0,0 +1,14 @@
+import type { APIClient } from '@ffflorian/api-client';
+import type { CommentActionResponse, CommentAddParams, CommentEditParams, CommentsListResponse } from '../interfaces';
+export declare class CommentsAPI {
+    private readonly apiClient;
+    constructor(apiClient: APIClient);
+    addComment(comment: CommentAddParams): Promise<CommentActionResponse>;
+    editComment(commentId: string, comment: CommentEditParams): Promise<CommentActionResponse>;
+    getComments(options?: Record<string, unknown>): Promise<CommentsListResponse>;
+    getObjectComments(objectId: string): Promise<CommentsListResponse>;
+    recoverComment(commentId: string): Promise<CommentActionResponse>;
+    toggleBestComment(commentId: string): Promise<CommentActionResponse>;
+    toggleVoteComment(commentId: string): Promise<CommentActionResponse>;
+    trashComment(commentId: string): Promise<CommentActionResponse>;
+}

package/dist/api/CommentsAPI.js

@@ -0,0 +1,75 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommentsAPI = void 0;
+const Endpoints_1 = require("../Endpoints");
+class CommentsAPI {
+    constructor(apiClient) {
+        this.apiClient = apiClient;
+    }
+    addComment(comment) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Comments.comments();
+            const { data } = yield this.apiClient.post(endpoint, comment);
+            return data;
+        });
+    }
+    editComment(commentId, comment) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Comments.editComment(commentId);
+            const { data } = yield this.apiClient.post(endpoint, comment);
+            return data;
+        });
+    }
+    getComments(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Comments.comments();
+            const { data } = yield this.apiClient.get(endpoint, { params: options });
+            return data;
+        });
+    }
+    getObjectComments(objectId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Comments.objectComments(objectId);
+            const { data } = yield this.apiClient.get(endpoint);
+            return data;
+        });
+    }
+    recoverComment(commentId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Comments.recoveryComment(commentId);
+            const { data } = yield this.apiClient.post(endpoint);
+            return data;
+        });
+    }
+    toggleBestComment(commentId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Comments.toggleBestComment(commentId);
+            const { data } = yield this.apiClient.post(endpoint);
+            return data;
+        });
+    }
+    toggleVoteComment(commentId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Comments.toggleVoteComment(commentId);
+            const { data } = yield this.apiClient.post(endpoint);
+            return data;
+        });
+    }
+    trashComment(commentId) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const endpoint = Endpoints_1.Endpoint.Comments.trashComment(commentId);
+            const { data } = yield this.apiClient.post(endpoint);
+            return data;
+        });
+    }
+}
+exports.CommentsAPI = CommentsAPI;

package/dist/api/CustomFieldsAPI.d.ts

@@ -0,0 +1,8 @@
+import type { APIClient } from '@ffflorian/api-client';
+import type { CustomField } from '../interfaces';
+export declare class CustomFieldsAPI {
+    private readonly apiClient;
+    constructor(apiClient: APIClient);
+    getObjectCustomFields(): Promise<CustomField[]>;
+    getUserCustomFields(): Promise<CustomField[]>;
+}