dub 0.2.2.pre.alpha.50 → 0.2.2.pre.alpha.52

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.
Files changed (23) hide show
  1. checksums.yaml +4 -4
  2. data/lib/open_api_sdk/links.rb +2 -2
  3. data/lib/open_api_sdk/models/operations/bulkcreatelinks_response.rb +5 -5
  4. data/lib/open_api_sdk/models/operations/createlink_requestbody.rb +11 -8
  5. data/lib/open_api_sdk/models/operations/data.rb +10 -7
  6. data/lib/open_api_sdk/models/operations/getlinks_request.rb +12 -3
  7. data/lib/open_api_sdk/models/operations/getlinkscount_request.rb +5 -2
  8. data/lib/open_api_sdk/models/operations/listevents_request.rb +8 -5
  9. data/lib/open_api_sdk/models/operations/order.rb +3 -1
  10. data/lib/open_api_sdk/models/operations/queryparam_sortby.rb +17 -0
  11. data/lib/open_api_sdk/models/operations/queryparam_sortorder.rb +18 -0
  12. data/lib/open_api_sdk/models/operations/requestbody.rb +11 -8
  13. data/lib/open_api_sdk/models/operations/sort.rb +4 -1
  14. data/lib/open_api_sdk/models/operations/sortby.rb +5 -2
  15. data/lib/open_api_sdk/models/operations/sortorder.rb +18 -0
  16. data/lib/open_api_sdk/models/operations/updatelink_requestbody.rb +11 -8
  17. data/lib/open_api_sdk/models/operations/upsertlink_requestbody.rb +11 -8
  18. data/lib/open_api_sdk/models/operations.rb +4 -1
  19. data/lib/open_api_sdk/models/shared/link.rb +9 -6
  20. data/lib/open_api_sdk/models/shared/linkschema.rb +10 -7
  21. data/lib/open_api_sdk/models/shared/workspaceschema.rb +1 -1
  22. data/lib/open_api_sdk/sdkconfiguration.rb +3 -3
  23. metadata +5 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a05d62462c95ef7b27a8ca29fc929d3703ad2ea49dd592dbe3445b5409d279ce
4
- data.tar.gz: 7ae59ae39e5bd3e838b5737ac1dbf6e0a96fbc22e7264752b9b960c3378deec4
3
+ metadata.gz: d48dd5dc7f84c1d324536496452cafb0037587583f033c17433deb10c7bc0cfc
4
+ data.tar.gz: d88c4e4d9984d2d17ad94ed50c769bf15f9403680b2caeff6abb2b701aab93d6
5
5
  SHA512:
6
- metadata.gz: 37e01327e02f3db9d90bb3e88b47c38f4d2ef8b3f945161da77a396f501965d2d0ddf58ddf2d64838f951b478f9f48397f1fd6833db5ee6cb8558d88abf1e6b7
7
- data.tar.gz: a8c44fdaeba6bb932ef8ea867773ec73020c8fc9dff36c7e6e83fb30d403b7e2957eaf3f89a00778d4542e8c750172bf2ca216af0fe1ee59c3f30aba0351ebc2
6
+ metadata.gz: 6f91ae5ac32d0c4a1357d466eff1142ccaca676a56b3f94b0897b6b44517c901f7416d57495f6e67f92845e655c041e93cd9b964309e5b464d17e5f24f45b59b
7
+ data.tar.gz: e10dba2d37f97ed4113b7de887032bb9b4f317c1bda842909a833b4f4081fd3173a52637449c37391245e55554683b87a772bd347480481c69dff9d2d048c164
data/lib/open_api_sdk/links.rb CHANGED
@@ -547,8 +547,8 @@ module OpenApiSDK
547
547
  )
548
548
  if r.status == 200
549
549
  if Utils.match_content_type(content_type, 'application/json')
550
- out = Utils.unmarshal_complex(r.env.response_body, T::Array[::OpenApiSDK::Shared::LinkSchema])
551
- res.link_schemas = out
550
+ out = Utils.unmarshal_complex(r.env.response_body, T::Array[::Object])
551
+ res.anies = out
552
552
  end
553
553
  elsif r.status == 400
554
554
  if Utils.match_content_type(content_type, 'application/json')
data/lib/open_api_sdk/models/operations/bulkcreatelinks_response.rb CHANGED
@@ -17,6 +17,8 @@ module OpenApiSDK
17
17
  field :raw_response, ::Faraday::Response
18
18
  # HTTP response status code for this operation
19
19
  field :status_code, ::Integer
20
+ # The created links
21
+ field :anies, T.nilable(T::Array[::Object])
20
22
  # The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
21
23
  field :bad_request, T.nilable(::OpenApiSDK::Shared::BadRequest)
22
24
  # This response is sent when a request conflicts with the current state of the server.
@@ -27,8 +29,6 @@ module OpenApiSDK
27
29
  field :internal_server_error, T.nilable(::OpenApiSDK::Shared::InternalServerError)
28
30
  # This response is sent when the requested content has been permanently deleted from server, with no forwarding address.
29
31
  field :invite_expired, T.nilable(::OpenApiSDK::Shared::InviteExpired)
30
- # The created links
31
- field :link_schemas, T.nilable(T::Array[::OpenApiSDK::Shared::LinkSchema])
32
32
  # The server cannot find the requested resource.
33
33
  field :not_found, T.nilable(::OpenApiSDK::Shared::NotFound)
34
34
  # The user has sent too many requests in a given amount of time ("rate limiting")
@@ -39,17 +39,17 @@ module OpenApiSDK
39
39
  field :unprocessable_entity, T.nilable(::OpenApiSDK::Shared::UnprocessableEntity)
40
40
 
41
41
 
42
- sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, 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), link_schemas: T.nilable(T::Array[::OpenApiSDK::Shared::LinkSchema]), 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, forbidden: nil, internal_server_error: nil, invite_expired: nil, link_schemas: nil, not_found: nil, rate_limit_exceeded: nil, unauthorized: nil, unprocessable_entity: nil)
42
+ sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, anies: T.nilable(T::Array[::Object]), bad_request: T.nilable(::OpenApiSDK::Shared::BadRequest), conflict: T.nilable(::OpenApiSDK::Shared::Conflict), forbidden: T.nilable(::OpenApiSDK::Shared::Forbidden), internal_server_error: T.nilable(::OpenApiSDK::Shared::InternalServerError), invite_expired: T.nilable(::OpenApiSDK::Shared::InviteExpired), not_found: T.nilable(::OpenApiSDK::Shared::NotFound), rate_limit_exceeded: T.nilable(::OpenApiSDK::Shared::RateLimitExceeded), unauthorized: T.nilable(::OpenApiSDK::Shared::Unauthorized), unprocessable_entity: T.nilable(::OpenApiSDK::Shared::UnprocessableEntity)).void }
43
+ def initialize(content_type: nil, raw_response: nil, status_code: nil, anies: nil, bad_request: nil, conflict: nil, forbidden: nil, internal_server_error: nil, invite_expired: nil, not_found: nil, rate_limit_exceeded: nil, unauthorized: nil, unprocessable_entity: nil)
44
44
  @content_type = content_type
45
45
  @raw_response = raw_response
46
46
  @status_code = status_code
47
+ @anies = anies
47
48
  @bad_request = bad_request
48
49
  @conflict = conflict
49
50
  @forbidden = forbidden
50
51
  @internal_server_error = internal_server_error
51
52
  @invite_expired = invite_expired
52
- @link_schemas = link_schemas
53
53
  @not_found = not_found
54
54
  @rate_limit_exceeded = rate_limit_exceeded
55
55
  @unauthorized = unauthorized
data/lib/open_api_sdk/models/operations/createlink_requestbody.rb CHANGED
@@ -15,7 +15,7 @@ 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. Defaults to `false` if not provided.
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') } }
@@ -29,7 +29,7 @@ module OpenApiSDK
29
29
  field :expired_url, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiredUrl') } }
30
30
  # The date and time when the short link will expire at.
31
31
  field :expires_at, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiresAt') } }
32
- # 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.
32
+ # The ID of the link in your database. If set, it can be used to identify the link in future API requests (must be prefixed with 'ext_' when passed as a query parameter). This key is unique across your workspace.
33
33
  field :external_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
34
34
  # Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`.
35
35
  field :geo, T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('geo') } }
@@ -45,15 +45,15 @@ module OpenApiSDK
45
45
  field :prefix, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('prefix') } }
46
46
  # The ID of the program the short link is associated with.
47
47
  field :program_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
48
- # Whether the short link uses Custom Social Media Cards feature.
48
+ # Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided.
49
49
  field :proxy, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('proxy') } }
