@selfcommunity/api-services 0.7.0-alpha.1 → 0.7.0-alpha.10

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.
Files changed (39) hide show
  1. package/lib/cjs/constants/Endpoints.js +19 -1
  2. package/lib/cjs/index.d.ts +3 -2
  3. package/lib/cjs/index.js +4 -1
  4. package/lib/cjs/services/community/index.d.ts +28 -24
  5. package/lib/cjs/services/community/index.js +28 -24
  6. package/lib/cjs/services/contact_us/index.d.ts +57 -0
  7. package/lib/cjs/services/contact_us/index.js +65 -0
  8. package/lib/cjs/services/custom_menu/index.d.ts +0 -7
  9. package/lib/cjs/services/custom_menu/index.js +0 -12
  10. package/lib/cjs/services/payment/index.d.ts +5 -5
  11. package/lib/cjs/services/payment/index.js +2 -2
  12. package/lib/cjs/services/user/index.d.ts +8 -0
  13. package/lib/cjs/services/user/index.js +13 -0
  14. package/lib/cjs/types/contactUs.d.ts +25 -0
  15. package/lib/cjs/types/contactUs.js +5 -0
  16. package/lib/cjs/types/index.d.ts +2 -1
  17. package/lib/cjs/types/user.d.ts +4 -0
  18. package/lib/esm/constants/Endpoints.js +19 -1
  19. package/lib/esm/index.d.ts +3 -2
  20. package/lib/esm/index.js +2 -1
  21. package/lib/esm/services/community/index.d.ts +28 -24
  22. package/lib/esm/services/community/index.js +28 -24
  23. package/lib/esm/services/contact_us/index.d.ts +57 -0
  24. package/lib/esm/services/contact_us/index.js +60 -0
  25. package/lib/esm/services/custom_menu/index.d.ts +0 -7
  26. package/lib/esm/services/custom_menu/index.js +0 -12
  27. package/lib/esm/services/payment/index.d.ts +5 -5
  28. package/lib/esm/services/payment/index.js +2 -2
  29. package/lib/esm/services/user/index.d.ts +8 -0
  30. package/lib/esm/services/user/index.js +13 -0
  31. package/lib/esm/types/contactUs.d.ts +25 -0
  32. package/lib/esm/types/contactUs.js +4 -0
  33. package/lib/esm/types/index.d.ts +2 -1
  34. package/lib/esm/types/user.d.ts +4 -0
  35. package/lib/umd/956.js +2 -0
  36. package/lib/umd/api-services.js +1 -1
  37. package/package.json +4 -4
  38. package/lib/umd/740.js +0 -2
  39. /package/lib/umd/{740.js.LICENSE.txt → 956.js.LICENSE.txt} +0 -0
@@ -53,11 +53,12 @@ import OnBoardingService, { OnBoardingApiClient, OnBoardingApiClientInterface }
53
53
  import CourseService, { CourseApiClient, CourseApiClientInterface } from './services/course';
54
54
  import PaymentService, { PaymentApiClient, PaymentApiClientInterface } from './services/payment';
55
55
  import CommunityService, { CommunityApiClient, CommunityApiClientInterface } from './services/community';
56
+ import ContactUsService, { ContactUsApiClient, ContactUsApiClientInterface } from './services/contact_us';
56
57
  /**
57
58
  * Types
58
59
  */
59
- import { AccountCreateParams, AccountVerifyParams, AccountResetParams, AccountRecoverParams, AccountSearchParams, SCPaginatedResponse, WebhookParamType, WebhookEventsType, SSOSignUpParams, CommentListParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, ModerateContributionParams, FlaggedContributionParams, CustomNotificationParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadParams, ChunkUploadCompleteParams, ThreadParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, ScheduledFeedObjParams, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, GroupCreateParams, GroupFeedParams, EventCreateParams, EventFeedParams, EventSearchParams, LiveStreamCreateParams, LiveStreamSearchParams, LiveStreamRemoveParticipantParams, StartStepParams, OnBoardingStep, CourseCreateParams, CourseSearchParams, CourseInfoViewType, CourseInfoParams, CourseLessonCommentsParams, CourseUserRoleParams, CourseUsersParams, CourseDashboardUsersParams, PaymentContentStatusParams, PaymentContentStatus, PaymentProductsParams, CustomerPortalCreateSessionParams, CheckoutSessionParams, CheckoutCreateSessionParams, PaymentOrderParams } from './types';
60
+ import { AccountCreateParams, AccountVerifyParams, AccountResetParams, AccountRecoverParams, AccountSearchParams, SCPaginatedResponse, WebhookParamType, WebhookEventsType, SSOSignUpParams, CommentListParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, ModerateContributionParams, FlaggedContributionParams, CustomNotificationParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadParams, ChunkUploadCompleteParams, ThreadParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, ScheduledFeedObjParams, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, GroupCreateParams, GroupFeedParams, EventCreateParams, EventFeedParams, EventSearchParams, LiveStreamCreateParams, LiveStreamSearchParams, LiveStreamRemoveParticipantParams, StartStepParams, OnBoardingStep, CourseCreateParams, CourseSearchParams, CourseInfoViewType, CourseInfoParams, CourseLessonCommentsParams, CourseUserRoleParams, CourseUsersParams, CourseDashboardUsersParams, PaymentContentStatusParams, PaymentContentStatus, PaymentProductsParams, CustomerPortalCreateSessionParams, CheckoutSessionParams, CheckoutCreateSessionParams, PaymentOrderParams, ContactUsRequestParams } from './types';
60
61
  /**
61
62
  * Export all
62
63
  */
