dub 0.2.2.pre.alpha.52 → 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (193) hide show
  1. checksums.yaml +4 -4
  2. data/lib/dub.rb +3 -6
  3. data/lib/open_api_sdk/analytics.rb +1 -2
  4. data/lib/open_api_sdk/domains.rb +55 -61
  5. data/lib/open_api_sdk/dub.rb +4 -7
  6. data/lib/open_api_sdk/links.rb +57 -145
  7. data/lib/open_api_sdk/metatags.rb +1 -2
  8. data/lib/open_api_sdk/models/operations/bulkcreatelinks_response.rb +6 -6
  9. data/lib/open_api_sdk/models/operations/bulkupdatelinks_requestbody.rb +5 -8
  10. data/lib/open_api_sdk/models/operations/bulkupdatelinks_response.rb +1 -1
  11. data/lib/open_api_sdk/models/operations/color.rb +2 -1
  12. data/lib/open_api_sdk/models/operations/createdomain_requestbody.rb +3 -9
  13. data/lib/open_api_sdk/models/operations/createdomain_response.rb +1 -1
  14. data/lib/open_api_sdk/models/operations/createlink_requestbody.rb +12 -44
  15. data/lib/open_api_sdk/models/operations/createlink_response.rb +1 -1
  16. data/lib/open_api_sdk/models/operations/createtag_requestbody.rb +1 -1
  17. data/lib/open_api_sdk/models/operations/createtag_response.rb +1 -1
  18. data/lib/open_api_sdk/models/operations/data.rb +11 -43
  19. data/lib/open_api_sdk/models/operations/deletedomain_request.rb +1 -1
  20. data/lib/open_api_sdk/models/operations/deletedomain_response.rb +1 -1
  21. data/lib/open_api_sdk/models/operations/deletedomain_responsebody.rb +1 -1
  22. data/lib/open_api_sdk/models/operations/deletelink_request.rb +1 -1
  23. data/lib/open_api_sdk/models/operations/deletelink_response.rb +2 -2
  24. data/lib/open_api_sdk/models/operations/deletelink_responsebody.rb +2 -2
  25. data/lib/open_api_sdk/models/operations/event.rb +3 -2
  26. data/lib/open_api_sdk/models/operations/getlinkinfo_request.rb +2 -2
  27. data/lib/open_api_sdk/models/operations/getlinkinfo_response.rb +1 -1
  28. data/lib/open_api_sdk/models/operations/getlinks_request.rb +8 -20
  29. data/lib/open_api_sdk/models/operations/getlinks_response.rb +1 -1
  30. data/lib/open_api_sdk/models/operations/getlinkscount_request.rb +5 -8
  31. data/lib/open_api_sdk/models/operations/getlinkscount_response.rb +1 -1
  32. data/lib/open_api_sdk/models/operations/getmetatags_request.rb +1 -1
  33. data/lib/open_api_sdk/models/operations/getmetatags_response.rb +1 -1
  34. data/lib/open_api_sdk/models/operations/getmetatags_responsebody.rb +1 -1
  35. data/lib/open_api_sdk/models/operations/getqrcode_request.rb +4 -13
  36. data/lib/open_api_sdk/models/operations/getqrcode_response.rb +1 -1
  37. data/lib/open_api_sdk/models/operations/gettags_response.rb +1 -1
  38. data/lib/open_api_sdk/models/operations/getworkspace_request.rb +1 -1
  39. data/lib/open_api_sdk/models/operations/getworkspace_response.rb +1 -1
  40. data/lib/open_api_sdk/models/operations/groupby.rb +4 -7
  41. data/lib/open_api_sdk/models/operations/interval.rb +3 -2
  42. data/lib/open_api_sdk/models/operations/level.rb +2 -1
  43. data/lib/open_api_sdk/models/operations/listdomains_response.rb +1 -1
  44. data/lib/open_api_sdk/models/operations/paymentprocessor.rb +2 -1
  45. data/lib/open_api_sdk/models/operations/requestbody.rb +12 -44
  46. data/lib/open_api_sdk/models/operations/retrieveanalytics_request.rb +10 -25
  47. data/lib/open_api_sdk/models/operations/retrieveanalytics_response.rb +1 -1
  48. data/lib/open_api_sdk/models/operations/sort.rb +3 -5
  49. data/lib/open_api_sdk/models/operations/trackcustomer_requestbody.rb +33 -0
  50. data/lib/open_api_sdk/models/operations/{getcustomer_response.rb → trackcustomer_response.rb} +5 -5
  51. data/lib/open_api_sdk/models/operations/trackcustomer_responsebody.rb +33 -0
  52. data/lib/open_api_sdk/models/operations/tracklead_requestbody.rb +7 -12
  53. data/lib/open_api_sdk/models/operations/tracklead_response.rb +1 -1
  54. data/lib/open_api_sdk/models/operations/tracklead_responsebody.rb +22 -7
  55. data/lib/open_api_sdk/models/operations/tracksale_requestbody.rb +6 -11
  56. data/lib/open_api_sdk/models/operations/tracksale_response.rb +1 -1
  57. data/lib/open_api_sdk/models/operations/tracksale_responsebody.rb +19 -7
  58. data/lib/open_api_sdk/models/operations/updatedomain_request.rb +1 -1
  59. data/lib/open_api_sdk/models/operations/updatedomain_requestbody.rb +3 -9
  60. data/lib/open_api_sdk/models/operations/updatedomain_response.rb +1 -1
  61. data/lib/open_api_sdk/models/operations/updatelink_request.rb +1 -1
  62. data/lib/open_api_sdk/models/operations/updatelink_requestbody.rb +13 -45
  63. data/lib/open_api_sdk/models/operations/updatelink_response.rb +1 -1
  64. data/lib/open_api_sdk/models/operations/updatetag_color.rb +2 -1
  65. data/lib/open_api_sdk/models/operations/updatetag_request.rb +1 -1
  66. data/lib/open_api_sdk/models/operations/updatetag_requestbody.rb +1 -1
  67. data/lib/open_api_sdk/models/operations/updatetag_response.rb +1 -1
  68. data/lib/open_api_sdk/models/operations/updateworkspace_request.rb +1 -1
  69. data/lib/open_api_sdk/models/operations/updateworkspace_requestbody.rb +3 -6
  70. data/lib/open_api_sdk/models/operations/updateworkspace_response.rb +1 -1
  71. data/lib/open_api_sdk/models/operations/upsertlink_requestbody.rb +12 -44
  72. data/lib/open_api_sdk/models/operations/upsertlink_response.rb +1 -1
  73. data/lib/open_api_sdk/models/operations.rb +22 -80
  74. data/lib/open_api_sdk/models/shared/badrequest.rb +2 -2
  75. data/lib/open_api_sdk/models/shared/code.rb +2 -1
  76. data/lib/open_api_sdk/models/shared/color.rb +2 -1
  77. data/lib/open_api_sdk/models/shared/conflict.rb +2 -2
  78. data/lib/open_api_sdk/models/shared/conflict_code.rb +2 -1
  79. data/lib/open_api_sdk/models/shared/conflict_error.rb +1 -1
  80. data/lib/open_api_sdk/models/shared/countrycode.rb +2 -1
  81. data/lib/open_api_sdk/models/shared/domains.rb +3 -6
  82. data/lib/open_api_sdk/models/shared/domainschema.rb +3 -12
  83. data/lib/open_api_sdk/models/shared/error.rb +1 -1
  84. data/lib/open_api_sdk/models/shared/forbidden.rb +2 -2
  85. data/lib/open_api_sdk/models/shared/forbidden_code.rb +2 -1
  86. data/lib/open_api_sdk/models/shared/forbidden_error.rb +1 -1
  87. data/lib/open_api_sdk/models/shared/geo.rb +1 -1
  88. data/lib/open_api_sdk/models/shared/internalservererror.rb +2 -2
  89. data/lib/open_api_sdk/models/shared/internalservererror_code.rb +2 -1
  90. data/lib/open_api_sdk/models/shared/internalservererror_error.rb +1 -1
  91. data/lib/open_api_sdk/models/shared/inviteexpired.rb +2 -2
  92. data/lib/open_api_sdk/models/shared/inviteexpired_code.rb +2 -1
  93. data/lib/open_api_sdk/models/shared/inviteexpired_error.rb +1 -1
  94. data/lib/open_api_sdk/models/shared/linkgeotargeting.rb +1 -1
  95. data/lib/open_api_sdk/models/shared/linkschema.rb +7 -22
  96. data/lib/open_api_sdk/models/shared/notfound.rb +2 -2
  97. data/lib/open_api_sdk/models/shared/notfound_code.rb +2 -1
  98. data/lib/open_api_sdk/models/shared/notfound_error.rb +1 -1
  99. data/lib/open_api_sdk/models/shared/plan.rb +2 -1
  100. data/lib/open_api_sdk/models/shared/ratelimitexceeded.rb +2 -2
  101. data/lib/open_api_sdk/models/shared/ratelimitexceeded_code.rb +2 -1
  102. data/lib/open_api_sdk/models/shared/ratelimitexceeded_error.rb +1 -1
  103. data/lib/open_api_sdk/models/shared/role.rb +2 -1
  104. data/lib/open_api_sdk/models/shared/security.rb +3 -3
  105. data/lib/open_api_sdk/models/shared/tagschema.rb +1 -1
  106. data/lib/open_api_sdk/models/shared/unauthorized.rb +2 -2
  107. data/lib/open_api_sdk/models/shared/unauthorized_code.rb +2 -1
  108. data/lib/open_api_sdk/models/shared/unauthorized_error.rb +1 -1
  109. data/lib/open_api_sdk/models/shared/unprocessableentity.rb +2 -2
  110. data/lib/open_api_sdk/models/shared/unprocessableentity_code.rb +2 -1
  111. data/lib/open_api_sdk/models/shared/unprocessableentity_error.rb +1 -1
  112. data/lib/open_api_sdk/models/shared/users.rb +1 -1
  113. data/lib/open_api_sdk/models/shared/workspaceschema.rb +7 -34
  114. data/lib/open_api_sdk/models/shared.rb +2 -9
  115. data/lib/open_api_sdk/qr_codes.rb +2 -2
  116. data/lib/open_api_sdk/sdkconfiguration.rb +4 -4
  117. data/lib/open_api_sdk/tags.rb +28 -113
  118. data/lib/open_api_sdk/track.rb +85 -2
  119. data/lib/open_api_sdk/utils/metadata_fields.rb +1 -1
  120. data/lib/open_api_sdk/utils/t.rb +1 -1
  121. data/lib/open_api_sdk/utils/utils.rb +5 -4
  122. data/lib/open_api_sdk/workspaces.rb +1 -3
  123. metadata +13 -81
  124. data/lib/open_api_sdk/customers.rb +0 -445
  125. data/lib/open_api_sdk/embed_tokens.rb +0 -107
  126. data/lib/open_api_sdk/events.rb +0 -100
  127. data/lib/open_api_sdk/models/operations/bulkdeletelinks_request.rb +0 -24
  128. data/lib/open_api_sdk/models/operations/bulkdeletelinks_response.rb +0 -60
  129. data/lib/open_api_sdk/models/operations/bulkdeletelinks_responsebody.rb +0 -24
  130. data/lib/open_api_sdk/models/operations/click.rb +0 -24
  131. data/lib/open_api_sdk/models/operations/createcustomer_discount.rb +0 -42
  132. data/lib/open_api_sdk/models/operations/createcustomer_interval.rb +0 -18
  133. data/lib/open_api_sdk/models/operations/createcustomer_link.rb +0 -36
  134. data/lib/open_api_sdk/models/operations/createcustomer_partner.rb +0 -33
  135. data/lib/open_api_sdk/models/operations/createcustomer_requestbody.rb +0 -33
  136. data/lib/open_api_sdk/models/operations/createcustomer_response.rb +0 -60
  137. data/lib/open_api_sdk/models/operations/createcustomer_responsebody.rb +0 -51
  138. data/lib/open_api_sdk/models/operations/createcustomer_type.rb +0 -18
  139. data/lib/open_api_sdk/models/operations/createembedtoken_requestbody.rb +0 -24
  140. data/lib/open_api_sdk/models/operations/createembedtoken_response.rb +0 -60
  141. data/lib/open_api_sdk/models/operations/createembedtoken_responsebody.rb +0 -27
  142. data/lib/open_api_sdk/models/operations/customer.rb +0 -33
  143. data/lib/open_api_sdk/models/operations/deletecustomer_request.rb +0 -24
  144. data/lib/open_api_sdk/models/operations/deletecustomer_response.rb +0 -60
  145. data/lib/open_api_sdk/models/operations/deletecustomer_responsebody.rb +0 -24
  146. data/lib/open_api_sdk/models/operations/deletetag_request.rb +0 -24
  147. data/lib/open_api_sdk/models/operations/deletetag_response.rb +0 -60
  148. data/lib/open_api_sdk/models/operations/deletetag_responsebody.rb +0 -24
  149. data/lib/open_api_sdk/models/operations/discount.rb +0 -42
  150. data/lib/open_api_sdk/models/operations/getcustomer_discount.rb +0 -42
  151. data/lib/open_api_sdk/models/operations/getcustomer_interval.rb +0 -18
  152. data/lib/open_api_sdk/models/operations/getcustomer_link.rb +0 -36
  153. data/lib/open_api_sdk/models/operations/getcustomer_partner.rb +0 -33
  154. data/lib/open_api_sdk/models/operations/getcustomer_request.rb +0 -27
  155. data/lib/open_api_sdk/models/operations/getcustomer_responsebody.rb +0 -51
  156. data/lib/open_api_sdk/models/operations/getcustomer_type.rb +0 -18
  157. data/lib/open_api_sdk/models/operations/getcustomers_interval.rb +0 -18
  158. data/lib/open_api_sdk/models/operations/getcustomers_request.rb +0 -30
  159. data/lib/open_api_sdk/models/operations/getcustomers_response.rb +0 -60
  160. data/lib/open_api_sdk/models/operations/link.rb +0 -36
  161. data/lib/open_api_sdk/models/operations/listdomains_request.rb +0 -33
  162. data/lib/open_api_sdk/models/operations/listevents_request.rb +0 -108
  163. data/lib/open_api_sdk/models/operations/listevents_response.rb +0 -60
  164. data/lib/open_api_sdk/models/operations/order.rb +0 -20
  165. data/lib/open_api_sdk/models/operations/partner.rb +0 -33
  166. data/lib/open_api_sdk/models/operations/queryparam_event.rb +0 -19
  167. data/lib/open_api_sdk/models/operations/queryparam_interval.rb +0 -23
  168. data/lib/open_api_sdk/models/operations/queryparam_sortby.rb +0 -17
  169. data/lib/open_api_sdk/models/operations/queryparam_sortorder.rb +0 -18
  170. data/lib/open_api_sdk/models/operations/queryparam_trigger.rb +0 -18
  171. data/lib/open_api_sdk/models/operations/responsebody.rb +0 -51
  172. data/lib/open_api_sdk/models/operations/sale.rb +0 -36
  173. data/lib/open_api_sdk/models/operations/sortby.rb +0 -20
  174. data/lib/open_api_sdk/models/operations/sortorder.rb +0 -18
  175. data/lib/open_api_sdk/models/operations/tracksale_customer.rb +0 -36
  176. data/lib/open_api_sdk/models/operations/trigger.rb +0 -18
  177. data/lib/open_api_sdk/models/operations/type.rb +0 -18
  178. data/lib/open_api_sdk/models/operations/updatecustomer_discount.rb +0 -42
  179. data/lib/open_api_sdk/models/operations/updatecustomer_interval.rb +0 -18
  180. data/lib/open_api_sdk/models/operations/updatecustomer_link.rb +0 -36
  181. data/lib/open_api_sdk/models/operations/updatecustomer_partner.rb +0 -33
  182. data/lib/open_api_sdk/models/operations/updatecustomer_request.rb +0 -30
  183. data/lib/open_api_sdk/models/operations/updatecustomer_requestbody.rb +0 -33
  184. data/lib/open_api_sdk/models/operations/updatecustomer_response.rb +0 -60
  185. data/lib/open_api_sdk/models/operations/updatecustomer_responsebody.rb +0 -51
  186. data/lib/open_api_sdk/models/operations/updatecustomer_type.rb +0 -18
  187. data/lib/open_api_sdk/models/shared/click.rb +0 -60
  188. data/lib/open_api_sdk/models/shared/clickevent.rb +0 -98
  189. data/lib/open_api_sdk/models/shared/clickevent_geo.rb +0 -771
  190. data/lib/open_api_sdk/models/shared/continentcode.rb +0 -23
  191. data/lib/open_api_sdk/models/shared/event.rb +0 -17
  192. data/lib/open_api_sdk/models/shared/link.rb +0 -157
  193. data/lib/open_api_sdk/models/shared/registereddomain.rb +0 -30