50
- # Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible.
50
+ # Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
51
51
  #
52
52
  # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
53
53
  field :public_stats, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('publicStats') } }
54
54
  # The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL.
55
55
  field :ref, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ref') } }
56
- # Whether the short link uses link cloaking.
56
+ # Whether the short link uses link cloaking. Defaults to `false` if not provided.
57
57
  field :rewrite, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('rewrite') } }
58
58
  # The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead.
59
59
  #
@@ -63,9 +63,11 @@ module OpenApiSDK
63
63
  field :tag_ids, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagIds') } }
64
64
  # The unique name of the tags assigned to the short link (case insensitive).
65
65
  field :tag_names, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagNames') } }
66
+ # The ID of the tenant that created the link inside your system. If set, it can be used to fetch all links for a tenant.
67
+ field :tenant_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } }
66
68
  # The custom link preview title (og:title). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
67
69
  field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
68
- # Whether to track conversions for the short link.
70
+ # Whether to track conversions for the short link. Defaults to `false` if not provided.
69
71
  field :track_conversion, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trackConversion') } }
70
72
  # The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL.
71
73
  field :utm_campaign, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_campaign') } }
@@ -83,8 +85,8 @@ module OpenApiSDK
83
85
  field :webhook_ids, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('webhookIds') } }
84
86
 
85
87
 
86
- sig { params(url: ::String, android: T.nilable(::String), archived: T.nilable(T::Boolean), comments: T.nilable(::String), description: T.nilable(::String), do_index: T.nilable(T::Boolean), domain: T.nilable(::String), expired_url: T.nilable(::String), expires_at: T.nilable(::String), external_id: T.nilable(::String), geo: T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), image: T.nilable(::String), ios: T.nilable(::String), key: T.nilable(::String), password: T.nilable(::String), prefix: T.nilable(::String), program_id: T.nilable(::String), proxy: T.nilable(T::Boolean), public_stats: T.nilable(T::Boolean), ref: T.nilable(::String), rewrite: T.nilable(T::Boolean), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), title: T.nilable(::String), track_conversion: T.nilable(T::Boolean), utm_campaign: T.nilable(::String), utm_content: T.nilable(::String), utm_medium: T.nilable(::String), utm_source: T.nilable(::String), utm_term: T.nilable(::String), video: T.nilable(::String), webhook_ids: T.nilable(T::Array[::String])).void }
87
- def initialize(url: nil, android: nil, archived: nil, comments: nil, description: nil, do_index: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, image: nil, ios: nil, key: nil, password: nil, prefix: nil, program_id: nil, proxy: nil, public_stats: nil, ref: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, title: nil, track_conversion: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil, webhook_ids: nil)
88
+ sig { params(url: ::String, android: T.nilable(::String), archived: T.nilable(T::Boolean), comments: T.nilable(::String), description: T.nilable(::String), do_index: T.nilable(T::Boolean), domain: T.nilable(::String), expired_url: T.nilable(::String), expires_at: T.nilable(::String), external_id: T.nilable(::String), geo: T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), image: T.nilable(::String), ios: T.nilable(::String), key: T.nilable(::String), password: T.nilable(::String), prefix: T.nilable(::String), program_id: T.nilable(::String), proxy: T.nilable(T::Boolean), public_stats: T.nilable(T::Boolean), ref: T.nilable(::String), rewrite: T.nilable(T::Boolean), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), tenant_id: T.nilable(::String), title: T.nilable(::String), track_conversion: T.nilable(T::Boolean), utm_campaign: T.nilable(::String), utm_content: T.nilable(::String), utm_medium: T.nilable(::String), utm_source: T.nilable(::String), utm_term: T.nilable(::String), video: T.nilable(::String), webhook_ids: T.nilable(T::Array[::String])).void }
89
+ def initialize(url: nil, android: nil, archived: nil, comments: nil, description: nil, do_index: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, image: nil, ios: nil, key: nil, password: nil, prefix: nil, program_id: nil, proxy: nil, public_stats: nil, ref: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, tenant_id: nil, title: nil, track_conversion: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil, webhook_ids: nil)
88
90
  @url = url
89
91
  @android = android
90
92
  @archived = archived
@@ -109,6 +111,7 @@ module OpenApiSDK
109
111
  @tag_id = tag_id
110
112
  @tag_ids = tag_ids
111
113
  @tag_names = tag_names
114
+ @tenant_id = tenant_id
112
115
  @title = title
113
116
  @track_conversion = track_conversion
114
117
  @utm_campaign = utm_campaign
data/lib/open_api_sdk/models/operations/data.rb CHANGED
@@ -13,7 +13,7 @@ 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. Defaults to `false` if not provided.
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') } }
@@ -35,15 +35,15 @@ module OpenApiSDK
35
35
  field :password, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('password') } }
36
36
  # The ID of the program the short link is associated with.
37
37
  field :program_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
38
- # Whether the short link uses Custom Social Media Cards feature.
38
+ # Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided.
39
39
  field :proxy, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('proxy') } }
40
- # Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible.
40
+ # Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
41
41
  #
42
42
  # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
43
43
  field :public_stats, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('publicStats') } }
44
44
  # The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL.
45
45
  field :ref, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ref') } }
46
- # Whether the short link uses link cloaking.
46
+ # Whether the short link uses link cloaking. Defaults to `false` if not provided.
47
47
  field :rewrite, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('rewrite') } }
48
48
  # The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead.
49
49
  #
@@ -53,9 +53,11 @@ module OpenApiSDK
53
53
  field :tag_ids, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagIds') } }
54
54
  # The unique name of the tags assigned to the short link (case insensitive).
55
55
  field :tag_names, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagNames') } }
56
+ # The ID of the tenant that created the link inside your system. If set, it can be used to fetch all links for a tenant.
57
+ field :tenant_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } }
56
58
  # The custom link preview title (og:title). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
57
59
  field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
58
- # Whether to track conversions for the short link.
60
+ # Whether to track conversions for the short link. Defaults to `false` if not provided.
59
61
  field :track_conversion, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trackConversion') } }
60
62
  # The destination URL of the short link.
61
63
  field :url, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('url') } }
@@ -75,8 +77,8 @@ module OpenApiSDK
75
77
  field :webhook_ids, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('webhookIds') } }
76
78
 
77
79
 
78
- sig { params(android: T.nilable(::String), archived: T.nilable(T::Boolean), comments: T.nilable(::String), description: T.nilable(::String), do_index: T.nilable(T::Boolean), expired_url: T.nilable(::String), expires_at: T.nilable(::String), geo: T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), image: T.nilable(::String), ios: T.nilable(::String), password: T.nilable(::String), program_id: T.nilable(::String), proxy: T.nilable(T::Boolean), public_stats: T.nilable(T::Boolean), ref: T.nilable(::String), rewrite: T.nilable(T::Boolean), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), title: T.nilable(::String), track_conversion: T.nilable(T::Boolean), url: T.nilable(::String), utm_campaign: T.nilable(::String), utm_content: T.nilable(::String), utm_medium: T.nilable(::String), utm_source: T.nilable(::String), utm_term: T.nilable(::String), video: T.nilable(::String), webhook_ids: T.nilable(T::Array[::String])).void }
79
- def initialize(android: nil, archived: nil, comments: nil, description: nil, do_index: nil, expired_url: nil, expires_at: nil, geo: nil, image: nil, ios: nil, password: nil, program_id: nil, proxy: nil, public_stats: nil, ref: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, title: nil, track_conversion: nil, url: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil, webhook_ids: nil)
80
+ sig { params(android: T.nilable(::String), archived: T.nilable(T::Boolean), comments: T.nilable(::String), description: T.nilable(::String), do_index: T.nilable(T::Boolean), expired_url: T.nilable(::String), expires_at: T.nilable(::String), geo: T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), image: T.nilable(::String), ios: T.nilable(::String), password: T.nilable(::String), program_id: T.nilable(::String), proxy: T.nilable(T::Boolean), public_stats: T.nilable(T::Boolean), ref: T.nilable(::String), rewrite: T.nilable(T::Boolean), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), tenant_id: T.nilable(::String), title: T.nilable(::String), track_conversion: T.nilable(T::Boolean), url: T.nilable(::String), utm_campaign: T.nilable(::String), utm_content: T.nilable(::String), utm_medium: T.nilable(::String), utm_source: T.nilable(::String), utm_term: T.nilable(::String), video: T.nilable(::String), webhook_ids: T.nilable(T::Array[::String])).void }
81
+ def initialize(android: nil, archived: nil, comments: nil, description: nil, do_index: nil, expired_url: nil, expires_at: nil, geo: nil, image: nil, ios: nil, password: nil, program_id: nil, proxy: nil, public_stats: nil, ref: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, tenant_id: nil, title: nil, track_conversion: nil, url: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil, webhook_ids: nil)
80
82
  @android = android
