dub 0.0.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 +7 -0
- data/lib/dub.rb +23 -0
- data/lib/open_api_sdk/analytics.rb +99 -0
- data/lib/open_api_sdk/domains.rb +577 -0
- data/lib/open_api_sdk/dub.rb +107 -0
- data/lib/open_api_sdk/links.rb +724 -0
- data/lib/open_api_sdk/metatags.rb +58 -0
- data/lib/open_api_sdk/models/operations/adddomain_request.rb +30 -0
- data/lib/open_api_sdk/models/operations/adddomain_requestbody.rb +42 -0
- data/lib/open_api_sdk/models/operations/adddomain_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/bulkcreatelinks_request.rb +30 -0
- data/lib/open_api_sdk/models/operations/bulkcreatelinks_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/color.rb +24 -0
- data/lib/open_api_sdk/models/operations/createlink_request.rb +30 -0
- data/lib/open_api_sdk/models/operations/createlink_requestbody.rb +92 -0
- data/lib/open_api_sdk/models/operations/createlink_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/createtag_request.rb +30 -0
- data/lib/open_api_sdk/models/operations/createtag_requestbody.rb +27 -0
- data/lib/open_api_sdk/models/operations/createtag_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/createworkspace_requestbody.rb +30 -0
- data/lib/open_api_sdk/models/operations/createworkspace_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/deletedomain_request.rb +30 -0
- data/lib/open_api_sdk/models/operations/deletedomain_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/deletedomain_responsebody.rb +24 -0
- data/lib/open_api_sdk/models/operations/deletelink_request.rb +30 -0
- data/lib/open_api_sdk/models/operations/deletelink_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/deletelink_responsebody.rb +24 -0
- data/lib/open_api_sdk/models/operations/event.rb +21 -0
- data/lib/open_api_sdk/models/operations/getlinkinfo_request.rb +39 -0
- data/lib/open_api_sdk/models/operations/getlinkinfo_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/getlinks_request.rb +57 -0
- data/lib/open_api_sdk/models/operations/getlinks_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/getlinkscount_request.rb +54 -0
- data/lib/open_api_sdk/models/operations/getlinkscount_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/getmetatags_request.rb +24 -0
- data/lib/open_api_sdk/models/operations/getmetatags_response.rb +33 -0
- data/lib/open_api_sdk/models/operations/getmetatags_responsebody.rb +30 -0
- data/lib/open_api_sdk/models/operations/getqrcode_request.rb +39 -0
- data/lib/open_api_sdk/models/operations/getqrcode_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/gettags_request.rb +27 -0
- data/lib/open_api_sdk/models/operations/gettags_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/getworkspace_request.rb +24 -0
- data/lib/open_api_sdk/models/operations/getworkspace_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/getworkspaces_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/groupby.rb +28 -0
- data/lib/open_api_sdk/models/operations/interval.rb +25 -0
- data/lib/open_api_sdk/models/operations/level.rb +21 -0
- data/lib/open_api_sdk/models/operations/listdomains_request.rb +27 -0
- data/lib/open_api_sdk/models/operations/listdomains_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/paymentprocessor.rb +20 -0
- data/lib/open_api_sdk/models/operations/requestbody.rb +92 -0
- data/lib/open_api_sdk/models/operations/retrieveanalytics_request.rb +87 -0
- data/lib/open_api_sdk/models/operations/retrieveanalytics_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/setprimarydomain_request.rb +30 -0
- data/lib/open_api_sdk/models/operations/setprimarydomain_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/sort.rb +20 -0
- data/lib/open_api_sdk/models/operations/trackcustomer_requestbody.rb +33 -0
- data/lib/open_api_sdk/models/operations/trackcustomer_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/trackcustomer_responsebody.rb +33 -0
- data/lib/open_api_sdk/models/operations/tracklead_requestbody.rb +42 -0
- data/lib/open_api_sdk/models/operations/tracklead_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/tracklead_responsebody.rb +42 -0
- data/lib/open_api_sdk/models/operations/tracksale_requestbody.rb +39 -0
- data/lib/open_api_sdk/models/operations/tracksale_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/tracksale_responsebody.rb +39 -0
- data/lib/open_api_sdk/models/operations/transferdomain_request.rb +33 -0
- data/lib/open_api_sdk/models/operations/transferdomain_requestbody.rb +24 -0
- data/lib/open_api_sdk/models/operations/transferdomain_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/type.rb +19 -0
- data/lib/open_api_sdk/models/operations/updatedomain_request.rb +33 -0
- data/lib/open_api_sdk/models/operations/updatedomain_requestbody.rb +42 -0
- data/lib/open_api_sdk/models/operations/updatedomain_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/updatedomain_type.rb +19 -0
- data/lib/open_api_sdk/models/operations/updatelink_request.rb +33 -0
- data/lib/open_api_sdk/models/operations/updatelink_requestbody.rb +92 -0
- data/lib/open_api_sdk/models/operations/updatelink_response.rb +60 -0
- data/lib/open_api_sdk/models/operations/upsertlink_request.rb +30 -0
- data/lib/open_api_sdk/models/operations/upsertlink_requestbody.rb +92 -0
- data/lib/open_api_sdk/models/operations/upsertlink_response.rb +60 -0
- data/lib/open_api_sdk/models/operations.rb +81 -0
- data/lib/open_api_sdk/models/shared/badrequest.rb +24 -0
- data/lib/open_api_sdk/models/shared/code.rb +18 -0
- data/lib/open_api_sdk/models/shared/color.rb +24 -0
- data/lib/open_api_sdk/models/shared/conflict.rb +24 -0
- data/lib/open_api_sdk/models/shared/conflict_code.rb +18 -0
- data/lib/open_api_sdk/models/shared/conflict_error.rb +30 -0
- data/lib/open_api_sdk/models/shared/countrycode.rb +267 -0
- data/lib/open_api_sdk/models/shared/domains.rb +27 -0
- data/lib/open_api_sdk/models/shared/domainschema.rb +54 -0
- data/lib/open_api_sdk/models/shared/error.rb +30 -0
- data/lib/open_api_sdk/models/shared/forbidden.rb +24 -0
- data/lib/open_api_sdk/models/shared/forbidden_code.rb +18 -0
- data/lib/open_api_sdk/models/shared/forbidden_error.rb +30 -0
- data/lib/open_api_sdk/models/shared/geo.rb +771 -0
- data/lib/open_api_sdk/models/shared/internalservererror.rb +24 -0
- data/lib/open_api_sdk/models/shared/internalservererror_code.rb +18 -0
- data/lib/open_api_sdk/models/shared/internalservererror_error.rb +30 -0
- data/lib/open_api_sdk/models/shared/inviteexpired.rb +24 -0
- data/lib/open_api_sdk/models/shared/inviteexpired_code.rb +18 -0
- data/lib/open_api_sdk/models/shared/inviteexpired_error.rb +30 -0
- data/lib/open_api_sdk/models/shared/linkgeotargeting.rb +771 -0
- data/lib/open_api_sdk/models/shared/linkschema.rb +139 -0
- data/lib/open_api_sdk/models/shared/notfound.rb +24 -0
- data/lib/open_api_sdk/models/shared/notfound_code.rb +18 -0
- data/lib/open_api_sdk/models/shared/notfound_error.rb +30 -0
- data/lib/open_api_sdk/models/shared/plan.rb +24 -0
- data/lib/open_api_sdk/models/shared/ratelimitexceeded.rb +24 -0
- data/lib/open_api_sdk/models/shared/ratelimitexceeded_code.rb +18 -0
- data/lib/open_api_sdk/models/shared/ratelimitexceeded_error.rb +30 -0
- data/lib/open_api_sdk/models/shared/role.rb +19 -0
- data/lib/open_api_sdk/models/shared/security.rb +24 -0
- data/lib/open_api_sdk/models/shared/tagschema.rb +30 -0
- data/lib/open_api_sdk/models/shared/type.rb +19 -0
- data/lib/open_api_sdk/models/shared/unauthorized.rb +24 -0
- data/lib/open_api_sdk/models/shared/unauthorized_code.rb +18 -0
- data/lib/open_api_sdk/models/shared/unauthorized_error.rb +30 -0
- data/lib/open_api_sdk/models/shared/unprocessableentity.rb +24 -0
- data/lib/open_api_sdk/models/shared/unprocessableentity_code.rb +18 -0
- data/lib/open_api_sdk/models/shared/unprocessableentity_error.rb +30 -0
- data/lib/open_api_sdk/models/shared/users.rb +24 -0
- data/lib/open_api_sdk/models/shared/workspaceschema.rb +81 -0
- data/lib/open_api_sdk/models/shared.rb +50 -0
- data/lib/open_api_sdk/qr_codes.rb +97 -0
- data/lib/open_api_sdk/sdkconfiguration.rb +54 -0
- data/lib/open_api_sdk/tags.rb +197 -0
- data/lib/open_api_sdk/track.rb +276 -0
- data/lib/open_api_sdk/utils/metadata_fields.rb +150 -0
- data/lib/open_api_sdk/utils/t.rb +59 -0
- data/lib/open_api_sdk/utils/utils.rb +772 -0
- data/lib/open_api_sdk/workspaces.rb +268 -0
- metadata +300 -0
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
# typed: true
|
|
4
|
+
# frozen_string_literal: true
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
module OpenApiSDK
|
|
8
|
+
module Operations
|
|
9
|
+
|
|
10
|
+
# A lead was tracked.
|
|
11
|
+
class TrackLeadResponseBody < ::OpenApiSDK::Utils::FieldAugmented
|
|
12
|
+
extend T::Sig
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
field :click_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('clickId') } }
|
|
16
|
+
|
|
17
|
+
field :customer_avatar, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('customerAvatar') } }
|
|
18
|
+
|
|
19
|
+
field :customer_email, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('customerEmail') } }
|
|
20
|
+
|
|
21
|
+
field :customer_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('customerId') } }
|
|
22
|
+
|
|
23
|
+
field :customer_name, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('customerName') } }
|
|
24
|
+
|
|
25
|
+
field :event_name, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('eventName') } }
|
|
26
|
+
|
|
27
|
+
field :metadata, T.nilable(T::Hash[Symbol, ::Object]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('metadata') } }
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
sig { params(click_id: ::String, customer_avatar: ::String, customer_email: ::String, customer_id: ::String, customer_name: ::String, event_name: ::String, metadata: T.nilable(T::Hash[Symbol, ::Object])).void }
|
|
31
|
+
def initialize(click_id: nil, customer_avatar: nil, customer_email: nil, customer_id: nil, customer_name: nil, event_name: nil, metadata: nil)
|
|
32
|
+
@click_id = click_id
|
|
33
|
+
@customer_avatar = customer_avatar
|
|
34
|
+
@customer_email = customer_email
|
|
35
|
+
@customer_id = customer_id
|
|
36
|
+
@customer_name = customer_name
|
|
37
|
+
@event_name = event_name
|
|
38
|
+
@metadata = metadata
|
|
39
|
+
end
|
|
40
|
+
end
|
|
41
|
+
end
|
|
42
|
+
end
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
# typed: true
|
|
4
|
+
# frozen_string_literal: true
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
module OpenApiSDK
|
|
8
|
+
module Operations
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class TrackSaleRequestBody < ::OpenApiSDK::Utils::FieldAugmented
|
|
12
|
+
extend T::Sig
|
|
13
|
+
|
|
14
|
+
# The amount of the sale. Should be passed in cents.
|
|
15
|
+
field :amount, ::Integer, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('amount') } }
|
|
16
|
+
# This is the unique identifier for the customer in the client's app. This is used to track the customer's journey.
|
|
17
|
+
field :customer_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('customerId') } }
|
|
18
|
+
# The payment processor via which the sale was made.
|
|
19
|
+
field :payment_processor, ::OpenApiSDK::Operations::PaymentProcessor, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('paymentProcessor'), 'decoder': Utils.enum_from_string(::OpenApiSDK::Operations::PaymentProcessor, false) } }
|
|
20
|
+
# The currency of the sale. Accepts ISO 4217 currency codes.
|
|
21
|
+
field :currency, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('currency') } }
|
|
22
|
+
# The invoice ID of the sale.
|
|
23
|
+
field :invoice_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('invoiceId') } }
|
|
24
|
+
# Additional metadata to be stored with the sale event.
|
|
25
|
+
field :metadata, T.nilable(T::Hash[Symbol, ::Object]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('metadata') } }
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
sig { params(amount: ::Integer, customer_id: ::String, payment_processor: ::OpenApiSDK::Operations::PaymentProcessor, currency: T.nilable(::String), invoice_id: T.nilable(::String), metadata: T.nilable(T::Hash[Symbol, ::Object])).void }
|
|
29
|
+
def initialize(amount: nil, customer_id: nil, payment_processor: nil, currency: nil, invoice_id: nil, metadata: nil)
|
|
30
|
+
@amount = amount
|
|
31
|
+
@customer_id = customer_id
|
|
32
|
+
@payment_processor = payment_processor
|
|
33
|
+
@currency = currency
|
|
34
|
+
@invoice_id = invoice_id
|
|
35
|
+
@metadata = metadata
|
|
36
|
+
end
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
end
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
# typed: true
|
|
4
|
+
# frozen_string_literal: true
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
module OpenApiSDK
|
|
8
|
+
module Operations
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class TrackSaleResponse < ::OpenApiSDK::Utils::FieldAugmented
|
|
12
|
+
extend T::Sig
|
|
13
|
+
|
|
14
|
+
# HTTP response content type for this operation
|
|
15
|
+
field :content_type, ::String
|
|
16
|
+
# Raw HTTP response; suitable for custom response parsing
|
|
17
|
+
field :raw_response, ::Faraday::Response
|
|
18
|
+
# HTTP response status code for this operation
|
|
19
|
+
field :status_code, ::Integer
|
|
20
|
+
# 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
|
+
field :bad_request, T.nilable(::OpenApiSDK::Shared::BadRequest)
|
|
22
|
+
# This response is sent when a request conflicts with the current state of the server.
|
|
23
|
+
field :conflict, T.nilable(::OpenApiSDK::Shared::Conflict)
|
|
24
|
+
# The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.
|
|
25
|
+
field :forbidden, T.nilable(::OpenApiSDK::Shared::Forbidden)
|
|
26
|
+
# The server has encountered a situation it does not know how to handle.
|
|
27
|
+
field :internal_server_error, T.nilable(::OpenApiSDK::Shared::InternalServerError)
|
|
28
|
+
# This response is sent when the requested content has been permanently deleted from server, with no forwarding address.
|
|
29
|
+
field :invite_expired, T.nilable(::OpenApiSDK::Shared::InviteExpired)
|
|
30
|
+
# The server cannot find the requested resource.
|
|
31
|
+
field :not_found, T.nilable(::OpenApiSDK::Shared::NotFound)
|
|
32
|
+
# A sale was tracked.
|
|
33
|
+
field :object, T.nilable(::OpenApiSDK::Operations::TrackSaleResponseBody)
|
|
34
|
+
# The user has sent too many requests in a given amount of time ("rate limiting")
|
|
35
|
+
field :rate_limit_exceeded, T.nilable(::OpenApiSDK::Shared::RateLimitExceeded)
|
|
36
|
+
# Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
|
|
37
|
+
field :unauthorized, T.nilable(::OpenApiSDK::Shared::Unauthorized)
|
|
38
|
+
# The request was well-formed but was unable to be followed due to semantic errors.
|
|
39
|
+
field :unprocessable_entity, T.nilable(::OpenApiSDK::Shared::UnprocessableEntity)
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, 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), object: T.nilable(::OpenApiSDK::Operations::TrackSaleResponseBody), 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, bad_request: nil, conflict: nil, forbidden: nil, internal_server_error: nil, invite_expired: nil, not_found: nil, object: nil, rate_limit_exceeded: nil, unauthorized: nil, unprocessable_entity: nil)
|
|
44
|
+
@content_type = content_type
|
|
45
|
+
@raw_response = raw_response
|
|
46
|
+
@status_code = status_code
|
|
47
|
+
@bad_request = bad_request
|
|
48
|
+
@conflict = conflict
|
|
49
|
+
@forbidden = forbidden
|
|
50
|
+
@internal_server_error = internal_server_error
|
|
51
|
+
@invite_expired = invite_expired
|
|
52
|
+
@not_found = not_found
|
|
53
|
+
@object = object
|
|
54
|
+
@rate_limit_exceeded = rate_limit_exceeded
|
|
55
|
+
@unauthorized = unauthorized
|
|
56
|
+
@unprocessable_entity = unprocessable_entity
|
|
57
|
+
end
|
|
58
|
+
end
|
|
59
|
+
end
|
|
60
|
+
end
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
# typed: true
|
|
4
|
+
# frozen_string_literal: true
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
module OpenApiSDK
|
|
8
|
+
module Operations
|
|
9
|
+
|
|
10
|
+
# A sale was tracked.
|
|
11
|
+
class TrackSaleResponseBody < ::OpenApiSDK::Utils::FieldAugmented
|
|
12
|
+
extend T::Sig
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
field :amount, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('amount') } }
|
|
16
|
+
|
|
17
|
+
field :currency, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('currency') } }
|
|
18
|
+
|
|
19
|
+
field :customer_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('customerId') } }
|
|
20
|
+
|
|
21
|
+
field :invoice_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('invoiceId') } }
|
|
22
|
+
|
|
23
|
+
field :metadata, T::Hash[Symbol, ::Object], { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('metadata') } }
|
|
24
|
+
|
|
25
|
+
field :payment_processor, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('paymentProcessor') } }
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
sig { params(amount: ::Float, currency: ::String, customer_id: ::String, invoice_id: ::String, metadata: T::Hash[Symbol, ::Object], payment_processor: ::String).void }
|
|
29
|
+
def initialize(amount: nil, currency: nil, customer_id: nil, invoice_id: nil, metadata: nil, payment_processor: nil)
|
|
30
|
+
@amount = amount
|
|
31
|
+
@currency = currency
|
|
32
|
+
@customer_id = customer_id
|
|
33
|
+
@invoice_id = invoice_id
|
|
34
|
+
@metadata = metadata
|
|
35
|
+
@payment_processor = payment_processor
|
|
36
|
+
end
|
|
37
|
+
end
|
|
38
|
+
end
|
|
39
|
+
end
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
# typed: true
|
|
4
|
+
# frozen_string_literal: true
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
module OpenApiSDK
|
|
8
|
+
module Operations
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class TransferDomainRequest < ::OpenApiSDK::Utils::FieldAugmented
|
|
12
|
+
extend T::Sig
|
|
13
|
+
|
|
14
|
+
# The domain name.
|
|
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
|
+
|
|
19
|
+
field :request_body, T.nilable(::OpenApiSDK::Operations::TransferDomainRequestBody), { '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
|
+
|
|
23
|
+
|
|
24
|
+
sig { params(slug: ::String, project_slug: T.nilable(::String), request_body: T.nilable(::OpenApiSDK::Operations::TransferDomainRequestBody), workspace_id: T.nilable(::String)).void }
|
|
25
|
+
def initialize(slug: nil, project_slug: nil, request_body: nil, workspace_id: nil)
|
|
26
|
+
@slug = slug
|
|
27
|
+
@project_slug = project_slug
|
|
28
|
+
@request_body = request_body
|
|
29
|
+
@workspace_id = workspace_id
|
|
30
|
+
end
|
|
31
|
+
end
|
|
32
|
+
end
|
|
33
|
+
end
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
# typed: true
|
|
4
|
+
# frozen_string_literal: true
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
module OpenApiSDK
|
|
8
|
+
module Operations
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class TransferDomainRequestBody < ::OpenApiSDK::Utils::FieldAugmented
|
|
12
|
+
extend T::Sig
|
|
13
|
+
|
|
14
|
+
# The ID of the new workspace to transfer the domain to.
|
|
15
|
+
field :new_workspace_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('newWorkspaceId') } }
|
|
16
|
+
|
|
17
|
+
|
|
18
|
+
sig { params(new_workspace_id: ::String).void }
|
|
19
|
+
def initialize(new_workspace_id: nil)
|
|
20
|
+
@new_workspace_id = new_workspace_id
|
|
21
|
+
end
|
|
22
|
+
end
|
|
23
|
+
end
|
|
24
|
+
end
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
# typed: true
|
|
4
|
+
# frozen_string_literal: true
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
module OpenApiSDK
|
|
8
|
+
module Operations
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class TransferDomainResponse < ::OpenApiSDK::Utils::FieldAugmented
|
|
12
|
+
extend T::Sig
|
|
13
|
+
|
|
14
|
+
# HTTP response content type for this operation
|
|
15
|
+
field :content_type, ::String
|
|
16
|
+
# Raw HTTP response; suitable for custom response parsing
|
|
17
|
+
field :raw_response, ::Faraday::Response
|
|
18
|
+
# HTTP response status code for this operation
|
|
19
|
+
field :status_code, ::Integer
|
|
20
|
+
# 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
|
+
field :bad_request, T.nilable(::OpenApiSDK::Shared::BadRequest)
|
|
22
|
+
# This response is sent when a request conflicts with the current state of the server.
|
|
23
|
+
field :conflict, T.nilable(::OpenApiSDK::Shared::Conflict)
|
|
24
|
+
# The domain transfer initiated
|
|
25
|
+
field :domain_schema, T.nilable(::OpenApiSDK::Shared::DomainSchema)
|
|
26
|
+
# The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.
|
|
27
|
+
field :forbidden, T.nilable(::OpenApiSDK::Shared::Forbidden)
|
|
28
|
+
# The server has encountered a situation it does not know how to handle.
|
|
29
|
+
field :internal_server_error, T.nilable(::OpenApiSDK::Shared::InternalServerError)
|
|
30
|
+
# This response is sent when the requested content has been permanently deleted from server, with no forwarding address.
|
|
31
|
+
field :invite_expired, T.nilable(::OpenApiSDK::Shared::InviteExpired)
|
|
32
|
+
# The server cannot find the requested resource.
|
|
33
|
+
field :not_found, T.nilable(::OpenApiSDK::Shared::NotFound)
|
|
34
|
+
# The user has sent too many requests in a given amount of time ("rate limiting")
|
|
35
|
+
field :rate_limit_exceeded, T.nilable(::OpenApiSDK::Shared::RateLimitExceeded)
|
|
36
|
+
# Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
|
|
37
|
+
field :unauthorized, T.nilable(::OpenApiSDK::Shared::Unauthorized)
|
|
38
|
+
# The request was well-formed but was unable to be followed due to semantic errors.
|
|
39
|
+
field :unprocessable_entity, T.nilable(::OpenApiSDK::Shared::UnprocessableEntity)
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, bad_request: T.nilable(::OpenApiSDK::Shared::BadRequest), conflict: T.nilable(::OpenApiSDK::Shared::Conflict), domain_schema: T.nilable(::OpenApiSDK::Shared::DomainSchema), 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, bad_request: nil, conflict: nil, domain_schema: nil, forbidden: nil, internal_server_error: nil, invite_expired: nil, not_found: nil, rate_limit_exceeded: nil, unauthorized: nil, unprocessable_entity: nil)
|
|
44
|
+
@content_type = content_type
|
|
45
|
+
@raw_response = raw_response
|
|
46
|
+
@status_code = status_code
|
|
47
|
+
@bad_request = bad_request
|
|
48
|
+
@conflict = conflict
|
|
49
|
+
@domain_schema = domain_schema
|
|
50
|
+
@forbidden = forbidden
|
|
51
|
+
@internal_server_error = internal_server_error
|
|
52
|
+
@invite_expired = invite_expired
|
|
53
|
+
@not_found = not_found
|
|
54
|
+
@rate_limit_exceeded = rate_limit_exceeded
|
|
55
|
+
@unauthorized = unauthorized
|
|
56
|
+
@unprocessable_entity = unprocessable_entity
|
|
57
|
+
end
|
|
58
|
+
end
|
|
59
|
+
end
|
|
60
|
+
end
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
# typed: true
|
|
4
|
+
# frozen_string_literal: true
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
module OpenApiSDK
|
|
8
|
+
module Operations
|
|
9
|
+
|
|
10
|
+
# Type - The type of redirect to use for this domain.
|
|
11
|
+
class Type < T::Enum
|
|
12
|
+
enums do
|
|
13
|
+
REDIRECT = new('redirect')
|
|
14
|
+
REWRITE = new('rewrite')
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
|
|
18
|
+
end
|
|
19
|
+
end
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
# typed: true
|
|
4
|
+
# frozen_string_literal: true
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
module OpenApiSDK
|
|
8
|
+
module Operations
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class UpdateDomainRequest < ::OpenApiSDK::Utils::FieldAugmented
|
|
12
|
+
extend T::Sig
|
|
13
|
+
|
|
14
|
+
# The domain name.
|
|
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
|
+
|
|
19
|
+
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
|
+
|
|
23
|
+
|
|
24
|
+
sig { params(slug: ::String, project_slug: T.nilable(::String), request_body: T.nilable(::OpenApiSDK::Operations::UpdateDomainRequestBody), workspace_id: T.nilable(::String)).void }
|
|
25
|
+
def initialize(slug: nil, project_slug: nil, request_body: nil, workspace_id: nil)
|
|
26
|
+
@slug = slug
|
|
27
|
+
@project_slug = project_slug
|
|
28
|
+
@request_body = request_body
|
|
29
|
+
@workspace_id = workspace_id
|
|
30
|
+
end
|
|
31
|
+
end
|
|
32
|
+
end
|
|
33
|
+
end
|
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
# typed: true
|
|
4
|
+
# frozen_string_literal: true
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
module OpenApiSDK
|
|
8
|
+
module Operations
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class UpdateDomainRequestBody < ::OpenApiSDK::Utils::FieldAugmented
|
|
12
|
+
extend T::Sig
|
|
13
|
+
|
|
14
|
+
# Whether to archive this domain. `false` will unarchive a previously archived domain.
|
|
15
|
+
field :archived, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('archived') } }
|
|
16
|
+
# Redirect users to a specific URL when any link under this domain has expired.
|
|
17
|
+
field :expired_url, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiredUrl') } }
|
|
18
|
+
# Prevent search engines from indexing the domain. Defaults to `false`.
|
|
19
|
+
field :noindex, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('noindex') } }
|
|
20
|
+
# Provide context to your teammates in the link creation modal by showing them an example of a link to be shortened.
|
|
21
|
+
field :placeholder, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('placeholder') } }
|
|
22
|
+
# Name of the domain.
|
|
23
|
+
field :slug, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('slug') } }
|
|
24
|
+
# The page your users will get redirected to when they visit your domain.
|
|
25
|
+
field :target, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('target') } }
|
|
26
|
+
# The type of redirect to use for this domain.
|
|
27
|
+
field :type, T.nilable(::OpenApiSDK::Operations::UpdateDomainType), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('type'), 'decoder': Utils.enum_from_string(::OpenApiSDK::Operations::UpdateDomainType, true) } }
|
|
28
|
+
|
|
29
|
+
|
|
30
|
+
sig { params(archived: T.nilable(T::Boolean), expired_url: T.nilable(::String), noindex: T.nilable(T::Boolean), placeholder: T.nilable(::String), slug: T.nilable(::String), target: T.nilable(::String), type: T.nilable(::OpenApiSDK::Operations::UpdateDomainType)).void }
|
|
31
|
+
def initialize(archived: nil, expired_url: nil, noindex: nil, placeholder: nil, slug: nil, target: nil, type: nil)
|
|
32
|
+
@archived = archived
|
|
33
|
+
@expired_url = expired_url
|
|
34
|
+
@noindex = noindex
|
|
35
|
+
@placeholder = placeholder
|
|
36
|
+
@slug = slug
|
|
37
|
+
@target = target
|
|
38
|
+
@type = type
|
|
39
|
+
end
|
|
40
|
+
end
|
|
41
|
+
end
|
|
42
|
+
end
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
# typed: true
|
|
4
|
+
# frozen_string_literal: true
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
module OpenApiSDK
|
|
8
|
+
module Operations
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class UpdateDomainResponse < ::OpenApiSDK::Utils::FieldAugmented
|
|
12
|
+
extend T::Sig
|
|
13
|
+
|
|
14
|
+
# HTTP response content type for this operation
|
|
15
|
+
field :content_type, ::String
|
|
16
|
+
# Raw HTTP response; suitable for custom response parsing
|
|
17
|
+
field :raw_response, ::Faraday::Response
|
|
18
|
+
# HTTP response status code for this operation
|
|
19
|
+
field :status_code, ::Integer
|
|
20
|
+
# 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
|
+
field :bad_request, T.nilable(::OpenApiSDK::Shared::BadRequest)
|
|
22
|
+
# This response is sent when a request conflicts with the current state of the server.
|
|
23
|
+
field :conflict, T.nilable(::OpenApiSDK::Shared::Conflict)
|
|
24
|
+
# The domain was updated.
|
|
25
|
+
field :domain_schema, T.nilable(::OpenApiSDK::Shared::DomainSchema)
|
|
26
|
+
# The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.
|
|
27
|
+
field :forbidden, T.nilable(::OpenApiSDK::Shared::Forbidden)
|
|
28
|
+
# The server has encountered a situation it does not know how to handle.
|
|
29
|
+
field :internal_server_error, T.nilable(::OpenApiSDK::Shared::InternalServerError)
|
|
30
|
+
# This response is sent when the requested content has been permanently deleted from server, with no forwarding address.
|
|
31
|
+
field :invite_expired, T.nilable(::OpenApiSDK::Shared::InviteExpired)
|
|
32
|
+
# The server cannot find the requested resource.
|
|
33
|
+
field :not_found, T.nilable(::OpenApiSDK::Shared::NotFound)
|
|
34
|
+
# The user has sent too many requests in a given amount of time ("rate limiting")
|
|
35
|
+
field :rate_limit_exceeded, T.nilable(::OpenApiSDK::Shared::RateLimitExceeded)
|
|
36
|
+
# Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
|
|
37
|
+
field :unauthorized, T.nilable(::OpenApiSDK::Shared::Unauthorized)
|
|
38
|
+
# The request was well-formed but was unable to be followed due to semantic errors.
|
|
39
|
+
field :unprocessable_entity, T.nilable(::OpenApiSDK::Shared::UnprocessableEntity)
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, bad_request: T.nilable(::OpenApiSDK::Shared::BadRequest), conflict: T.nilable(::OpenApiSDK::Shared::Conflict), domain_schema: T.nilable(::OpenApiSDK::Shared::DomainSchema), 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, bad_request: nil, conflict: nil, domain_schema: nil, forbidden: nil, internal_server_error: nil, invite_expired: nil, not_found: nil, rate_limit_exceeded: nil, unauthorized: nil, unprocessable_entity: nil)
|
|
44
|
+
@content_type = content_type
|
|
45
|
+
@raw_response = raw_response
|
|
46
|
+
@status_code = status_code
|
|
47
|
+
@bad_request = bad_request
|
|
48
|
+
@conflict = conflict
|
|
49
|
+
@domain_schema = domain_schema
|
|
50
|
+
@forbidden = forbidden
|
|
51
|
+
@internal_server_error = internal_server_error
|
|
52
|
+
@invite_expired = invite_expired
|
|
53
|
+
@not_found = not_found
|
|
54
|
+
@rate_limit_exceeded = rate_limit_exceeded
|
|
55
|
+
@unauthorized = unauthorized
|
|
56
|
+
@unprocessable_entity = unprocessable_entity
|
|
57
|
+
end
|
|
58
|
+
end
|
|
59
|
+
end
|
|
60
|
+
end
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
# typed: true
|
|
4
|
+
# frozen_string_literal: true
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
module OpenApiSDK
|
|
8
|
+
module Operations
|
|
9
|
+
|
|
10
|
+
# UpdateDomainType - The type of redirect to use for this domain.
|
|
11
|
+
class UpdateDomainType < T::Enum
|
|
12
|
+
enums do
|
|
13
|
+
REDIRECT = new('redirect')
|
|
14
|
+
REWRITE = new('rewrite')
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
|
|
18
|
+
end
|
|
19
|
+
end
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
# typed: true
|
|
4
|
+
# frozen_string_literal: true
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
module OpenApiSDK
|
|
8
|
+
module Operations
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class UpdateLinkRequest < ::OpenApiSDK::Utils::FieldAugmented
|
|
12
|
+
extend T::Sig
|
|
13
|
+
|
|
14
|
+
# The id of the link to update. You may use either `linkId` (obtained via `/links/info` endpoint) or `externalId` prefixed with `ext_`.
|
|
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
|
+
|
|
19
|
+
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
|
+
|
|
23
|
+
|
|
24
|
+
sig { params(link_id: ::String, project_slug: T.nilable(::String), request_body: T.nilable(::OpenApiSDK::Operations::UpdateLinkRequestBody), workspace_id: T.nilable(::String)).void }
|
|
25
|
+
def initialize(link_id: nil, project_slug: nil, request_body: nil, workspace_id: nil)
|
|
26
|
+
@link_id = link_id
|
|
27
|
+
@project_slug = project_slug
|
|
28
|
+
@request_body = request_body
|
|
29
|
+
@workspace_id = workspace_id
|
|
30
|
+
end
|
|
31
|
+
end
|
|
32
|
+
end
|
|
33
|
+
end
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
# Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
|
|
2
|
+
|
|
3
|
+
# typed: true
|
|
4
|
+
# frozen_string_literal: true
|
|
5
|
+
|
|
6
|
+
|
|
7
|
+
module OpenApiSDK
|
|
8
|
+
module Operations
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class UpdateLinkRequestBody < ::OpenApiSDK::Utils::FieldAugmented
|
|
12
|
+
extend T::Sig
|
|
13
|
+
|
|
14
|
+
# The destination URL of the short link.
|
|
15
|
+
field :url, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('url') } }
|
|
16
|
+
# The Android destination URL for the short link for Android device targeting.
|
|
17
|
+
field :android, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('android') } }
|
|
18
|
+
# Whether the short link is archived.
|
|
19
|
+
field :archived, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('archived') } }
|
|
20
|
+
# The comments for the short link.
|
|
21
|
+
field :comments, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('comments') } }
|
|
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
|
+
field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description') } }
|
|
24
|
+
# The domain of the short link. If not provided, the primary domain for the workspace will be used (or `dub.sh` if the workspace has no domains).
|
|
25
|
+
field :domain, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('domain') } }
|
|
26
|
+
# The URL to redirect to when the short link has expired.
|
|
27
|
+
field :expired_url, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiredUrl') } }
|
|
28
|
+
# The date and time when the short link will expire at.
|
|
29
|
+
field :expires_at, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiresAt') } }
|
|
30
|
+
# This is the ID of the link in your database. If set, it can be used to identify the link in the future. Must be prefixed with `ext_` when passed as a query parameter.
|
|
31
|
+
field :external_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
|
|
32
|
+
# Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`.
|
|
33
|
+
field :geo, T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('geo') } }
|
|
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.
|
|
35
|
+
field :image, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
|
|
36
|
+
# The iOS destination URL for the short link for iOS device targeting.
|
|
37
|
+
field :ios, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ios') } }
|
|
38
|
+
# The short link slug. If not provided, a random 7-character slug will be generated.
|
|
39
|
+
field :key, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('key') } }
|
|
40
|
+
# The password required to access the destination URL of the short link.
|
|
41
|
+
field :password, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('password') } }
|
|
42
|
+
# 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.
|
|
43
|
+
field :prefix, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('prefix') } }
|
|
44
|
+
# Whether the short link uses Custom Social Media Cards feature.
|
|
45
|
+
field :proxy, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('proxy') } }
|
|
46
|
+
# Whether the short link's stats are publicly accessible.
|
|
47
|
+
field :public_stats, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('publicStats') } }
|
|
48
|
+
# Whether the short link uses link cloaking.
|
|
49
|
+
field :rewrite, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('rewrite') } }
|
|
50
|
+
# The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead.
|
|
51
|
+
#
|
|
52
|
+
# @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
|
|
53
|
+
field :tag_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagId') } }
|
|
54
|
+
# The unique IDs of the tags assigned to the short link.
|
|
55
|
+
field :tag_ids, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagIds') } }
|
|
56
|
+
# The unique name of the tags assigned to the short link (case insensitive).
|
|
57
|
+
field :tag_names, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagNames') } }
|
|
58
|
+
# The title of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
|
|
59
|
+
field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
|
|
60
|
+
# Whether to track conversions for the short link.
|
|
61
|
+
field :track_conversion, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trackConversion') } }
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
sig { params(url: ::String, android: T.nilable(::String), archived: T.nilable(T::Boolean), comments: T.nilable(::String), description: T.nilable(::String), 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 }
|
|
65
|
+
def initialize(url: nil, android: nil, archived: nil, comments: nil, description: 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)
|
|
66
|
+
@url = url
|
|
67
|
+
@android = android
|
|
68
|
+
@archived = archived
|
|
69
|
+
@comments = comments
|
|
70
|
+
@description = description
|
|
71
|
+
@domain = domain
|
|
72
|
+
@expired_url = expired_url
|
|
73
|
+
@expires_at = expires_at
|
|
74
|
+
@external_id = external_id
|
|
75
|
+
@geo = geo
|
|
76
|
+
@image = image
|
|
77
|
+
@ios = ios
|
|
78
|
+
@key = key
|
|
79
|
+
@password = password
|
|
80
|
+
@prefix = prefix
|
|
81
|
+
@proxy = proxy
|
|
82
|
+
@public_stats = public_stats
|
|
83
|
+
@rewrite = rewrite
|
|
84
|
+
@tag_id = tag_id
|
|
85
|
+
@tag_ids = tag_ids
|
|
86
|
+
@tag_names = tag_names
|
|
87
|
+
@title = title
|
|
88
|
+
@track_conversion = track_conversion
|
|
89
|
+
end
|
|
90
|
+
end
|
|
91
|
+
end
|
|
92
|
+
end
|