@@ -1,4 +1,4 @@
1
- # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
1
+ # Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
2
2
 
3
3
  # typed: true
4
4
  # frozen_string_literal: true
@@ -15,11 +15,11 @@ module OpenApiSDK
15
15
  field :url, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('url') } }
16
16
  # The Android destination URL for the short link for Android device targeting.
17
17
  field :android, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('android') } }
18
- # Whether the short link is archived. Defaults to `false` if not provided.
18
+ # Whether the short link is archived.
19
19
  field :archived, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('archived') } }
20
20
  # The comments for the short link.
21
21
  field :comments, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('comments') } }
22
- # The custom link preview description (og:description). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
22
+ # The description of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
23
23
  field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description') } }
24
24
  # Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex
25
25
  field :do_index, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('doIndex') } }
@@ -29,11 +29,11 @@ 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
- # 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.
32
+ # This is the ID of the link in your database. If set, it can be used to identify the link in the future. Must be prefixed with `ext_` when passed as a query parameter.
33
33
  field :external_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
34
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') } }
36
- # The custom link preview image (og:image). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
36
+ # The image of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
37
37
  field :image, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
38
38
  # The iOS destination URL for the short link for iOS device targeting.
39
39
  field :ios, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ios') } }
@@ -43,17 +43,11 @@ module OpenApiSDK
43
43
  field :password, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('password') } }