81
83
  @archived = archived
82
84
  @comments = comments
@@ -96,6 +98,7 @@ module OpenApiSDK
96
98
  @tag_id = tag_id
97
99
  @tag_ids = tag_ids
98
100
  @tag_names = tag_names
101
+ @tenant_id = tenant_id
99
102
  @title = title
100
103
  @track_conversion = track_conversion
101
104
  @url = url
data/lib/open_api_sdk/models/operations/getlinks_request.rb CHANGED
@@ -21,31 +21,40 @@ module OpenApiSDK
21
21
  field :search, T.nilable(::String), { 'query_param': { 'field_name': 'search', 'style': 'form', 'explode': true } }
22
22
  # Whether to include archived links in the response. Defaults to `false` if not provided.
23
23
  field :show_archived, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'showArchived', 'style': 'form', 'explode': true } }
24
- # The field to sort the links by. The default is `createdAt`, and sort order is always descending.
24
+ # DEPRECATED. Use `sortBy` instead.
25
25
  field :sort, T.nilable(::OpenApiSDK::Operations::Sort), { 'query_param': { 'field_name': 'sort', 'style': 'form', 'explode': true } }
26
+ # The field to sort the links by. The default is `createdAt`.
27
+ field :sort_by, T.nilable(::OpenApiSDK::Operations::SortBy), { 'query_param': { 'field_name': 'sortBy', 'style': 'form', 'explode': true } }
28
+ # The sort order. The default is `desc`.
29
+ field :sort_order, T.nilable(::OpenApiSDK::Operations::SortOrder), { 'query_param': { 'field_name': 'sortOrder', 'style': 'form', 'explode': true } }
26
30
  # Deprecated. Use `tagIds` instead. The tag ID to filter the links by.
27
31
  field :tag_id, T.nilable(::String), { 'query_param': { 'field_name': 'tagId', 'style': 'form', 'explode': true } }
28
32
  # The tag IDs to filter the links by.
29
33
  field :tag_ids, T.nilable(::Object), { 'query_param': { 'field_name': 'tagIds', 'style': 'form', 'explode': true } }
30
34
  # The unique name of the tags assigned to the short link (case insensitive).
31
35
  field :tag_names, T.nilable(::Object), { 'query_param': { 'field_name': 'tagNames', 'style': 'form', 'explode': true } }
36
+ # The ID of the tenant that created the link inside your system. If set, will only return links for the specified tenant.
37
+ field :tenant_id, T.nilable(::String), { 'query_param': { 'field_name': 'tenantId', 'style': 'form', 'explode': true } }
32
38
  # The user ID to filter the links by.
33
39
  field :user_id, T.nilable(::String), { 'query_param': { 'field_name': 'userId', 'style': 'form', 'explode': true } }
34
40
  # DEPRECATED. Filter for links that have at least one tag assigned to them.
35
41
  field :with_tags, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'withTags', 'style': 'form', 'explode': true } }
36
42
 
37
43
 
38
- sig { params(domain: T.nilable(::String), page: T.nilable(::Float), page_size: T.nilable(::Float), search: T.nilable(::String), show_archived: T.nilable(T::Boolean), sort: T.nilable(::OpenApiSDK::Operations::Sort), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), user_id: T.nilable(::String), with_tags: T.nilable(T::Boolean)).void }
39
- def initialize(domain: nil, page: nil, page_size: nil, search: nil, show_archived: nil, sort: nil, tag_id: nil, tag_ids: nil, tag_names: nil, user_id: nil, with_tags: nil)
44
+ sig { params(domain: T.nilable(::String), page: T.nilable(::Float), page_size: T.nilable(::Float), search: T.nilable(::String), show_archived: T.nilable(T::Boolean), sort: T.nilable(::OpenApiSDK::Operations::Sort), sort_by: T.nilable(::OpenApiSDK::Operations::SortBy), sort_order: T.nilable(::OpenApiSDK::Operations::SortOrder), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), tenant_id: T.nilable(::String), user_id: T.nilable(::String), with_tags: T.nilable(T::Boolean)).void }
45
+ def initialize(domain: nil, page: nil, page_size: nil, search: nil, show_archived: nil, sort: nil, sort_by: nil, sort_order: nil, tag_id: nil, tag_ids: nil, tag_names: nil, tenant_id: nil, user_id: nil, with_tags: nil)
40
46
  @domain = domain
41
47
  @page = page
42
48
  @page_size = page_size
43
49
  @search = search
44
50
  @show_archived = show_archived
45
51
  @sort = sort
52
+ @sort_by = sort_by
53
+ @sort_order = sort_order
46
54
  @tag_id = tag_id
47
55
  @tag_ids = tag_ids
48
56
  @tag_names = tag_names
57
+ @tenant_id = tenant_id
49
58
  @user_id = user_id
50
59
  @with_tags = with_tags
51
60
  end
data/lib/open_api_sdk/models/operations/getlinkscount_request.rb CHANGED
@@ -25,14 +25,16 @@ module OpenApiSDK
25
25
  field :tag_ids, T.nilable(::Object), { 'query_param': { 'field_name': 'tagIds', 'style': 'form', 'explode': true } }
26
26
  # The unique name of the tags assigned to the short link (case insensitive).
27
27
  field :tag_names, T.nilable(::Object), { 'query_param': { 'field_name': 'tagNames', 'style': 'form', 'explode': true } }
28
+ # The ID of the tenant that created the link inside your system. If set, will only return links for the specified tenant.
29
+ field :tenant_id, T.nilable(::String), { 'query_param': { 'field_name': 'tenantId', 'style': 'form', 'explode': true } }
28
30
  # The user ID to filter the links by.
29
31
  field :user_id, T.nilable(::String), { 'query_param': { 'field_name': 'userId', 'style': 'form', 'explode': true } }
30
32
  # DEPRECATED. Filter for links that have at least one tag assigned to them.
31
33
  field :with_tags, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'withTags', 'style': 'form', 'explode': true } }
32
34
 
33
35
 
34
- sig { params(domain: T.nilable(::String), group_by: T.nilable(::Object), search: T.nilable(::String), show_archived: T.nilable(T::Boolean), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), user_id: T.nilable(::String), with_tags: T.nilable(T::Boolean)).void }
35
- def initialize(domain: nil, group_by: nil, search: nil, show_archived: nil, tag_id: nil, tag_ids: nil, tag_names: nil, user_id: nil, with_tags: nil)
36
+ sig { params(domain: T.nilable(::String), group_by: T.nilable(::Object), search: T.nilable(::String), show_archived: T.nilable(T::Boolean), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), tenant_id: T.nilable(::String), user_id: T.nilable(::String), with_tags: T.nilable(T::Boolean)).void }
37
+ def initialize(domain: nil, group_by: nil, search: nil, show_archived: nil, tag_id: nil, tag_ids: nil, tag_names: nil, tenant_id: nil, user_id: nil, with_tags: nil)
36
38
  @domain = domain
37
39
  @group_by = group_by
38
40
  @search = search
@@ -40,6 +42,7 @@ module OpenApiSDK
40
42
  @tag_id = tag_id
41
43
  @tag_ids = tag_ids
42
44
  @tag_names = tag_names
45
+ @tenant_id = tenant_id
43
46
  @user_id = user_id
44
47
  @with_tags = with_tags
45
48
  end
data/lib/open_api_sdk/models/operations/listevents_request.rb CHANGED
@@ -37,7 +37,7 @@ module OpenApiSDK
37
37
  field :limit, T.nilable(::Float), { 'query_param': { 'field_name': 'limit', 'style': 'form', 'explode': true } }
38
38
  # The unique ID of the short link on Dub.
39
39
  field :link_id, T.nilable(::String), { 'query_param': { 'field_name': 'linkId', 'style': 'form', 'explode': true } }
40
-
40
+ # DEPRECATED. Use `sortOrder` instead.
41
41
  field :order, T.nilable(::OpenApiSDK::Operations::Order), { 'query_param': { 'field_name': 'order', 'style': 'form', 'explode': true } }
42
42
  # The OS to retrieve analytics for.
43
43
  field :os, T.nilable(::String), { 'query_param': { 'field_name': 'os', 'style': 'form', 'explode': true } }
@@ -53,8 +53,10 @@ module OpenApiSDK
53
53
  field :region, T.nilable(::String), { 'query_param': { 'field_name': 'region', 'style': 'form', 'explode': true } }
