dub 0.12.14 → 0.12.16
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.
- checksums.yaml +4 -4
- data/lib/open_api_sdk/analytics.rb +2 -2
- data/lib/open_api_sdk/models/operations/listcommissions_request.rb +25 -4
- data/lib/open_api_sdk/models/operations/listevents_request.rb +6 -2
- data/lib/open_api_sdk/models/operations/listevents_request.rbi +2 -0
- data/lib/open_api_sdk/models/operations/queryparam_groupby.rb +1 -0
- data/lib/open_api_sdk/models/operations/retrieveanalytics_request.rb +6 -2
- data/lib/open_api_sdk/models/operations/retrieveanalytics_request.rbi +2 -0
- data/lib/open_api_sdk/models/operations/type.rb +5 -1
- data/lib/open_api_sdk/models/shared/analyticseventnames.rb +50 -0
- data/lib/open_api_sdk/models/shared/analyticseventnames.rbi +21 -0
- data/lib/open_api_sdk/models/shared.rb +1 -0
- data/lib/open_api_sdk/sdkconfiguration.rb +2 -2
- metadata +4 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 8ba3ee22815fd119f2fd7e8b2766d2ff6f8436246ca44ddcfe286a1588aab7a1
|
|
4
|
+
data.tar.gz: 87e6bceffaf0bf657829752efe2b3e459f8f240bdd4b3f19a3d0f700fc5bbe6e
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 3ff10d1122416f32c3c5d9a7ce326d405a8296ec4c9b49d2cadd8cd2e4def9fb5e4412f88667bc74c58b11c000ef0763699becd18b66f7f9d80e31dd893a3007
|
|
7
|
+
data.tar.gz: e0c77a914ddd49b23eb3469c7c009f22b1e6c7835e59f7698bf6f006cac520a2c12f43a40ed07e876a250895ccb50ce31c2e13bcab550d6517faebc7f8784106
|
|
@@ -43,7 +43,7 @@ module OpenApiSDK
|
|
|
43
43
|
|
|
44
44
|
|
|
45
45
|
|
|
46
|
-
sig { params(request: Models::Operations::RetrieveAnalyticsRequest, timeout_ms: T.nilable(Integer), http_headers: T.nilable(T::Hash[T.any(String, Symbol), String])).returns(T.any(Models::Shared::AnalyticsCount, T::Array[Models::Shared::AnalyticsTimeseries], T::Array[Models::Shared::AnalyticsContinents], T::Array[Models::Shared::AnalyticsCountries], T::Array[Models::Shared::AnalyticsRegions], T::Array[Models::Shared::AnalyticsCities], T::Array[Models::Shared::AnalyticsDevices], T::Array[Models::Shared::AnalyticsBrowsers], T::Array[Models::Shared::AnalyticsOS], T::Array[Models::Shared::AnalyticsTriggers], T::Array[Models::Shared::AnalyticsReferers], T::Array[Models::Shared::AnalyticsRefererUrls], T::Array[Models::Shared::AnalyticsTopLinks], T::Array[Models::Shared::AnalyticsTopUrls])) }
|
|
46
|
+
sig { params(request: Models::Operations::RetrieveAnalyticsRequest, timeout_ms: T.nilable(Integer), http_headers: T.nilable(T::Hash[T.any(String, Symbol), String])).returns(T.any(Models::Shared::AnalyticsCount, T::Array[Models::Shared::AnalyticsTimeseries], T::Array[Models::Shared::AnalyticsContinents], T::Array[Models::Shared::AnalyticsCountries], T::Array[Models::Shared::AnalyticsRegions], T::Array[Models::Shared::AnalyticsCities], T::Array[Models::Shared::AnalyticsDevices], T::Array[Models::Shared::AnalyticsBrowsers], T::Array[Models::Shared::AnalyticsOS], T::Array[Models::Shared::AnalyticsTriggers], T::Array[Models::Shared::AnalyticsEventNames], T::Array[Models::Shared::AnalyticsReferers], T::Array[Models::Shared::AnalyticsRefererUrls], T::Array[Models::Shared::AnalyticsTopLinks], T::Array[Models::Shared::AnalyticsTopUrls])) }
|
|
47
47
|
def retrieve(request:, timeout_ms: nil, http_headers: nil)
|
|
48
48
|
# retrieve - Retrieve analytics for a link, a domain, or the authenticated workspace.
|
|
49
49
|
# Retrieve analytics for a link, a domain, or the authenticated workspace. The response type depends on the `event` and `type` query parameters.
|
|
@@ -129,7 +129,7 @@ module OpenApiSDK
|
|
|
129
129
|
response: http_response
|
|
130
130
|
)
|
|
131
131
|
response_data = http_response.env.response_body
|
|
132
|
-
obj = Crystalline.unmarshal_json(JSON.parse(response_data), Crystalline::Union.new(Models::Shared::AnalyticsCount, Crystalline::Array.new(Models::Shared::AnalyticsTimeseries), Crystalline::Array.new(Models::Shared::AnalyticsContinents), Crystalline::Array.new(Models::Shared::AnalyticsCountries), Crystalline::Array.new(Models::Shared::AnalyticsRegions), Crystalline::Array.new(Models::Shared::AnalyticsCities), Crystalline::Array.new(Models::Shared::AnalyticsDevices), Crystalline::Array.new(Models::Shared::AnalyticsBrowsers), Crystalline::Array.new(Models::Shared::AnalyticsOS), Crystalline::Array.new(Models::Shared::AnalyticsTriggers), Crystalline::Array.new(Models::Shared::AnalyticsReferers), Crystalline::Array.new(Models::Shared::AnalyticsRefererUrls), Crystalline::Array.new(Models::Shared::AnalyticsTopLinks), Crystalline::Array.new(Models::Shared::AnalyticsTopUrls)))
|
|
132
|
+
obj = Crystalline.unmarshal_json(JSON.parse(response_data), Crystalline::Union.new(Models::Shared::AnalyticsCount, Crystalline::Array.new(Models::Shared::AnalyticsTimeseries), Crystalline::Array.new(Models::Shared::AnalyticsContinents), Crystalline::Array.new(Models::Shared::AnalyticsCountries), Crystalline::Array.new(Models::Shared::AnalyticsRegions), Crystalline::Array.new(Models::Shared::AnalyticsCities), Crystalline::Array.new(Models::Shared::AnalyticsDevices), Crystalline::Array.new(Models::Shared::AnalyticsBrowsers), Crystalline::Array.new(Models::Shared::AnalyticsOS), Crystalline::Array.new(Models::Shared::AnalyticsTriggers), Crystalline::Array.new(Models::Shared::AnalyticsEventNames), Crystalline::Array.new(Models::Shared::AnalyticsReferers), Crystalline::Array.new(Models::Shared::AnalyticsRefererUrls), Crystalline::Array.new(Models::Shared::AnalyticsTopLinks), Crystalline::Array.new(Models::Shared::AnalyticsTopUrls)))
|
|
133
133
|
|
|
134
134
|
return obj
|
|
135
135
|
else
|
|
@@ -14,19 +14,37 @@ module OpenApiSDK
|
|
|
14
14
|
extend T::Sig
|
|
15
15
|
include Crystalline::MetadataFields
|
|
16
16
|
|
|
17
|
-
# Filter the list of commissions by type.
|
|
17
|
+
# Filter the list of commissions by type.
|
|
18
|
+
# Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples:
|
|
19
|
+
# - "sale"
|
|
20
|
+
# - "sale,lead"
|
|
21
|
+
# - "-click"
|
|
18
22
|
field :type, Crystalline::Nilable.new(Models::Operations::Type), { 'query_param': { 'field_name': 'type', 'style': 'form', 'explode': true } }
|
|
19
23
|
# Filter the list of commissions by the associated customer.
|
|
20
24
|
field :customer_id, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'customerId', 'style': 'form', 'explode': true } }
|
|
21
25
|
# Filter the list of commissions by the associated payout.
|
|
22
26
|
field :payout_id, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'payoutId', 'style': 'form', 'explode': true } }
|
|
23
|
-
# Filter the list of commissions by the associated partner. When specified, takes precedence over `tenantId`.
|
|
27
|
+
# Filter the list of commissions by the associated partner. When specified, takes precedence over `tenantId`.
|
|
28
|
+
# Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`).
|
|
29
|
+
# Examples:
|
|
30
|
+
# - "partner_abc"
|
|
31
|
+
# - "partner_abc,partner_xyz"
|
|
32
|
+
# - "-partner_abc"
|
|
24
33
|
field :partner_id, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'partnerId', 'style': 'form', 'explode': true } }
|
|
25
34
|
# Filter the list of commissions by the associated partner's `tenantId` (their unique ID within your database).
|
|
26
35
|
field :tenant_id, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'tenantId', 'style': 'form', 'explode': true } }
|
|
27
|
-
# Filter the list of commissions by the associated partner group.
|
|
36
|
+
# Filter the list of commissions by the associated partner group.
|
|
37
|
+
# Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples:
|
|
38
|
+
# - "group_abc"
|
|
39
|
+
# - "group_abc,group_xyz"
|
|
40
|
+
# - "-group_abc"
|
|
28
41
|
field :group_id, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'groupId', 'style': 'form', 'explode': true } }
|
|
29
|
-
# Filter the list of commissions by the associated partner tag.
|
|
42
|
+
# Filter the list of commissions by the associated partner tag.
|
|
43
|
+
# Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`).
|
|
44
|
+
# Examples:
|
|
45
|
+
# - "ptag_abc"
|
|
46
|
+
# - "ptag_abc,ptag_xyz"
|
|
47
|
+
# - "-ptag_abc"
|
|
30
48
|
field :partner_tag_id, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'partnerTagId', 'style': 'form', 'explode': true } }
|
|
31
49
|
# Filter the list of commissions by the associated invoice. Since invoiceId is unique on a per-program basis, this will only return one commission per invoice.
|
|
32
50
|
field :invoice_id, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'invoiceId', 'style': 'form', 'explode': true } }
|
|
@@ -39,6 +57,9 @@ module OpenApiSDK
|
|
|
39
57
|
|
|
40
58
|
field :timezone, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'timezone', 'style': 'form', 'explode': true } }
|
|
41
59
|
# Filter by lead or sale event metadata. Top-level keys only. Compares string values only — numeric and boolean metadata values are not matched.
|
|
60
|
+
# Examples:
|
|
61
|
+
# - "metadata['key']='value'"
|
|
62
|
+
# - "metadata['key']!='value'"
|
|
42
63
|
field :query, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'query', 'style': 'form', 'explode': true } }
|
|
43
64
|
# If specified, the query only searches for results before this cursor. Mutually exclusive with `startingAfter`.
|
|
44
65
|
field :ending_before, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'endingBefore', 'style': 'form', 'explode': true } }
|
|
@@ -58,6 +58,8 @@ module OpenApiSDK
|
|
|
58
58
|
field :os, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'os', 'style': 'form', 'explode': true } }
|
|
59
59
|
# The trigger to retrieve analytics for. Valid values: qr, link, pageview. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `qr`, `qr,link`, `-qr`. If undefined, returns all trigger types.
|
|
60
60
|
field :trigger, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'trigger', 'style': 'form', 'explode': true } }
|
|
61
|
+
# The conversion event name to retrieve analytics for. Only available for lead and sale events. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Sign up`, `Sign up,Purchase`, `-Sign up`.
|
|
62
|
+
field :event_name, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'eventName', 'style': 'form', 'explode': true } }
|
|
61
63
|
# The referer hostname to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `google.com`, `google.com,twitter.com`, `-facebook.com`.
|
|
62
64
|
field :referer, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'referer', 'style': 'form', 'explode': true } }
|
|
63
65
|
# The full referer URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `https://google.com`, `https://google.com,https://twitter.com`, `-https://spam.com`.
|
|
@@ -101,8 +103,8 @@ module OpenApiSDK
|
|
|
101
103
|
# DEPRECATED. Use `sortOrder` instead.
|
|
102
104
|
field :order, Crystalline::Nilable.new(Models::Operations::Order), { 'query_param': { 'field_name': 'order', 'style': 'form', 'explode': true } }
|
|
103
105
|
|
|
104
|
-
sig { params(domain: T.nilable(::String), key: T.nilable(::String), link_id: T.nilable(::String), external_id: T.nilable(::String), tenant_id: T.nilable(::String), tag_id: T.nilable(::String), folder_id: T.nilable(::String), partner_tag_id: T.nilable(::String), group_id: T.nilable(::String), partner_id: T.nilable(::String), customer_id: T.nilable(::String), interval: T.nilable(Models::Operations::QueryParamInterval), start: T.nilable(::String), end_: T.nilable(::String), country: T.nilable(::String), city: T.nilable(::String), region: T.nilable(::String), continent: T.nilable(::String), device: T.nilable(::String), browser: T.nilable(::String), os: T.nilable(::String), trigger: T.nilable(::String), referer: T.nilable(::String), referer_url: T.nilable(::String), url: T.nilable(::String), utm_source: T.nilable(::String), utm_medium: T.nilable(::String), utm_campaign: T.nilable(::String), utm_term: T.nilable(::String), utm_content: T.nilable(::String), root: T.nilable(T::Boolean), sale_type: T.nilable(Models::Operations::QueryParamSaleType), query: T.nilable(::String), program_id: T.nilable(::String), tag_ids: T.nilable(::String), qr: T.nilable(T::Boolean), event: T.nilable(Models::Operations::QueryParamEvent), timezone: T.nilable(::String), page: T.nilable(::Integer), limit: T.nilable(::Integer), sort_order: T.nilable(Models::Operations::SortOrder), sort_by: T.nilable(Models::Operations::SortBy), order: T.nilable(Models::Operations::Order)).void }
|
|
105
|
-
def initialize(domain: nil, key: nil, link_id: nil, external_id: nil, tenant_id: nil, tag_id: nil, folder_id: nil, partner_tag_id: nil, group_id: nil, partner_id: nil, customer_id: nil, interval: nil, start: nil, end_: nil, country: nil, city: nil, region: nil, continent: nil, device: nil, browser: nil, os: nil, trigger: nil, referer: nil, referer_url: nil, url: nil, utm_source: nil, utm_medium: nil, utm_campaign: nil, utm_term: nil, utm_content: nil, root: nil, sale_type: nil, query: nil, program_id: nil, tag_ids: nil, qr: nil, event: Models::Operations::QueryParamEvent::CLICKS, timezone: 'UTC', page: 1, limit: 100, sort_order: Models::Operations::SortOrder::DESC, sort_by: Models::Operations::SortBy::TIMESTAMP, order: Models::Operations::Order::DESC)
|
|
106
|
+
sig { params(domain: T.nilable(::String), key: T.nilable(::String), link_id: T.nilable(::String), external_id: T.nilable(::String), tenant_id: T.nilable(::String), tag_id: T.nilable(::String), folder_id: T.nilable(::String), partner_tag_id: T.nilable(::String), group_id: T.nilable(::String), partner_id: T.nilable(::String), customer_id: T.nilable(::String), interval: T.nilable(Models::Operations::QueryParamInterval), start: T.nilable(::String), end_: T.nilable(::String), country: T.nilable(::String), city: T.nilable(::String), region: T.nilable(::String), continent: T.nilable(::String), device: T.nilable(::String), browser: T.nilable(::String), os: T.nilable(::String), trigger: T.nilable(::String), event_name: T.nilable(::String), referer: T.nilable(::String), referer_url: T.nilable(::String), url: T.nilable(::String), utm_source: T.nilable(::String), utm_medium: T.nilable(::String), utm_campaign: T.nilable(::String), utm_term: T.nilable(::String), utm_content: T.nilable(::String), root: T.nilable(T::Boolean), sale_type: T.nilable(Models::Operations::QueryParamSaleType), query: T.nilable(::String), program_id: T.nilable(::String), tag_ids: T.nilable(::String), qr: T.nilable(T::Boolean), event: T.nilable(Models::Operations::QueryParamEvent), timezone: T.nilable(::String), page: T.nilable(::Integer), limit: T.nilable(::Integer), sort_order: T.nilable(Models::Operations::SortOrder), sort_by: T.nilable(Models::Operations::SortBy), order: T.nilable(Models::Operations::Order)).void }
|
|
107
|
+
def initialize(domain: nil, key: nil, link_id: nil, external_id: nil, tenant_id: nil, tag_id: nil, folder_id: nil, partner_tag_id: nil, group_id: nil, partner_id: nil, customer_id: nil, interval: nil, start: nil, end_: nil, country: nil, city: nil, region: nil, continent: nil, device: nil, browser: nil, os: nil, trigger: nil, event_name: nil, referer: nil, referer_url: nil, url: nil, utm_source: nil, utm_medium: nil, utm_campaign: nil, utm_term: nil, utm_content: nil, root: nil, sale_type: nil, query: nil, program_id: nil, tag_ids: nil, qr: nil, event: Models::Operations::QueryParamEvent::CLICKS, timezone: 'UTC', page: 1, limit: 100, sort_order: Models::Operations::SortOrder::DESC, sort_by: Models::Operations::SortBy::TIMESTAMP, order: Models::Operations::Order::DESC)
|
|
106
108
|
@domain = domain
|
|
107
109
|
@key = key
|
|
108
110
|
@link_id = link_id
|
|
@@ -125,6 +127,7 @@ module OpenApiSDK
|
|
|
125
127
|
@browser = browser
|
|
126
128
|
@os = os
|
|
127
129
|
@trigger = trigger
|
|
130
|
+
@event_name = event_name
|
|
128
131
|
@referer = referer
|
|
129
132
|
@referer_url = referer_url
|
|
130
133
|
@url = url
|
|
@@ -173,6 +176,7 @@ module OpenApiSDK
|
|
|
173
176
|
return false unless @browser == other.browser
|
|
174
177
|
return false unless @os == other.os
|
|
175
178
|
return false unless @trigger == other.trigger
|
|
179
|
+
return false unless @event_name == other.event_name
|
|
176
180
|
return false unless @referer == other.referer
|
|
177
181
|
return false unless @referer_url == other.referer_url
|
|
178
182
|
return false unless @url == other.url
|
|
@@ -58,6 +58,8 @@ module OpenApiSDK
|
|
|
58
58
|
field :os, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'os', 'style': 'form', 'explode': true } }
|
|
59
59
|
# The trigger to retrieve analytics for. Valid values: qr, link, pageview. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `qr`, `qr,link`, `-qr`. If undefined, returns all trigger types.
|
|
60
60
|
field :trigger, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'trigger', 'style': 'form', 'explode': true } }
|
|
61
|
+
# The conversion event name to retrieve analytics for. Only available for lead and sale events. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `Sign up`, `Sign up,Purchase`, `-Sign up`.
|
|
62
|
+
field :event_name, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'eventName', 'style': 'form', 'explode': true } }
|
|
61
63
|
# The referer hostname to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `google.com`, `google.com,twitter.com`, `-facebook.com`.
|
|
62
64
|
field :referer, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'referer', 'style': 'form', 'explode': true } }
|
|
63
65
|
# The full referer URL to retrieve analytics for. Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples: `https://google.com`, `https://google.com,https://twitter.com`, `-https://spam.com`.
|
|
@@ -93,8 +95,8 @@ module OpenApiSDK
|
|
|
93
95
|
# The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.
|
|
94
96
|
field :timezone, Crystalline::Nilable.new(::String), { 'query_param': { 'field_name': 'timezone', 'style': 'form', 'explode': true } }
|
|
95
97
|
|
|
96
|
-
sig { params(domain: T.nilable(::String), key: T.nilable(::String), link_id: T.nilable(::String), external_id: T.nilable(::String), tenant_id: T.nilable(::String), tag_id: T.nilable(::String), folder_id: T.nilable(::String), partner_tag_id: T.nilable(::String), group_id: T.nilable(::String), partner_id: T.nilable(::String), customer_id: T.nilable(::String), interval: T.nilable(Models::Operations::Interval), start: T.nilable(::String), end_: T.nilable(::String), country: T.nilable(::String), city: T.nilable(::String), region: T.nilable(::String), continent: T.nilable(::String), device: T.nilable(::String), browser: T.nilable(::String), os: T.nilable(::String), trigger: T.nilable(::String), referer: T.nilable(::String), referer_url: T.nilable(::String), url: T.nilable(::String), utm_source: T.nilable(::String), utm_medium: T.nilable(::String), utm_campaign: T.nilable(::String), utm_term: T.nilable(::String), utm_content: T.nilable(::String), root: T.nilable(T::Boolean), sale_type: T.nilable(Models::Operations::SaleType), query: T.nilable(::String), program_id: T.nilable(::String), tag_ids: T.nilable(::String), qr: T.nilable(T::Boolean), event: T.nilable(Models::Operations::Event), group_by: T.nilable(Models::Operations::QueryParamGroupBy), timezone: T.nilable(::String)).void }
|
|
97
|
-
def initialize(domain: nil, key: nil, link_id: nil, external_id: nil, tenant_id: nil, tag_id: nil, folder_id: nil, partner_tag_id: nil, group_id: nil, partner_id: nil, customer_id: nil, interval: nil, start: nil, end_: nil, country: nil, city: nil, region: nil, continent: nil, device: nil, browser: nil, os: nil, trigger: nil, referer: nil, referer_url: nil, url: nil, utm_source: nil, utm_medium: nil, utm_campaign: nil, utm_term: nil, utm_content: nil, root: nil, sale_type: nil, query: nil, program_id: nil, tag_ids: nil, qr: nil, event: Models::Operations::Event::CLICKS, group_by: Models::Operations::QueryParamGroupBy::COUNT, timezone: 'UTC')
|
|
98
|
+
sig { params(domain: T.nilable(::String), key: T.nilable(::String), link_id: T.nilable(::String), external_id: T.nilable(::String), tenant_id: T.nilable(::String), tag_id: T.nilable(::String), folder_id: T.nilable(::String), partner_tag_id: T.nilable(::String), group_id: T.nilable(::String), partner_id: T.nilable(::String), customer_id: T.nilable(::String), interval: T.nilable(Models::Operations::Interval), start: T.nilable(::String), end_: T.nilable(::String), country: T.nilable(::String), city: T.nilable(::String), region: T.nilable(::String), continent: T.nilable(::String), device: T.nilable(::String), browser: T.nilable(::String), os: T.nilable(::String), trigger: T.nilable(::String), event_name: T.nilable(::String), referer: T.nilable(::String), referer_url: T.nilable(::String), url: T.nilable(::String), utm_source: T.nilable(::String), utm_medium: T.nilable(::String), utm_campaign: T.nilable(::String), utm_term: T.nilable(::String), utm_content: T.nilable(::String), root: T.nilable(T::Boolean), sale_type: T.nilable(Models::Operations::SaleType), query: T.nilable(::String), program_id: T.nilable(::String), tag_ids: T.nilable(::String), qr: T.nilable(T::Boolean), event: T.nilable(Models::Operations::Event), group_by: T.nilable(Models::Operations::QueryParamGroupBy), timezone: T.nilable(::String)).void }
|
|
99
|
+
def initialize(domain: nil, key: nil, link_id: nil, external_id: nil, tenant_id: nil, tag_id: nil, folder_id: nil, partner_tag_id: nil, group_id: nil, partner_id: nil, customer_id: nil, interval: nil, start: nil, end_: nil, country: nil, city: nil, region: nil, continent: nil, device: nil, browser: nil, os: nil, trigger: nil, event_name: nil, referer: nil, referer_url: nil, url: nil, utm_source: nil, utm_medium: nil, utm_campaign: nil, utm_term: nil, utm_content: nil, root: nil, sale_type: nil, query: nil, program_id: nil, tag_ids: nil, qr: nil, event: Models::Operations::Event::CLICKS, group_by: Models::Operations::QueryParamGroupBy::COUNT, timezone: 'UTC')
|
|
98
100
|
@domain = domain
|
|
99
101
|
@key = key
|
|
100
102
|
@link_id = link_id
|
|
@@ -117,6 +119,7 @@ module OpenApiSDK
|
|
|
117
119
|
@browser = browser
|
|
118
120
|
@os = os
|
|
119
121
|
@trigger = trigger
|
|
122
|
+
@event_name = event_name
|
|
120
123
|
@referer = referer
|
|
121
124
|
@referer_url = referer_url
|
|
122
125
|
@url = url
|
|
@@ -161,6 +164,7 @@ module OpenApiSDK
|
|
|
161
164
|
return false unless @browser == other.browser
|
|
162
165
|
return false unless @os == other.os
|
|
163
166
|
return false unless @trigger == other.trigger
|
|
167
|
+
return false unless @event_name == other.event_name
|
|
164
168
|
return false unless @referer == other.referer
|
|
165
169
|
return false unless @referer_url == other.referer_url
|
|
166
170
|
return false unless @url == other.url
|
|
@@ -52,6 +52,8 @@ class OpenApiSDK::Models::Operations::RetrieveAnalyticsRequest
|
|
|
52
52
|
def os=(str_); end
|
|
53
53
|
def trigger(); end
|
|
54
54
|
def trigger=(str_); end
|
|
55
|
+
def event_name(); end
|
|
56
|
+
def event_name=(str_); end
|
|
55
57
|
def referer(); end
|
|
56
58
|
def referer=(str_); end
|
|
57
59
|
def referer_url(); end
|
|
@@ -9,7 +9,11 @@
|
|
|
9
9
|
module OpenApiSDK
|
|
10
10
|
module Models
|
|
11
11
|
module Operations
|
|
12
|
-
# Type - Filter the list of commissions by type.
|
|
12
|
+
# Type - Filter the list of commissions by type.
|
|
13
|
+
# Supports advanced filtering: single value, multiple values (comma-separated), or exclusion (prefix with `-`). Examples:
|
|
14
|
+
# - "sale"
|
|
15
|
+
# - "sale,lead"
|
|
16
|
+
# - "-click"
|
|
13
17
|
class Type < T::Enum
|
|
14
18
|
enums do
|
|
15
19
|
CLICK = new('click')
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
2
|
+
# Generated under the AGPL-3.0-only license.
|
|
3
|
+
# SPDX-License-Identifier: AGPL-3.0-only
|
|
4
|
+
|
|
5
|
+
# typed: true
|
|
6
|
+
# frozen_string_literal: true
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
module OpenApiSDK
|
|
10
|
+
module Models
|
|
11
|
+
module Shared
|
|
12
|
+
|
|
13
|
+
class AnalyticsEventNames
|
|
14
|
+
extend T::Sig
|
|
15
|
+
include Crystalline::MetadataFields
|
|
16
|
+
|
|
17
|
+
# The name of the conversion event (lead or sale)
|
|
18
|
+
field :event_name, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('eventName'), required: true } }
|
|
19
|
+
# The number of clicks from this event name
|
|
20
|
+
field :clicks, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('clicks') } }
|
|
21
|
+
# The number of leads from this event name
|
|
22
|
+
field :leads, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('leads') } }
|
|
23
|
+
# The number of sales from this event name
|
|
24
|
+
field :sales, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('sales') } }
|
|
25
|
+
# The total amount of sales from this event name, in cents
|
|
26
|
+
field :sale_amount, Crystalline::Nilable.new(::Float), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('saleAmount') } }
|
|
27
|
+
|
|
28
|
+
sig { params(event_name: ::String, clicks: T.nilable(::Float), leads: T.nilable(::Float), sales: T.nilable(::Float), sale_amount: T.nilable(::Float)).void }
|
|
29
|
+
def initialize(event_name:, clicks: 0.0, leads: 0.0, sales: 0.0, sale_amount: 0.0)
|
|
30
|
+
@event_name = event_name
|
|
31
|
+
@clicks = clicks
|
|
32
|
+
@leads = leads
|
|
33
|
+
@sales = sales
|
|
34
|
+
@sale_amount = sale_amount
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
sig { params(other: T.untyped).returns(T::Boolean) }
|
|
38
|
+
def ==(other)
|
|
39
|
+
return false unless other.is_a? self.class
|
|
40
|
+
return false unless @event_name == other.event_name
|
|
41
|
+
return false unless @clicks == other.clicks
|
|
42
|
+
return false unless @leads == other.leads
|
|
43
|
+
return false unless @sales == other.sales
|
|
44
|
+
return false unless @sale_amount == other.sale_amount
|
|
45
|
+
true
|
|
46
|
+
end
|
|
47
|
+
end
|
|
48
|
+
end
|
|
49
|
+
end
|
|
50
|
+
end
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# typed: true
|
|
2
|
+
# frozen_string_literal: true
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
class OpenApiSDK::Models::Shared::AnalyticsEventNames
|
|
6
|
+
extend ::Crystalline::MetadataFields::ClassMethods
|
|
7
|
+
end
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
class OpenApiSDK::Models::Shared::AnalyticsEventNames
|
|
11
|
+
def event_name(); end
|
|
12
|
+
def event_name=(str_); end
|
|
13
|
+
def clicks(); end
|
|
14
|
+
def clicks=(str_); end
|
|
15
|
+
def leads(); end
|
|
16
|
+
def leads=(str_); end
|
|
17
|
+
def sales(); end
|
|
18
|
+
def sales=(str_); end
|
|
19
|
+
def sale_amount(); end
|
|
20
|
+
def sale_amount=(str_); end
|
|
21
|
+
end
|
|
@@ -22,6 +22,7 @@ module OpenApiSDK
|
|
|
22
22
|
autoload :AnalyticsCount, 'open_api_sdk/models/shared/analyticscount.rb'
|
|
23
23
|
autoload :AnalyticsCountries, 'open_api_sdk/models/shared/analyticscountries.rb'
|
|
24
24
|
autoload :AnalyticsDevices, 'open_api_sdk/models/shared/analyticsdevices.rb'
|
|
25
|
+
autoload :AnalyticsEventNames, 'open_api_sdk/models/shared/analyticseventnames.rb'
|
|
25
26
|
autoload :AnalyticsOS, 'open_api_sdk/models/shared/analyticsos.rb'
|
|
26
27
|
autoload :AnalyticsRefererUrls, 'open_api_sdk/models/shared/analyticsrefererurls.rb'
|
|
27
28
|
autoload :AnalyticsReferers, 'open_api_sdk/models/shared/analyticsreferers.rb'
|
|
@@ -90,9 +90,9 @@ module OpenApiSDK
|
|
|
90
90
|
end
|
|
91
91
|
@language = 'ruby'
|
|
92
92
|
@openapi_doc_version = '0.0.1'
|
|
93
|
-
@sdk_version = '0.12.
|
|
93
|
+
@sdk_version = '0.12.16'
|
|
94
94
|
@gen_version = '2.933.0'
|
|
95
|
-
@user_agent = 'speakeasy-sdk/ruby 0.12.
|
|
95
|
+
@user_agent = 'speakeasy-sdk/ruby 0.12.16 2.933.0 0.0.1 dub'
|
|
96
96
|
end
|
|
97
97
|
|
|
98
98
|
sig { returns([String, T::Hash[Symbol, String]]) }
|
metadata
CHANGED
|
@@ -1,14 +1,14 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: dub
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.12.
|
|
4
|
+
version: 0.12.16
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Dub
|
|
8
8
|
autorequire:
|
|
9
9
|
bindir: bin
|
|
10
10
|
cert_chain: []
|
|
11
|
-
date: 2026-08-
|
|
11
|
+
date: 2026-08-30 00:00:00.000000000 Z
|
|
12
12
|
dependencies:
|
|
13
13
|
- !ruby/object:Gem::Dependency
|
|
14
14
|
name: base64
|
|
@@ -982,6 +982,8 @@ files:
|
|
|
982
982
|
- lib/open_api_sdk/models/shared/analyticscountries.rbi
|
|
983
983
|
- lib/open_api_sdk/models/shared/analyticsdevices.rb
|
|
984
984
|
- lib/open_api_sdk/models/shared/analyticsdevices.rbi
|
|
985
|
+
- lib/open_api_sdk/models/shared/analyticseventnames.rb
|
|
986
|
+
- lib/open_api_sdk/models/shared/analyticseventnames.rbi
|
|
985
987
|
- lib/open_api_sdk/models/shared/analyticsos.rb
|
|
986
988
|
- lib/open_api_sdk/models/shared/analyticsos.rbi
|
|
987
989
|
- lib/open_api_sdk/models/shared/analyticsreferers.rb
|