44
44
  # The prefix of the short link slug for randomly-generated keys (e.g. if prefix is `/c/`, generated keys will be in the `/c/:key` format). Will be ignored if `key` is provided.
45
45
  field :prefix, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('prefix') } }
46
- # The ID of the program the short link is associated with.
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. Defaults to `false` if not provided.
46
+ # Whether the short link uses Custom Social Media Cards feature.
49
47
  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. Defaults to `false` if not provided.
51
- #
52
- # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
48
+ # Whether the short link's stats are publicly accessible.
53
49
  field :public_stats, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('publicStats') } }
54
- # The referral tag of the short link. If set, this will populate or override the `ref` query parameter in the destination URL.
55
- field :ref, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ref') } }
56
- # Whether the short link uses link cloaking. Defaults to `false` if not provided.
50
+ # Whether the short link uses link cloaking.
57
51
  field :rewrite, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('rewrite') } }
58
52
  # The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead.
59
53
  #
@@ -63,30 +57,14 @@ module OpenApiSDK
63
57
  field :tag_ids, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagIds') } }
64
58
  # The unique name of the tags assigned to the short link (case insensitive).
65
59
  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') } }
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
60
+ # The title of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
69
61
  field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
70
- # Whether to track conversions for the short link. Defaults to `false` if not provided.
62
+ # Whether to track conversions for the short link.
71
63
  field :track_conversion, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trackConversion') } }
