@selfcommunity/api-services 0.1.5 → 0.1.6-alpha.2

package/lib/esm/types/src/types/tag.d.ts

@@ -0,0 +1,47 @@
+/**
+ * Interface SCTagType.
+ * Tag Schema.
+ */
+export interface SCTagType {
+    /**
+     * Unique integer value identifying this tag.
+     */
+    id: number;
+    /**
+     * The type of the tag (unique together name).
+     */
+    type?: string;
+    /**
+     * The name of the tag (unique together type).
+     */
+    name: string;
+    /**
+     * Short description of the tag.
+     */
+    description: string;
+    /**
+     * Hexadecimal format color code with prefix '#'.
+     */
+    color: string;
+    /**
+     * Tag publicly visible.
+     */
+    visible?: boolean;
+    /**
+     * The tag has a visibility boost.
+     */
+    visibility_boost?: boolean;
+    /**
+     * Creation date time.
+     */
+    created_at?: string;
+    /**
+     * Tag active or not
+     */
+    active?: boolean;
+    /**
+     * Tag deleted or not
+     */
+    deleted: boolean;
+}
+//# sourceMappingURL=tag.d.ts.map

package/lib/esm/types/src/types/tag.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tag.d.ts","sourceRoot":"","sources":["../../../../../../types/src/types/tag.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,SAAS;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAE3B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB"}

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

