zorihq 0.11.0 → 0.12.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 (166) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/package.json +1 -1
  3. package/resources/v1/analytics/analytics.d.mts +13 -43
  4. package/resources/v1/analytics/analytics.d.mts.map +1 -1
  5. package/resources/v1/analytics/analytics.d.ts +13 -43
  6. package/resources/v1/analytics/analytics.d.ts.map +1 -1
  7. package/resources/v1/analytics/analytics.js +4 -2
  8. package/resources/v1/analytics/analytics.js.map +1 -1
  9. package/resources/v1/analytics/analytics.mjs +4 -2
  10. package/resources/v1/analytics/analytics.mjs.map +1 -1
  11. package/resources/v1/analytics/events.d.mts +30 -42
  12. package/resources/v1/analytics/events.d.mts.map +1 -1
  13. package/resources/v1/analytics/events.d.ts +30 -42
  14. package/resources/v1/analytics/events.d.ts.map +1 -1
  15. package/resources/v1/analytics/events.js +8 -2
  16. package/resources/v1/analytics/events.js.map +1 -1
  17. package/resources/v1/analytics/events.mjs +8 -2
  18. package/resources/v1/analytics/events.mjs.map +1 -1
  19. package/resources/v1/analytics/retention.d.mts +39 -34
  20. package/resources/v1/analytics/retention.d.mts.map +1 -1
  21. package/resources/v1/analytics/retention.d.ts +39 -34
  22. package/resources/v1/analytics/retention.d.ts.map +1 -1
  23. package/resources/v1/analytics/retention.js +12 -6
  24. package/resources/v1/analytics/retention.js.map +1 -1
  25. package/resources/v1/analytics/retention.mjs +12 -6
  26. package/resources/v1/analytics/retention.mjs.map +1 -1
  27. package/resources/v1/analytics/sessions.d.mts +26 -24
  28. package/resources/v1/analytics/sessions.d.mts.map +1 -1
  29. package/resources/v1/analytics/sessions.d.ts +26 -24
  30. package/resources/v1/analytics/sessions.d.ts.map +1 -1
  31. package/resources/v1/analytics/sessions.js +8 -4
  32. package/resources/v1/analytics/sessions.js.map +1 -1
  33. package/resources/v1/analytics/sessions.mjs +8 -4
  34. package/resources/v1/analytics/sessions.mjs.map +1 -1
  35. package/resources/v1/analytics/users.d.mts +13 -5
  36. package/resources/v1/analytics/users.d.mts.map +1 -1
  37. package/resources/v1/analytics/users.d.ts +13 -5
  38. package/resources/v1/analytics/users.d.ts.map +1 -1
  39. package/resources/v1/analytics/users.js +4 -1
  40. package/resources/v1/analytics/users.js.map +1 -1
  41. package/resources/v1/analytics/users.mjs +4 -1
  42. package/resources/v1/analytics/users.mjs.map +1 -1
  43. package/resources/v1/analytics/visitors.d.mts +78 -64
  44. package/resources/v1/analytics/visitors.d.mts.map +1 -1
  45. package/resources/v1/analytics/visitors.d.ts +78 -64
  46. package/resources/v1/analytics/visitors.d.ts.map +1 -1
  47. package/resources/v1/analytics/visitors.js +24 -12
  48. package/resources/v1/analytics/visitors.js.map +1 -1
  49. package/resources/v1/analytics/visitors.mjs +24 -12
  50. package/resources/v1/analytics/visitors.mjs.map +1 -1
  51. package/resources/v1/index.d.mts +1 -1
  52. package/resources/v1/index.d.ts +1 -1
  53. package/resources/v1/index.js +4 -4
  54. package/resources/v1/index.js.map +1 -1
  55. package/resources/v1/index.mjs +1 -1
  56. package/resources/v1/payment-providers/index.d.mts +3 -0
  57. package/resources/v1/payment-providers/index.d.mts.map +1 -0
  58. package/resources/v1/payment-providers/index.d.ts +3 -0
  59. package/resources/v1/payment-providers/index.d.ts.map +1 -0
  60. package/resources/v1/payment-providers/index.js +9 -0
  61. package/resources/v1/payment-providers/index.js.map +1 -0
  62. package/resources/v1/payment-providers/index.mjs +4 -0
  63. package/resources/v1/payment-providers/index.mjs.map +1 -0
  64. package/resources/v1/payment-providers/payment-providers.d.mts +151 -0
  65. package/resources/v1/payment-providers/payment-providers.d.mts.map +1 -0
  66. package/resources/v1/payment-providers/payment-providers.d.ts +151 -0
  67. package/resources/v1/payment-providers/payment-providers.d.ts.map +1 -0
  68. package/resources/v1/payment-providers/payment-providers.js +98 -0
  69. package/resources/v1/payment-providers/payment-providers.js.map +1 -0
  70. package/resources/v1/payment-providers/payment-providers.mjs +93 -0
  71. package/resources/v1/payment-providers/payment-providers.mjs.map +1 -0
  72. package/resources/v1/payment-providers/stripe/app.d.mts +39 -0
  73. package/resources/v1/payment-providers/stripe/app.d.mts.map +1 -0
  74. package/resources/v1/payment-providers/stripe/app.d.ts +39 -0
  75. package/resources/v1/payment-providers/stripe/app.d.ts.map +1 -0
  76. package/resources/v1/payment-providers/stripe/app.js +24 -0
  77. package/resources/v1/payment-providers/stripe/app.js.map +1 -0
  78. package/resources/v1/payment-providers/stripe/app.mjs +20 -0
  79. package/resources/v1/payment-providers/stripe/app.mjs.map +1 -0
  80. package/resources/v1/payment-providers/stripe/index.d.mts +3 -0
  81. package/resources/v1/payment-providers/stripe/index.d.mts.map +1 -0
  82. package/resources/v1/payment-providers/stripe/index.d.ts +3 -0
  83. package/resources/v1/payment-providers/stripe/index.d.ts.map +1 -0
  84. package/resources/v1/payment-providers/stripe/index.js +9 -0
  85. package/resources/v1/payment-providers/stripe/index.js.map +1 -0
  86. package/resources/v1/payment-providers/stripe/index.mjs +4 -0
  87. package/resources/v1/payment-providers/stripe/index.mjs.map +1 -0
  88. package/resources/v1/payment-providers/stripe/stripe.d.mts +10 -0
  89. package/resources/v1/payment-providers/stripe/stripe.d.mts.map +1 -0
  90. package/resources/v1/payment-providers/stripe/stripe.d.ts +10 -0
  91. package/resources/v1/payment-providers/stripe/stripe.d.ts.map +1 -0
  92. package/resources/v1/payment-providers/stripe/stripe.js +17 -0
  93. package/resources/v1/payment-providers/stripe/stripe.js.map +1 -0
  94. package/resources/v1/payment-providers/stripe/stripe.mjs +12 -0
  95. package/resources/v1/payment-providers/stripe/stripe.mjs.map +1 -0
  96. package/resources/v1/payment-providers/stripe.d.mts +2 -0
  97. package/resources/v1/payment-providers/stripe.d.mts.map +1 -0
  98. package/resources/v1/payment-providers/stripe.d.ts +2 -0
  99. package/resources/v1/payment-providers/stripe.d.ts.map +1 -0
  100. package/resources/v1/payment-providers/stripe.js +6 -0
  101. package/resources/v1/payment-providers/stripe.js.map +1 -0
  102. package/resources/v1/payment-providers/stripe.mjs +3 -0
  103. package/resources/v1/payment-providers/stripe.mjs.map +1 -0
  104. package/resources/v1/payment-providers.d.mts +1 -149
  105. package/resources/v1/payment-providers.d.mts.map +1 -1
  106. package/resources/v1/payment-providers.d.ts +1 -149
  107. package/resources/v1/payment-providers.d.ts.map +1 -1
  108. package/resources/v1/payment-providers.js +2 -86
  109. package/resources/v1/payment-providers.js.map +1 -1
  110. package/resources/v1/payment-providers.mjs +1 -84
  111. package/resources/v1/payment-providers.mjs.map +1 -1
  112. package/resources/v1/revenue/cohort.d.mts +45 -0
  113. package/resources/v1/revenue/cohort.d.mts.map +1 -0
  114. package/resources/v1/revenue/cohort.d.ts +45 -0
  115. package/resources/v1/revenue/cohort.d.ts.map +1 -0
  116. package/resources/v1/revenue/cohort.js +24 -0
  117. package/resources/v1/revenue/cohort.js.map +1 -0
  118. package/resources/v1/revenue/cohort.mjs +20 -0
  119. package/resources/v1/revenue/cohort.mjs.map +1 -0
  120. package/resources/v1/revenue/index.d.mts +1 -0
  121. package/resources/v1/revenue/index.d.mts.map +1 -1
  122. package/resources/v1/revenue/index.d.ts +1 -0
  123. package/resources/v1/revenue/index.d.ts.map +1 -1
  124. package/resources/v1/revenue/index.js +3 -1
  125. package/resources/v1/revenue/index.js.map +1 -1
  126. package/resources/v1/revenue/index.mjs +1 -0
  127. package/resources/v1/revenue/index.mjs.map +1 -1
  128. package/resources/v1/revenue/revenue.d.mts +6 -75
  129. package/resources/v1/revenue/revenue.d.mts.map +1 -1
  130. package/resources/v1/revenue/revenue.d.ts +6 -75
  131. package/resources/v1/revenue/revenue.d.ts.map +1 -1
  132. package/resources/v1/revenue/revenue.js +4 -0
  133. package/resources/v1/revenue/revenue.js.map +1 -1
  134. package/resources/v1/revenue/revenue.mjs +4 -0
  135. package/resources/v1/revenue/revenue.mjs.map +1 -1
  136. package/resources/v1/v1.d.mts +2 -2
  137. package/resources/v1/v1.d.mts.map +1 -1
  138. package/resources/v1/v1.d.ts +2 -2
  139. package/resources/v1/v1.d.ts.map +1 -1
  140. package/resources/v1/v1.js +2 -2
  141. package/resources/v1/v1.js.map +1 -1
  142. package/resources/v1/v1.mjs +2 -2
  143. package/resources/v1/v1.mjs.map +1 -1
  144. package/src/resources/v1/analytics/analytics.ts +20 -43
  145. package/src/resources/v1/analytics/events.ts +42 -42
  146. package/src/resources/v1/analytics/retention.ts +59 -34
  147. package/src/resources/v1/analytics/sessions.ts +39 -24
  148. package/src/resources/v1/analytics/users.ts +21 -5
  149. package/src/resources/v1/analytics/visitors.ts +119 -64
  150. package/src/resources/v1/index.ts +1 -1
  151. package/src/resources/v1/payment-providers/index.ts +17 -0
  152. package/src/resources/v1/payment-providers/payment-providers.ts +235 -0
  153. package/src/resources/v1/payment-providers/stripe/app.ts +56 -0
  154. package/src/resources/v1/payment-providers/stripe/index.ts +4 -0
  155. package/src/resources/v1/payment-providers/stripe/stripe.ts +19 -0
  156. package/src/resources/v1/payment-providers/stripe.ts +3 -0
  157. package/src/resources/v1/payment-providers.ts +1 -228
  158. package/src/resources/v1/revenue/cohort.ts +72 -0
  159. package/src/resources/v1/revenue/index.ts +1 -0
  160. package/src/resources/v1/revenue/revenue.ts +14 -75
  161. package/src/resources/v1/v1.ts +15 -15
  162. package/src/version.ts +1 -1
  163. package/version.d.mts +1 -1
  164. package/version.d.ts +1 -1
  165. package/version.js +1 -1
  166. package/version.mjs +1 -1