72
- # The UTM campaign of the short link. If set, this will populate or override the UTM campaign in the destination URL.
73
- field :utm_campaign, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_campaign') } }
74
- # The UTM content of the short link. If set, this will populate or override the UTM content in the destination URL.
75
- field :utm_content, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_content') } }
76
- # The UTM medium of the short link. If set, this will populate or override the UTM medium in the destination URL.
77
- field :utm_medium, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_medium') } }
78
- # The UTM source of the short link. If set, this will populate or override the UTM source in the destination URL.
79
- field :utm_source, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_source') } }
80
- # The UTM term of the short link. If set, this will populate or override the UTM term in the destination URL.
81
- field :utm_term, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('utm_term') } }
82
- # The custom link preview video (og:video). Will be used for Custom Social Media Cards if `proxy` is true. Learn more: https://d.to/og
83
- field :video, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('video') } }
84
- # An array of webhook IDs to trigger when the link is clicked. These webhooks will receive click event data.
85
- field :webhook_ids, T.nilable(T::Array[::String]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('webhookIds') } }
86
64
 
87
65
 
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)
66
+ sig { params(url: ::String, android: T.nilable(::String), archived: T.nilable(T::Boolean), comments: T.nilable(::String), description: T.nilable(::String), do_index: T.nilable(T::Boolean), domain: T.nilable(::String), expired_url: T.nilable(::String), expires_at: T.nilable(::String), external_id: T.nilable(::String), geo: T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), image: T.nilable(::String), ios: T.nilable(::String), key: T.nilable(::String), password: T.nilable(::String), prefix: T.nilable(::String), proxy: T.nilable(T::Boolean), public_stats: T.nilable(T::Boolean), rewrite: T.nilable(T::Boolean), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), tag_names: T.nilable(::Object), title: T.nilable(::String), track_conversion: T.nilable(T::Boolean)).void }
67
+ def initialize(url: nil, android: nil, archived: nil, comments: nil, description: nil, do_index: nil, domain: nil, expired_url: nil, expires_at: nil, external_id: nil, geo: nil, image: nil, ios: nil, key: nil, password: nil, prefix: nil, proxy: nil, public_stats: nil, rewrite: nil, tag_id: nil, tag_ids: nil, tag_names: nil, title: nil, track_conversion: nil)
90
68
  @url = url
91
69
  @android = android
92
70
  @archived = archived
@@ -103,24 +81,14 @@ module OpenApiSDK
103
81
  @key = key
104
82
  @password = password
105
83
  @prefix = prefix
106
- @program_id = program_id
107
84
  @proxy = proxy
108
85
  @public_stats = public_stats
109
- @ref = ref
110
86
  @rewrite = rewrite
111
87
  @tag_id = tag_id
112
88
  @tag_ids = tag_ids
113
89
  @tag_names = tag_names
114
- @tenant_id = tenant_id
115
90
  @title = title
116
91
  @track_conversion = track_conversion
117
- @utm_campaign = utm_campaign
118
- @utm_content = utm_content
119
- @utm_medium = utm_medium
120
- @utm_source = utm_source
121
- @utm_term = utm_term
122
- @video = video
123
- @webhook_ids = webhook_ids
124
92
  end
125
93
  end
126
94
  end
@@ -1,4 +1,4 @@
1
- # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
1
+ # Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
2
2
 
3
3
  # typed: true
4
4
  # frozen_string_literal: true
@@ -15,23 +15,21 @@ module OpenApiSDK
15
15
  field :browser, T.nilable(::String), { 'query_param': { 'field_name': 'browser', 'style': 'form', 'explode': true } }
16
16
  # The city to retrieve analytics for.
17
17
  field :city, T.nilable(::String), { 'query_param': { 'field_name': 'city', 'style': 'form', 'explode': true } }
18
- # The continent to retrieve analytics for.
19
- field :continent, T.nilable(::OpenApiSDK::Shared::ContinentCode), { 'query_param': { 'field_name': 'continent', 'style': 'form', 'explode': true } }
20
18
  # The country to retrieve analytics for.