63
- export { http, HttpResponse, HttpMethod, apiRequest, formatHttpError, formatHttpErrorCode, getCancelTokenSourceRequest, generateJWTToken, parseJwt, urlParams, Endpoints, EndpointType, AccountService, AccountApiClient, AccountApiClientInterface, PreferenceService, PreferenceApiClient, PreferenceApiClientInterface, UserService, UserApiClient, UserApiClientInterface, FeatureService, FeatureApiClient, FeatureApiClientInterface, CategoryService, CategoryApiClient, CategoryApiClientInterface, CommentService, CommentApiClient, CommentApiClientInterface, CustomAdvService, CustomAdvApiClient, CustomAdvApiClientInterface, CustomMenuService, CustomMenuApiClient, CustomMenuApiClientInterface, CustomPageService, CustomPageApiClient, CustomPageApiClientInterface, DataPortabilityService, DataPortabilityApiClient, DataPortabilityApiClientInterface, EmbedService, EmbedApiClient, EmbedApiClientInterface, FeedService, FeedApiClient, FeedApiClientInterface, FeedObjectService, FeedObjectApiClient, FeedObjectApiClientInterface, IncubatorService, IncubatorApiClient, IncubatorApiClientInterface, InsightService, InsightApiClient, InsightApiClientInterface, InviteService, InviteApiClient, InviteApiClientInterface, LegalPageService, LegalPageApiClient, LegalPageApiClientInterface, LocalityService, LocalityApiClient, LocalityApiClientInterface, LoyaltyService, LoyaltyApiClient, LoyaltyApiClientInterface, MediaService, MediaApiClient, MediaApiClientInterface, ModerationService, ModerationApiClient, ModerationApiClientInterface, NotificationService, NotificationApiClient, NotificationApiClientInterface, PrivateMessageService, PrivateMessageApiClient, PrivateMessageApiClientInterface, PromoService, PromoApiClient, PromoApiClientInterface, ScoreService, ScoreApiClient, ScoreApiClientInterface, SSOService, SSOApiClient, SSOApiClientInterface, SuggestionService, SuggestionApiClient, SuggestionApiClientInterface, TagService, TagApiClient, TagApiClientInterface, WebhookService, WebhookApiClient, WebhookApiClientInterface, SCPaginatedResponse, WebhookParamType, WebhookEventsType, AccountSearchParams, AccountCreateParams, AccountVerifyParams, AccountResetParams, AccountRecoverParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, SSOSignUpParams, CommentListParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, FlaggedContributionParams, ModerateContributionParams, CustomNotificationParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadParams, ChunkUploadCompleteParams, ThreadParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, ScheduledFeedObjParams, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, ReactionService, ReactionApiClient, ReactionApiClientInterface, GroupCreateParams, GroupFeedParams, GroupService, GroupApiClient, GroupApiClientInterface, EventCreateParams, EventFeedParams, EventSearchParams, EventService, EventApiClient, EventApiClientInterface, LiveStreamService, LiveStreamApiClient, LiveStreamApiClientInterface, LiveStreamCreateParams, LiveStreamSearchParams, LiveStreamRemoveParticipantParams, OnBoardingService, OnBoardingApiClientInterface, OnBoardingApiClient, StartStepParams, OnBoardingStep, CourseCreateParams, CourseSearchParams, CourseInfoParams, CourseInfoViewType, CourseService, CourseApiClientInterface, CourseApiClient, CourseLessonCommentsParams, CourseUserRoleParams, CourseUsersParams, CourseDashboardUsersParams, PaymentService, PaymentApiClientInterface, PaymentApiClient, CommunityService, CommunityApiClient, CommunityApiClientInterface, PaymentContentStatusParams, PaymentContentStatus, PaymentProductsParams, CustomerPortalCreateSessionParams, CheckoutSessionParams, CheckoutCreateSessionParams, PaymentOrderParams };
64
+ export { http, HttpResponse, HttpMethod, apiRequest, formatHttpError, formatHttpErrorCode, getCancelTokenSourceRequest, generateJWTToken, parseJwt, urlParams, Endpoints, EndpointType, AccountService, AccountApiClient, AccountApiClientInterface, PreferenceService, PreferenceApiClient, PreferenceApiClientInterface, UserService, UserApiClient, UserApiClientInterface, FeatureService, FeatureApiClient, FeatureApiClientInterface, CategoryService, CategoryApiClient, CategoryApiClientInterface, CommentService, CommentApiClient, CommentApiClientInterface, CustomAdvService, CustomAdvApiClient, CustomAdvApiClientInterface, CustomMenuService, CustomMenuApiClient, CustomMenuApiClientInterface, CustomPageService, CustomPageApiClient, CustomPageApiClientInterface, DataPortabilityService, DataPortabilityApiClient, DataPortabilityApiClientInterface, EmbedService, EmbedApiClient, EmbedApiClientInterface, FeedService, FeedApiClient, FeedApiClientInterface, FeedObjectService, FeedObjectApiClient, FeedObjectApiClientInterface, IncubatorService, IncubatorApiClient, IncubatorApiClientInterface, InsightService, InsightApiClient, InsightApiClientInterface, InviteService, InviteApiClient, InviteApiClientInterface, LegalPageService, LegalPageApiClient, LegalPageApiClientInterface, LocalityService, LocalityApiClient, LocalityApiClientInterface, LoyaltyService, LoyaltyApiClient, LoyaltyApiClientInterface, MediaService, MediaApiClient, MediaApiClientInterface, ModerationService, ModerationApiClient, ModerationApiClientInterface, NotificationService, NotificationApiClient, NotificationApiClientInterface, PrivateMessageService, PrivateMessageApiClient, PrivateMessageApiClientInterface, PromoService, PromoApiClient, PromoApiClientInterface, ScoreService, ScoreApiClient, ScoreApiClientInterface, SSOService, SSOApiClient, SSOApiClientInterface, SuggestionService, SuggestionApiClient, SuggestionApiClientInterface, TagService, TagApiClient, TagApiClientInterface, WebhookService, WebhookApiClient, WebhookApiClientInterface, SCPaginatedResponse, WebhookParamType, WebhookEventsType, AccountSearchParams, AccountCreateParams, AccountVerifyParams, AccountResetParams, AccountRecoverParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, SSOSignUpParams, CommentListParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, FlaggedContributionParams, ModerateContributionParams, CustomNotificationParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadParams, ChunkUploadCompleteParams, ThreadParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, ScheduledFeedObjParams, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, ReactionService, ReactionApiClient, ReactionApiClientInterface, GroupCreateParams, GroupFeedParams, GroupService, GroupApiClient, GroupApiClientInterface, EventCreateParams, EventFeedParams, EventSearchParams, EventService, EventApiClient, EventApiClientInterface, LiveStreamService, LiveStreamApiClient, LiveStreamApiClientInterface, LiveStreamCreateParams, LiveStreamSearchParams, LiveStreamRemoveParticipantParams, OnBoardingService, OnBoardingApiClientInterface, OnBoardingApiClient, StartStepParams, OnBoardingStep, CourseCreateParams, CourseSearchParams, CourseInfoParams, CourseInfoViewType, CourseService, CourseApiClientInterface, CourseApiClient, CourseLessonCommentsParams, CourseUserRoleParams, CourseUsersParams, CourseDashboardUsersParams, PaymentService, PaymentApiClientInterface, PaymentApiClient, CommunityService, CommunityApiClient, CommunityApiClientInterface, PaymentContentStatusParams, PaymentContentStatus, PaymentProductsParams, CustomerPortalCreateSessionParams, CheckoutSessionParams, CheckoutCreateSessionParams, PaymentOrderParams, ContactUsRequestParams, ContactUsService, ContactUsApiClient, ContactUsApiClientInterface };
package/lib/esm/index.js CHANGED
@@ -53,6 +53,7 @@ import OnBoardingService, { OnBoardingApiClient } from './services/onboarding';
53
53
  import CourseService, { CourseApiClient } from './services/course';
