@selfcommunity/api-services 0.7.0-alpha.3 → 0.7.0-alpha.5

package/lib/cjs/constants/Endpoints.js

@@ -333,6 +333,10 @@ const Endpoints = {
         url: (0, utils_1.urlReplacer)('/api/v2/user/'),
         method: 'GET'
     },
+    UserMatchUsernames: {
+        url: (0, utils_1.urlReplacer)('/api/v2/user/match/?usernames=$(usernames)'),
+        method: 'GET'
+    },
     ListHiddenUsers: {
         url: (0, utils_1.urlReplacer)('/api/v2/user/hidden_users/'),
         method: 'GET'

package/lib/cjs/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 detail of an order
+     * @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/cjs/services/user/index.js

@@ -480,6 +480,14 @@ class UserApiClient {
     static getOrderDetail(id, order, params, config) {
         return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.GetOrderDetail.url({ id, order }), method: Endpoints_1.default.GetOrderDetail.method, params }));
     }
+    /**
+     * This endpoint retrieve detail of an order
+     * @param usernames
+     * @param config
+     */
+    static matchUsernames(usernames, config) {
+        return (0, apiRequest_1.apiRequest)(Object.assign(Object.assign({}, config), { url: Endpoints_1.default.UserMatchUsernames.url({ usernames }), method: Endpoints_1.default.UserMatchUsernames.method }));
+    }
 }
 exports.UserApiClient = UserApiClient;
 /**
@@ -790,5 +798,10 @@ class UserService {
             return UserApiClient.getOrderDetail(id, order, params, config);
         });
     }
+    static matchUsernames(usernames, config) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return UserApiClient.matchUsernames(usernames, config);
+        });
+    }
 }
 exports.default = UserService;

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

@@ -11,15 +11,15 @@ export interface ContactUsRequestParams {
      */
     surname?: string;
     /**
-   * Email field for the account
-   */
+     * Email field for the account
+     */
     email?: string;
     /**
-     * Contact request text
+     * Contact request message text
      */
-    body?: string;
+    message?: string;
     /**
-     * Any other properties available in user_metadata_definition
+     * Any other properties
      */
     [p: string]: any;
 }

package/lib/cjs/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.

package/lib/esm/constants/Endpoints.js

@@ -331,6 +331,10 @@ const Endpoints = {
         url: urlReplacer('/api/v2/user/'),
         method: 'GET'
     },
+    UserMatchUsernames: {
+        url: urlReplacer('/api/v2/user/match/?usernames=$(usernames)'),
+        method: 'GET'
+    },
     ListHiddenUsers: {
         url: urlReplacer('/api/v2/user/hidden_users/'),
         method: 'GET'

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 detail of an order
+     * @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 detail of an order
+     * @param usernames
+     * @param config
+     */
+    static matchUsernames(usernames, config) {
+        return apiRequest(Object.assign(Object.assign({}, config), { url: Endpoints.UserMatchUsernames.url({ usernames }), method: Endpoints.UserMatchUsernames.method }));
+    }
 }
 /**
  *
@@ -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

@@ -11,15 +11,15 @@ export interface ContactUsRequestParams {
      */
     surname?: string;
     /**
-   * Email field for the account
-   */
+     * Email field for the account
+     */
     email?: string;
     /**
-     * Contact request text
+     * Contact request message text
      */
-    body?: string;
+    message?: string;
     /**
-     * Any other properties available in user_metadata_definition
+     * Any other properties
      */
     [p: string]: any;
 }

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.