21
19
  field :country, T.nilable(::OpenApiSDK::Shared::CountryCode), { 'query_param': { 'field_name': 'country', 'style': 'form', 'explode': true } }
22
20
  # The device to retrieve analytics for.
23
21
  field :device, T.nilable(::String), { 'query_param': { 'field_name': 'device', 'style': 'form', 'explode': true } }
24
22
  # The domain to filter analytics for.
25
23
  field :domain, T.nilable(::String), { 'query_param': { 'field_name': 'domain', 'style': 'form', 'explode': true } }
26
- # The end date and time when to retrieve analytics from. If not provided, defaults to the current date. Takes precedence over `interval`.
24
+ # The end date and time when to retrieve analytics from. If not provided, defaults to the current date.
27
25
  field :end_, T.nilable(::String), { 'query_param': { 'field_name': 'end', 'style': 'form', 'explode': true } }
28
- # The type of event to retrieve analytics for. Defaults to `clicks`.
26
+ # The type of event to retrieve analytics for. Defaults to 'clicks'.
29
27
  field :event, T.nilable(::OpenApiSDK::Operations::Event), { 'query_param': { 'field_name': 'event', 'style': 'form', 'explode': true } }
30
28
  # This is the ID of the link in the your database. Must be prefixed with 'ext_' when passed as a query parameter.
31
29
  field :external_id, T.nilable(::String), { 'query_param': { 'field_name': 'externalId', 'style': 'form', 'explode': true } }
32
- # The parameter to group the analytics data points by. Defaults to `count` if undefined. Note that `trigger` is deprecated (use `triggers` instead), but kept for backwards compatibility.
30
+ # The parameter to group the analytics data points by. Defaults to 'count' if undefined.
33
31
  field :group_by, T.nilable(::OpenApiSDK::Operations::GroupBy), { 'query_param': { 'field_name': 'groupBy', 'style': 'form', 'explode': true } }
34
- # The interval to retrieve analytics for. If undefined, defaults to 24h.
32
+ # The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
35
33
  field :interval, T.nilable(::OpenApiSDK::Operations::Interval), { 'query_param': { 'field_name': 'interval', 'style': 'form', 'explode': true } }
36
34
  # The short link slug.
37
35
  field :key, T.nilable(::String), { 'query_param': { 'field_name': 'key', 'style': 'form', 'explode': true } }
@@ -39,35 +37,26 @@ module OpenApiSDK
39
37
  field :link_id, T.nilable(::String), { 'query_param': { 'field_name': 'linkId', 'style': 'form', 'explode': true } }
40
38
  # The OS to retrieve analytics for.
41
39
  field :os, T.nilable(::String), { 'query_param': { 'field_name': 'os', 'style': 'form', 'explode': true } }
42
- # Deprecated. Use the `trigger` field instead. Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.
40
+ # Filter for QR code scans. If true, filter for QR codes only. If false, filter for links only. If undefined, return both.
43
41
  field :qr, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'qr', 'style': 'form', 'explode': true } }
44
42
  # The referer to retrieve analytics for.
45
43
  field :referer, T.nilable(::String), { 'query_param': { 'field_name': 'referer', 'style': 'form', 'explode': true } }
46
- # The full referer URL to retrieve analytics for.
47
- field :referer_url, T.nilable(::String), { 'query_param': { 'field_name': 'refererUrl', 'style': 'form', 'explode': true } }
48
- # The ISO 3166-2 region code to retrieve analytics for.
49
- field :region, T.nilable(::String), { 'query_param': { 'field_name': 'region', 'style': 'form', 'explode': true } }
50
44
  # Filter for root domains. If true, filter for domains only. If false, filter for links only. If undefined, return both.
51
45
  field :root, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'root', 'style': 'form', 'explode': true } }
52
- # The start date and time when to retrieve analytics from. Takes precedence over `interval`.
46
+ # The start date and time when to retrieve analytics from.
53
47
  field :start, T.nilable(::String), { 'query_param': { 'field_name': 'start', 'style': 'form', 'explode': true } }
54
- # Deprecated. Use `tagIds` instead. The tag ID to retrieve analytics for.
48
+ # The tag ID to retrieve analytics for.
55
49
  field :tag_id, T.nilable(::String), { 'query_param': { 'field_name': 'tagId', 'style': 'form', 'explode': true } }
56
- # The tag IDs to retrieve analytics for.
57
- field :tag_ids, T.nilable(::Object), { 'query_param': { 'field_name': 'tagIds', 'style': 'form', 'explode': true } }
58
50
  # The IANA time zone code for aligning timeseries granularity (e.g. America/New_York). Defaults to UTC.
59
51
  field :timezone, T.nilable(::String), { 'query_param': { 'field_name': 'timezone', 'style': 'form', 'explode': true } }
60
- # The trigger to retrieve analytics for. If undefined, return both QR and link clicks.
61
- field :trigger, T.nilable(::OpenApiSDK::Operations::Trigger), { 'query_param': { 'field_name': 'trigger', 'style': 'form', 'explode': true } }
62
52
  # The URL to retrieve analytics for.
63
53
  field :url, T.nilable(::String), { 'query_param': { 'field_name': 'url', 'style': 'form', 'explode': true } }
64
54
 
65
55
 