@@ -0,0 +1,231 @@
+/**
+ * Interface SCUserType.
+ * User Schema.
+ */
+import { SCTagType } from './tag';
+/**
+ * User Fields
+ */
+export declare enum SCUserFields {
+    USERNAME = "username",
+    REAL_NAME = "real_name",
+    DATE_JOINED = "date_joined",
+    BIO = "bio",
+    LOCATION = "location",
+    DATE_OF_BIRTH = "date_of_birth",
+    DESCRIPTION = "description",
+    GENDER = "gender",
+    WEBSITE = "website"
+}
+/**
+ * User status
+ */
+export declare enum SCUserStatus {
+    APPROVED = "a",
+    BLOCKED = "b",
+    DELETED = "d",
+    UNREGISTERED = "u"
+}
+export interface SCUserType {
+    /**
+     * The ID of the user.
+     */
+    id: number;
+    /**
+     * The username of the user.
+     */
+    username: string;
+    /**
+     * Real name of the user.
+     */
+    real_name: string;
+    /**
+     * Email of the user.
+     */
+    email?: string;
+    /**
+     * Email is valid. Default: False.
+     */
+    email_isvalid?: boolean;
+    /**
+     * Date joined to the community.
+     */
+    date_joined: Date;
+    /**
+     * User biography.
+     */
+    bio: string;
+    /**
+     * Location
+     */
+    location: string;
+    /**
+     * Location in coordinates. Format: lat,lng.
+     */
+    location_lat_lng?: string;
+    /**
+     * User current position. Format: lat,lng.
+     */
+    position_lat_lng?: string;
+    /**
+     * Date of birth. Format: YYYY-MM-DD (ISO 8601).
+     */
+    date_of_birth?: Date;
+    /**
+     * User description.
+     */
+    description: string;
+    /**
+     * Gender of the user. Values: Male, Female, Unspecified. Default: Unspecified.
+     */
+    gender: string;
+    /**
+     * User status. Values: a (approved), b (blocked), d (deleted; soft deleted), u (unregistered). Default: a.
+     * A blocked user can't:
+     *    - create contribution (post/discussion/status)
+     *    - create comment
+     *    - vote/unvote contribution
+     *    - follow/connect user
+     *    - edit contribution
+     *    - suggest an incubator
+     *    - flag a contribution
+     *    - send a private message
+     *    - edit info profile
+     * but he can't:
+     *    - follow/unfollow a post/discussion/status
+     *    - follow/unfollow a category
+     *    - unfollow user
+     */
+    status: string;
+    /**
+     * User website.
+     */
+    website: string;
+    /**
+     * Avatar of the user.
+     */
+    avatar: string;
+    /**
+     * Image Cover of the user.
+     */
+    cover?: string;
+    /**
+     * The external ID of the user. It is assigned only during signup if necessary.
+     */
+    ext_id?: number;
+    /**
+     * User's tag list. List of Tag.
+     */
+    tags: Array<SCTagType>;
+    /**
+     * User reputation.
+     */
+    reputation: number;
+    /**
+     * List of user permission. Only for the resource /user/me/.
+     */
+    permission?: Array<string>;
+    /**
+     * The connection status between the request user and this user.
+     */
+    connection_status?: string;
+    /**
+     * Number of connection requests sent by the user.
+     */
+    connection_requests_sent_counter?: number;
+    /**
+     * Number of connection requests received by the user.
+     */
+    connection_requests_received_counter?: number;
+    /**
+     * Number of connections of the user.
+     */
+    connections_counter?: number;
+    /**
+     * Number of followings of the user
+     */
+    followings_counter?: number;
+    /**
+     * Number of followers of the user
+     */
+    followers_counter?: number;
+    /**
+     * Number of posts created by the user.
+     */
+    posts_counter?: number;
+    /**
+     * Number of discussions created by the user.
+     */
+    discussions_counter?: number;
+    /**
+     * Number of statuses created by the user.
+     */
+    statuses_counter?: number;
+    /**
+     * Number of polls created by the user.
+     */
+    polls_counter?: number;
+    /**
+     * Number of categories followed by the user.
+     */
+    categories_counter?: number;
+    /**
+     *  User role
+     */
+    role: string;
+    /**
+     * interactions counter
+     */
+    unseen_interactions_counter?: number;
+    /**
+     * notification banner counter
+     */
+    unseen_notification_banners_counter?: number;
+}
+/**
+ * User Settings
+ */
+export interface SCUserSettingsType {
+    /**
+     * Frequency of the email notifications for all interactions (except for private messages notifications)
+     */
+    qa_frequency: number;
+    /**
+     * Enable private messages notifications also via mail
+     */
+    email_notification_not_qa: number;
+    /**
+     * Enable mobile app/PWA notifications
+     */
+    mobile_notifications_scmty: number;
+    /**
+     * Shows a popup when the user receive a notification
+     */
+    show_toast_notifications: number;
+    /**
+     * Emit a sound when the notification popup is shown. See 'show_toast_notifications'
+     */
+    toast_notifications_emit_sound: number;
+}
+/**
+ * User Blocked Settings
+ */
+export interface SCUserBlockedSettingsType {
+    /**
+     * N° days of block
+     */
+    days_blocked: number;
+    /**
+     * Reputation stolen
+     */
+    reputation_delta: number;
+    /**
+     * Start User Block datetime
+     */
+    blocked_at?: Date;
+    /**
+     * End User Block datetime
+     */
+    expire_at?: Date;
+}
+//# sourceMappingURL=user.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"user.d.ts","sourceRoot":"","sources":["../../../../../../types/src/types/user.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAC,SAAS,EAAC,MAAM,OAAO,CAAC;AAEhC;;GAEG;AACH,oBAAY,YAAY;IACtB,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,WAAW,gBAAgB;IAC3B,GAAG,QAAQ;IACX,QAAQ,aAAa;IACrB,aAAa,kBAAkB;IAC/B,WAAW,gBAAgB;IAC3B,MAAM,WAAW;IACjB,OAAO,YAAY;CACpB;AAED;;GAEG;AACH,oBAAY,YAAY;IACtB,QAAQ,MAAM;IACd,OAAO,MAAM;IACb,OAAO,MAAM;IACb,YAAY,MAAM;CACnB;AAED,MAAM,WAAW,UAAU;IACzB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;OAEG;IACH,WAAW,EAAE,IAAI,CAAC;IAElB;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,aAAa,CAAC,EAAE,IAAI,CAAC;IAErB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;;;;;;;;;;;OAgBG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,SAAS,CAAC,CAAC;IAEvB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,UAAU,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE3B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,gCAAgC,CAAC,EAAE,MAAM,CAAC;IAE1C;;OAEG;IACH,oCAAoC,CAAC,EAAE,MAAM,CAAC;IAE9C;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;IAE3B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,2BAA2B,CAAC,EAAE,MAAM,CAAC;IAErC;;OAEG;IACH,mCAAmC,CAAC,EAAE,MAAM,CAAC;CAC9C;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,yBAAyB,EAAE,MAAM,CAAC;IAElC;;OAEG;IACH,0BAA0B,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,wBAAwB,EAAE,MAAM,CAAC;IAEjC;;OAEG;IACH,8BAA8B,EAAE,MAAM,CAAC;CACxC;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB;;OAEG;IACH,UAAU,CAAC,EAAE,IAAI,CAAC;IAElB;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAC;CAClB"}

