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

package/lib/esm/constants/Endpoints.js

@@ -164,6 +164,10 @@ const Endpoints = {
         url: urlReplacer('/api/v2/$(type)/drafted/'),
         method: 'GET'
     },
+    GetDownloadCSV: {
+        url: urlReplacer('/api/v2/$(type)/$(id)/export/'),
+        method: 'GET'
+    },
     /**
      * Comments
      */
@@ -300,8 +304,8 @@ const Endpoints = {
         url: urlReplacer('/api/v2/tag/'),
         method: 'POST'
     },
-    SearchTag: {
-        url: urlReplacer('/api/v2/tag/'),
+    SearchUserTags: {
+        url: urlReplacer('/api/v2/tag/user/search/'),
         method: 'GET'
     },
     Tag: {
@@ -327,6 +331,10 @@ const Endpoints = {
         url: urlReplacer('/api/v2/user/'),
         method: 'GET'
     },
+    UserMatchUsernames: {
+        url: urlReplacer('/api/v2/user/match/'),
+        method: 'POST'
+    },
     ListHiddenUsers: {
         url: urlReplacer('/api/v2/user/hidden_users/'),
         method: 'GET'
@@ -1657,6 +1665,16 @@ const Endpoints = {
         url: urlReplacer('/api/v2/payments/customer_portal_session/'),
         method: 'POST'
     },
-    CreatePaymentProduct: { url: urlReplacer('/api/v2/payments/payment_product/price/'), method: 'POST' }
+    CreatePaymentProduct: {
+        url: urlReplacer('/api/v2/payments/payment_product/price/'),
+        method: 'POST'
+    },
+    /**
+     * Contact-us Endpoints
+     */
+    ContactRequest: {
+        url: urlReplacer('/api/v2/contact/request/'),
+        method: 'POST'
+    }
 };
 export default Endpoints;

package/lib/esm/index.d.ts

@@ -53,11 +53,12 @@ import OnBoardingService, { OnBoardingApiClient, OnBoardingApiClientInterface }
 import CourseService, { CourseApiClient, CourseApiClientInterface } from './services/course';
 import PaymentService, { PaymentApiClient, PaymentApiClientInterface } from './services/payment';
 import CommunityService, { CommunityApiClient, CommunityApiClientInterface } from './services/community';
+import ContactUsService, { ContactUsApiClient, ContactUsApiClientInterface } from './services/contact_us';
 /**
  * Types
  */
-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';
+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';
 /**
  * Export all
  */
-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 };
+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

@@ -53,6 +53,7 @@ import OnBoardingService, { OnBoardingApiClient } from './services/onboarding';
 import CourseService, { CourseApiClient } from './services/course';
 import PaymentService, { PaymentApiClient } from './services/payment';
 import CommunityService, { CommunityApiClient } from './services/community';
+import ContactUsService, { ContactUsApiClient } from './services/contact_us';
 /**
  * Types
  */
@@ -60,4 +61,4 @@ import { MediaTypes, OnBoardingStep, CourseInfoViewType } from './types';
 /**
  * Export all
  */
-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 };
+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 };

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