66
- 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::Event), external_id: T.nilable(::String), group_by: T.nilable(::OpenApiSDK::Operations::GroupBy), interval: T.nilable(::OpenApiSDK::Operations::Interval), key: T.nilable(::String), link_id: T.nilable(::String), os: T.nilable(::String), qr: T.nilable(T::Boolean), referer: T.nilable(::String), referer_url: T.nilable(::String), region: T.nilable(::String), root: T.nilable(T::Boolean), start: T.nilable(::String), tag_id: T.nilable(::String), tag_ids: T.nilable(::Object), timezone: T.nilable(::String), trigger: T.nilable(::OpenApiSDK::Operations::Trigger), url: T.nilable(::String)).void }
67
- def initialize(browser: nil, city: nil, continent: nil, country: nil, device: nil, domain: nil, end_: nil, event: nil, external_id: nil, group_by: nil, interval: nil, key: nil, link_id: nil, os: nil, qr: nil, referer: nil, referer_url: nil, region: nil, root: nil, start: nil, tag_id: nil, tag_ids: nil, timezone: nil, trigger: nil, url: nil)
56
+ sig { params(browser: T.nilable(::String), city: T.nilable(::String), country: T.nilable(::OpenApiSDK::Shared::CountryCode), device: T.nilable(::String), domain: T.nilable(::String), end_: T.nilable(::String), event: T.nilable(::OpenApiSDK::Operations::Event), external_id: T.nilable(::String), group_by: T.nilable(::OpenApiSDK::Operations::GroupBy), interval: T.nilable(::OpenApiSDK::Operations::Interval), key: T.nilable(::String), link_id: T.nilable(::String), os: T.nilable(::String), qr: T.nilable(T::Boolean), referer: T.nilable(::String), root: T.nilable(T::Boolean), start: T.nilable(::String), tag_id: T.nilable(::String), timezone: T.nilable(::String), url: T.nilable(::String)).void }
57
+ def initialize(browser: nil, city: nil, country: nil, device: nil, domain: nil, end_: nil, event: nil, external_id: nil, group_by: nil, interval: nil, key: nil, link_id: nil, os: nil, qr: nil, referer: nil, root: nil, start: nil, tag_id: nil, timezone: nil, url: nil)
68
58
  @browser = browser
69
59
  @city = city
70
- @continent = continent
71
60
  @country = country
72
61
  @device = device
73
62
  @domain = domain
@@ -81,14 +70,10 @@ module OpenApiSDK
81
70
  @os = os
82
71
  @qr = qr
83
72
  @referer = referer
84
- @referer_url = referer_url
85
- @region = region
86
73
  @root = root
87
74
  @start = start
88
75
  @tag_id = tag_id
89
- @tag_ids = tag_ids
90
76
  @timezone = timezone
91
- @trigger = trigger
92
77
  @url = url
93
78
  end
94
79
  end
@@ -1,4 +1,4 @@
1
- # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
1
+ # Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
2
2
 
3
3
  # typed: true
4
4
  # frozen_string_literal: true
@@ -1,4 +1,4 @@
1
- # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
1
+ # Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
2
2
 
3
3
  # typed: true
4
4
  # frozen_string_literal: true
@@ -7,16 +7,14 @@
7
7
  module OpenApiSDK
8
8
  module Operations
9
9
 
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.
10
+ # Sort - The field to sort the links by. The default is `createdAt`, and sort order is always descending.
13
11
  class Sort < T::Enum
14
12
  enums do
15
13
  CREATED_AT = new('createdAt')
16
14
  CLICKS = new('clicks')
17
- SALE_AMOUNT = new('saleAmount')
18
15
  LAST_CLICKED = new('lastClicked')
19
16
  end
20
17
  end
18
+
21
19
  end
22
20
  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 TrackCustomerRequestBody < ::OpenApiSDK::Utils::FieldAugmented
12
+ extend T::Sig
13
+
14
+ # This is the unique identifier for the customer in the client's app. This is used to track the customer's journey.
15
+ field :customer_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('customerId') } }
16
+ # Avatar of the customer in the client's app.
17
+ field :customer_avatar, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('customerAvatar') } }
18
+ # Email of the customer in the client's app.
19
+ field :customer_email, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('customerEmail') } }
20
+ # Name of the customer in the client's app.
21
+ field :customer_name, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('customerName') } }
22
+
23
+
24
+ sig { params(customer_id: ::String, customer_avatar: T.nilable(::String), customer_email: T.nilable(::String), customer_name: T.nilable(::String)).void }
25
+ def initialize(customer_id: nil, customer_avatar: nil, customer_email: nil, customer_name: nil)
26
+ @customer_id = customer_id
27
+ @customer_avatar = customer_avatar
28
+ @customer_email = customer_email
29
+ @customer_name = customer_name
30
+ end
31
+ end
32
+ end
33
+ end
@@ -1,4 +1,4 @@
1
- # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
1
+ # Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
2
2
 
3
3
  # typed: true
4
4
  # frozen_string_literal: true
@@ -8,7 +8,7 @@ module OpenApiSDK
8
8
  module Operations
9
9
 
10
10
 
11
- class GetCustomerResponse < ::OpenApiSDK::Utils::FieldAugmented
11
+ class TrackCustomerResponse < ::OpenApiSDK::Utils::FieldAugmented
12
12
  extend T::Sig
13
13
 
14
14
  # HTTP response content type for this operation
@@ -29,8 +29,8 @@ module OpenApiSDK
29
29
  field :invite_expired, T.nilable(::OpenApiSDK::Shared::InviteExpired)
30
30
  # The server cannot find the requested resource.
31
31
  field :not_found, T.nilable(::OpenApiSDK::Shared::NotFound)
32
- # The customer object.
33
- field :object, T.nilable(::OpenApiSDK::Operations::GetCustomerResponseBody)
32
+ # A customer was tracked.
33
+ field :object, T.nilable(::OpenApiSDK::Operations::TrackCustomerResponseBody)
34
34
  # The user has sent too many requests in a given amount of time ("rate limiting")
35
35
  field :rate_limit_exceeded, T.nilable(::OpenApiSDK::Shared::RateLimitExceeded)
36
36
  # Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
@@ -39,7 +39,7 @@ 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), not_found: T.nilable(::OpenApiSDK::Shared::NotFound), object: T.nilable(::OpenApiSDK::Operations::GetCustomerResponseBody), rate_limit_exceeded: T.nilable(::OpenApiSDK::Shared::RateLimitExceeded), unauthorized: T.nilable(::OpenApiSDK::Shared::Unauthorized), unprocessable_entity: T.nilable(::OpenApiSDK::Shared::UnprocessableEntity)).void }
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::TrackCustomerResponseBody), rate_limit_exceeded: T.nilable(::OpenApiSDK::Shared::RateLimitExceeded), unauthorized: T.nilable(::OpenApiSDK::Shared::Unauthorized), unprocessable_entity: T.nilable(::OpenApiSDK::Shared::UnprocessableEntity)).void }
43
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
44
  @content_type = content_type
