dub 0.2.2.pre.alpha.49 → 0.2.2.pre.alpha.51
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/customers.rb +8 -2
- data/lib/open_api_sdk/links.rb +2 -2
- data/lib/open_api_sdk/models/operations/bulkcreatelinks_response.rb +5 -5
- data/lib/open_api_sdk/models/operations/createlink_requestbody.rb +6 -3
- data/lib/open_api_sdk/models/operations/data.rb +5 -2
- data/lib/open_api_sdk/models/operations/getcustomer_request.rb +5 -2
- data/lib/open_api_sdk/models/operations/getcustomers_request.rb +30 -0
- data/lib/open_api_sdk/models/operations/getlinks_request.rb +12 -3
- data/lib/open_api_sdk/models/operations/getlinkscount_request.rb +5 -2
- data/lib/open_api_sdk/models/operations/listevents_request.rb +8 -5
- data/lib/open_api_sdk/models/operations/order.rb +3 -1
- data/lib/open_api_sdk/models/operations/queryparam_sortby.rb +17 -0
- data/lib/open_api_sdk/models/operations/queryparam_sortorder.rb +18 -0
- data/lib/open_api_sdk/models/operations/requestbody.rb +6 -3
- data/lib/open_api_sdk/models/operations/sort.rb +4 -1
- data/lib/open_api_sdk/models/operations/sortby.rb +5 -2
- data/lib/open_api_sdk/models/operations/sortorder.rb +18 -0
- data/lib/open_api_sdk/models/operations/updatecustomer_request.rb +5 -2
- data/lib/open_api_sdk/models/operations/updatelink_requestbody.rb +6 -3
- data/lib/open_api_sdk/models/operations/upsertlink_requestbody.rb +6 -3
- data/lib/open_api_sdk/models/operations.rb +5 -1
- data/lib/open_api_sdk/models/shared/link.rb +9 -6
- data/lib/open_api_sdk/models/shared/linkschema.rb +10 -7
- data/lib/open_api_sdk/models/shared/workspaceschema.rb +1 -1
- data/lib/open_api_sdk/sdkconfiguration.rb +3 -3
- metadata +6 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: f9414e55b9d93fcd988021fc1a00369ca92f3ec28d3a57fe5dcd3559e0041b4e
|
4
|
+
data.tar.gz: a7cf16722048633213186660b130ed0b2bd12b06f4d096ecaac6c8ddf627b5ea
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz: '
|
6
|
+
metadata.gz: 65088760ad7e0af331e61b1d4da07ee3024fca0d28ffa6447d0521e54abef9f5d49c98b124bc6e0eefdcb6fd743effd95b4817aa595f89c8ceaacf79cc6c19f4
|
7
|
+
data.tar.gz: '0093d100eb450d06e547d397f1431b2a5382a5d2b3fca8f87f9c5b5a45f70a3af9a27b38eb246ddc3e0a7f26f61aa7a1284bba87227962ab2af8bddb907c0f3c'
|
@@ -19,19 +19,21 @@ module OpenApiSDK
|
|
19
19
|
end
|
20
20
|
|
21
21
|
|
22
|
-
sig { returns(::OpenApiSDK::Operations::GetCustomersResponse) }
|
23
|
-
def list
|
22
|
+
sig { params(request: T.nilable(::OpenApiSDK::Operations::GetCustomersRequest)).returns(::OpenApiSDK::Operations::GetCustomersResponse) }
|
23
|
+
def list(request)
|
24
24
|
# list - Retrieve a list of customers
|
25
25
|
# Retrieve a list of customers for the authenticated workspace.
|
26
26
|
url, params = @sdk_configuration.get_server_details
|
27
27
|
base_url = Utils.template_url(url, params)
|
28
28
|
url = "#{base_url}/customers"
|
29
29
|
headers = {}
|
30
|
+
query_params = Utils.get_query_params(::OpenApiSDK::Operations::GetCustomersRequest, request)
|
30
31
|
headers['Accept'] = 'application/json'
|
31
32
|
headers['user-agent'] = @sdk_configuration.user_agent
|
32
33
|
|
33
34
|
r = @sdk_configuration.client.get(url) do |req|
|
34
35
|
req.headers = headers
|
36
|
+
req.params = query_params
|
35
37
|
Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
|
36
38
|
end
|
37
39
|
|
@@ -195,11 +197,13 @@ module OpenApiSDK
|
|
195
197
|
request
|
196
198
|
)
|
197
199
|
headers = {}
|
200
|
+
query_params = Utils.get_query_params(::OpenApiSDK::Operations::GetCustomerRequest, request)
|
198
201
|
headers['Accept'] = 'application/json'
|
199
202
|
headers['user-agent'] = @sdk_configuration.user_agent
|
200
203
|
|
201
204
|
r = @sdk_configuration.client.get(url) do |req|
|
202
205
|
req.headers = headers
|
206
|
+
req.params = query_params
|
203
207
|
Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
|
204
208
|
end
|
205
209
|
|
@@ -279,11 +283,13 @@ module OpenApiSDK
|
|
279
283
|
headers = {}
|
280
284
|
req_content_type, data, form = Utils.serialize_request_body(request, :request_body, :json)
|
281
285
|
headers['content-type'] = req_content_type
|
286
|
+
query_params = Utils.get_query_params(::OpenApiSDK::Operations::UpdateCustomerRequest, request)
|
282
287
|
headers['Accept'] = 'application/json'
|
283
288
|
headers['user-agent'] = @sdk_configuration.user_agent
|
284
289
|
|
285
290
|
r = @sdk_configuration.client.patch(url) do |req|
|
286
291
|
req.headers = headers
|
292
|
+
req.params = query_params
|
287
293
|
Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
|
288
294
|
if form
|
289
295
|
req.body = Utils.encode_form(form)
|
data/lib/open_api_sdk/links.rb
CHANGED
@@ -547,8 +547,8 @@ module OpenApiSDK
|
|
547
547
|
)
|
548
548
|
if r.status == 200
|
549
549
|
if Utils.match_content_type(content_type, 'application/json')
|
550
|
-
out = Utils.unmarshal_complex(r.env.response_body, T::Array[::
|
551
|
-
res.
|
550
|
+
out = Utils.unmarshal_complex(r.env.response_body, T::Array[::Object])
|
551
|
+
res.anies = out
|
552
552
|
end
|
553
553
|
elsif r.status == 400
|
554
554
|
if Utils.match_content_type(content_type, 'application/json')
|
@@ -17,6 +17,8 @@ module OpenApiSDK
|
|
17
17
|
field :raw_response, ::Faraday::Response
|
18
18
|
# HTTP response status code for this operation
|
19
19
|
field :status_code, ::Integer
|
20
|
+
# The created links
|
21
|
+
field :anies, T.nilable(T::Array[::Object])
|
20
22
|
# The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
|
21
23
|
field :bad_request, T.nilable(::OpenApiSDK::Shared::BadRequest)
|
22
24
|
# This response is sent when a request conflicts with the current state of the server.
|
@@ -27,8 +29,6 @@ module OpenApiSDK
|
|
27
29
|
field :internal_server_error, T.nilable(::OpenApiSDK::Shared::InternalServerError)
|
28
30
|
# This response is sent when the requested content has been permanently deleted from server, with no forwarding address.
|
29
31
|
field :invite_expired, T.nilable(::OpenApiSDK::Shared::InviteExpired)
|
30
|
-
# The created links
|
31
|
-
field :link_schemas, T.nilable(T::Array[::OpenApiSDK::Shared::LinkSchema])
|
32
32
|
# The server cannot find the requested resource.
|
33
33
|
field :not_found, T.nilable(::OpenApiSDK::Shared::NotFound)
|
34
34
|
# The user has sent too many requests in a given amount of time ("rate limiting")
|
@@ -39,17 +39,17 @@ module OpenApiSDK
|
|
39
39
|
field :unprocessable_entity, T.nilable(::OpenApiSDK::Shared::UnprocessableEntity)
|
40
40
|
|
41
41
|
|
42
|
-
sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer,
|
43
|
-
def initialize(content_type: nil, raw_response: nil, status_code: nil, bad_request: nil, conflict: nil, forbidden: nil, internal_server_error: nil, invite_expired: nil,
|
42
|
+
sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, anies: T.nilable(T::Array[::Object]), bad_request: T.nilable(::OpenApiSDK::Shared::BadRequest), conflict: T.nilable(::OpenApiSDK::Shared::Conflict), forbidden: T.nilable(::OpenApiSDK::Shared::Forbidden), internal_server_error: T.nilable(::OpenApiSDK::Shared::InternalServerError), invite_expired: T.nilable(::OpenApiSDK::Shared::InviteExpired), not_found: T.nilable(::OpenApiSDK::Shared::NotFound), rate_limit_exceeded: T.nilable(::OpenApiSDK::Shared::RateLimitExceeded), unauthorized: T.nilable(::OpenApiSDK::Shared::Unauthorized), unprocessable_entity: T.nilable(::OpenApiSDK::Shared::UnprocessableEntity)).void }
|
43
|
+
def initialize(content_type: nil, raw_response: nil, status_code: nil, anies: nil, bad_request: nil, conflict: nil, forbidden: nil, internal_server_error: nil, invite_expired: nil, not_found: nil, rate_limit_exceeded: nil, unauthorized: nil, unprocessable_entity: nil)
|
44
44
|
@content_type = content_type
|
45
45
|
@raw_response = raw_response
|
46
46
|
@status_code = status_code
|
47
|
+
@anies = anies
|
47
48
|
@bad_request = bad_request
|
48
49
|
@conflict = conflict
|
49
50
|
@forbidden = forbidden
|
50
51
|
@internal_server_error = internal_server_error
|
51
52
|
@invite_expired = invite_expired
|
52
|
-
@link_schemas = link_schemas
|
53
53
|
@not_found = not_found
|
54
54
|
@rate_limit_exceeded = rate_limit_exceeded
|
55
55
|
@unauthorized = unauthorized
|
@@ -29,7 +29,7 @@ module OpenApiSDK
|
|
29
29
|
field :expired_url, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiredUrl') } }
|
30
30
|
# The date and time when the short link will expire at.
|
31
31
|
field :expires_at, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiresAt') } }
|
32
|
-
#
|
32
|
+
# The ID of the link in your database. 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). This key is unique across your workspace.
|
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') } }
|
@@ -63,6 +63,8 @@ module OpenApiSDK
|
|
63
63
|
field :tag_ids, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagIds') } }
|
64
64
|
# The unique name of the tags assigned to the short link (case insensitive).
|
65
65
|
field :tag_names, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagNames') } }
|
66
|
+
# 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.
|
67
|
+
field :tenant_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } }
|
66
68
|
# The custom link preview title (og:title). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
|
67
69
|
field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
|
68
70
|
# Whether to track conversions for the short link.
|
@@ -83,8 +85,8 @@ module OpenApiSDK
|
|
83
85
|
field :webhook_ids, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('webhookIds') } }
|
84
86
|
|
85
87
|
|
86
|
-
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), program_id: 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), webhook_ids: T.nilable(T::Array[::String])).void }
|
87
|
-
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, program_id: 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, webhook_ids: nil)
|
88
|
+
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), program_id: 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), tenant_id: T.nilable(::String), 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), webhook_ids: T.nilable(T::Array[::String])).void }
|
89
|
+
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, program_id: nil, proxy: nil, public_stats: nil, ref: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, tenant_id: nil, title: nil, track_conversion: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil, webhook_ids: nil)
|
88
90
|
@url = url
|
89
91
|
@android = android
|
90
92
|
@archived = archived
|
@@ -109,6 +111,7 @@ module OpenApiSDK
|
|
109
111
|
@tag_id = tag_id
|
110
112
|
@tag_ids = tag_ids
|
111
113
|
@tag_names = tag_names
|
114
|
+
@tenant_id = tenant_id
|
112
115
|
@title = title
|
113
116
|
@track_conversion = track_conversion
|
114
117
|
@utm_campaign = utm_campaign
|
@@ -53,6 +53,8 @@ module OpenApiSDK
|
|
53
53
|
field :tag_ids, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagIds') } }
|
54
54
|
# The unique name of the tags assigned to the short link (case insensitive).
|
55
55
|
field :tag_names, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagNames') } }
|
56
|
+
# 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.
|
57
|
+
field :tenant_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } }
|
56
58
|
# The custom link preview title (og:title). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
|
57
59
|
field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
|
58
60
|
# Whether to track conversions for the short link.
|
@@ -75,8 +77,8 @@ module OpenApiSDK
|
|
75
77
|
field :webhook_ids, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('webhookIds') } }
|
76
78
|
|
77
79
|
|
78
|
-
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), expired_url: T.nilable(::String), expires_at: T.nilable(::String), geo: T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), image: T.nilable(::String), ios: T.nilable(::String), password: T.nilable(::String), program_id: 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), webhook_ids: T.nilable(T::Array[::String])).void }
|
79
|
-
def initialize(android: nil, archived: nil, comments: nil, description: nil, do_index: nil, expired_url: nil, expires_at: nil, geo: nil, image: nil, ios: nil, password: nil, program_id: 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, webhook_ids: nil)
|
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), expired_url: T.nilable(::String), expires_at: T.nilable(::String), geo: T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), image: T.nilable(::String), ios: T.nilable(::String), password: T.nilable(::String), program_id: 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), tenant_id: T.nilable(::String), 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), webhook_ids: T.nilable(T::Array[::String])).void }
|
81
|
+
def initialize(android: nil, archived: nil, comments: nil, description: nil, do_index: nil, expired_url: nil, expires_at: nil, geo: nil, image: nil, ios: nil, password: nil, program_id: nil, proxy: nil, public_stats: nil, ref: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, tenant_id: 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, webhook_ids: nil)
|
80
82
|
@android = android
|
81
83
|
@archived = archived
|
82
84
|
@comments = comments
|
@@ -96,6 +98,7 @@ module OpenApiSDK
|
|
96
98
|
@tag_id = tag_id
|
97
99
|
@tag_ids = tag_ids
|
98
100
|
@tag_names = tag_names
|
101
|
+
@tenant_id = tenant_id
|
99
102
|
@title = title
|
100
103
|
@track_conversion = track_conversion
|
101
104
|
@url = url
|
@@ -13,11 +13,14 @@ module OpenApiSDK
|
|
13
13
|
|
14
14
|
# The unique identifier of the customer in Dub.
|
15
15
|
field :id, ::String, { 'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': false } }
|
16
|
+
# Whether to include expanded fields on the customer (`link`, `partner`, `discount`).
|
17
|
+
field :include_expanded_fields, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'includeExpandedFields', 'style': 'form', 'explode': true } }
|
16
18
|
|
17
19
|
|
18
|
-
sig { params(id: ::String).void }
|
19
|
-
def initialize(id: nil)
|
20
|
+
sig { params(id: ::String, include_expanded_fields: T.nilable(T::Boolean)).void }
|
21
|
+
def initialize(id: nil, include_expanded_fields: nil)
|
20
22
|
@id = id
|
23
|
+
@include_expanded_fields = include_expanded_fields
|
21
24
|
end
|
22
25
|
end
|
23
26
|
end
|
@@ -0,0 +1,30 @@
|
|
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
|
+
|
11
|
+
class GetCustomersRequest < ::OpenApiSDK::Utils::FieldAugmented
|
12
|
+
extend T::Sig
|
13
|
+
|
14
|
+
# A case-sensitive filter on the list based on the customer's `email` field. The value must be a string.
|
15
|
+
field :email, T.nilable(::String), { 'query_param': { 'field_name': 'email', 'style': 'form', 'explode': true } }
|
16
|
+
# A case-sensitive filter on the list based on the customer's `externalId` field. The value must be a string.
|
17
|
+
field :external_id, T.nilable(::String), { 'query_param': { 'field_name': 'externalId', 'style': 'form', 'explode': true } }
|
18
|
+
# Whether to include expanded fields on the customer (`link`, `partner`, `discount`).
|
19
|
+
field :include_expanded_fields, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'includeExpandedFields', 'style': 'form', 'explode': true } }
|
20
|
+
|
21
|
+
|
22
|
+
sig { params(email: T.nilable(::String), external_id: T.nilable(::String), include_expanded_fields: T.nilable(T::Boolean)).void }
|
23
|
+
def initialize(email: nil, external_id: nil, include_expanded_fields: nil)
|
24
|
+
@email = email
|
25
|
+
@external_id = external_id
|
26
|
+
@include_expanded_fields = include_expanded_fields
|
27
|
+
end
|
28
|
+
end
|
29
|
+
end
|
30
|
+
end
|
@@ -21,31 +21,40 @@ module OpenApiSDK
|
|
21
21
|
field :search, T.nilable(::String), { 'query_param': { 'field_name': 'search', 'style': 'form', 'explode': true } }
|
22
22
|
# Whether to include archived links in the response. Defaults to `false` if not provided.
|
23
23
|
field :show_archived, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'showArchived', 'style': 'form', 'explode': true } }
|
24
|
-
#
|
24
|
+
# DEPRECATED. Use `sortBy` instead.
|
25
25
|
field :sort, T.nilable(::OpenApiSDK::Operations::Sort), { 'query_param': { 'field_name': 'sort', 'style': 'form', 'explode': true } }
|
26
|
+
# The field to sort the links by. The default is `createdAt`.
|
27
|
+
field :sort_by, T.nilable(::OpenApiSDK::Operations::SortBy), { 'query_param': { 'field_name': 'sortBy', 'style': 'form', 'explode': true } }
|
28
|
+
# The sort order. The default is `desc`.
|
29
|
+
field :sort_order, T.nilable(::OpenApiSDK::Operations::SortOrder), { 'query_param': { 'field_name': 'sortOrder', 'style': 'form', 'explode': true } }
|
26
30
|
# Deprecated. Use `tagIds` instead. The tag ID to filter the links by.
|
27
31
|
field :tag_id, T.nilable(::String), { 'query_param': { 'field_name': 'tagId', 'style': 'form', 'explode': true } }
|
28
32
|
# The tag IDs to filter the links by.
|
29
33
|
field :tag_ids, T.nilable(::Object), { 'query_param': { 'field_name': 'tagIds', 'style': 'form', 'explode': true } }
|
30
34
|
# The unique name of the tags assigned to the short link (case insensitive).
|
31
35
|
field :tag_names, T.nilable(::Object), { 'query_param': { 'field_name': 'tagNames', 'style': 'form', 'explode': true } }
|
36
|
+
# The ID of the tenant that created the link inside your system. If set, will only return links for the specified tenant.
|
37
|
+
field :tenant_id, T.nilable(::String), { 'query_param': { 'field_name': 'tenantId', 'style': 'form', 'explode': true } }
|
32
38
|
# The user ID to filter the links by.
|
33
39
|
field :user_id, T.nilable(::String), { 'query_param': { 'field_name': 'userId', 'style': 'form', 'explode': true } }
|
34
40
|
# DEPRECATED. Filter for links that have at least one tag assigned to them.
|
35
41
|
field :with_tags, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'withTags', 'style': 'form', 'explode': true } }
|
36
42
|
|
37
43
|
|
38
|
-
sig { params(domain: T.nilable(::String), page: T.nilable(::Float), page_size: T.nilable(::Float), search: T.nilable(::String), show_archived: T.nilable(T::Boolean), sort: T.nilable(::OpenApiSDK::Operations::Sort), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), user_id: T.nilable(::String), with_tags: T.nilable(T::Boolean)).void }
|
39
|
-
def initialize(domain: nil, page: nil, page_size: nil, search: nil, show_archived: nil, sort: nil, tag_id: nil, tag_ids: nil, tag_names: nil, user_id: nil, with_tags: nil)
|
44
|
+
sig { params(domain: T.nilable(::String), page: T.nilable(::Float), page_size: T.nilable(::Float), search: T.nilable(::String), show_archived: T.nilable(T::Boolean), sort: T.nilable(::OpenApiSDK::Operations::Sort), sort_by: T.nilable(::OpenApiSDK::Operations::SortBy), sort_order: T.nilable(::OpenApiSDK::Operations::SortOrder), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), tenant_id: T.nilable(::String), user_id: T.nilable(::String), with_tags: T.nilable(T::Boolean)).void }
|
45
|
+
def initialize(domain: nil, page: nil, page_size: nil, search: nil, show_archived: nil, sort: nil, sort_by: nil, sort_order: nil, tag_id: nil, tag_ids: nil, tag_names: nil, tenant_id: nil, user_id: nil, with_tags: nil)
|
40
46
|
@domain = domain
|
41
47
|
@page = page
|
42
48
|
@page_size = page_size
|
43
49
|
@search = search
|
44
50
|
@show_archived = show_archived
|
45
51
|
@sort = sort
|
52
|
+
@sort_by = sort_by
|
53
|
+
@sort_order = sort_order
|
46
54
|
@tag_id = tag_id
|
47
55
|
@tag_ids = tag_ids
|
48
56
|
@tag_names = tag_names
|
57
|
+
@tenant_id = tenant_id
|
49
58
|
@user_id = user_id
|
50
59
|
@with_tags = with_tags
|
51
60
|
end
|
@@ -25,14 +25,16 @@ module OpenApiSDK
|
|
25
25
|
field :tag_ids, T.nilable(::Object), { 'query_param': { 'field_name': 'tagIds', 'style': 'form', 'explode': true } }
|
26
26
|
# The unique name of the tags assigned to the short link (case insensitive).
|
27
27
|
field :tag_names, T.nilable(::Object), { 'query_param': { 'field_name': 'tagNames', 'style': 'form', 'explode': true } }
|
28
|
+
# The ID of the tenant that created the link inside your system. If set, will only return links for the specified tenant.
|
29
|
+
field :tenant_id, T.nilable(::String), { 'query_param': { 'field_name': 'tenantId', 'style': 'form', 'explode': true } }
|
28
30
|
# The user ID to filter the links by.
|
29
31
|
field :user_id, T.nilable(::String), { 'query_param': { 'field_name': 'userId', 'style': 'form', 'explode': true } }
|
30
32
|
# DEPRECATED. Filter for links that have at least one tag assigned to them.
|
31
33
|
field :with_tags, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'withTags', 'style': 'form', 'explode': true } }
|
32
34
|
|
33
35
|
|
34
|
-
sig { params(domain: T.nilable(::String), group_by: T.nilable(::Object), search: T.nilable(::String), show_archived: T.nilable(T::Boolean), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), user_id: T.nilable(::String), with_tags: T.nilable(T::Boolean)).void }
|
35
|
-
def initialize(domain: nil, group_by: nil, search: nil, show_archived: nil, tag_id: nil, tag_ids: nil, tag_names: nil, user_id: nil, with_tags: nil)
|
36
|
+
sig { params(domain: T.nilable(::String), group_by: T.nilable(::Object), search: T.nilable(::String), show_archived: T.nilable(T::Boolean), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), tenant_id: T.nilable(::String), user_id: T.nilable(::String), with_tags: T.nilable(T::Boolean)).void }
|
37
|
+
def initialize(domain: nil, group_by: nil, search: nil, show_archived: nil, tag_id: nil, tag_ids: nil, tag_names: nil, tenant_id: nil, user_id: nil, with_tags: nil)
|
36
38
|
@domain = domain
|
37
39
|
@group_by = group_by
|
38
40
|
@search = search
|
@@ -40,6 +42,7 @@ module OpenApiSDK
|
|
40
42
|
@tag_id = tag_id
|
41
43
|
@tag_ids = tag_ids
|
42
44
|
@tag_names = tag_names
|
45
|
+
@tenant_id = tenant_id
|
43
46
|
@user_id = user_id
|
44
47
|
@with_tags = with_tags
|
45
48
|
end
|
@@ -37,7 +37,7 @@ module OpenApiSDK
|
|
37
37
|
field :limit, T.nilable(::Float), { 'query_param': { 'field_name': 'limit', 'style': 'form', 'explode': true } }
|
38
38
|
# The unique ID of the short link on Dub.
|
39
39
|
field :link_id, T.nilable(::String), { 'query_param': { 'field_name': 'linkId', 'style': 'form', 'explode': true } }
|
40
|
-
|
40
|
+
# DEPRECATED. Use `sortOrder` instead.
|
41
41
|
field :order, T.nilable(::OpenApiSDK::Operations::Order), { 'query_param': { 'field_name': 'order', 'style': 'form', 'explode': true } }
|
42
42
|
# The OS to retrieve analytics for.
|
43
43
|
field :os, T.nilable(::String), { 'query_param': { 'field_name': 'os', 'style': 'form', 'explode': true } }
|
@@ -53,8 +53,10 @@ module OpenApiSDK
|
|
53
53
|
field :region, T.nilable(::String), { 'query_param': { 'field_name': 'region', 'style': 'form', 'explode': true } }
|
54
54
|
# Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.
|
55
55
|
field :root, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'root', 'style': 'form', 'explode': true } }
|
56
|
-
|
57
|
-
field :sort_by, T.nilable(::OpenApiSDK::Operations::
|
56
|
+
# The field to sort the events by. The default is `timestamp`.
|
57
|
+
field :sort_by, T.nilable(::OpenApiSDK::Operations::QueryParamSortBy), { 'query_param': { 'field_name': 'sortBy', 'style': 'form', 'explode': true } }
|
58
|
+
# The sort order. The default is `desc`.
|
59
|
+
field :sort_order, T.nilable(::OpenApiSDK::Operations::QueryParamSortOrder), { 'query_param': { 'field_name': 'sortOrder', 'style': 'form', 'explode': true } }
|
58
60
|
# The start date and time when to retrieve analytics from. Takes precedence over `interval`.
|
59
61
|
field :start, T.nilable(::String), { 'query_param': { 'field_name': 'start', 'style': 'form', 'explode': true } }
|
60
62
|
# Deprecated. Use `tagIds` instead. The tag ID to retrieve analytics for.
|
@@ -69,8 +71,8 @@ module OpenApiSDK
|
|
69
71
|
field :url, T.nilable(::String), { 'query_param': { 'field_name': 'url', 'style': 'form', 'explode': true } }
|
70
72
|
|
71
73
|
|
72
|
-
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), region: T.nilable(::String), root: T.nilable(T::Boolean), sort_by: T.nilable(::OpenApiSDK::Operations::
|
73
|
-
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, region: nil, root: nil, sort_by: nil, start: nil, tag_id: nil, tag_ids: nil, timezone: nil, trigger: nil, url: nil)
|
74
|
+
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), region: T.nilable(::String), root: T.nilable(T::Boolean), sort_by: T.nilable(::OpenApiSDK::Operations::QueryParamSortBy), sort_order: T.nilable(::OpenApiSDK::Operations::QueryParamSortOrder), start: T.nilable(::String), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), timezone: T.nilable(::String), trigger: T.nilable(::OpenApiSDK::Operations::QueryParamTrigger), url: T.nilable(::String)).void }
|
75
|
+
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, region: nil, root: nil, sort_by: nil, sort_order: nil, start: nil, tag_id: nil, tag_ids: nil, timezone: nil, trigger: nil, url: nil)
|
74
76
|
@browser = browser
|
75
77
|
@city = city
|
76
78
|
@continent = continent
|
@@ -93,6 +95,7 @@ module OpenApiSDK
|
|
93
95
|
@region = region
|
94
96
|
@root = root
|
95
97
|
@sort_by = sort_by
|
98
|
+
@sort_order = sort_order
|
96
99
|
@start = start
|
97
100
|
@tag_id = tag_id
|
98
101
|
@tag_ids = tag_ids
|
@@ -7,7 +7,9 @@
|
|
7
7
|
module OpenApiSDK
|
8
8
|
module Operations
|
9
9
|
|
10
|
-
# Order
|
10
|
+
# Order - DEPRECATED. Use `sortOrder` instead.
|
11
|
+
#
|
12
|
+
# @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
|
11
13
|
class Order < T::Enum
|
12
14
|
enums do
|
13
15
|
ASC = new('asc')
|
@@ -0,0 +1,17 @@
|
|
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
|
+
# QueryParamSortBy - The field to sort the events by. The default is `timestamp`.
|
11
|
+
class QueryParamSortBy < T::Enum
|
12
|
+
enums do
|
13
|
+
TIMESTAMP = new('timestamp')
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
17
|
+
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
|
+
# QueryParamSortOrder - The sort order. The default is `desc`.
|
11
|
+
class QueryParamSortOrder < T::Enum
|
12
|
+
enums do
|
13
|
+
ASC = new('asc')
|
14
|
+
DESC = new('desc')
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -29,7 +29,7 @@ module OpenApiSDK
|
|
29
29
|
field :expired_url, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiredUrl') } }
|
30
30
|
# The date and time when the short link will expire at.
|
31
31
|
field :expires_at, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiresAt') } }
|
32
|
-
#
|
32
|
+
# The ID of the link in your database. 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). This key is unique across your workspace.
|
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') } }
|
@@ -63,6 +63,8 @@ module OpenApiSDK
|
|
63
63
|
field :tag_ids, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagIds') } }
|
64
64
|
# The unique name of the tags assigned to the short link (case insensitive).
|
65
65
|
field :tag_names, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagNames') } }
|
66
|
+
# 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.
|
67
|
+
field :tenant_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } }
|
66
68
|
# The custom link preview title (og:title). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
|
67
69
|
field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
|
68
70
|
# Whether to track conversions for the short link.
|
@@ -83,8 +85,8 @@ module OpenApiSDK
|
|
83
85
|
field :webhook_ids, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('webhookIds') } }
|
84
86
|
|
85
87
|
|
86
|
-
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), program_id: 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), webhook_ids: T.nilable(T::Array[::String])).void }
|
87
|
-
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, program_id: 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, webhook_ids: nil)
|
88
|
+
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), program_id: 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), tenant_id: T.nilable(::String), 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), webhook_ids: T.nilable(T::Array[::String])).void }
|
89
|
+
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, program_id: nil, proxy: nil, public_stats: nil, ref: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, tenant_id: nil, title: nil, track_conversion: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil, webhook_ids: nil)
|
88
90
|
@url = url
|
89
91
|
@android = android
|
90
92
|
@archived = archived
|
@@ -109,6 +111,7 @@ module OpenApiSDK
|
|
109
111
|
@tag_id = tag_id
|
110
112
|
@tag_ids = tag_ids
|
111
113
|
@tag_names = tag_names
|
114
|
+
@tenant_id = tenant_id
|
112
115
|
@title = title
|
113
116
|
@track_conversion = track_conversion
|
114
117
|
@utm_campaign = utm_campaign
|
@@ -7,11 +7,14 @@
|
|
7
7
|
module OpenApiSDK
|
8
8
|
module Operations
|
9
9
|
|
10
|
-
# Sort -
|
10
|
+
# Sort - DEPRECATED. Use `sortBy` instead.
|
11
|
+
#
|
12
|
+
# @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
|
11
13
|
class Sort < T::Enum
|
12
14
|
enums do
|
13
15
|
CREATED_AT = new('createdAt')
|
14
16
|
CLICKS = new('clicks')
|
17
|
+
SALE_AMOUNT = new('saleAmount')
|
15
18
|
LAST_CLICKED = new('lastClicked')
|
16
19
|
end
|
17
20
|
end
|
@@ -7,10 +7,13 @@
|
|
7
7
|
module OpenApiSDK
|
8
8
|
module Operations
|
9
9
|
|
10
|
-
# SortBy
|
10
|
+
# SortBy - The field to sort the links by. The default is `createdAt`.
|
11
11
|
class SortBy < T::Enum
|
12
12
|
enums do
|
13
|
-
|
13
|
+
CREATED_AT = new('createdAt')
|
14
|
+
CLICKS = new('clicks')
|
15
|
+
SALE_AMOUNT = new('saleAmount')
|
16
|
+
LAST_CLICKED = new('lastClicked')
|
14
17
|
end
|
15
18
|
end
|
16
19
|
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
|
+
# SortOrder - The sort order. The default is `desc`.
|
11
|
+
class SortOrder < T::Enum
|
12
|
+
enums do
|
13
|
+
ASC = new('asc')
|
14
|
+
DESC = new('desc')
|
15
|
+
end
|
16
|
+
end
|
17
|
+
end
|
18
|
+
end
|
@@ -13,13 +13,16 @@ module OpenApiSDK
|
|
13
13
|
|
14
14
|
# The unique identifier of the customer in Dub.
|
15
15
|
field :id, ::String, { 'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': false } }
|
16
|
+
# Whether to include expanded fields on the customer (`link`, `partner`, `discount`).
|
17
|
+
field :include_expanded_fields, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'includeExpandedFields', 'style': 'form', 'explode': true } }
|
16
18
|
|
17
19
|
field :request_body, T.nilable(::OpenApiSDK::Operations::UpdateCustomerRequestBody), { 'request': { 'media_type': 'application/json' } }
|
18
20
|
|
19
21
|
|
20
|
-
sig { params(id: ::String, request_body: T.nilable(::OpenApiSDK::Operations::UpdateCustomerRequestBody)).void }
|
21
|
-
def initialize(id: nil, request_body: nil)
|
22
|
+
sig { params(id: ::String, include_expanded_fields: T.nilable(T::Boolean), request_body: T.nilable(::OpenApiSDK::Operations::UpdateCustomerRequestBody)).void }
|
23
|
+
def initialize(id: nil, include_expanded_fields: nil, request_body: nil)
|
22
24
|
@id = id
|
25
|
+
@include_expanded_fields = include_expanded_fields
|
23
26
|
@request_body = request_body
|
24
27
|
end
|
25
28
|
end
|
@@ -27,7 +27,7 @@ module OpenApiSDK
|
|
27
27
|
field :expired_url, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiredUrl') } }
|
28
28
|
# The date and time when the short link will expire at.
|
29
29
|
field :expires_at, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiresAt') } }
|
30
|
-
#
|
30
|
+
# The ID of the link in your database. 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). This key is unique across your workspace.
|
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') } }
|
@@ -61,6 +61,8 @@ module OpenApiSDK
|
|
61
61
|
field :tag_ids, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagIds') } }
|
62
62
|
# The unique name of the tags assigned to the short link (case insensitive).
|
63
63
|
field :tag_names, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagNames') } }
|
64
|
+
# 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.
|
65
|
+
field :tenant_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } }
|
64
66
|
# The custom link preview title (og:title). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
|
65
67
|
field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
|
66
68
|
# Whether to track conversions for the short link.
|
@@ -83,8 +85,8 @@ module OpenApiSDK
|
|
83
85
|
field :webhook_ids, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('webhookIds') } }
|
84
86
|
|
85
87
|
|
86
|
-
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), program_id: 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), webhook_ids: T.nilable(T::Array[::String])).void }
|
87
|
-
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, program_id: 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, webhook_ids: nil)
|
88
|
+
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), program_id: 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), tenant_id: T.nilable(::String), 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), webhook_ids: T.nilable(T::Array[::String])).void }
|
89
|
+
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, program_id: nil, proxy: nil, public_stats: nil, ref: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, tenant_id: 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, webhook_ids: nil)
|
88
90
|
@android = android
|
89
91
|
@archived = archived
|
90
92
|
@comments = comments
|
@@ -108,6 +110,7 @@ module OpenApiSDK
|
|
108
110
|
@tag_id = tag_id
|
109
111
|
@tag_ids = tag_ids
|
110
112
|
@tag_names = tag_names
|
113
|
+
@tenant_id = tenant_id
|
111
114
|
@title = title
|
112
115
|
@track_conversion = track_conversion
|
113
116
|
@url = url
|
@@ -29,7 +29,7 @@ module OpenApiSDK
|
|
29
29
|
field :expired_url, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiredUrl') } }
|
30
30
|
# The date and time when the short link will expire at.
|
31
31
|
field :expires_at, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiresAt') } }
|
32
|
-
#
|
32
|
+
# The ID of the link in your database. 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). This key is unique across your workspace.
|
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') } }
|
@@ -63,6 +63,8 @@ module OpenApiSDK
|
|
63
63
|
field :tag_ids, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagIds') } }
|
64
64
|
# The unique name of the tags assigned to the short link (case insensitive).
|
65
65
|
field :tag_names, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagNames') } }
|
66
|
+
# 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.
|
67
|
+
field :tenant_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } }
|
66
68
|
# The custom link preview title (og:title). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
|
67
69
|
field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
|
68
70
|
# Whether to track conversions for the short link.
|
@@ -83,8 +85,8 @@ module OpenApiSDK
|
|
83
85
|
field :webhook_ids, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('webhookIds') } }
|
84
86
|
|
85
87
|
|
86
|
-
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), program_id: 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), webhook_ids: T.nilable(T::Array[::String])).void }
|
87
|
-
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, program_id: 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, webhook_ids: nil)
|
88
|
+
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), program_id: 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), tenant_id: T.nilable(::String), 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), webhook_ids: T.nilable(T::Array[::String])).void }
|
89
|
+
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, program_id: nil, proxy: nil, public_stats: nil, ref: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, tenant_id: nil, title: nil, track_conversion: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil, webhook_ids: nil)
|
88
90
|
@url = url
|
89
91
|
@android = android
|
90
92
|
@archived = archived
|
@@ -109,6 +111,7 @@ module OpenApiSDK
|
|
109
111
|
@tag_id = tag_id
|
110
112
|
@tag_ids = tag_ids
|
111
113
|
@tag_names = tag_names
|
114
|
+
@tenant_id = tenant_id
|
112
115
|
@title = title
|
113
116
|
@track_conversion = track_conversion
|
114
117
|
@utm_campaign = utm_campaign
|
@@ -7,6 +7,8 @@ module OpenApiSDK
|
|
7
7
|
module Operations
|
8
8
|
autoload :CreateLinkRequestBody, 'open_api_sdk/models/operations/createlink_requestbody.rb'
|
9
9
|
autoload :CreateLinkResponse, 'open_api_sdk/models/operations/createlink_response.rb'
|
10
|
+
autoload :SortBy, 'open_api_sdk/models/operations/sortby.rb'
|
11
|
+
autoload :SortOrder, 'open_api_sdk/models/operations/sortorder.rb'
|
10
12
|
autoload :Sort, 'open_api_sdk/models/operations/sort.rb'
|
11
13
|
autoload :GetLinksRequest, 'open_api_sdk/models/operations/getlinks_request.rb'
|
12
14
|
autoload :GetLinksResponse, 'open_api_sdk/models/operations/getlinks_response.rb'
|
@@ -39,8 +41,9 @@ module OpenApiSDK
|
|
39
41
|
autoload :QueryParamEvent, 'open_api_sdk/models/operations/queryparam_event.rb'
|
40
42
|
autoload :QueryParamInterval, 'open_api_sdk/models/operations/queryparam_interval.rb'
|
41
43
|
autoload :QueryParamTrigger, 'open_api_sdk/models/operations/queryparam_trigger.rb'
|
44
|
+
autoload :QueryParamSortOrder, 'open_api_sdk/models/operations/queryparam_sortorder.rb'
|
45
|
+
autoload :QueryParamSortBy, 'open_api_sdk/models/operations/queryparam_sortby.rb'
|
42
46
|
autoload :Order, 'open_api_sdk/models/operations/order.rb'
|
43
|
-
autoload :SortBy, 'open_api_sdk/models/operations/sortby.rb'
|
44
47
|
autoload :ListEventsRequest, 'open_api_sdk/models/operations/listevents_request.rb'
|
45
48
|
autoload :ListEventsResponse, 'open_api_sdk/models/operations/listevents_response.rb'
|
46
49
|
autoload :Color, 'open_api_sdk/models/operations/color.rb'
|
@@ -75,6 +78,7 @@ module OpenApiSDK
|
|
75
78
|
autoload :Sale, 'open_api_sdk/models/operations/sale.rb'
|
76
79
|
autoload :TrackSaleResponseBody, 'open_api_sdk/models/operations/tracksale_responsebody.rb'
|
77
80
|
autoload :TrackSaleResponse, 'open_api_sdk/models/operations/tracksale_response.rb'
|
81
|
+
autoload :GetCustomersRequest, 'open_api_sdk/models/operations/getcustomers_request.rb'
|
78
82
|
autoload :Link, 'open_api_sdk/models/operations/link.rb'
|
79
83
|
autoload :Partner, 'open_api_sdk/models/operations/partner.rb'
|
80
84
|
autoload :Type, 'open_api_sdk/models/operations/type.rb'
|
@@ -27,7 +27,7 @@ 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
|
-
#
|
30
|
+
# The ID of the link in your database. 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). This key is unique across your workspace.
|
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') } }
|
@@ -41,7 +41,7 @@ module OpenApiSDK
|
|
41
41
|
field :key, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('key') } }
|
42
42
|
|
43
43
|
field :last_clicked, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('lastClicked') } }
|
44
|
-
#
|
44
|
+
# The number of leads the short links has generated.
|
45
45
|
field :leads, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('leads') } }
|
46
46
|
# The password required to access the destination URL of the short link.
|
47
47
|
field :password, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('password') } }
|
@@ -53,9 +53,9 @@ module OpenApiSDK
|
|
53
53
|
field :project_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('projectId') } }
|
54
54
|
# The full URL of the QR code for the short link (e.g. `https://api.dub.co/qr?url=https://dub.sh/try`).
|
55
55
|
field :qr_code, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('qrCode') } }
|
56
|
-
#
|
56
|
+
# The total dollar amount of sales the short links has generated (in cents).
|
57
57
|
field :sale_amount, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('saleAmount') } }
|
58
|
-
#
|
58
|
+
# The number of sales the short links has generated.
|
59
59
|
field :sales, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('sales') } }
|
60
60
|
# The full URL of the short link, including the https protocol (e.g. `https://dub.sh/try`).
|
61
61
|
field :short_link, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('shortLink') } }
|
@@ -65,6 +65,8 @@ module OpenApiSDK
|
|
65
65
|
field :tag_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagId') } }
|
66
66
|
# The tags assigned to the short link.
|
67
67
|
field :tags, T::Array[::OpenApiSDK::Shared::TagSchema], { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tags') } }
|
68
|
+
# 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.
|
69
|
+
field :tenant_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } }
|
68
70
|
# The title of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
|
69
71
|
field :title, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
|
70
72
|
|
@@ -103,8 +105,8 @@ module OpenApiSDK
|
|
103
105
|
field :track_conversion, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trackConversion') } }
|
104
106
|
|
105
107
|
|
106
|
-
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, program_id: ::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, webhook_ids: T::Array[::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 }
|
107
|
-
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, program_id: 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, webhook_ids: nil, workspace_id: nil, archived: nil, do_index: nil, proxy: nil, public_stats: nil, rewrite: nil, track_conversion: nil)
|
108
|
+
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, program_id: ::String, project_id: ::String, qr_code: ::String, sale_amount: ::Float, sales: ::Float, short_link: ::String, tag_id: ::String, tags: T::Array[::OpenApiSDK::Shared::TagSchema], tenant_id: ::String, 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, webhook_ids: T::Array[::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 }
|
109
|
+
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, program_id: nil, project_id: nil, qr_code: nil, sale_amount: nil, sales: nil, short_link: nil, tag_id: nil, tags: nil, tenant_id: 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, webhook_ids: nil, workspace_id: nil, archived: nil, do_index: nil, proxy: nil, public_stats: nil, rewrite: nil, track_conversion: nil)
|
108
110
|
@android = android
|
109
111
|
@clicks = clicks
|
110
112
|
@comments = comments
|
@@ -130,6 +132,7 @@ module OpenApiSDK
|
|
130
132
|
@short_link = short_link
|
131
133
|
@tag_id = tag_id
|
132
134
|
@tags = tags
|
135
|
+
@tenant_id = tenant_id
|
133
136
|
@title = title
|
134
137
|
@updated_at = updated_at
|
135
138
|
@url = url
|
@@ -31,7 +31,7 @@ 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
|
-
#
|
34
|
+
# The ID of the link in your database. 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). This key is unique across your workspace.
|
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') } }
|
@@ -45,7 +45,7 @@ module OpenApiSDK
|
|
45
45
|
field :key, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('key') } }
|
46
46
|
# The date and time when the short link was last clicked.
|
47
47
|
field :last_clicked, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('lastClicked') } }
|
48
|
-
#
|
48
|
+
# The number of leads the short links has generated.
|
49
49
|
field :leads, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('leads') } }
|
50
50
|
# The password required to access the destination URL of the short link.
|
51
51
|
field :password, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('password') } }
|
@@ -63,9 +63,9 @@ module OpenApiSDK
|
|
63
63
|
field :qr_code, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('qrCode') } }
|
64
64
|
# Whether the short link uses link cloaking.
|
65
65
|
field :rewrite, T::Boolean, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('rewrite') } }
|
66
|
-
#
|
66
|
+
# The total dollar amount of sales the short links has generated (in cents).
|
67
67
|
field :sale_amount, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('saleAmount') } }
|
68
|
-
#
|
68
|
+
# The number of sales the short links has generated.
|
69
69
|
field :sales, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('sales') } }
|
70
70
|
# The full URL of the short link, including the https protocol (e.g. `https://dub.sh/try`).
|
71
71
|
field :short_link, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('shortLink') } }
|
@@ -75,9 +75,11 @@ module OpenApiSDK
|
|
75
75
|
field :tag_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagId') } }
|
76
76
|
# The tags assigned to the short link.
|
77
77
|
field :tags, T::Array[::OpenApiSDK::Shared::TagSchema], { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tags') } }
|
78
|
+
# 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.
|
79
|
+
field :tenant_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } }
|
78
80
|
# The title of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
|
79
81
|
field :title, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
|
80
|
-
#
|
82
|
+
# Whether to track conversions for the short link.
|
81
83
|
field :track_conversion, T::Boolean, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trackConversion') } }
|
82
84
|
# The date and time when the short link was last updated.
|
83
85
|
field :updated_at, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('updatedAt') } }
|
@@ -103,8 +105,8 @@ module OpenApiSDK
|
|
103
105
|
field :workspace_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('workspaceId') } }
|
104
106
|
|
105
107
|
|
106
|
-
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, program_id: ::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, webhook_ids: T::Array[::String], workspace_id: ::String).void }
|
107
|
-
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, program_id: 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, webhook_ids: nil, workspace_id: nil)
|
108
|
+
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, program_id: ::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], tenant_id: ::String, 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, webhook_ids: T::Array[::String], workspace_id: ::String).void }
|
109
|
+
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, program_id: 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, tenant_id: 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, webhook_ids: nil, workspace_id: nil)
|
108
110
|
@android = android
|
109
111
|
@archived = archived
|
110
112
|
@clicks = clicks
|
@@ -135,6 +137,7 @@ module OpenApiSDK
|
|
135
137
|
@short_link = short_link
|
136
138
|
@tag_id = tag_id
|
137
139
|
@tags = tags
|
140
|
+
@tenant_id = tenant_id
|
138
141
|
@title = title
|
139
142
|
@track_conversion = track_conversion
|
140
143
|
@updated_at = updated_at
|
@@ -53,7 +53,7 @@ module OpenApiSDK
|
|
53
53
|
field :sales_usage, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('salesUsage') } }
|
54
54
|
# The slug of the workspace.
|
55
55
|
field :slug, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('slug') } }
|
56
|
-
#
|
56
|
+
# The Stripe Connect ID of the workspace.
|
57
57
|
field :stripe_connect_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('stripeConnectId') } }
|
58
58
|
# The Stripe ID of the workspace.
|
59
59
|
field :stripe_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('stripeId') } }
|
@@ -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.51'
|
42
|
+
@gen_version = '2.493.4'
|
43
|
+
@user_agent = 'speakeasy-sdk/ruby 0.2.2-alpha.51 2.493.4 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.51
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Dub
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date:
|
11
|
+
date: 2025-01-12 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: faraday
|
@@ -202,6 +202,7 @@ files:
|
|
202
202
|
- lib/open_api_sdk/models/operations/getcustomer_responsebody.rb
|
203
203
|
- lib/open_api_sdk/models/operations/getcustomer_type.rb
|
204
204
|
- lib/open_api_sdk/models/operations/getcustomers_interval.rb
|
205
|
+
- lib/open_api_sdk/models/operations/getcustomers_request.rb
|
205
206
|
- lib/open_api_sdk/models/operations/getcustomers_response.rb
|
206
207
|
- lib/open_api_sdk/models/operations/getlinkinfo_request.rb
|
207
208
|
- lib/open_api_sdk/models/operations/getlinkinfo_response.rb
|
@@ -230,6 +231,8 @@ files:
|
|
230
231
|
- lib/open_api_sdk/models/operations/paymentprocessor.rb
|
231
232
|
- lib/open_api_sdk/models/operations/queryparam_event.rb
|
232
233
|
- lib/open_api_sdk/models/operations/queryparam_interval.rb
|
234
|
+
- lib/open_api_sdk/models/operations/queryparam_sortby.rb
|
235
|
+
- lib/open_api_sdk/models/operations/queryparam_sortorder.rb
|
233
236
|
- lib/open_api_sdk/models/operations/queryparam_trigger.rb
|
234
237
|
- lib/open_api_sdk/models/operations/requestbody.rb
|
235
238
|
- lib/open_api_sdk/models/operations/responsebody.rb
|
@@ -238,6 +241,7 @@ files:
|
|
238
241
|
- lib/open_api_sdk/models/operations/sale.rb
|
239
242
|
- lib/open_api_sdk/models/operations/sort.rb
|
240
243
|
- lib/open_api_sdk/models/operations/sortby.rb
|
244
|
+
- lib/open_api_sdk/models/operations/sortorder.rb
|
241
245
|
- lib/open_api_sdk/models/operations/tracklead_requestbody.rb
|
242
246
|
- lib/open_api_sdk/models/operations/tracklead_response.rb
|
243
247
|
- lib/open_api_sdk/models/operations/tracklead_responsebody.rb
|