@or-sdk/tickets 1.0.1-324.0 → 1.0.1-327.0

package/dist/cjs/Tickets.js

@@ -75,6 +75,17 @@ var Tickets = (function (_super) {
             });
         });
     };
+    Tickets.prototype.getTypes = function (query) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2, this.callApi({
+                        method: 'get',
+                        route: '/types',
+                        params: query,
+                    })];
+            });
+        });
+    };
     Tickets.prototype.updateType = function (id, data) {
         return __awaiter(this, void 0, void 0, function () {
             return __generator(this, function (_a) {
@@ -86,6 +97,17 @@ var Tickets = (function (_super) {
             });
         });
     };
+    Tickets.prototype.deleteType = function (data) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                return [2, this.callApi({
+                        method: 'delete',
+                        route: '/types',
+                        data: data,
+                    })];
+            });
+        });
+    };
     return Tickets;
 }(base_1.Base));
 exports.Tickets = Tickets;

package/dist/cjs/Tickets.js.map

@@ -1 +1 @@
-{"version":3,"file":"Tickets.js","sourceRoot":"","sources":["../../src/Tickets.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAoC;AAEpC,yCAA0C;AAS1C;IAA6B,2BAAI;IAO/B,iBAAY,MAAqB;QACvB,IAAA,KAAK,GAAiB,MAAM,MAAvB,EAAE,UAAU,GAAK,MAAM,WAAX,CAAY;eAErC,kBAAM;YACJ,KAAK,OAAA;YACL,UAAU,YAAA;YACV,UAAU,EAAE,uBAAW;SACxB,CAAC;IACJ,CAAC;IAEK,4BAAU,GAAhB,UAAiB,IAAuB;;;gBACtC,WAAO,IAAI,CAAC,OAAO,CAAC;wBAClB,MAAM,EAAE,MAAM;wBACd,KAAK,EAAE,QAAQ;wBACf,IAAI,MAAA;qBACL,CAAC,EAAC;;;KACJ;IAEK,4BAAU,GAAhB,UAAiB,EAAU,EAAE,IAAuB;;;gBAClD,WAAO,IAAI,CAAC,OAAO,CAAC;wBAClB,MAAM,EAAE,KAAK;wBACb,KAAK,EAAE,iBAAU,EAAE,CAAE;wBACrB,IAAI,MAAA;qBACL,CAAC,EAAC;;;KACJ;IACH,cAAC;AAAD,CAAC,AAhCD,CAA6B,WAAI,GAgChC;AAhCY,0BAAO"}
+{"version":3,"file":"Tickets.js","sourceRoot":"","sources":["../../src/Tickets.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,qCAAoC;AASpC,yCAA0C;AAS1C;IAA6B,2BAAI;IAO/B,iBAAY,MAAqB;QACvB,IAAA,KAAK,GAAiB,MAAM,MAAvB,EAAE,UAAU,GAAK,MAAM,WAAX,CAAY;eAErC,kBAAM;YACJ,KAAK,OAAA;YACL,UAAU,YAAA;YACV,UAAU,EAAE,uBAAW;SACxB,CAAC;IACJ,CAAC;IAOK,4BAAU,GAAhB,UAAiB,IAAuB;;;gBACtC,WAAO,IAAI,CAAC,OAAO,CAAC;wBAClB,MAAM,EAAE,MAAM;wBACd,KAAK,EAAE,QAAQ;wBACf,IAAI,MAAA;qBACL,CAAC,EAAC;;;KACJ;IAOK,0BAAQ,GAAd,UAAe,KAAuB;;;gBACpC,WAAO,IAAI,CAAC,OAAO,CAAC;wBAClB,MAAM,EAAE,KAAK;wBACb,KAAK,EAAE,QAAQ;wBACf,MAAM,EAAE,KAAK;qBACd,CAAC,EAAC;;;KACJ;IAQK,4BAAU,GAAhB,UAAiB,EAAU,EAAE,IAAuB;;;gBAClD,WAAO,IAAI,CAAC,OAAO,CAAC;wBAClB,MAAM,EAAE,KAAK;wBACb,KAAK,EAAE,iBAAU,EAAE,CAAE;wBACrB,IAAI,MAAA;qBACL,CAAC,EAAC;;;KACJ;IAOK,4BAAU,GAAhB,UAAiB,IAAuB;;;gBACtC,WAAO,IAAI,CAAC,OAAO,CAAC;wBAClB,MAAM,EAAE,QAAQ;wBAChB,KAAK,EAAE,QAAQ;wBACf,IAAI,MAAA;qBACL,CAAC,EAAC;;;KACJ;IACH,cAAC;AAAD,CAAC,AArED,CAA6B,WAAI,GAqEhC;AArEY,0BAAO"}

package/dist/esm/Tickets.js

@@ -27,6 +27,15 @@ export class Tickets extends Base {
             });
         });
     }
