zorihq 0.5.0 → 0.7.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 (57) hide show
  1. package/CHANGELOG.md +16 -0
  2. package/package.json +1 -1
  3. package/resources/v1/analytics/analytics.d.mts +35 -3
  4. package/resources/v1/analytics/analytics.d.mts.map +1 -1
  5. package/resources/v1/analytics/analytics.d.ts +35 -3
  6. package/resources/v1/analytics/analytics.d.ts.map +1 -1
  7. package/resources/v1/analytics/analytics.js.map +1 -1
  8. package/resources/v1/analytics/analytics.mjs.map +1 -1
  9. package/resources/v1/analytics/index.d.mts +2 -2
  10. package/resources/v1/analytics/index.d.mts.map +1 -1
  11. package/resources/v1/analytics/index.d.ts +2 -2
  12. package/resources/v1/analytics/index.d.ts.map +1 -1
  13. package/resources/v1/analytics/index.js.map +1 -1
  14. package/resources/v1/analytics/index.mjs.map +1 -1
  15. package/resources/v1/analytics/visitors.d.mts +27 -1
  16. package/resources/v1/analytics/visitors.d.mts.map +1 -1
  17. package/resources/v1/analytics/visitors.d.ts +27 -1
  18. package/resources/v1/analytics/visitors.d.ts.map +1 -1
  19. package/resources/v1/analytics/visitors.js +16 -0
  20. package/resources/v1/analytics/visitors.js.map +1 -1
  21. package/resources/v1/analytics/visitors.mjs +16 -0
  22. package/resources/v1/analytics/visitors.mjs.map +1 -1
  23. package/resources/v1/index.d.mts +2 -1
  24. package/resources/v1/index.d.mts.map +1 -1
  25. package/resources/v1/index.d.ts +2 -1
  26. package/resources/v1/index.d.ts.map +1 -1
  27. package/resources/v1/index.js +3 -1
  28. package/resources/v1/index.js.map +1 -1
  29. package/resources/v1/index.mjs +1 -0
  30. package/resources/v1/index.mjs.map +1 -1
  31. package/resources/v1/payment-providers.d.mts +109 -0
  32. package/resources/v1/payment-providers.d.mts.map +1 -0
  33. package/resources/v1/payment-providers.d.ts +109 -0
  34. package/resources/v1/payment-providers.d.ts.map +1 -0
  35. package/resources/v1/payment-providers.js +75 -0
  36. package/resources/v1/payment-providers.js.map +1 -0
  37. package/resources/v1/payment-providers.mjs +71 -0
  38. package/resources/v1/payment-providers.mjs.map +1 -0
  39. package/resources/v1/v1.d.mts +6 -2
  40. package/resources/v1/v1.d.mts.map +1 -1
  41. package/resources/v1/v1.d.ts +6 -2
  42. package/resources/v1/v1.d.ts.map +1 -1
  43. package/resources/v1/v1.js +4 -0
  44. package/resources/v1/v1.js.map +1 -1
  45. package/resources/v1/v1.mjs +4 -0
  46. package/resources/v1/v1.mjs.map +1 -1
  47. package/src/resources/v1/analytics/analytics.ts +56 -0
  48. package/src/resources/v1/analytics/index.ts +3 -0
  49. package/src/resources/v1/analytics/visitors.ts +39 -0
  50. package/src/resources/v1/index.ts +13 -0
  51. package/src/resources/v1/payment-providers.ts +167 -0
  52. package/src/resources/v1/v1.ts +32 -0
  53. package/src/version.ts +1 -1
  54. package/version.d.mts +1 -1
  55. package/version.d.ts +1 -1
  56. package/version.js +1 -1
  57. package/version.mjs +1 -1
