@selfcommunity/api-services 0.3.6-alpha.7 → 0.3.6-alpha.8

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

@@ -0,0 +1,54 @@
+import { AxiosRequestConfig } from 'axios';
+import { SCPromoType } from '@selfcommunity/types';
+export interface PromoApiClientInterface {
+    getSpecificPromo(code: string, config?: AxiosRequestConfig): Promise<SCPromoType>;
+}
+/**
+ * Contains all the endpoints needed to manage Promo codes.
+ */
+export declare class PromoApiClient {
+    /**
+     * This endpoint retrieves a specific Promo identified by Promo code.
+     * @param code
+     * @param config
+     */
+    static getSpecificPromo(code: string, config?: AxiosRequestConfig): Promise<SCPromoType>;
+}
+/**
+ *
+ :::tip Promo service can be used in the following way:
+ ```jsx
+ 1. Import the service from our library:
+
+ import {PromoService} 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 getSpecificPromoCode() {
+   return await PromoService.getSpecificPromo();
+ }
+ ```
+ ```jsx
+ In case of required `params`, just add them inside the brackets.
+
+ async create(data) {
+  return await PromoService.getSpecificPromo(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 PromoService {
+    static getSpecificPromo(code: string, config?: AxiosRequestConfig): Promise<SCPromoType>;
+}
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/promo/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,kBAAkB,EAAC,MAAM,OAAO,CAAC;AACzC,OAAO,EAAC,WAAW,EAAC,MAAM,sBAAsB,CAAC;AAEjD,MAAM,WAAW,uBAAuB;IACtC,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;CACnF;AAED;;GAEG;AACH,qBAAa,cAAc;IACzB;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;CAGzF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,CAAC,OAAO,OAAO,YAAY;WAClB,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;CAG/F"}

package/lib/esm/services/promo/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 Promo codes.
+ */
+export class PromoApiClient {
+    /**
+     * This endpoint retrieves a specific Promo identified by Promo code.
+     * @param code
+     * @param config
+     */
+    static getSpecificPromo(code, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.PromoCode.url({ code }), method: Endpoints.User.method }));
+    }
+}
+/**
+ *
+ :::tip Promo service can be used in the following way:
+ ```jsx
+ 1. Import the service from our library:
+
+ import {PromoService} 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 getSpecificPromoCode() {
+   return await PromoService.getSpecificPromo();
+ }
+ ```
+ ```jsx
+ In case of required `params`, just add them inside the brackets.
+
+ async create(data) {
+  return await PromoService.getSpecificPromo(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 PromoService {
+    static getSpecificPromo(code, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return PromoApiClient.getSpecificPromo(code, config);
+        });
+    }
+}
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/promo/index.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,SAAS,MAAM,2BAA2B,CAAC;AAClD,OAAO,EAAC,UAAU,EAAC,MAAM,wBAAwB,CAAC;AAQlD;;GAEG;AACH,MAAM,OAAO,cAAc;IACzB;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,CAAC,IAAY,EAAE,MAA2B;QAC/D,OAAO,UAAU,iCAAK,MAAM,KAAE,GAAG,EAAE,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,EAAC,IAAI,EAAC,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,IAAI,CAAC,MAAM,IAAE,CAAC;IACtG,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiCG;AACH,MAAM,CAAC,OAAO,OAAO,YAAY;IAC/B,MAAM,CAAO,gBAAgB,CAAC,IAAY,EAAE,MAA2B;;YACrE,OAAO,cAAc,CAAC,gBAAgB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACvD,CAAC;KAAA;CACF"}