45
45
  @raw_response = raw_response
@@ -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
+ # A customer was tracked.
11
+ class TrackCustomerResponseBody < ::OpenApiSDK::Utils::FieldAugmented
12
+ extend T::Sig
13
+
14
+
15
+ field :customer_avatar, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('customerAvatar') } }
16
+
17
+ field :customer_email, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('customerEmail') } }
18
+
19
+ field :customer_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('customerId') } }
20
+
21
+ field :customer_name, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('customerName') } }
22
+
23
+
24
+ sig { params(customer_avatar: ::String, customer_email: ::String, customer_id: ::String, customer_name: ::String).void }
25
+ def initialize(customer_avatar: nil, customer_email: nil, customer_id: nil, customer_name: nil)
26
+ @customer_avatar = customer_avatar
27
+ @customer_email = customer_email
28
+ @customer_id = customer_id
29
+ @customer_name = customer_name
30
+ end
31
+ end
32
+ end
33
+ end
@@ -1,4 +1,4 @@
1
- # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
1
+ # Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
2
2
 
3
3
  # typed: true
4
4
  # frozen_string_literal: true
@@ -11,35 +11,30 @@ module OpenApiSDK
11
11
  class TrackLeadRequestBody < ::OpenApiSDK::Utils::FieldAugmented
12
12
  extend T::Sig
13
13
 
14
- # The ID of the click in th Dub. You can read this value from `dub_id` cookie.
14
+ # The ID of the click in th Dub. You can read this value from `dclid` cookie.
15
15
  field :click_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('clickId') } }
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') } }
16
18
  # The name of the event to track.
17
19
  field :event_name, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('eventName') } }
18
20
  # Avatar of the customer in the client's app.
19
21
  field :customer_avatar, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('customerAvatar') } }
20
22
  # Email of the customer in the client's app.
21
23
  field :customer_email, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('customerEmail') } }
22
- # This is the unique identifier for the customer in the client's app. This is used to track the customer's journey.
23
- #
24
- # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
25
- field :customer_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('customerId') } }
26
24
  # Name of the customer in the client's app.
27
25
  field :customer_name, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('customerName') } }
28
- # This is the unique identifier for the customer in the client's app. This is used to track the customer's journey.
29
- field :external_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
30
26
  # Additional metadata to be stored with the lead event
31
27
  field :metadata, T.nilable(T::Hash[Symbol, ::Object]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('metadata') } }
32
28
 
33
29
 
34
- sig { params(click_id: ::String, event_name: ::String, customer_avatar: T.nilable(::String), customer_email: T.nilable(::String), customer_id: T.nilable(::String), customer_name: T.nilable(::String), external_id: T.nilable(::String), metadata: T.nilable(T::Hash[Symbol, ::Object])).void }
35
- def initialize(click_id: nil, event_name: nil, customer_avatar: nil, customer_email: nil, customer_id: nil, customer_name: nil, external_id: nil, metadata: nil)
30
+ sig { params(click_id: ::String, customer_id: ::String, event_name: ::String, customer_avatar: T.nilable(::String), customer_email: T.nilable(::String), customer_name: T.nilable(::String), metadata: T.nilable(T::Hash[Symbol, ::Object])).void }
31
+ def initialize(click_id: nil, customer_id: nil, event_name: nil, customer_avatar: nil, customer_email: nil, customer_name: nil, metadata: nil)
36
32
  @click_id = click_id
33
+ @customer_id = customer_id
37
34
  @event_name = event_name
38
35
  @customer_avatar = customer_avatar
39
36
  @customer_email = customer_email
40
- @customer_id = customer_id
41
37
  @customer_name = customer_name
42
- @external_id = external_id
43
38
  @metadata = metadata
44
39
  end
45
40
  end
@@ -1,4 +1,4 @@
1
- # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
1
+ # Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
2
2
 
3
3
  # typed: true
4
4
  # frozen_string_literal: true
@@ -1,4 +1,4 @@
1
- # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
1
+ # Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
2
2
 
3
3
  # typed: true
4
4
  # frozen_string_literal: true
@@ -12,15 +12,30 @@ module OpenApiSDK
12
12
  extend T::Sig
13
13
 
14
14
 
15
- field :click, ::OpenApiSDK::Operations::Click, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('click') } }
15
+ field :click_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('clickId') } }
16
16
 
17
- field :customer, ::OpenApiSDK::Operations::Customer, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('customer') } }
17
+ field :customer_avatar, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('customerAvatar') } }
18
18
 
19
+ field :customer_email, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('customerEmail') } }
19
20
 
20
- sig { params(click: ::OpenApiSDK::Operations::Click, customer: ::OpenApiSDK::Operations::Customer).void }
21
- def initialize(click: nil, customer: nil)
22
- @click = click
23
- @customer = customer
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
24
39
  end
25
40
  end
26
41
  end
@@ -1,4 +1,4 @@
1
- # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
1
+ # Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
2
2
 
3
3
  # typed: true
4
4
  # frozen_string_literal: true
@@ -13,32 +13,27 @@ module OpenApiSDK
13
13
 
14
14
  # The amount of the sale. Should be passed in cents.
15
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') } }
16
18
  # The payment processor via which the sale was made.
17
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) } }
18
20
  # The currency of the sale. Accepts ISO 4217 currency codes.
19
21
  field :currency, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('currency') } }
20
- # This is the unique identifier for the customer in the client's app. This is used to track the customer's journey.
21
- #
22
- # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
23
- field :customer_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('customerId') } }
24
22
  # The name of the sale event. It can be used to track different types of event for example 'Purchase', 'Upgrade', 'Payment', etc.