54
54
  # Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.
55
55
  field :root, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'root', 'style': 'form', 'explode': true } }
56
-
57
- field :sort_by, T.nilable(::OpenApiSDK::Operations::SortBy), { 'query_param': { 'field_name': 'sortBy', 'style': 'form', 'explode': true } }
56
+ # The field to sort the events by. The default is `timestamp`.
57
+ field :sort_by, T.nilable(::OpenApiSDK::Operations::QueryParamSortBy), { 'query_param': { 'field_name': 'sortBy', 'style': 'form', 'explode': true } }
58
+ # The sort order. The default is `desc`.
59
+ field :sort_order, T.nilable(::OpenApiSDK::Operations::QueryParamSortOrder), { 'query_param': { 'field_name': 'sortOrder', 'style': 'form', 'explode': true } }
58
60
  # The start date and time when to retrieve analytics from. Takes precedence over `interval`.
59
61
  field :start, T.nilable(::String), { 'query_param': { 'field_name': 'start', 'style': 'form', 'explode': true } }
60
62
  # Deprecated. Use `tagIds` instead. The tag ID to retrieve analytics for.
@@ -69,8 +71,8 @@ module OpenApiSDK
69
71
  field :url, T.nilable(::String), { 'query_param': { 'field_name': 'url', 'style': 'form', 'explode': true } }
70
72
 
71
73
 
72
- sig { params(browser: T.nilable(::String), city: T.nilable(::String), continent: T.nilable(::OpenApiSDK::Shared::ContinentCode), country: T.nilable(::OpenApiSDK::Shared::CountryCode), device: T.nilable(::String), domain: T.nilable(::String), end_: T.nilable(::String), event: T.nilable(::OpenApiSDK::Operations::QueryParamEvent), external_id: T.nilable(::String), interval: T.nilable(::OpenApiSDK::Operations::QueryParamInterval), key: T.nilable(::String), limit: T.nilable(::Float), link_id: T.nilable(::String), order: T.nilable(::OpenApiSDK::Operations::Order), os: T.nilable(::String), page: T.nilable(::Float), qr: T.nilable(T::Boolean), referer: T.nilable(::String), referer_url: T.nilable(::String), region: T.nilable(::String), root: T.nilable(T::Boolean), sort_by: T.nilable(::OpenApiSDK::Operations::SortBy), start: T.nilable(::String), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), timezone: T.nilable(::String), trigger: T.nilable(::OpenApiSDK::Operations::QueryParamTrigger), url: T.nilable(::String)).void }
73
- def initialize(browser: nil, city: nil, continent: nil, country: nil, device: nil, domain: nil, end_: nil, event: nil, external_id: nil, interval: nil, key: nil, limit: nil, link_id: nil, order: nil, os: nil, page: nil, qr: nil, referer: nil, referer_url: nil, region: nil, root: nil, sort_by: nil, start: nil, tag_id: nil, tag_ids: nil, timezone: nil, trigger: nil, url: nil)
74
+ sig { params(browser: T.nilable(::String), city: T.nilable(::String), continent: T.nilable(::OpenApiSDK::Shared::ContinentCode), country: T.nilable(::OpenApiSDK::Shared::CountryCode), device: T.nilable(::String), domain: T.nilable(::String), end_: T.nilable(::String), event: T.nilable(::OpenApiSDK::Operations::QueryParamEvent), external_id: T.nilable(::String), interval: T.nilable(::OpenApiSDK::Operations::QueryParamInterval), key: T.nilable(::String), limit: T.nilable(::Float), link_id: T.nilable(::String), order: T.nilable(::OpenApiSDK::Operations::Order), os: T.nilable(::String), page: T.nilable(::Float), qr: T.nilable(T::Boolean), referer: T.nilable(::String), referer_url: T.nilable(::String), region: T.nilable(::String), root: T.nilable(T::Boolean), sort_by: T.nilable(::OpenApiSDK::Operations::QueryParamSortBy), sort_order: T.nilable(::OpenApiSDK::Operations::QueryParamSortOrder), start: T.nilable(::String), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), timezone: T.nilable(::String), trigger: T.nilable(::OpenApiSDK::Operations::QueryParamTrigger), url: T.nilable(::String)).void }
75
+ def initialize(browser: nil, city: nil, continent: nil, country: nil, device: nil, domain: nil, end_: nil, event: nil, external_id: nil, interval: nil, key: nil, limit: nil, link_id: nil, order: nil, os: nil, page: nil, qr: nil, referer: nil, referer_url: nil, region: nil, root: nil, sort_by: nil, sort_order: nil, start: nil, tag_id: nil, tag_ids: nil, timezone: nil, trigger: nil, url: nil)
74
76
  @browser = browser
75
77
  @city = city
76
78
  @continent = continent
@@ -93,6 +95,7 @@ module OpenApiSDK
93
95
  @region = region
94
96
  @root = root
95
97
  @sort_by = sort_by
98
+ @sort_order = sort_order
96
99
  @start = start
97
100
  @tag_id = tag_id
98
101
  @tag_ids = tag_ids
data/lib/open_api_sdk/models/operations/order.rb CHANGED
@@ -7,7 +7,9 @@
7
7
  module OpenApiSDK
8
8
  module Operations
9
9
 
10
- # Order
10
+ # Order - DEPRECATED. Use `sortOrder` instead.
11
+ #
12
+ # @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
11
13
  class Order < T::Enum
12
14
  enums do
13
15
  ASC = new('asc')
data/lib/open_api_sdk/models/operations/queryparam_sortby.rb ADDED
@@ -0,0 +1,17 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: true
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module OpenApiSDK
8
+ module Operations
9
+
10
+ # QueryParamSortBy - The field to sort the events by. The default is `timestamp`.
11
+ class QueryParamSortBy < T::Enum
12
+ enums do
13
+ TIMESTAMP = new('timestamp')
14
+ end
15
+ end
16
+ end
17
+ end
data/lib/open_api_sdk/models/operations/queryparam_sortorder.rb ADDED
@@ -0,0 +1,18 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: true
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module OpenApiSDK
8
+ module Operations
9
+
10
+ # QueryParamSortOrder - The sort order. The default is `desc`.
11
+ class QueryParamSortOrder < T::Enum
12
+ enums do
13
+ ASC = new('asc')
14
+ DESC = new('desc')
15
+ end
16
+ end
17
+ end
18
+ end
data/lib/open_api_sdk/models/operations/requestbody.rb CHANGED
@@ -15,7 +15,7 @@ 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. Defaults to `false` if not provided.
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') } }
@@ -29,7 +29,7 @@ module OpenApiSDK
29
29
  field :expired_url, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiredUrl') } }
30
30
  # The date and time when the short link will expire at.
31
31
  field :expires_at, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiresAt') } }
32
- # 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.
32
+ # The ID of the link in your database. If set, it can be used to identify the link in future API requests (must be prefixed with 'ext_' when passed as a query parameter). This key is unique across your workspace.
33
33
  field :external_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
34
34
  # Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`.
35
35
  field :geo, T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('geo') } }
@@ -45,15 +45,15 @@ module OpenApiSDK
45
45
  field :prefix, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('prefix') } }
46
46
  # The ID of the program the short link is associated with.
47
47
  field :program_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
48
- # Whether the short link uses Custom Social Media Cards feature.
48
+ # Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided.
49
49
  field :proxy, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('proxy') } }
50
- # Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible.
50
+ # Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
51
51
  #
52
52
  # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
53
53
  field :public_stats, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('publicStats') } }
54
54
  # The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL.
55
55
  field :ref, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ref') } }
56
- # Whether the short link uses link cloaking.
56
+ # Whether the short link uses link cloaking. Defaults to `false` if not provided.
57
57
  field :rewrite, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('rewrite') } }
58
58
  # The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead.
59
59
  #
@@ -63,9 +63,11 @@ module OpenApiSDK
63
63
  field :tag_ids, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagIds') } }
64
64
  # The unique name of the tags assigned to the short link (case insensitive).
65
65
  field :tag_names, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagNames') } }
66
+ # The ID of the tenant that created the link inside your system. If set, it can be used to fetch all links for a tenant.
67
+ field :tenant_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } }
66
68
  # The custom link preview title (og:title). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
67
69
  field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
68
- # Whether to track conversions for the short link.
70
+ # Whether to track conversions for the short link. Defaults to `false` if not provided.
69
71
  field :track_conversion, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trackConversion') } }
70
72
  # The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL.
71
73
  field :utm_campaign, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_campaign') } }
@@ -83,8 +85,8 @@ module OpenApiSDK
83
85
  field :webhook_ids, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('webhookIds') } }
