@selfcommunity/api-services 0.1.28-alpha.3 → 0.1.28
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/cjs/services/category/index.d.ts +76 -49
- package/lib/cjs/services/category/index.d.ts.map +1 -1
- package/lib/cjs/services/category/index.js +91 -65
- package/lib/cjs/services/category/index.js.map +1 -1
- package/lib/cjs/services/comment/index.d.ts +55 -34
- package/lib/cjs/services/comment/index.d.ts.map +1 -1
- package/lib/cjs/services/comment/index.js +65 -45
- package/lib/cjs/services/comment/index.js.map +1 -1
- package/lib/cjs/services/custom_adv/index.d.ts +23 -10
- package/lib/cjs/services/custom_adv/index.d.ts.map +1 -1
- package/lib/cjs/services/custom_adv/index.js +25 -13
- package/lib/cjs/services/custom_adv/index.js.map +1 -1
- package/lib/cjs/services/custom_page/index.d.ts +23 -10
- package/lib/cjs/services/custom_page/index.d.ts.map +1 -1
- package/lib/cjs/services/custom_page/index.js +25 -13
- package/lib/cjs/services/custom_page/index.js.map +1 -1
- package/lib/cjs/services/data_portability/index.d.ts +22 -9
- package/lib/cjs/services/data_portability/index.d.ts.map +1 -1
- package/lib/cjs/services/data_portability/index.js +24 -12
- package/lib/cjs/services/data_portability/index.js.map +1 -1
- package/lib/cjs/services/embed/index.d.ts +43 -25
- package/lib/cjs/services/embed/index.d.ts.map +1 -1
- package/lib/cjs/services/embed/index.js +50 -33
- package/lib/cjs/services/embed/index.js.map +1 -1
- package/lib/cjs/services/feature/index.d.ts +14 -3
- package/lib/cjs/services/feature/index.d.ts.map +1 -1
- package/lib/cjs/services/feature/index.js +14 -4
- package/lib/cjs/services/feature/index.js.map +1 -1
- package/lib/cjs/services/feed/index.d.ts +32 -17
- package/lib/cjs/services/feed/index.d.ts.map +1 -1
- package/lib/cjs/services/feed/index.js +36 -22
- package/lib/cjs/services/feed/index.js.map +1 -1
- package/lib/cjs/services/feed_object/index.d.ts +118 -81
- package/lib/cjs/services/feed_object/index.d.ts.map +1 -1
- package/lib/cjs/services/feed_object/index.js +143 -107
- package/lib/cjs/services/feed_object/index.js.map +1 -1
- package/lib/cjs/services/incubator/index.d.ts +39 -22
- package/lib/cjs/services/incubator/index.d.ts.map +1 -1
- package/lib/cjs/services/incubator/index.js +45 -29
- package/lib/cjs/services/incubator/index.js.map +1 -1
- package/lib/cjs/services/insight/index.d.ts +35 -19
- package/lib/cjs/services/insight/index.d.ts.map +1 -1
- package/lib/cjs/services/insight/index.js +40 -25
- package/lib/cjs/services/insight/index.js.map +1 -1
- package/lib/cjs/services/legal_page/index.d.ts +35 -19
- package/lib/cjs/services/legal_page/index.d.ts.map +1 -1
- package/lib/cjs/services/legal_page/index.js +40 -25
- package/lib/cjs/services/legal_page/index.js.map +1 -1
- package/lib/cjs/services/locality/index.d.ts +18 -6
- package/lib/cjs/services/locality/index.d.ts.map +1 -1
- package/lib/cjs/services/locality/index.js +19 -8
- package/lib/cjs/services/locality/index.js.map +1 -1
- package/lib/cjs/services/loyalty/index.d.ts +48 -29
- package/lib/cjs/services/loyalty/index.d.ts.map +1 -1
- package/lib/cjs/services/loyalty/index.js +56 -38
- package/lib/cjs/services/loyalty/index.js.map +1 -1
- package/lib/cjs/services/media/index.d.ts +42 -22
- package/lib/cjs/services/media/index.d.ts.map +1 -1
- package/lib/cjs/services/media/index.js +48 -29
- package/lib/cjs/services/media/index.js.map +1 -1
- package/lib/cjs/services/moderation/index.d.ts +33 -19
- package/lib/cjs/services/moderation/index.d.ts.map +1 -1
- package/lib/cjs/services/moderation/index.js +40 -27
- package/lib/cjs/services/moderation/index.js.map +1 -1
- package/lib/cjs/services/notification/index.d.ts +47 -28
- package/lib/cjs/services/notification/index.d.ts.map +1 -1
- package/lib/cjs/services/notification/index.js +55 -37
- package/lib/cjs/services/notification/index.js.map +1 -1
- package/lib/cjs/services/preference/index.d.ts +23 -10
- package/lib/cjs/services/preference/index.d.ts.map +1 -1
- package/lib/cjs/services/preference/index.js +25 -13
- package/lib/cjs/services/preference/index.js.map +1 -1
- package/lib/cjs/services/private_message/index.d.ts +51 -31
- package/lib/cjs/services/private_message/index.d.ts.map +1 -1
- package/lib/cjs/services/private_message/index.js +60 -41
- package/lib/cjs/services/private_message/index.js.map +1 -1
- package/lib/cjs/services/score/index.d.ts +22 -9
- package/lib/cjs/services/score/index.d.ts.map +1 -1
- package/lib/cjs/services/score/index.js +24 -12
- package/lib/cjs/services/score/index.js.map +1 -1
- package/lib/cjs/services/sso/index.d.ts +18 -6
- package/lib/cjs/services/sso/index.d.ts.map +1 -1
- package/lib/cjs/services/sso/index.js +19 -8
- package/lib/cjs/services/sso/index.js.map +1 -1
- package/lib/cjs/services/suggestion/index.d.ts +26 -12
- package/lib/cjs/services/suggestion/index.d.ts.map +1 -1
- package/lib/cjs/services/suggestion/index.js +29 -16
- package/lib/cjs/services/suggestion/index.js.map +1 -1
- package/lib/cjs/services/tag/index.d.ts +39 -22
- package/lib/cjs/services/tag/index.d.ts.map +1 -1
- package/lib/cjs/services/tag/index.js +45 -29
- package/lib/cjs/services/tag/index.js.map +1 -1
- package/lib/cjs/services/user/index.d.ts +204 -145
- package/lib/cjs/services/user/index.d.ts.map +1 -1
- package/lib/cjs/services/user/index.js +259 -201
- package/lib/cjs/services/user/index.js.map +1 -1
- package/lib/cjs/services/webhook/index.d.ts +59 -37
- package/lib/cjs/services/webhook/index.d.ts.map +1 -1
- package/lib/cjs/services/webhook/index.js +70 -49
- package/lib/cjs/services/webhook/index.js.map +1 -1
- package/lib/cjs/utils/apiRequest.d.ts +2 -1
- package/lib/cjs/utils/apiRequest.d.ts.map +1 -1
- package/lib/cjs/utils/apiRequest.js +4 -8
- package/lib/cjs/utils/apiRequest.js.map +1 -1
- package/lib/esm/services/category/index.d.ts +76 -49
- package/lib/esm/services/category/index.d.ts.map +1 -1
- package/lib/esm/services/category/index.js +91 -65
- package/lib/esm/services/category/index.js.map +1 -1
- package/lib/esm/services/comment/index.d.ts +55 -34
- package/lib/esm/services/comment/index.d.ts.map +1 -1
- package/lib/esm/services/comment/index.js +65 -45
- package/lib/esm/services/comment/index.js.map +1 -1
- package/lib/esm/services/custom_adv/index.d.ts +23 -10
- package/lib/esm/services/custom_adv/index.d.ts.map +1 -1
- package/lib/esm/services/custom_adv/index.js +25 -13
- package/lib/esm/services/custom_adv/index.js.map +1 -1
- package/lib/esm/services/custom_page/index.d.ts +23 -10
- package/lib/esm/services/custom_page/index.d.ts.map +1 -1
- package/lib/esm/services/custom_page/index.js +25 -13
- package/lib/esm/services/custom_page/index.js.map +1 -1
- package/lib/esm/services/data_portability/index.d.ts +22 -9
- package/lib/esm/services/data_portability/index.d.ts.map +1 -1
- package/lib/esm/services/data_portability/index.js +24 -12
- package/lib/esm/services/data_portability/index.js.map +1 -1
- package/lib/esm/services/embed/index.d.ts +43 -25
- package/lib/esm/services/embed/index.d.ts.map +1 -1
- package/lib/esm/services/embed/index.js +50 -33
- package/lib/esm/services/embed/index.js.map +1 -1
- package/lib/esm/services/feature/index.d.ts +14 -3
- package/lib/esm/services/feature/index.d.ts.map +1 -1
- package/lib/esm/services/feature/index.js +14 -4
- package/lib/esm/services/feature/index.js.map +1 -1
- package/lib/esm/services/feed/index.d.ts +32 -17
- package/lib/esm/services/feed/index.d.ts.map +1 -1
- package/lib/esm/services/feed/index.js +36 -22
- package/lib/esm/services/feed/index.js.map +1 -1
- package/lib/esm/services/feed_object/index.d.ts +118 -81
- package/lib/esm/services/feed_object/index.d.ts.map +1 -1
- package/lib/esm/services/feed_object/index.js +143 -107
- package/lib/esm/services/feed_object/index.js.map +1 -1
- package/lib/esm/services/incubator/index.d.ts +39 -22
- package/lib/esm/services/incubator/index.d.ts.map +1 -1
- package/lib/esm/services/incubator/index.js +45 -29
- package/lib/esm/services/incubator/index.js.map +1 -1
- package/lib/esm/services/insight/index.d.ts +35 -19
- package/lib/esm/services/insight/index.d.ts.map +1 -1
- package/lib/esm/services/insight/index.js +40 -25
- package/lib/esm/services/insight/index.js.map +1 -1
- package/lib/esm/services/legal_page/index.d.ts +35 -19
- package/lib/esm/services/legal_page/index.d.ts.map +1 -1
- package/lib/esm/services/legal_page/index.js +40 -25
- package/lib/esm/services/legal_page/index.js.map +1 -1
- package/lib/esm/services/locality/index.d.ts +18 -6
- package/lib/esm/services/locality/index.d.ts.map +1 -1
- package/lib/esm/services/locality/index.js +19 -8
- package/lib/esm/services/locality/index.js.map +1 -1
- package/lib/esm/services/loyalty/index.d.ts +48 -29
- package/lib/esm/services/loyalty/index.d.ts.map +1 -1
- package/lib/esm/services/loyalty/index.js +56 -38
- package/lib/esm/services/loyalty/index.js.map +1 -1
- package/lib/esm/services/media/index.d.ts +42 -22
- package/lib/esm/services/media/index.d.ts.map +1 -1
- package/lib/esm/services/media/index.js +48 -29
- package/lib/esm/services/media/index.js.map +1 -1
- package/lib/esm/services/moderation/index.d.ts +33 -19
- package/lib/esm/services/moderation/index.d.ts.map +1 -1
- package/lib/esm/services/moderation/index.js +40 -27
- package/lib/esm/services/moderation/index.js.map +1 -1
- package/lib/esm/services/notification/index.d.ts +47 -28
- package/lib/esm/services/notification/index.d.ts.map +1 -1
- package/lib/esm/services/notification/index.js +55 -37
- package/lib/esm/services/notification/index.js.map +1 -1
- package/lib/esm/services/preference/index.d.ts +23 -10
- package/lib/esm/services/preference/index.d.ts.map +1 -1
- package/lib/esm/services/preference/index.js +25 -13
- package/lib/esm/services/preference/index.js.map +1 -1
- package/lib/esm/services/private_message/index.d.ts +51 -31
- package/lib/esm/services/private_message/index.d.ts.map +1 -1
- package/lib/esm/services/private_message/index.js +60 -41
- package/lib/esm/services/private_message/index.js.map +1 -1
- package/lib/esm/services/score/index.d.ts +22 -9
- package/lib/esm/services/score/index.d.ts.map +1 -1
- package/lib/esm/services/score/index.js +24 -12
- package/lib/esm/services/score/index.js.map +1 -1
- package/lib/esm/services/sso/index.d.ts +18 -6
- package/lib/esm/services/sso/index.d.ts.map +1 -1
- package/lib/esm/services/sso/index.js +19 -8
- package/lib/esm/services/sso/index.js.map +1 -1
- package/lib/esm/services/suggestion/index.d.ts +26 -12
- package/lib/esm/services/suggestion/index.d.ts.map +1 -1
- package/lib/esm/services/suggestion/index.js +29 -16
- package/lib/esm/services/suggestion/index.js.map +1 -1
- package/lib/esm/services/tag/index.d.ts +39 -22
- package/lib/esm/services/tag/index.d.ts.map +1 -1
- package/lib/esm/services/tag/index.js +45 -29
- package/lib/esm/services/tag/index.js.map +1 -1
- package/lib/esm/services/user/index.d.ts +204 -145
- package/lib/esm/services/user/index.d.ts.map +1 -1
- package/lib/esm/services/user/index.js +259 -201
- package/lib/esm/services/user/index.js.map +1 -1
- package/lib/esm/services/webhook/index.d.ts +59 -37
- package/lib/esm/services/webhook/index.d.ts.map +1 -1
- package/lib/esm/services/webhook/index.js +70 -49
- package/lib/esm/services/webhook/index.js.map +1 -1
- package/lib/esm/utils/apiRequest.d.ts +2 -1
- package/lib/esm/utils/apiRequest.d.ts.map +1 -1
- package/lib/esm/utils/apiRequest.js +4 -8
- package/lib/esm/utils/apiRequest.js.map +1 -1
- package/lib/umd/api-services.js +1 -1
- package/lib/umd/api-services.js.map +1 -1
- package/package.json +4 -4
|
@@ -1,12 +1,13 @@
|
|
|
1
1
|
import { LegalPageFilterParams, SCPaginatedResponse } from '../../types';
|
|
2
2
|
import { SCLegalPageAckType, SCLegalPageType } from '@selfcommunity/types';
|
|
3
|
+
import { AxiosRequestConfig } from 'axios';
|
|
3
4
|
export interface LegalPageApiClientInterface {
|
|
4
|
-
getLegalPages(params?: LegalPageFilterParams): Promise<SCPaginatedResponse<SCLegalPageType>>;
|
|
5
|
-
getSpecificLegalPage(id: number): Promise<SCLegalPageType>;
|
|
6
|
-
searchLegalPages(params?: LegalPageFilterParams): Promise<SCPaginatedResponse<SCLegalPageType>>;
|
|
7
|
-
ackLegalPage(id: number, accept?: number): Promise<SCPaginatedResponse<SCLegalPageType>>;
|
|
8
|
-
getSpecificUserAck(id: number): Promise<SCLegalPageAckType>;
|
|
9
|
-
userAckList(): Promise<SCLegalPageAckType[]>;
|
|
5
|
+
getLegalPages(params?: LegalPageFilterParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLegalPageType>>;
|
|
6
|
+
getSpecificLegalPage(id: number, config?: AxiosRequestConfig): Promise<SCLegalPageType>;
|
|
7
|
+
searchLegalPages(params?: LegalPageFilterParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLegalPageType>>;
|
|
8
|
+
ackLegalPage(id: number, accept?: number, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLegalPageType>>;
|
|
9
|
+
getSpecificUserAck(id: number, config?: AxiosRequestConfig): Promise<SCLegalPageAckType>;
|
|
10
|
+
userAckList(config?: AxiosRequestConfig): Promise<SCLegalPageAckType[]>;
|
|
10
11
|
}
|
|
11
12
|
/**
|
|
12
13
|
* Contains all the endpoints needed to manage legal pages.
|
|
@@ -15,36 +16,42 @@ export declare class LegalPageApiClient {
|
|
|
15
16
|
/**
|
|
16
17
|
* This endpoint retrieves all legal pages.
|
|
17
18
|
* @param params
|
|
19
|
+
* @param config
|
|
18
20
|
*/
|
|
19
|
-
static getLegalPages(params?: LegalPageFilterParams): Promise<SCPaginatedResponse<SCLegalPageType>>;
|
|
21
|
+
static getLegalPages(params?: LegalPageFilterParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLegalPageType>>;
|
|
20
22
|
/**
|
|
21
23
|
* This endpoint retrieves a specific legal page.
|
|
24
|
+
* @param id
|
|
25
|
+
* @param config
|
|
22
26
|
*/
|
|
23
|
-
static getSpecificLegalPage(id: number): Promise<SCLegalPageType>;
|
|
27
|
+
static getSpecificLegalPage(id: number, config?: AxiosRequestConfig): Promise<SCLegalPageType>;
|
|
24
28
|
/**
|
|
25
29
|
* This endpoint performs search of a Legal Page.
|
|
26
30
|
* @param params
|
|
31
|
+
* @param config
|
|
27
32
|
*/
|
|
28
|
-
static searchLegalPages(params?: LegalPageFilterParams): Promise<SCPaginatedResponse<SCLegalPageType>>;
|
|
33
|
+
static searchLegalPages(params?: LegalPageFilterParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLegalPageType>>;
|
|
29
34
|
/**
|
|
30
35
|
*
|
|
31
36
|
* @param id
|
|
32
37
|
* @param accept Accept or not accept a legal page, valid values are: ('true', 'on', '1').
|
|
38
|
+
* @param config
|
|
33
39
|
*/
|
|
34
|
-
static ackLegalPage(id: number, accept?: number): Promise<SCPaginatedResponse<SCLegalPageType>>;
|
|
40
|
+
static ackLegalPage(id: number, accept?: number, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLegalPageType>>;
|
|
35
41
|
/**
|
|
36
42
|
* This endpoint retrieves a specific user ack.
|
|
37
43
|
* @param id
|
|
44
|
+
* @param config
|
|
38
45
|
*/
|
|
39
|
-
static getSpecificUserAck(id: number): Promise<SCLegalPageAckType>;
|
|
46
|
+
static getSpecificUserAck(id: number, config?: AxiosRequestConfig): Promise<SCLegalPageAckType>;
|
|
40
47
|
/**
|
|
41
48
|
* This endpoint retrieves all user acks.
|
|
42
49
|
*/
|
|
43
|
-
static userAckList(): Promise<SCLegalPageAckType[]>;
|
|
50
|
+
static userAckList(config?: AxiosRequestConfig): Promise<SCLegalPageAckType[]>;
|
|
44
51
|
}
|
|
45
52
|
/**
|
|
46
53
|
*
|
|
47
|
-
:::tipLegalPage service can be used in the following
|
|
54
|
+
:::tipLegalPage service can be used in the following way:
|
|
48
55
|
|
|
49
56
|
```jsx
|
|
50
57
|
1. Import the service from our library:
|
|
@@ -66,14 +73,23 @@ export declare class LegalPageApiClient {
|
|
|
66
73
|
return await LegalPageService.getSpecificLegalPage(legalPageId);
|
|
67
74
|
}
|
|
68
75
|
```
|
|
76
|
+
```jsx
|
|
77
|
+
If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
|
|
78
|
+
|
|
79
|
+
1. Declare it(or declare them, it is possible to add multiple params)
|
|
80
|
+
|
|
81
|
+
const headers = headers: {Authorization: `Bearer ${yourToken}`}
|
|
82
|
+
|
|
83
|
+
2. Add it inside the brackets and pass it to the function, as shown in the previous example!
|
|
84
|
+
```
|
|
69
85
|
:::
|
|
70
86
|
*/
|
|
71
87
|
export default class LegalPageService {
|
|
72
|
-
static getLegalPages(params?: LegalPageFilterParams): Promise<SCPaginatedResponse<SCLegalPageType>>;
|
|
73
|
-
static getSpecificLegalPage(id: number): Promise<SCLegalPageType>;
|
|
74
|
-
static searchLegalPages(params?: LegalPageFilterParams): Promise<SCPaginatedResponse<SCLegalPageType>>;
|
|
75
|
-
static ackLegalPage(id: number, accept?: number): Promise<SCPaginatedResponse<SCLegalPageType>>;
|
|
76
|
-
static getSpecificUserAck(id: number): Promise<SCLegalPageAckType>;
|
|
77
|
-
static userAckList(): Promise<SCLegalPageAckType[]>;
|
|
88
|
+
static getLegalPages(params?: LegalPageFilterParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLegalPageType>>;
|
|
89
|
+
static getSpecificLegalPage(id: number, config?: AxiosRequestConfig): Promise<SCLegalPageType>;
|
|
90
|
+
static searchLegalPages(params?: LegalPageFilterParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLegalPageType>>;
|
|
91
|
+
static ackLegalPage(id: number, accept?: number, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLegalPageType>>;
|
|
92
|
+
static getSpecificUserAck(id: number, config?: AxiosRequestConfig): Promise<SCLegalPageAckType>;
|
|
93
|
+
static userAckList(config?: AxiosRequestConfig): Promise<SCLegalPageAckType[]>;
|
|
78
94
|
}
|
|
79
95
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/legal_page/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,qBAAqB,EAAE,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAEvE,OAAO,EAAC,kBAAkB,EAAE,eAAe,EAAC,MAAM,sBAAsB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/legal_page/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,qBAAqB,EAAE,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAEvE,OAAO,EAAC,kBAAkB,EAAE,eAAe,EAAC,MAAM,sBAAsB,CAAC;AACzE,OAAO,EAAC,kBAAkB,EAAC,MAAM,OAAO,CAAC;AAEzC,MAAM,WAAW,2BAA2B;IAC1C,aAAa,CAAC,MAAM,CAAC,EAAE,qBAAqB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC;IAC1H,oBAAoB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACxF,gBAAgB,CAAC,MAAM,CAAC,EAAE,qBAAqB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC;IAC7H,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC;IACtH,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAC;IACzF,WAAW,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC,CAAC;CACzE;AACD;;GAEG;AAEH,qBAAa,kBAAkB;IAC7B;;;;OAIG;IACH,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,qBAAqB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;IAIhI;;;;OAIG;IACH,MAAM,CAAC,oBAAoB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,eAAe,CAAC;IAI9F;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,qBAAqB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;IAKnI;;;;;OAKG;IACH,MAAM,CAAC,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;IAI5H;;;;OAIG;IACH,MAAM,CAAC,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAI/F;;OAEG;IACH,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;CAG/E;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,CAAC,OAAO,OAAO,gBAAgB;WACtB,aAAa,CAAC,MAAM,CAAC,EAAE,qBAAqB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;WAIzH,oBAAoB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,eAAe,CAAC;WAIvF,gBAAgB,CAAC,MAAM,CAAC,EAAE,qBAAqB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;WAI5H,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;WAIrH,kBAAkB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,CAAC;WAIxF,WAAW,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,kBAAkB,EAAE,CAAC;CAGrF"}
|
|
@@ -16,51 +16,57 @@ export class LegalPageApiClient {
|
|
|
16
16
|
/**
|
|
17
17
|
* This endpoint retrieves all legal pages.
|
|
18
18
|
* @param params
|
|
19
|
+
* @param config
|
|
19
20
|
*/
|
|
20
|
-
static getLegalPages(params) {
|
|
21
|
+
static getLegalPages(params, config) {
|
|
21
22
|
const p = new URLSearchParams(params);
|
|
22
|
-
return apiRequest(`${Endpoints.GetLegalPages.url({})}?${p.toString()}`, Endpoints.GetLegalPages.method);
|
|
23
|
+
return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.GetLegalPages.url({})}?${p.toString()}`, method: Endpoints.GetLegalPages.method }));
|
|
23
24
|
}
|
|
24
25
|
/**
|
|
25
26
|
* This endpoint retrieves a specific legal page.
|
|
27
|
+
* @param id
|
|
28
|
+
* @param config
|
|
26
29
|
*/
|
|
27
|
-
static getSpecificLegalPage(id) {
|
|
28
|
-
return apiRequest(Endpoints.LegalPage.url({ id }), Endpoints.LegalPage.method);
|
|
30
|
+
static getSpecificLegalPage(id, config) {
|
|
31
|
+
return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.LegalPage.url({ id }), method: Endpoints.LegalPage.method }));
|
|
29
32
|
}
|
|
30
33
|
/**
|
|
31
34
|
* This endpoint performs search of a Legal Page.
|
|
32
35
|
* @param params
|
|
36
|
+
* @param config
|
|
33
37
|
*/
|
|
34
|
-
static searchLegalPages(params) {
|
|
38
|
+
static searchLegalPages(params, config) {
|
|
35
39
|
const p = new URLSearchParams(params);
|
|
36
|
-
return apiRequest(`${Endpoints.SearchLegalPages.url({})}?${p.toString()}`, Endpoints.SearchLegalPages.method);
|
|
40
|
+
return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.SearchLegalPages.url({})}?${p.toString()}`, method: Endpoints.SearchLegalPages.method }));
|
|
37
41
|
}
|
|
38
42
|
/**
|
|
39
43
|
*
|
|
40
44
|
* @param id
|
|
41
45
|
* @param accept Accept or not accept a legal page, valid values are: ('true', 'on', '1').
|
|
46
|
+
* @param config
|
|
42
47
|
*/
|
|
43
|
-
static ackLegalPage(id, accept) {
|
|
48
|
+
static ackLegalPage(id, accept, config) {
|
|
44
49
|
var _a;
|
|
45
|
-
return apiRequest(Endpoints.AckLegalPage.url({ id }), Endpoints.AckLegalPage.method, (_a = { accept: accept }) !== null && _a !== void 0 ? _a : null);
|
|
50
|
+
return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.AckLegalPage.url({ id }), method: Endpoints.AckLegalPage.method, data: (_a = { accept: accept }) !== null && _a !== void 0 ? _a : null }));
|
|
46
51
|
}
|
|
47
52
|
/**
|
|
48
53
|
* This endpoint retrieves a specific user ack.
|
|
49
54
|
* @param id
|
|
55
|
+
* @param config
|
|
50
56
|
*/
|
|
51
|
-
static getSpecificUserAck(id) {
|
|
52
|
-
return apiRequest(Endpoints.SpecificUserAck.url({ id }), Endpoints.SpecificUserAck.method);
|
|
57
|
+
static getSpecificUserAck(id, config) {
|
|
58
|
+
return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.SpecificUserAck.url({ id }), method: Endpoints.SpecificUserAck.method }));
|
|
53
59
|
}
|
|
54
60
|
/**
|
|
55
61
|
* This endpoint retrieves all user acks.
|
|
56
62
|
*/
|
|
57
|
-
static userAckList() {
|
|
58
|
-
return apiRequest(Endpoints.UserAckList.url({}), Endpoints.UserAckList.method);
|
|
63
|
+
static userAckList(config) {
|
|
64
|
+
return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.UserAckList.url({}), method: Endpoints.UserAckList.method }));
|
|
59
65
|
}
|
|
60
66
|
}
|
|
61
67
|
/**
|
|
62
68
|
*
|
|
63
|
-
:::tipLegalPage service can be used in the following
|
|
69
|
+
:::tipLegalPage service can be used in the following way:
|
|
64
70
|
|
|
65
71
|
```jsx
|
|
66
72
|
1. Import the service from our library:
|
|
@@ -82,37 +88,46 @@ export class LegalPageApiClient {
|
|
|
82
88
|
return await LegalPageService.getSpecificLegalPage(legalPageId);
|
|
83
89
|
}
|
|
84
90
|
```
|
|
91
|
+
```jsx
|
|
92
|
+
If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
|
|
93
|
+
|
|
94
|
+
1. Declare it(or declare them, it is possible to add multiple params)
|
|
95
|
+
|
|
96
|
+
const headers = headers: {Authorization: `Bearer ${yourToken}`}
|
|
97
|
+
|
|
98
|
+
2. Add it inside the brackets and pass it to the function, as shown in the previous example!
|
|
99
|
+
```
|
|
85
100
|
:::
|
|
86
101
|
*/
|
|
87
102
|
export default class LegalPageService {
|
|
88
|
-
static getLegalPages(params) {
|
|
103
|
+
static getLegalPages(params, config) {
|
|
89
104
|
return __awaiter(this, void 0, void 0, function* () {
|
|
90
|
-
return LegalPageApiClient.getLegalPages(params);
|
|
105
|
+
return LegalPageApiClient.getLegalPages(params, config);
|
|
91
106
|
});
|
|
92
107
|
}
|
|
93
|
-
static getSpecificLegalPage(id) {
|
|
108
|
+
static getSpecificLegalPage(id, config) {
|
|
94
109
|
return __awaiter(this, void 0, void 0, function* () {
|
|
95
|
-
return LegalPageApiClient.getSpecificLegalPage(id);
|
|
110
|
+
return LegalPageApiClient.getSpecificLegalPage(id, config);
|
|
96
111
|
});
|
|
97
112
|
}
|
|
98
|
-
static searchLegalPages(params) {
|
|
113
|
+
static searchLegalPages(params, config) {
|
|
99
114
|
return __awaiter(this, void 0, void 0, function* () {
|
|
100
|
-
return LegalPageApiClient.searchLegalPages(params);
|
|
115
|
+
return LegalPageApiClient.searchLegalPages(params, config);
|
|
101
116
|
});
|
|
102
117
|
}
|
|
103
|
-
static ackLegalPage(id, accept) {
|
|
118
|
+
static ackLegalPage(id, accept, config) {
|
|
104
119
|
return __awaiter(this, void 0, void 0, function* () {
|
|
105
|
-
return LegalPageApiClient.ackLegalPage(id, accept);
|
|
120
|
+
return LegalPageApiClient.ackLegalPage(id, accept, config);
|
|
106
121
|
});
|
|
107
122
|
}
|
|
108
|
-
static getSpecificUserAck(id) {
|
|
123
|
+
static getSpecificUserAck(id, config) {
|
|
109
124
|
return __awaiter(this, void 0, void 0, function* () {
|
|
110
|
-
return LegalPageApiClient.getSpecificUserAck(id);
|
|
125
|
+
return LegalPageApiClient.getSpecificUserAck(id, config);
|
|
111
126
|
});
|
|
112
127
|
}
|
|
113
|
-
static userAckList() {
|
|
128
|
+
static userAckList(config) {
|
|
114
129
|
return __awaiter(this, void 0, void 0, function* () {
|
|
115
|
-
return LegalPageApiClient.userAckList();
|
|
130
|
+
return LegalPageApiClient.userAckList(config);
|
|
116
131
|
});
|
|
117
132
|
}
|
|
118
133
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/legal_page/index.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,SAAS,MAAM,2BAA2B,CAAC;AAElD,OAAO,EAAC,UAAU,EAAC,MAAM,wBAAwB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/legal_page/index.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,SAAS,MAAM,2BAA2B,CAAC;AAElD,OAAO,EAAC,UAAU,EAAC,MAAM,wBAAwB,CAAC;AAYlD;;GAEG;AAEH,MAAM,OAAO,kBAAkB;IAC7B;;;;OAIG;IACH,MAAM,CAAC,aAAa,CAAC,MAA8B,EAAE,MAA2B;QAC9E,MAAM,CAAC,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,UAAU,iCAAK,MAAM,KAAE,GAAG,EAAE,GAAG,SAAS,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,aAAa,CAAC,MAAM,IAAE,CAAC;IACpI,CAAC;IACD;;;;OAIG;IACH,MAAM,CAAC,oBAAoB,CAAC,EAAU,EAAE,MAA2B;QACjE,OAAO,UAAU,iCAAK,MAAM,KAAE,GAAG,EAAE,SAAS,CAAC,SAAS,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,SAAS,CAAC,MAAM,IAAE,CAAC;IACzG,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,CAAC,MAA8B,EAAE,MAA2B;QACjF,MAAM,CAAC,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,UAAU,iCAAK,MAAM,KAAE,GAAG,EAAE,GAAG,SAAS,CAAC,gBAAgB,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,gBAAgB,CAAC,MAAM,IAAE,CAAC;IAC1I,CAAC;IAED;;;;;OAKG;IACH,MAAM,CAAC,YAAY,CAAC,EAAU,EAAE,MAAe,EAAE,MAA2B;;QAC1E,OAAO,UAAU,iCAAK,MAAM,KAAE,GAAG,EAAE,SAAS,CAAC,YAAY,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,YAAY,CAAC,MAAM,EAAE,IAAI,EAAE,MAAA,EAAC,MAAM,EAAE,MAAM,EAAC,mCAAI,IAAI,IAAE,CAAC;IAC/I,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,kBAAkB,CAAC,EAAU,EAAE,MAA2B;QAC/D,OAAO,UAAU,iCAAK,MAAM,KAAE,GAAG,EAAE,SAAS,CAAC,eAAe,CAAC,GAAG,CAAC,EAAC,EAAE,EAAC,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,eAAe,CAAC,MAAM,IAAE,CAAC;IACrH,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,WAAW,CAAC,MAA2B;QAC5C,OAAO,UAAU,iCAAK,MAAM,KAAE,GAAG,EAAE,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,SAAS,CAAC,WAAW,CAAC,MAAM,IAAE,CAAC;IAC3G,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,CAAC,OAAO,OAAO,gBAAgB;IACnC,MAAM,CAAO,aAAa,CAAC,MAA8B,EAAE,MAA2B;;YACpF,OAAO,kBAAkB,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC1D,CAAC;KAAA;IAED,MAAM,CAAO,oBAAoB,CAAC,EAAU,EAAE,MAA2B;;YACvE,OAAO,kBAAkB,CAAC,oBAAoB,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QAC7D,CAAC;KAAA;IAED,MAAM,CAAO,gBAAgB,CAAC,MAA8B,EAAE,MAA2B;;YACvF,OAAO,kBAAkB,CAAC,gBAAgB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC7D,CAAC;KAAA;IAED,MAAM,CAAO,YAAY,CAAC,EAAU,EAAE,MAAe,EAAE,MAA2B;;YAChF,OAAO,kBAAkB,CAAC,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;QAC7D,CAAC;KAAA;IAED,MAAM,CAAO,kBAAkB,CAAC,EAAU,EAAE,MAA2B;;YACrE,OAAO,kBAAkB,CAAC,kBAAkB,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;QAC3D,CAAC;KAAA;IAED,MAAM,CAAO,WAAW,CAAC,MAA2B;;YAClD,OAAO,kBAAkB,CAAC,WAAW,CAAC,MAAM,CAAC,CAAC;QAChD,CAAC;KAAA;CACF"}
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import { BaseSearchParams, SCPaginatedResponse } from '../../types';
|
|
2
2
|
import { SCLocalityType } from '@selfcommunity/types';
|
|
3
|
+
import { AxiosRequestConfig } from 'axios';
|
|
3
4
|
export interface LocalityApiClientInterface {
|
|
4
|
-
getLocalities(params?: BaseSearchParams): Promise<SCPaginatedResponse<SCLocalityType>>;
|
|
5
|
-
searchLocalities(params?: BaseSearchParams): Promise<SCPaginatedResponse<SCLocalityType>>;
|
|
5
|
+
getLocalities(params?: BaseSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLocalityType>>;
|
|
6
|
+
searchLocalities(params?: BaseSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLocalityType>>;
|
|
6
7
|
}
|
|
7
8
|
/**
|
|
8
9
|
* Contains all the endpoints needed to manage localities.
|
|
@@ -11,13 +12,15 @@ export declare class LocalityApiClient {
|
|
|
11
12
|
/**
|
|
12
13
|
* This endpoint retrieves the list of available localities.
|
|
13
14
|
* @param params
|
|
15
|
+
* @param config
|
|
14
16
|
*/
|
|
15
|
-
static getLocalities(params?: BaseSearchParams): Promise<SCPaginatedResponse<SCLocalityType>>;
|
|
17
|
+
static getLocalities(params?: BaseSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLocalityType>>;
|
|
16
18
|
/**
|
|
17
19
|
* This endpoint searches localities
|
|
18
20
|
* @param params
|
|
21
|
+
* @param config
|
|
19
22
|
*/
|
|
20
|
-
static searchLocalities(params?: BaseSearchParams): Promise<SCPaginatedResponse<SCLocalityType>>;
|
|
23
|
+
static searchLocalities(params?: BaseSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLocalityType>>;
|
|
21
24
|
}
|
|
22
25
|
/**
|
|
23
26
|
*
|
|
@@ -36,10 +39,19 @@ export declare class LocalityApiClient {
|
|
|
36
39
|
return await LocalityService.getLocalities();
|
|
37
40
|
}
|
|
38
41
|
```
|
|
42
|
+
```jsx
|
|
43
|
+
If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
|
|
44
|
+
|
|
45
|
+
1. Declare it(or declare them, it is possible to add multiple params)
|
|
46
|
+
|
|
47
|
+
const headers = headers: {Authorization: `Bearer ${yourToken}`}
|
|
48
|
+
|
|
49
|
+
2. Add it inside the brackets and pass it to the function, as shown in the previous example!
|
|
50
|
+
```
|
|
39
51
|
:::
|
|
40
52
|
*/
|
|
41
53
|
export default class LocalityService {
|
|
42
|
-
static getLocalities(params?: BaseSearchParams): Promise<SCPaginatedResponse<SCLocalityType>>;
|
|
43
|
-
static searchLocalities(params?: BaseSearchParams): Promise<SCPaginatedResponse<SCLocalityType>>;
|
|
54
|
+
static getLocalities(params?: BaseSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLocalityType>>;
|
|
55
|
+
static searchLocalities(params?: BaseSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLocalityType>>;
|
|
44
56
|
}
|
|
45
57
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/locality/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,gBAAgB,EAAE,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAElE,OAAO,EAAC,cAAc,EAAC,MAAM,sBAAsB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/locality/index.ts"],"names":[],"mappings":"AACA,OAAO,EAAC,gBAAgB,EAAE,mBAAmB,EAAC,MAAM,aAAa,CAAC;AAElE,OAAO,EAAC,cAAc,EAAC,MAAM,sBAAsB,CAAC;AACpD,OAAO,EAAC,kBAAkB,EAAC,MAAM,OAAO,CAAC;AAEzC,MAAM,WAAW,0BAA0B;IACzC,aAAa,CAAC,MAAM,CAAC,EAAE,gBAAgB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC,CAAC;IACpH,gBAAgB,CAAC,MAAM,CAAC,EAAE,gBAAgB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC,CAAC;CACxH;AACD;;GAEG;AAEH,qBAAa,iBAAiB;IAC5B;;;;OAIG;IACH,MAAM,CAAC,aAAa,CAAC,MAAM,CAAC,EAAE,gBAAgB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;IAK1H;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,EAAE,gBAAgB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;CAQ9H;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe;WACrB,aAAa,CAAC,MAAM,CAAC,EAAE,gBAAgB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;WAGnH,gBAAgB,CAAC,MAAM,CAAC,EAAE,gBAAgB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,cAAc,CAAC,CAAC;CAGpI"}
|
|
@@ -16,18 +16,20 @@ export class LocalityApiClient {
|
|
|
16
16
|
/**
|
|
17
17
|
* This endpoint retrieves the list of available localities.
|
|
18
18
|
* @param params
|
|
19
|
+
* @param config
|
|
19
20
|
*/
|
|
20
|
-
static getLocalities(params) {
|
|
21
|
+
static getLocalities(params, config) {
|
|
21
22
|
const p = new URLSearchParams(params);
|
|
22
|
-
return apiRequest(`${Endpoints.GetLocalities.url({})}?${p.toString()}`, Endpoints.GetLocalities.method);
|
|
23
|
+
return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.GetLocalities.url({})}?${p.toString()}`, method: Endpoints.GetLocalities.method }));
|
|
23
24
|
}
|
|
24
25
|
/**
|
|
25
26
|
* This endpoint searches localities
|
|
26
27
|
* @param params
|
|
28
|
+
* @param config
|
|
27
29
|
*/
|
|
28
|
-
static searchLocalities(params) {
|
|
30
|
+
static searchLocalities(params, config) {
|
|
29
31
|
const p = new URLSearchParams(params);
|
|
30
|
-
return apiRequest(`${Endpoints.ComposerLocalitySearch.url({})}?${p.toString()}`, Endpoints.ComposerLocalitySearch.method);
|
|
32
|
+
return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.ComposerLocalitySearch.url({})}?${p.toString()}`, method: Endpoints.ComposerLocalitySearch.method }));
|
|
31
33
|
}
|
|
32
34
|
}
|
|
33
35
|
/**
|
|
@@ -47,17 +49,26 @@ export class LocalityApiClient {
|
|
|
47
49
|
return await LocalityService.getLocalities();
|
|
48
50
|
}
|
|
49
51
|
```
|
|
52
|
+
```jsx
|
|
53
|
+
If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
|
|
54
|
+
|
|
55
|
+
1. Declare it(or declare them, it is possible to add multiple params)
|
|
56
|
+
|
|
57
|
+
const headers = headers: {Authorization: `Bearer ${yourToken}`}
|
|
58
|
+
|
|
59
|
+
2. Add it inside the brackets and pass it to the function, as shown in the previous example!
|
|
60
|
+
```
|
|
50
61
|
:::
|
|
51
62
|
*/
|
|
52
63
|
export default class LocalityService {
|
|
53
|
-
static getLocalities(params) {
|
|
64
|
+
static getLocalities(params, config) {
|
|
54
65
|
return __awaiter(this, void 0, void 0, function* () {
|
|
55
|
-
return LocalityApiClient.getLocalities(params);
|
|
66
|
+
return LocalityApiClient.getLocalities(params, config);
|
|
56
67
|
});
|
|
57
68
|
}
|
|
58
|
-
static searchLocalities(params) {
|
|
69
|
+
static searchLocalities(params, config) {
|
|
59
70
|
return __awaiter(this, void 0, void 0, function* () {
|
|
60
|
-
return LocalityApiClient.searchLocalities(params);
|
|
71
|
+
return LocalityApiClient.searchLocalities(params, config);
|
|
61
72
|
});
|
|
62
73
|
}
|
|
63
74
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/locality/index.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,SAAS,MAAM,2BAA2B,CAAC;AAElD,OAAO,EAAC,UAAU,EAAC,MAAM,wBAAwB,CAAC;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../src/services/locality/index.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,SAAS,MAAM,2BAA2B,CAAC;AAElD,OAAO,EAAC,UAAU,EAAC,MAAM,wBAAwB,CAAC;AAQlD;;GAEG;AAEH,MAAM,OAAO,iBAAiB;IAC5B;;;;OAIG;IACH,MAAM,CAAC,aAAa,CAAC,MAAyB,EAAE,MAA2B;QACzE,MAAM,CAAC,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,UAAU,iCAAK,MAAM,KAAE,GAAG,EAAE,GAAG,SAAS,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,SAAS,CAAC,aAAa,CAAC,MAAM,IAAE,CAAC;IACpI,CAAC;IAED;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,CAAC,MAAyB,EAAE,MAA2B;QAC5E,MAAM,CAAC,GAAG,IAAI,eAAe,CAAC,MAAM,CAAC,CAAC;QACtC,OAAO,UAAU,iCACZ,MAAM,KACT,GAAG,EAAE,GAAG,SAAS,CAAC,sBAAsB,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,EAClE,MAAM,EAAE,SAAS,CAAC,sBAAsB,CAAC,MAAM,IAC/C,CAAC;IACL,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;GA2BG;AACH,MAAM,CAAC,OAAO,OAAO,eAAe;IAClC,MAAM,CAAO,aAAa,CAAC,MAAyB,EAAE,MAA2B;;YAC/E,OAAO,iBAAiB,CAAC,aAAa,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QACzD,CAAC;KAAA;IACD,MAAM,CAAO,gBAAgB,CAAC,MAAyB,EAAE,MAA2B;;YAClF,OAAO,iBAAiB,CAAC,gBAAgB,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAC5D,CAAC;KAAA;CACF"}
|
|
@@ -1,15 +1,16 @@
|
|
|
1
1
|
import { SCPrizeType, SCPrizeUserStatusType, SCPrizeUserType } from '@selfcommunity/types';
|
|
2
2
|
import { SCPaginatedResponse, LoyaltyPrizeParams } from '../../types';
|
|
3
|
+
import { AxiosRequestConfig } from 'axios';
|
|
3
4
|
export interface LoyaltyApiClientInterface {
|
|
4
|
-
getPrizes(): Promise<SCPaginatedResponse<SCPrizeType>>;
|
|
5
|
-
createPrize(data: LoyaltyPrizeParams): Promise<SCPrizeType>;
|
|
6
|
-
getSpecificPrize(id: number): Promise<SCPrizeType>;
|
|
7
|
-
updatePrize(id: number, data: LoyaltyPrizeParams): Promise<SCPrizeType>;
|
|
8
|
-
patchPrize(id: number, data?: LoyaltyPrizeParams): Promise<SCPrizeType>;
|
|
9
|
-
getAllPrizeRequests(): Promise<SCPaginatedResponse<SCPrizeUserType>>;
|
|
10
|
-
createPrizeRequest(prize: number): Promise<SCPrizeUserType>;
|
|
11
|
-
getSpecificPrizeRequest(id: number): Promise<SCPrizeUserType>;
|
|
12
|
-
patchPrizeRequest(id: number, status?: SCPrizeUserStatusType): Promise<SCPrizeUserType>;
|
|
5
|
+
getPrizes(config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPrizeType>>;
|
|
6
|
+
createPrize(data: LoyaltyPrizeParams, config?: AxiosRequestConfig): Promise<SCPrizeType>;
|
|
7
|
+
getSpecificPrize(id: number, config?: AxiosRequestConfig): Promise<SCPrizeType>;
|
|
8
|
+
updatePrize(id: number, data: LoyaltyPrizeParams, config?: AxiosRequestConfig): Promise<SCPrizeType>;
|
|
9
|
+
patchPrize(id: number, data?: LoyaltyPrizeParams, config?: AxiosRequestConfig): Promise<SCPrizeType>;
|
|
10
|
+
getAllPrizeRequests(config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPrizeUserType>>;
|
|
11
|
+
createPrizeRequest(prize: number, config?: AxiosRequestConfig): Promise<SCPrizeUserType>;
|
|
12
|
+
getSpecificPrizeRequest(id: number, config?: AxiosRequestConfig): Promise<SCPrizeUserType>;
|
|
13
|
+
patchPrizeRequest(id: number, status?: SCPrizeUserStatusType, config?: AxiosRequestConfig): Promise<SCPrizeUserType>;
|
|
13
14
|
}
|
|
14
15
|
/**
|
|
15
16
|
* Contains all the endpoints needed to manage loyalty program.
|
|
@@ -17,55 +18,64 @@ export interface LoyaltyApiClientInterface {
|
|
|
17
18
|
export declare class LoyaltyApiClient {
|
|
18
19
|
/**
|
|
19
20
|
* This endpoint retrieves all prizes.
|
|
21
|
+
* @param config
|
|
20
22
|
*/
|
|
21
|
-
static getPrizes(): Promise<SCPaginatedResponse<SCPrizeType>>;
|
|
23
|
+
static getPrizes(config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPrizeType>>;
|
|
22
24
|
/**
|
|
23
25
|
* This endpoint creates a prize.
|
|
24
26
|
* @param data
|
|
27
|
+
* @param config
|
|
25
28
|
*/
|
|
26
|
-
static createPrize(data: LoyaltyPrizeParams): Promise<SCPrizeType>;
|
|
29
|
+
static createPrize(data: LoyaltyPrizeParams, config?: AxiosRequestConfig): Promise<SCPrizeType>;
|
|
27
30
|
/**
|
|
28
31
|
* This endpoint retrieves a specific prize
|
|
29
32
|
* @param id
|
|
33
|
+
* @param config
|
|
30
34
|
*/
|
|
31
|
-
static getSpecificPrize(id: number): Promise<SCPrizeType>;
|
|
35
|
+
static getSpecificPrize(id: number, config?: AxiosRequestConfig): Promise<SCPrizeType>;
|
|
32
36
|
/**
|
|
33
37
|
* This endpoint updates a specific prize.
|
|
34
38
|
* @param id
|
|
35
39
|
* @param data
|
|
40
|
+
* @param config
|
|
36
41
|
*/
|
|
37
|
-
static updatePrize(id: number, data: LoyaltyPrizeParams): Promise<SCPrizeType>;
|
|
42
|
+
static updatePrize(id: number, data: LoyaltyPrizeParams, config?: AxiosRequestConfig): Promise<SCPrizeType>;
|
|
38
43
|
/**
|
|
39
44
|
* This endpoint patches a specific prize.
|
|
40
45
|
* @param id
|
|
41
46
|
* @param data
|
|
47
|
+
* @param config
|
|
42
48
|
*/
|
|
43
|
-
static patchPrize(id: number, data?: LoyaltyPrizeParams): Promise<SCPrizeType>;
|
|
49
|
+
static patchPrize(id: number, data?: LoyaltyPrizeParams, config?: AxiosRequestConfig): Promise<SCPrizeType>;
|
|
44
50
|
/**
|
|
45
51
|
* This endpoint retrieves all requests of loyalty prizes.
|
|
52
|
+
* @param config
|
|
46
53
|
*/
|
|
47
|
-
static getAllPrizeRequests(): Promise<SCPaginatedResponse<SCPrizeUserType>>;
|
|
54
|
+
static getAllPrizeRequests(config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPrizeUserType>>;
|
|
48
55
|
/**
|
|
49
56
|
* This endpoint creates a request for a loyalty prize
|
|
50
57
|
* @param prize
|
|
58
|
+
* @param config
|
|
51
59
|
*/
|
|
52
|
-
static createPrizeRequest(prize: number): Promise<SCPrizeUserType>;
|
|
60
|
+
static createPrizeRequest(prize: number, config?: AxiosRequestConfig): Promise<SCPrizeUserType>;
|
|
53
61
|
/**
|
|
54
62
|
* This endpoint retrieves a specific request for a loyalty prize.
|
|
55
63
|
* @param id
|
|
64
|
+
* @param config
|
|
56
65
|
*/
|
|
57
|
-
static getSpecificPrizeRequest(id: number): Promise<SCPrizeUserType>;
|
|
66
|
+
static getSpecificPrizeRequest(id: number, config?: AxiosRequestConfig): Promise<SCPrizeUserType>;
|
|
58
67
|
/**
|
|
59
68
|
* This endpoint patches a specific request for a loyalty prize.
|
|
60
|
-
* You can use this endpoint to
|
|
69
|
+
* You can use this endpoint to change status in an admin list/table interface.
|
|
61
70
|
* @param id
|
|
62
71
|
* @param status
|
|
72
|
+
* @param config
|
|
63
73
|
*/
|
|
64
|
-
static patchPrizeRequest(id: number, status?: SCPrizeUserStatusType): Promise<SCPrizeUserType>;
|
|
74
|
+
static patchPrizeRequest(id: number, status?: SCPrizeUserStatusType, config?: AxiosRequestConfig): Promise<SCPrizeUserType>;
|
|
65
75
|
}
|
|
66
76
|
/**
|
|
67
77
|
*
|
|
68
|
-
:::tipLoyalty service can be used in the following
|
|
78
|
+
:::tipLoyalty service can be used in the following way:
|
|
69
79
|
|
|
70
80
|
```jsx
|
|
71
81
|
1. Import the service from our library:
|
|
@@ -87,17 +97,26 @@ export declare class LoyaltyApiClient {
|
|
|
87
97
|
return await LoyaltyService.getSpecificPrize(prizeId);
|
|
88
98
|
}
|
|
89
99
|
```
|
|
100
|
+
```jsx
|
|
101
|
+
If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
|
|
102
|
+
|
|
103
|
+
1. Declare it(or declare them, it is possible to add multiple params)
|
|
104
|
+
|
|
105
|
+
const headers = headers: {Authorization: `Bearer ${yourToken}`}
|
|
106
|
+
|
|
107
|
+
2. Add it inside the brackets and pass it to the function, as shown in the previous example!
|
|
108
|
+
```
|
|
90
109
|
:::
|
|
91
110
|
*/
|
|
92
111
|
export default class LoyaltyService {
|
|
93
|
-
static getPrizes(): Promise<SCPaginatedResponse<SCPrizeType>>;
|
|
94
|
-
static createPrize(data: LoyaltyPrizeParams): Promise<SCPrizeType>;
|
|
95
|
-
static getSpecificPrize(id: number): Promise<SCPrizeType>;
|
|
96
|
-
static updatePrize(id: number, data: LoyaltyPrizeParams): Promise<SCPrizeType>;
|
|
97
|
-
static patchPrize(id: number, data?: LoyaltyPrizeParams): Promise<SCPrizeType>;
|
|
98
|
-
static getAllPrizeRequests(): Promise<SCPaginatedResponse<SCPrizeUserType>>;
|
|
99
|
-
static createPrizeRequest(prize: number): Promise<SCPrizeUserType>;
|
|
100
|
-
static getSpecificPrizeRequest(id: number): Promise<SCPrizeUserType>;
|
|
101
|
-
static patchPrizeRequest(id: number, status?: SCPrizeUserStatusType): Promise<SCPrizeUserType>;
|
|
112
|
+
static getPrizes(config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPrizeType>>;
|
|
113
|
+
static createPrize(data: LoyaltyPrizeParams, config?: AxiosRequestConfig): Promise<SCPrizeType>;
|
|
114
|
+
static getSpecificPrize(id: number, config?: AxiosRequestConfig): Promise<SCPrizeType>;
|
|
115
|
+
static updatePrize(id: number, data: LoyaltyPrizeParams, config?: AxiosRequestConfig): Promise<SCPrizeType>;
|
|
116
|
+
static patchPrize(id: number, data?: LoyaltyPrizeParams, config?: AxiosRequestConfig): Promise<SCPrizeType>;
|
|
117
|
+
static getAllPrizeRequests(config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPrizeUserType>>;
|
|
118
|
+
static createPrizeRequest(prize: number, config?: AxiosRequestConfig): Promise<SCPrizeUserType>;
|
|
119
|
+
static getSpecificPrizeRequest(id: number, config?: AxiosRequestConfig): Promise<SCPrizeUserType>;
|
|
120
|
+
static patchPrizeRequest(id: number, status?: SCPrizeUserStatusType, config?: AxiosRequestConfig): Promise<SCPrizeUserType>;
|
|
102
121
|
}
|
|
103
122
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/loyalty/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,WAAW,EAAE,qBAAqB,EAAE,eAAe,EAAC,MAAM,sBAAsB,CAAC;AACzF,OAAO,EAAC,mBAAmB,EAAE,kBAAkB,EAAC,MAAM,aAAa,CAAC;
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/services/loyalty/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAC,WAAW,EAAE,qBAAqB,EAAE,eAAe,EAAC,MAAM,sBAAsB,CAAC;AACzF,OAAO,EAAC,mBAAmB,EAAE,kBAAkB,EAAC,MAAM,aAAa,CAAC;AACpE,OAAO,EAAC,kBAAkB,EAAC,MAAM,OAAO,CAAC;AAEzC,MAAM,WAAW,yBAAyB;IACxC,SAAS,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC,CAAC;IAClF,WAAW,CAAC,IAAI,EAAE,kBAAkB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACzF,gBAAgB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IAChF,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACrG,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,kBAAkB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAC;IACrG,mBAAmB,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC,CAAC;IAChG,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IACzF,uBAAuB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAC3F,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,qBAAqB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;CACtH;AACD;;GAEG;AAEH,qBAAa,gBAAgB;IAC3B;;;OAGG;IACH,MAAM,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;IAIxF;;;;OAIG;IACH,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,kBAAkB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;IAI/F;;;;OAIG;IACH,MAAM,CAAC,gBAAgB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;IAItF;;;;;OAKG;IACH,MAAM,CAAC,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;IAI3G;;;;;OAKG;IACH,MAAM,CAAC,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,kBAAkB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;IAI3G;;;OAGG;IACH,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;IAItG;;;;OAIG;IACH,MAAM,CAAC,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,eAAe,CAAC;IAI/F;;;;OAIG;IACH,MAAM,CAAC,uBAAuB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,eAAe,CAAC;IAIjG;;;;;;OAMG;IACH,MAAM,CAAC,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,qBAAqB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,eAAe,CAAC;CAG5H;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkCG;AACH,MAAM,CAAC,OAAO,OAAO,cAAc;WACpB,SAAS,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,WAAW,CAAC,CAAC;WAIjF,WAAW,CAAC,IAAI,EAAE,kBAAkB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;WAIxF,gBAAgB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;WAI/E,WAAW,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;WAIpG,UAAU,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,kBAAkB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC;WAIpG,mBAAmB,CAAC,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,mBAAmB,CAAC,eAAe,CAAC,CAAC;WAI/F,kBAAkB,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,eAAe,CAAC;WAIxF,uBAAuB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,eAAe,CAAC;WAG1F,iBAAiB,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,qBAAqB,EAAE,MAAM,CAAC,EAAE,kBAAkB,GAAG,OAAO,CAAC,eAAe,CAAC;CAGlI"}
|