dub 0.2.2.pre.alpha.69 → 0.2.2
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/dub.rb +3 -8
- data/lib/open_api_sdk/analytics.rb +1 -2
- data/lib/open_api_sdk/domains.rb +55 -61
- data/lib/open_api_sdk/dub.rb +4 -9
- data/lib/open_api_sdk/links.rb +57 -145
- data/lib/open_api_sdk/metatags.rb +1 -2
- data/lib/open_api_sdk/models/operations/bulkcreatelinks_response.rb +6 -6
- data/lib/open_api_sdk/models/operations/bulkupdatelinks_requestbody.rb +5 -8
- data/lib/open_api_sdk/models/operations/bulkupdatelinks_response.rb +1 -1
- data/lib/open_api_sdk/models/operations/color.rb +2 -1
- data/lib/open_api_sdk/models/operations/createdomain_requestbody.rb +3 -15
- data/lib/open_api_sdk/models/operations/createdomain_response.rb +1 -1
- data/lib/open_api_sdk/models/operations/createlink_requestbody.rb +12 -50
- data/lib/open_api_sdk/models/operations/createlink_response.rb +1 -1
- data/lib/open_api_sdk/models/operations/createtag_requestbody.rb +1 -1
- data/lib/open_api_sdk/models/operations/createtag_response.rb +1 -1
- data/lib/open_api_sdk/models/operations/data.rb +11 -49
- data/lib/open_api_sdk/models/operations/deletedomain_request.rb +1 -1
- data/lib/open_api_sdk/models/operations/deletedomain_response.rb +1 -1
- data/lib/open_api_sdk/models/operations/deletedomain_responsebody.rb +1 -1
- data/lib/open_api_sdk/models/operations/deletelink_request.rb +1 -1
- data/lib/open_api_sdk/models/operations/deletelink_response.rb +2 -2
- data/lib/open_api_sdk/models/operations/deletelink_responsebody.rb +2 -2
- data/lib/open_api_sdk/models/operations/event.rb +3 -2
- data/lib/open_api_sdk/models/operations/getlinkinfo_request.rb +2 -2
- data/lib/open_api_sdk/models/operations/getlinkinfo_response.rb +1 -1
- data/lib/open_api_sdk/models/operations/getlinks_request.rb +8 -23
- data/lib/open_api_sdk/models/operations/getlinks_response.rb +1 -1
- data/lib/open_api_sdk/models/operations/getlinkscount_request.rb +5 -11
- data/lib/open_api_sdk/models/operations/getlinkscount_response.rb +1 -1
- data/lib/open_api_sdk/models/operations/getmetatags_request.rb +1 -1
- data/lib/open_api_sdk/models/operations/getmetatags_response.rb +1 -1
- data/lib/open_api_sdk/models/operations/getmetatags_responsebody.rb +1 -1
- data/lib/open_api_sdk/models/operations/getqrcode_request.rb +4 -13
- data/lib/open_api_sdk/models/operations/getqrcode_response.rb +1 -1
- data/lib/open_api_sdk/models/operations/gettags_response.rb +1 -1
- data/lib/open_api_sdk/models/operations/getworkspace_request.rb +1 -1
- data/lib/open_api_sdk/models/operations/getworkspace_response.rb +1 -1
- data/lib/open_api_sdk/models/operations/groupby.rb +4 -12
- data/lib/open_api_sdk/models/operations/interval.rb +4 -5
- data/lib/open_api_sdk/models/operations/level.rb +2 -1
- data/lib/open_api_sdk/models/operations/listdomains_response.rb +1 -1
- data/lib/open_api_sdk/models/operations/paymentprocessor.rb +2 -1
- data/lib/open_api_sdk/models/operations/requestbody.rb +12 -50
- data/lib/open_api_sdk/models/operations/retrieveanalytics_request.rb +10 -52
- data/lib/open_api_sdk/models/operations/retrieveanalytics_response.rb +1 -1
- data/lib/open_api_sdk/models/operations/sort.rb +3 -5
- data/lib/open_api_sdk/models/operations/trackcustomer_requestbody.rb +33 -0
- data/lib/open_api_sdk/models/operations/{createpartner_response.rb → trackcustomer_response.rb} +5 -5
- data/lib/open_api_sdk/models/operations/trackcustomer_responsebody.rb +33 -0
- data/lib/open_api_sdk/models/operations/tracklead_requestbody.rb +8 -16
- data/lib/open_api_sdk/models/operations/tracklead_response.rb +1 -1
- data/lib/open_api_sdk/models/operations/tracklead_responsebody.rb +22 -7
- data/lib/open_api_sdk/models/operations/tracksale_requestbody.rb +6 -14
- data/lib/open_api_sdk/models/operations/tracksale_response.rb +1 -1
- data/lib/open_api_sdk/models/operations/tracksale_responsebody.rb +19 -7
- data/lib/open_api_sdk/models/operations/updatedomain_request.rb +1 -1
- data/lib/open_api_sdk/models/operations/updatedomain_requestbody.rb +3 -15
- data/lib/open_api_sdk/models/operations/updatedomain_response.rb +1 -1
- data/lib/open_api_sdk/models/operations/updatelink_request.rb +1 -1
- data/lib/open_api_sdk/models/operations/updatelink_requestbody.rb +13 -51
- data/lib/open_api_sdk/models/operations/updatelink_response.rb +1 -1
- data/lib/open_api_sdk/models/operations/updatetag_color.rb +2 -1
- data/lib/open_api_sdk/models/operations/updatetag_request.rb +1 -1
- data/lib/open_api_sdk/models/operations/updatetag_requestbody.rb +1 -1
- data/lib/open_api_sdk/models/operations/updatetag_response.rb +1 -1
- data/lib/open_api_sdk/models/operations/updateworkspace_request.rb +1 -1
- data/lib/open_api_sdk/models/operations/updateworkspace_requestbody.rb +3 -12
- data/lib/open_api_sdk/models/operations/updateworkspace_response.rb +1 -1
- data/lib/open_api_sdk/models/operations/upsertlink_requestbody.rb +12 -50
- data/lib/open_api_sdk/models/operations/upsertlink_response.rb +1 -1
- data/lib/open_api_sdk/models/operations.rb +22 -112
- data/lib/open_api_sdk/models/shared/badrequest.rb +2 -2
- data/lib/open_api_sdk/models/shared/code.rb +2 -1
- data/lib/open_api_sdk/models/shared/color.rb +2 -1
- data/lib/open_api_sdk/models/shared/conflict.rb +2 -2
- data/lib/open_api_sdk/models/shared/conflict_code.rb +2 -1
- data/lib/open_api_sdk/models/shared/conflict_error.rb +1 -1
- data/lib/open_api_sdk/models/shared/countrycode.rb +2 -1
- data/lib/open_api_sdk/models/shared/domains.rb +3 -6
- data/lib/open_api_sdk/models/shared/domainschema.rb +3 -12
- data/lib/open_api_sdk/models/shared/error.rb +1 -1
- data/lib/open_api_sdk/models/shared/forbidden.rb +2 -2
- data/lib/open_api_sdk/models/shared/forbidden_code.rb +2 -1
- data/lib/open_api_sdk/models/shared/forbidden_error.rb +1 -1
- data/lib/open_api_sdk/models/shared/geo.rb +1 -1
- data/lib/open_api_sdk/models/shared/internalservererror.rb +2 -2
- data/lib/open_api_sdk/models/shared/internalservererror_code.rb +2 -1
- data/lib/open_api_sdk/models/shared/internalservererror_error.rb +1 -1
- data/lib/open_api_sdk/models/shared/inviteexpired.rb +2 -2
- data/lib/open_api_sdk/models/shared/inviteexpired_code.rb +2 -1
- data/lib/open_api_sdk/models/shared/inviteexpired_error.rb +1 -1
- data/lib/open_api_sdk/models/shared/linkgeotargeting.rb +1 -1
- data/lib/open_api_sdk/models/shared/linkschema.rb +7 -28
- data/lib/open_api_sdk/models/shared/notfound.rb +2 -2
- data/lib/open_api_sdk/models/shared/notfound_code.rb +2 -1
- data/lib/open_api_sdk/models/shared/notfound_error.rb +1 -1
- data/lib/open_api_sdk/models/shared/plan.rb +2 -1
- data/lib/open_api_sdk/models/shared/ratelimitexceeded.rb +2 -2
- data/lib/open_api_sdk/models/shared/ratelimitexceeded_code.rb +2 -1
- data/lib/open_api_sdk/models/shared/ratelimitexceeded_error.rb +1 -1
- data/lib/open_api_sdk/models/shared/role.rb +2 -1
- data/lib/open_api_sdk/models/shared/security.rb +3 -3
- data/lib/open_api_sdk/models/shared/tagschema.rb +1 -1
- data/lib/open_api_sdk/models/shared/unauthorized.rb +2 -2
- data/lib/open_api_sdk/models/shared/unauthorized_code.rb +2 -1
- data/lib/open_api_sdk/models/shared/unauthorized_error.rb +1 -1
- data/lib/open_api_sdk/models/shared/unprocessableentity.rb +2 -2
- data/lib/open_api_sdk/models/shared/unprocessableentity_code.rb +2 -1
- data/lib/open_api_sdk/models/shared/unprocessableentity_error.rb +1 -1
- data/lib/open_api_sdk/models/shared/users.rb +1 -1
- data/lib/open_api_sdk/models/shared/workspaceschema.rb +7 -43
- data/lib/open_api_sdk/models/shared.rb +2 -11
- data/lib/open_api_sdk/qr_codes.rb +2 -2
- data/lib/open_api_sdk/sdkconfiguration.rb +4 -4
- data/lib/open_api_sdk/tags.rb +28 -115
- data/lib/open_api_sdk/track.rb +85 -2
- data/lib/open_api_sdk/utils/metadata_fields.rb +1 -1
- data/lib/open_api_sdk/utils/t.rb +1 -1
- data/lib/open_api_sdk/utils/utils.rb +5 -4
- data/lib/open_api_sdk/workspaces.rb +1 -3
- metadata +13 -117
- data/lib/open_api_sdk/customers.rb +0 -447
- data/lib/open_api_sdk/embed_tokens.rb +0 -107
- data/lib/open_api_sdk/events.rb +0 -100
- data/lib/open_api_sdk/folders.rb +0 -359
- data/lib/open_api_sdk/models/operations/accesslevel.rb +0 -18
- data/lib/open_api_sdk/models/operations/bulkdeletelinks_request.rb +0 -24
- data/lib/open_api_sdk/models/operations/bulkdeletelinks_response.rb +0 -60
- data/lib/open_api_sdk/models/operations/bulkdeletelinks_responsebody.rb +0 -24
- data/lib/open_api_sdk/models/operations/click.rb +0 -24
- data/lib/open_api_sdk/models/operations/country.rb +0 -266
- data/lib/open_api_sdk/models/operations/createcustomer_discount.rb +0 -42
- data/lib/open_api_sdk/models/operations/createcustomer_interval.rb +0 -18
- data/lib/open_api_sdk/models/operations/createcustomer_link.rb +0 -36
- data/lib/open_api_sdk/models/operations/createcustomer_partner.rb +0 -33
- data/lib/open_api_sdk/models/operations/createcustomer_requestbody.rb +0 -33
- data/lib/open_api_sdk/models/operations/createcustomer_response.rb +0 -60
- data/lib/open_api_sdk/models/operations/createcustomer_responsebody.rb +0 -51
- data/lib/open_api_sdk/models/operations/createcustomer_type.rb +0 -18
- data/lib/open_api_sdk/models/operations/createembedtoken_requestbody.rb +0 -30
- data/lib/open_api_sdk/models/operations/createembedtoken_response.rb +0 -60
- data/lib/open_api_sdk/models/operations/createembedtoken_responsebody.rb +0 -27
- data/lib/open_api_sdk/models/operations/createfolder_requestbody.rb +0 -27
- data/lib/open_api_sdk/models/operations/createfolder_response.rb +0 -60
- data/lib/open_api_sdk/models/operations/createpartner_requestbody.rb +0 -48
- data/lib/open_api_sdk/models/operations/createpartner_responsebody.rb +0 -72
- data/lib/open_api_sdk/models/operations/createpartnerlink_linkprops.rb +0 -102
- data/lib/open_api_sdk/models/operations/createpartnerlink_requestbody.rb +0 -39
- data/lib/open_api_sdk/models/operations/createpartnerlink_response.rb +0 -60
- data/lib/open_api_sdk/models/operations/customer.rb +0 -33
- data/lib/open_api_sdk/models/operations/deletecustomer_request.rb +0 -24
- data/lib/open_api_sdk/models/operations/deletecustomer_response.rb +0 -60
- data/lib/open_api_sdk/models/operations/deletecustomer_responsebody.rb +0 -24
- data/lib/open_api_sdk/models/operations/deletefolder_request.rb +0 -24
- data/lib/open_api_sdk/models/operations/deletefolder_response.rb +0 -60
- data/lib/open_api_sdk/models/operations/deletefolder_responsebody.rb +0 -24
- data/lib/open_api_sdk/models/operations/deletetag_request.rb +0 -24
- data/lib/open_api_sdk/models/operations/deletetag_response.rb +0 -60
- data/lib/open_api_sdk/models/operations/deletetag_responsebody.rb +0 -24
- data/lib/open_api_sdk/models/operations/discount.rb +0 -42
- data/lib/open_api_sdk/models/operations/getcustomer_discount.rb +0 -42
- data/lib/open_api_sdk/models/operations/getcustomer_interval.rb +0 -18
- data/lib/open_api_sdk/models/operations/getcustomer_link.rb +0 -36
- data/lib/open_api_sdk/models/operations/getcustomer_partner.rb +0 -33
- data/lib/open_api_sdk/models/operations/getcustomer_request.rb +0 -27
- data/lib/open_api_sdk/models/operations/getcustomer_response.rb +0 -60
- data/lib/open_api_sdk/models/operations/getcustomer_responsebody.rb +0 -51
- data/lib/open_api_sdk/models/operations/getcustomer_type.rb +0 -18
- data/lib/open_api_sdk/models/operations/getcustomers_interval.rb +0 -18
- data/lib/open_api_sdk/models/operations/getcustomers_request.rb +0 -30
- data/lib/open_api_sdk/models/operations/getcustomers_response.rb +0 -60
- data/lib/open_api_sdk/models/operations/gettags_queryparam_sortby.rb +0 -18
- data/lib/open_api_sdk/models/operations/gettags_queryparam_sortorder.rb +0 -18
- data/lib/open_api_sdk/models/operations/gettags_request.rb +0 -39
- data/lib/open_api_sdk/models/operations/link.rb +0 -36
- data/lib/open_api_sdk/models/operations/linkprops.rb +0 -102
- data/lib/open_api_sdk/models/operations/links.rb +0 -48
- data/lib/open_api_sdk/models/operations/listdomains_request.rb +0 -33
- data/lib/open_api_sdk/models/operations/listevents_request.rb +0 -135
- data/lib/open_api_sdk/models/operations/listevents_response.rb +0 -60
- data/lib/open_api_sdk/models/operations/listfolders_request.rb +0 -24
- data/lib/open_api_sdk/models/operations/listfolders_response.rb +0 -60
- data/lib/open_api_sdk/models/operations/order.rb +0 -20
- data/lib/open_api_sdk/models/operations/partner.rb +0 -33
- data/lib/open_api_sdk/models/operations/queryparam_event.rb +0 -19
- data/lib/open_api_sdk/models/operations/queryparam_groupby.rb +0 -19
- data/lib/open_api_sdk/models/operations/queryparam_interval.rb +0 -25
- data/lib/open_api_sdk/models/operations/queryparam_sortby.rb +0 -17
- data/lib/open_api_sdk/models/operations/queryparam_sortorder.rb +0 -18
- data/lib/open_api_sdk/models/operations/queryparam_trigger.rb +0 -18
- data/lib/open_api_sdk/models/operations/responsebody.rb +0 -51
- data/lib/open_api_sdk/models/operations/retrievepartneranalytics_queryparam_interval.rb +0 -26
- data/lib/open_api_sdk/models/operations/retrievepartneranalytics_request.rb +0 -45
- data/lib/open_api_sdk/models/operations/retrievepartneranalytics_response.rb +0 -60
- data/lib/open_api_sdk/models/operations/sale.rb +0 -36
- data/lib/open_api_sdk/models/operations/sortby.rb +0 -20
- data/lib/open_api_sdk/models/operations/sortorder.rb +0 -18
- data/lib/open_api_sdk/models/operations/status.rb +0 -19
- data/lib/open_api_sdk/models/operations/tracksale_customer.rb +0 -36
- data/lib/open_api_sdk/models/operations/trigger.rb +0 -18
- data/lib/open_api_sdk/models/operations/type.rb +0 -18
- data/lib/open_api_sdk/models/operations/updatecustomer_discount.rb +0 -42
- data/lib/open_api_sdk/models/operations/updatecustomer_interval.rb +0 -18
- data/lib/open_api_sdk/models/operations/updatecustomer_link.rb +0 -36
- data/lib/open_api_sdk/models/operations/updatecustomer_partner.rb +0 -33
- data/lib/open_api_sdk/models/operations/updatecustomer_request.rb +0 -30
- data/lib/open_api_sdk/models/operations/updatecustomer_requestbody.rb +0 -33
- data/lib/open_api_sdk/models/operations/updatecustomer_response.rb +0 -60
- data/lib/open_api_sdk/models/operations/updatecustomer_responsebody.rb +0 -51
- data/lib/open_api_sdk/models/operations/updatecustomer_type.rb +0 -18
- data/lib/open_api_sdk/models/operations/updatefolder_accesslevel.rb +0 -18
- data/lib/open_api_sdk/models/operations/updatefolder_request.rb +0 -27
- data/lib/open_api_sdk/models/operations/updatefolder_requestbody.rb +0 -27
- data/lib/open_api_sdk/models/operations/updatefolder_response.rb +0 -60
- data/lib/open_api_sdk/models/operations/upsertpartnerlink_linkprops.rb +0 -102
- data/lib/open_api_sdk/models/operations/upsertpartnerlink_requestbody.rb +0 -39
- data/lib/open_api_sdk/models/operations/upsertpartnerlink_response.rb +0 -60
- data/lib/open_api_sdk/models/shared/accesslevel.rb +0 -18
- data/lib/open_api_sdk/models/shared/click.rb +0 -63
- data/lib/open_api_sdk/models/shared/clickevent.rb +0 -98
- data/lib/open_api_sdk/models/shared/clickevent_geo.rb +0 -771
- data/lib/open_api_sdk/models/shared/continentcode.rb +0 -23
- data/lib/open_api_sdk/models/shared/event.rb +0 -17
- data/lib/open_api_sdk/models/shared/folderschema.rb +0 -39
- data/lib/open_api_sdk/models/shared/link.rb +0 -163
- data/lib/open_api_sdk/models/shared/registereddomain.rb +0 -30
- data/lib/open_api_sdk/partners.rb +0 -358
@@ -1,4 +1,4 @@
|
|
1
|
-
# Code generated by Speakeasy (https://
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
2
2
|
|
3
3
|
# typed: true
|
4
4
|
# frozen_string_literal: true
|
@@ -15,11 +15,11 @@ module OpenApiSDK
|
|
15
15
|
field :url, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('url') } }
|
16
16
|
# The Android destination URL for the short link for Android device targeting.
|
17
17
|
field :android, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('android') } }
|
18
|
-
# Whether the short link is archived.
|
18
|
+
# Whether the short link is archived.
|
19
19
|
field :archived, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('archived') } }
|
20
20
|
# The comments for the short link.
|
21
21
|
field :comments, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('comments') } }
|
22
|
-
# The
|
22
|
+
# The description of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
|
23
23
|
field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description') } }
|
24
24
|
# Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex
|
25
25
|
field :do_index, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('doIndex') } }
|
@@ -29,35 +29,25 @@ 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
|
+
# 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
33
|
field :external_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
|
34
|
-
# The unique ID existing folder to assign the short link to.
|
35
|
-
field :folder_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('folderId') } }
|
36
34
|
# Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`.
|
37
35
|
field :geo, T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('geo') } }
|
38
|
-
# The
|
36
|
+
# The image of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
|
39
37
|
field :image, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
|
40
38
|
# The iOS destination URL for the short link for iOS device targeting.
|
41
39
|
field :ios, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ios') } }
|
42
40
|
# The short link slug. If not provided, a random 7-character slug will be generated.
|
43
41
|
field :key, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('key') } }
|
44
|
-
# The ID of the partner the short link is associated with.
|
45
|
-
field :partner_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('partnerId') } }
|
46
42
|
# The password required to access the destination URL of the short link.
|
47
43
|
field :password, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('password') } }
|
48
44
|
# The prefix of the short link slug for randomly-generated keys (e.g. if prefix is `/c/`, generated keys will be in the `/c/:key` format). Will be ignored if `key` is provided.
|
49
45
|
field :prefix, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('prefix') } }
|
50
|
-
#
|
51
|
-
field :program_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
|
52
|
-
# Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided.
|
46
|
+
# Whether the short link uses Custom Social Media Cards feature.
|
53
47
|
field :proxy, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('proxy') } }
|
54
|
-
#
|
55
|
-
#
|
56
|
-
# @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
|
48
|
+
# Whether the short link's stats are publicly accessible.
|
57
49
|
field :public_stats, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('publicStats') } }
|
58
|
-
#
|
59
|
-
field :ref, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ref') } }
|
60
|
-
# Whether the short link uses link cloaking. Defaults to `false` if not provided.
|
50
|
+
# Whether the short link uses link cloaking.
|
61
51
|
field :rewrite, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('rewrite') } }
|
62
52
|
# The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead.
|
63
53
|
#
|
@@ -67,30 +57,14 @@ module OpenApiSDK
|
|
67
57
|
field :tag_ids, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagIds') } }
|
68
58
|
# The unique name of the tags assigned to the short link (case insensitive).
|
69
59
|
field :tag_names, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagNames') } }
|
70
|
-
# The
|
71
|
-
field :tenant_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } }
|
72
|
-
# 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
|
60
|
+
# The title of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
|
73
61
|
field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
|
74
|
-
# Whether to track conversions for the short link.
|
62
|
+
# Whether to track conversions for the short link.
|
75
63
|
field :track_conversion, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trackConversion') } }
|
76
|
-
# The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL.
|
77
|
-
field :utm_campaign, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_campaign') } }
|
78
|
-
# The UTM content of the short link. If set, this will populate or override the UTM content in the destination URL.
|
79
|
-
field :utm_content, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_content') } }
|
80
|
-
# The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL.
|
81
|
-
field :utm_medium, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_medium') } }
|
82
|
-
# The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL.
|
83
|
-
field :utm_source, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_source') } }
|
84
|
-
# The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL.
|
85
|
-
field :utm_term, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_term') } }
|
86
|
-
# The custom link preview video (og:video). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
|
87
|
-
field :video, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('video') } }
|
88
|
-
# An array of webhook IDs to trigger when the link is clicked. These webhooks will receive click event data.
|
89
|
-
field :webhook_ids, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('webhookIds') } }
|
90
64
|
|
91
65
|
|
92
|
-
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),
|
93
|
-
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,
|
66
|
+
sig { params(url: ::String, android: T.nilable(::String), archived: T.nilable(T::Boolean), comments: T.nilable(::String), description: T.nilable(::String), do_index: T.nilable(T::Boolean), domain: T.nilable(::String), expired_url: T.nilable(::String), expires_at: T.nilable(::String), external_id: T.nilable(::String), geo: T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), image: T.nilable(::String), ios: T.nilable(::String), key: T.nilable(::String), password: T.nilable(::String), prefix: T.nilable(::String), proxy: T.nilable(T::Boolean), public_stats: T.nilable(T::Boolean), 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)).void }
|
67
|
+
def initialize(url: nil, android: nil, archived: nil, comments: nil, description: nil, do_index: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, image: nil, ios: nil, key: nil, password: nil, prefix: nil, proxy: nil, public_stats: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, title: nil, track_conversion: nil)
|
94
68
|
@url = url
|
95
69
|
@android = android
|
96
70
|
@archived = archived
|
@@ -101,32 +75,20 @@ module OpenApiSDK
|
|
101
75
|
@expired_url = expired_url
|
102
76
|
@expires_at = expires_at
|
103
77
|
@external_id = external_id
|
104
|
-
@folder_id = folder_id
|
105
78
|
@geo = geo
|
106
79
|
@image = image
|
107
80
|
@ios = ios
|
108
81
|
@key = key
|
109
|
-
@partner_id = partner_id
|
110
82
|
@password = password
|
111
83
|
@prefix = prefix
|
112
|
-
@program_id = program_id
|
113
84
|
@proxy = proxy
|
114
85
|
@public_stats = public_stats
|
115
|
-
@ref = ref
|
116
86
|
@rewrite = rewrite
|
117
87
|
@tag_id = tag_id
|
118
88
|
@tag_ids = tag_ids
|
119
89
|
@tag_names = tag_names
|
120
|
-
@tenant_id = tenant_id
|
121
90
|
@title = title
|
122
91
|
@track_conversion = track_conversion
|
123
|
-
@utm_campaign = utm_campaign
|
124
|
-
@utm_content = utm_content
|
125
|
-
@utm_medium = utm_medium
|
126
|
-
@utm_source = utm_source
|
127
|
-
@utm_term = utm_term
|
128
|
-
@video = video
|
129
|
-
@webhook_ids = webhook_ids
|
130
92
|
end
|
131
93
|
end
|
132
94
|
end
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# Code generated by Speakeasy (https://
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
2
2
|
|
3
3
|
# typed: true
|
4
4
|
# frozen_string_literal: true
|
@@ -13,11 +13,11 @@ module OpenApiSDK
|
|
13
13
|
|
14
14
|
# The Android destination URL for the short link for Android device targeting.
|
15
15
|
field :android, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('android') } }
|
16
|
-
# Whether the short link is archived.
|
16
|
+
# Whether the short link is archived.
|
17
17
|
field :archived, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('archived') } }
|
18
18
|
# The comments for the short link.
|
19
19
|
field :comments, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('comments') } }
|
20
|
-
# The
|
20
|
+
# The description of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
|
21
21
|
field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description') } }
|
22
22
|
# Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex
|
23
23
|
field :do_index, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('doIndex') } }
|
@@ -25,29 +25,19 @@ module OpenApiSDK
|
|
25
25
|
field :expired_url, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiredUrl') } }
|
26
26
|
# The date and time when the short link will expire at.
|
27
27
|
field :expires_at, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiresAt') } }
|
28
|
-
# The unique ID existing folder to assign the short link to.
|
29
|
-
field :folder_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('folderId') } }
|
30
28
|
# Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`.
|
31
29
|
field :geo, T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('geo') } }
|
32
|
-
# The
|
30
|
+
# The image of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
|
33
31
|
field :image, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
|
34
32
|
# The iOS destination URL for the short link for iOS device targeting.
|
35
33
|
field :ios, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ios') } }
|
36
|
-
# The ID of the partner the short link is associated with.
|
37
|
-
field :partner_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('partnerId') } }
|
38
34
|
# The password required to access the destination URL of the short link.
|
39
35
|
field :password, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('password') } }
|
40
|
-
#
|
41
|
-
field :program_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
|
42
|
-
# Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided.
|
36
|
+
# Whether the short link uses Custom Social Media Cards feature.
|
43
37
|
field :proxy, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('proxy') } }
|
44
|
-
#
|
45
|
-
#
|
46
|
-
# @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
|
38
|
+
# Whether the short link's stats are publicly accessible.
|
47
39
|
field :public_stats, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('publicStats') } }
|
48
|
-
#
|
49
|
-
field :ref, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ref') } }
|
50
|
-
# Whether the short link uses link cloaking. Defaults to `false` if not provided.
|
40
|
+
# Whether the short link uses link cloaking.
|
51
41
|
field :rewrite, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('rewrite') } }
|
52
42
|
# The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead.
|
53
43
|
#
|
@@ -57,32 +47,16 @@ module OpenApiSDK
|
|
57
47
|
field :tag_ids, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagIds') } }
|
58
48
|
# The unique name of the tags assigned to the short link (case insensitive).
|
59
49
|
field :tag_names, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagNames') } }
|
60
|
-
# The
|
61
|
-
field :tenant_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } }
|
62
|
-
# 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
|
50
|
+
# The title of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
|
63
51
|
field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
|
64
|
-
# Whether to track conversions for the short link.
|
52
|
+
# Whether to track conversions for the short link.
|
65
53
|
field :track_conversion, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trackConversion') } }
|
66
54
|
# The destination URL of the short link.
|
67
55
|
field :url, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('url') } }
|
68
|
-
# The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL.
|
69
|
-
field :utm_campaign, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_campaign') } }
|
70
|
-
# The UTM content of the short link. If set, this will populate or override the UTM content in the destination URL.
|
71
|
-
field :utm_content, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_content') } }
|
72
|
-
# The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL.
|
73
|
-
field :utm_medium, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_medium') } }
|
74
|
-
# The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL.
|
75
|
-
field :utm_source, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_source') } }
|
76
|
-
# The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL.
|
77
|
-
field :utm_term, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_term') } }
|
78
|
-
# The custom link preview video (og:video). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
|
79
|
-
field :video, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('video') } }
|
80
|
-
# An array of webhook IDs to trigger when the link is clicked. These webhooks will receive click event data.
|
81
|
-
field :webhook_ids, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('webhookIds') } }
|
82
56
|
|
83
57
|
|
84
|
-
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),
|
85
|
-
def initialize(android: nil, archived: nil, comments: nil, description: nil, do_index: nil, expired_url: nil, expires_at: nil,
|
58
|
+
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), 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 }
|
59
|
+
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, proxy: nil, public_stats: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, title: nil, track_conversion: nil, url: nil)
|
86
60
|
@android = android
|
87
61
|
@archived = archived
|
88
62
|
@comments = comments
|
@@ -90,31 +64,19 @@ module OpenApiSDK
|
|
90
64
|
@do_index = do_index
|
91
65
|
@expired_url = expired_url
|
92
66
|
@expires_at = expires_at
|
93
|
-
@folder_id = folder_id
|
94
67
|
@geo = geo
|
95
68
|
@image = image
|
96
69
|
@ios = ios
|
97
|
-
@partner_id = partner_id
|
98
70
|
@password = password
|
99
|
-
@program_id = program_id
|
100
71
|
@proxy = proxy
|
101
72
|
@public_stats = public_stats
|
102
|
-
@ref = ref
|
103
73
|
@rewrite = rewrite
|
104
74
|
@tag_id = tag_id
|
105
75
|
@tag_ids = tag_ids
|
106
76
|
@tag_names = tag_names
|
107
|
-
@tenant_id = tenant_id
|
108
77
|
@title = title
|
109
78
|
@track_conversion = track_conversion
|
110
79
|
@url = url
|
111
|
-
@utm_campaign = utm_campaign
|
112
|
-
@utm_content = utm_content
|
113
|
-
@utm_medium = utm_medium
|
114
|
-
@utm_source = utm_source
|
115
|
-
@utm_term = utm_term
|
116
|
-
@video = video
|
117
|
-
@webhook_ids = webhook_ids
|
118
80
|
end
|
119
81
|
end
|
120
82
|
end
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# Code generated by Speakeasy (https://
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
2
2
|
|
3
3
|
# typed: true
|
4
4
|
# frozen_string_literal: true
|
@@ -29,7 +29,7 @@ module OpenApiSDK
|
|
29
29
|
field :invite_expired, T.nilable(::OpenApiSDK::Shared::InviteExpired)
|
30
30
|
# The server cannot find the requested resource.
|
31
31
|
field :not_found, T.nilable(::OpenApiSDK::Shared::NotFound)
|
32
|
-
# The deleted link
|
32
|
+
# The deleted link
|
33
33
|
field :object, T.nilable(::OpenApiSDK::Operations::DeleteLinkResponseBody)
|
34
34
|
# The user has sent too many requests in a given amount of time ("rate limiting")
|
35
35
|
field :rate_limit_exceeded, T.nilable(::OpenApiSDK::Shared::RateLimitExceeded)
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# Code generated by Speakeasy (https://
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
2
2
|
|
3
3
|
# typed: true
|
4
4
|
# frozen_string_literal: true
|
@@ -7,7 +7,7 @@
|
|
7
7
|
module OpenApiSDK
|
8
8
|
module Operations
|
9
9
|
|
10
|
-
# The deleted link
|
10
|
+
# The deleted link
|
11
11
|
class DeleteLinkResponseBody < ::OpenApiSDK::Utils::FieldAugmented
|
12
12
|
extend T::Sig
|
13
13
|
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# Code generated by Speakeasy (https://
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
2
2
|
|
3
3
|
# typed: true
|
4
4
|
# frozen_string_literal: true
|
@@ -7,7 +7,7 @@
|
|
7
7
|
module OpenApiSDK
|
8
8
|
module Operations
|
9
9
|
|
10
|
-
# Event - The type of event to retrieve analytics for. Defaults to
|
10
|
+
# Event - The type of event to retrieve analytics for. Defaults to 'clicks'.
|
11
11
|
class Event < T::Enum
|
12
12
|
enums do
|
13
13
|
CLICKS = new('clicks')
|
@@ -16,5 +16,6 @@ module OpenApiSDK
|
|
16
16
|
COMPOSITE = new('composite')
|
17
17
|
end
|
18
18
|
end
|
19
|
+
|
19
20
|
end
|
20
21
|
end
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# Code generated by Speakeasy (https://
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
2
2
|
|
3
3
|
# typed: true
|
4
4
|
# frozen_string_literal: true
|
@@ -13,7 +13,7 @@ module OpenApiSDK
|
|
13
13
|
|
14
14
|
|
15
15
|
field :domain, T.nilable(::String), { 'query_param': { 'field_name': 'domain', 'style': 'form', 'explode': true } }
|
16
|
-
# This is the ID of the link in the your database.
|
16
|
+
# This is the ID of the link in the your database. Must be prefixed with `ext_` when passed as a query parameter.
|
17
17
|
field :external_id, T.nilable(::String), { 'query_param': { 'field_name': 'externalId', 'style': 'form', 'explode': true } }
|
18
18
|
# The key of the link to retrieve. E.g. for `d.to/github`, the key is `github`.
|
19
19
|
field :key, T.nilable(::String), { 'query_param': { 'field_name': 'key', 'style': 'form', 'explode': true } }
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# Code generated by Speakeasy (https://
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
2
2
|
|
3
3
|
# typed: true
|
4
4
|
# frozen_string_literal: true
|
@@ -13,51 +13,36 @@ module OpenApiSDK
|
|
13
13
|
|
14
14
|
# The domain to filter the links by. E.g. `ac.me`. If not provided, all links for the workspace will be returned.
|
15
15
|
field :domain, T.nilable(::String), { 'query_param': { 'field_name': 'domain', 'style': 'form', 'explode': true } }
|
16
|
-
# The
|
17
|
-
field :
|
18
|
-
# The page number for pagination.
|
19
|
-
field :page, T.nilable(::Float), { 'query_param': { 'field_name': 'page', 'style': 'form', 'explode': true } }
|
20
|
-
# The number of items per page.
|
21
|
-
field :page_size, T.nilable(::Float), { 'query_param': { 'field_name': 'pageSize', 'style': 'form', 'explode': true } }
|
16
|
+
# The page number for pagination (each page contains 100 links).
|
17
|
+
field :page, T.nilable(::Integer), { 'query_param': { 'field_name': 'page', 'style': 'form', 'explode': true } }
|
22
18
|
# The search term to filter the links by. The search term will be matched against the short link slug and the destination url.
|
23
19
|
field :search, T.nilable(::String), { 'query_param': { 'field_name': 'search', 'style': 'form', 'explode': true } }
|
24
20
|
# Whether to include archived links in the response. Defaults to `false` if not provided.
|
25
21
|
field :show_archived, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'showArchived', 'style': 'form', 'explode': true } }
|
26
|
-
#
|
22
|
+
# The field to sort the links by. The default is `createdAt`, and sort order is always descending.
|
27
23
|
field :sort, T.nilable(::OpenApiSDK::Operations::Sort), { 'query_param': { 'field_name': 'sort', 'style': 'form', 'explode': true } }
|
28
|
-
# The
|
29
|
-
field :sort_by, T.nilable(::OpenApiSDK::Operations::SortBy), { 'query_param': { 'field_name': 'sortBy', 'style': 'form', 'explode': true } }
|
30
|
-
# The sort order. The default is `desc`.
|
31
|
-
field :sort_order, T.nilable(::OpenApiSDK::Operations::SortOrder), { 'query_param': { 'field_name': 'sortOrder', 'style': 'form', 'explode': true } }
|
32
|
-
# Deprecated. Use `tagIds` instead. The tag ID to filter the links by.
|
24
|
+
# The tag ID to filter the links by. This field is deprecated – use `tagIds` instead.
|
33
25
|
field :tag_id, T.nilable(::String), { 'query_param': { 'field_name': 'tagId', 'style': 'form', 'explode': true } }
|
34
26
|
# The tag IDs to filter the links by.
|
35
27
|
field :tag_ids, T.nilable(::Object), { 'query_param': { 'field_name': 'tagIds', 'style': 'form', 'explode': true } }
|
36
28
|
# The unique name of the tags assigned to the short link (case insensitive).
|
37
29
|
field :tag_names, T.nilable(::Object), { 'query_param': { 'field_name': 'tagNames', 'style': 'form', 'explode': true } }
|
38
|
-
# The ID of the tenant that created the link inside your system. If set, will only return links for the specified tenant.
|
39
|
-
field :tenant_id, T.nilable(::String), { 'query_param': { 'field_name': 'tenantId', 'style': 'form', 'explode': true } }
|
40
30
|
# The user ID to filter the links by.
|
41
31
|
field :user_id, T.nilable(::String), { 'query_param': { 'field_name': 'userId', 'style': 'form', 'explode': true } }
|
42
|
-
#
|
32
|
+
# Whether to include tags in the response. Defaults to `false` if not provided.
|
43
33
|
field :with_tags, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'withTags', 'style': 'form', 'explode': true } }
|
44
34
|
|
45
35
|
|
46
|
-
sig { params(domain: T.nilable(::String),
|
47
|
-
def initialize(domain: 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)
|
48
38
|
@domain = domain
|
49
|
-
@folder_id = folder_id
|
50
39
|
@page = page
|
51
|
-
@page_size = page_size
|
52
40
|
@search = search
|
53
41
|
@show_archived = show_archived
|
54
42
|
@sort = sort
|
55
|
-
@sort_by = sort_by
|
56
|
-
@sort_order = sort_order
|
57
43
|
@tag_id = tag_id
|
58
44
|
@tag_ids = tag_ids
|
59
45
|
@tag_names = tag_names
|
60
|
-
@tenant_id = tenant_id
|
61
46
|
@user_id = user_id
|
62
47
|
@with_tags = with_tags
|
63
48
|
end
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# Code generated by Speakeasy (https://
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
2
2
|
|
3
3
|
# typed: true
|
4
4
|
# frozen_string_literal: true
|
@@ -13,39 +13,33 @@ module OpenApiSDK
|
|
13
13
|
|
14
14
|
# The domain to filter the links by. E.g. `ac.me`. If not provided, all links for the workspace will be returned.
|
15
15
|
field :domain, T.nilable(::String), { 'query_param': { 'field_name': 'domain', 'style': 'form', 'explode': true } }
|
16
|
-
# The folder ID to filter the links by.
|
17
|
-
field :folder_id, T.nilable(::String), { 'query_param': { 'field_name': 'folderId', 'style': 'form', 'explode': true } }
|
18
16
|
# The field to group the links by.
|
19
17
|
field :group_by, T.nilable(::Object), { 'query_param': { 'field_name': 'groupBy', '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.
|
23
21
|
field :show_archived, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'showArchived', 'style': 'form', 'explode': true } }
|
24
|
-
#
|
22
|
+
# The tag ID to filter the links by. This field is deprecated – use `tagIds` instead.
|
25
23
|
field :tag_id, T.nilable(::String), { 'query_param': { 'field_name': 'tagId', 'style': 'form', 'explode': true } }
|
26
24
|
# The tag IDs to filter the links by.
|
27
25
|
field :tag_ids, T.nilable(::Object), { 'query_param': { 'field_name': 'tagIds', 'style': 'form', 'explode': true } }
|
28
26
|
# The unique name of the tags assigned to the short link (case insensitive).
|
29
27
|
field :tag_names, T.nilable(::Object), { 'query_param': { 'field_name': 'tagNames', 'style': 'form', 'explode': true } }
|
30
|
-
# The ID of the tenant that created the link inside your system. If set, will only return links for the specified tenant.
|
31
|
-
field :tenant_id, T.nilable(::String), { 'query_param': { 'field_name': 'tenantId', 'style': 'form', 'explode': true } }
|
32
28
|
# The user ID to filter the links by.
|
33
29
|
field :user_id, T.nilable(::String), { 'query_param': { 'field_name': 'userId', 'style': 'form', 'explode': true } }
|
34
|
-
#
|
30
|
+
# Whether to include tags in the response. Defaults to `false` if not provided.
|
35
31
|
field :with_tags, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'withTags', 'style': 'form', 'explode': true } }
|
36
32
|
|
37
33
|
|
38
|
-
sig { params(domain: T.nilable(::String),
|
39
|
-
def initialize(domain: 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
|
-
@folder_id = folder_id
|
42
37
|
@group_by = group_by
|
43
38
|
@search = search
|
44
39
|
@show_archived = show_archived
|
45
40
|
@tag_id = tag_id
|
46
41
|
@tag_ids = tag_ids
|
47
42
|
@tag_names = tag_names
|
48
|
-
@tenant_id = tenant_id
|
49
43
|
@user_id = user_id
|
50
44
|
@with_tags = with_tags
|
51
45
|
end
|
@@ -1,4 +1,4 @@
|
|
1
|
-
# Code generated by Speakeasy (https://
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
2
2
|
|
3
3
|
# typed: true
|
4
4
|
# frozen_string_literal: true
|
@@ -17,30 +17,21 @@ module OpenApiSDK
|
|
17
17
|
field :bg_color, T.nilable(::String), { 'query_param': { 'field_name': 'bgColor', 'style': 'form', 'explode': true } }
|
18
18
|
# The foreground color of the QR code in hex format. Defaults to `#000000` if not provided.
|
19
19
|
field :fg_color, T.nilable(::String), { 'query_param': { 'field_name': 'fgColor', 'style': 'form', 'explode': true } }
|
20
|
-
# Whether to
|
21
|
-
field :hide_logo, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'hideLogo', 'style': 'form', 'explode': true } }
|
22
|
-
# DEPRECATED: Margin is included by default. Use the `margin` prop to customize the margin size.
|
20
|
+
# Whether to include a margin around the QR code. Defaults to `false` if not provided.
|
23
21
|
field :include_margin, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'includeMargin', 'style': 'form', 'explode': true } }
|
24
22
|
# The level of error correction to use for the QR code. Defaults to `L` if not provided.
|
25
23
|
field :level, T.nilable(::OpenApiSDK::Operations::Level), { 'query_param': { 'field_name': 'level', 'style': 'form', 'explode': true } }
|
26
|
-
# The logo to include in the QR code. Can only be used with a paid plan on Dub.co.
|
27
|
-
field :logo, T.nilable(::String), { 'query_param': { 'field_name': 'logo', 'style': 'form', 'explode': true } }
|
28
|
-
# The size of the margin around the QR code. Defaults to 2 if not provided.
|
29
|
-
field :margin, T.nilable(::Float), { 'query_param': { 'field_name': 'margin', 'style': 'form', 'explode': true } }
|
30
24
|
# The size of the QR code in pixels. Defaults to `600` if not provided.
|
31
25
|
field :size, T.nilable(::Float), { 'query_param': { 'field_name': 'size', 'style': 'form', 'explode': true } }
|
32
26
|
|
33
27
|
|
34
|
-
sig { params(url: ::String, bg_color: T.nilable(::String), fg_color: T.nilable(::String),
|
35
|
-
def initialize(url: nil, bg_color: nil, fg_color: nil,
|
28
|
+
sig { params(url: ::String, bg_color: T.nilable(::String), fg_color: T.nilable(::String), include_margin: T.nilable(T::Boolean), level: T.nilable(::OpenApiSDK::Operations::Level), size: T.nilable(::Float)).void }
|
29
|
+
def initialize(url: nil, bg_color: nil, fg_color: nil, include_margin: nil, level: nil, size: nil)
|
36
30
|
@url = url
|
37
31
|
@bg_color = bg_color
|
38
32
|
@fg_color = fg_color
|
39
|
-
@hide_logo = hide_logo
|
40
33
|
@include_margin = include_margin
|
41
34
|
@level = level
|
42
|
-
@logo = logo
|
43
|
-
@margin = margin
|
44
35
|
@size = size
|
45
36
|
end
|
46
37
|
end
|