@@ -3,6 +3,8 @@
3
3
  import { APIResource } from '../../../core/resource';
4
4
  import * as AttributionAPI from './attribution';
5
5
  import { Attribution, AttributionByOriginParams, AttributionByUtmParams } from './attribution';
6
+ import * as CohortAPI from './cohort';
7
+ import { Cohort, CohortGetMetricsParams, CohortGetMetricsResponse } from './cohort';
6
8
  import * as ConversionAPI from './conversion';
7
9
  import { Conversion, ConversionMetricsParams } from './conversion';
8
10
  import * as CustomersAPI from './customers';
@@ -14,6 +16,7 @@ export class Revenue extends APIResource {
14
16
  attribution: AttributionAPI.Attribution = new AttributionAPI.Attribution(this._client);
15
17
  customers: CustomersAPI.Customers = new CustomersAPI.Customers(this._client);
16
18
  conversion: ConversionAPI.Conversion = new ConversionAPI.Conversion(this._client);
19
+ cohort: CohortAPI.Cohort = new CohortAPI.Cohort(this._client);
17
20
 
18
21
  /**
19
22
  * Get key revenue metrics including total revenue, conversion rate, and average
@@ -57,28 +60,16 @@ export interface AttributionByUtmResponse {
57
60
  export interface ConversionMetricsResponse {
58
61
  avg_purchases_per_customer?: number;
59
62
 
60
- /**
61
- * Time to conversion
62
- */
63
63
  avg_time_to_first_purchase_hours?: number;
64
64
 
65
- /**
66
- * % of visitors who paid
67
- */
68
65
  conversion_rate?: number;
69
66
 
70
- /**
71
- * Customer value
72
- */
73
67
  customer_lifetime_value?: number;
74
68
 
75
69
  median_time_to_first_purchase_hours?: number;
76
70
 
77
71
  paying_customers?: number;
78
72
 
79
- /**
80
- * Repeat purchase metrics
81
- */
82
73
  repeat_purchase_rate?: number;
83
74
 
84
75
  total_visitors?: number;
@@ -95,9 +86,6 @@ export interface CustomerProfileResponse {
95
86
 
96
87
  first_payment_date?: string;
97
88
 
98
- /**
99
- * Attribution
100
- */
101
89
  first_traffic_origin?: string;
102
90
 
103
91
  first_utm_campaign?: string;
@@ -112,86 +100,44 @@ export interface CustomerProfileResponse {
112
100
 
113
101
  payment_count?: number;
114
102
 
115
- /**
116
- * Payment history
117
- */
118
103
  payments?: Array<Payment>;
119
104
 
120
- /**
121
- * Revenue over time (last 90 days)
122
- */
123
105
  revenue_over_time?: Array<RevenueOverTimeDataPoint>;
124
106
 
125
- /**
126
- * Revenue summary
127
- */
128
107
  total_revenue?: number;
129
108
 
130
109
  user_id?: string;
131
110
 
132
- /**
133
- * Identity
134
- */
135
111
  visitor_id?: string;
136
112
  }
137
113
 
138
114
  export interface DashboardResponse {
139
- /**
140
- * Average metrics
141
- */
142
115
  avg_order_value?: number;
143
116
 
144
- /**
145
- * Average revenue per paying customer
146
- */
147
117
  avg_revenue_per_customer?: number;
148
118
 
149
119
  avg_revenue_per_identified_customer?: number;
150
120
 
151
- /**
152
- * Average revenue per session
153
- */
154
121
  avg_revenue_per_session?: number;
155
122
 
156
- /**
157
- * % of visitors who paid
158
- */
159
123
  conversion_rate?: number;
160
124
 
161
125
  currency?: string;
162
126
 
163
127
  identified_customer_revenue?: number;
164
128
 
165
- /**
166
- * Identified customers (have email/user_id)
167
- */
168
129
  identified_customers?: number;
169
130
 
170
- /**
171
- * Customer metrics
172
- */
173
131
  paying_customers?: number;
174
132
 
175
- /**
176
- * Count of successful payments
177
- */
178
133
  total_payments?: number;
179
134
 
180
- /**
181
- * Core revenue metrics
182
- */
183
135
  total_revenue?: number;
184
136
  }
185
137
 
186
138
  export interface OriginAttributionDataPoint {
187
- /**
188
- * Average revenue per paying customer
189
- */
190
139
  avg_revenue_per_customer?: number;
191
140
 
192
- /**
193
- * paying_customers / unique_visitors \* 100
194
- */
195
141
  conversion_rate?: number;
196
142
 
197
143
  currency?: string;
@@ -204,9 +150,6 @@ export interface OriginAttributionDataPoint {
204
150
 
205
151
  revenue_percentage?: number;
206
152
 
207
- /**
208
- * Revenue in smallest currency unit (cents)
209
- */
210
153
  total_revenue?: number;
211
154
 
212
155
  unique_visitors?: number;
@@ -243,9 +186,6 @@ export interface TimelineDataPoint {
243
186
 
244
187
  timestamp?: string;
245
188
 
246
- /**
247
- * Revenue in smallest currency unit (cents)
248
- */
249
189
  total_revenue?: number;
250
190
  }
251
191
 
@@ -258,6 +198,8 @@ export interface TopCustomer {
258
198
 
259
199
  currency?: string;
260
200
 
201
+ customer_id?: string;
202
+
261
203
  email?: string;
262
204
 
263
205
  external_id?: string;
@@ -274,14 +216,13 @@ export interface TopCustomer {
274
216
 
275
217
  payment_count?: number;
276
218
 
277
- /**
278
- * Total revenue in smallest currency unit (cents)
279
- */
280
219
  total_revenue?: number;
281
220
 
282
221
  user_id?: string;
283
222
 
284
223
  visitor_id?: string;
224
+
225
+ visitor_ids?: Array<string>;
285
226
  }
286
227
 
287
228
  export interface TopCustomersResponse {
@@ -291,14 +232,8 @@ export interface TopCustomersResponse {
291
232
  }
292
233
 
293
234
  export interface UtmAttributionDataPoint {
294
- /**
295
- * Average revenue per paying customer
296
- */
297
235
  avg_revenue_per_customer?: number;
298
236
 
299
- /**
300
- * paying_customers / unique_visitors \* 100
301
- */
302
237
  conversion_rate?: number;
303
238
 
304
239
  currency?: string;
@@ -309,9 +244,6 @@ export interface UtmAttributionDataPoint {
309
244
 
310
245
  revenue_percentage?: number;
311
246
 
312
- /**
313
- * Revenue in smallest currency unit (cents)
314
- */
315
247
  total_revenue?: number;
316
248
 
317
249
  unique_visitors?: number;
@@ -346,6 +278,7 @@ export interface RevenueTimelineParams {
346
278
  Revenue.Attribution = Attribution;
347
279
  Revenue.Customers = Customers;
348
280
  Revenue.Conversion = Conversion;
281
+ Revenue.Cohort = Cohort;
349
282
 
350
283
  export declare namespace Revenue {
351
284
  export {
@@ -379,4 +312,10 @@ export declare namespace Revenue {
379
312
  };
380
313
 
381
314
  export { Conversion as Conversion, type ConversionMetricsParams as ConversionMetricsParams };
315
+
316
+ export {
317
+ Cohort as Cohort,
318
+ type CohortGetMetricsResponse as CohortGetMetricsResponse,
319
+ type CohortGetMetricsParams as CohortGetMetricsParams,
320
+ };
382
321
  }
@@ -3,21 +3,6 @@
3
3
  import { APIResource } from '../../core/resource';
4
4
  import * as AuthAPI from './auth';
5
5
  import { Auth, AuthLoginParams, LoginRequest, LoginResponse } from './auth';
6
- import * as PaymentProvidersAPI from './payment-providers';
7
- import {
8
- CreatePaymentProviderRequest,
9
- ListPaymentProvidersResponse,
10
- PaymentProviderCreateParams,
11
- PaymentProviderDeleteResponse,
12
- PaymentProviderInstructionsParams,
13
- PaymentProviderListParams,
14
- PaymentProviderResponse,
15
- PaymentProviderUpdateParams,
16
- PaymentProviders,
17
- ProviderField,
18
- ProviderInstructionsResponse,
19
- UpdatePaymentProviderRequest,
20
- } from './payment-providers';
21
6
  import * as ProjectsAPI from './projects';
22
7
  import {
23
8
  CreateProjectRequest,
@@ -62,6 +47,21 @@ import {
62
47
  VisitorsByDeviceResponse,
63
48
  VisitorsByOriginResponse,
64
49
  } from './analytics/analytics';
50
+ import * as PaymentProvidersAPI from './payment-providers/payment-providers';
51
+ import {
52
+ CreatePaymentProviderRequest,
53
+ ListPaymentProvidersResponse,
54
+ PaymentProviderCreateParams,
55
+ PaymentProviderDeleteResponse,
56
+ PaymentProviderInstructionsParams,
57
+ PaymentProviderListParams,
58
+ PaymentProviderResponse,
59
+ PaymentProviderUpdateParams,
60
+ PaymentProviders,
61
+ ProviderField,
62
+ ProviderInstructionsResponse,
63
+ UpdatePaymentProviderRequest,
64
+ } from './payment-providers/payment-providers';
65
65
  import * as RevenueAPI from './revenue/revenue';
66
66
  import {
67
67
  AttributionByOriginResponse,
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.11.0'; // x-release-please-version
1
+ export const VERSION = '0.12.0'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.11.0";
1
+ export declare const VERSION = "0.12.0";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.11.0";
1
+ export declare const VERSION = "0.12.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.11.0'; // x-release-please-version
4
+ exports.VERSION = '0.12.0'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.11.0'; // x-release-please-version
1
+ export const VERSION = '0.12.0'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map