dub 0.2.2.pre.alpha.111 → 0.2.2.pre.alpha.115
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/models/operations/createlink_requestbody.rb +5 -5
- data/lib/open_api_sdk/models/operations/createpartner_responsebody.rb +8 -5
- data/lib/open_api_sdk/models/operations/createpartner_status.rb +1 -0
- data/lib/open_api_sdk/models/operations/createpartnerlink_linkprops.rb +5 -5
- data/lib/open_api_sdk/models/operations/createreferralsembedtoken_linkprops.rb +5 -5
- data/lib/open_api_sdk/models/operations/data.rb +5 -5
- data/lib/open_api_sdk/models/operations/linkprops.rb +5 -5
- data/lib/open_api_sdk/models/operations/listevents_request.rb +3 -3
- data/lib/open_api_sdk/models/operations/requestbody.rb +5 -5
- data/lib/open_api_sdk/models/operations/retrieveanalytics_request.rb +3 -3
- data/lib/open_api_sdk/models/operations/updatelink_requestbody.rb +4 -4
- data/lib/open_api_sdk/models/operations/upsertlink_requestbody.rb +5 -5
- data/lib/open_api_sdk/models/operations/upsertpartnerlink_linkprops.rb +5 -5
- data/lib/open_api_sdk/models/shared/linkschema.rb +5 -5
- data/lib/open_api_sdk/sdkconfiguration.rb +2 -2
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 7512c726999df3cebb2f7c2de080b9edcfb9506f4aecd1200b3c5689ed88d9b5
|
4
|
+
data.tar.gz: ca1179cb59031151c7a4d4d90d55a4d123786e640b817e47c7610d42bee897fe
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: '0204984712d57f01e29394bab3a06976aa4ddd44c164102a3b1c26a9b6e0dc029aee4a2749fc566379d97703d38e3072b5f02924d3dc96dae857bf09d7d6fa98'
|
7
|
+
data.tar.gz: df9ef818f15d575fec5c6ce15eff602073fcdadcac5a5a225a1b9188795d6c24aa5b38198d7c838d3cd2a4f473888a6e458a9119c5244456ec62e80b334c2cb2
|
@@ -19,7 +19,7 @@ module OpenApiSDK
|
|
19
19
|
field :archived, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('archived') } }
|
20
20
|
# The comments for the short link.
|
21
21
|
field :comments, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('comments') } }
|
22
|
-
# The custom link preview description (og:description). Will be used for Custom
|
22
|
+
# The custom link preview description (og:description). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
23
23
|
field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description') } }
|
24
24
|
# Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex
|
25
25
|
field :do_index, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('doIndex') } }
|
@@ -35,7 +35,7 @@ module OpenApiSDK
|
|
35
35
|
field :folder_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('folderId') } }
|
36
36
|
# Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`.
|
37
37
|
field :geo, T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('geo') } }
|
38
|
-
# The custom link preview image (og:image). Will be used for Custom
|
38
|
+
# The custom link preview image (og:image). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
39
39
|
field :image, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
|
40
40
|
# The iOS destination URL for the short link for iOS device targeting.
|
41
41
|
field :ios, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ios') } }
|
@@ -49,7 +49,7 @@ module OpenApiSDK
|
|
49
49
|
field :prefix, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('prefix') } }
|
50
50
|
# The ID of the program the short link is associated with.
|
51
51
|
field :program_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
|
52
|
-
# Whether the short link uses Custom
|
52
|
+
# Whether the short link uses Custom Link Previews feature. Defaults to `false` if not provided.
|
53
53
|
field :proxy, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('proxy') } }
|
54
54
|
# Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
|
55
55
|
#
|
@@ -75,7 +75,7 @@ module OpenApiSDK
|
|
75
75
|
field :test_started_at, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('testStartedAt') } }
|
76
76
|
# An array of A/B test URLs and the percentage of traffic to send to each URL.
|
77
77
|
field :test_variants, T.nilable(T::Array[::OpenApiSDK::Operations::TestVariants]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('testVariants') } }
|
78
|
-
# The custom link preview title (og:title). Will be used for Custom
|
78
|
+
# The custom link preview title (og:title). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
79
79
|
field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
|
80
80
|
# Whether to track conversions for the short link. Defaults to `false` if not provided.
|
81
81
|
field :track_conversion, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trackConversion') } }
|
@@ -89,7 +89,7 @@ module OpenApiSDK
|
|
89
89
|
field :utm_source, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_source') } }
|
90
90
|
# The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL.
|
91
91
|
field :utm_term, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_term') } }
|
92
|
-
# The custom link preview video (og:video). Will be used for Custom
|
92
|
+
# The custom link preview video (og:video). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
93
93
|
field :video, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('video') } }
|
94
94
|
# An array of webhook IDs to trigger when the link is clicked. These webhooks will receive click event data.
|
95
95
|
field :webhook_ids, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('webhookIds') } }
|
@@ -37,6 +37,8 @@ module OpenApiSDK
|
|
37
37
|
field :links, T::Array[::OpenApiSDK::Operations::CreatePartnerLink], { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('links') } }
|
38
38
|
# The partner's full legal name.
|
39
39
|
field :name, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('name') } }
|
40
|
+
# The total net revenue generated by the partner.
|
41
|
+
field :net_revenue, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('netRevenue') } }
|
40
42
|
# The date when the partner enabled payouts.
|
41
43
|
field :payouts_enabled_at, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('payoutsEnabledAt') } }
|
42
44
|
# The partner's PayPal email (for receiving payouts via PayPal).
|
@@ -55,20 +57,20 @@ module OpenApiSDK
|
|
55
57
|
field :tenant_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } }
|
56
58
|
# The partner's TikTok username (e.g. `johndoe`).
|
57
59
|
field :tiktok, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tiktok') } }
|
60
|
+
# The total commissions paid to the partner for their referrals.
|
61
|
+
field :total_commissions, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('totalCommissions') } }
|
58
62
|
# The partner's Twitter username (e.g. `johndoe`).
|
59
63
|
field :twitter, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('twitter') } }
|
60
64
|
# The partner's website URL (including the https protocol).
|
61
65
|
field :website, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('website') } }
|
62
66
|
# The partner's YouTube channel username (e.g. `johndoe`).
|
63
67
|
field :youtube, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('youtube') } }
|
64
|
-
# If the partner submitted an application to join the program, this is the ID of the application.
|
65
|
-
field :application_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('applicationId') } }
|
66
68
|
# A brief description of the partner and their background.
|
67
69
|
field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description') } }
|
68
70
|
|
69
71
|
|
70
|
-
sig { params(clicks: ::Float, country: ::String, created_at: ::String, earnings: ::Float, email: ::String, id: ::String, image: ::String, instagram: ::String, leads: ::Float, linkedin: ::String, links: T::Array[::OpenApiSDK::Operations::CreatePartnerLink], name: ::String, payouts_enabled_at: ::String, paypal_email: ::String, program_id: ::String, sale_amount: ::Float, sales: ::Float, status: ::OpenApiSDK::Operations::CreatePartnerStatus, stripe_connect_id: ::String, tenant_id: ::String, tiktok: ::String,
|
71
|
-
def initialize(clicks: nil, country: nil, created_at: nil, earnings: nil, email: nil, id: nil, image: nil, instagram: nil, leads: nil, linkedin: nil, links: nil, name: nil, payouts_enabled_at: nil, paypal_email: nil, program_id: nil, sale_amount: nil, sales: nil, status: nil, stripe_connect_id: nil, tenant_id: nil, tiktok: nil,
|
72
|
+
sig { params(clicks: ::Float, country: ::String, created_at: ::String, earnings: ::Float, email: ::String, id: ::String, image: ::String, instagram: ::String, leads: ::Float, linkedin: ::String, links: T::Array[::OpenApiSDK::Operations::CreatePartnerLink], name: ::String, net_revenue: ::Float, payouts_enabled_at: ::String, paypal_email: ::String, program_id: ::String, sale_amount: ::Float, sales: ::Float, status: ::OpenApiSDK::Operations::CreatePartnerStatus, stripe_connect_id: ::String, tenant_id: ::String, tiktok: ::String, total_commissions: ::Float, twitter: ::String, website: ::String, youtube: ::String, description: T.nilable(::String)).void }
|
73
|
+
def initialize(clicks: nil, country: nil, created_at: nil, earnings: nil, email: nil, id: nil, image: nil, instagram: nil, leads: nil, linkedin: nil, links: nil, name: nil, net_revenue: nil, payouts_enabled_at: nil, paypal_email: nil, program_id: nil, sale_amount: nil, sales: nil, status: nil, stripe_connect_id: nil, tenant_id: nil, tiktok: nil, total_commissions: nil, twitter: nil, website: nil, youtube: nil, description: nil)
|
72
74
|
@clicks = clicks
|
73
75
|
@country = country
|
74
76
|
@created_at = created_at
|
@@ -81,6 +83,7 @@ module OpenApiSDK
|
|
81
83
|
@linkedin = linkedin
|
82
84
|
@links = links
|
83
85
|
@name = name
|
86
|
+
@net_revenue = net_revenue
|
84
87
|
@payouts_enabled_at = payouts_enabled_at
|
85
88
|
@paypal_email = paypal_email
|
86
89
|
@program_id = program_id
|
@@ -90,10 +93,10 @@ module OpenApiSDK
|
|
90
93
|
@stripe_connect_id = stripe_connect_id
|
91
94
|
@tenant_id = tenant_id
|
92
95
|
@tiktok = tiktok
|
96
|
+
@total_commissions = total_commissions
|
93
97
|
@twitter = twitter
|
94
98
|
@website = website
|
95
99
|
@youtube = youtube
|
96
|
-
@application_id = application_id
|
97
100
|
@description = description
|
98
101
|
end
|
99
102
|
end
|
@@ -17,7 +17,7 @@ module OpenApiSDK
|
|
17
17
|
field :archived, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('archived') } }
|
18
18
|
# The comments for the short link.
|
19
19
|
field :comments, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('comments') } }
|
20
|
-
# The custom link preview description (og:description). Will be used for Custom
|
20
|
+
# The custom link preview description (og:description). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
21
21
|
field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description') } }
|
22
22
|
# Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex
|
23
23
|
field :do_index, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('doIndex') } }
|
@@ -29,7 +29,7 @@ module OpenApiSDK
|
|
29
29
|
field :external_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
|
30
30
|
# The unique ID existing folder to assign the short link to.
|
31
31
|
field :folder_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('folderId') } }
|
32
|
-
# The custom link preview image (og:image). Will be used for Custom
|
32
|
+
# The custom link preview image (og:image). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
33
33
|
field :image, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
|
34
34
|
# The iOS destination URL for the short link for iOS device targeting.
|
35
35
|
field :ios, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ios') } }
|
@@ -37,7 +37,7 @@ module OpenApiSDK
|
|
37
37
|
field :password, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('password') } }
|
38
38
|
# The prefix of the short link slug for randomly-generated keys (e.g. if prefix is `/c/`, generated keys will be in the `/c/:key` format). Will be ignored if `key` is provided.
|
39
39
|
field :prefix, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('prefix') } }
|
40
|
-
# Whether the short link uses Custom
|
40
|
+
# Whether the short link uses Custom Link Previews feature. Defaults to `false` if not provided.
|
41
41
|
field :proxy, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('proxy') } }
|
42
42
|
# The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL.
|
43
43
|
field :ref, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ref') } }
|
@@ -55,7 +55,7 @@ module OpenApiSDK
|
|
55
55
|
field :test_started_at, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('testStartedAt') } }
|
56
56
|
# An array of A/B test URLs and the percentage of traffic to send to each URL.
|
57
57
|
field :test_variants, T.nilable(T::Array[::OpenApiSDK::Operations::CreatePartnerLinkTestVariants]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('testVariants') } }
|
58
|
-
# The custom link preview title (og:title). Will be used for Custom
|
58
|
+
# The custom link preview title (og:title). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
59
59
|
field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
|
60
60
|
# The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL.
|
61
61
|
field :utm_campaign, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_campaign') } }
|
@@ -67,7 +67,7 @@ module OpenApiSDK
|
|
67
67
|
field :utm_source, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_source') } }
|
68
68
|
# The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL.
|
69
69
|
field :utm_term, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_term') } }
|
70
|
-
# The custom link preview video (og:video). Will be used for Custom
|
70
|
+
# The custom link preview video (og:video). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
71
71
|
field :video, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('video') } }
|
72
72
|
|
73
73
|
|
@@ -17,7 +17,7 @@ module OpenApiSDK
|
|
17
17
|
field :archived, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('archived') } }
|
18
18
|
# The comments for the short link.
|
19
19
|
field :comments, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('comments') } }
|
20
|
-
# The custom link preview description (og:description). Will be used for Custom
|
20
|
+
# The custom link preview description (og:description). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
21
21
|
field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description') } }
|
22
22
|
# Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex
|
23
23
|
field :do_index, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('doIndex') } }
|
@@ -29,7 +29,7 @@ module OpenApiSDK
|
|
29
29
|
field :external_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
|
30
30
|
# The unique ID existing folder to assign the short link to.
|
31
31
|
field :folder_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('folderId') } }
|
32
|
-
# The custom link preview image (og:image). Will be used for Custom
|
32
|
+
# The custom link preview image (og:image). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
33
33
|
field :image, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
|
34
34
|
# The iOS destination URL for the short link for iOS device targeting.
|
35
35
|
field :ios, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ios') } }
|
@@ -37,7 +37,7 @@ module OpenApiSDK
|
|
37
37
|
field :password, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('password') } }
|
38
38
|
# The prefix of the short link slug for randomly-generated keys (e.g. if prefix is `/c/`, generated keys will be in the `/c/:key` format). Will be ignored if `key` is provided.
|
39
39
|
field :prefix, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('prefix') } }
|
40
|
-
# Whether the short link uses Custom
|
40
|
+
# Whether the short link uses Custom Link Previews feature. Defaults to `false` if not provided.
|
41
41
|
field :proxy, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('proxy') } }
|
42
42
|
# The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL.
|
43
43
|
field :ref, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ref') } }
|
@@ -55,7 +55,7 @@ module OpenApiSDK
|
|
55
55
|
field :test_started_at, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('testStartedAt') } }
|
56
56
|
# An array of A/B test URLs and the percentage of traffic to send to each URL.
|
57
57
|
field :test_variants, T.nilable(T::Array[::OpenApiSDK::Operations::CreateReferralsEmbedTokenTestVariants]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('testVariants') } }
|
58
|
-
# The custom link preview title (og:title). Will be used for Custom
|
58
|
+
# The custom link preview title (og:title). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
59
59
|
field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
|
60
60
|
# The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL.
|
61
61
|
field :utm_campaign, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_campaign') } }
|
@@ -67,7 +67,7 @@ module OpenApiSDK
|
|
67
67
|
field :utm_source, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_source') } }
|
68
68
|
# The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL.
|
69
69
|
field :utm_term, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_term') } }
|
70
|
-
# The custom link preview video (og:video). Will be used for Custom
|
70
|
+
# The custom link preview video (og:video). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
71
71
|
field :video, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('video') } }
|
72
72
|
|
73
73
|
|
@@ -17,7 +17,7 @@ module OpenApiSDK
|
|
17
17
|
field :archived, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('archived') } }
|
18
18
|
# The comments for the short link.
|
19
19
|
field :comments, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('comments') } }
|
20
|
-
# The custom link preview description (og:description). Will be used for Custom
|
20
|
+
# The custom link preview description (og:description). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
21
21
|
field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description') } }
|
22
22
|
# Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex
|
23
23
|
field :do_index, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('doIndex') } }
|
@@ -29,7 +29,7 @@ module OpenApiSDK
|
|
29
29
|
field :folder_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('folderId') } }
|
30
30
|
# Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`.
|
31
31
|
field :geo, T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('geo') } }
|
32
|
-
# The custom link preview image (og:image). Will be used for Custom
|
32
|
+
# The custom link preview image (og:image). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
33
33
|
field :image, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
|
34
34
|
# The iOS destination URL for the short link for iOS device targeting.
|
35
35
|
field :ios, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ios') } }
|
@@ -39,7 +39,7 @@ module OpenApiSDK
|
|
39
39
|
field :password, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('password') } }
|
40
40
|
# The ID of the program the short link is associated with.
|
41
41
|
field :program_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
|
42
|
-
# Whether the short link uses Custom
|
42
|
+
# Whether the short link uses Custom Link Previews feature. Defaults to `false` if not provided.
|
43
43
|
field :proxy, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('proxy') } }
|
44
44
|
# Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
|
45
45
|
#
|
@@ -65,7 +65,7 @@ module OpenApiSDK
|
|
65
65
|
field :test_started_at, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('testStartedAt') } }
|
66
66
|
# An array of A/B test URLs and the percentage of traffic to send to each URL.
|
67
67
|
field :test_variants, T.nilable(T::Array[::OpenApiSDK::Operations::BulkUpdateLinksTestVariants]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('testVariants') } }
|
68
|
-
# The custom link preview title (og:title). Will be used for Custom
|
68
|
+
# The custom link preview title (og:title). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
69
69
|
field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
|
70
70
|
# Whether to track conversions for the short link. Defaults to `false` if not provided.
|
71
71
|
field :track_conversion, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trackConversion') } }
|
@@ -81,7 +81,7 @@ module OpenApiSDK
|
|
81
81
|
field :utm_source, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_source') } }
|
82
82
|
# The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL.
|
83
83
|
field :utm_term, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_term') } }
|
84
|
-
# The custom link preview video (og:video). Will be used for Custom
|
84
|
+
# The custom link preview video (og:video). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
85
85
|
field :video, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('video') } }
|
86
86
|
# An array of webhook IDs to trigger when the link is clicked. These webhooks will receive click event data.
|
87
87
|
field :webhook_ids, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('webhookIds') } }
|
@@ -17,7 +17,7 @@ module OpenApiSDK
|
|
17
17
|
field :archived, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('archived') } }
|
18
18
|
# The comments for the short link.
|
19
19
|
field :comments, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('comments') } }
|
20
|
-
# The custom link preview description (og:description). Will be used for Custom
|
20
|
+
# The custom link preview description (og:description). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
21
21
|
field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description') } }
|
22
22
|
# Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex
|
23
23
|
field :do_index, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('doIndex') } }
|
@@ -29,7 +29,7 @@ module OpenApiSDK
|
|
29
29
|
field :external_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
|
30
30
|
# The unique ID existing folder to assign the short link to.
|
31
31
|
field :folder_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('folderId') } }
|
32
|
-
# The custom link preview image (og:image). Will be used for Custom
|
32
|
+
# The custom link preview image (og:image). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
33
33
|
field :image, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
|
34
34
|
# The iOS destination URL for the short link for iOS device targeting.
|
35
35
|
field :ios, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ios') } }
|
@@ -37,7 +37,7 @@ module OpenApiSDK
|
|
37
37
|
field :password, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('password') } }
|
38
38
|
# The prefix of the short link slug for randomly-generated keys (e.g. if prefix is `/c/`, generated keys will be in the `/c/:key` format). Will be ignored if `key` is provided.
|
39
39
|
field :prefix, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('prefix') } }
|
40
|
-
# Whether the short link uses Custom
|
40
|
+
# Whether the short link uses Custom Link Previews feature. Defaults to `false` if not provided.
|
41
41
|
field :proxy, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('proxy') } }
|
42
42
|
# The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL.
|
43
43
|
field :ref, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ref') } }
|
@@ -55,7 +55,7 @@ module OpenApiSDK
|
|
55
55
|
field :test_started_at, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('testStartedAt') } }
|
56
56
|
# An array of A/B test URLs and the percentage of traffic to send to each URL.
|
57
57
|
field :test_variants, T.nilable(T::Array[::OpenApiSDK::Operations::CreatePartnerTestVariants]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('testVariants') } }
|
58
|
-
# The custom link preview title (og:title). Will be used for Custom
|
58
|
+
# The custom link preview title (og:title). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
59
59
|
field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
|
60
60
|
# The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL.
|
61
61
|
field :utm_campaign, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_campaign') } }
|
@@ -67,7 +67,7 @@ module OpenApiSDK
|
|
67
67
|
field :utm_source, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_source') } }
|
68
68
|
# The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL.
|
69
69
|
field :utm_term, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_term') } }
|
70
|
-
# The custom link preview video (og:video). Will be used for Custom
|
70
|
+
# The custom link preview video (og:video). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
71
71
|
field :video, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('video') } }
|
72
72
|
|
73
73
|
|
@@ -29,17 +29,17 @@ module OpenApiSDK
|
|
29
29
|
field :end_, T.nilable(::String), { 'query_param': { 'field_name': 'end', 'style': 'form', 'explode': true } }
|
30
30
|
# The type of event to retrieve analytics for. Defaults to 'clicks'.
|
31
31
|
field :event, T.nilable(::OpenApiSDK::Operations::QueryParamEvent), { 'query_param': { 'field_name': 'event', 'style': 'form', 'explode': true } }
|
32
|
-
#
|
32
|
+
# The ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.
|
33
33
|
field :external_id, T.nilable(::String), { 'query_param': { 'field_name': 'externalId', 'style': 'form', 'explode': true } }
|
34
34
|
# The folder ID to retrieve analytics for. If not provided, return analytics for unsorted links.
|
35
35
|
field :folder_id, T.nilable(::String), { 'query_param': { 'field_name': 'folderId', 'style': 'form', 'explode': true } }
|
36
36
|
# The interval to retrieve analytics for. If undefined, defaults to 24h.
|
37
37
|
field :interval, T.nilable(::OpenApiSDK::Operations::QueryParamInterval), { 'query_param': { 'field_name': 'interval', 'style': 'form', 'explode': true } }
|
38
|
-
# The short link
|
38
|
+
# The slug of the short link to retrieve analytics for. Must be used along with the corresponding `domain` of the short link to fetch analytics for a specific short link.
|
39
39
|
field :key, T.nilable(::String), { 'query_param': { 'field_name': 'key', 'style': 'form', 'explode': true } }
|
40
40
|
|
41
41
|
field :limit, T.nilable(::Float), { 'query_param': { 'field_name': 'limit', 'style': 'form', 'explode': true } }
|
42
|
-
# The unique ID of the short link on Dub.
|
42
|
+
# The unique ID of the short link on Dub to retrieve analytics for.
|
43
43
|
field :link_id, T.nilable(::String), { 'query_param': { 'field_name': 'linkId', 'style': 'form', 'explode': true } }
|
44
44
|
# DEPRECATED. Use `sortOrder` instead.
|
45
45
|
field :order, T.nilable(::OpenApiSDK::Operations::Order), { 'query_param': { 'field_name': 'order', 'style': 'form', 'explode': true } }
|
@@ -19,7 +19,7 @@ module OpenApiSDK
|
|
19
19
|
field :archived, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('archived') } }
|
20
20
|
# The comments for the short link.
|
21
21
|
field :comments, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('comments') } }
|
22
|
-
# The custom link preview description (og:description). Will be used for Custom
|
22
|
+
# The custom link preview description (og:description). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
23
23
|
field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description') } }
|
24
24
|
# Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex
|
25
25
|
field :do_index, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('doIndex') } }
|
@@ -35,7 +35,7 @@ module OpenApiSDK
|
|
35
35
|
field :folder_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('folderId') } }
|
36
36
|
# Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`.
|
37
37
|
field :geo, T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('geo') } }
|
38
|
-
# The custom link preview image (og:image). Will be used for Custom
|
38
|
+
# The custom link preview image (og:image). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
39
39
|
field :image, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
|
40
40
|
# The iOS destination URL for the short link for iOS device targeting.
|
41
41
|
field :ios, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ios') } }
|
@@ -49,7 +49,7 @@ module OpenApiSDK
|
|
49
49
|
field :prefix, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('prefix') } }
|
50
50
|
# The ID of the program the short link is associated with.
|
51
51
|
field :program_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
|
52
|
-
# Whether the short link uses Custom
|
52
|
+
# Whether the short link uses Custom Link Previews feature. Defaults to `false` if not provided.
|
53
53
|
field :proxy, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('proxy') } }
|
54
54
|
# Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
|
55
55
|
#
|
@@ -75,7 +75,7 @@ module OpenApiSDK
|
|
75
75
|
field :test_started_at, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('testStartedAt') } }
|
76
76
|
# An array of A/B test URLs and the percentage of traffic to send to each URL.
|
77
77
|
field :test_variants, T.nilable(T::Array[::OpenApiSDK::Operations::BulkCreateLinksTestVariants]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('testVariants') } }
|
78
|
-
# The custom link preview title (og:title). Will be used for Custom
|
78
|
+
# The custom link preview title (og:title). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
79
79
|
field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
|
80
80
|
# Whether to track conversions for the short link. Defaults to `false` if not provided.
|
81
81
|
field :track_conversion, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trackConversion') } }
|
@@ -89,7 +89,7 @@ module OpenApiSDK
|
|
89
89
|
field :utm_source, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_source') } }
|
90
90
|
# The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL.
|
91
91
|
field :utm_term, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_term') } }
|
92
|
-
# The custom link preview video (og:video). Will be used for Custom
|
92
|
+
# The custom link preview video (og:video). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
93
93
|
field :video, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('video') } }
|
94
94
|
# An array of webhook IDs to trigger when the link is clicked. These webhooks will receive click event data.
|
95
95
|
field :webhook_ids, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('webhookIds') } }
|
@@ -29,7 +29,7 @@ module OpenApiSDK
|
|
29
29
|
field :end_, T.nilable(::String), { 'query_param': { 'field_name': 'end', 'style': 'form', 'explode': true } }
|
30
30
|
# The type of event to retrieve analytics for. Defaults to `clicks`.
|
31
31
|
field :event, T.nilable(::OpenApiSDK::Operations::Event), { 'query_param': { 'field_name': 'event', 'style': 'form', 'explode': true } }
|
32
|
-
#
|
32
|
+
# The ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.
|
33
33
|
field :external_id, T.nilable(::String), { 'query_param': { 'field_name': 'externalId', 'style': 'form', 'explode': true } }
|
34
34
|
# The folder ID to retrieve analytics for. If not provided, return analytics for unsorted links.
|
35
35
|
field :folder_id, T.nilable(::String), { 'query_param': { 'field_name': 'folderId', 'style': 'form', 'explode': true } }
|
@@ -37,9 +37,9 @@ module OpenApiSDK
|
|
37
37
|
field :group_by, T.nilable(::OpenApiSDK::Operations::GroupBy), { 'query_param': { 'field_name': 'groupBy', 'style': 'form', 'explode': true } }
|
38
38
|
# The interval to retrieve analytics for. If undefined, defaults to 24h.
|
39
39
|
field :interval, T.nilable(::OpenApiSDK::Operations::Interval), { 'query_param': { 'field_name': 'interval', 'style': 'form', 'explode': true } }
|
40
|
-
# The short link
|
40
|
+
# The slug of the short link to retrieve analytics for. Must be used along with the corresponding `domain` of the short link to fetch analytics for a specific short link.
|
41
41
|
field :key, T.nilable(::String), { 'query_param': { 'field_name': 'key', 'style': 'form', 'explode': true } }
|
42
|
-
# The unique ID of the short link on Dub.
|
42
|
+
# The unique ID of the short link on Dub to retrieve analytics for.
|
43
43
|
field :link_id, T.nilable(::String), { 'query_param': { 'field_name': 'linkId', 'style': 'form', 'explode': true } }
|
44
44
|
# The OS to retrieve analytics for.
|
45
45
|
field :os, T.nilable(::String), { 'query_param': { 'field_name': 'os', 'style': 'form', 'explode': true } }
|
@@ -17,7 +17,7 @@ module OpenApiSDK
|
|
17
17
|
field :archived, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('archived') } }
|
18
18
|
# The comments for the short link.
|
19
19
|
field :comments, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('comments') } }
|
20
|
-
# The custom link preview description (og:description). Will be used for Custom
|
20
|
+
# The custom link preview description (og:description). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
21
21
|
field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description') } }
|
22
22
|
# Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex
|
23
23
|
field :do_index, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('doIndex') } }
|
@@ -47,7 +47,7 @@ module OpenApiSDK
|
|
47
47
|
field :prefix, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('prefix') } }
|
48
48
|
# The ID of the program the short link is associated with.
|
49
49
|
field :program_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
|
50
|
-
# Whether the short link uses Custom
|
50
|
+
# Whether the short link uses Custom Link Previews feature. Defaults to `false` if not provided.
|
51
51
|
field :proxy, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('proxy') } }
|
52
52
|
# Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
|
53
53
|
#
|
@@ -73,7 +73,7 @@ module OpenApiSDK
|
|
73
73
|
field :test_started_at, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('testStartedAt') } }
|
74
74
|
# An array of A/B test URLs and the percentage of traffic to send to each URL.
|
75
75
|
field :test_variants, T.nilable(T::Array[::OpenApiSDK::Operations::UpdateLinkTestVariants]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('testVariants') } }
|
76
|
-
# The custom link preview title (og:title). Will be used for Custom
|
76
|
+
# The custom link preview title (og:title). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
77
77
|
field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
|
78
78
|
# Whether to track conversions for the short link. Defaults to `false` if not provided.
|
79
79
|
field :track_conversion, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trackConversion') } }
|
@@ -89,7 +89,7 @@ module OpenApiSDK
|
|
89
89
|
field :utm_source, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_source') } }
|
90
90
|
# The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL.
|
91
91
|
field :utm_term, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_term') } }
|
92
|
-
# The custom link preview video (og:video). Will be used for Custom
|
92
|
+
# The custom link preview video (og:video). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
93
93
|
field :video, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('video') } }
|
94
94
|
# An array of webhook IDs to trigger when the link is clicked. These webhooks will receive click event data.
|
95
95
|
field :webhook_ids, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('webhookIds') } }
|
@@ -19,7 +19,7 @@ module OpenApiSDK
|
|
19
19
|
field :archived, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('archived') } }
|
20
20
|
# The comments for the short link.
|
21
21
|
field :comments, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('comments') } }
|
22
|
-
# The custom link preview description (og:description). Will be used for Custom
|
22
|
+
# The custom link preview description (og:description). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
23
23
|
field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description') } }
|
24
24
|
# Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex
|
25
25
|
field :do_index, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('doIndex') } }
|
@@ -35,7 +35,7 @@ module OpenApiSDK
|
|
35
35
|
field :folder_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('folderId') } }
|
36
36
|
# Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`.
|
37
37
|
field :geo, T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('geo') } }
|
38
|
-
# The custom link preview image (og:image). Will be used for Custom
|
38
|
+
# The custom link preview image (og:image). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
39
39
|
field :image, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
|
40
40
|
# The iOS destination URL for the short link for iOS device targeting.
|
41
41
|
field :ios, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ios') } }
|
@@ -49,7 +49,7 @@ module OpenApiSDK
|
|
49
49
|
field :prefix, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('prefix') } }
|
50
50
|
# The ID of the program the short link is associated with.
|
51
51
|
field :program_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
|
52
|
-
# Whether the short link uses Custom
|
52
|
+
# Whether the short link uses Custom Link Previews feature. Defaults to `false` if not provided.
|
53
53
|
field :proxy, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('proxy') } }
|
54
54
|
# Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
|
55
55
|
#
|
@@ -75,7 +75,7 @@ module OpenApiSDK
|
|
75
75
|
field :test_started_at, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('testStartedAt') } }
|
76
76
|
# An array of A/B test URLs and the percentage of traffic to send to each URL.
|
77
77
|
field :test_variants, T.nilable(T::Array[::OpenApiSDK::Operations::UpsertLinkTestVariants]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('testVariants') } }
|
78
|
-
# The custom link preview title (og:title). Will be used for Custom
|
78
|
+
# The custom link preview title (og:title). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
79
79
|
field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
|
80
80
|
# Whether to track conversions for the short link. Defaults to `false` if not provided.
|
81
81
|
field :track_conversion, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trackConversion') } }
|
@@ -89,7 +89,7 @@ module OpenApiSDK
|
|
89
89
|
field :utm_source, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_source') } }
|
90
90
|
# The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL.
|
91
91
|
field :utm_term, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_term') } }
|
92
|
-
# The custom link preview video (og:video). Will be used for Custom
|
92
|
+
# The custom link preview video (og:video). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
93
93
|
field :video, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('video') } }
|
94
94
|
# An array of webhook IDs to trigger when the link is clicked. These webhooks will receive click event data.
|
95
95
|
field :webhook_ids, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('webhookIds') } }
|
@@ -17,7 +17,7 @@ module OpenApiSDK
|
|
17
17
|
field :archived, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('archived') } }
|
18
18
|
# The comments for the short link.
|
19
19
|
field :comments, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('comments') } }
|
20
|
-
# The custom link preview description (og:description). Will be used for Custom
|
20
|
+
# The custom link preview description (og:description). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
21
21
|
field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description') } }
|
22
22
|
# Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex
|
23
23
|
field :do_index, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('doIndex') } }
|
@@ -29,7 +29,7 @@ module OpenApiSDK
|
|
29
29
|
field :external_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
|
30
30
|
# The unique ID existing folder to assign the short link to.
|
31
31
|
field :folder_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('folderId') } }
|
32
|
-
# The custom link preview image (og:image). Will be used for Custom
|
32
|
+
# The custom link preview image (og:image). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
33
33
|
field :image, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
|
34
34
|
# The iOS destination URL for the short link for iOS device targeting.
|
35
35
|
field :ios, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ios') } }
|
@@ -37,7 +37,7 @@ module OpenApiSDK
|
|
37
37
|
field :password, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('password') } }
|
38
38
|
# The prefix of the short link slug for randomly-generated keys (e.g. if prefix is `/c/`, generated keys will be in the `/c/:key` format). Will be ignored if `key` is provided.
|
39
39
|
field :prefix, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('prefix') } }
|
40
|
-
# Whether the short link uses Custom
|
40
|
+
# Whether the short link uses Custom Link Previews feature. Defaults to `false` if not provided.
|
41
41
|
field :proxy, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('proxy') } }
|
42
42
|
# The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL.
|
43
43
|
field :ref, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ref') } }
|
@@ -55,7 +55,7 @@ module OpenApiSDK
|
|
55
55
|
field :test_started_at, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('testStartedAt') } }
|
56
56
|
# An array of A/B test URLs and the percentage of traffic to send to each URL.
|
57
57
|
field :test_variants, T.nilable(T::Array[::OpenApiSDK::Operations::UpsertPartnerLinkTestVariants]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('testVariants') } }
|
58
|
-
# The custom link preview title (og:title). Will be used for Custom
|
58
|
+
# The custom link preview title (og:title). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
59
59
|
field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
|
60
60
|
# The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL.
|
61
61
|
field :utm_campaign, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_campaign') } }
|
@@ -67,7 +67,7 @@ module OpenApiSDK
|
|
67
67
|
field :utm_source, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_source') } }
|
68
68
|
# The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL.
|
69
69
|
field :utm_term, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_term') } }
|
70
|
-
# The custom link preview video (og:video). Will be used for Custom
|
70
|
+
# The custom link preview video (og:video). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
71
71
|
field :video, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('video') } }
|
72
72
|
|
73
73
|
|
@@ -21,7 +21,7 @@ module OpenApiSDK
|
|
21
21
|
field :comments, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('comments') } }
|
22
22
|
# The date and time when the short link was created.
|
23
23
|
field :created_at, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('createdAt') } }
|
24
|
-
# The description of the short link. Will be used for Custom
|
24
|
+
# The description of the short link. Will be used for Custom Link Previews if `proxy` is true.
|
25
25
|
field :description, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description') } }
|
26
26
|
# Whether to allow search engines to index the short link.
|
27
27
|
field :do_index, T::Boolean, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('doIndex') } }
|
@@ -39,7 +39,7 @@ module OpenApiSDK
|
|
39
39
|
field :geo, ::OpenApiSDK::Shared::Geo, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('geo') } }
|
40
40
|
# The unique ID of the short link.
|
41
41
|
field :id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('id') } }
|
42
|
-
# The image of the short link. Will be used for Custom
|
42
|
+
# The image of the short link. Will be used for Custom Link Previews if `proxy` is true.
|
43
43
|
field :image, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
|
44
44
|
# The iOS destination URL for the short link for iOS device targeting.
|
45
45
|
field :ios, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ios') } }
|
@@ -59,7 +59,7 @@ module OpenApiSDK
|
|
59
59
|
#
|
60
60
|
# @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
|
61
61
|
field :project_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('projectId') } }
|
62
|
-
# Whether the short link uses Custom
|
62
|
+
# Whether the short link uses Custom Link Previews feature.
|
63
63
|
field :proxy, T::Boolean, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('proxy') } }
|
64
64
|
# Whether the short link's stats are publicly accessible.
|
65
65
|
field :public_stats, T::Boolean, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('publicStats') } }
|
@@ -81,7 +81,7 @@ module OpenApiSDK
|
|
81
81
|
field :tags, T::Array[::OpenApiSDK::Shared::TagSchema], { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tags') } }
|
82
82
|
# The ID of the tenant that created the link inside your system. If set, it can be used to fetch all links for a tenant.
|
83
83
|
field :tenant_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } }
|
84
|
-
# The title of the short link. Will be used for Custom
|
84
|
+
# The title of the short link. Will be used for Custom Link Previews if `proxy` is true.
|
85
85
|
field :title, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
|
86
86
|
# Whether to track conversions for the short link.
|
87
87
|
field :track_conversion, T::Boolean, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trackConversion') } }
|
@@ -101,7 +101,7 @@ module OpenApiSDK
|
|
101
101
|
field :utm_source, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_source') } }
|
102
102
|
# The UTM term of the short link.
|
103
103
|
field :utm_term, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_term') } }
|
104
|
-
# The custom link preview video (og:video). Will be used for Custom
|
104
|
+
# The custom link preview video (og:video). Will be used for Custom Link Previews if `proxy` is true. Learn more: https://d.to/og
|
105
105
|
field :video, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('video') } }
|
106
106
|
# The IDs of the webhooks that the short link is associated with.
|
107
107
|
field :webhook_ids, T::Array[::String], { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('webhookIds') } }
|
@@ -61,9 +61,9 @@ module OpenApiSDK
|
|
61
61
|
end
|
62
62
|
@language = 'ruby'
|
63
63
|
@openapi_doc_version = '0.0.1'
|
64
|
-
@sdk_version = '0.2.2-alpha.
|
64
|
+
@sdk_version = '0.2.2-alpha.115'
|
65
65
|
@gen_version = '2.563.0'
|
66
|
-
@user_agent = 'speakeasy-sdk/ruby 0.2.2-alpha.
|
66
|
+
@user_agent = 'speakeasy-sdk/ruby 0.2.2-alpha.115 2.563.0 0.0.1 dub'
|
67
67
|
end
|
68
68
|
|
69
69
|
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.115
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Dub
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2025-06-
|
11
|
+
date: 2025-06-09 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: faraday
|