zorihq 0.10.1 → 0.11.1

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 (125) hide show
  1. package/CHANGELOG.md +12 -0
  2. package/README.md +13 -20
  3. package/package.json +1 -1
  4. package/resources/v1/auth.d.mts +33 -0
  5. package/resources/v1/auth.d.mts.map +1 -0
  6. package/resources/v1/auth.d.ts +33 -0
  7. package/resources/v1/auth.d.ts.map +1 -0
  8. package/resources/v1/auth.js +23 -0
  9. package/resources/v1/auth.js.map +1 -0
  10. package/resources/v1/auth.mjs +19 -0
  11. package/resources/v1/auth.mjs.map +1 -0
  12. package/resources/v1/index.d.mts +2 -1
  13. package/resources/v1/index.d.mts.map +1 -1
  14. package/resources/v1/index.d.ts +2 -1
  15. package/resources/v1/index.d.ts.map +1 -1
  16. package/resources/v1/index.js +7 -5
  17. package/resources/v1/index.js.map +1 -1
  18. package/resources/v1/index.mjs +2 -1
  19. package/resources/v1/index.mjs.map +1 -1
  20. package/resources/v1/payment-providers/index.d.mts +3 -0
  21. package/resources/v1/payment-providers/index.d.mts.map +1 -0
  22. package/resources/v1/payment-providers/index.d.ts +3 -0
  23. package/resources/v1/payment-providers/index.d.ts.map +1 -0
  24. package/resources/v1/payment-providers/index.js +9 -0
  25. package/resources/v1/payment-providers/index.js.map +1 -0
  26. package/resources/v1/payment-providers/index.mjs +4 -0
  27. package/resources/v1/payment-providers/index.mjs.map +1 -0
  28. package/resources/v1/payment-providers/payment-providers.d.mts +154 -0
  29. package/resources/v1/payment-providers/payment-providers.d.mts.map +1 -0
  30. package/resources/v1/payment-providers/payment-providers.d.ts +154 -0
  31. package/resources/v1/payment-providers/payment-providers.d.ts.map +1 -0
  32. package/resources/v1/payment-providers/payment-providers.js +98 -0
  33. package/resources/v1/payment-providers/payment-providers.js.map +1 -0
  34. package/resources/v1/payment-providers/payment-providers.mjs +93 -0
  35. package/resources/v1/payment-providers/payment-providers.mjs.map +1 -0
  36. package/resources/v1/payment-providers/stripe/app.d.mts +39 -0
  37. package/resources/v1/payment-providers/stripe/app.d.mts.map +1 -0
  38. package/resources/v1/payment-providers/stripe/app.d.ts +39 -0
  39. package/resources/v1/payment-providers/stripe/app.d.ts.map +1 -0
  40. package/resources/v1/payment-providers/stripe/app.js +24 -0
  41. package/resources/v1/payment-providers/stripe/app.js.map +1 -0
  42. package/resources/v1/payment-providers/stripe/app.mjs +20 -0
  43. package/resources/v1/payment-providers/stripe/app.mjs.map +1 -0
  44. package/resources/v1/payment-providers/stripe/index.d.mts +3 -0
  45. package/resources/v1/payment-providers/stripe/index.d.mts.map +1 -0
  46. package/resources/v1/payment-providers/stripe/index.d.ts +3 -0
  47. package/resources/v1/payment-providers/stripe/index.d.ts.map +1 -0
  48. package/resources/v1/payment-providers/stripe/index.js +9 -0
  49. package/resources/v1/payment-providers/stripe/index.js.map +1 -0
  50. package/resources/v1/payment-providers/stripe/index.mjs +4 -0
  51. package/resources/v1/payment-providers/stripe/index.mjs.map +1 -0
  52. package/resources/v1/payment-providers/stripe/stripe.d.mts +10 -0
  53. package/resources/v1/payment-providers/stripe/stripe.d.mts.map +1 -0
  54. package/resources/v1/payment-providers/stripe/stripe.d.ts +10 -0
  55. package/resources/v1/payment-providers/stripe/stripe.d.ts.map +1 -0
  56. package/resources/v1/payment-providers/stripe/stripe.js +17 -0
  57. package/resources/v1/payment-providers/stripe/stripe.js.map +1 -0
  58. package/resources/v1/payment-providers/stripe/stripe.mjs +12 -0
  59. package/resources/v1/payment-providers/stripe/stripe.mjs.map +1 -0
  60. package/resources/v1/payment-providers/stripe.d.mts +2 -0
  61. package/resources/v1/payment-providers/stripe.d.mts.map +1 -0
  62. package/resources/v1/payment-providers/stripe.d.ts +2 -0
  63. package/resources/v1/payment-providers/stripe.d.ts.map +1 -0
  64. package/resources/v1/payment-providers/stripe.js +6 -0
  65. package/resources/v1/payment-providers/stripe.js.map +1 -0
  66. package/resources/v1/payment-providers/stripe.mjs +3 -0
  67. package/resources/v1/payment-providers/stripe.mjs.map +1 -0
  68. package/resources/v1/payment-providers.d.mts +1 -149
  69. package/resources/v1/payment-providers.d.mts.map +1 -1
  70. package/resources/v1/payment-providers.d.ts +1 -149
  71. package/resources/v1/payment-providers.d.ts.map +1 -1
  72. package/resources/v1/payment-providers.js +2 -86
  73. package/resources/v1/payment-providers.js.map +1 -1
  74. package/resources/v1/payment-providers.mjs +1 -84
  75. package/resources/v1/payment-providers.mjs.map +1 -1
  76. package/resources/v1/revenue/cohort.d.mts +84 -0
  77. package/resources/v1/revenue/cohort.d.mts.map +1 -0
  78. package/resources/v1/revenue/cohort.d.ts +84 -0
  79. package/resources/v1/revenue/cohort.d.ts.map +1 -0
  80. package/resources/v1/revenue/cohort.js +24 -0
  81. package/resources/v1/revenue/cohort.js.map +1 -0
  82. package/resources/v1/revenue/cohort.mjs +20 -0
  83. package/resources/v1/revenue/cohort.mjs.map +1 -0
  84. package/resources/v1/revenue/index.d.mts +1 -0
  85. package/resources/v1/revenue/index.d.mts.map +1 -1
  86. package/resources/v1/revenue/index.d.ts +1 -0
  87. package/resources/v1/revenue/index.d.ts.map +1 -1
  88. package/resources/v1/revenue/index.js +3 -1
  89. package/resources/v1/revenue/index.js.map +1 -1
  90. package/resources/v1/revenue/index.mjs +1 -0
  91. package/resources/v1/revenue/index.mjs.map +1 -1
  92. package/resources/v1/revenue/revenue.d.mts +15 -0
  93. package/resources/v1/revenue/revenue.d.mts.map +1 -1
  94. package/resources/v1/revenue/revenue.d.ts +15 -0
  95. package/resources/v1/revenue/revenue.d.ts.map +1 -1
  96. package/resources/v1/revenue/revenue.js +4 -0
  97. package/resources/v1/revenue/revenue.js.map +1 -1
  98. package/resources/v1/revenue/revenue.mjs +4 -0
  99. package/resources/v1/revenue/revenue.mjs.map +1 -1
  100. package/resources/v1/v1.d.mts +6 -2
  101. package/resources/v1/v1.d.mts.map +1 -1
  102. package/resources/v1/v1.d.ts +6 -2
  103. package/resources/v1/v1.d.ts.map +1 -1
  104. package/resources/v1/v1.js +6 -2
  105. package/resources/v1/v1.js.map +1 -1
  106. package/resources/v1/v1.mjs +6 -2
  107. package/resources/v1/v1.mjs.map +1 -1
  108. package/src/resources/v1/auth.ts +48 -0
  109. package/src/resources/v1/index.ts +2 -1
  110. package/src/resources/v1/payment-providers/index.ts +17 -0
  111. package/src/resources/v1/payment-providers/payment-providers.ts +238 -0
  112. package/src/resources/v1/payment-providers/stripe/app.ts +56 -0
  113. package/src/resources/v1/payment-providers/stripe/index.ts +4 -0
  114. package/src/resources/v1/payment-providers/stripe/stripe.ts +19 -0
  115. package/src/resources/v1/payment-providers/stripe.ts +3 -0
  116. package/src/resources/v1/payment-providers.ts +1 -228
  117. package/src/resources/v1/revenue/cohort.ts +111 -0
  118. package/src/resources/v1/revenue/index.ts +1 -0
  119. package/src/resources/v1/revenue/revenue.ts +23 -0
  120. package/src/resources/v1/v1.ts +26 -15
  121. package/src/version.ts +1 -1
  122. package/version.d.mts +1 -1
  123. package/version.d.ts +1 -1
  124. package/version.js +1 -1
  125. package/version.mjs +1 -1