package/lib/esm/types/src/types/webhook.d.ts

@@ -0,0 +1,91 @@
+/**
+ * Interface SCWebhookEndpointType
+ * Webhook Schema
+ */
+export interface SCWebhookEndpointType {
+    /**
+     * Webhook id
+     */
+    id: number;
+    /**
+     * Webhook creation date-time
+     */
+    created_at: Date | string;
+    /**
+     * Webhook update date-time
+     */
+    updated_at: Date | string;
+    /**
+     * Active status
+     */
+    is_active: boolean;
+    /**
+     * Webhook target
+     */
+    target: string;
+    /**
+     * Webhook description
+     */
+    description: string;
+    /**
+     * Webhook events
+     */
+    events: SCWebhookEventsType[];
+    /**
+     * Webhook SSL certificates for HTTPS requests.
+     */
+    ssl_cert_verification: boolean;
+}
+export interface SCWebhookEndpointAttemptType {
+    /**
+     * Webhook attempt id
+     */
+    id: number;
+    /**
+     * Webhook attempt creation date-time
+     */
+    created_at: Date | string;
+    /**
+     * Webhook attempt event
+     */
+    event: SCWebhookEventsType[];
+    /**
+     * Webhook attempt sent date-time
+     */
+    sent_at: Date | string;
+    /**
+     * Active status
+     */
+    http_request_body: string;
+    /**
+     * Http request signature header
+     */
+    http_request_signature_header: string;
+    /**
+     * Http response code
+     */
+    http_response_code: number;
+    /**
+     * Http response body
+     */
+    http_response_body: string;
+    /**
+     * Date time of next retry
+     */
+    next_retry: Date | string;
+}
+export interface SCWebhookEndpointSecretType {
+    signing_secret: string;
+}
+export interface SCWebhookEventsType {
+    /**
+     * Webhook event type: contains the name of the event that triggered the webhook
+     * example: "category.follow"
+     */
+    type: string;
+    /**
+     * Creation date time
+     */
+    added_at: Date | string;
+}
+//# sourceMappingURL=webhook.d.ts.map

package/lib/esm/types/src/types/webhook.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhook.d.ts","sourceRoot":"","sources":["../../../../../../types/src/types/webhook.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,MAAM,WAAW,qBAAqB;IACpC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,MAAM,CAAC;IAC1B;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,MAAM,CAAC;IAC1B;;OAEG;IACH,SAAS,EAAE,OAAO,CAAC;IACnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,MAAM,EAAE,mBAAmB,EAAE,CAAC;IAC9B;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;CAChC;AAED,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IACX;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,MAAM,CAAC;IAC1B;;OAEG;IACH,KAAK,EAAE,mBAAmB,EAAE,CAAC;IAC7B;;OAEG;IACH,OAAO,EAAE,IAAI,GAAG,MAAM,CAAC;IACvB;;OAEG;IACH,iBAAiB,EAAE,MAAM,CAAC;IAC1B;;OAEG;IACH,6BAA6B,EAAE,MAAM,CAAC;IACtC;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAC;IAC3B;;OAEG;IACH,UAAU,EAAE,IAAI,GAAG,MAAM,CAAC;CAC3B;AAED,MAAM,WAAW,2BAA2B;IAC1C,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,QAAQ,EAAE,IAAI,GAAG,MAAM,CAAC;CACzB"}

package/lib/esm/types/webhook.js

@@ -0,0 +1,3 @@
+"use strict";
+
+exports.__esModule = true;

package/lib/esm/utils/apiRequest.js

@@ -0,0 +1,26 @@
+"use strict";
+
+exports.__esModule = true;
+exports.apiRequest = apiRequest;
+
+var _client = _interopRequireDefault(require("../client"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+function apiRequest(url, method, data) {
+  return _client.default.request({
+    url,
+    method,
+    data: data != null ? data : null
+  }).then(res => {
+    if (res.status >= 300) {
+      console.log(`Unable to ${method} ${url} (Response code: ${res.status}).`);
+      return Promise.reject(res);
+    }
+
+    return Promise.resolve(res.data);
+  }).catch(error => {
+    console.log(`Unable to ${method} ${url}`);
+    return Promise.reject(error);
+  });
+}