@@ -34,30 +34,34 @@ export declare class CommunityApiClient {
 }
 /**
  *
- :::tip Community service can be used in the following way:
-
- ```jsx
- 1. Import the service from our library:
-
- import {CommunityService} from "@selfcommunity/api-services";
- ```
- ```jsx
- 2. Create a function and put the service inside it!
- The async function `getCommunities` will return the events matching the search query.
-
- async getCommunities() {
-         return await CommunityService.getCommunities({...});
-        }
- ```
- 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!
- ```
- :::
+ * :::tip Community service can be used in the following way:
+ *
+ * 1. Import the service from our library:
+ *
+ * ```ts
+ * import {CommunityService} from "@selfcommunity/api-services";
+ * ```
+ *
+ * 2. Create a function and put the service inside it! The async function `getCommunities`
+ * will return the events matching the search query.
+ *
+ * ```ts
+ * async function getCommunities() {
+ *   return await CommunityService.getCommunities({...});
+ * }
+ * ```
+ *
+ * If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
+ *
+ * 1. Declare it (or declare multiple params):
+ *
+ * ```ts
+ * const 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 CommunityService {
     static getCommunities(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCCommunityType>>;

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

@@ -26,30 +26,34 @@ export class CommunityApiClient {
 }
 /**
  *
- :::tip Community service can be used in the following way:
-
- ```jsx
- 1. Import the service from our library:
-
- import {CommunityService} from "@selfcommunity/api-services";
- ```
- ```jsx
- 2. Create a function and put the service inside it!
- The async function `getCommunities` will return the events matching the search query.
-
- async getCommunities() {
-         return await CommunityService.getCommunities({...});
-        }
- ```
- 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!
- ```
- :::
+ * :::tip Community service can be used in the following way:
+ *
+ * 1. Import the service from our library:
+ *
+ * ```ts
+ * import {CommunityService} from "@selfcommunity/api-services";
+ * ```
+ *
+ * 2. Create a function and put the service inside it! The async function `getCommunities`
+ * will return the events matching the search query.
+ *
+ * ```ts
+ * async function getCommunities() {
+ *   return await CommunityService.getCommunities({...});
+ * }
+ * ```
+ *
+ * If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).
+ *
+ * 1. Declare it (or declare multiple params):
+ *
+ * ```ts
+ * const 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 CommunityService {
     static getCommunities(params, config) {

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

@@ -0,0 +1,57 @@
+import { ContactUsRequestParams } from '../../types';
+import { type SCContactUsRequestType } from '@selfcommunity/types';
+import { AxiosRequestConfig } from 'axios';
+export interface ContactUsApiClientInterface {
+    request(data?: ContactUsRequestParams, config?: AxiosRequestConfig): Promise<SCContactUsRequestType>;
+}
+/**
+ * Contains all the endpoints needed to contact-us.
+ */
+export declare class ContactUsApiClient {
+    /**
+     * This endpoint create an contact request.
+     *
+     * It requires an authenticated user.
+     *
+     * @param data
+     * @param config
+     */
+    static request(data?: ContactUsRequestParams, config?: AxiosRequestConfig): Promise<SCContactUsRequestType>;
+}
+/**
+ *
+ :::tip Contact service can be used in the following way:
+ ```jsx
+ 1. Import the service from our library:
+
+ import {ContactService} 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 create() {
+   return await ContactService.request();
+ }
+ ```
+ ```jsx
+ In case of required `params`, just add them inside the brackets.
+
+ async request(data) {
+  return await ContactService.request(data);
+ }
+ ```
+ ```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 ContactUsService {
+    static request(data?: ContactUsRequestParams, config?: AxiosRequestConfig): Promise<SCContactUsRequestType>;
+}

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

@@ -0,0 +1,60 @@
+import { __awaiter } from "tslib";
+import Endpoints from '../../constants/Endpoints';
+import { apiRequest } from '../../utils/apiRequest';
+/**
+ * Contains all the endpoints needed to contact-us.
+ */
+export class ContactUsApiClient {
+    /**
+     * This endpoint create an contact request.
+     *
+     * It requires an authenticated user.
+     *
+     * @param data
+     * @param config
+     */
+    static request(data, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { data, url: Endpoints.ContactRequest.url({}), method: Endpoints.ContactRequest.method }));
+    }
+}
+/**
+ *
+ :::tip Contact service can be used in the following way:
+ ```jsx
+ 1. Import the service from our library:
+
+ import {ContactService} 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 create() {
+   return await ContactService.request();
+ }
+ ```
+ ```jsx
+ In case of required `params`, just add them inside the brackets.
+
+ async request(data) {
+  return await ContactService.request(data);
+ }
+ ```
+ ```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 ContactUsService {
+    static request(data, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return ContactUsApiClient.request(data, config);
+        });
+    }
+}

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

@@ -4,7 +4,6 @@ import { AxiosRequestConfig } from 'axios';
 export interface CustomMenuApiClientInterface {
     getASpecificCustomMenu(id: number | string, config?: AxiosRequestConfig): Promise<SCCustomMenuType>;
     getAllCustomMenus(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCCustomMenuType>>;
-    getBaseCustomMenu(config?: AxiosRequestConfig): Promise<SCCustomMenuType>;
     searchCustomMenus(params?: BaseSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCCustomMenuType>>;
 }
 /**
@@ -23,11 +22,6 @@ export declare class CustomMenuApiClient {
      * @param config
      */
     static getAllCustomMenus(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCCustomMenuType>>;
-    /**
-     * This endpoint retrieves the base custom menu.
-     * @param config
-     */
-    static getBaseCustomMenu(config?: AxiosRequestConfig): Promise<SCCustomMenuType>;
     /**
      * This endpoint performs search of a Custom Menu
      * @param params
@@ -73,6 +67,5 @@ export declare class CustomMenuApiClient {
 export default class CustomMenuService {
     static getASpecificCustomMenu(id: number | string, config?: AxiosRequestConfig): Promise<SCCustomMenuType>;
     static getAllCustomMenus(params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCCustomMenuType>>;
-    static getBaseCustomMenu(config?: AxiosRequestConfig): Promise<SCCustomMenuType>;
     static searchCustomMenus(params?: BaseSearchParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCCustomMenuType>>;
 }

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

@@ -23,13 +23,6 @@ export class CustomMenuApiClient {
         const p = urlParams(params);
         return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.GetCustomMenus.url({})}?${p.toString()}`, method: Endpoints.GetCustomMenus.method }));
     }
-    /**
-     * This endpoint retrieves the base custom menu.
-     * @param config
-     */
-    static getBaseCustomMenu(config) {
-        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.CustomMenu.url({ id: 'base' }), method: Endpoints.CustomMenu.method }));
-    }
     /**
      * This endpoint performs search of a Custom Menu
      * @param params
@@ -86,11 +79,6 @@ export default class CustomMenuService {
             return CustomMenuApiClient.getAllCustomMenus(params, config);
         });
     }
-    static getBaseCustomMenu(config) {
-        return __awaiter(this, void 0, void 0, function* () {
-            return CustomMenuApiClient.getBaseCustomMenu(config);
-        });
-    }
     static searchCustomMenus(params, config) {
         return __awaiter(this, void 0, void 0, function* () {
             return CustomMenuApiClient.searchCustomMenus(params, config);

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

@@ -4,13 +4,13 @@ import { CheckoutCreateSessionParams, CheckoutSessionParams, PaymentProductsPara
 import { SCCheckoutSession, SCPaymentOrder, SCCheckoutSessionDetail, SCCheckoutSessionComplete, SCPaymentProduct, SCPaymentPrice, SCPaymentsCustomerPortalSession, SCPaywall } from '@selfcommunity/types';
 export interface PaymentApiClientInterface {
     /**
-     * Get payment products related to an object (aka paywalls) of type <content_type> and id <content_id> and the current payment_order
+     * 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
      * @param params
      * @param config
      */
     getPaymentContentStatus(params?: PaymentContentStatusParams, config?: AxiosRequestConfig): Promise<PaymentContentStatus>;
     /**
-     * Get payment products related to an object (aka paywalls) of type <content_type> and id <content_id>
+     * Get payment products related to an object (aka paywalls) of type &lt;content_type&gt; and id &lt;content_id&gt;
      * @param params
      * @param config
      */