54
54
  import PaymentService, { PaymentApiClient } from './services/payment';
55
55
  import CommunityService, { CommunityApiClient } from './services/community';
56
+ import ContactUsService, { ContactUsApiClient } from './services/contact_us';
56
57
  /**
57
58
  * Types
58
59
  */
@@ -60,4 +61,4 @@ import { MediaTypes, OnBoardingStep, CourseInfoViewType } from './types';
60
61
  /**
61
62
  * Export all
62
63
  */
63
- export { http, apiRequest, formatHttpError, formatHttpErrorCode, getCancelTokenSourceRequest, generateJWTToken, parseJwt, urlParams, Endpoints, AccountService, AccountApiClient, PreferenceService, PreferenceApiClient, UserService, UserApiClient, FeatureService, FeatureApiClient, CategoryService, CategoryApiClient, CommentService, CommentApiClient, CustomAdvService, CustomAdvApiClient, CustomMenuService, CustomMenuApiClient, CustomPageService, CustomPageApiClient, DataPortabilityService, DataPortabilityApiClient, EmbedService, EmbedApiClient, FeedService, FeedApiClient, FeedObjectService, FeedObjectApiClient, IncubatorService, IncubatorApiClient, InsightService, InsightApiClient, InviteService, InviteApiClient, LegalPageService, LegalPageApiClient, LocalityService, LocalityApiClient, LoyaltyService, LoyaltyApiClient, MediaService, MediaApiClient, ModerationService, ModerationApiClient, NotificationService, NotificationApiClient, PrivateMessageService, PrivateMessageApiClient, PromoService, PromoApiClient, ScoreService, ScoreApiClient, SSOService, SSOApiClient, SuggestionService, SuggestionApiClient, TagService, TagApiClient, WebhookService, WebhookApiClient, MediaTypes, ReactionService, ReactionApiClient, GroupService, GroupApiClient, EventService, EventApiClient, LiveStreamService, LiveStreamApiClient, OnBoardingService, OnBoardingApiClient, OnBoardingStep, CourseInfoViewType, CourseService, CourseApiClient, PaymentService, PaymentApiClient, CommunityService, CommunityApiClient };
64
+ export { http, apiRequest, formatHttpError, formatHttpErrorCode, getCancelTokenSourceRequest, generateJWTToken, parseJwt, urlParams, Endpoints, AccountService, AccountApiClient, PreferenceService, PreferenceApiClient, UserService, UserApiClient, FeatureService, FeatureApiClient, CategoryService, CategoryApiClient, CommentService, CommentApiClient, CustomAdvService, CustomAdvApiClient, CustomMenuService, CustomMenuApiClient, CustomPageService, CustomPageApiClient, DataPortabilityService, DataPortabilityApiClient, EmbedService, EmbedApiClient, FeedService, FeedApiClient, FeedObjectService, FeedObjectApiClient, IncubatorService, IncubatorApiClient, InsightService, InsightApiClient, InviteService, InviteApiClient, LegalPageService, LegalPageApiClient, LocalityService, LocalityApiClient, LoyaltyService, LoyaltyApiClient, MediaService, MediaApiClient, ModerationService, ModerationApiClient, NotificationService, NotificationApiClient, PrivateMessageService, PrivateMessageApiClient, PromoService, PromoApiClient, ScoreService, ScoreApiClient, SSOService, SSOApiClient, SuggestionService, SuggestionApiClient, TagService, TagApiClient, WebhookService, WebhookApiClient, MediaTypes, ReactionService, ReactionApiClient, GroupService, GroupApiClient, EventService, EventApiClient, LiveStreamService, LiveStreamApiClient, OnBoardingService, OnBoardingApiClient, OnBoardingStep, CourseInfoViewType, CourseService, CourseApiClient, PaymentService, PaymentApiClient, CommunityService, CommunityApiClient, ContactUsService, ContactUsApiClient };
@@ -34,30 +34,34 @@ export declare class CommunityApiClient {
34
34
  }