@@ -0,0 +1,111 @@
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
+
7
+ export class Cohort extends APIResource {
8
+ /**
9
+ * Analyze revenue metrics for a specific cohort of visitors, including total
10
+ * revenue, conversion rates, and time to first purchase
11
+ *
12
+ * @example
13
+ * ```ts
14
+ * const response = await client.v1.revenue.cohort.getMetrics({
15
+ * project_id: 'project_id',
16
+ * visitor_ids: ['string'],
17
+ * });
18
+ * ```
19
+ */
20
+ getMetrics(body: CohortGetMetricsParams, options?: RequestOptions): APIPromise<CohortGetMetricsResponse> {
21
+ return this._client.post('/api/v1/revenue/cohort/metrics', { body, ...options });
22
+ }
23
+ }
24
+
25
+ export interface CohortGetMetricsResponse {
26
+ /**
27
+ * Customers with only visitor_id
28
+ */
29
+ anonymous_customers?: number;
30
+
31
+ avg_order_value?: number;
32
+
33
+ avg_payments_per_customer?: number;
34
+
35
+ avg_revenue_per_customer?: number;
36
+
37
+ avg_revenue_per_visitor?: number;
38
+
39
+ /**
40
+ * Time metrics
41
+ */
42
+ avg_time_to_first_purchase_hours?: number;
43
+
44
+ /**
45
+ * paying_customers / total_customers \* 100
46
+ */
47
+ conversion_rate?: number;
48
+
49
+ currency?: string;
50
+
51
+ /**
52
+ * Customer identity mapping
53
+ */
54
+ identified_customers?: number;
55
+
56
+ /**
57
+ * Median time to first payment
58
+ */
59
+ median_time_to_first_purchase_hours?: number;
60
+
61
+ /**
62
+ * Unique customer identities who made payments
63
+ */
64
+ paying_customers?: number;
65
+
66
+ /**
67
+ * Total unique customer identities in cohort
68
+ */
69
+ total_customers?: number;
70
+
71
+ /**
72
+ * Payment metrics
73
+ */
74
+ total_payments?: number;
75
+
76
+ /**
77
+ * Revenue metrics
78
+ */
79
+ total_revenue?: number;
80
+
81
+ /**
82
+ * Cohort size
83
+ */
84
+ total_visitors?: number;
85
+
86
+ /**
87
+ * paying_customers / total_visitors \* 100
88
+ */
89
+ visitor_conversion_rate?: number;
90
+ }
91
+
92
+ export interface CohortGetMetricsParams {
93
+ project_id: string;
94
+
95
+ /**
96
+ * List of visitor IDs to analyze
97
+ */
98
+ visitor_ids: Array<string>;
99
+
100
+ /**
101
+ * Optional: filter by payment date
102
+ */
103
+ time_range?: 'last_hour' | 'today' | 'last_7_days' | 'last_30_days' | 'last_90_days';
104
+ }
105
+
106
+ export declare namespace Cohort {
107
+ export {
108
+ type CohortGetMetricsResponse as CohortGetMetricsResponse,
109
+ type CohortGetMetricsParams as CohortGetMetricsParams,
110
+ };
111
+ }
@@ -1,6 +1,7 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
 