25
23
  field :event_name, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('eventName') } }
26
- # This is the unique identifier for the customer in the client's app. This is used to track the customer's journey.
27
- field :external_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
28
24
  # The invoice ID of the sale.
29
25
  field :invoice_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('invoiceId') } }
30
26
  # Additional metadata to be stored with the sale event.
31
27
  field :metadata, T.nilable(T::Hash[Symbol, ::Object]), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('metadata') } }
32
28
 
33
29
 
34
- sig { params(amount: ::Integer, payment_processor: ::OpenApiSDK::Operations::PaymentProcessor, currency: T.nilable(::String), customer_id: T.nilable(::String), event_name: T.nilable(::String), external_id: T.nilable(::String), invoice_id: T.nilable(::String), metadata: T.nilable(T::Hash[Symbol, ::Object])).void }
35
- def initialize(amount: nil, payment_processor: nil, currency: nil, customer_id: nil, event_name: nil, external_id: nil, invoice_id: nil, metadata: nil)
30
+ sig { params(amount: ::Integer, customer_id: ::String, payment_processor: ::OpenApiSDK::Operations::PaymentProcessor, currency: T.nilable(::String), event_name: T.nilable(::String), invoice_id: T.nilable(::String), metadata: T.nilable(T::Hash[Symbol, ::Object])).void }
31
+ def initialize(amount: nil, customer_id: nil, payment_processor: nil, currency: nil, event_name: nil, invoice_id: nil, metadata: nil)
36
32
  @amount = amount
33
+ @customer_id = customer_id
37
34
  @payment_processor = payment_processor
38
35
  @currency = currency
39
- @customer_id = customer_id
40
36
  @event_name = event_name
41
- @external_id = external_id
42
37
  @invoice_id = invoice_id
43
38
  @metadata = metadata
44
39
  end
@@ -1,4 +1,4 @@
1
- # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
1
+ # Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
2
2
 
3
3
  # typed: true
4
4
  # frozen_string_literal: true
@@ -1,4 +1,4 @@
1
- # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
1
+ # Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
2
2
 
3
3
  # typed: true
4
4
  # frozen_string_literal: true
@@ -12,18 +12,30 @@ module OpenApiSDK
12
12
  extend T::Sig
13
13
 
14
14
 
15
- field :customer, ::OpenApiSDK::Operations::TrackSaleCustomer, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('customer') } }
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') } }
16
20
 
17
21
  field :event_name, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('eventName') } }
18
22
 
19
- field :sale, ::OpenApiSDK::Operations::Sale, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('sale') } }
23
+ field :invoice_id, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('invoiceId') } }
24
+
25
+ field :metadata, T::Hash[Symbol, ::Object], { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('metadata') } }
26
+
27
+ field :payment_processor, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('paymentProcessor') } }
20
28
 
21
29
 
22
- sig { params(customer: ::OpenApiSDK::Operations::TrackSaleCustomer, event_name: ::String, sale: ::OpenApiSDK::Operations::Sale).void }
23
- def initialize(customer: nil, event_name: nil, sale: nil)
24
- @customer = customer
30
+ sig { params(amount: ::Float, currency: ::String, customer_id: ::String, event_name: ::String, invoice_id: ::String, metadata: T::Hash[Symbol, ::Object], payment_processor: ::String).void }
31
+ def initialize(amount: nil, currency: nil, customer_id: nil, event_name: nil, invoice_id: nil, metadata: nil, payment_processor: nil)
32
+ @amount = amount
33
+ @currency = currency
34
+ @customer_id = customer_id
25
35
  @event_name = event_name
26
- @sale = sale
36
+ @invoice_id = invoice_id
37
+ @metadata = metadata
38
+ @payment_processor = payment_processor
27
39
  end
28
40
  end
29
41
  end
@@ -1,4 +1,4 @@
1
- # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
1
+ # Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
2
2
 
3
3
  # typed: true
4
4
  # frozen_string_literal: true
@@ -1,4 +1,4 @@
1
- # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
1
+ # Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
2
2
 
3
3
  # typed: true
4
4
  # frozen_string_literal: true
@@ -15,22 +15,16 @@ module OpenApiSDK
15
15
  field :archived, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('archived') } }
16
16
  # Redirect users to a specific URL when any link under this domain has expired.
17
17
  field :expired_url, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiredUrl') } }
18
- # The logo of the domain.
19
- field :logo, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('logo') } }
20
- # Redirect users to a specific URL when a link under this domain doesn't exist.
21
- field :not_found_url, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('notFoundUrl') } }
22
18
  # Provide context to your teammates in the link creation modal by showing them an example of a link to be shortened.
23
19
  field :placeholder, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('placeholder') } }
24
20
  # Name of the domain.
25
21
  field :slug, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('slug') } }
26
22
 
27
23
 
28
- sig { params(archived: T.nilable(T::Boolean), expired_url: T.nilable(::String), logo: T.nilable(::String), not_found_url: T.nilable(::String), placeholder: T.nilable(::String), slug: T.nilable(::String)).void }
29
- def initialize(archived: nil, expired_url: nil, logo: nil, not_found_url: nil, placeholder: nil, slug: nil)
24
+ sig { params(archived: T.nilable(T::Boolean), expired_url: T.nilable(::String), placeholder: T.nilable(::String), slug: T.nilable(::String)).void }
25
+ def initialize(archived: nil, expired_url: nil, placeholder: nil, slug: nil)
30
26
  @archived = archived
31
27
  @expired_url = expired_url
32
- @logo = logo
33
- @not_found_url = not_found_url
34
28
  @placeholder = placeholder
35
29
  @slug = slug
36
30
  end
@@ -1,4 +1,4 @@
1
- # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
1
+ # Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
2
2
 
3
3
  # typed: true
4
4
  # frozen_string_literal: true
@@ -1,4 +1,4 @@
1
- # Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
1
+ # Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
2
2
 
3
3
  # typed: true
4
4
  # frozen_string_literal: true