84
86
 
85
87
 
86
- sig { params(url: ::String, android: T.nilable(::String), archived: T.nilable(T::Boolean), comments: T.nilable(::String), description: T.nilable(::String), do_index: T.nilable(T::Boolean), domain: T.nilable(::String), expired_url: T.nilable(::String), expires_at: T.nilable(::String), external_id: T.nilable(::String), geo: T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), image: T.nilable(::String), ios: T.nilable(::String), key: T.nilable(::String), password: T.nilable(::String), prefix: T.nilable(::String), program_id: T.nilable(::String), proxy: T.nilable(T::Boolean), public_stats: T.nilable(T::Boolean), ref: T.nilable(::String), rewrite: T.nilable(T::Boolean), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), title: T.nilable(::String), track_conversion: T.nilable(T::Boolean), utm_campaign: T.nilable(::String), utm_content: T.nilable(::String), utm_medium: T.nilable(::String), utm_source: T.nilable(::String), utm_term: T.nilable(::String), video: T.nilable(::String), webhook_ids: T.nilable(T::Array[::String])).void }
87
- def initialize(url: nil, android: nil, archived: nil, comments: nil, description: nil, do_index: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, image: nil, ios: nil, key: nil, password: nil, prefix: nil, program_id: nil, proxy: nil, public_stats: nil, ref: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, title: nil, track_conversion: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil, webhook_ids: nil)
88
+ sig { params(url: ::String, android: T.nilable(::String), archived: T.nilable(T::Boolean), comments: T.nilable(::String), description: T.nilable(::String), do_index: T.nilable(T::Boolean), domain: T.nilable(::String), expired_url: T.nilable(::String), expires_at: T.nilable(::String), external_id: T.nilable(::String), geo: T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), image: T.nilable(::String), ios: T.nilable(::String), key: T.nilable(::String), password: T.nilable(::String), prefix: T.nilable(::String), program_id: T.nilable(::String), proxy: T.nilable(T::Boolean), public_stats: T.nilable(T::Boolean), ref: T.nilable(::String), rewrite: T.nilable(T::Boolean), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), tenant_id: T.nilable(::String), title: T.nilable(::String), track_conversion: T.nilable(T::Boolean), utm_campaign: T.nilable(::String), utm_content: T.nilable(::String), utm_medium: T.nilable(::String), utm_source: T.nilable(::String), utm_term: T.nilable(::String), video: T.nilable(::String), webhook_ids: T.nilable(T::Array[::String])).void }
89
+ def initialize(url: nil, android: nil, archived: nil, comments: nil, description: nil, do_index: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, image: nil, ios: nil, key: nil, password: nil, prefix: nil, program_id: nil, proxy: nil, public_stats: nil, ref: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, tenant_id: nil, title: nil, track_conversion: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil, webhook_ids: nil)
88
90
  @url = url
89
91
  @android = android
90
92
  @archived = archived
@@ -109,6 +111,7 @@ module OpenApiSDK
109
111
  @tag_id = tag_id
110
112
  @tag_ids = tag_ids
111
113
  @tag_names = tag_names
114
+ @tenant_id = tenant_id
112
115
  @title = title
113
116
  @track_conversion = track_conversion
114
117
  @utm_campaign = utm_campaign
data/lib/open_api_sdk/models/operations/sort.rb CHANGED
@@ -7,11 +7,14 @@
7
7
  module OpenApiSDK
8
8
  module Operations
9
9
 
10
- # Sort - The field to sort the links by. The default is `createdAt`, and sort order is always descending.
10
+ # Sort - DEPRECATED. Use `sortBy` instead.
11
+ #
12
+ # @deprecated class: This will be removed in a future release, please migrate away from it as soon as possible.
11
13
  class Sort < T::Enum
12
14
  enums do
13
15
  CREATED_AT = new('createdAt')
14
16
  CLICKS = new('clicks')
17
+ SALE_AMOUNT = new('saleAmount')
15
18
  LAST_CLICKED = new('lastClicked')
16
19
  end
17
20
  end
data/lib/open_api_sdk/models/operations/sortby.rb CHANGED
@@ -7,10 +7,13 @@
7
7
  module OpenApiSDK
8
8
  module Operations
9
9
 
10
- # SortBy
10
+ # SortBy - The field to sort the links by. The default is `createdAt`.
11
11
  class SortBy < T::Enum
12
12
  enums do
13
- TIMESTAMP = new('timestamp')
13
+ CREATED_AT = new('createdAt')
14
+ CLICKS = new('clicks')
15
+ SALE_AMOUNT = new('saleAmount')
16
+ LAST_CLICKED = new('lastClicked')
14
17
  end
15
18
  end
16
19
  end
data/lib/open_api_sdk/models/operations/sortorder.rb ADDED
@@ -0,0 +1,18 @@
1
+ # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
2
+
3
+ # typed: true
4
+ # frozen_string_literal: true
5
+
6
+
7
+ module OpenApiSDK
8
+ module Operations
9
+
10
+ # SortOrder - The sort order. The default is `desc`.
11
+ class SortOrder < T::Enum
12
+ enums do
13
+ ASC = new('asc')
14
+ DESC = new('desc')
15
+ end
16
+ end
17
+ end
18
+ end
data/lib/open_api_sdk/models/operations/updatelink_requestbody.rb CHANGED
@@ -13,7 +13,7 @@ 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. Defaults to `false` if not provided.
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') } }
@@ -27,7 +27,7 @@ module OpenApiSDK
27
27
  field :expired_url, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiredUrl') } }
28
28
  # The date and time when the short link will expire at.
29
29
  field :expires_at, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiresAt') } }
30
- # 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.
30
+ # The ID of the link in your database. If set, it can be used to identify the link in future API requests (must be prefixed with 'ext_' when passed as a query parameter). This key is unique across your workspace.
31
31
  field :external_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
32
32
  # Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`.
33
33
  field :geo, T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('geo') } }
@@ -43,15 +43,15 @@ module OpenApiSDK
43
43
  field :prefix, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('prefix') } }
44
44
  # The ID of the program the short link is associated with.
45
45
  field :program_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
46
- # Whether the short link uses Custom Social Media Cards feature.
46
+ # Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided.
47
47
  field :proxy, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('proxy') } }
48
- # Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible.
48
+ # Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
49
49
  #
50
50
  # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
51
51
  field :public_stats, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('publicStats') } }
52
52
  # The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL.
53
53
  field :ref, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ref') } }
54
- # Whether the short link uses link cloaking.
54
+ # Whether the short link uses link cloaking. Defaults to `false` if not provided.
55
55
  field :rewrite, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('rewrite') } }
56
56
  # The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead.
57
57
  #
@@ -61,9 +61,11 @@ module OpenApiSDK
61
61
  field :tag_ids, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagIds') } }
62
62
  # The unique name of the tags assigned to the short link (case insensitive).
63
63
  field :tag_names, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagNames') } }
64
+ # The ID of the tenant that created the link inside your system. If set, it can be used to fetch all links for a tenant.
65
+ field :tenant_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } }
64
66
  # The custom link preview title (og:title). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
65
67
  field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
66
- # Whether to track conversions for the short link.
68
+ # Whether to track conversions for the short link. Defaults to `false` if not provided.
67
69
  field :track_conversion, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trackConversion') } }
68
70
  # The destination URL of the short link.
69
71
  field :url, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('url') } }
@@ -83,8 +85,8 @@ module OpenApiSDK
83
85
  field :webhook_ids, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('webhookIds') } }
84
86
 
85
87
 
