@selfcommunity/api-services 0.3.3-alpha.0 → 0.3.3-alpha.1

package/lib/esm/services/invite_code/index.d.ts

@@ -0,0 +1,54 @@
+import { AxiosRequestConfig } from 'axios';
+import { SCInviteCodeType } from '@selfcommunity/types';
+export interface InviteCodeApiClientInterface {
+    getSpecificInviteCode(invite_code: string, config?: AxiosRequestConfig): Promise<SCInviteCodeType>;
+}
+/**
+ * Contains all the endpoints needed to manage invite codes.
+ */
+export declare class InviteCodeApiClient {
+    /**
+     * This endpoint retrieves a specific invite code identified by invite_code.
+     * @param invite_code
+     * @param config
+     */
+    static getSpecificInviteCode(invite_code: string, config?: AxiosRequestConfig): Promise<SCInviteCodeType>;
+}
+/**
+ *
+ :::tip InviteCode service can be used in the following way:
+ ```jsx
+ 1. Import the service from our library:
+
+ import {InviteCodeService} from "@selfcommunity/api-services";
+ ```
+ ```jsx
+ 2. Create a function and put the service inside it!
+ The async function `create` will return the paginated list of categories.
+
+ async getSpecificInviteCode() {
+   return await InviteCodeService.getSpecificInviteCode();
+ }
+ ```
+ ```jsx
+ In case of required `params`, just add them inside the brackets.
+
+ async create(data) {
+  return await InviteCodeService.getSpecificInviteCode(invite_code);
+ }
+ ```
+ ```jsx
+ If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
+
+ 1. Declare it(or declare them, it is possible to add multiple params)
+
+ const headers = headers: {Authorization: `Bearer ${yourToken}`}
+
+ 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
+ ```
+ :::
+ */
+export default class InviteCodeService {
+    static getSpecificInviteCode(invite_code: string, config?: AxiosRequestConfig): Promise<SCInviteCodeType>;
+}
+//# sourceMappingURL=index.d.ts.map

package/lib/esm/services/invite_code/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/invite_code/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,kBAAkB,EAAC,MAAM,OAAO,CAAC;AACzC,OAAO,EAAC,gBAAgB,EAAC,MAAM,sBAAsB,CAAC;AAEtD,MAAM,WAAW,4BAA4B;IAC3C,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;CACpG;AAED;;GAEG;AACH,qBAAa,mBAAmB;IAC9B;;;;OAIG;IACH,MAAM,CAAC,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAG1G;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAiB;WACvB,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAGhH"}

package/lib/esm/services/invite_code/index.js

@@ -0,0 +1,66 @@
+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());
+    });
+};
+import Endpoints from '../../constants/Endpoints';
+import { apiRequest } from '../../utils/apiRequest';
+/**
+ * Contains all the endpoints needed to manage invite codes.
+ */
+export class InviteCodeApiClient {
+    /**
+     * This endpoint retrieves a specific invite code identified by invite_code.
+     * @param invite_code
+     * @param config
+     */
+    static getSpecificInviteCode(invite_code, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.InviteCode.url({ invite_code }), method: Endpoints.User.method }));
+    }
+}
+/**
+ *
+ :::tip InviteCode service can be used in the following way:
+ ```jsx
+ 1. Import the service from our library:
+
+ import {InviteCodeService} from "@selfcommunity/api-services";
+ ```
+ ```jsx
+ 2. Create a function and put the service inside it!
+ The async function `create` will return the paginated list of categories.
+
+ async getSpecificInviteCode() {
+   return await InviteCodeService.getSpecificInviteCode();
+ }
+ ```
+ ```jsx
+ In case of required `params`, just add them inside the brackets.
+
+ async create(data) {
+  return await InviteCodeService.getSpecificInviteCode(invite_code);
+ }
+ ```
+ ```jsx
+ If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
+
+ 1. Declare it(or declare them, it is possible to add multiple params)
+
+ const headers = headers: {Authorization: `Bearer ${yourToken}`}
+
+ 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
+ ```
+ :::
+ */
+export default class InviteCodeService {
+    static getSpecificInviteCode(invite_code, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return InviteCodeApiClient.getSpecificInviteCode(invite_code, config);
+        });
+    }
+}
+//# sourceMappingURL=index.js.map

package/lib/esm/services/invite_code/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/invite_code/index.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,SAAS,MAAM,2BAA2B,CAAC;AAClD,OAAO,EAAC,UAAU,EAAC,MAAM,wBAAwB,CAAC;AAQlD;;GAEG;AACH,MAAM,OAAO,mBAAmB;IAC9B;;;;OAIG;IACH,MAAM,CAAC,qBAAqB,CAAC,WAAmB,EAAE,MAA2B;QAC3E,OAAO,UAAU,iCAAK,MAAM,KAAE,GAAG,EAAE,SAAS,CAAC,UAAU,CAAC,GAAG,CAAC,EAAC,WAAW,EAAC,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC,MAAM,IAAE,CAAC;IAC9G,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,CAAC,OAAO,OAAO,iBAAiB;IACpC,MAAM,CAAO,qBAAqB,CAAC,WAAmB,EAAE,MAA2B;;YACjF,OAAO,mBAAmB,CAAC,qBAAqB,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;QACxE,CAAC;KAAA;CACF"}

package/lib/esm/types/account.d.ts

@@ -14,6 +14,10 @@ export interface AccountCreateParams {
      * 	Password field for the account
      */
     password: string;
+    /**
+     * 	Optional Invite Code field for confirm invitation
+     */
+    invite_code?: string;
 }
 export interface AccountVerifyParams {
     /**

package/lib/esm/types/account.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../../../src/types/account.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}
+{"version":3,"file":"account.d.ts","sourceRoot":"","sources":["../../../src/types/account.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,kBAAmB,SAAQ,mBAAmB;IAC7D;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB"}