@lorikeetai/node-sdk 0.4.1 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (9) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/package.json +1 -1
  3. package/resources/customer.d.ts +37 -9
  4. package/resources/customer.d.ts.map +1 -1
  5. package/src/resources/customer.ts +42 -9
  6. package/src/version.ts +1 -1
  7. package/version.d.ts +1 -1
  8. package/version.js +1 -1
  9. package/version.mjs +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,22 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.6.0 (2024-12-03)
4
+
5
+ Full Changelog: [v0.5.0...v0.6.0](https://github.com/optechai/node-sdk/compare/v0.5.0...v0.6.0)
6
+
7
+ ### Features
8
+
9
+ * **api:** api update ([#103](https://github.com/optechai/node-sdk/issues/103)) ([8d13189](https://github.com/optechai/node-sdk/commit/8d13189d8e121cd012358ad6d91f24113d5ba12e))
10
+ * **internal:** make git install file structure match npm ([#101](https://github.com/optechai/node-sdk/issues/101)) ([3870c33](https://github.com/optechai/node-sdk/commit/3870c334741c6e805070d2c150d14d0351f69537))
11
+
12
+ ## 0.5.0 (2024-11-22)
13
+
14
+ Full Changelog: [v0.4.1...v0.5.0](https://github.com/optechai/node-sdk/compare/v0.4.1...v0.5.0)
15
+
16
+ ### Features
17
+
18
+ * **api:** api update ([#98](https://github.com/optechai/node-sdk/issues/98)) ([860fd1e](https://github.com/optechai/node-sdk/commit/860fd1ec25a9b85f856fe27ba2a704091c6412ab))
19
+
3
20
  ## 0.4.1 (2024-11-20)
4
21
 
5
22
  Full Changelog: [v0.4.0...v0.4.1](https://github.com/optechai/node-sdk/compare/v0.4.0...v0.4.1)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@lorikeetai/node-sdk",
3
- "version": "0.4.1",
3
+ "version": "0.6.0",
4
4
  "description": "The official TypeScript library for the Lorikeet API",
5
5
  "author": "Lorikeet <support@lorikeetcx.ai>",
6
6
  "types": "./index.d.ts",
package/resources/customer.d.ts CHANGED
@@ -9,7 +9,7 @@ export interface CustomerCreateResponse {
9
9
  /**
10
10
  * The id of the customer in the subscriber system
11
11
  */
12
- id: unknown;
12
+ id: string;
13
13
  /**
14
14
  * The timestamp of the when the customer was created in our system
15
15
  */
@@ -27,9 +27,15 @@ export interface CustomerCreateResponse {
27
27
  */
28
28
  lastName: string;
29
29
  /**
30
- * The id of the customer in the subscriber system
30
+ * The id of the customer in the ticketing system. For the SDK this needs to be
31
+ * stable and unique
31
32
  */
32
33
  remoteId: string;
34
+ /**
35
+ * The id of the customer in your own primary database or a unique identifier, for
36
+ * example a cookie
37
+ */
38
+ subscriberCustomerId: string;
33
39
  /**
34
40
  * The display name of the customer
35
41
  */
@@ -39,7 +45,7 @@ export interface CustomerGetResponse {
39
45
  /**
40
46
  * The id of the customer in the subscriber system
41
47
  */
42
- id: unknown;
48
+ id: string;
43
49
  /**
44
50
  * The timestamp of the when the customer was created in our system
45
51
  */
@@ -57,9 +63,15 @@ export interface CustomerGetResponse {
57
63
  */
58
64
  lastName: string;
59
65
  /**
60
- * The id of the customer in the subscriber system
66
+ * The id of the customer in the ticketing system. For the SDK this needs to be
67
+ * stable and unique
61
68
  */
62
69
  remoteId: string;
70
+ /**
71
+ * The id of the customer in your own primary database or a unique identifier, for
72
+ * example a cookie
73
+ */
74
+ subscriberCustomerId: string;
63
75
  /**
64
76
  * The display name of the customer
65
77
  */
@@ -80,9 +92,15 @@ export interface CustomerCreateParams {
80
92
  */
81
93
  lastName: string;
82
94
  /**
83
- * The id of the customer in the subscriber system
95
+ * The id of the customer in the ticketing system. For the SDK this needs to be
96
+ * stable and unique
84
97
  */
85
98
  remoteId: string;
99
+ /**
100
+ * The id of the customer in your own primary database or a unique identifier, for
101
+ * example a cookie
102
+ */
103
+ subscriberCustomerId: string;
86
104
  /**
87
105
  * The display name of the customer
88
106
  */
@@ -90,21 +108,31 @@ export interface CustomerCreateParams {
90
108
  }
91
109
  export interface CustomerTokenParams {
92
110
  /**
93
- * The email of the user.
111
+ * The email of the customer
94
112
  */
95
113
  email: string;
96
114
  /**
97
- * The first name of the user.
115
+ * The first name of the customer
98
116
  */
99
117
  firstName: string;
100
118
  /**
101
- * The last name of the user.
119
+ * The last name of the customer
102
120
  */
103
121
  lastName: string;
104
122
  /**
105
- * The unique identifier of the user in your ticketing system.
123
+ * The id of the customer in the ticketing system. For the SDK this needs to be
124
+ * stable and unique
106
125
  */
107
126
  remoteId: string;
127
+ /**
128
+ * The id of the customer in your own primary database or a unique identifier, for
129
+ * example a cookie
130
+ */
131
+ subscriberCustomerId: string;
132
+ /**
133
+ * The display name of the customer
134
+ */
135
+ displayName?: string;
108
136
  }
109
137
  export declare namespace Customer {
110
138
  export { type CustomerCreateResponse as CustomerCreateResponse, type CustomerGetResponse as CustomerGetResponse, type CustomerTokenResponse as CustomerTokenResponse, type CustomerCreateParams as CustomerCreateParams, type CustomerTokenParams as CustomerTokenParams, };
package/resources/customer.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"customer.d.ts","sourceRoot":"","sources":["../src/resources/customer.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,QAAS,SAAQ,WAAW;IACvC,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAI1G,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAIpF,KAAK,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;CAOzF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,OAAO,CAAC;IAEZ;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,OAAO,CAAC;IAEZ;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC;AAE3C,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
1
+ {"version":3,"file":"customer.d.ts","sourceRoot":"","sources":["../src/resources/customer.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,IAAI,MAAM,SAAS,CAAC;AAEhC,qBAAa,QAAS,SAAQ,WAAW;IACvC,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,sBAAsB,CAAC;IAI1G,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,mBAAmB,CAAC;IAIpF,KAAK,CAAC,IAAI,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;CAOzF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,qBAAqB,GAAG,MAAM,CAAC;AAE3C,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,QAAQ,CAAC;IAChC,OAAO,EACL,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,mBAAmB,IAAI,mBAAmB,GAChD,CAAC;CACH"}
package/src/resources/customer.ts CHANGED
@@ -25,7 +25,7 @@ export interface CustomerCreateResponse {
25
25
  /**
26
26
  * The id of the customer in the subscriber system
27
27
  */
28
- id: unknown;
28
+ id: string;
29
29
 
30
30
  /**
31
31
  * The timestamp of the when the customer was created in our system
@@ -48,10 +48,17 @@ export interface CustomerCreateResponse {
48
48
  lastName: string;
49
49
 
50
50
  /**
51
- * The id of the customer in the subscriber system
51
+ * The id of the customer in the ticketing system. For the SDK this needs to be
52
+ * stable and unique
52
53
  */
53
54
  remoteId: string;
54
55
 
56
+ /**
57
+ * The id of the customer in your own primary database or a unique identifier, for
58
+ * example a cookie
59
+ */
60
+ subscriberCustomerId: string;
61
+
55
62
  /**
56
63
  * The display name of the customer
57
64
  */
@@ -62,7 +69,7 @@ export interface CustomerGetResponse {
62
69
  /**
63
70
  * The id of the customer in the subscriber system
64
71
  */
65
- id: unknown;
72
+ id: string;
66
73
 
67
74
  /**
68
75
  * The timestamp of the when the customer was created in our system
@@ -85,10 +92,17 @@ export interface CustomerGetResponse {
85
92
  lastName: string;
86
93
 
87
94
  /**
88
- * The id of the customer in the subscriber system
95
+ * The id of the customer in the ticketing system. For the SDK this needs to be
96
+ * stable and unique
89
97
  */
90
98
  remoteId: string;
91
99
 
100
+ /**
101
+ * The id of the customer in your own primary database or a unique identifier, for
102
+ * example a cookie
103
+ */
104
+ subscriberCustomerId: string;
105
+
92
106
  /**
93
107
  * The display name of the customer
94
108
  */
@@ -114,10 +128,17 @@ export interface CustomerCreateParams {
114
128
  lastName: string;
115
129
 
116
130
  /**
117
- * The id of the customer in the subscriber system
131
+ * The id of the customer in the ticketing system. For the SDK this needs to be
132
+ * stable and unique
118
133
  */
119
134
  remoteId: string;
120
135
 
136
+ /**
137
+ * The id of the customer in your own primary database or a unique identifier, for
138
+ * example a cookie
139
+ */
140
+ subscriberCustomerId: string;
141
+
121
142
  /**
122
143
  * The display name of the customer
123
144
  */
@@ -126,24 +147,36 @@ export interface CustomerCreateParams {
126
147
 
127
148
  export interface CustomerTokenParams {
128
149
  /**
129
- * The email of the user.
150
+ * The email of the customer
130
151
  */
131
152
  email: string;
132
153
 
133
154
  /**
134
- * The first name of the user.
155
+ * The first name of the customer
135
156
  */
136
157
  firstName: string;
137
158
 
138
159
  /**
139
- * The last name of the user.
160
+ * The last name of the customer
140
161
  */
141
162
  lastName: string;
142
163
 
143
164
  /**
144
- * The unique identifier of the user in your ticketing system.
165
+ * The id of the customer in the ticketing system. For the SDK this needs to be
166
+ * stable and unique
145
167
  */
146
168
  remoteId: string;
169
+
170
+ /**
171
+ * The id of the customer in your own primary database or a unique identifier, for
172
+ * example a cookie
173
+ */
174
+ subscriberCustomerId: string;
175
+
176
+ /**
177
+ * The display name of the customer
178
+ */
179
+ displayName?: string;
147
180
  }
148
181
 
149
182
  export declare namespace Customer {
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.4.1'; // x-release-please-version
1
+ export const VERSION = '0.6.0'; // x-release-please-version
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.4.1";
1
+ export declare const VERSION = "0.6.0";
2
2
  //# sourceMappingURL=version.d.ts.map
package/version.js CHANGED
@@ -1,5 +1,5 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.VERSION = void 0;
4
- exports.VERSION = '0.4.1'; // x-release-please-version
4
+ exports.VERSION = '0.6.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.4.1'; // x-release-please-version
1
+ export const VERSION = '0.6.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map