86
- sig { params(android: T.nilable(::String), archived: T.nilable(T::Boolean), comments: T.nilable(::String), description: T.nilable(::String), do_index: T.nilable(T::Boolean), domain: T.nilable(::String), expired_url: T.nilable(::String), expires_at: T.nilable(::String), external_id: T.nilable(::String), geo: T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), image: T.nilable(::String), ios: T.nilable(::String), key: T.nilable(::String), password: T.nilable(::String), prefix: T.nilable(::String), program_id: T.nilable(::String), proxy: T.nilable(T::Boolean), public_stats: T.nilable(T::Boolean), ref: T.nilable(::String), rewrite: T.nilable(T::Boolean), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), title: T.nilable(::String), track_conversion: T.nilable(T::Boolean), url: T.nilable(::String), utm_campaign: T.nilable(::String), utm_content: T.nilable(::String), utm_medium: T.nilable(::String), utm_source: T.nilable(::String), utm_term: T.nilable(::String), video: T.nilable(::String), webhook_ids: T.nilable(T::Array[::String])).void }
87
- def initialize(android: nil, archived: nil, comments: nil, description: nil, do_index: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, image: nil, ios: nil, key: nil, password: nil, prefix: nil, program_id: nil, proxy: nil, public_stats: nil, ref: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, title: nil, track_conversion: nil, url: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil, webhook_ids: nil)
88
+ sig { params(android: T.nilable(::String), archived: T.nilable(T::Boolean), comments: T.nilable(::String), description: T.nilable(::String), do_index: T.nilable(T::Boolean), domain: T.nilable(::String), expired_url: T.nilable(::String), expires_at: T.nilable(::String), external_id: T.nilable(::String), geo: T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), image: T.nilable(::String), ios: T.nilable(::String), key: T.nilable(::String), password: T.nilable(::String), prefix: T.nilable(::String), program_id: T.nilable(::String), proxy: T.nilable(T::Boolean), public_stats: T.nilable(T::Boolean), ref: T.nilable(::String), rewrite: T.nilable(T::Boolean), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), tenant_id: T.nilable(::String), title: T.nilable(::String), track_conversion: T.nilable(T::Boolean), url: T.nilable(::String), utm_campaign: T.nilable(::String), utm_content: T.nilable(::String), utm_medium: T.nilable(::String), utm_source: T.nilable(::String), utm_term: T.nilable(::String), video: T.nilable(::String), webhook_ids: T.nilable(T::Array[::String])).void }
89
+ def initialize(android: nil, archived: nil, comments: nil, description: nil, do_index: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, image: nil, ios: nil, key: nil, password: nil, prefix: nil, program_id: nil, proxy: nil, public_stats: nil, ref: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, tenant_id: nil, title: nil, track_conversion: nil, url: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil, webhook_ids: nil)
88
90
  @android = android
89
91
  @archived = archived
90
92
  @comments = comments
@@ -108,6 +110,7 @@ module OpenApiSDK
108
110
  @tag_id = tag_id
109
111
  @tag_ids = tag_ids
110
112
  @tag_names = tag_names
113
+ @tenant_id = tenant_id
111
114
  @title = title
112
115
  @track_conversion = track_conversion
113
116
  @url = url
data/lib/open_api_sdk/models/operations/upsertlink_requestbody.rb CHANGED
@@ -15,7 +15,7 @@ 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. Defaults to `false` if not provided.
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') } }
@@ -29,7 +29,7 @@ module OpenApiSDK
29
29
  field :expired_url, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiredUrl') } }
30
30
  # The date and time when the short link will expire at.
31
31
  field :expires_at, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiresAt') } }
32
- # 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.
32
+ # The ID of the link in your database. If set, it can be used to identify the link in future API requests (must be prefixed with 'ext_' when passed as a query parameter). This key is unique across your workspace.
33
33
  field :external_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
34
34
  # Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`.
35
35
  field :geo, T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('geo') } }
@@ -45,15 +45,15 @@ module OpenApiSDK
45
45
  field :prefix, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('prefix') } }
46
46
  # The ID of the program the short link is associated with.
47
47
  field :program_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('programId') } }
48
- # Whether the short link uses Custom Social Media Cards feature.
48
+ # Whether the short link uses Custom Social Media Cards feature. Defaults to `false` if not provided.
49
49
  field :proxy, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('proxy') } }
50
- # Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible.
50
+ # Deprecated: Use `dashboard` instead. Whether the short link's stats are publicly accessible. Defaults to `false` if not provided.
51
51
  #
52
52
  # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
53
53
  field :public_stats, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('publicStats') } }
54
54
  # The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL.
55
55
  field :ref, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ref') } }
56
- # Whether the short link uses link cloaking.
56
+ # Whether the short link uses link cloaking. Defaults to `false` if not provided.
57
57
  field :rewrite, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('rewrite') } }
58
58
  # The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead.
59
59
  #
@@ -63,9 +63,11 @@ module OpenApiSDK
63
63
  field :tag_ids, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagIds') } }
64
64
  # The unique name of the tags assigned to the short link (case insensitive).
65
65
  field :tag_names, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagNames') } }
66
+ # The ID of the tenant that created the link inside your system. If set, it can be used to fetch all links for a tenant.
67
+ field :tenant_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } }
66
68
  # The custom link preview title (og:title). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
67
69
  field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
68
- # Whether to track conversions for the short link.
70
+ # Whether to track conversions for the short link. Defaults to `false` if not provided.
69
71
  field :track_conversion, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trackConversion') } }
70
72
  # The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL.
71
73
  field :utm_campaign, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_campaign') } }
@@ -83,8 +85,8 @@ module OpenApiSDK
83
85
  field :webhook_ids, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('webhookIds') } }
84
86
 
85
87
 
86
- sig { params(url: ::String, android: T.nilable(::String), archived: T.nilable(T::Boolean), comments: T.nilable(::String), description: T.nilable(::String), do_index: T.nilable(T::Boolean), domain: T.nilable(::String), expired_url: T.nilable(::String), expires_at: T.nilable(::String), external_id: T.nilable(::String), geo: T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), image: T.nilable(::String), ios: T.nilable(::String), key: T.nilable(::String), password: T.nilable(::String), prefix: T.nilable(::String), program_id: T.nilable(::String), proxy: T.nilable(T::Boolean), public_stats: T.nilable(T::Boolean), ref: T.nilable(::String), rewrite: T.nilable(T::Boolean), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), title: T.nilable(::String), track_conversion: T.nilable(T::Boolean), utm_campaign: T.nilable(::String), utm_content: T.nilable(::String), utm_medium: T.nilable(::String), utm_source: T.nilable(::String), utm_term: T.nilable(::String), video: T.nilable(::String), webhook_ids: T.nilable(T::Array[::String])).void }
87
- def initialize(url: nil, android: nil, archived: nil, comments: nil, description: nil, do_index: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, image: nil, ios: nil, key: nil, password: nil, prefix: nil, program_id: nil, proxy: nil, public_stats: nil, ref: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, title: nil, track_conversion: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil, webhook_ids: nil)
88
+ sig { params(url: ::String, android: T.nilable(::String), archived: T.nilable(T::Boolean), comments: T.nilable(::String), description: T.nilable(::String), do_index: T.nilable(T::Boolean), domain: T.nilable(::String), expired_url: T.nilable(::String), expires_at: T.nilable(::String), external_id: T.nilable(::String), geo: T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), image: T.nilable(::String), ios: T.nilable(::String), key: T.nilable(::String), password: T.nilable(::String), prefix: T.nilable(::String), program_id: T.nilable(::String), proxy: T.nilable(T::Boolean), public_stats: T.nilable(T::Boolean), ref: T.nilable(::String), rewrite: T.nilable(T::Boolean), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), tenant_id: T.nilable(::String), title: T.nilable(::String), track_conversion: T.nilable(T::Boolean), utm_campaign: T.nilable(::String), utm_content: T.nilable(::String), utm_medium: T.nilable(::String), utm_source: T.nilable(::String), utm_term: T.nilable(::String), video: T.nilable(::String), webhook_ids: T.nilable(T::Array[::String])).void }
89
+ def initialize(url: nil, android: nil, archived: nil, comments: nil, description: nil, do_index: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, image: nil, ios: nil, key: nil, password: nil, prefix: nil, program_id: nil, proxy: nil, public_stats: nil, ref: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, tenant_id: nil, title: nil, track_conversion: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil, webhook_ids: nil)
88
90
  @url = url
89
91
  @android = android
90
92
  @archived = archived
@@ -109,6 +111,7 @@ module OpenApiSDK
109
111
  @tag_id = tag_id
110
112
  @tag_ids = tag_ids
111
113
  @tag_names = tag_names
114
+ @tenant_id = tenant_id
112
115
  @title = title
113
116
  @track_conversion = track_conversion
114
117
  @utm_campaign = utm_campaign
data/lib/open_api_sdk/models/operations.rb CHANGED
@@ -7,6 +7,8 @@ module OpenApiSDK
7
7
  module Operations
8
8
  autoload :CreateLinkRequestBody, 'open_api_sdk/models/operations/createlink_requestbody.rb'
9
9
  autoload :CreateLinkResponse, 'open_api_sdk/models/operations/createlink_response.rb'
10
+ autoload :SortBy, 'open_api_sdk/models/operations/sortby.rb'
11
+ autoload :SortOrder, 'open_api_sdk/models/operations/sortorder.rb'
10
12
  autoload :Sort, 'open_api_sdk/models/operations/sort.rb'
11
13
  autoload :GetLinksRequest, 'open_api_sdk/models/operations/getlinks_request.rb'
12
14
  autoload :GetLinksResponse, 'open_api_sdk/models/operations/getlinks_response.rb'
