@parra/parra-js-sdk 0.2.10 → 0.2.14

package/dist/ParraAPI.d.ts

@@ -11,7 +11,7 @@ export interface Tenant {
     name: string;
     is_test: boolean;
 }
-export interface TenantColectionResponse {
+export interface TenantCollectionResponse {
     page: number;
     page_count: number;
     page_size: number;
@@ -20,6 +20,7 @@ export interface TenantColectionResponse {
 }
 export interface CreateApiKeyRequestBody {
     name: string;
+    description?: string | null;
 }
 export interface ApiKey {
     id: string;
@@ -27,6 +28,7 @@ export interface ApiKey {
     updated_at: string;
     deleted_at?: string | null;
     name: string;
+    description?: string | null;
     tenant_id: string;
 }
 export interface ApiKeyWithSecretResponse {
@@ -35,10 +37,11 @@ export interface ApiKeyWithSecretResponse {
     updated_at: string;
     deleted_at?: string | null;
     name: string;
+    description?: string | null;
     tenant_id: string;
     secret: string;
 }
-export interface ApiKeyColectionResponse {
+export interface ApiKeyCollectionResponse {
     page: number;
     page_count: number;
     page_size: number;
@@ -58,10 +61,14 @@ export interface Answer {
     data: AnswerData;
 }
 export interface AnswerQuestionBody {
+    data?: AnswerData;
 }
 export declare type CardItemData = Question;
+export declare enum CardItemType {
+    question = "question"
+}
 export interface CardItem {
-    type: string;
+    type: CardItemType;
     version: string;
     data: CardItemData;
 }
@@ -69,19 +76,21 @@ export interface CardsResponse {
     items: Array<CardItem>;
 }
 export declare enum QuestionType {
-    choice = "choice"
+    choice = "choice",
+    rating = "rating"
 }
 export declare enum QuestionKind {
     radio = "radio",
-    checkbox = "checkbox"
+    checkbox = "checkbox",
+    star = "star"
 }
 export interface CreateChoiceQuestionOption {
-    title?: string;
+    title: string;
     value: string;
     is_other?: boolean | null;
 }
 export interface ChoiceQuestionOption {
-    title?: string;
+    title: string;
     value: string;
     is_other?: boolean | null;
     id: string;
@@ -97,8 +106,8 @@ export declare type QuestionData = ChoiceQuestionBody;
 export interface CreateQuestionRequestBody {
     title: string;
     subtitle?: string | null;
-    type: string;
-    kind: string;
+    type: QuestionType;
+    kind: QuestionKind;
     data: CreateQuestionData;
     active?: boolean;
     expires_at?: string | null;
@@ -109,18 +118,18 @@ export interface Question {
     created_at: string;
     updated_at: string;
     deleted_at?: string | null;
+    tenant_id: string;
     title: string;
     subtitle?: string | null;
-    type: string;
-    kind: string;
-    data: CreateQuestionData;
+    type: QuestionType;
+    kind: QuestionKind;
+    data: QuestionData;
     active?: boolean;
     expires_at?: string | null;
     answer_quota?: number | null;
-    tenant_id: string;
     answer?: Answer;
 }
-export interface QuestionColectionResponse {
+export interface QuestionCollectionResponse {
     page: number;
     page_count: number;
     page_size: number;
@@ -168,7 +177,7 @@ export interface NotificationResponse {
     viewed_at?: string | null;
     version?: string;
 }
-export interface NotificationColectionResponse {
+export interface NotificationCollectionResponse {
     page: number;
     page_count: number;
     page_size: number;
@@ -242,14 +251,23 @@ declare class ParraAPI {
     });
     getTenantById: (tenant_id: string) => Promise<Tenant>;
     createTenantForUserById: (user_id: string, body?: CreateTenantRequestBody | undefined) => Promise<Tenant>;
-    getTenantsForUserById: (user_id: string) => Promise<TenantColectionResponse>;
+    getTenantsForUserById: (user_id: string) => Promise<TenantCollectionResponse>;
     getTenantByUserIdAndTenantId: (user_id: string, tenant_id: string) => Promise<Tenant>;
     createApiKeyForTenantById: (tenant_id: string, body?: CreateApiKeyRequestBody | undefined) => Promise<ApiKeyWithSecretResponse>;
-    getApiKeysForTenantById: (tenant_id: string) => Promise<ApiKeyColectionResponse>;
+    getApiKeysForTenantById: (tenant_id: string) => Promise<ApiKeyCollectionResponse>;
     deleteApiKeyForTenantById: (tenant_id: string, api_key_id: string) => Promise<Response>;
     getTenantForApiKeyById: (api_key_id: string) => Promise<Tenant>;
     getCards: () => Promise<CardsResponse>;
     createQuestion: (body?: CreateQuestionRequestBody | undefined) => Promise<Question>;
+    paginateQuestions: (query?: {
+        $select?: string | undefined;
+        $top?: number | undefined;
+        $skip?: number | undefined;
+        $orderBy?: string | undefined;
+        $filter?: string | undefined;
+        $expand?: string | undefined;
+        $search?: string | undefined;
+    } | undefined) => Promise<QuestionCollectionResponse>;
     getQuestionById: (question_id: string) => Promise<Question>;
     answerQuestionById: (question_id: string, body?: AnswerQuestionBody | undefined) => Promise<Response>;
     createUser: (body: CreateUserRequestBody) => Promise<UserResponse>;

package/dist/ParraAPI.js

@@ -1,14 +1,20 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.QuestionKind = exports.QuestionType = void 0;
+exports.QuestionKind = exports.QuestionType = exports.CardItemType = void 0;
+var CardItemType;
+(function (CardItemType) {
+    CardItemType["question"] = "question";
+})(CardItemType = exports.CardItemType || (exports.CardItemType = {}));
 var QuestionType;
 (function (QuestionType) {
     QuestionType["choice"] = "choice";
+    QuestionType["rating"] = "rating";
 })(QuestionType = exports.QuestionType || (exports.QuestionType = {}));
 var QuestionKind;
 (function (QuestionKind) {
     QuestionKind["radio"] = "radio";
     QuestionKind["checkbox"] = "checkbox";
+    QuestionKind["star"] = "star";
 })(QuestionKind = exports.QuestionKind || (exports.QuestionKind = {}));
 var ParraAPI = /** @class */ (function () {
     function ParraAPI(http, options) {
@@ -77,6 +83,12 @@ var ParraAPI = /** @class */ (function () {
                 },
             });
         };
+        this.paginateQuestions = function (query) {
+            return _this.http.execute(_this.options.baseUrl + "/v1/questions", {
+                method: "get",
+                query: query,
+            });
+        };
         this.getQuestionById = function (question_id) {
             return _this.http.execute(_this.options.baseUrl + "/v1/questions/" + question_id, {
                 method: "get",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@parra/parra-js-sdk",
-  "version": "0.2.10",
+  "version": "0.2.14",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -18,7 +18,6 @@
   "author": "Parra",
   "license": "ISC",
   "devDependencies": {
-    "nyc": "^15.1.0",
     "prettier": "^2.0.5",
     "typescript": "^3.9.7"
   },