dub 0.1.2 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/open_api_sdk/analytics.rb +1 -1
- data/lib/open_api_sdk/domains.rb +6 -16
- data/lib/open_api_sdk/dub.rb +1 -20
- data/lib/open_api_sdk/links.rb +14 -26
- data/lib/open_api_sdk/metatags.rb +1 -1
- data/lib/open_api_sdk/models/operations/deletedomain_request.rb +2 -8
- data/lib/open_api_sdk/models/operations/deletelink_request.rb +2 -8
- data/lib/open_api_sdk/models/operations/getlinkinfo_request.rb +2 -8
- data/lib/open_api_sdk/models/operations/getlinks_request.rb +2 -8
- data/lib/open_api_sdk/models/operations/getlinkscount_request.rb +2 -8
- data/lib/open_api_sdk/models/operations/retrieveanalytics_request.rb +2 -8
- data/lib/open_api_sdk/models/operations/updatedomain_request.rb +2 -8
- data/lib/open_api_sdk/models/operations/updatelink_request.rb +2 -8
- data/lib/open_api_sdk/models/operations/updatelink_requestbody.rb +6 -6
- data/lib/open_api_sdk/models/operations/updatetag_request.rb +3 -9
- data/lib/open_api_sdk/models/operations/updateworkspace_request.rb +6 -3
- data/lib/open_api_sdk/models/operations/updateworkspace_requestbody.rb +27 -0
- data/lib/open_api_sdk/models/operations.rb +1 -10
- data/lib/open_api_sdk/qr_codes.rb +1 -1
- data/lib/open_api_sdk/sdkconfiguration.rb +5 -7
- data/lib/open_api_sdk/tags.rb +5 -12
- data/lib/open_api_sdk/track.rb +6 -12
- data/lib/open_api_sdk/workspaces.rb +11 -4
- metadata +3 -12
- data/lib/open_api_sdk/models/operations/bulkcreatelinks_request.rb +0 -30
- data/lib/open_api_sdk/models/operations/createdomain_request.rb +0 -30
- data/lib/open_api_sdk/models/operations/createlink_request.rb +0 -30
- data/lib/open_api_sdk/models/operations/createtag_request.rb +0 -30
- data/lib/open_api_sdk/models/operations/gettags_request.rb +0 -27
- data/lib/open_api_sdk/models/operations/listdomains_request.rb +0 -27
- data/lib/open_api_sdk/models/operations/trackcustomer_request.rb +0 -30
- data/lib/open_api_sdk/models/operations/tracklead_request.rb +0 -30
- data/lib/open_api_sdk/models/operations/tracksale_request.rb +0 -30
- data/lib/open_api_sdk/models/operations/upsertlink_request.rb +0 -30
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 7257628ae7357107aaffaa3e4eb5a9f4d20e9ab45b9cca14026f52c01558142b
|
4
|
+
data.tar.gz: 3d16c1e0cf805b85812b78352cd0bd05d4699cb0ff1c3699c4b52cda809e35b3
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 5b9c81038ec2f855b08e6e4b5e7131ee0538d45676e0d0edf4e23ec40f860ab2922a5b54f7b66258a08156712755e7107b879a7795904eb23f6c839ea44cce62
|
7
|
+
data.tar.gz: 0d7894a153e220decfe14225eb1c3051e67624f6a7e20a8c31c97cd63363d8b93f584e12aeca4ea323e0b03cf9a33bfcd6d45a56732f71bbb88c9769d8781c9f
|
@@ -27,7 +27,7 @@ module OpenApiSDK
|
|
27
27
|
base_url = Utils.template_url(url, params)
|
28
28
|
url = "#{base_url}/analytics"
|
29
29
|
headers = {}
|
30
|
-
query_params = Utils.get_query_params(::OpenApiSDK::Operations::RetrieveAnalyticsRequest, request
|
30
|
+
query_params = Utils.get_query_params(::OpenApiSDK::Operations::RetrieveAnalyticsRequest, request)
|
31
31
|
headers['Accept'] = 'application/json'
|
32
32
|
headers['user-agent'] = @sdk_configuration.user_agent
|
33
33
|
|
data/lib/open_api_sdk/domains.rb
CHANGED
@@ -19,21 +19,19 @@ module OpenApiSDK
|
|
19
19
|
end
|
20
20
|
|
21
21
|
|
22
|
-
sig {
|
23
|
-
def list
|
22
|
+
sig { returns(::OpenApiSDK::Operations::ListDomainsResponse) }
|
23
|
+
def list
|
24
24
|
# list - Retrieve a list of domains
|
25
25
|
# Retrieve a list of domains associated with 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}/domains"
|
29
29
|
headers = {}
|
30
|
-
query_params = Utils.get_query_params(::OpenApiSDK::Operations::ListDomainsRequest, request, @sdk_configuration.globals)
|
31
30
|
headers['Accept'] = 'application/json'
|
32
31
|
headers['user-agent'] = @sdk_configuration.user_agent
|
33
32
|
|
34
33
|
r = @sdk_configuration.client.get(url) do |req|
|
35
34
|
req.headers = headers
|
36
|
-
req.params = query_params
|
37
35
|
Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
|
38
36
|
end
|
39
37
|
|
@@ -97,7 +95,7 @@ module OpenApiSDK
|
|
97
95
|
end
|
98
96
|
|
99
97
|
|
100
|
-
sig { params(request: T.nilable(::OpenApiSDK::Operations::
|
98
|
+
sig { params(request: T.nilable(::OpenApiSDK::Operations::CreateDomainRequestBody)).returns(::OpenApiSDK::Operations::CreateDomainResponse) }
|
101
99
|
def create(request)
|
102
100
|
# create - Create a domain
|
103
101
|
# Create a domain for the authenticated workspace.
|
@@ -105,15 +103,13 @@ module OpenApiSDK
|
|
105
103
|
base_url = Utils.template_url(url, params)
|
106
104
|
url = "#{base_url}/domains"
|
107
105
|
headers = {}
|
108
|
-
req_content_type, data, form = Utils.serialize_request_body(request, :
|
106
|
+
req_content_type, data, form = Utils.serialize_request_body(request, :request, :json)
|
109
107
|
headers['content-type'] = req_content_type
|
110
|
-
query_params = Utils.get_query_params(::OpenApiSDK::Operations::CreateDomainRequest, request, @sdk_configuration.globals)
|
111
108
|
headers['Accept'] = 'application/json'
|
112
109
|
headers['user-agent'] = @sdk_configuration.user_agent
|
113
110
|
|
114
111
|
r = @sdk_configuration.client.post(url) do |req|
|
115
112
|
req.headers = headers
|
116
|
-
req.params = query_params
|
117
113
|
Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
|
118
114
|
if form
|
119
115
|
req.body = Utils.encode_form(form)
|
@@ -194,17 +190,14 @@ module OpenApiSDK
|
|
194
190
|
::OpenApiSDK::Operations::DeleteDomainRequest,
|
195
191
|
base_url,
|
196
192
|
'/domains/{slug}',
|
197
|
-
request
|
198
|
-
@sdk_configuration.globals
|
193
|
+
request
|
199
194
|
)
|
200
195
|
headers = {}
|
201
|
-
query_params = Utils.get_query_params(::OpenApiSDK::Operations::DeleteDomainRequest, request, @sdk_configuration.globals)
|
202
196
|
headers['Accept'] = 'application/json'
|
203
197
|
headers['user-agent'] = @sdk_configuration.user_agent
|
204
198
|
|
205
199
|
r = @sdk_configuration.client.delete(url) do |req|
|
206
200
|
req.headers = headers
|
207
|
-
req.params = query_params
|
208
201
|
Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
|
209
202
|
end
|
210
203
|
|
@@ -278,19 +271,16 @@ module OpenApiSDK
|
|
278
271
|
::OpenApiSDK::Operations::UpdateDomainRequest,
|
279
272
|
base_url,
|
280
273
|
'/domains/{slug}',
|
281
|
-
request
|
282
|
-
@sdk_configuration.globals
|
274
|
+
request
|
283
275
|
)
|
284
276
|
headers = {}
|
285
277
|
req_content_type, data, form = Utils.serialize_request_body(request, :request_body, :json)
|
286
278
|
headers['content-type'] = req_content_type
|
287
|
-
query_params = Utils.get_query_params(::OpenApiSDK::Operations::UpdateDomainRequest, request, @sdk_configuration.globals)
|
288
279
|
headers['Accept'] = 'application/json'
|
289
280
|
headers['user-agent'] = @sdk_configuration.user_agent
|
290
281
|
|
291
282
|
r = @sdk_configuration.client.patch(url) do |req|
|
292
283
|
req.headers = headers
|
293
|
-
req.params = query_params
|
294
284
|
Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
|
295
285
|
if form
|
296
286
|
req.body = Utils.encode_form(form)
|
data/lib/open_api_sdk/dub.rb
CHANGED
@@ -18,16 +18,12 @@ module OpenApiSDK
|
|
18
18
|
sig do
|
19
19
|
params(client: Faraday::Request,
|
20
20
|
security: T.nilable(Shared::Security),
|
21
|
-
workspace_id: ::String,
|
22
|
-
project_slug: ::String,
|
23
21
|
server_idx: Integer,
|
24
22
|
server_url: String,
|
25
23
|
url_params: T::Hash[Symbol, String]).void
|
26
24
|
end
|
27
25
|
def initialize(client: nil,
|
28
26
|
security: nil,
|
29
|
-
workspace_id: nil,
|
30
|
-
project_slug: nil,
|
31
27
|
server_idx: nil,
|
32
28
|
server_url: nil,
|
33
29
|
url_params: nil)
|
@@ -35,8 +31,6 @@ module OpenApiSDK
|
|
35
31
|
## Instantiates the SDK configuring it with the provided parameters.
|
36
32
|
# @param [Faraday::Request] client The faraday HTTP client to use for all operations
|
37
33
|
# @param [Shared::Security] security The security details required for authentication
|
38
|
-
# @param [::String] workspace_id: Configures the workspace_id parameter for all supported operations
|
39
|
-
# @param [::String] project_slug: Configures the project_slug parameter for all supported operations
|
40
34
|
# @param [::Integer] server_idx The index of the server to use for all operations
|
41
35
|
# @param [::String] server_url The server URL to use for all operations
|
42
36
|
# @param [::Hash<::Symbol, ::String>] url_params Parameters to optionally template the server URL with
|
@@ -57,20 +51,7 @@ module OpenApiSDK
|
|
57
51
|
end
|
58
52
|
server_idx = 0 if server_idx.nil?
|
59
53
|
|
60
|
-
|
61
|
-
'parameters': {
|
62
|
-
'queryParam': {
|
63
|
-
'workspace_id': workspace_id,
|
64
|
-
'project_slug': project_slug,
|
65
|
-
},
|
66
|
-
'pathParam': {
|
67
|
-
},
|
68
|
-
'header': {
|
69
|
-
}
|
70
|
-
}
|
71
|
-
}
|
72
|
-
|
73
|
-
@sdk_configuration = SDKConfiguration.new(client, security, server_url, server_idx, globals)
|
54
|
+
@sdk_configuration = SDKConfiguration.new(client, security, server_url, server_idx)
|
74
55
|
init_sdks
|
75
56
|
end
|
76
57
|
|
data/lib/open_api_sdk/links.rb
CHANGED
@@ -22,12 +22,12 @@ module OpenApiSDK
|
|
22
22
|
sig { params(request: T.nilable(::OpenApiSDK::Operations::GetLinksRequest)).returns(::OpenApiSDK::Operations::GetLinksResponse) }
|
23
23
|
def list(request)
|
24
24
|
# list - Retrieve a list of links
|
25
|
-
# Retrieve a list of links for the authenticated workspace.
|
25
|
+
# Retrieve a paginated list of links 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}/links"
|
29
29
|
headers = {}
|
30
|
-
query_params = Utils.get_query_params(::OpenApiSDK::Operations::GetLinksRequest, request
|
30
|
+
query_params = Utils.get_query_params(::OpenApiSDK::Operations::GetLinksRequest, request)
|
31
31
|
headers['Accept'] = 'application/json'
|
32
32
|
headers['user-agent'] = @sdk_configuration.user_agent
|
33
33
|
|
@@ -97,7 +97,7 @@ module OpenApiSDK
|
|
97
97
|
end
|
98
98
|
|
99
99
|
|
100
|
-
sig { params(request: T.nilable(::OpenApiSDK::Operations::
|
100
|
+
sig { params(request: T.nilable(::OpenApiSDK::Operations::CreateLinkRequestBody)).returns(::OpenApiSDK::Operations::CreateLinkResponse) }
|
101
101
|
def create(request)
|
102
102
|
# create - Create a new link
|
103
103
|
# Create a new link for the authenticated workspace.
|
@@ -105,15 +105,13 @@ module OpenApiSDK
|
|
105
105
|
base_url = Utils.template_url(url, params)
|
106
106
|
url = "#{base_url}/links"
|
107
107
|
headers = {}
|
108
|
-
req_content_type, data, form = Utils.serialize_request_body(request, :
|
108
|
+
req_content_type, data, form = Utils.serialize_request_body(request, :request, :json)
|
109
109
|
headers['content-type'] = req_content_type
|
110
|
-
query_params = Utils.get_query_params(::OpenApiSDK::Operations::CreateLinkRequest, request, @sdk_configuration.globals)
|
111
110
|
headers['Accept'] = 'application/json'
|
112
111
|
headers['user-agent'] = @sdk_configuration.user_agent
|
113
112
|
|
114
113
|
r = @sdk_configuration.client.post(url) do |req|
|
115
114
|
req.headers = headers
|
116
|
-
req.params = query_params
|
117
115
|
Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
|
118
116
|
if form
|
119
117
|
req.body = Utils.encode_form(form)
|
@@ -186,13 +184,13 @@ module OpenApiSDK
|
|
186
184
|
|
187
185
|
sig { params(request: T.nilable(::OpenApiSDK::Operations::GetLinksCountRequest)).returns(::OpenApiSDK::Operations::GetLinksCountResponse) }
|
188
186
|
def count(request)
|
189
|
-
# count - Retrieve
|
190
|
-
# Retrieve the number of links for the authenticated workspace.
|
187
|
+
# count - Retrieve links count
|
188
|
+
# Retrieve the number of links for the authenticated workspace.
|
191
189
|
url, params = @sdk_configuration.get_server_details
|
192
190
|
base_url = Utils.template_url(url, params)
|
193
191
|
url = "#{base_url}/links/count"
|
194
192
|
headers = {}
|
195
|
-
query_params = Utils.get_query_params(::OpenApiSDK::Operations::GetLinksCountRequest, request
|
193
|
+
query_params = Utils.get_query_params(::OpenApiSDK::Operations::GetLinksCountRequest, request)
|
196
194
|
headers['Accept'] = 'application/json'
|
197
195
|
headers['user-agent'] = @sdk_configuration.user_agent
|
198
196
|
|
@@ -270,7 +268,7 @@ module OpenApiSDK
|
|
270
268
|
base_url = Utils.template_url(url, params)
|
271
269
|
url = "#{base_url}/links/info"
|
272
270
|
headers = {}
|
273
|
-
query_params = Utils.get_query_params(::OpenApiSDK::Operations::GetLinkInfoRequest, request
|
271
|
+
query_params = Utils.get_query_params(::OpenApiSDK::Operations::GetLinkInfoRequest, request)
|
274
272
|
headers['Accept'] = 'application/json'
|
275
273
|
headers['user-agent'] = @sdk_configuration.user_agent
|
276
274
|
|
@@ -350,17 +348,14 @@ module OpenApiSDK
|
|
350
348
|
::OpenApiSDK::Operations::DeleteLinkRequest,
|
351
349
|
base_url,
|
352
350
|
'/links/{linkId}',
|
353
|
-
request
|
354
|
-
@sdk_configuration.globals
|
351
|
+
request
|
355
352
|
)
|
356
353
|
headers = {}
|
357
|
-
query_params = Utils.get_query_params(::OpenApiSDK::Operations::DeleteLinkRequest, request, @sdk_configuration.globals)
|
358
354
|
headers['Accept'] = 'application/json'
|
359
355
|
headers['user-agent'] = @sdk_configuration.user_agent
|
360
356
|
|
361
357
|
r = @sdk_configuration.client.delete(url) do |req|
|
362
358
|
req.headers = headers
|
363
|
-
req.params = query_params
|
364
359
|
Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
|
365
360
|
end
|
366
361
|
|
@@ -434,19 +429,16 @@ module OpenApiSDK
|
|
434
429
|
::OpenApiSDK::Operations::UpdateLinkRequest,
|
435
430
|
base_url,
|
436
431
|
'/links/{linkId}',
|
437
|
-
request
|
438
|
-
@sdk_configuration.globals
|
432
|
+
request
|
439
433
|
)
|
440
434
|
headers = {}
|
441
435
|
req_content_type, data, form = Utils.serialize_request_body(request, :request_body, :json)
|
442
436
|
headers['content-type'] = req_content_type
|
443
|
-
query_params = Utils.get_query_params(::OpenApiSDK::Operations::UpdateLinkRequest, request, @sdk_configuration.globals)
|
444
437
|
headers['Accept'] = 'application/json'
|
445
438
|
headers['user-agent'] = @sdk_configuration.user_agent
|
446
439
|
|
447
440
|
r = @sdk_configuration.client.patch(url) do |req|
|
448
441
|
req.headers = headers
|
449
|
-
req.params = query_params
|
450
442
|
Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
|
451
443
|
if form
|
452
444
|
req.body = Utils.encode_form(form)
|
@@ -517,7 +509,7 @@ module OpenApiSDK
|
|
517
509
|
end
|
518
510
|
|
519
511
|
|
520
|
-
sig { params(request: T.nilable(::OpenApiSDK::Operations::
|
512
|
+
sig { params(request: T.nilable(T::Array[::OpenApiSDK::Operations::RequestBody])).returns(::OpenApiSDK::Operations::BulkCreateLinksResponse) }
|
521
513
|
def create_many(request)
|
522
514
|
# create_many - Bulk create links
|
523
515
|
# Bulk create up to 100 links for the authenticated workspace.
|
@@ -525,15 +517,13 @@ module OpenApiSDK
|
|
525
517
|
base_url = Utils.template_url(url, params)
|
526
518
|
url = "#{base_url}/links/bulk"
|
527
519
|
headers = {}
|
528
|
-
req_content_type, data, form = Utils.serialize_request_body(request, :
|
520
|
+
req_content_type, data, form = Utils.serialize_request_body(request, :request, :json)
|
529
521
|
headers['content-type'] = req_content_type
|
530
|
-
query_params = Utils.get_query_params(::OpenApiSDK::Operations::BulkCreateLinksRequest, request, @sdk_configuration.globals)
|
531
522
|
headers['Accept'] = 'application/json'
|
532
523
|
headers['user-agent'] = @sdk_configuration.user_agent
|
533
524
|
|
534
525
|
r = @sdk_configuration.client.post(url) do |req|
|
535
526
|
req.headers = headers
|
536
|
-
req.params = query_params
|
537
527
|
Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
|
538
528
|
if form
|
539
529
|
req.body = Utils.encode_form(form)
|
@@ -689,7 +679,7 @@ module OpenApiSDK
|
|
689
679
|
end
|
690
680
|
|
691
681
|
|
692
|
-
sig { params(request: T.nilable(::OpenApiSDK::Operations::
|
682
|
+
sig { params(request: T.nilable(::OpenApiSDK::Operations::UpsertLinkRequestBody)).returns(::OpenApiSDK::Operations::UpsertLinkResponse) }
|
693
683
|
def upsert(request)
|
694
684
|
# upsert - Upsert a link
|
695
685
|
# Upsert a link for the authenticated workspace by its URL. If a link with the same URL already exists, return it (or update it if there are any changes). Otherwise, a new link will be created.
|
@@ -697,15 +687,13 @@ module OpenApiSDK
|
|
697
687
|
base_url = Utils.template_url(url, params)
|
698
688
|
url = "#{base_url}/links/upsert"
|
699
689
|
headers = {}
|
700
|
-
req_content_type, data, form = Utils.serialize_request_body(request, :
|
690
|
+
req_content_type, data, form = Utils.serialize_request_body(request, :request, :json)
|
701
691
|
headers['content-type'] = req_content_type
|
702
|
-
query_params = Utils.get_query_params(::OpenApiSDK::Operations::UpsertLinkRequest, request, @sdk_configuration.globals)
|
703
692
|
headers['Accept'] = 'application/json'
|
704
693
|
headers['user-agent'] = @sdk_configuration.user_agent
|
705
694
|
|
706
695
|
r = @sdk_configuration.client.put(url) do |req|
|
707
696
|
req.headers = headers
|
708
|
-
req.params = query_params
|
709
697
|
Utils.configure_request_security(req, @sdk_configuration.security) if !@sdk_configuration.nil? && !@sdk_configuration.security.nil?
|
710
698
|
if form
|
711
699
|
req.body = Utils.encode_form(form)
|
@@ -27,7 +27,7 @@ module OpenApiSDK
|
|
27
27
|
base_url = Utils.template_url(url, params)
|
28
28
|
url = "#{base_url}/metatags"
|
29
29
|
headers = {}
|
30
|
-
query_params = Utils.get_query_params(::OpenApiSDK::Operations::GetMetatagsRequest, request
|
30
|
+
query_params = Utils.get_query_params(::OpenApiSDK::Operations::GetMetatagsRequest, request)
|
31
31
|
headers['Accept'] = 'application/json'
|
32
32
|
headers['user-agent'] = @sdk_configuration.user_agent
|
33
33
|
|
@@ -13,17 +13,11 @@ module OpenApiSDK
|
|
13
13
|
|
14
14
|
# The domain name.
|
15
15
|
field :slug, ::String, { 'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': false } }
|
16
|
-
# The slug of the project. This field is deprecated – use `workspaceId` instead.
|
17
|
-
field :project_slug, T.nilable(::String), { 'query_param': { 'field_name': 'projectSlug', 'style': 'form', 'explode': true } }
|
18
|
-
# The ID of the workspace.
|
19
|
-
field :workspace_id, T.nilable(::String), { 'query_param': { 'field_name': 'workspaceId', 'style': 'form', 'explode': true } }
|
20
16
|
|
21
17
|
|
22
|
-
sig { params(slug: ::String
|
23
|
-
def initialize(slug: nil
|
18
|
+
sig { params(slug: ::String).void }
|
19
|
+
def initialize(slug: nil)
|
24
20
|
@slug = slug
|
25
|
-
@project_slug = project_slug
|
26
|
-
@workspace_id = workspace_id
|
27
21
|
end
|
28
22
|
end
|
29
23
|
end
|
@@ -13,17 +13,11 @@ module OpenApiSDK
|
|
13
13
|
|
14
14
|
# The id of the link to delete. You may use either `linkId` (obtained via `/links/info` endpoint) or `externalId` prefixed with `ext_`.
|
15
15
|
field :link_id, ::String, { 'path_param': { 'field_name': 'linkId', 'style': 'simple', 'explode': false } }
|
16
|
-
# The slug of the project. This field is deprecated – use `workspaceId` instead.
|
17
|
-
field :project_slug, T.nilable(::String), { 'query_param': { 'field_name': 'projectSlug', 'style': 'form', 'explode': true } }
|
18
|
-
# The ID of the workspace.
|
19
|
-
field :workspace_id, T.nilable(::String), { 'query_param': { 'field_name': 'workspaceId', 'style': 'form', 'explode': true } }
|
20
16
|
|
21
17
|
|
22
|
-
sig { params(link_id: ::String
|
23
|
-
def initialize(link_id: nil
|
18
|
+
sig { params(link_id: ::String).void }
|
19
|
+
def initialize(link_id: nil)
|
24
20
|
@link_id = link_id
|
25
|
-
@project_slug = project_slug
|
26
|
-
@workspace_id = workspace_id
|
27
21
|
end
|
28
22
|
end
|
29
23
|
end
|
@@ -19,20 +19,14 @@ module OpenApiSDK
|
|
19
19
|
field :key, T.nilable(::String), { 'query_param': { 'field_name': 'key', 'style': 'form', 'explode': true } }
|
20
20
|
# The unique ID of the short link.
|
21
21
|
field :link_id, T.nilable(::String), { 'query_param': { 'field_name': 'linkId', 'style': 'form', 'explode': true } }
|
22
|
-
# The slug of the project. This field is deprecated – use `workspaceId` instead.
|
23
|
-
field :project_slug, T.nilable(::String), { 'query_param': { 'field_name': 'projectSlug', 'style': 'form', 'explode': true } }
|
24
|
-
# The ID of the workspace.
|
25
|
-
field :workspace_id, T.nilable(::String), { 'query_param': { 'field_name': 'workspaceId', 'style': 'form', 'explode': true } }
|
26
22
|
|
27
23
|
|
28
|
-
sig { params(domain: T.nilable(::String), external_id: T.nilable(::String), key: T.nilable(::String), link_id: T.nilable(::String)
|
29
|
-
def initialize(domain: nil, external_id: nil, key: nil, link_id: nil
|
24
|
+
sig { params(domain: T.nilable(::String), external_id: T.nilable(::String), key: T.nilable(::String), link_id: T.nilable(::String)).void }
|
25
|
+
def initialize(domain: nil, external_id: nil, key: nil, link_id: nil)
|
30
26
|
@domain = domain
|
31
27
|
@external_id = external_id
|
32
28
|
@key = key
|
33
29
|
@link_id = link_id
|
34
|
-
@project_slug = project_slug
|
35
|
-
@workspace_id = workspace_id
|
36
30
|
end
|
37
31
|
end
|
38
32
|
end
|
@@ -15,8 +15,6 @@ module OpenApiSDK
|
|
15
15
|
field :domain, T.nilable(::String), { 'query_param': { 'field_name': 'domain', 'style': 'form', 'explode': true } }
|
16
16
|
# The page number for pagination (each page contains 100 links).
|
17
17
|
field :page, T.nilable(::Integer), { 'query_param': { 'field_name': 'page', 'style': 'form', 'explode': true } }
|
18
|
-
# The slug of the project. This field is deprecated – use `workspaceId` instead.
|
19
|
-
field :project_slug, T.nilable(::String), { 'query_param': { 'field_name': 'projectSlug', 'style': 'form', 'explode': true } }
|
20
18
|
# The search term to filter the links by. The search term will be matched against the short link slug and the destination url.
|
21
19
|
field :search, T.nilable(::String), { 'query_param': { 'field_name': 'search', 'style': 'form', 'explode': true } }
|
22
20
|
# Whether to include archived links in the response. Defaults to `false` if not provided.
|
@@ -33,15 +31,12 @@ module OpenApiSDK
|
|
33
31
|
field :user_id, T.nilable(::String), { 'query_param': { 'field_name': 'userId', 'style': 'form', 'explode': true } }
|
34
32
|
# Whether to include tags in the response. Defaults to `false` if not provided.
|
35
33
|
field :with_tags, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'withTags', 'style': 'form', 'explode': true } }
|
36
|
-
# The ID of the workspace.
|
37
|
-
field :workspace_id, T.nilable(::String), { 'query_param': { 'field_name': 'workspaceId', 'style': 'form', 'explode': true } }
|
38
34
|
|
39
35
|
|
40
|
-
sig { params(domain: T.nilable(::String), page: T.nilable(::Integer),
|
41
|
-
def initialize(domain: nil, page: nil,
|
36
|
+
sig { params(domain: T.nilable(::String), page: T.nilable(::Integer), 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 }
|
37
|
+
def initialize(domain: nil, page: nil, search: nil, show_archived: nil, sort: nil, tag_id: nil, tag_ids: nil, tag_names: nil, user_id: nil, with_tags: nil)
|
42
38
|
@domain = domain
|
43
39
|
@page = page
|
44
|
-
@project_slug = project_slug
|
45
40
|
@search = search
|
46
41
|
@show_archived = show_archived
|
47
42
|
@sort = sort
|
@@ -50,7 +45,6 @@ module OpenApiSDK
|
|
50
45
|
@tag_names = tag_names
|
51
46
|
@user_id = user_id
|
52
47
|
@with_tags = with_tags
|
53
|
-
@workspace_id = workspace_id
|
54
48
|
end
|
55
49
|
end
|
56
50
|
end
|
@@ -15,8 +15,6 @@ module OpenApiSDK
|
|
15
15
|
field :domain, T.nilable(::String), { 'query_param': { 'field_name': 'domain', 'style': 'form', 'explode': true } }
|
16
16
|
# The field to group the links by.
|
17
17
|
field :group_by, T.nilable(::Object), { 'query_param': { 'field_name': 'groupBy', 'style': 'form', 'explode': true } }
|
18
|
-
# The slug of the project. This field is deprecated – use `workspaceId` instead.
|
19
|
-
field :project_slug, T.nilable(::String), { 'query_param': { 'field_name': 'projectSlug', 'style': 'form', 'explode': true } }
|
20
18
|
# The search term to filter the links by. The search term will be matched against the short link slug and the destination url.
|
21
19
|
field :search, T.nilable(::String), { 'query_param': { 'field_name': 'search', 'style': 'form', 'explode': true } }
|
22
20
|
# Whether to include archived links in the response. Defaults to `false` if not provided.
|
@@ -31,15 +29,12 @@ module OpenApiSDK
|
|
31
29
|
field :user_id, T.nilable(::String), { 'query_param': { 'field_name': 'userId', 'style': 'form', 'explode': true } }
|
32
30
|
# Whether to include tags in the response. Defaults to `false` if not provided.
|
33
31
|
field :with_tags, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'withTags', 'style': 'form', 'explode': true } }
|
34
|
-
# The ID of the workspace.
|
35
|
-
field :workspace_id, T.nilable(::String), { 'query_param': { 'field_name': 'workspaceId', 'style': 'form', 'explode': true } }
|
36
32
|
|
37
33
|
|
38
|
-
sig { params(domain: T.nilable(::String), group_by: T.nilable(::Object),
|
39
|
-
def initialize(domain: nil, group_by: nil,
|
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)
|
40
36
|
@domain = domain
|
41
37
|
@group_by = group_by
|
42
|
-
@project_slug = project_slug
|
43
38
|
@search = search
|
44
39
|
@show_archived = show_archived
|
45
40
|
@tag_id = tag_id
|
@@ -47,7 +42,6 @@ module OpenApiSDK
|
|
47
42
|
@tag_names = tag_names
|
48
43
|
@user_id = user_id
|
49
44
|
@with_tags = with_tags
|
50
|
-
@workspace_id = workspace_id
|
51
45
|
end
|
52
46
|
end
|
53
47
|
end
|
@@ -37,8 +37,6 @@ module OpenApiSDK
|
|
37
37
|
field :link_id, T.nilable(::String), { 'query_param': { 'field_name': 'linkId', 'style': 'form', 'explode': true } }
|
38
38
|
# The OS to retrieve analytics for.
|
39
39
|
field :os, T.nilable(::String), { 'query_param': { 'field_name': 'os', 'style': 'form', 'explode': true } }
|
40
|
-
# The slug of the project. This field is deprecated – use `workspaceId` instead.
|
41
|
-
field :project_slug, T.nilable(::String), { 'query_param': { 'field_name': 'projectSlug', 'style': 'form', 'explode': true } }
|
42
40
|
# Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.
|
43
41
|
field :qr, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'qr', 'style': 'form', 'explode': true } }
|
44
42
|
# The referer to retrieve analytics for.
|
@@ -53,12 +51,10 @@ module OpenApiSDK
|
|
53
51
|
field :timezone, T.nilable(::String), { 'query_param': { 'field_name': 'timezone', 'style': 'form', 'explode': true } }
|
54
52
|
# The URL to retrieve analytics for.
|
55
53
|
field :url, T.nilable(::String), { 'query_param': { 'field_name': 'url', 'style': 'form', 'explode': true } }
|
56
|
-
# The ID of the workspace.
|
57
|
-
field :workspace_id, T.nilable(::String), { 'query_param': { 'field_name': 'workspaceId', 'style': 'form', 'explode': true } }
|
58
54
|
|
59
55
|
|
60
|
-
sig { params(browser: T.nilable(::String), city: T.nilable(::String), country: T.nilable(::OpenApiSDK::Shared::CountryCode), device: T.nilable(::String), domain: T.nilable(::String), end_: T.nilable(::String), event: T.nilable(::OpenApiSDK::Operations::Event), external_id: T.nilable(::String), group_by: T.nilable(::OpenApiSDK::Operations::GroupBy), interval: T.nilable(::OpenApiSDK::Operations::Interval), key: T.nilable(::String), link_id: T.nilable(::String), os: T.nilable(::String),
|
61
|
-
def initialize(browser: nil, city: nil, country: nil, device: nil, domain: nil, end_: nil, event: nil, external_id: nil, group_by: nil, interval: nil, key: nil, link_id: nil, os: nil,
|
56
|
+
sig { params(browser: T.nilable(::String), city: T.nilable(::String), country: T.nilable(::OpenApiSDK::Shared::CountryCode), device: T.nilable(::String), domain: T.nilable(::String), end_: T.nilable(::String), event: T.nilable(::OpenApiSDK::Operations::Event), external_id: T.nilable(::String), group_by: T.nilable(::OpenApiSDK::Operations::GroupBy), interval: T.nilable(::OpenApiSDK::Operations::Interval), key: T.nilable(::String), link_id: T.nilable(::String), os: T.nilable(::String), qr: T.nilable(T::Boolean), referer: T.nilable(::String), root: T.nilable(T::Boolean), start: T.nilable(::String), tag_id: T.nilable(::String), timezone: T.nilable(::String), url: T.nilable(::String)).void }
|
57
|
+
def initialize(browser: nil, city: nil, country: nil, device: nil, domain: nil, end_: nil, event: nil, external_id: nil, group_by: nil, interval: nil, key: nil, link_id: nil, os: nil, qr: nil, referer: nil, root: nil, start: nil, tag_id: nil, timezone: nil, url: nil)
|
62
58
|
@browser = browser
|
63
59
|
@city = city
|
64
60
|
@country = country
|
@@ -72,7 +68,6 @@ module OpenApiSDK
|
|
72
68
|
@key = key
|
73
69
|
@link_id = link_id
|
74
70
|
@os = os
|
75
|
-
@project_slug = project_slug
|
76
71
|
@qr = qr
|
77
72
|
@referer = referer
|
78
73
|
@root = root
|
@@ -80,7 +75,6 @@ module OpenApiSDK
|
|
80
75
|
@tag_id = tag_id
|
81
76
|
@timezone = timezone
|
82
77
|
@url = url
|
83
|
-
@workspace_id = workspace_id
|
84
78
|
end
|
85
79
|
end
|
86
80
|
end
|
@@ -13,20 +13,14 @@ module OpenApiSDK
|
|
13
13
|
|
14
14
|
# The domain name.
|
15
15
|
field :slug, ::String, { 'path_param': { 'field_name': 'slug', 'style': 'simple', 'explode': false } }
|
16
|
-
# The slug of the project. This field is deprecated – use `workspaceId` instead.
|
17
|
-
field :project_slug, T.nilable(::String), { 'query_param': { 'field_name': 'projectSlug', 'style': 'form', 'explode': true } }
|
18
16
|
|
19
17
|
field :request_body, T.nilable(::OpenApiSDK::Operations::UpdateDomainRequestBody), { 'request': { 'media_type': 'application/json' } }
|
20
|
-
# The ID of the workspace.
|
21
|
-
field :workspace_id, T.nilable(::String), { 'query_param': { 'field_name': 'workspaceId', 'style': 'form', 'explode': true } }
|
22
18
|
|
23
19
|
|
24
|
-
sig { params(slug: ::String,
|
25
|
-
def initialize(slug: nil,
|
20
|
+
sig { params(slug: ::String, request_body: T.nilable(::OpenApiSDK::Operations::UpdateDomainRequestBody)).void }
|
21
|
+
def initialize(slug: nil, request_body: nil)
|
26
22
|
@slug = slug
|
27
|
-
@project_slug = project_slug
|
28
23
|
@request_body = request_body
|
29
|
-
@workspace_id = workspace_id
|
30
24
|
end
|
31
25
|
end
|
32
26
|
end
|
@@ -13,20 +13,14 @@ module OpenApiSDK
|
|
13
13
|
|
14
14
|
# The id of the link to update. You may use either `linkId` (obtained via `/links/info` endpoint) or `externalId` prefixed with `ext_`.
|
15
15
|
field :link_id, ::String, { 'path_param': { 'field_name': 'linkId', 'style': 'simple', 'explode': false } }
|
16
|
-
# The slug of the project. This field is deprecated – use `workspaceId` instead.
|
17
|
-
field :project_slug, T.nilable(::String), { 'query_param': { 'field_name': 'projectSlug', 'style': 'form', 'explode': true } }
|
18
16
|
|
19
17
|
field :request_body, T.nilable(::OpenApiSDK::Operations::UpdateLinkRequestBody), { 'request': { 'media_type': 'application/json' } }
|
20
|
-
# The ID of the workspace.
|
21
|
-
field :workspace_id, T.nilable(::String), { 'query_param': { 'field_name': 'workspaceId', 'style': 'form', 'explode': true } }
|
22
18
|
|
23
19
|
|
24
|
-
sig { params(link_id: ::String,
|
25
|
-
def initialize(link_id: nil,
|
20
|
+
sig { params(link_id: ::String, request_body: T.nilable(::OpenApiSDK::Operations::UpdateLinkRequestBody)).void }
|
21
|
+
def initialize(link_id: nil, request_body: nil)
|
26
22
|
@link_id = link_id
|
27
|
-
@project_slug = project_slug
|
28
23
|
@request_body = request_body
|
29
|
-
@workspace_id = workspace_id
|
30
24
|
end
|
31
25
|
end
|
32
26
|
end
|
@@ -11,8 +11,6 @@ module OpenApiSDK
|
|
11
11
|
class UpdateLinkRequestBody < ::OpenApiSDK::Utils::FieldAugmented
|
12
12
|
extend T::Sig
|
13
13
|
|
14
|
-
# The destination URL of the short link.
|
15
|
-
field :url, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('url') } }
|
16
14
|
# The Android destination URL for the short link for Android device targeting.
|
17
15
|
field :android, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('android') } }
|
18
16
|
# Whether the short link is archived.
|
@@ -31,7 +29,7 @@ module OpenApiSDK
|
|
31
29
|
field :expires_at, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiresAt') } }
|
32
30
|
# This is the ID of the link in your database. If set, it can be used to identify the link in the future. Must be prefixed with `ext_` when passed as a query parameter.
|
33
31
|
field :external_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
|
34
|
-
|
32
|
+
|
35
33
|
field :geo, T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('geo') } }
|
36
34
|
# The image of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
|
37
35
|
field :image, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
|
@@ -61,11 +59,12 @@ module OpenApiSDK
|
|
61
59
|
field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
|
62
60
|
# Whether to track conversions for the short link.
|
63
61
|
field :track_conversion, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trackConversion') } }
|
62
|
+
# The destination URL of the short link.
|
63
|
+
field :url, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('url') } }
|
64
64
|
|
65
65
|
|
66
|
-
sig { params(
|
67
|
-
def initialize(
|
68
|
-
@url = url
|
66
|
+
sig { params(android: T.nilable(::String), archived: T.nilable(T::Boolean), comments: T.nilable(::String), description: T.nilable(::String), do_index: T.nilable(T::Boolean), domain: T.nilable(::String), expired_url: T.nilable(::String), expires_at: T.nilable(::String), external_id: T.nilable(::String), geo: T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), image: T.nilable(::String), ios: T.nilable(::String), key: T.nilable(::String), password: T.nilable(::String), prefix: T.nilable(::String), proxy: T.nilable(T::Boolean), public_stats: T.nilable(T::Boolean), 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)).void }
|
67
|
+
def initialize(android: nil, archived: nil, comments: nil, description: nil, do_index: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, image: nil, ios: nil, key: nil, password: nil, prefix: nil, proxy: nil, public_stats: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, title: nil, track_conversion: nil, url: nil)
|
69
68
|
@android = android
|
70
69
|
@archived = archived
|
71
70
|
@comments = comments
|
@@ -89,6 +88,7 @@ module OpenApiSDK
|
|
89
88
|
@tag_names = tag_names
|
90
89
|
@title = title
|
91
90
|
@track_conversion = track_conversion
|
91
|
+
@url = url
|
92
92
|
end
|
93
93
|
end
|
94
94
|
end
|
@@ -11,22 +11,16 @@ module OpenApiSDK
|
|
11
11
|
class UpdateTagRequest < ::OpenApiSDK::Utils::FieldAugmented
|
12
12
|
extend T::Sig
|
13
13
|
|
14
|
-
# The ID of the tag
|
14
|
+
# The ID of the tag to update.
|
15
15
|
field :id, ::String, { 'path_param': { 'field_name': 'id', 'style': 'simple', 'explode': false } }
|
16
|
-
# The slug of the project. This field is deprecated – use `workspaceId` instead.
|
17
|
-
field :project_slug, T.nilable(::String), { 'query_param': { 'field_name': 'projectSlug', 'style': 'form', 'explode': true } }
|
18
16
|
|
19
17
|
field :request_body, T.nilable(::OpenApiSDK::Operations::UpdateTagRequestBody), { 'request': { 'media_type': 'application/json' } }
|
20
|
-
# The ID of the workspace.
|
21
|
-
field :workspace_id, T.nilable(::String), { 'query_param': { 'field_name': 'workspaceId', 'style': 'form', 'explode': true } }
|
22
18
|
|
23
19
|
|
24
|
-
sig { params(id: ::String,
|
25
|
-
def initialize(id: nil,
|
20
|
+
sig { params(id: ::String, request_body: T.nilable(::OpenApiSDK::Operations::UpdateTagRequestBody)).void }
|
21
|
+
def initialize(id: nil, request_body: nil)
|
26
22
|
@id = id
|
27
|
-
@project_slug = project_slug
|
28
23
|
@request_body = request_body
|
29
|
-
@workspace_id = workspace_id
|
30
24
|
end
|
31
25
|
end
|
32
26
|
end
|