@@ -39,8 +41,9 @@ module OpenApiSDK
39
41
  autoload :QueryParamEvent, 'open_api_sdk/models/operations/queryparam_event.rb'
40
42
  autoload :QueryParamInterval, 'open_api_sdk/models/operations/queryparam_interval.rb'
41
43
  autoload :QueryParamTrigger, 'open_api_sdk/models/operations/queryparam_trigger.rb'
44
+ autoload :QueryParamSortOrder, 'open_api_sdk/models/operations/queryparam_sortorder.rb'
45
+ autoload :QueryParamSortBy, 'open_api_sdk/models/operations/queryparam_sortby.rb'
42
46
  autoload :Order, 'open_api_sdk/models/operations/order.rb'
43
- autoload :SortBy, 'open_api_sdk/models/operations/sortby.rb'
44
47
  autoload :ListEventsRequest, 'open_api_sdk/models/operations/listevents_request.rb'
45
48
  autoload :ListEventsResponse, 'open_api_sdk/models/operations/listevents_response.rb'
46
49
  autoload :Color, 'open_api_sdk/models/operations/color.rb'
data/lib/open_api_sdk/models/shared/link.rb CHANGED
@@ -27,7 +27,7 @@ module OpenApiSDK
27
27
  field :expired_url, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiredUrl') } }
28
28
 
29
29
  field :expires_at, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiresAt') } }
30
- # This is the ID of the link in your database that is unique across your workspace. If set, it can be used to identify the link in future API requests. Must be prefixed with 'ext_' when passed as a query parameter.
30
+ # The ID of the link in your database. If set, it can be used to identify the link in future API requests (must be prefixed with 'ext_' when passed as a query parameter). This key is unique across your workspace.
31
31
  field :external_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
32
32
  # Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. Learn more: https://d.to/geo
33
33
  field :geo, ::OpenApiSDK::Shared::ClickEventGeo, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('geo') } }
@@ -41,7 +41,7 @@ module OpenApiSDK
41
41
  field :key, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('key') } }
42
42
 
43
43
  field :last_clicked, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('lastClicked') } }
44
- # [BETA]: The number of leads the short links has generated.
44
+ # The number of leads the short links has generated.
45
45
  field :leads, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('leads') } }
46
46
  # The password required to access the destination URL of the short link.
47
47
  field :password, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('password') } }
@@ -53,9 +53,9 @@ module OpenApiSDK
53
53
  field :project_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('projectId') } }
54
54
  # The full URL of the QR code for the short link (e.g. `https://api.dub.co/qr?url=https://dub.sh/try`).
55
55
  field :qr_code, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('qrCode') } }
56
- # [BETA]: The total dollar amount of sales the short links has generated (in cents).
56
+ # The total dollar amount of sales the short links has generated (in cents).
57
57
  field :sale_amount, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('saleAmount') } }
58
- # [BETA]: The number of sales the short links has generated.
58
+ # The number of sales the short links has generated.
59
59
  field :sales, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('sales') } }
60
60
  # The full URL of the short link, including the https protocol (e.g. `https://dub.sh/try`).
61
61
  field :short_link, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('shortLink') } }
@@ -65,6 +65,8 @@ module OpenApiSDK
65
65
  field :tag_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagId') } }
66
66
  # The tags assigned to the short link.
67
67
  field :tags, T::Array[::OpenApiSDK::Shared::TagSchema], { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tags') } }
68
+ # The ID of the tenant that created the link inside your system. If set, it can be used to fetch all links for a tenant.
69
+ field :tenant_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } }
68
70
  # The title of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
69
71
  field :title, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
70
72
 
@@ -103,8 +105,8 @@ module OpenApiSDK
103
105
  field :track_conversion, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trackConversion') } }
104
106
 
105
107
 
106
- sig { params(android: ::String, clicks: ::Float, comments: ::String, created_at: ::String, description: ::String, domain: ::String, expired_url: ::String, expires_at: ::String, external_id: ::String, geo: ::OpenApiSDK::Shared::ClickEventGeo, id: ::String, image: ::String, ios: ::String, key: ::String, last_clicked: ::String, leads: ::Float, password: ::String, program_id: ::String, project_id: ::String, qr_code: ::String, sale_amount: ::Float, sales: ::Float, short_link: ::String, tag_id: ::String, tags: T::Array[::OpenApiSDK::Shared::TagSchema], title: ::String, updated_at: ::String, url: ::String, user_id: ::String, utm_campaign: ::String, utm_content: ::String, utm_medium: ::String, utm_source: ::String, utm_term: ::String, video: ::String, webhook_ids: T::Array[::String], workspace_id: ::String, archived: T.nilable(T::Boolean), do_index: T.nilable(T::Boolean), proxy: T.nilable(T::Boolean), public_stats: T.nilable(T::Boolean), rewrite: T.nilable(T::Boolean), track_conversion: T.nilable(T::Boolean)).void }
107
- def initialize(android: nil, clicks: nil, comments: nil, created_at: nil, description: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, id: nil, image: nil, ios: nil, key: nil, last_clicked: nil, leads: nil, password: nil, program_id: nil, project_id: nil, qr_code: nil, sale_amount: nil, sales: nil, short_link: nil, tag_id: nil, tags: nil, title: nil, updated_at: nil, url: nil, user_id: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil, webhook_ids: nil, workspace_id: nil, archived: nil, do_index: nil, proxy: nil, public_stats: nil, rewrite: nil, track_conversion: nil)
108
+ sig { params(android: ::String, clicks: ::Float, comments: ::String, created_at: ::String, description: ::String, domain: ::String, expired_url: ::String, expires_at: ::String, external_id: ::String, geo: ::OpenApiSDK::Shared::ClickEventGeo, id: ::String, image: ::String, ios: ::String, key: ::String, last_clicked: ::String, leads: ::Float, password: ::String, program_id: ::String, project_id: ::String, qr_code: ::String, sale_amount: ::Float, sales: ::Float, short_link: ::String, tag_id: ::String, tags: T::Array[::OpenApiSDK::Shared::TagSchema], tenant_id: ::String, title: ::String, updated_at: ::String, url: ::String, user_id: ::String, utm_campaign: ::String, utm_content: ::String, utm_medium: ::String, utm_source: ::String, utm_term: ::String, video: ::String, webhook_ids: T::Array[::String], workspace_id: ::String, archived: T.nilable(T::Boolean), do_index: T.nilable(T::Boolean), proxy: T.nilable(T::Boolean), public_stats: T.nilable(T::Boolean), rewrite: T.nilable(T::Boolean), track_conversion: T.nilable(T::Boolean)).void }
109
+ def initialize(android: nil, clicks: nil, comments: nil, created_at: nil, description: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, id: nil, image: nil, ios: nil, key: nil, last_clicked: nil, leads: nil, password: nil, program_id: nil, project_id: nil, qr_code: nil, sale_amount: nil, sales: nil, short_link: nil, tag_id: nil, tags: nil, tenant_id: nil, title: nil, updated_at: nil, url: nil, user_id: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil, webhook_ids: nil, workspace_id: nil, archived: nil, do_index: nil, proxy: nil, public_stats: nil, rewrite: nil, track_conversion: nil)
108
110
  @android = android
109
111
  @clicks = clicks
110
112
  @comments = comments
@@ -130,6 +132,7 @@ module OpenApiSDK
130
132
  @short_link = short_link
131
133
  @tag_id = tag_id
132
134
  @tags = tags
135
+ @tenant_id = tenant_id
133
136
  @title = title
134
137
  @updated_at = updated_at
135
138
  @url = url
data/lib/open_api_sdk/models/shared/linkschema.rb CHANGED
@@ -31,7 +31,7 @@ module OpenApiSDK
31
31
  field :expired_url, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiredUrl') } }
32
32
  # The date and time when the short link will expire in ISO-8601 format.
33
33
  field :expires_at, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiresAt') } }
34
- # This is the ID of the link in your database that is unique across your workspace. If set, it can be used to identify the link in future API requests. Must be prefixed with 'ext_' when passed as a query parameter.
34
+ # The ID of the link in your database. If set, it can be used to identify the link in future API requests (must be prefixed with 'ext_' when passed as a query parameter). This key is unique across your workspace.
35
35
  field :external_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
36
36
  # Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`. Learn more: https://d.to/geo
37
37
  field :geo, ::OpenApiSDK::Shared::Geo, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('geo') } }
@@ -45,7 +45,7 @@ module OpenApiSDK
45
45
  field :key, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('key') } }
46
46
  # The date and time when the short link was last clicked.
47
47
  field :last_clicked, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('lastClicked') } }