35
35
  /**
36
36
  *
37
- :::tip Community service can be used in the following way:
38
-
39
- ```jsx
40
- 1. Import the service from our library:
41
-
42
- import {CommunityService} from "@selfcommunity/api-services";
43
- ```
44
- ```jsx
45
- 2. Create a function and put the service inside it!
46
- The async function `getCommunities` will return the events matching the search query.
47
-
48
- async getCommunities() {
49
- return await CommunityService.getCommunities({...});
50
- }
51
- ```
52
- If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
53
-
54
- 1. Declare it(or declare them, it is possible to add multiple params)
55
-
56
- const headers = headers: {Authorization: `Bearer ${yourToken}`}
57
-
58
- 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
59
- ```
60
- :::
37
+ * :::tip Community service can be used in the following way:
38
+ *
39
+ * 1. Import the service from our library:
40
+ *
41
+ * ```ts
42
+ * import {CommunityService} from "@selfcommunity/api-services";
43
+ * ```
44
+ *
45
+ * 2. Create a function and put the service inside it! The async function `getCommunities`
46
+ * will return the events matching the search query.
47
+ *
48
+ * ```ts
49
+ * async function getCommunities() {
50
+ * return await CommunityService.getCommunities({...});
51
+ * }
52
+ * ```
53
+ *
54
+ * If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
55
+ *
56
+ * 1. Declare it (or declare multiple params):
57
+ *
58
+ * ```ts
59
+ * const headers = { Authorization: `Bearer ${yourToken}` };
60
+ * ```
61
+ *
62
+ * 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
63
+ *
64
+ * :::
61
65
  */