@@ -35,7 +35,7 @@ export interface PaymentApiClientInterface {
      */
     getPaymentProductPrices(id: number | string, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentPrice>>;
     /**
-     * Create session checkout with price_id for an object of type <content_type> and id <content_id>
+     * Create session checkout with price_id for an object of type &lt;content_type&gt; and id &lt;content_id&gt;
      * @param data
      * @param config
      */
@@ -88,13 +88,13 @@ export interface PaymentApiClientInterface {
  */
 export declare class PaymentApiClient {
     /**
-     * This endpoint retrieves all the products related to an object of type <content_type> and id <content_id> and the current payment_order
+     * 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
      * @param params
      * @param config
      */
     static getPaymentContentStatus(params?: PaymentContentStatusParams, config?: AxiosRequestConfig): Promise<PaymentContentStatus>;
     /**
-     * This endpoint retrieves all the products related to an object of type <content_type> and id <content_id>
+     * This endpoint retrieves all the products related to an object of type &lt;content_type&gt; and id &lt;content_id&gt;
      * @param params
      * @param config
      */

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

@@ -7,7 +7,7 @@ import { urlParams } from '../../utils/url';
  */
 export class PaymentApiClient {
     /**
-     * This endpoint retrieves all the products related to an object of type <content_type> and id <content_id> and the current payment_order
+     * 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
      * @param params
      * @param config
      */
@@ -15,7 +15,7 @@ export class PaymentApiClient {
         return apiRequest(Object.assign(Object.assign({}, config), { params, url: `${Endpoints.GetPaymentContentStatus.url({})}`, method: Endpoints.GetPaymentContentStatus.method }));
     }
     /**
-     * This endpoint retrieves all the products related to an object of type <content_type> and id <content_id>
+     * This endpoint retrieves all the products related to an object of type &lt;content_type&gt; and id &lt;content_id&gt;
      * @param params
      * @param config
      */

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

@@ -4,7 +4,7 @@ import { AxiosRequestConfig } from 'axios';
 export interface TagApiClientInterface {
     getAllTags(params?: TagGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCTagType>>;
     createTag(data: TagParams, config?: AxiosRequestConfig): Promise<SCTagType>;
-    searchTag(params?: TagGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCTagType>>;
+    searchUserTags(params?: TagGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCTagType>>;
     getSpecificTag(id: number | string, config?: AxiosRequestConfig): Promise<SCTagType>;
     updateTag(id: number | string, data?: TagParams, config?: AxiosRequestConfig): Promise<SCTagType>;
     patchTag(id: number | string, data?: TagParams, config?: AxiosRequestConfig): Promise<SCTagType>;
@@ -32,7 +32,7 @@ export declare class TagApiClient {
      * @param params
      * @param config
      */
-    static searchTag(params?: TagGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCTagType>>;
+    static searchUserTags(params?: TagGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCTagType>>;
     /**
      * This endpoint retrieves a specific tag.
      * @param id
@@ -101,7 +101,7 @@ export declare class TagApiClient {
 export default class TagService {
     static getAllTags(params?: TagGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCTagType>>;
     static createTag(data: TagParams, config?: AxiosRequestConfig): Promise<SCTagType>;
-    static searchTag(params?: TagGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCTagType>>;
+    static searchUserTags(params?: TagGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCTagType>>;
     static getSpecificTag(id: number | string, config?: AxiosRequestConfig): Promise<SCTagType>;
     static updateTag(id: number | string, data?: TagParams, config?: AxiosRequestConfig): Promise<SCTagType>;
     static patchTag(id: number | string, data?: TagParams, config?: AxiosRequestConfig): Promise<SCTagType>;

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

@@ -29,9 +29,9 @@ export class TagApiClient {
      * @param params
      * @param config
      */
-    static searchTag(params, config) {
+    static searchUserTags(params, config) {
         const p = urlParams(params);
-        return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.SearchTag.url({})}?${p.toString()}`, method: Endpoints.SearchTag.method }));
+        return apiRequest(Object.assign(Object.assign({}, config), { url: `${Endpoints.SearchUserTags.url({})}?${p.toString()}`, method: Endpoints.SearchUserTags.method }));
     }
     /**
      * This endpoint retrieves a specific tag.
@@ -117,9 +117,9 @@ export default class TagService {
             return TagApiClient.createTag(data, config);
         });
     }
-    static searchTag(params, config) {
+    static searchUserTags(params, config) {
         return __awaiter(this, void 0, void 0, function* () {
-            return TagApiClient.searchTag(params, config);
+            return TagApiClient.searchUserTags(params, config);
         });
     }
     static getSpecificTag(id, config) {

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

@@ -57,6 +57,7 @@ export interface UserApiClientInterface {
     getUserLiveStream(id: number | string, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLiveStreamType>>;
     getOrderHistory(id: number, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaymentOrder[]>;
     getOrderDetail(id: number, order: number, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaymentOrder>;
+    matchUsernames(usernames: string[], config?: AxiosRequestConfig): Promise<SCUserAutocompleteType[]>;
 }
 /**
  * Contains all the endpoints needed to manage users.
@@ -410,6 +411,12 @@ export declare class UserApiClient {
      * @param config
      */
     static getOrderDetail(id: number, order: number, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaymentOrder>;
+    /**
+     * This endpoint retrieve the users corresponding to the sent usernames
+     * @param usernames
+     * @param config
+     */
+    static matchUsernames(usernames: string[], config?: AxiosRequestConfig): Promise<SCUserAutocompleteType[]>;
 }
 /**
  *
@@ -503,4 +510,5 @@ export default class UserService {
     static getUserLiveStream(id: number | string, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCLiveStreamType>>;
     static getOrderHistory(id: number, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaginatedResponse<SCPaymentOrder>>;
     static getOrderDetail(id: number, order: number, params?: BaseGetParams, config?: AxiosRequestConfig): Promise<SCPaymentOrder>;
+    static matchUsernames(usernames: string[], config?: AxiosRequestConfig): Promise<SCUserAutocompleteType[]>;
 }

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

@@ -477,6 +477,14 @@ export class UserApiClient {
     static getOrderDetail(id, order, params, config) {
         return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.GetOrderDetail.url({ id, order }), method: Endpoints.GetOrderDetail.method, params }));
     }
+    /**
+     * This endpoint retrieve the users corresponding to the sent usernames
+     * @param usernames
+     * @param config
+     */
+    static matchUsernames(usernames, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.UserMatchUsernames.url(), method: Endpoints.UserMatchUsernames.method, data: usernames }));
+    }
 }
 /**
  *
@@ -786,4 +794,9 @@ export default class UserService {
             return UserApiClient.getOrderDetail(id, order, params, config);
         });
     }
+    static matchUsernames(usernames, config) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return UserApiClient.matchUsernames(usernames, config);
+        });
+    }
 }

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

@@ -0,0 +1,25 @@
+/**
+ * ContactUsRequestParams interface
+ */
+export interface ContactUsRequestParams {
+    /**
+     * name field for the account
+     */
+    name?: string;
+    /**
+     * Surname field for the account
+     */
+    surname?: string;
+    /**
+     * Email field for the account
+     */
+    email?: string;
+    /**
+     * Contact request message text
+     */
+    message?: string;
+    /**
+     * Any other properties
+     */
+    [p: string]: any;
+}

package/lib/esm/types/contactUs.js

@@ -0,0 +1,4 @@
+/**
+ * ContactUsRequestParams interface
+ */
+export {};

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

@@ -29,4 +29,5 @@ import { LiveStreamCreateParams, LiveStreamSearchParams, LiveStreamRemovePartici
 import { StartStepParams, OnBoardingStep } from './onBoarding';
 import { CourseCreateParams, CourseSearchParams, CourseInfoViewType, CourseInfoParams, CourseLessonCommentsParams, CourseUserRoleParams, CourseUsersParams, CourseDashboardUsersParams } from './course';
 import { PaymentContentStatusParams, PaymentContentStatus, PaymentProductsParams, CustomerPortalCreateSessionParams, CheckoutSessionParams, CheckoutCreateSessionParams, PaymentOrderParams } from './payment';
-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 };
+import { ContactUsRequestParams } from './contactUs';
+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 };

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

@@ -27,6 +27,10 @@ export interface UserAutocompleteParams extends BaseSearchParams {
      * Ordering fields (eg?: ?ordering=username). Minus char is used for descending ordering, eg. -username
      */
     ordering?: string;
+    /**
+     * Filter using the user ids
+     */
+    exclude?: string;
 }
 /**
  * UserScoreParams interface.