+    getTypes(query) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.callApi({
+                method: 'get',
+                route: '/types',
+                params: query,
+            });
+        });
+    }
     updateType(id, data) {
         return __awaiter(this, void 0, void 0, function* () {
             return this.callApi({
@@ -36,5 +45,14 @@ export class Tickets extends Base {
             });
         });
     }
+    deleteType(data) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return this.callApi({
+                method: 'delete',
+                route: '/types',
+                data,
+            });
+        });
+    }
 }
 //# sourceMappingURL=Tickets.js.map

package/dist/esm/Tickets.js.map

@@ -1 +1 @@
-{"version":3,"file":"Tickets.js","sourceRoot":"","sources":["../../src/Tickets.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAEpC,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAS1C,MAAM,OAAO,OAAQ,SAAQ,IAAI;IAO/B,YAAY,MAAqB;QAC/B,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAErC,KAAK,CAAC;YACJ,KAAK;YACL,UAAU;YACV,UAAU,EAAE,WAAW;SACxB,CAAC,CAAC;IACL,CAAC;IAEK,UAAU,CAAC,IAAuB;;YACtC,OAAO,IAAI,CAAC,OAAO,CAAC;gBAClB,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE,QAAQ;gBACf,IAAI;aACL,CAAC,CAAC;QACL,CAAC;KAAA;IAEK,UAAU,CAAC,EAAU,EAAE,IAAuB;;YAClD,OAAO,IAAI,CAAC,OAAO,CAAC;gBAClB,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,UAAU,EAAE,EAAE;gBACrB,IAAI;aACL,CAAC,CAAC;QACL,CAAC;KAAA;CACF"}
+{"version":3,"file":"Tickets.js","sourceRoot":"","sources":["../../src/Tickets.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AASpC,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAS1C,MAAM,OAAO,OAAQ,SAAQ,IAAI;IAO/B,YAAY,MAAqB;QAC/B,MAAM,EAAE,KAAK,EAAE,UAAU,EAAE,GAAG,MAAM,CAAC;QAErC,KAAK,CAAC;YACJ,KAAK;YACL,UAAU;YACV,UAAU,EAAE,WAAW;SACxB,CAAC,CAAC;IACL,CAAC;IAOK,UAAU,CAAC,IAAuB;;YACtC,OAAO,IAAI,CAAC,OAAO,CAAC;gBAClB,MAAM,EAAE,MAAM;gBACd,KAAK,EAAE,QAAQ;gBACf,IAAI;aACL,CAAC,CAAC;QACL,CAAC;KAAA;IAOK,QAAQ,CAAC,KAAuB;;YACpC,OAAO,IAAI,CAAC,OAAO,CAAC;gBAClB,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,QAAQ;gBACf,MAAM,EAAE,KAAK;aACd,CAAC,CAAC;QACL,CAAC;KAAA;IAQK,UAAU,CAAC,EAAU,EAAE,IAAuB;;YAClD,OAAO,IAAI,CAAC,OAAO,CAAC;gBAClB,MAAM,EAAE,KAAK;gBACb,KAAK,EAAE,UAAU,EAAE,EAAE;gBACrB,IAAI;aACL,CAAC,CAAC;QACL,CAAC;KAAA;IAOK,UAAU,CAAC,IAAuB;;YACtC,OAAO,IAAI,CAAC,OAAO,CAAC;gBAClB,MAAM,EAAE,QAAQ;gBAChB,KAAK,EAAE,QAAQ;gBACf,IAAI;aACL,CAAC,CAAC;QACL,CAAC;KAAA;CACF"}

package/dist/types/Tickets.d.ts

@@ -1,7 +1,9 @@
 import { Base } from '@or-sdk/base';
-import { CreateTypeOptions, TicketsConfig, UpdateTypeOptions } from './types';
+import { CreateTypeOptions, FindTypesOptions, TicketsConfig, UpdateTypeOptions, TypeRecordEntity, EntitiesListResponse, DeleteTypeOptions } from './types';
 export declare class Tickets extends Base {
     constructor(params: TicketsConfig);
-    createType(data: CreateTypeOptions): Promise<unknown>;
-    updateType(id: string, data: UpdateTypeOptions): Promise<unknown>;
+    createType(data: CreateTypeOptions): Promise<TypeRecordEntity>;
+    getTypes(query: FindTypesOptions): Promise<EntitiesListResponse<TypeRecordEntity>>;
+    updateType(id: string, data: UpdateTypeOptions): Promise<TypeRecordEntity>;
+    deleteType(data: DeleteTypeOptions): Promise<TypeRecordEntity>;
 }

package/dist/types/types.d.ts

@@ -3,6 +3,27 @@ export declare type TicketsConfig = {
     token: Token;
     serviceUrl?: string;
 };
+declare type CreatedBy = {
+    accountId: string;
+    userId?: string;
+    flowId?: string;
+};
+export interface EntitiesListResponse<R extends Record<string, any> = Record<string, any>> {
+    total: number;
+    hits: R[];
+}
+export interface TypeRecordEntity {
+    id: string;
+    accountId: string;
+    label: string;
+    settings: Record<string, any>;
+    initialData: Record<string, any>;
+    createdBy: CreatedBy;
+    dateCreated: Date;
+    dateModified: Date;
+    meta?: Record<string, any>;
+    _isDeleted: boolean;
+}
 export declare type CreateLabelOptions = {
     label: string;
     color: string;
@@ -15,10 +36,23 @@ export declare type CreateTypeOptions = {
     initialData: Record<string, any>;
     systemLabels?: Pick<CreateLabelOptions, 'label' | 'color'>[];
 };
-export interface UpdateTypeOptions {
+export declare type UpdateTypeOptions = {
     label?: string;
     settings?: Record<string, any>;
     initialData?: Record<string, any>;
     meta?: Record<string, any>;
     _isDeleted?: boolean;
-}
+};
+export declare type DeleteTypeOptions = {
+    id: string;
+};
+export declare type FindTypesOptions = {
+    accountId?: string | string[];
+    projection?: string[];
+    from?: number;
+    size?: number;
+    orderBy?: string;
+    sortOrder?: string;
+    label?: string;
+};
+export {};

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.0.1-324.0",
+  "version": "1.0.1-327.0",
   "name": "@or-sdk/tickets",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",

package/src/Tickets.ts

@@ -1,5 +1,12 @@
 import { Base } from '@or-sdk/base';
-import { CreateTypeOptions, TicketsConfig, UpdateTypeOptions } from './types';
+import {
+  CreateTypeOptions,
+  FindTypesOptions,
+  TicketsConfig,
+  UpdateTypeOptions,
+  TypeRecordEntity,
+  EntitiesListResponse, DeleteTypeOptions,
+} from './types';
 import { SERVICE_KEY } from './constants';
 
 /**
@@ -26,7 +33,12 @@ export class Tickets extends Base {
     });
   }
 
-  async createType(data: CreateTypeOptions) {
+  /**
+   * Create a Type
+   * @param data has CreateTypeOptions values inside
+   * @return Type Entity
+   */
+  async createType(data: CreateTypeOptions): Promise<TypeRecordEntity> {
     return this.callApi({
       method: 'post',
       route: '/types',
@@ -34,11 +46,43 @@ export class Tickets extends Base {
     });
   }
 
-  async updateType(id: string, data: UpdateTypeOptions) {
+  /**
+   * Get the list of available Types
+   * @param query has FindTypesOptions values inside
+   * @return Type Entity
+   */
+  async getTypes(query: FindTypesOptions): Promise<EntitiesListResponse<TypeRecordEntity>> {
+    return this.callApi({
+      method: 'get',
+      route: '/types',
+      params: query,
+    });
+  }
+
+  /**
+   * Update the Type by provided id
+   * @param id string;
+   * @param data has UpdateTypeOptions values inside
+   * @return Type Entity
+   */
+  async updateType(id: string, data: UpdateTypeOptions): Promise<TypeRecordEntity> {
     return this.callApi({
       method: 'put',
       route: `/types/${id}`,
       data,
     });
   }
+
+  /**
+   * Delete the Type by provided id
+   * @param data has DeleteTypeOptions values inside
+   * @return Type Entity
+   */
+  async deleteType(data: DeleteTypeOptions): Promise<TypeRecordEntity> {
+    return this.callApi({
+      method: 'delete',
+      route: '/types',
+      data,
+    });
+  }
 }

package/src/types.ts

@@ -1,16 +1,33 @@
 import { Token } from '@or-sdk/base';
 
 export type TicketsConfig = {
-  /**
-   * token
-   */
   token: Token;
-  /**
-   * Direct service url, can be used to avoid discovery api call
-   */
   serviceUrl?: string;
 };
 
+type CreatedBy = {
+  accountId: string;
+  userId?: string;
+  flowId?: string;
+};
+
+export interface EntitiesListResponse<R extends Record<string, any> = Record<string, any>> {
+  total: number;
+  hits: R[];
+}
+
+export interface TypeRecordEntity {
+  id: string;
+  accountId: string;
+  label: string;
+  settings: Record<string, any>;
+  initialData: Record<string, any>;
+  createdBy: CreatedBy;
+  dateCreated: Date;
+  dateModified: Date;
+  meta?: Record<string, any>;
+  _isDeleted: boolean;
+}
 
 export type CreateLabelOptions = {
   label: string;
@@ -26,10 +43,24 @@ export type CreateTypeOptions = {
   systemLabels?: Pick<CreateLabelOptions, 'label' | 'color'>[];
 };
 
-export interface UpdateTypeOptions {
+export type UpdateTypeOptions = {
   label?: string;
   settings?: Record<string, any>;
   initialData?: Record<string, any>;
   meta?: Record<string, any>;
   _isDeleted?: boolean;
-}
+};
+
+export type DeleteTypeOptions = {
+  id: string;
+};
+
+export type FindTypesOptions = {
+  accountId?: string | string[];
+  projection?: string[];
+  from?: number;
+  size?: number;
+  orderBy?: string;
+  sortOrder?: string;
+  label?: string;
+};