62
66
  export default class CommunityService {
63
67
  static getCommunities(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCCommunityType>>;
@@ -26,30 +26,34 @@ export class CommunityApiClient {
26
26
  }
27
27
  /**
28
28
  *
29
- :::tip Community service can be used in the following way:
30
-
31
- ```jsx
32
- 1. Import the service from our library:
33
-
34
- import {CommunityService} from "@selfcommunity/api-services";
35
- ```
36
- ```jsx
37
- 2. Create a function and put the service inside it!
38
- The async function `getCommunities` will return the events matching the search query.
39
-
40
- async getCommunities() {
41
- return await CommunityService.getCommunities({...});
42
- }
43
- ```
44
- If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
45
-
46
- 1. Declare it(or declare them, it is possible to add multiple params)
47
-
48
- const headers = headers: {Authorization: `Bearer ${yourToken}`}
49
-
50
- 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
51
- ```
52
- :::
29
+ * :::tip Community service can be used in the following way:
30
+ *
31
+ * 1. Import the service from our library:
32
+ *
33
+ * ```ts
34
+ * import {CommunityService} from "@selfcommunity/api-services";
35
+ * ```
36
+ *
37
+ * 2. Create a function and put the service inside it! The async function `getCommunities`
38
+ * will return the events matching the search query.
39
+ *
40
+ * ```ts
41
+ * async function getCommunities() {
42
+ * return await CommunityService.getCommunities({...});
43
+ * }
44
+ * ```
45
+ *
46
+ * If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
47
+ *
48
+ * 1. Declare it (or declare multiple params):
49
+ *
50
+ * ```ts
51
+ * const headers = { Authorization: `Bearer ${yourToken}` };
52
+ * ```
53
+ *
54
+ * 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
55
+ *
56
+ * :::
53
57
  */
54
58
  export default class CommunityService {
55
59
  static getCommunities(params, config) {
@@ -0,0 +1,57 @@
1
+ import { ContactUsRequestParams } from '../../types';
2
+ import { type SCContactUsRequestType } from '@selfcommunity/types';
3
+ import { AxiosRequestConfig } from 'axios';
4
+ export interface ContactUsApiClientInterface {
5
+ request(data?: ContactUsRequestParams, config?: AxiosRequestConfig): Promise<SCContactUsRequestType>;
6
+ }
7
+ /**
8
+ * Contains all the endpoints needed to contact-us.
9
+ */
10
+ export declare class ContactUsApiClient {
11
+ /**
12
+ * This endpoint create an contact request.
13
+ *
14
+ * It requires an authenticated user.
15
+ *
16
+ * @param data
17
+ * @param config
18
+ */
19
+ static request(data?: ContactUsRequestParams, config?: AxiosRequestConfig): Promise<SCContactUsRequestType>;
20
+ }
21
+ /**
22
+ *
23
+ :::tip Contact service can be used in the following way:
24
+ ```jsx
25
+ 1. Import the service from our library:
26
+
27
+ import {ContactService} from "@selfcommunity/api-services";
28
+ ```
29
+ ```jsx
30
+ 2. Create a function and put the service inside it!
31
+ The async function `create` will return the paginated list of categories.
32
+
33
+ async create() {
34
+ return await ContactService.request();
35
+ }
36
+ ```
37
+ ```jsx
38
+ In case of required `params`, just add them inside the brackets.
39
+
40
+ async request(data) {
41
+ return await ContactService.request(data);
42
+ }
43
+ ```
44
+ ```jsx
45
+ If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
46
+
47
+ 1. Declare it(or declare them, it is possible to add multiple params)
48
+
49
+ const headers = headers: {Authorization: `Bearer ${yourToken}`}
50
+
51
+ 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
52
+ ```
53
+ :::
54
+ */
55
+ export default class ContactUsService {
56
+ static request(data?: ContactUsRequestParams, config?: AxiosRequestConfig): Promise<SCContactUsRequestType>;
57
+ }
@@ -0,0 +1,60 @@
1
+ import { __awaiter } from "tslib";
2
+ import Endpoints from '../../constants/Endpoints';
3
+ import { apiRequest } from '../../utils/apiRequest';
4
+ /**
5
+ * Contains all the endpoints needed to contact-us.
6
+ */
7
+ export class ContactUsApiClient {
8
+ /**
9
+ * This endpoint create an contact request.
10
+ *
11
+ * It requires an authenticated user.
12
+ *
13
+ * @param data
14
+ * @param config
15
+ */
16
+ static request(data, config) {
17
+ return apiRequest(Object.assign(Object.assign({}, config), { data, url: Endpoints.ContactRequest.url({}), method: Endpoints.ContactRequest.method }));
18
+ }
19
+ }
20
+ /**
21
+ *
22
+ :::tip Contact service can be used in the following way:
23
+ ```jsx
24
+ 1. Import the service from our library:
25
+
26
+ import {ContactService} from "@selfcommunity/api-services";
27
+ ```
28
+ ```jsx
29
+ 2. Create a function and put the service inside it!
30
+ The async function `create` will return the paginated list of categories.
31
+
32
+ async create() {
33
+ return await ContactService.request();
34
+ }
35
+ ```
36
+ ```jsx
37
+ In case of required `params`, just add them inside the brackets.
38
+
39
+ async request(data) {
40
+ return await ContactService.request(data);
41
+ }
42
+ ```
43
+ ```jsx
44
+ If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
45
+
46
+ 1. Declare it(or declare them, it is possible to add multiple params)
47
+
48
+ const headers = headers: {Authorization: `Bearer ${yourToken}`}
49
+
50
+ 2. Add it inside the brackets and pass it to the function, as shown in the previous example!
51
+ ```
52
+ :::
53
+ */
54
+ export default class ContactUsService {
55
+ static request(data, config) {
56
+ return __awaiter(this, void 0, void 0, function* () {
57
+ return ContactUsApiClient.request(data, config);
58
+ });
59
+ }
60
+ }
@@ -4,7 +4,6 @@ import { AxiosRequestConfig } from 'axios';
4
4
  export interface CustomMenuApiClientInterface {
5
5
  getASpecificCustomMenu(id: number | string, config?: AxiosRequestConfig): Promise<SCCustomMenuType>;
6
6
  getAllCustomMenus(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCCustomMenuType>>;
7
- getBaseCustomMenu(config?: AxiosRequestConfig): Promise<SCCustomMenuType>;
8
7
  searchCustomMenus(params?: BaseSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCCustomMenuType>>;
9
8
  }
10
9
  /**
@@ -23,11 +22,6 @@ export declare class CustomMenuApiClient {
23
22
  * @param config
24
23
  */
25
24
  static getAllCustomMenus(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCCustomMenuType>>;
26
- /**
27
- * This endpoint retrieves the base custom menu.
28
- * @param config
29
- */
30
- static getBaseCustomMenu(config?: AxiosRequestConfig): Promise<SCCustomMenuType>;
31
25
  /**
32
26
  * This endpoint performs search of a Custom Menu
33
27
  * @param params
@@ -73,6 +67,5 @@ export declare class CustomMenuApiClient {
73
67
  export default class CustomMenuService {
74
68
  static getASpecificCustomMenu(id: number | string, config?: AxiosRequestConfig): Promise<SCCustomMenuType>;
75
69
  static getAllCustomMenus(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCCustomMenuType>>;
76
- static getBaseCustomMenu(config?: AxiosRequestConfig): Promise<SCCustomMenuType>;
77
70
  static searchCustomMenus(params?: BaseSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCCustomMenuType>>;
78
71
  }
@@ -23,13 +23,6 @@ export class CustomMenuApiClient {
23
23
  const p = urlParams(params);
24
24
  return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.GetCustomMenus.url({})}?${p.toString()}`, method: Endpoints.GetCustomMenus.method }));
25
25
  }
26
- /**
27
- * This endpoint retrieves the base custom menu.
28
- * @param config
29
- */
30
- static getBaseCustomMenu(config) {
31
- return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.CustomMenu.url({ id: 'base' }), method: Endpoints.CustomMenu.method }));
32
- }
33
26
  /**
34
27
  * This endpoint performs search of a Custom Menu
35
28
  * @param params
@@ -86,11 +79,6 @@ export default class CustomMenuService {
86
79
  return CustomMenuApiClient.getAllCustomMenus(params, config);
87
80
  });
88
81
  }
89
- static getBaseCustomMenu(config) {
90
- return __awaiter(this, void 0, void 0, function* () {
91
- return CustomMenuApiClient.getBaseCustomMenu(config);
92
- });
93
- }
94
82
  static searchCustomMenus(params, config) {
95
83
  return __awaiter(this, void 0, void 0, function* () {
96
84
  return CustomMenuApiClient.searchCustomMenus(params, config);
@@ -4,13 +4,13 @@ import { CheckoutCreateSessionParams, CheckoutSessionParams, PaymentProductsPara
4
4
  import { SCCheckoutSession, SCPaymentOrder, SCCheckoutSessionDetail, SCCheckoutSessionComplete, SCPaymentProduct, SCPaymentPrice, SCPaymentsCustomerPortalSession, SCPaywall } from '@selfcommunity/types';
5
5
  export interface PaymentApiClientInterface {
6
6
  /**
7
- * Get payment products related to an object (aka paywalls) of type <content_type> and id <content_id> and the current payment_order
7
+ * Get payment products related to an object (aka paywalls) of type &lt;content_type&gt; and id &lt;content_id&gt; and the current payment_order
8
8
  * @param params
9
9
  * @param config
10
10
  */
11
11
  getPaymentContentStatus(params?: PaymentContentStatusParams, config?: AxiosRequestConfig): Promise<PaymentContentStatus>;
12
12
  /**
13
- * Get payment products related to an object (aka paywalls) of type <content_type> and id <content_id>
13
+ * Get payment products related to an object (aka paywalls) of type &lt;content_type&gt; and id &lt;content_id&gt;
14
14
  * @param params
15
15
  * @param config
16
16
  */
@@ -35,7 +35,7 @@ export interface PaymentApiClientInterface {
35
35
  */
36
36
  getPaymentProductPrices(id: number | string, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentPrice>>;
37
37
  /**
38
- * Create session checkout with price_id for an object of type <content_type> and id <content_id>
38
+ * Create session checkout with price_id for an object of type &lt;content_type&gt; and id &lt;content_id&gt;
39
39
  * @param data
40
40
  * @param config
41
41
  */
@@ -88,13 +88,13 @@ export interface PaymentApiClientInterface {
88
88
  */
89
89
  export declare class PaymentApiClient {
90
90
  /**
91
- * This endpoint retrieves all the products related to an object of type <content_type> and id <content_id> and the current payment_order
91
+ * This endpoint retrieves all the products related to an object of type &lt;content_type&gt; and id &lt;content_id&gt; and the current payment_order
92
92
  * @param params
93
93
  * @param config
94
94
  */
95
95
  static getPaymentContentStatus(params?: PaymentContentStatusParams, config?: AxiosRequestConfig): Promise<PaymentContentStatus>;
96
96
  /**
97
- * This endpoint retrieves all the products related to an object of type <content_type> and id <content_id>
97
+ * This endpoint retrieves all the products related to an object of type &lt;content_type&gt; and id &lt;content_id&gt;
98
98
  * @param params
99
99
  * @param config
100
100
  */
@@ -7,7 +7,7 @@ import { urlParams } from '../../utils/url';
7
7
  */
8
8
  export class PaymentApiClient {
9
9
  /**
10
- * This endpoint retrieves all the products related to an object of type <content_type> and id <content_id> and the current payment_order
10
+ * This endpoint retrieves all the products related to an object of type &lt;content_type&gt; and id &lt;content_id&gt; and the current payment_order
11
11
  * @param params
12
12
  * @param config
13
13
  */
@@ -15,7 +15,7 @@ export class PaymentApiClient {
15
15
  return apiRequest(Object.assign(Object.assign({}, config), { params, url: `${Endpoints.GetPaymentContentStatus.url({})}`, method: Endpoints.GetPaymentContentStatus.method }));
16
16
  }
17
17
  /**
18
- * This endpoint retrieves all the products related to an object of type <content_type> and id <content_id>
18
+ * This endpoint retrieves all the products related to an object of type &lt;content_type&gt; and id &lt;content_id&gt;
19
19
  * @param params
20
20
  * @param config
21
21
  */
@@ -57,6 +57,7 @@ export interface UserApiClientInterface {
57
57
  getUserLiveStream(id: number | string, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLiveStreamType>>;
58
58
  getOrderHistory(id: number, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaymentOrder[]>;
59
59
  getOrderDetail(id: number, order: number, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaymentOrder>;
60
+ matchUsernames(usernames: string[], config?: AxiosRequestConfig): Promise<SCUserAutocompleteType[]>;
60
61
  }
61
62
  /**
62
63
  * Contains all the endpoints needed to manage users.
@@ -410,6 +411,12 @@ export declare class UserApiClient {
410
411
  * @param config
411
412
  */
412
413
  static getOrderDetail(id: number, order: number, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaymentOrder>;
414
+ /**
415
+ * This endpoint retrieve the users corresponding to the sent usernames
416
+ * @param usernames
417
+ * @param config
418
+ */
419
+ static matchUsernames(usernames: string[], config?: AxiosRequestConfig): Promise<SCUserAutocompleteType[]>;
413
420
  }
414
421
  /**
415
422
  *
@@ -503,4 +510,5 @@ export default class UserService {
503
510
  static getUserLiveStream(id: number | string, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLiveStreamType>>;
504
511
  static getOrderHistory(id: number, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentOrder>>;
505
512
  static getOrderDetail(id: number, order: number, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaymentOrder>;
513
+ static matchUsernames(usernames: string[], config?: AxiosRequestConfig): Promise<SCUserAutocompleteType[]>;
506
514
  }
@@ -477,6 +477,14 @@ export class UserApiClient {
477
477
  static getOrderDetail(id, order, params, config) {
478
478
  return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.GetOrderDetail.url({ id, order }), method: Endpoints.GetOrderDetail.method, params }));
479
479
  }
480
+ /**
481
+ * This endpoint retrieve the users corresponding to the sent usernames
482
+ * @param usernames
483
+ * @param config
484
+ */
485
+ static matchUsernames(usernames, config) {
486
+ return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.UserMatchUsernames.url(), method: Endpoints.UserMatchUsernames.method, data: usernames }));
487
+ }
480
488
  }
481
489
  /**
482
490
  *
@@ -786,4 +794,9 @@ export default class UserService {
786
794
  return UserApiClient.getOrderDetail(id, order, params, config);
787
795
  });
788
796
  }
797
+ static matchUsernames(usernames, config) {
798
+ return __awaiter(this, void 0, void 0, function* () {
799
+ return UserApiClient.matchUsernames(usernames, config);
800
+ });
801
+ }
789
802
  }
@@ -0,0 +1,25 @@
1
+ /**
2
+ * ContactUsRequestParams interface
3
+ */
4
+ export interface ContactUsRequestParams {
5
+ /**
6
+ * name field for the account
7
+ */
8
+ name?: string;
9
+ /**
10
+ * Surname field for the account
11
+ */
12
+ surname?: string;
13
+ /**
14
+ * Email field for the account
15
+ */
16
+ email?: string;
17
+ /**
18
+ * Contact request message text
19
+ */
20
+ message?: string;
21
+ /**
22
+ * Any other properties
23
+ */
24
+ [p: string]: any;
25
+ }
@@ -0,0 +1,4 @@
1
+ /**
2
+ * ContactUsRequestParams interface
3
+ */
4
+ export {};
@@ -29,4 +29,5 @@ import { LiveStreamCreateParams, LiveStreamSearchParams, LiveStreamRemovePartici
29
29
  import { StartStepParams, OnBoardingStep } from './onBoarding';
30
30
  import { CourseCreateParams, CourseSearchParams, CourseInfoViewType, CourseInfoParams, CourseLessonCommentsParams, CourseUserRoleParams, CourseUsersParams, CourseDashboardUsersParams } from './course';
31
31
  import { PaymentContentStatusParams, PaymentContentStatus, PaymentProductsParams, CustomerPortalCreateSessionParams, CheckoutSessionParams, CheckoutCreateSessionParams, PaymentOrderParams } from './payment';
32
- export { AccountCreateParams, AccountVerifyParams, AccountRecoverParams, AccountResetParams, AccountSearchParams, SCPaginatedResponse, WebhookParamType, WebhookEventsType, SSOSignUpParams, CommentListParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, ModerateContributionParams, FlaggedContributionParams, CustomNotificationParams, UserGetParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadCompleteParams, ChunkUploadParams, ThreadParams, ThreadDeleteParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, ScheduledFeedObjParams, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, GroupCreateParams, GroupFeedParams, EventCreateParams, EventFeedParams, EventRelatedParams, EventSearchParams, LiveStreamCreateParams, LiveStreamSearchParams, LiveStreamRemoveParticipantParams, StartStepParams, OnBoardingStep, CourseCreateParams, CourseSearchParams, CourseInfoViewType, CourseInfoParams, CourseLessonCommentsParams, CourseUserRoleParams, CourseUsersParams, CourseDashboardUsersParams, PaymentContentStatusParams, PaymentContentStatus, PaymentProductsParams, CustomerPortalCreateSessionParams, CheckoutSessionParams, CheckoutCreateSessionParams, PaymentOrderParams };
32
+ import { ContactUsRequestParams } from './contactUs';
33
+ export { AccountCreateParams, AccountVerifyParams, AccountRecoverParams, AccountResetParams, AccountSearchParams, SCPaginatedResponse, WebhookParamType, WebhookEventsType, SSOSignUpParams, CommentListParams, CommentCreateParams, IncubatorCreateParams, IncubatorSearchParams, LoyaltyPrizeParams, LoyaltyGetPrizeParams, ModerationParams, ModerateContributionParams, FlaggedContributionParams, CustomNotificationParams, UserGetParams, UserAutocompleteParams, UserScoreParams, UserSearchParams, TagParams, TagGetParams, MediaCreateParams, MediaTypes, ChunkUploadCompleteParams, ChunkUploadParams, ThreadParams, ThreadDeleteParams, MessageCreateParams, MessageMediaUploadParams, MessageThumbnailUploadParams, MessageChunkUploadDoneParams, MessageMediaChunksParams, CategoryParams, CustomAdvParams, CustomPageParams, CustomPageSearchParams, EmbedUpdateParams, EmbedSearchParams, BaseGetParams, BaseSearchParams, FeedObjGetParams, FeedObjCreateParams, FeedObjectPollVotesSearch, ScheduledFeedObjParams, FeedParams, LegalPageFilterParams, FeatureParams, ScoreParams, InsightContributionParams, InsightUserParams, InsightEmbedParams, InsightCommonParams, ReactionParams, GroupCreateParams, GroupFeedParams, EventCreateParams, EventFeedParams, EventRelatedParams, EventSearchParams, LiveStreamCreateParams, LiveStreamSearchParams, LiveStreamRemoveParticipantParams, StartStepParams, OnBoardingStep, CourseCreateParams, CourseSearchParams, CourseInfoViewType, CourseInfoParams, CourseLessonCommentsParams, CourseUserRoleParams, CourseUsersParams, CourseDashboardUsersParams, PaymentContentStatusParams, PaymentContentStatus, PaymentProductsParams, CustomerPortalCreateSessionParams, CheckoutSessionParams, CheckoutCreateSessionParams, PaymentOrderParams, ContactUsRequestParams };
@@ -27,6 +27,10 @@ export interface UserAutocompleteParams extends BaseSearchParams {
27
27
  * Ordering fields (eg?: ?ordering=username). Minus char is used for descending ordering, eg. -username
28
28
  */
29
29
  ordering?: string;
30
+ /**
31
+ * Filter using the user ids
32
+ */
33
+ exclude?: string;
30
34
  }
31
35
  /**
32
36
  * UserScoreParams interface.