@@ -19,6 +19,7 @@ import {
19
19
  VisitorByCountryParams,
20
20
  VisitorByDeviceParams,
21
21
  VisitorByOriginParams,
22
+ VisitorIdentifyParams,
22
23
  VisitorProfileParams,
23
24
  VisitorTimelineParams,
24
25
  VisitorTopParams,
@@ -156,6 +157,32 @@ export interface EventsOverTimeDataPoint {
156
157
  timestamp?: string;
157
158
  }
158
159
 
160
+ export interface ManualIdentifyRequest {
161
+ project_id: string;
162
+
163
+ visitor_id: string;
164
+
165
+ additional_properties?: { [key: string]: unknown };
166
+
167
+ email?: string;
168
+
169
+ external_id?: string;
170
+
171
+ name?: string;
172
+
173
+ phone?: string;
174
+
175
+ user_id?: string;
176
+ }
177
+
178
+ export interface ManualIdentifyResponse {
179
+ message?: string;
180
+
181
+ success?: boolean;
182
+
183
+ visitor_id?: string;
184
+ }
185
+
159
186
  export interface OriginDataPoint {
160
187
  origin?: string;
161
188
 
@@ -173,6 +200,8 @@ export interface RecentEvent {
173
200
 
174
201
  event_name?: string;
175
202
 
203
+ external_id?: string;
204
+
176
205
  location_city?: string;
177
206
 
178
207
  location_country_iso?: string;
@@ -183,6 +212,8 @@ export interface RecentEvent {
183
212
 
184
213
  referrer_url?: string;
185
214
 
215
+ user_id?: string;
216
+
186
217
  visitor_id?: string;
187
218
  }
188
219
 
@@ -217,6 +248,8 @@ export interface TopVisitor {
217
248
 
218
249
  event_count?: number;
219
250
 
251
+ external_id?: string;
252
+
220
253
  first_seen?: string;
221
254
 
222
255
  last_seen?: string;
@@ -225,6 +258,8 @@ export interface TopVisitor {
225
258
 
226
259
  location_country_iso?: string;
227
260
 
261
+ user_id?: string;
262
+
228
263
  visitor_id?: string;
229
264
  }
230
265
 
@@ -273,24 +308,42 @@ export interface VisitorEvent {
273
308
  }
274
309
 
275
310
  export interface VisitorProfileResponse {
311
+ custom_traits?: { [key: string]: unknown };
312
+
313
+ email?: string;
314
+
276
315
  events?: Array<VisitorEvent>;
277
316
 
278
317
  events_over_time?: Array<EventsOverTimeDataPoint>;
279
318
 
319
+ external_id?: string;
320
+
321
+ first_identified_at?: string;
322
+
280
323
  first_referrer_url?: string;
281
324
 
282
325
  first_seen?: string;
283
326
 
284
327
  first_traffic_origin?: string;
285
328
 
329
+ is_identified?: boolean;
330
+
331
+ last_identified_at?: string;
332
+
286
333
  last_seen?: string;
287
334
 
288
335
  location_city?: string;
289
336
 
290
337
  location_country_iso?: string;
291
338
 
339
+ name?: string;
340
+
341
+ phone?: string;
342
+
292
343
  total_events?: number;
293
344
 
345
+ user_id?: string;
346
+
294
347
  visitor_id?: string;
295
348
  }
296
349
 
@@ -335,6 +388,8 @@ export declare namespace Analytics {
335
388
  type CountryDataPoint as CountryDataPoint,
336
389
  type DashboardMetricsResponse as DashboardMetricsResponse,
337
390
  type EventsOverTimeDataPoint as EventsOverTimeDataPoint,
391
+ type ManualIdentifyRequest as ManualIdentifyRequest,
392
+ type ManualIdentifyResponse as ManualIdentifyResponse,
338
393
  type OriginDataPoint as OriginDataPoint,
339
394
  type RecentEvent as RecentEvent,
340
395
  type RecentEventsResponse as RecentEventsResponse,
@@ -358,6 +413,7 @@ export declare namespace Analytics {
358
413
  type VisitorByCountryParams as VisitorByCountryParams,
359
414
  type VisitorByDeviceParams as VisitorByDeviceParams,
360
415
  type VisitorByOriginParams as VisitorByOriginParams,
416
+ type VisitorIdentifyParams as VisitorIdentifyParams,
361
417
  type VisitorProfileParams as VisitorProfileParams,
362
418
  type VisitorTimelineParams as VisitorTimelineParams,
363
419
  type VisitorTopParams as VisitorTopParams,
@@ -11,6 +11,8 @@ export {
11
11
  type CountryDataPoint,
12
12
  type DashboardMetricsResponse,
13
13
  type EventsOverTimeDataPoint,
14
+ type ManualIdentifyRequest,
15
+ type ManualIdentifyResponse,
14
16
  type OriginDataPoint,
15
17
  type RecentEvent,
16
18
  type RecentEventsResponse,
@@ -42,6 +44,7 @@ export {
42
44
  type VisitorByCountryParams,
43
45
  type VisitorByDeviceParams,
44
46
  type VisitorByOriginParams,
47
+ type VisitorIdentifyParams,
45
48
  type VisitorProfileParams,
46
49
  type VisitorTimelineParams,
47
50
  type VisitorTopParams,
@@ -64,6 +64,26 @@ export class Visitors extends APIResource {
64
64
  return this._client.get('/api/v1/analytics/visitors/origin', { query, ...options });
65
65
  }
66
66
 
67
+ /**
68
+ * Manually identify a visitor by updating their profile information from the
69
+ * dashboard
70
+ *
71
+ * @example
72
+ * ```ts
73
+ * const manualIdentifyResponse =
74
+ * await client.v1.analytics.visitors.identify({
75
+ * project_id: 'project_id',
76
+ * visitor_id: 'visitor_id',
77
+ * });
78
+ * ```
79
+ */
80
+ identify(
81
+ body: VisitorIdentifyParams,
82
+ options?: RequestOptions,
83
+ ): APIPromise<AnalyticsAPI.ManualIdentifyResponse> {
84
+ return this._client.post('/api/v1/analytics/visitors/identify', { body, ...options });
85
+ }
86
+
67
87
  /**
68
88
  * Get detailed information about a specific visitor including their event history
69
89
  * and aggregated statistics
@@ -157,6 +177,24 @@ export interface VisitorByOriginParams {
157
177
  time_range: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
158
178
  }
159
179
 
180
+ export interface VisitorIdentifyParams {
181
+ project_id: string;
182
+
183
+ visitor_id: string;
184
+
185
+ additional_properties?: { [key: string]: unknown };
186
+
187
+ email?: string;
188
+
189
+ external_id?: string;
190
+
191
+ name?: string;
192
+
193
+ phone?: string;
194
+
195
+ user_id?: string;
196
+ }
197
+
160
198
  export interface VisitorProfileParams {
161
199
  /**
162
200
  * Project ID
@@ -203,6 +241,7 @@ export declare namespace Visitors {
203
241
  type VisitorByCountryParams as VisitorByCountryParams,
204
242
  type VisitorByDeviceParams as VisitorByDeviceParams,
205
243
  type VisitorByOriginParams as VisitorByOriginParams,
244
+ type VisitorIdentifyParams as VisitorIdentifyParams,
206
245
  type VisitorProfileParams as VisitorProfileParams,
207
246
  type VisitorTimelineParams as VisitorTimelineParams,
208
247
  type VisitorTopParams as VisitorTopParams,
@@ -11,6 +11,8 @@ export {
11
11
  type CountryDataPoint,
12
12
  type DashboardMetricsResponse,
13
13
  type EventsOverTimeDataPoint,
14
+ type ManualIdentifyRequest,
15
+ type ManualIdentifyResponse,
14
16
  type OriginDataPoint,
15
17
  type RecentEvent,
16
18
  type RecentEventsResponse,
@@ -41,6 +43,17 @@ export {
41
43
  type AuthRegisterAccountParams,
42
44
  type AuthRequestPasswordRecoveryParams,
43
45
  } from './auth';
46
+ export {
47
+ PaymentProviders,
48
+ type CreatePaymentProviderRequest,
49
+ type ListPaymentProvidersResponse,
50
+ type PaymentProviderResponse,
51
+ type UpdatePaymentProviderRequest,
52
+ type PaymentProviderDeleteResponse,
53
+ type PaymentProviderCreateParams,
54
+ type PaymentProviderUpdateParams,
55
+ type PaymentProviderListParams,
56
+ } from './payment-providers';
44
57
  export {
45
58
  Projects,
46
59
  type CreateProjectRequest,
@@ -0,0 +1,167 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import { APIResource } from '../../core/resource';
4
+ import { APIPromise } from '../../core/api-promise';
5
+ import { RequestOptions } from '../../internal/request-options';
6
+ import { path } from '../../internal/utils/path';
7
+
8
+ export class PaymentProviders extends APIResource {
9
+ /**
10
+ * Connect a new payment provider to a project
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const paymentProviderResponse =
15
+ * await client.v1.paymentProviders.create({
16
+ * api_key: 'sk_test_xxxxx',
17
+ * project_id: '550e8400-e29b-41d4-a716-446655440000',
18
+ * provider_type: 'stripe',
19
+ * webhook_secret: 'whsec_xxxxx',
20
+ * });
21
+ * ```
22
+ */
23
+ create(body: PaymentProviderCreateParams, options?: RequestOptions): APIPromise<PaymentProviderResponse> {
24
+ return this._client.post('/api/v1/payment-providers', { body, ...options });
25
+ }
26
+
27
+ /**
28
+ * Update payment provider credentials or settings
29
+ *
30
+ * @example
31
+ * ```ts
32
+ * const paymentProviderResponse =
33
+ * await client.v1.paymentProviders.update('id');
34
+ * ```
35
+ */
36
+ update(
37
+ id: string,
38
+ body: PaymentProviderUpdateParams,
39
+ options?: RequestOptions,
40
+ ): APIPromise<PaymentProviderResponse> {
41
+ return this._client.put(path`/api/v1/payment-providers/${id}`, { body, ...options });
42
+ }
43
+
44
+ /**
45
+ * Get all payment providers for the organization
46
+ *
47
+ * @example
48
+ * ```ts
49
+ * const listPaymentProvidersResponse =
50
+ * await client.v1.paymentProviders.list();
51
+ * ```
52
+ */
53
+ list(
54
+ query: PaymentProviderListParams | null | undefined = {},
55
+ options?: RequestOptions,
56
+ ): APIPromise<ListPaymentProvidersResponse> {
57
+ return this._client.get('/api/v1/payment-providers', { query, ...options });
58
+ }
59
+
60
+ /**
61
+ * Disconnect a payment provider from a project
62
+ *
63
+ * @example
64
+ * ```ts
65
+ * const paymentProvider =
66
+ * await client.v1.paymentProviders.delete('id');
67
+ * ```
68
+ */
69
+ delete(id: string, options?: RequestOptions): APIPromise<PaymentProviderDeleteResponse> {
70
+ return this._client.delete(path`/api/v1/payment-providers/${id}`, options);
71
+ }
72
+
73
+ /**
74
+ * Get a single payment provider by ID
75
+ *
76
+ * @example
77
+ * ```ts
78
+ * const paymentProviderResponse =
79
+ * await client.v1.paymentProviders.get('id');
80
+ * ```
81
+ */
82
+ get(id: string, options?: RequestOptions): APIPromise<PaymentProviderResponse> {
83
+ return this._client.get(path`/api/v1/payment-providers/${id}`, options);
84
+ }
85
+ }
86
+
87
+ export interface CreatePaymentProviderRequest {
88
+ api_key: string;
89
+
90
+ project_id: string;
91
+
92
+ provider_type: 'stripe' | 'paddle' | 'paypal' | 'lemon_squeezy' | 'square';
93
+
94
+ webhook_secret: string;
95
+ }
96
+
97
+ export interface ListPaymentProvidersResponse {
98
+ providers?: Array<PaymentProviderResponse>;
99
+
100
+ total?: number;
101
+ }
102
+
103
+ export interface PaymentProviderResponse {
104
+ id?: string;
105
+
106
+ created_at?: string;
107
+
108
+ is_active?: boolean;
109
+
110
+ last_synced_at?: string;
111
+
112
+ organization_id?: string;
113
+
114
+ project_id?: string;
115
+
116
+ provider_type?: 'stripe' | 'paddle' | 'paypal' | 'lemon_squeezy' | 'square';
117
+
118
+ updated_at?: string;
119
+ }
120
+
121
+ export interface UpdatePaymentProviderRequest {
122
+ api_key?: string;
123
+
124
+ is_active?: boolean;
125
+
126
+ webhook_secret?: string;
127
+ }
128
+
129
+ export type PaymentProviderDeleteResponse = { [key: string]: string };
130
+
131
+ export interface PaymentProviderCreateParams {
132
+ api_key: string;
133
+
134
+ project_id: string;
135
+
136
+ provider_type: 'stripe' | 'paddle' | 'paypal' | 'lemon_squeezy' | 'square';
137
+
138
+ webhook_secret: string;
139
+ }
140
+
141
+ export interface PaymentProviderUpdateParams {
142
+ api_key?: string;
143
+
144
+ is_active?: boolean;
145
+
146
+ webhook_secret?: string;
147
+ }
148
+
149
+ export interface PaymentProviderListParams {
150
+ /**
151
+ * Filter by project ID
152
+ */
153
+ project_id?: string;
154
+ }
155
+
156
+ export declare namespace PaymentProviders {
157
+ export {
158
+ type CreatePaymentProviderRequest as CreatePaymentProviderRequest,
159
+ type ListPaymentProvidersResponse as ListPaymentProvidersResponse,
160
+ type PaymentProviderResponse as PaymentProviderResponse,
161
+ type UpdatePaymentProviderRequest as UpdatePaymentProviderRequest,
162
+ type PaymentProviderDeleteResponse as PaymentProviderDeleteResponse,
163
+ type PaymentProviderCreateParams as PaymentProviderCreateParams,
164
+ type PaymentProviderUpdateParams as PaymentProviderUpdateParams,
165
+ type PaymentProviderListParams as PaymentProviderListParams,
166
+ };
167
+ }
@@ -15,6 +15,18 @@ import {
15
15
  MessageResponse,
16
16
  Organization,
17
17
  } from './auth';
18
+ import * as PaymentProvidersAPI from './payment-providers';
19
+ import {
20
+ CreatePaymentProviderRequest,
21
+ ListPaymentProvidersResponse,
22
+ PaymentProviderCreateParams,
23
+ PaymentProviderDeleteResponse,
24
+ PaymentProviderListParams,
25
+ PaymentProviderResponse,
26
+ PaymentProviderUpdateParams,
27
+ PaymentProviders,
28
+ UpdatePaymentProviderRequest,
29
+ } from './payment-providers';
18
30
  import * as ProjectsAPI from './projects';
19
31
  import {
20
32
  CreateProjectRequest,
@@ -40,6 +52,8 @@ import {
40
52
  CountryDataPoint,
41
53
  DashboardMetricsResponse,
42
54
  EventsOverTimeDataPoint,
55
+ ManualIdentifyRequest,
56
+ ManualIdentifyResponse,
43
57
  OriginDataPoint,
44
58
  RecentEvent,
45
59
  RecentEventsResponse,
@@ -61,11 +75,15 @@ export class V1 extends APIResource {
61
75
  analytics: AnalyticsAPI.Analytics = new AnalyticsAPI.Analytics(this._client);
62
76
  projects: ProjectsAPI.Projects = new ProjectsAPI.Projects(this._client);
63
77
  auth: AuthAPI.Auth = new AuthAPI.Auth(this._client);
78
+ paymentProviders: PaymentProvidersAPI.PaymentProviders = new PaymentProvidersAPI.PaymentProviders(
79
+ this._client,
80
+ );
64
81
  }
65
82
 
66
83
  V1.Analytics = Analytics;
67
84
  V1.Projects = Projects;
68
85
  V1.Auth = Auth;
86
+ V1.PaymentProviders = PaymentProviders;
69
87
 
70
88
  export declare namespace V1 {
71
89
  export {
@@ -79,6 +97,8 @@ export declare namespace V1 {
79
97
  type CountryDataPoint as CountryDataPoint,
80
98
  type DashboardMetricsResponse as DashboardMetricsResponse,
81
99
  type EventsOverTimeDataPoint as EventsOverTimeDataPoint,
100
+ type ManualIdentifyRequest as ManualIdentifyRequest,
101
+ type ManualIdentifyResponse as ManualIdentifyResponse,
82
102
  type OriginDataPoint as OriginDataPoint,
83
103
  type RecentEvent as RecentEvent,
84
104
  type RecentEventsResponse as RecentEventsResponse,
@@ -122,4 +142,16 @@ export declare namespace V1 {
122
142
  type AuthRegisterAccountParams as AuthRegisterAccountParams,
123
143
  type AuthRequestPasswordRecoveryParams as AuthRequestPasswordRecoveryParams,
124
144
  };
145
+
146
+ export {
147
+ PaymentProviders as PaymentProviders,
148
+ type CreatePaymentProviderRequest as CreatePaymentProviderRequest,
149
+ type ListPaymentProvidersResponse as ListPaymentProvidersResponse,
150
+ type PaymentProviderResponse as PaymentProviderResponse,
151
+ type UpdatePaymentProviderRequest as UpdatePaymentProviderRequest,
152
+ type PaymentProviderDeleteResponse as PaymentProviderDeleteResponse,
153
+ type PaymentProviderCreateParams as PaymentProviderCreateParams,
154
+ type PaymentProviderUpdateParams as PaymentProviderUpdateParams,
155
+ type PaymentProviderListParams as PaymentProviderListParams,
156
+ };
125
157
  }
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.5.0'; // x-release-please-version
1
+ export const VERSION = '0.7.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.5.0";
1
+ export declare const VERSION = "0.7.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.5.0";
1
+ export declare const VERSION = "0.7.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.5.0'; // x-release-please-version
4
+ exports.VERSION = '0.7.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.5.0'; // x-release-please-version
1
+ export const VERSION = '0.7.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map