3
3
  export { Attribution, type AttributionByOriginParams, type AttributionByUtmParams } from './attribution';
4
+ export { Cohort, type CohortGetMetricsResponse, type CohortGetMetricsParams } from './cohort';
4
5
  export { Conversion, type ConversionMetricsParams } from './conversion';
5
6
  export { Customers, type CustomerProfileParams, type CustomerTopParams } from './customers';
6
7
  export {
@@ -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
@@ -258,6 +261,11 @@ export interface TopCustomer {
258
261
 
259
262
  currency?: string;
260
263
 
264
+ /**
265
+ * Resolved customer identity (user_id > external_id > visitor_id)
266
+ */
267
+ customer_id?: string;
268
+
261
269
  email?: string;
262
270
 
263
271
  external_id?: string;
@@ -281,7 +289,15 @@ export interface TopCustomer {
281
289
 
282
290
  user_id?: string;
283
291
 
292
+ /**
293
+ * Representative visitor_id for this customer
294
+ */
284
295
  visitor_id?: string;
296
+
297
+ /**
298
+ * All visitor_ids for this customer
299
+ */
300
+ visitor_ids?: Array<string>;
285
301
  }
286
302
 
287
303
  export interface TopCustomersResponse {
@@ -346,6 +362,7 @@ export interface RevenueTimelineParams {
346
362
  Revenue.Attribution = Attribution;
347
363
  Revenue.Customers = Customers;
348
364
  Revenue.Conversion = Conversion;
365
+ Revenue.Cohort = Cohort;
349
366
 
350
367
  export declare namespace Revenue {
351
368
  export {
@@ -379,4 +396,10 @@ export declare namespace Revenue {
379
396
  };
380
397
 
381
398
  export { Conversion as Conversion, type ConversionMetricsParams as ConversionMetricsParams };
399
+
400
+ export {
401
+ Cohort as Cohort,
402
+ type CohortGetMetricsResponse as CohortGetMetricsResponse,
403
+ type CohortGetMetricsParams as CohortGetMetricsParams,
404
+ };
382
405
  }
@@ -1,21 +1,8 @@
1
1
  // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
2
 
3
3
  import { APIResource } from '../../core/resource';
4
- import * as PaymentProvidersAPI from './payment-providers';
5
- import {
6
- CreatePaymentProviderRequest,
7
- ListPaymentProvidersResponse,
8
- PaymentProviderCreateParams,
9
- PaymentProviderDeleteResponse,
10
- PaymentProviderInstructionsParams,
11
- PaymentProviderListParams,
12
- PaymentProviderResponse,
13
- PaymentProviderUpdateParams,
14
- PaymentProviders,
15
- ProviderField,
16
- ProviderInstructionsResponse,
17
- UpdatePaymentProviderRequest,
18
- } from './payment-providers';
4
+ import * as AuthAPI from './auth';
5
+ import { Auth, AuthLoginParams, LoginRequest, LoginResponse } from './auth';
19
6
  import * as ProjectsAPI from './projects';
20
7
  import {
21
8
  CreateProjectRequest,
@@ -60,6 +47,21 @@ import {
60
47
  VisitorsByDeviceResponse,
61
48
  VisitorsByOriginResponse,
62
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';
63
65
  import * as RevenueAPI from './revenue/revenue';
64
66
  import {
65
67
  AttributionByOriginResponse,
@@ -81,6 +83,7 @@ import {
81
83
  } from './revenue/revenue';
82
84
 
83
85
  export class V1 extends APIResource {
86
+ auth: AuthAPI.Auth = new AuthAPI.Auth(this._client);
84
87
  analytics: AnalyticsAPI.Analytics = new AnalyticsAPI.Analytics(this._client);
85
88
  revenue: RevenueAPI.Revenue = new RevenueAPI.Revenue(this._client);
86
89
  projects: ProjectsAPI.Projects = new ProjectsAPI.Projects(this._client);
@@ -89,12 +92,20 @@ export class V1 extends APIResource {
89
92
  );
90
93
  }
91
94
 
95
+ V1.Auth = Auth;
92
96
  V1.Analytics = Analytics;
93
97
  V1.Revenue = Revenue;
94
98
  V1.Projects = Projects;
95
99
  V1.PaymentProviders = PaymentProviders;
96
100
 
97
101
  export declare namespace V1 {
102
+ export {
103
+ Auth as Auth,
104
+ type LoginRequest as LoginRequest,
105
+ type LoginResponse as LoginResponse,
106
+ type AuthLoginParams as AuthLoginParams,
107
+ };
108
+
98
109
  export {
99
110
  Analytics as Analytics,
100
111
  type ActiveUsersResponse as ActiveUsersResponse,
package/src/version.ts CHANGED
@@ -1 +1 @@
1
- export const VERSION = '0.10.1'; // x-release-please-version
1
+ export const VERSION = '0.11.1'; // x-release-please-version
package/version.d.mts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.10.1";
1
+ export declare const VERSION = "0.11.1";
2
2
  //# sourceMappingURL=version.d.mts.map
package/version.d.ts CHANGED
@@ -1,2 +1,2 @@
1
- export declare const VERSION = "0.10.1";
1
+ export declare const VERSION = "0.11.1";
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.10.1'; // x-release-please-version
4
+ exports.VERSION = '0.11.1'; // x-release-please-version
5
5
  //# sourceMappingURL=version.js.map
package/version.mjs CHANGED
@@ -1,2 +1,2 @@
1
- export const VERSION = '0.10.1'; // x-release-please-version
1
+ export const VERSION = '0.11.1'; // x-release-please-version
2
2
  //# sourceMappingURL=version.mjs.map