dub 0.2.2.pre.alpha.20 → 0.2.2.pre.alpha.22
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/lib/open_api_sdk/models/operations/createlink_requestbody.rb +5 -2
- data/lib/open_api_sdk/models/operations/event.rb +1 -1
- data/lib/open_api_sdk/models/operations/getqrcode_request.rb +8 -2
- data/lib/open_api_sdk/models/operations/groupby.rb +3 -2
- data/lib/open_api_sdk/models/operations/listevents_request.rb +6 -3
- data/lib/open_api_sdk/models/operations/queryparam_trigger.rb +18 -0
- data/lib/open_api_sdk/models/operations/requestbody.rb +5 -2
- data/lib/open_api_sdk/models/operations/retrieveanalytics_request.rb +8 -5
- data/lib/open_api_sdk/models/operations/trigger.rb +18 -0
- data/lib/open_api_sdk/models/operations/updatelink_requestbody.rb +5 -2
- data/lib/open_api_sdk/models/operations/upsertlink_requestbody.rb +5 -2
- data/lib/open_api_sdk/models/operations.rb +2 -0
- data/lib/open_api_sdk/models/shared/link.rb +6 -3
- data/lib/open_api_sdk/models/shared/linkschema.rb +6 -3
- data/lib/open_api_sdk/models/shared/workspaceschema.rb +5 -2
- data/lib/open_api_sdk/sdkconfiguration.rb +3 -3
- 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: ccb1c86c2e65464aab0473ef98e3404cefab59caddccb8cb79ad13444997efe6
|
4
|
+
data.tar.gz: 9881d34f2aef4350e829690a160b680b6886d9d394335cffc46a269e8c8c2987
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: db8ba20e8211ccd63b4bda1343133d0cc37eecd8592171306a9776918e6651ebd32c270159b1ef56f48ef82ab219653c6c570647e9be31295144f4caa48f1ec6
|
7
|
+
data.tar.gz: baa5c15fa14a6401e01b43d7c7e74da09e6875aa6e8b8a7e65ea7030b84db1e9794c8ccb79671264fa60d6729eb9a6ed0b726c55bbdc54e4117492f31625a0a7
|
@@ -33,6 +33,8 @@ module OpenApiSDK
|
|
33
33
|
field :external_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
|
34
34
|
# Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`.
|
35
35
|
field :geo, T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('geo') } }
|
36
|
+
# The identifier of the short link that is unique across your workspace. If set, it can be used to identify your short link for client-side click tracking.
|
37
|
+
field :identifier, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('identifier') } }
|
36
38
|
# The custom link preview image (og:image). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
|
37
39
|
field :image, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
|
38
40
|
# The iOS destination URL for the short link for iOS device targeting.
|
@@ -77,8 +79,8 @@ module OpenApiSDK
|
|
77
79
|
field :video, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('video') } }
|
78
80
|
|
79
81
|
|
80
|
-
sig { params(url: ::String, android: T.nilable(::String), archived: T.nilable(T::Boolean), comments: T.nilable(::String), description: T.nilable(::String), do_index: T.nilable(T::Boolean), domain: T.nilable(::String), expired_url: T.nilable(::String), expires_at: T.nilable(::String), external_id: T.nilable(::String), geo: T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), image: T.nilable(::String), ios: T.nilable(::String), key: T.nilable(::String), password: T.nilable(::String), prefix: T.nilable(::String), proxy: T.nilable(T::Boolean), public_stats: T.nilable(T::Boolean), ref: T.nilable(::String), rewrite: T.nilable(T::Boolean), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), title: T.nilable(::String), track_conversion: T.nilable(T::Boolean), utm_campaign: T.nilable(::String), utm_content: T.nilable(::String), utm_medium: T.nilable(::String), utm_source: T.nilable(::String), utm_term: T.nilable(::String), video: T.nilable(::String)).void }
|
81
|
-
def initialize(url: nil, android: nil, archived: nil, comments: nil, description: nil, do_index: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, image: nil, ios: nil, key: nil, password: nil, prefix: nil, proxy: nil, public_stats: nil, ref: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, title: nil, track_conversion: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil)
|
82
|
+
sig { params(url: ::String, android: T.nilable(::String), archived: T.nilable(T::Boolean), comments: T.nilable(::String), description: T.nilable(::String), do_index: T.nilable(T::Boolean), domain: T.nilable(::String), expired_url: T.nilable(::String), expires_at: T.nilable(::String), external_id: T.nilable(::String), geo: T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), identifier: T.nilable(::String), image: T.nilable(::String), ios: T.nilable(::String), key: T.nilable(::String), password: T.nilable(::String), prefix: T.nilable(::String), proxy: T.nilable(T::Boolean), public_stats: T.nilable(T::Boolean), ref: T.nilable(::String), rewrite: T.nilable(T::Boolean), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), title: T.nilable(::String), track_conversion: T.nilable(T::Boolean), utm_campaign: T.nilable(::String), utm_content: T.nilable(::String), utm_medium: T.nilable(::String), utm_source: T.nilable(::String), utm_term: T.nilable(::String), video: T.nilable(::String)).void }
|
83
|
+
def initialize(url: nil, android: nil, archived: nil, comments: nil, description: nil, do_index: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, identifier: nil, image: nil, ios: nil, key: nil, password: nil, prefix: nil, proxy: nil, public_stats: nil, ref: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, title: nil, track_conversion: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil)
|
82
84
|
@url = url
|
83
85
|
@android = android
|
84
86
|
@archived = archived
|
@@ -90,6 +92,7 @@ module OpenApiSDK
|
|
90
92
|
@expires_at = expires_at
|
91
93
|
@external_id = external_id
|
92
94
|
@geo = geo
|
95
|
+
@identifier = identifier
|
93
96
|
@image = image
|
94
97
|
@ios = ios
|
95
98
|
@key = key
|
@@ -17,21 +17,27 @@ module OpenApiSDK
|
|
17
17
|
field :bg_color, T.nilable(::String), { 'query_param': { 'field_name': 'bgColor', 'style': 'form', 'explode': true } }
|
18
18
|
# The foreground color of the QR code in hex format. Defaults to `#000000` if not provided.
|
19
19
|
field :fg_color, T.nilable(::String), { 'query_param': { 'field_name': 'fgColor', 'style': 'form', 'explode': true } }
|
20
|
+
# Whether to hide the logo in the QR code. Can only be used with a paid plan on Dub.co.
|
21
|
+
field :hide_logo, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'hideLogo', 'style': 'form', 'explode': true } }
|
20
22
|
# Whether to include a margin around the QR code. Defaults to `false` if not provided.
|
21
23
|
field :include_margin, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'includeMargin', 'style': 'form', 'explode': true } }
|
22
24
|
# The level of error correction to use for the QR code. Defaults to `L` if not provided.
|
23
25
|
field :level, T.nilable(::OpenApiSDK::Operations::Level), { 'query_param': { 'field_name': 'level', 'style': 'form', 'explode': true } }
|
26
|
+
# The logo to include in the QR code. Can only be used with a paid plan on Dub.co.
|
27
|
+
field :logo, T.nilable(::String), { 'query_param': { 'field_name': 'logo', 'style': 'form', 'explode': true } }
|
24
28
|
# The size of the QR code in pixels. Defaults to `600` if not provided.
|
25
29
|
field :size, T.nilable(::Float), { 'query_param': { 'field_name': 'size', 'style': 'form', 'explode': true } }
|
26
30
|
|
27
31
|
|
28
|
-
sig { params(url: ::String, bg_color: T.nilable(::String), fg_color: T.nilable(::String), include_margin: T.nilable(T::Boolean), level: T.nilable(::OpenApiSDK::Operations::Level), size: T.nilable(::Float)).void }
|
29
|
-
def initialize(url: nil, bg_color: nil, fg_color: nil, include_margin: nil, level: nil, size: nil)
|
32
|
+
sig { params(url: ::String, bg_color: T.nilable(::String), fg_color: T.nilable(::String), hide_logo: T.nilable(T::Boolean), include_margin: T.nilable(T::Boolean), level: T.nilable(::OpenApiSDK::Operations::Level), logo: T.nilable(::String), size: T.nilable(::Float)).void }
|
33
|
+
def initialize(url: nil, bg_color: nil, fg_color: nil, hide_logo: nil, include_margin: nil, level: nil, logo: nil, size: nil)
|
30
34
|
@url = url
|
31
35
|
@bg_color = bg_color
|
32
36
|
@fg_color = fg_color
|
37
|
+
@hide_logo = hide_logo
|
33
38
|
@include_margin = include_margin
|
34
39
|
@level = level
|
40
|
+
@logo = logo
|
35
41
|
@size = size
|
36
42
|
end
|
37
43
|
end
|
@@ -7,7 +7,7 @@
|
|
7
7
|
module OpenApiSDK
|
8
8
|
module Operations
|
9
9
|
|
10
|
-
# GroupBy - The parameter to group the analytics data points by. Defaults to
|
10
|
+
# GroupBy - The parameter to group the analytics data points by. Defaults to `count` if undefined. Note that `trigger` is deprecated (use `triggers` instead), but kept for backwards compatibility.
|
11
11
|
class GroupBy < T::Enum
|
12
12
|
enums do
|
13
13
|
COUNT = new('count')
|
@@ -18,11 +18,12 @@ module OpenApiSDK
|
|
18
18
|
DEVICES = new('devices')
|
19
19
|
BROWSERS = new('browsers')
|
20
20
|
OS = new('os')
|
21
|
+
TRIGGER = new('trigger')
|
22
|
+
TRIGGERS = new('triggers')
|
21
23
|
REFERERS = new('referers')
|
22
24
|
REFERER_URLS = new('referer_urls')
|
23
25
|
TOP_LINKS = new('top_links')
|
24
26
|
TOP_URLS = new('top_urls')
|
25
|
-
TRIGGER = new('trigger')
|
26
27
|
end
|
27
28
|
end
|
28
29
|
end
|
@@ -43,7 +43,7 @@ module OpenApiSDK
|
|
43
43
|
field :os, T.nilable(::String), { 'query_param': { 'field_name': 'os', 'style': 'form', 'explode': true } }
|
44
44
|
|
45
45
|
field :page, T.nilable(::Float), { 'query_param': { 'field_name': 'page', 'style': 'form', 'explode': true } }
|
46
|
-
# Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.
|
46
|
+
# Deprecated. Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.
|
47
47
|
field :qr, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'qr', 'style': 'form', 'explode': true } }
|
48
48
|
# The referer to retrieve analytics for.
|
49
49
|
field :referer, T.nilable(::String), { 'query_param': { 'field_name': 'referer', 'style': 'form', 'explode': true } }
|
@@ -59,12 +59,14 @@ module OpenApiSDK
|
|
59
59
|
field :tag_id, T.nilable(::String), { 'query_param': { 'field_name': 'tagId', 'style': 'form', 'explode': true } }
|
60
60
|
# The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.
|
61
61
|
field :timezone, T.nilable(::String), { 'query_param': { 'field_name': 'timezone', 'style': 'form', 'explode': true } }
|
62
|
+
# The trigger to retrieve analytics for. If undefined, return both QR and link clicks.
|
63
|
+
field :trigger, T.nilable(::OpenApiSDK::Operations::QueryParamTrigger), { 'query_param': { 'field_name': 'trigger', 'style': 'form', 'explode': true } }
|
62
64
|
# The URL to retrieve analytics for.
|
63
65
|
field :url, T.nilable(::String), { 'query_param': { 'field_name': 'url', 'style': 'form', 'explode': true } }
|
64
66
|
|
65
67
|
|
66
|
-
sig { params(browser: T.nilable(::String), city: T.nilable(::String), continent: T.nilable(::OpenApiSDK::Shared::ContinentCode), country: T.nilable(::OpenApiSDK::Shared::CountryCode), device: T.nilable(::String), domain: T.nilable(::String), end_: T.nilable(::String), event: T.nilable(::OpenApiSDK::Operations::QueryParamEvent), external_id: T.nilable(::String), interval: T.nilable(::OpenApiSDK::Operations::QueryParamInterval), key: T.nilable(::String), limit: T.nilable(::Float), link_id: T.nilable(::String), order: T.nilable(::OpenApiSDK::Operations::Order), os: T.nilable(::String), page: T.nilable(::Float), qr: T.nilable(T::Boolean), referer: T.nilable(::String), referer_url: T.nilable(::String), root: T.nilable(T::Boolean), sort_by: T.nilable(::OpenApiSDK::Operations::SortBy), start: T.nilable(::String), tag_id: T.nilable(::String), timezone: T.nilable(::String), url: T.nilable(::String)).void }
|
67
|
-
def initialize(browser: nil, city: nil, continent: nil, country: nil, device: nil, domain: nil, end_: nil, event: nil, external_id: nil, interval: nil, key: nil, limit: nil, link_id: nil, order: nil, os: nil, page: nil, qr: nil, referer: nil, referer_url: nil, root: nil, sort_by: nil, start: nil, tag_id: nil, timezone: nil, url: nil)
|
68
|
+
sig { params(browser: T.nilable(::String), city: T.nilable(::String), continent: T.nilable(::OpenApiSDK::Shared::ContinentCode), country: T.nilable(::OpenApiSDK::Shared::CountryCode), device: T.nilable(::String), domain: T.nilable(::String), end_: T.nilable(::String), event: T.nilable(::OpenApiSDK::Operations::QueryParamEvent), external_id: T.nilable(::String), interval: T.nilable(::OpenApiSDK::Operations::QueryParamInterval), key: T.nilable(::String), limit: T.nilable(::Float), link_id: T.nilable(::String), order: T.nilable(::OpenApiSDK::Operations::Order), os: T.nilable(::String), page: T.nilable(::Float), qr: T.nilable(T::Boolean), referer: T.nilable(::String), referer_url: T.nilable(::String), root: T.nilable(T::Boolean), sort_by: T.nilable(::OpenApiSDK::Operations::SortBy), start: T.nilable(::String), tag_id: T.nilable(::String), timezone: T.nilable(::String), trigger: T.nilable(::OpenApiSDK::Operations::QueryParamTrigger), url: T.nilable(::String)).void }
|
69
|
+
def initialize(browser: nil, city: nil, continent: nil, country: nil, device: nil, domain: nil, end_: nil, event: nil, external_id: nil, interval: nil, key: nil, limit: nil, link_id: nil, order: nil, os: nil, page: nil, qr: nil, referer: nil, referer_url: nil, root: nil, sort_by: nil, start: nil, tag_id: nil, timezone: nil, trigger: nil, url: nil)
|
68
70
|
@browser = browser
|
69
71
|
@city = city
|
70
72
|
@continent = continent
|
@@ -89,6 +91,7 @@ module OpenApiSDK
|
|
89
91
|
@start = start
|
90
92
|
@tag_id = tag_id
|
91
93
|
@timezone = timezone
|
94
|
+
@trigger = trigger
|
92
95
|
@url = url
|
93
96
|
end
|
94
97
|
end
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
2
|
+
|
3
|
+
# typed: true
|
4
|
+
# frozen_string_literal: true
|
5
|
+
|
6
|
+
|
7
|
+
module OpenApiSDK
|
8
|
+
module Operations
|
9
|
+
|
10
|
+
# QueryParamTrigger - The trigger to retrieve analytics for. If undefined, return both QR and link clicks.
|
11
|
+
class QueryParamTrigger < T::Enum
|
12
|
+
enums do
|
13
|
+
QR = new('qr')
|
14
|
+
LINK = new('link')
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -33,6 +33,8 @@ module OpenApiSDK
|
|
33
33
|
field :external_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
|
34
34
|
# Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`.
|
35
35
|
field :geo, T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('geo') } }
|
36
|
+
# The identifier of the short link that is unique across your workspace. If set, it can be used to identify your short link for client-side click tracking.
|
37
|
+
field :identifier, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('identifier') } }
|
36
38
|
# The custom link preview image (og:image). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
|
37
39
|
field :image, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
|
38
40
|
# The iOS destination URL for the short link for iOS device targeting.
|
@@ -77,8 +79,8 @@ module OpenApiSDK
|
|
77
79
|
field :video, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('video') } }
|
78
80
|
|
79
81
|
|
80
|
-
sig { params(url: ::String, android: T.nilable(::String), archived: T.nilable(T::Boolean), comments: T.nilable(::String), description: T.nilable(::String), do_index: T.nilable(T::Boolean), domain: T.nilable(::String), expired_url: T.nilable(::String), expires_at: T.nilable(::String), external_id: T.nilable(::String), geo: T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), image: T.nilable(::String), ios: T.nilable(::String), key: T.nilable(::String), password: T.nilable(::String), prefix: T.nilable(::String), proxy: T.nilable(T::Boolean), public_stats: T.nilable(T::Boolean), ref: T.nilable(::String), rewrite: T.nilable(T::Boolean), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), title: T.nilable(::String), track_conversion: T.nilable(T::Boolean), utm_campaign: T.nilable(::String), utm_content: T.nilable(::String), utm_medium: T.nilable(::String), utm_source: T.nilable(::String), utm_term: T.nilable(::String), video: T.nilable(::String)).void }
|
81
|
-
def initialize(url: nil, android: nil, archived: nil, comments: nil, description: nil, do_index: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, image: nil, ios: nil, key: nil, password: nil, prefix: nil, proxy: nil, public_stats: nil, ref: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, title: nil, track_conversion: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil)
|
82
|
+
sig { params(url: ::String, android: T.nilable(::String), archived: T.nilable(T::Boolean), comments: T.nilable(::String), description: T.nilable(::String), do_index: T.nilable(T::Boolean), domain: T.nilable(::String), expired_url: T.nilable(::String), expires_at: T.nilable(::String), external_id: T.nilable(::String), geo: T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), identifier: T.nilable(::String), image: T.nilable(::String), ios: T.nilable(::String), key: T.nilable(::String), password: T.nilable(::String), prefix: T.nilable(::String), proxy: T.nilable(T::Boolean), public_stats: T.nilable(T::Boolean), ref: T.nilable(::String), rewrite: T.nilable(T::Boolean), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), title: T.nilable(::String), track_conversion: T.nilable(T::Boolean), utm_campaign: T.nilable(::String), utm_content: T.nilable(::String), utm_medium: T.nilable(::String), utm_source: T.nilable(::String), utm_term: T.nilable(::String), video: T.nilable(::String)).void }
|
83
|
+
def initialize(url: nil, android: nil, archived: nil, comments: nil, description: nil, do_index: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, identifier: nil, image: nil, ios: nil, key: nil, password: nil, prefix: nil, proxy: nil, public_stats: nil, ref: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, title: nil, track_conversion: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil)
|
82
84
|
@url = url
|
83
85
|
@android = android
|
84
86
|
@archived = archived
|
@@ -90,6 +92,7 @@ module OpenApiSDK
|
|
90
92
|
@expires_at = expires_at
|
91
93
|
@external_id = external_id
|
92
94
|
@geo = geo
|
95
|
+
@identifier = identifier
|
93
96
|
@image = image
|
94
97
|
@ios = ios
|
95
98
|
@key = key
|
@@ -25,11 +25,11 @@ module OpenApiSDK
|
|
25
25
|
field :domain, T.nilable(::String), { 'query_param': { 'field_name': 'domain', 'style': 'form', 'explode': true } }
|
26
26
|
# The end date and time when to retrieve analytics from. If not provided, defaults to the current date.
|
27
27
|
field :end_, T.nilable(::String), { 'query_param': { 'field_name': 'end', 'style': 'form', 'explode': true } }
|
28
|
-
# The type of event to retrieve analytics for. Defaults to
|
28
|
+
# The type of event to retrieve analytics for. Defaults to `clicks`.
|
29
29
|
field :event, T.nilable(::OpenApiSDK::Operations::Event), { 'query_param': { 'field_name': 'event', 'style': 'form', 'explode': true } }
|
30
30
|
# This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.
|
31
31
|
field :external_id, T.nilable(::String), { 'query_param': { 'field_name': 'externalId', 'style': 'form', 'explode': true } }
|
32
|
-
# The parameter to group the analytics data points by. Defaults to
|
32
|
+
# The parameter to group the analytics data points by. Defaults to `count` if undefined. Note that `trigger` is deprecated (use `triggers` instead), but kept for backwards compatibility.
|
33
33
|
field :group_by, T.nilable(::OpenApiSDK::Operations::GroupBy), { 'query_param': { 'field_name': 'groupBy', 'style': 'form', 'explode': true } }
|
34
34
|
# The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
|
35
35
|
field :interval, T.nilable(::OpenApiSDK::Operations::Interval), { 'query_param': { 'field_name': 'interval', 'style': 'form', 'explode': true } }
|
@@ -39,7 +39,7 @@ module OpenApiSDK
|
|
39
39
|
field :link_id, T.nilable(::String), { 'query_param': { 'field_name': 'linkId', 'style': 'form', 'explode': true } }
|
40
40
|
# The OS to retrieve analytics for.
|
41
41
|
field :os, T.nilable(::String), { 'query_param': { 'field_name': 'os', 'style': 'form', 'explode': true } }
|
42
|
-
# Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.
|
42
|
+
# Deprecated. Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.
|
43
43
|
field :qr, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'qr', 'style': 'form', 'explode': true } }
|
44
44
|
# The referer to retrieve analytics for.
|
45
45
|
field :referer, T.nilable(::String), { 'query_param': { 'field_name': 'referer', 'style': 'form', 'explode': true } }
|
@@ -53,12 +53,14 @@ module OpenApiSDK
|
|
53
53
|
field :tag_id, T.nilable(::String), { 'query_param': { 'field_name': 'tagId', 'style': 'form', 'explode': true } }
|
54
54
|
# The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.
|
55
55
|
field :timezone, T.nilable(::String), { 'query_param': { 'field_name': 'timezone', 'style': 'form', 'explode': true } }
|
56
|
+
# The trigger to retrieve analytics for. If undefined, return both QR and link clicks.
|
57
|
+
field :trigger, T.nilable(::OpenApiSDK::Operations::Trigger), { 'query_param': { 'field_name': 'trigger', 'style': 'form', 'explode': true } }
|
56
58
|
# The URL to retrieve analytics for.
|
57
59
|
field :url, T.nilable(::String), { 'query_param': { 'field_name': 'url', 'style': 'form', 'explode': true } }
|
58
60
|
|
59
61
|
|
60
|
-
sig { params(browser: T.nilable(::String), city: T.nilable(::String), continent: T.nilable(::OpenApiSDK::Shared::ContinentCode), country: T.nilable(::OpenApiSDK::Shared::CountryCode), device: T.nilable(::String), domain: T.nilable(::String), end_: T.nilable(::String), event: T.nilable(::OpenApiSDK::Operations::Event), external_id: T.nilable(::String), group_by: T.nilable(::OpenApiSDK::Operations::GroupBy), interval: T.nilable(::OpenApiSDK::Operations::Interval), key: T.nilable(::String), link_id: T.nilable(::String), os: T.nilable(::String), qr: T.nilable(T::Boolean), referer: T.nilable(::String), referer_url: T.nilable(::String), root: T.nilable(T::Boolean), start: T.nilable(::String), tag_id: T.nilable(::String), timezone: T.nilable(::String), url: T.nilable(::String)).void }
|
61
|
-
def initialize(browser: nil, city: nil, continent: nil, country: nil, device: nil, domain: nil, end_: nil, event: nil, external_id: nil, group_by: nil, interval: nil, key: nil, link_id: nil, os: nil, qr: nil, referer: nil, referer_url: nil, root: nil, start: nil, tag_id: nil, timezone: nil, url: nil)
|
62
|
+
sig { params(browser: T.nilable(::String), city: T.nilable(::String), continent: T.nilable(::OpenApiSDK::Shared::ContinentCode), country: T.nilable(::OpenApiSDK::Shared::CountryCode), device: T.nilable(::String), domain: T.nilable(::String), end_: T.nilable(::String), event: T.nilable(::OpenApiSDK::Operations::Event), external_id: T.nilable(::String), group_by: T.nilable(::OpenApiSDK::Operations::GroupBy), interval: T.nilable(::OpenApiSDK::Operations::Interval), key: T.nilable(::String), link_id: T.nilable(::String), os: T.nilable(::String), qr: T.nilable(T::Boolean), referer: T.nilable(::String), referer_url: T.nilable(::String), root: T.nilable(T::Boolean), start: T.nilable(::String), tag_id: T.nilable(::String), timezone: T.nilable(::String), trigger: T.nilable(::OpenApiSDK::Operations::Trigger), url: T.nilable(::String)).void }
|
63
|
+
def initialize(browser: nil, city: nil, continent: nil, country: nil, device: nil, domain: nil, end_: nil, event: nil, external_id: nil, group_by: nil, interval: nil, key: nil, link_id: nil, os: nil, qr: nil, referer: nil, referer_url: nil, root: nil, start: nil, tag_id: nil, timezone: nil, trigger: nil, url: nil)
|
62
64
|
@browser = browser
|
63
65
|
@city = city
|
64
66
|
@continent = continent
|
@@ -80,6 +82,7 @@ module OpenApiSDK
|
|
80
82
|
@start = start
|
81
83
|
@tag_id = tag_id
|
82
84
|
@timezone = timezone
|
85
|
+
@trigger = trigger
|
83
86
|
@url = url
|
84
87
|
end
|
85
88
|
end
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
2
|
+
|
3
|
+
# typed: true
|
4
|
+
# frozen_string_literal: true
|
5
|
+
|
6
|
+
|
7
|
+
module OpenApiSDK
|
8
|
+
module Operations
|
9
|
+
|
10
|
+
# Trigger - The trigger to retrieve analytics for. If undefined, return both QR and link clicks.
|
11
|
+
class Trigger < T::Enum
|
12
|
+
enums do
|
13
|
+
QR = new('qr')
|
14
|
+
LINK = new('link')
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -31,6 +31,8 @@ module OpenApiSDK
|
|
31
31
|
field :external_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
|
32
32
|
# Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`.
|
33
33
|
field :geo, T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('geo') } }
|
34
|
+
# The identifier of the short link that is unique across your workspace. If set, it can be used to identify your short link for client-side click tracking.
|
35
|
+
field :identifier, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('identifier') } }
|
34
36
|
# The custom link preview image (og:image). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
|
35
37
|
field :image, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
|
36
38
|
# The iOS destination URL for the short link for iOS device targeting.
|
@@ -77,8 +79,8 @@ module OpenApiSDK
|
|
77
79
|
field :video, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('video') } }
|
78
80
|
|
79
81
|
|
80
|
-
sig { params(android: T.nilable(::String), archived: T.nilable(T::Boolean), comments: T.nilable(::String), description: T.nilable(::String), do_index: T.nilable(T::Boolean), domain: T.nilable(::String), expired_url: T.nilable(::String), expires_at: T.nilable(::String), external_id: T.nilable(::String), geo: T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), image: T.nilable(::String), ios: T.nilable(::String), key: T.nilable(::String), password: T.nilable(::String), prefix: T.nilable(::String), proxy: T.nilable(T::Boolean), public_stats: T.nilable(T::Boolean), ref: T.nilable(::String), rewrite: T.nilable(T::Boolean), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), title: T.nilable(::String), track_conversion: T.nilable(T::Boolean), url: T.nilable(::String), utm_campaign: T.nilable(::String), utm_content: T.nilable(::String), utm_medium: T.nilable(::String), utm_source: T.nilable(::String), utm_term: T.nilable(::String), video: T.nilable(::String)).void }
|
81
|
-
def initialize(android: nil, archived: nil, comments: nil, description: nil, do_index: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, image: nil, ios: nil, key: nil, password: nil, prefix: nil, proxy: nil, public_stats: nil, ref: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, title: nil, track_conversion: nil, url: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil)
|
82
|
+
sig { params(android: T.nilable(::String), archived: T.nilable(T::Boolean), comments: T.nilable(::String), description: T.nilable(::String), do_index: T.nilable(T::Boolean), domain: T.nilable(::String), expired_url: T.nilable(::String), expires_at: T.nilable(::String), external_id: T.nilable(::String), geo: T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), identifier: T.nilable(::String), image: T.nilable(::String), ios: T.nilable(::String), key: T.nilable(::String), password: T.nilable(::String), prefix: T.nilable(::String), proxy: T.nilable(T::Boolean), public_stats: T.nilable(T::Boolean), ref: T.nilable(::String), rewrite: T.nilable(T::Boolean), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), title: T.nilable(::String), track_conversion: T.nilable(T::Boolean), url: T.nilable(::String), utm_campaign: T.nilable(::String), utm_content: T.nilable(::String), utm_medium: T.nilable(::String), utm_source: T.nilable(::String), utm_term: T.nilable(::String), video: T.nilable(::String)).void }
|
83
|
+
def initialize(android: nil, archived: nil, comments: nil, description: nil, do_index: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, identifier: nil, image: nil, ios: nil, key: nil, password: nil, prefix: nil, proxy: nil, public_stats: nil, ref: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, title: nil, track_conversion: nil, url: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil)
|
82
84
|
@android = android
|
83
85
|
@archived = archived
|
84
86
|
@comments = comments
|
@@ -89,6 +91,7 @@ module OpenApiSDK
|
|
89
91
|
@expires_at = expires_at
|
90
92
|
@external_id = external_id
|
91
93
|
@geo = geo
|
94
|
+
@identifier = identifier
|
92
95
|
@image = image
|
93
96
|
@ios = ios
|
94
97
|
@key = key
|
@@ -33,6 +33,8 @@ module OpenApiSDK
|
|
33
33
|
field :external_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
|
34
34
|
# Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`.
|
35
35
|
field :geo, T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('geo') } }
|
36
|
+
# The identifier of the short link that is unique across your workspace. If set, it can be used to identify your short link for client-side click tracking.
|
37
|
+
field :identifier, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('identifier') } }
|
36
38
|
# The custom link preview image (og:image). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
|
37
39
|
field :image, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
|
38
40
|
# The iOS destination URL for the short link for iOS device targeting.
|
@@ -77,8 +79,8 @@ module OpenApiSDK
|
|
77
79
|
field :video, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('video') } }
|
78
80
|
|
79
81
|
|
80
|
-
sig { params(url: ::String, android: T.nilable(::String), archived: T.nilable(T::Boolean), comments: T.nilable(::String), description: T.nilable(::String), do_index: T.nilable(T::Boolean), domain: T.nilable(::String), expired_url: T.nilable(::String), expires_at: T.nilable(::String), external_id: T.nilable(::String), geo: T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), image: T.nilable(::String), ios: T.nilable(::String), key: T.nilable(::String), password: T.nilable(::String), prefix: T.nilable(::String), proxy: T.nilable(T::Boolean), public_stats: T.nilable(T::Boolean), ref: T.nilable(::String), rewrite: T.nilable(T::Boolean), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), title: T.nilable(::String), track_conversion: T.nilable(T::Boolean), utm_campaign: T.nilable(::String), utm_content: T.nilable(::String), utm_medium: T.nilable(::String), utm_source: T.nilable(::String), utm_term: T.nilable(::String), video: T.nilable(::String)).void }
|
81
|
-
def initialize(url: nil, android: nil, archived: nil, comments: nil, description: nil, do_index: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, image: nil, ios: nil, key: nil, password: nil, prefix: nil, proxy: nil, public_stats: nil, ref: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, title: nil, track_conversion: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil)
|
82
|
+
sig { params(url: ::String, android: T.nilable(::String), archived: T.nilable(T::Boolean), comments: T.nilable(::String), description: T.nilable(::String), do_index: T.nilable(T::Boolean), domain: T.nilable(::String), expired_url: T.nilable(::String), expires_at: T.nilable(::String), external_id: T.nilable(::String), geo: T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), identifier: T.nilable(::String), image: T.nilable(::String), ios: T.nilable(::String), key: T.nilable(::String), password: T.nilable(::String), prefix: T.nilable(::String), proxy: T.nilable(T::Boolean), public_stats: T.nilable(T::Boolean), ref: T.nilable(::String), rewrite: T.nilable(T::Boolean), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), title: T.nilable(::String), track_conversion: T.nilable(T::Boolean), utm_campaign: T.nilable(::String), utm_content: T.nilable(::String), utm_medium: T.nilable(::String), utm_source: T.nilable(::String), utm_term: T.nilable(::String), video: T.nilable(::String)).void }
|
83
|
+
def initialize(url: nil, android: nil, archived: nil, comments: nil, description: nil, do_index: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, identifier: nil, image: nil, ios: nil, key: nil, password: nil, prefix: nil, proxy: nil, public_stats: nil, ref: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, title: nil, track_conversion: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil)
|
82
84
|
@url = url
|
83
85
|
@android = android
|
84
86
|
@archived = archived
|
@@ -90,6 +92,7 @@ module OpenApiSDK
|
|
90
92
|
@expires_at = expires_at
|
91
93
|
@external_id = external_id
|
92
94
|
@geo = geo
|
95
|
+
@identifier = identifier
|
93
96
|
@image = image
|
94
97
|
@ios = ios
|
95
98
|
@key = key
|
@@ -36,10 +36,12 @@ module OpenApiSDK
|
|
36
36
|
autoload :Event, 'open_api_sdk/models/operations/event.rb'
|
37
37
|
autoload :GroupBy, 'open_api_sdk/models/operations/groupby.rb'
|
38
38
|
autoload :Interval, 'open_api_sdk/models/operations/interval.rb'
|
39
|
+
autoload :Trigger, 'open_api_sdk/models/operations/trigger.rb'
|
39
40
|
autoload :RetrieveAnalyticsRequest, 'open_api_sdk/models/operations/retrieveanalytics_request.rb'
|
40
41
|
autoload :RetrieveAnalyticsResponse, 'open_api_sdk/models/operations/retrieveanalytics_response.rb'
|
41
42
|
autoload :QueryParamEvent, 'open_api_sdk/models/operations/queryparam_event.rb'
|
42
43
|
autoload :QueryParamInterval, 'open_api_sdk/models/operations/queryparam_interval.rb'
|
44
|
+
autoload :QueryParamTrigger, 'open_api_sdk/models/operations/queryparam_trigger.rb'
|
43
45
|
autoload :Order, 'open_api_sdk/models/operations/order.rb'
|
44
46
|
autoload :SortBy, 'open_api_sdk/models/operations/sortby.rb'
|
45
47
|
autoload :ListEventsRequest, 'open_api_sdk/models/operations/listevents_request.rb'
|
@@ -27,12 +27,14 @@ module OpenApiSDK
|
|
27
27
|
field :expired_url, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiredUrl') } }
|
28
28
|
|
29
29
|
field :expires_at, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiresAt') } }
|
30
|
-
# This is the ID of the link in your database. If set, it can be used to identify the link in
|
30
|
+
# This is the ID of the link in your database that is unique across your workspace. If set, it can be used to identify the link in future API requests. Must be prefixed with 'ext_' when passed as a query parameter.
|
31
31
|
field :external_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
|
32
32
|
# Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. Learn more: https://d.to/geo
|
33
33
|
field :geo, ::OpenApiSDK::Shared::ClickEventGeo, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('geo') } }
|
34
34
|
# The unique ID of the short link.
|
35
35
|
field :id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id') } }
|
36
|
+
# The identifier of the short link that is unique across your workspace. If set, it can be used to identify your short link for client-side click tracking.
|
37
|
+
field :identifier, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('identifier') } }
|
36
38
|
# The image of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
|
37
39
|
field :image, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
|
38
40
|
# The iOS destination URL for the short link for iOS device targeting.
|
@@ -99,8 +101,8 @@ module OpenApiSDK
|
|
99
101
|
field :track_conversion, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trackConversion') } }
|
100
102
|
|
101
103
|
|
102
|
-
sig { params(android: ::String, clicks: ::Float, comments: ::String, created_at: ::String, description: ::String, domain: ::String, expired_url: ::String, expires_at: ::String, external_id: ::String, geo: ::OpenApiSDK::Shared::ClickEventGeo, id: ::String, image: ::String, ios: ::String, key: ::String, last_clicked: ::String, leads: ::Float, password: ::String, project_id: ::String, qr_code: ::String, sale_amount: ::Float, sales: ::Float, short_link: ::String, tag_id: ::String, tags: T::Array[::OpenApiSDK::Shared::TagSchema], title: ::String, updated_at: ::String, url: ::String, user_id: ::String, utm_campaign: ::String, utm_content: ::String, utm_medium: ::String, utm_source: ::String, utm_term: ::String, video: ::String, workspace_id: ::String, archived: T.nilable(T::Boolean), do_index: T.nilable(T::Boolean), proxy: T.nilable(T::Boolean), public_stats: T.nilable(T::Boolean), rewrite: T.nilable(T::Boolean), track_conversion: T.nilable(T::Boolean)).void }
|
103
|
-
def initialize(android: nil, clicks: nil, comments: nil, created_at: nil, description: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, id: nil, image: nil, ios: nil, key: nil, last_clicked: nil, leads: nil, password: nil, project_id: nil, qr_code: nil, sale_amount: nil, sales: nil, short_link: nil, tag_id: nil, tags: nil, title: nil, updated_at: nil, url: nil, user_id: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil, workspace_id: nil, archived: nil, do_index: nil, proxy: nil, public_stats: nil, rewrite: nil, track_conversion: nil)
|
104
|
+
sig { params(android: ::String, clicks: ::Float, comments: ::String, created_at: ::String, description: ::String, domain: ::String, expired_url: ::String, expires_at: ::String, external_id: ::String, geo: ::OpenApiSDK::Shared::ClickEventGeo, id: ::String, identifier: ::String, image: ::String, ios: ::String, key: ::String, last_clicked: ::String, leads: ::Float, password: ::String, project_id: ::String, qr_code: ::String, sale_amount: ::Float, sales: ::Float, short_link: ::String, tag_id: ::String, tags: T::Array[::OpenApiSDK::Shared::TagSchema], title: ::String, updated_at: ::String, url: ::String, user_id: ::String, utm_campaign: ::String, utm_content: ::String, utm_medium: ::String, utm_source: ::String, utm_term: ::String, video: ::String, workspace_id: ::String, archived: T.nilable(T::Boolean), do_index: T.nilable(T::Boolean), proxy: T.nilable(T::Boolean), public_stats: T.nilable(T::Boolean), rewrite: T.nilable(T::Boolean), track_conversion: T.nilable(T::Boolean)).void }
|
105
|
+
def initialize(android: nil, clicks: nil, comments: nil, created_at: nil, description: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, id: nil, identifier: nil, image: nil, ios: nil, key: nil, last_clicked: nil, leads: nil, password: nil, project_id: nil, qr_code: nil, sale_amount: nil, sales: nil, short_link: nil, tag_id: nil, tags: nil, title: nil, updated_at: nil, url: nil, user_id: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil, workspace_id: nil, archived: nil, do_index: nil, proxy: nil, public_stats: nil, rewrite: nil, track_conversion: nil)
|
104
106
|
@android = android
|
105
107
|
@clicks = clicks
|
106
108
|
@comments = comments
|
@@ -112,6 +114,7 @@ module OpenApiSDK
|
|
112
114
|
@external_id = external_id
|
113
115
|
@geo = geo
|
114
116
|
@id = id
|
117
|
+
@identifier = identifier
|
115
118
|
@image = image
|
116
119
|
@ios = ios
|
117
120
|
@key = key
|
@@ -31,12 +31,14 @@ module OpenApiSDK
|
|
31
31
|
field :expired_url, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiredUrl') } }
|
32
32
|
# The date and time when the short link will expire in ISO-8601 format.
|
33
33
|
field :expires_at, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiresAt') } }
|
34
|
-
# This is the ID of the link in your database. If set, it can be used to identify the link in
|
34
|
+
# This is the ID of the link in your database that is unique across your workspace. If set, it can be used to identify the link in future API requests. Must be prefixed with 'ext_' when passed as a query parameter.
|
35
35
|
field :external_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
|
36
36
|
# Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. Learn more: https://d.to/geo
|
37
37
|
field :geo, ::OpenApiSDK::Shared::Geo, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('geo') } }
|
38
38
|
# The unique ID of the short link.
|
39
39
|
field :id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id') } }
|
40
|
+
# The identifier of the short link that is unique across your workspace. If set, it can be used to identify your short link for client-side click tracking.
|
41
|
+
field :identifier, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('identifier') } }
|
40
42
|
# The image of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
|
41
43
|
field :image, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
|
42
44
|
# The iOS destination URL for the short link for iOS device targeting.
|
@@ -99,8 +101,8 @@ module OpenApiSDK
|
|
99
101
|
field :workspace_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('workspaceId') } }
|
100
102
|
|
101
103
|
|
102
|
-
sig { params(android: ::String, archived: T::Boolean, clicks: ::Float, comments: ::String, created_at: ::String, description: ::String, do_index: T::Boolean, domain: ::String, expired_url: ::String, expires_at: ::String, external_id: ::String, geo: ::OpenApiSDK::Shared::Geo, id: ::String, image: ::String, ios: ::String, key: ::String, last_clicked: ::String, leads: ::Float, password: ::String, project_id: ::String, proxy: T::Boolean, public_stats: T::Boolean, qr_code: ::String, rewrite: T::Boolean, sale_amount: ::Float, sales: ::Float, short_link: ::String, tag_id: ::String, tags: T::Array[::OpenApiSDK::Shared::TagSchema], title: ::String, track_conversion: T::Boolean, updated_at: ::String, url: ::String, user_id: ::String, utm_campaign: ::String, utm_content: ::String, utm_medium: ::String, utm_source: ::String, utm_term: ::String, video: ::String, workspace_id: ::String).void }
|
103
|
-
def initialize(android: nil, archived: nil, clicks: nil, comments: nil, created_at: nil, description: nil, do_index: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, id: nil, image: nil, ios: nil, key: nil, last_clicked: nil, leads: nil, password: nil, project_id: nil, proxy: nil, public_stats: nil, qr_code: nil, rewrite: nil, sale_amount: nil, sales: nil, short_link: nil, tag_id: nil, tags: nil, title: nil, track_conversion: nil, updated_at: nil, url: nil, user_id: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil, workspace_id: nil)
|
104
|
+
sig { params(android: ::String, archived: T::Boolean, clicks: ::Float, comments: ::String, created_at: ::String, description: ::String, do_index: T::Boolean, domain: ::String, expired_url: ::String, expires_at: ::String, external_id: ::String, geo: ::OpenApiSDK::Shared::Geo, id: ::String, identifier: ::String, image: ::String, ios: ::String, key: ::String, last_clicked: ::String, leads: ::Float, password: ::String, project_id: ::String, proxy: T::Boolean, public_stats: T::Boolean, qr_code: ::String, rewrite: T::Boolean, sale_amount: ::Float, sales: ::Float, short_link: ::String, tag_id: ::String, tags: T::Array[::OpenApiSDK::Shared::TagSchema], title: ::String, track_conversion: T::Boolean, updated_at: ::String, url: ::String, user_id: ::String, utm_campaign: ::String, utm_content: ::String, utm_medium: ::String, utm_source: ::String, utm_term: ::String, video: ::String, workspace_id: ::String).void }
|
105
|
+
def initialize(android: nil, archived: nil, clicks: nil, comments: nil, created_at: nil, description: nil, do_index: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, id: nil, identifier: nil, image: nil, ios: nil, key: nil, last_clicked: nil, leads: nil, password: nil, project_id: nil, proxy: nil, public_stats: nil, qr_code: nil, rewrite: nil, sale_amount: nil, sales: nil, short_link: nil, tag_id: nil, tags: nil, title: nil, track_conversion: nil, updated_at: nil, url: nil, user_id: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil, workspace_id: nil)
|
104
106
|
@android = android
|
105
107
|
@archived = archived
|
106
108
|
@clicks = clicks
|
@@ -114,6 +116,7 @@ module OpenApiSDK
|
|
114
116
|
@external_id = external_id
|
115
117
|
@geo = geo
|
116
118
|
@id = id
|
119
|
+
@identifier = identifier
|
117
120
|
@image = image
|
118
121
|
@ios = ios
|
119
122
|
@key = key
|
@@ -41,6 +41,8 @@ module OpenApiSDK
|
|
41
41
|
field :name, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('name') } }
|
42
42
|
# The plan of the workspace.
|
43
43
|
field :plan, ::OpenApiSDK::Shared::Plan, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('plan'), 'decoder': Utils.enum_from_string(::OpenApiSDK::Shared::Plan, false) } }
|
44
|
+
# The publishable key of the workspace.
|
45
|
+
field :publishable_key, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('publishableKey') } }
|
44
46
|
# The ID of the referral link of the workspace.
|
45
47
|
field :referral_link_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('referralLinkId') } }
|
46
48
|
# The limit of tracked revenue in the current billing cycle (in cents).
|
@@ -67,8 +69,8 @@ module OpenApiSDK
|
|
67
69
|
field :flags, T.nilable(T::Hash[Symbol, T::Boolean]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('flags') } }
|
68
70
|
|
69
71
|
|
70
|
-
sig { params(ai_limit: ::Float, ai_usage: ::Float, billing_cycle_start: ::Float, conversion_enabled: T::Boolean, created_at: ::String, domains: T::Array[::OpenApiSDK::Shared::Domains], domains_limit: ::Float, dot_link_claimed: T::Boolean, id: ::String, invite_code: ::String, links_limit: ::Float, links_usage: ::Float, logo: ::String, name: ::String, plan: ::OpenApiSDK::Shared::Plan, referral_link_id: ::String, sales_limit: ::Float, sales_usage: ::Float, slug: ::String, stripe_connect_id: ::String, stripe_id: ::String, tags_limit: ::Float, usage: ::Float, usage_limit: ::Float, users: T::Array[::OpenApiSDK::Shared::Users], users_limit: ::Float, flags: T.nilable(T::Hash[Symbol, T::Boolean])).void }
|
71
|
-
def initialize(ai_limit: nil, ai_usage: nil, billing_cycle_start: nil, conversion_enabled: nil, created_at: nil, domains: nil, domains_limit: nil, dot_link_claimed: nil, id: nil, invite_code: nil, links_limit: nil, links_usage: nil, logo: nil, name: nil, plan: nil, referral_link_id: nil, sales_limit: nil, sales_usage: nil, slug: nil, stripe_connect_id: nil, stripe_id: nil, tags_limit: nil, usage: nil, usage_limit: nil, users: nil, users_limit: nil, flags: nil)
|
72
|
+
sig { params(ai_limit: ::Float, ai_usage: ::Float, billing_cycle_start: ::Float, conversion_enabled: T::Boolean, created_at: ::String, domains: T::Array[::OpenApiSDK::Shared::Domains], domains_limit: ::Float, dot_link_claimed: T::Boolean, id: ::String, invite_code: ::String, links_limit: ::Float, links_usage: ::Float, logo: ::String, name: ::String, plan: ::OpenApiSDK::Shared::Plan, publishable_key: ::String, referral_link_id: ::String, sales_limit: ::Float, sales_usage: ::Float, slug: ::String, stripe_connect_id: ::String, stripe_id: ::String, tags_limit: ::Float, usage: ::Float, usage_limit: ::Float, users: T::Array[::OpenApiSDK::Shared::Users], users_limit: ::Float, flags: T.nilable(T::Hash[Symbol, T::Boolean])).void }
|
73
|
+
def initialize(ai_limit: nil, ai_usage: nil, billing_cycle_start: nil, conversion_enabled: nil, created_at: nil, domains: nil, domains_limit: nil, dot_link_claimed: nil, id: nil, invite_code: nil, links_limit: nil, links_usage: nil, logo: nil, name: nil, plan: nil, publishable_key: nil, referral_link_id: nil, sales_limit: nil, sales_usage: nil, slug: nil, stripe_connect_id: nil, stripe_id: nil, tags_limit: nil, usage: nil, usage_limit: nil, users: nil, users_limit: nil, flags: nil)
|
72
74
|
@ai_limit = ai_limit
|
73
75
|
@ai_usage = ai_usage
|
74
76
|
@billing_cycle_start = billing_cycle_start
|
@@ -84,6 +86,7 @@ module OpenApiSDK
|
|
84
86
|
@logo = logo
|
85
87
|
@name = name
|
86
88
|
@plan = plan
|
89
|
+
@publishable_key = publishable_key
|
87
90
|
@referral_link_id = referral_link_id
|
88
91
|
@sales_limit = sales_limit
|
89
92
|
@sales_usage = sales_usage
|
@@ -38,9 +38,9 @@ module OpenApiSDK
|
|
38
38
|
@security = security
|
39
39
|
@language = 'ruby'
|
40
40
|
@openapi_doc_version = '0.0.1'
|
41
|
-
@sdk_version = '0.2.2-alpha.
|
42
|
-
@gen_version = '2.
|
43
|
-
@user_agent = 'speakeasy-sdk/ruby 0.2.2-alpha.
|
41
|
+
@sdk_version = '0.2.2-alpha.22'
|
42
|
+
@gen_version = '2.429.0'
|
43
|
+
@user_agent = 'speakeasy-sdk/ruby 0.2.2-alpha.22 2.429.0 0.0.1 dub'
|
44
44
|
end
|
45
45
|
|
46
46
|
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.2.2.pre.alpha.
|
4
|
+
version: 0.2.2.pre.alpha.22
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Dub
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2024-
|
11
|
+
date: 2024-10-06 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: faraday
|
@@ -201,6 +201,7 @@ files:
|
|
201
201
|
- lib/open_api_sdk/models/operations/paymentprocessor.rb
|
202
202
|
- lib/open_api_sdk/models/operations/queryparam_event.rb
|
203
203
|
- lib/open_api_sdk/models/operations/queryparam_interval.rb
|
204
|
+
- lib/open_api_sdk/models/operations/queryparam_trigger.rb
|
204
205
|
- lib/open_api_sdk/models/operations/requestbody.rb
|
205
206
|
- lib/open_api_sdk/models/operations/retrieveanalytics_request.rb
|
206
207
|
- lib/open_api_sdk/models/operations/retrieveanalytics_response.rb
|
@@ -217,6 +218,7 @@ files:
|
|
217
218
|
- lib/open_api_sdk/models/operations/tracksale_requestbody.rb
|
218
219
|
- lib/open_api_sdk/models/operations/tracksale_response.rb
|
219
220
|
- lib/open_api_sdk/models/operations/tracksale_responsebody.rb
|
221
|
+
- lib/open_api_sdk/models/operations/trigger.rb
|
220
222
|
- lib/open_api_sdk/models/operations/updatedomain_request.rb
|
221
223
|
- lib/open_api_sdk/models/operations/updatedomain_requestbody.rb
|
222
224
|
- lib/open_api_sdk/models/operations/updatedomain_response.rb
|