48
- # [BETA]: The number of leads the short links has generated.
48
+ # The number of leads the short links has generated.
49
49
  field :leads, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('leads') } }
50
50
  # The password required to access the destination URL of the short link.
51
51
  field :password, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('password') } }
@@ -63,9 +63,9 @@ module OpenApiSDK
63
63
  field :qr_code, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('qrCode') } }
64
64
  # Whether the short link uses link cloaking.
65
65
  field :rewrite, T::Boolean, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('rewrite') } }
66
- # [BETA]: The total dollar amount of sales the short links has generated (in cents).
66
+ # The total dollar amount of sales the short links has generated (in cents).
67
67
  field :sale_amount, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('saleAmount') } }
68
- # [BETA]: The number of sales the short links has generated.
68
+ # The number of sales the short links has generated.
69
69
  field :sales, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('sales') } }
70
70
  # The full URL of the short link, including the https protocol (e.g. `https://dub.sh/try`).
71
71
  field :short_link, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('shortLink') } }
@@ -75,9 +75,11 @@ module OpenApiSDK
75
75
  field :tag_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagId') } }
76
76
  # The tags assigned to the short link.
77
77
  field :tags, T::Array[::OpenApiSDK::Shared::TagSchema], { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tags') } }
78
+ # The ID of the tenant that created the link inside your system. If set, it can be used to fetch all links for a tenant.
79
+ field :tenant_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tenantId') } }
78
80
  # The title of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
79
81
  field :title, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
80
- # [BETA] Whether to track conversions for the short link.
82
+ # Whether to track conversions for the short link.
81
83
  field :track_conversion, T::Boolean, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trackConversion') } }
82
84
  # The date and time when the short link was last updated.
83
85
  field :updated_at, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('updatedAt') } }
@@ -103,8 +105,8 @@ module OpenApiSDK
103
105
  field :workspace_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('workspaceId') } }
104
106
 
105
107
 
106
- sig { params(android: ::String, archived: T::Boolean, clicks: ::Float, comments: ::String, created_at: ::String, description: ::String, do_index: T::Boolean, domain: ::String, expired_url: ::String, expires_at: ::String, external_id: ::String, geo: ::OpenApiSDK::Shared::Geo, id: ::String, image: ::String, ios: ::String, key: ::String, last_clicked: ::String, leads: ::Float, password: ::String, program_id: ::String, project_id: ::String, proxy: T::Boolean, public_stats: T::Boolean, qr_code: ::String, rewrite: T::Boolean, sale_amount: ::Float, sales: ::Float, short_link: ::String, tag_id: ::String, tags: T::Array[::OpenApiSDK::Shared::TagSchema], title: ::String, track_conversion: T::Boolean, updated_at: ::String, url: ::String, user_id: ::String, utm_campaign: ::String, utm_content: ::String, utm_medium: ::String, utm_source: ::String, utm_term: ::String, video: ::String, webhook_ids: T::Array[::String], workspace_id: ::String).void }
107
- def initialize(android: nil, archived: nil, clicks: nil, comments: nil, created_at: nil, description: nil, do_index: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, id: nil, image: nil, ios: nil, key: nil, last_clicked: nil, leads: nil, password: nil, program_id: nil, project_id: nil, proxy: nil, public_stats: nil, qr_code: nil, rewrite: nil, sale_amount: nil, sales: nil, short_link: nil, tag_id: nil, tags: nil, title: nil, track_conversion: nil, updated_at: nil, url: nil, user_id: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil, webhook_ids: nil, workspace_id: nil)
108
+ sig { params(android: ::String, archived: T::Boolean, clicks: ::Float, comments: ::String, created_at: ::String, description: ::String, do_index: T::Boolean, domain: ::String, expired_url: ::String, expires_at: ::String, external_id: ::String, geo: ::OpenApiSDK::Shared::Geo, id: ::String, image: ::String, ios: ::String, key: ::String, last_clicked: ::String, leads: ::Float, password: ::String, program_id: ::String, project_id: ::String, proxy: T::Boolean, public_stats: T::Boolean, qr_code: ::String, rewrite: T::Boolean, sale_amount: ::Float, sales: ::Float, short_link: ::String, tag_id: ::String, tags: T::Array[::OpenApiSDK::Shared::TagSchema], tenant_id: ::String, title: ::String, track_conversion: T::Boolean, updated_at: ::String, url: ::String, user_id: ::String, utm_campaign: ::String, utm_content: ::String, utm_medium: ::String, utm_source: ::String, utm_term: ::String, video: ::String, webhook_ids: T::Array[::String], workspace_id: ::String).void }
109
+ def initialize(android: nil, archived: nil, clicks: nil, comments: nil, created_at: nil, description: nil, do_index: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, id: nil, image: nil, ios: nil, key: nil, last_clicked: nil, leads: nil, password: nil, program_id: nil, project_id: nil, proxy: nil, public_stats: nil, qr_code: nil, rewrite: nil, sale_amount: nil, sales: nil, short_link: nil, tag_id: nil, tags: nil, tenant_id: nil, title: nil, track_conversion: nil, updated_at: nil, url: nil, user_id: nil, utm_campaign: nil, utm_content: nil, utm_medium: nil, utm_source: nil, utm_term: nil, video: nil, webhook_ids: nil, workspace_id: nil)
108
110
  @android = android
109
111
  @archived = archived
110
112
  @clicks = clicks
@@ -135,6 +137,7 @@ module OpenApiSDK
135
137
  @short_link = short_link
136
138
  @tag_id = tag_id
137
139
  @tags = tags
140
+ @tenant_id = tenant_id
138
141
  @title = title
139
142
  @track_conversion = track_conversion
140
143
  @updated_at = updated_at
data/lib/open_api_sdk/models/shared/workspaceschema.rb CHANGED
@@ -53,7 +53,7 @@ module OpenApiSDK
53
53
  field :sales_usage, ::Float, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('salesUsage') } }
54
54
  # The slug of the workspace.
55
55
  field :slug, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('slug') } }
56
- # [BETA – Dub Conversions]: The Stripe Connect ID of the workspace.
56
+ # The Stripe Connect ID of the workspace.
57
57
  field :stripe_connect_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('stripeConnectId') } }
58
58
  # The Stripe ID of the workspace.
59
59
  field :stripe_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('stripeId') } }
data/lib/open_api_sdk/sdkconfiguration.rb CHANGED
@@ -38,9 +38,9 @@ module OpenApiSDK
38
38
  @security = security
39
39
  @language = 'ruby'
40
40
  @openapi_doc_version = '0.0.1'
41
- @sdk_version = '0.2.2-alpha.50'
42
- @gen_version = '2.486.1'
43
- @user_agent = 'speakeasy-sdk/ruby 0.2.2-alpha.50 2.486.1 0.0.1 dub'
41
+ @sdk_version = '0.2.2-alpha.52'
42
+ @gen_version = '2.493.4'
43
+ @user_agent = 'speakeasy-sdk/ruby 0.2.2-alpha.52 2.493.4 0.0.1 dub'
44
44
  end
45
45
 
46
46
  sig { returns([String, T::Hash[Symbol, String]]) }
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: dub
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.2.2.pre.alpha.50
4
+ version: 0.2.2.pre.alpha.52
5
5
  platform: ruby
6
6
  authors:
7
7
  - Dub
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2025-01-06 00:00:00.000000000 Z
11
+ date: 2025-01-14 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday
@@ -231,6 +231,8 @@ files:
231
231
  - lib/open_api_sdk/models/operations/paymentprocessor.rb
232
232
  - lib/open_api_sdk/models/operations/queryparam_event.rb
233
233
  - lib/open_api_sdk/models/operations/queryparam_interval.rb
234
+ - lib/open_api_sdk/models/operations/queryparam_sortby.rb
235
+ - lib/open_api_sdk/models/operations/queryparam_sortorder.rb
234
236
  - lib/open_api_sdk/models/operations/queryparam_trigger.rb
235
237
  - lib/open_api_sdk/models/operations/requestbody.rb
236
238
  - lib/open_api_sdk/models/operations/responsebody.rb
@@ -239,6 +241,7 @@ files:
239
241
  - lib/open_api_sdk/models/operations/sale.rb
240
242
  - lib/open_api_sdk/models/operations/sort.rb
241
243
  - lib/open_api_sdk/models/operations/sortby.rb
244
+ - lib/open_api_sdk/models/operations/sortorder.rb
242
245
  - lib/open_api_sdk/models/operations/tracklead_requestbody.rb
243
246
  - lib/open_api_sdk/models/operations/tracklead_response.rb
244
247
  - lib/open_api_sdk/models/operations/tracklead_responsebody.rb