dub 0.2.2 → 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of dub might be problematic. Click here for more details.

Files changed (277) hide show
  1. data/History.txt +92 -0
  2. data/LICENSE +20 -0
  3. data/README.rdoc +115 -0
  4. data/Rakefile +59 -0
  5. data/dub.gemspec +197 -0
  6. data/lib/dub/argument.rb +286 -0
  7. data/lib/dub/entities_unescape.rb +9 -0
  8. data/lib/dub/function.rb +177 -0
  9. data/lib/dub/function_group.rb +72 -0
  10. data/lib/dub/generator.rb +15 -0
  11. data/lib/dub/group.rb +20 -0
  12. data/lib/dub/klass.rb +338 -0
  13. data/lib/dub/lua/class.cpp.erb +114 -0
  14. data/lib/dub/lua/class_gen.rb +96 -0
  15. data/lib/dub/lua/function.cpp.erb +15 -0
  16. data/lib/dub/lua/function_gen.rb +329 -0
  17. data/lib/dub/lua/group.cpp.erb +9 -0
  18. data/lib/dub/lua/lua_cpp_helper.cpp +259 -0
  19. data/lib/dub/lua/lua_cpp_helper.h +219 -0
  20. data/lib/dub/lua/lua_object.cpp +158 -0
  21. data/lib/dub/lua/lua_object.h +69 -0
  22. data/lib/dub/lua/namespace.cpp.erb +42 -0
  23. data/lib/dub/lua/namespace_gen.rb +69 -0
  24. data/lib/dub/lua.rb +24 -0
  25. data/lib/dub/member_extraction.rb +128 -0
  26. data/lib/dub/namespace.rb +295 -0
  27. data/lib/dub/opts_parser.rb +30 -0
  28. data/lib/dub/parser.rb +46 -0
  29. data/lib/dub/templates/lua_template.erb +21 -0
  30. data/lib/dub/version.rb +3 -0
  31. data/lib/dub.rb +24 -20
  32. data/test/argument_test.rb +581 -0
  33. data/test/fixtures/app/CMakeLists.txt +54 -0
  34. data/test/fixtures/app/Doxyfile +1600 -0
  35. data/test/fixtures/app/bindings/all_lua.cpp +299 -0
  36. data/test/fixtures/app/include/matrix.h +283 -0
  37. data/test/fixtures/app/make_lua_bindings.rb +13 -0
  38. data/test/fixtures/app/vendor/lua/CMakeLists.txt +25 -0
  39. data/test/fixtures/app/vendor/lua/COPYRIGHT +34 -0
  40. data/test/fixtures/app/vendor/lua/HISTORY +183 -0
  41. data/test/fixtures/app/vendor/lua/INSTALL +99 -0
  42. data/test/fixtures/app/vendor/lua/Makefile +183 -0
  43. data/test/fixtures/app/vendor/lua/README +37 -0
  44. data/test/fixtures/app/vendor/lua/lapi.c +1080 -0
  45. data/test/fixtures/app/vendor/lua/lapi.h +16 -0
  46. data/test/fixtures/app/vendor/lua/lauxlib.c +653 -0
  47. data/test/fixtures/app/vendor/lua/lauxlib.h +174 -0
  48. data/test/fixtures/app/vendor/lua/lbaselib.c +643 -0
  49. data/test/fixtures/app/vendor/lua/lcode.c +839 -0
  50. data/test/fixtures/app/vendor/lua/lcode.h +76 -0
  51. data/test/fixtures/app/vendor/lua/ldblib.c +397 -0
  52. data/test/fixtures/app/vendor/lua/ldebug.c +622 -0
  53. data/test/fixtures/app/vendor/lua/ldebug.h +33 -0
  54. data/test/fixtures/app/vendor/lua/ldo.c +516 -0
  55. data/test/fixtures/app/vendor/lua/ldo.h +57 -0
  56. data/test/fixtures/app/vendor/lua/ldump.c +164 -0
  57. data/test/fixtures/app/vendor/lua/lfunc.c +174 -0
  58. data/test/fixtures/app/vendor/lua/lfunc.h +34 -0
  59. data/test/fixtures/app/vendor/lua/lgc.c +711 -0
  60. data/test/fixtures/app/vendor/lua/lgc.h +110 -0
  61. data/test/fixtures/app/vendor/lua/liblua.a +0 -0
  62. data/test/fixtures/app/vendor/lua/linit.c +38 -0
  63. data/test/fixtures/app/vendor/lua/liolib.c +532 -0
  64. data/test/fixtures/app/vendor/lua/llex.c +461 -0
  65. data/test/fixtures/app/vendor/lua/llex.h +81 -0
  66. data/test/fixtures/app/vendor/lua/llimits.h +128 -0
  67. data/test/fixtures/app/vendor/lua/lmathlib.c +263 -0
  68. data/test/fixtures/app/vendor/lua/lmem.c +86 -0
  69. data/test/fixtures/app/vendor/lua/lmem.h +49 -0
  70. data/test/fixtures/app/vendor/lua/loadlib.c +664 -0
  71. data/test/fixtures/app/vendor/lua/lobject.c +214 -0
  72. data/test/fixtures/app/vendor/lua/lobject.h +381 -0
  73. data/test/fixtures/app/vendor/lua/lopcodes.c +102 -0
  74. data/test/fixtures/app/vendor/lua/lopcodes.h +268 -0
  75. data/test/fixtures/app/vendor/lua/loslib.c +244 -0
  76. data/test/fixtures/app/vendor/lua/lparser.c +1337 -0
  77. data/test/fixtures/app/vendor/lua/lparser.h +82 -0
  78. data/test/fixtures/app/vendor/lua/lstate.c +214 -0
  79. data/test/fixtures/app/vendor/lua/lstate.h +168 -0
  80. data/test/fixtures/app/vendor/lua/lstring.c +111 -0
  81. data/test/fixtures/app/vendor/lua/lstring.h +31 -0
  82. data/test/fixtures/app/vendor/lua/lstrlib.c +868 -0
  83. data/test/fixtures/app/vendor/lua/ltable.c +588 -0
  84. data/test/fixtures/app/vendor/lua/ltable.h +40 -0
  85. data/test/fixtures/app/vendor/lua/ltablib.c +278 -0
  86. data/test/fixtures/app/vendor/lua/ltm.c +75 -0
  87. data/test/fixtures/app/vendor/lua/ltm.h +54 -0
  88. data/test/fixtures/app/vendor/lua/lua.c +695 -0
  89. data/test/fixtures/app/vendor/lua/lua.h +385 -0
  90. data/test/fixtures/app/vendor/lua/lua_dub_helper.h +77 -0
  91. data/test/fixtures/app/vendor/lua/luac +0 -0
  92. data/test/fixtures/app/vendor/lua/luac.c +200 -0
  93. data/test/fixtures/app/vendor/lua/luaconf.h +762 -0
  94. data/test/fixtures/app/vendor/lua/lualib.h +53 -0
  95. data/test/fixtures/app/vendor/lua/lundump.c +223 -0
  96. data/test/fixtures/app/vendor/lua/lundump.h +36 -0
  97. data/test/fixtures/app/vendor/lua/lvm.c +765 -0
  98. data/test/fixtures/app/vendor/lua/lvm.h +36 -0
  99. data/test/fixtures/app/vendor/lua/lzio.c +82 -0
  100. data/test/fixtures/app/vendor/lua/lzio.h +67 -0
  101. data/test/fixtures/app/vendor/lua/matrix.h +102 -0
  102. data/test/fixtures/app/vendor/lua/print.c +227 -0
  103. data/test/fixtures/app/vendor/lua/test/README +26 -0
  104. data/test/fixtures/app/vendor/lua/test/bisect.lua +27 -0
  105. data/test/fixtures/app/vendor/lua/test/cf.lua +16 -0
  106. data/test/fixtures/app/vendor/lua/test/echo.lua +5 -0
  107. data/test/fixtures/app/vendor/lua/test/env.lua +7 -0
  108. data/test/fixtures/app/vendor/lua/test/factorial.lua +32 -0
  109. data/test/fixtures/app/vendor/lua/test/fib.lua +40 -0
  110. data/test/fixtures/app/vendor/lua/test/fibfor.lua +13 -0
  111. data/test/fixtures/app/vendor/lua/test/globals.lua +13 -0
  112. data/test/fixtures/app/vendor/lua/test/hello.lua +3 -0
  113. data/test/fixtures/app/vendor/lua/test/life.lua +111 -0
  114. data/test/fixtures/app/vendor/lua/test/luac.lua +7 -0
  115. data/test/fixtures/app/vendor/lua/test/printf.lua +7 -0
  116. data/test/fixtures/app/vendor/lua/test/readonly.lua +12 -0
  117. data/test/fixtures/app/vendor/lua/test/sieve.lua +29 -0
  118. data/test/fixtures/app/vendor/lua/test/sort.lua +66 -0
  119. data/test/fixtures/app/vendor/lua/test/table.lua +12 -0
  120. data/test/fixtures/app/vendor/lua/test/trace-calls.lua +32 -0
  121. data/test/fixtures/app/vendor/lua/test/trace-globals.lua +38 -0
  122. data/test/fixtures/app/vendor/lua/test/xd.lua +14 -0
  123. data/test/fixtures/app/xml/classdub_1_1_base.xml +85 -0
  124. data/test/fixtures/app/xml/classdub_1_1_custom_destructor.xml +67 -0
  125. data/test/fixtures/app/xml/classdub_1_1_deletable_out_of_lua.xml +43 -0
  126. data/test/fixtures/app/xml/classdub_1_1_matrix.xml +482 -0
  127. data/test/fixtures/app/xml/classdub_1_1_no_destructor.xml +49 -0
  128. data/test/fixtures/app/xml/classdub_1_1_priv_sub_base.xml +89 -0
  129. data/test/fixtures/app/xml/classdub_1_1_private_constr.xml +68 -0
  130. data/test/fixtures/app/xml/classdub_1_1_static_constr.xml +69 -0
  131. data/test/fixtures/app/xml/classdub_1_1_sub_base.xml +89 -0
  132. data/test/fixtures/app/xml/classdub_1_1_t_mat.xml +252 -0
  133. data/test/fixtures/app/xml/combine.xslt +15 -0
  134. data/test/fixtures/app/xml/compound.xsd +814 -0
  135. data/test/fixtures/app/xml/dir_53661a2bdeb1d55e60581a7e15deb763.xml +12 -0
  136. data/test/fixtures/app/xml/index.xml +91 -0
  137. data/test/fixtures/app/xml/index.xsd +66 -0
  138. data/test/fixtures/app/xml/matrix_8h.xml +310 -0
  139. data/test/fixtures/app/xml/namespacedub.xml +48 -0
  140. data/test/fixtures/classcv_1_1_mat.xml +1996 -0
  141. data/test/fixtures/classcv_1_1_point__.xml +341 -0
  142. data/test/fixtures/classcv_1_1_scalar__.xml +269 -0
  143. data/test/fixtures/classcv_1_1_size__.xml +270 -0
  144. data/test/fixtures/dummy_class.cpp.erb +1 -0
  145. data/test/fixtures/dummy_function.cpp.erb +1 -0
  146. data/test/fixtures/group___magic_type.xml +406 -0
  147. data/test/fixtures/namespacecv.xml +12659 -0
  148. data/test/function_group_test.rb +43 -0
  149. data/test/function_test.rb +405 -0
  150. data/test/group_test.rb +241 -0
  151. data/test/helper.rb +34 -0
  152. data/test/klass_test.rb +551 -0
  153. data/test/lua_function_gen_test.rb +242 -0
  154. data/test/namespace_test.rb +220 -0
  155. data/test/parser_test.rb +36 -0
  156. metadata +229 -272
  157. checksums.yaml +0 -7
  158. data/lib/open_api_sdk/analytics.rb +0 -99
  159. data/lib/open_api_sdk/domains.rb +0 -353
  160. data/lib/open_api_sdk/dub.rb +0 -88
  161. data/lib/open_api_sdk/links.rb +0 -766
  162. data/lib/open_api_sdk/metatags.rb +0 -54
  163. data/lib/open_api_sdk/models/operations/bulkcreatelinks_response.rb +0 -60
  164. data/lib/open_api_sdk/models/operations/bulkupdatelinks_requestbody.rb +0 -27
  165. data/lib/open_api_sdk/models/operations/bulkupdatelinks_response.rb +0 -60
  166. data/lib/open_api_sdk/models/operations/color.rb +0 -24
  167. data/lib/open_api_sdk/models/operations/createdomain_requestbody.rb +0 -33
  168. data/lib/open_api_sdk/models/operations/createdomain_response.rb +0 -60
  169. data/lib/open_api_sdk/models/operations/createlink_requestbody.rb +0 -95
  170. data/lib/open_api_sdk/models/operations/createlink_response.rb +0 -60
  171. data/lib/open_api_sdk/models/operations/createtag_requestbody.rb +0 -32
  172. data/lib/open_api_sdk/models/operations/createtag_response.rb +0 -60
  173. data/lib/open_api_sdk/models/operations/data.rb +0 -83
  174. data/lib/open_api_sdk/models/operations/deletedomain_request.rb +0 -24
  175. data/lib/open_api_sdk/models/operations/deletedomain_response.rb +0 -60
  176. data/lib/open_api_sdk/models/operations/deletedomain_responsebody.rb +0 -24
  177. data/lib/open_api_sdk/models/operations/deletelink_request.rb +0 -24
  178. data/lib/open_api_sdk/models/operations/deletelink_response.rb +0 -60
  179. data/lib/open_api_sdk/models/operations/deletelink_responsebody.rb +0 -24
  180. data/lib/open_api_sdk/models/operations/event.rb +0 -21
  181. data/lib/open_api_sdk/models/operations/getlinkinfo_request.rb +0 -33
  182. data/lib/open_api_sdk/models/operations/getlinkinfo_response.rb +0 -60
  183. data/lib/open_api_sdk/models/operations/getlinks_request.rb +0 -51
  184. data/lib/open_api_sdk/models/operations/getlinks_response.rb +0 -60
  185. data/lib/open_api_sdk/models/operations/getlinkscount_request.rb +0 -48
  186. data/lib/open_api_sdk/models/operations/getlinkscount_response.rb +0 -60
  187. data/lib/open_api_sdk/models/operations/getmetatags_request.rb +0 -24
  188. data/lib/open_api_sdk/models/operations/getmetatags_response.rb +0 -33
  189. data/lib/open_api_sdk/models/operations/getmetatags_responsebody.rb +0 -30
  190. data/lib/open_api_sdk/models/operations/getqrcode_request.rb +0 -39
  191. data/lib/open_api_sdk/models/operations/getqrcode_response.rb +0 -60
  192. data/lib/open_api_sdk/models/operations/gettags_response.rb +0 -60
  193. data/lib/open_api_sdk/models/operations/getworkspace_request.rb +0 -24
  194. data/lib/open_api_sdk/models/operations/getworkspace_response.rb +0 -60
  195. data/lib/open_api_sdk/models/operations/groupby.rb +0 -28
  196. data/lib/open_api_sdk/models/operations/interval.rb +0 -25
  197. data/lib/open_api_sdk/models/operations/level.rb +0 -21
  198. data/lib/open_api_sdk/models/operations/listdomains_response.rb +0 -60
  199. data/lib/open_api_sdk/models/operations/paymentprocessor.rb +0 -20
  200. data/lib/open_api_sdk/models/operations/requestbody.rb +0 -95
  201. data/lib/open_api_sdk/models/operations/retrieveanalytics_request.rb +0 -81
  202. data/lib/open_api_sdk/models/operations/retrieveanalytics_response.rb +0 -60
  203. data/lib/open_api_sdk/models/operations/sort.rb +0 -20
  204. data/lib/open_api_sdk/models/operations/trackcustomer_requestbody.rb +0 -33
  205. data/lib/open_api_sdk/models/operations/trackcustomer_response.rb +0 -60
  206. data/lib/open_api_sdk/models/operations/trackcustomer_responsebody.rb +0 -33
  207. data/lib/open_api_sdk/models/operations/tracklead_requestbody.rb +0 -42
  208. data/lib/open_api_sdk/models/operations/tracklead_response.rb +0 -60
  209. data/lib/open_api_sdk/models/operations/tracklead_responsebody.rb +0 -42
  210. data/lib/open_api_sdk/models/operations/tracksale_requestbody.rb +0 -42
  211. data/lib/open_api_sdk/models/operations/tracksale_response.rb +0 -60
  212. data/lib/open_api_sdk/models/operations/tracksale_responsebody.rb +0 -42
  213. data/lib/open_api_sdk/models/operations/updatedomain_request.rb +0 -27
  214. data/lib/open_api_sdk/models/operations/updatedomain_requestbody.rb +0 -33
  215. data/lib/open_api_sdk/models/operations/updatedomain_response.rb +0 -60
  216. data/lib/open_api_sdk/models/operations/updatelink_request.rb +0 -27
  217. data/lib/open_api_sdk/models/operations/updatelink_requestbody.rb +0 -95
  218. data/lib/open_api_sdk/models/operations/updatelink_response.rb +0 -60
  219. data/lib/open_api_sdk/models/operations/updatetag_color.rb +0 -24
  220. data/lib/open_api_sdk/models/operations/updatetag_request.rb +0 -27
  221. data/lib/open_api_sdk/models/operations/updatetag_requestbody.rb +0 -32
  222. data/lib/open_api_sdk/models/operations/updatetag_response.rb +0 -60
  223. data/lib/open_api_sdk/models/operations/updateworkspace_request.rb +0 -27
  224. data/lib/open_api_sdk/models/operations/updateworkspace_requestbody.rb +0 -27
  225. data/lib/open_api_sdk/models/operations/updateworkspace_response.rb +0 -60
  226. data/lib/open_api_sdk/models/operations/upsertlink_requestbody.rb +0 -95
  227. data/lib/open_api_sdk/models/operations/upsertlink_response.rb +0 -60
  228. data/lib/open_api_sdk/models/operations.rb +0 -74
  229. data/lib/open_api_sdk/models/shared/badrequest.rb +0 -24
  230. data/lib/open_api_sdk/models/shared/code.rb +0 -18
  231. data/lib/open_api_sdk/models/shared/color.rb +0 -24
  232. data/lib/open_api_sdk/models/shared/conflict.rb +0 -24
  233. data/lib/open_api_sdk/models/shared/conflict_code.rb +0 -18
  234. data/lib/open_api_sdk/models/shared/conflict_error.rb +0 -30
  235. data/lib/open_api_sdk/models/shared/countrycode.rb +0 -267
  236. data/lib/open_api_sdk/models/shared/domains.rb +0 -27
  237. data/lib/open_api_sdk/models/shared/domainschema.rb +0 -48
  238. data/lib/open_api_sdk/models/shared/error.rb +0 -30
  239. data/lib/open_api_sdk/models/shared/forbidden.rb +0 -24
  240. data/lib/open_api_sdk/models/shared/forbidden_code.rb +0 -18
  241. data/lib/open_api_sdk/models/shared/forbidden_error.rb +0 -30
  242. data/lib/open_api_sdk/models/shared/geo.rb +0 -771
  243. data/lib/open_api_sdk/models/shared/internalservererror.rb +0 -24
  244. data/lib/open_api_sdk/models/shared/internalservererror_code.rb +0 -18
  245. data/lib/open_api_sdk/models/shared/internalservererror_error.rb +0 -30
  246. data/lib/open_api_sdk/models/shared/inviteexpired.rb +0 -24
  247. data/lib/open_api_sdk/models/shared/inviteexpired_code.rb +0 -18
  248. data/lib/open_api_sdk/models/shared/inviteexpired_error.rb +0 -30
  249. data/lib/open_api_sdk/models/shared/linkgeotargeting.rb +0 -771
  250. data/lib/open_api_sdk/models/shared/linkschema.rb +0 -142
  251. data/lib/open_api_sdk/models/shared/notfound.rb +0 -24
  252. data/lib/open_api_sdk/models/shared/notfound_code.rb +0 -18
  253. data/lib/open_api_sdk/models/shared/notfound_error.rb +0 -30
  254. data/lib/open_api_sdk/models/shared/plan.rb +0 -24
  255. data/lib/open_api_sdk/models/shared/ratelimitexceeded.rb +0 -24
  256. data/lib/open_api_sdk/models/shared/ratelimitexceeded_code.rb +0 -18
  257. data/lib/open_api_sdk/models/shared/ratelimitexceeded_error.rb +0 -30
  258. data/lib/open_api_sdk/models/shared/role.rb +0 -19
  259. data/lib/open_api_sdk/models/shared/security.rb +0 -24
  260. data/lib/open_api_sdk/models/shared/tagschema.rb +0 -30
  261. data/lib/open_api_sdk/models/shared/unauthorized.rb +0 -24
  262. data/lib/open_api_sdk/models/shared/unauthorized_code.rb +0 -18
  263. data/lib/open_api_sdk/models/shared/unauthorized_error.rb +0 -30
  264. data/lib/open_api_sdk/models/shared/unprocessableentity.rb +0 -24
  265. data/lib/open_api_sdk/models/shared/unprocessableentity_code.rb +0 -18
  266. data/lib/open_api_sdk/models/shared/unprocessableentity_error.rb +0 -30
  267. data/lib/open_api_sdk/models/shared/users.rb +0 -24
  268. data/lib/open_api_sdk/models/shared/workspaceschema.rb +0 -81
  269. data/lib/open_api_sdk/models/shared.rb +0 -49
  270. data/lib/open_api_sdk/qr_codes.rb +0 -97
  271. data/lib/open_api_sdk/sdkconfiguration.rb +0 -52
  272. data/lib/open_api_sdk/tags.rb +0 -272
  273. data/lib/open_api_sdk/track.rb +0 -276
  274. data/lib/open_api_sdk/utils/metadata_fields.rb +0 -150
  275. data/lib/open_api_sdk/utils/t.rb +0 -59
  276. data/lib/open_api_sdk/utils/utils.rb +0 -772
  277. data/lib/open_api_sdk/workspaces.rb +0 -192
@@ -1,24 +0,0 @@
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 GetMetatagsRequest < ::OpenApiSDK::Utils::FieldAugmented
12
- extend T::Sig
13
-
14
- # The URL to retrieve metatags for.
15
- field :url, ::String, { 'query_param': { 'field_name': 'url', 'style': 'form', 'explode': true } }
16
-
17
-
18
- sig { params(url: ::String).void }
19
- def initialize(url: nil)
20
- @url = url
21
- end
22
- end
23
- end
24
- end
@@ -1,33 +0,0 @@
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 GetMetatagsResponse < ::OpenApiSDK::Utils::FieldAugmented
12
- extend T::Sig
13
-
14
- # HTTP response content type for this operation
15
- field :content_type, ::String
16
- # Raw HTTP response; suitable for custom response parsing
17
- field :raw_response, ::Faraday::Response
18
- # HTTP response status code for this operation
19
- field :status_code, ::Integer
20
- # The retrieved metatags
21
- field :object, T.nilable(::OpenApiSDK::Operations::GetMetatagsResponseBody)
22
-
23
-
24
- sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, object: T.nilable(::OpenApiSDK::Operations::GetMetatagsResponseBody)).void }
25
- def initialize(content_type: nil, raw_response: nil, status_code: nil, object: nil)
26
- @content_type = content_type
27
- @raw_response = raw_response
28
- @status_code = status_code
29
- @object = object
30
- end
31
- end
32
- end
33
- end
@@ -1,30 +0,0 @@
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
- # The retrieved metatags
11
- class GetMetatagsResponseBody < ::OpenApiSDK::Utils::FieldAugmented
12
- extend T::Sig
13
-
14
- # The meta description tag for the URL.
15
- field :description, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description') } }
16
- # The OpenGraph image for the URL.
17
- field :image, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
18
- # The meta title tag for the URL.
19
- field :title, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
20
-
21
-
22
- sig { params(description: ::String, image: ::String, title: ::String).void }
23
- def initialize(description: nil, image: nil, title: nil)
24
- @description = description
25
- @image = image
26
- @title = title
27
- end
28
- end
29
- end
30
- end
@@ -1,39 +0,0 @@
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 GetQRCodeRequest < ::OpenApiSDK::Utils::FieldAugmented
12
- extend T::Sig
13
-
14
- # The URL to generate a QR code for.
15
- field :url, ::String, { 'query_param': { 'field_name': 'url', 'style': 'form', 'explode': true } }
16
- # The background color of the QR code in hex format. Defaults to `#ffffff` if not provided.
17
- field :bg_color, T.nilable(::String), { 'query_param': { 'field_name': 'bgColor', 'style': 'form', 'explode': true } }
18
- # The foreground color of the QR code in hex format. Defaults to `#000000` if not provided.
19
- field :fg_color, T.nilable(::String), { 'query_param': { 'field_name': 'fgColor', 'style': 'form', 'explode': true } }
20
- # Whether to include a margin around the QR code. Defaults to `false` if not provided.
21
- field :include_margin, T.nilable(T::Boolean), { 'query_param': { 'field_name': 'includeMargin', 'style': 'form', 'explode': true } }
22
- # The level of error correction to use for the QR code. Defaults to `L` if not provided.
23
- field :level, T.nilable(::OpenApiSDK::Operations::Level), { 'query_param': { 'field_name': 'level', 'style': 'form', 'explode': true } }
24
- # The size of the QR code in pixels. Defaults to `600` if not provided.
25
- field :size, T.nilable(::Float), { 'query_param': { 'field_name': 'size', 'style': 'form', 'explode': true } }
26
-
27
-
28
- sig { params(url: ::String, bg_color: T.nilable(::String), fg_color: T.nilable(::String), include_margin: T.nilable(T::Boolean), level: T.nilable(::OpenApiSDK::Operations::Level), size: T.nilable(::Float)).void }
29
- def initialize(url: nil, bg_color: nil, fg_color: nil, include_margin: nil, level: nil, size: nil)
30
- @url = url
31
- @bg_color = bg_color
32
- @fg_color = fg_color
33
- @include_margin = include_margin
34
- @level = level
35
- @size = size
36
- end
37
- end
38
- end
39
- end
@@ -1,60 +0,0 @@
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 GetQRCodeResponse < ::OpenApiSDK::Utils::FieldAugmented
12
- extend T::Sig
13
-
14
- # HTTP response content type for this operation
15
- field :content_type, ::String
16
- # Raw HTTP response; suitable for custom response parsing
17
- field :raw_response, ::Faraday::Response
18
- # HTTP response status code for this operation
19
- field :status_code, ::Integer
20
- # The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
21
- field :bad_request, T.nilable(::OpenApiSDK::Shared::BadRequest)
22
- # This response is sent when a request conflicts with the current state of the server.
23
- field :conflict, T.nilable(::OpenApiSDK::Shared::Conflict)
24
- # The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.
25
- field :forbidden, T.nilable(::OpenApiSDK::Shared::Forbidden)
26
- # The server has encountered a situation it does not know how to handle.
27
- field :internal_server_error, T.nilable(::OpenApiSDK::Shared::InternalServerError)
28
- # This response is sent when the requested content has been permanently deleted from server, with no forwarding address.
29
- field :invite_expired, T.nilable(::OpenApiSDK::Shared::InviteExpired)
30
- # The server cannot find the requested resource.
31
- field :not_found, T.nilable(::OpenApiSDK::Shared::NotFound)
32
- # The user has sent too many requests in a given amount of time ("rate limiting")
33
- field :rate_limit_exceeded, T.nilable(::OpenApiSDK::Shared::RateLimitExceeded)
34
- # The QR code
35
- field :res, T.nilable(::String)
36
- # Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
37
- field :unauthorized, T.nilable(::OpenApiSDK::Shared::Unauthorized)
38
- # The request was well-formed but was unable to be followed due to semantic errors.
39
- field :unprocessable_entity, T.nilable(::OpenApiSDK::Shared::UnprocessableEntity)
40
-
41
-
42
- sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, bad_request: T.nilable(::OpenApiSDK::Shared::BadRequest), conflict: T.nilable(::OpenApiSDK::Shared::Conflict), forbidden: T.nilable(::OpenApiSDK::Shared::Forbidden), internal_server_error: T.nilable(::OpenApiSDK::Shared::InternalServerError), invite_expired: T.nilable(::OpenApiSDK::Shared::InviteExpired), not_found: T.nilable(::OpenApiSDK::Shared::NotFound), rate_limit_exceeded: T.nilable(::OpenApiSDK::Shared::RateLimitExceeded), res: T.nilable(::String), unauthorized: T.nilable(::OpenApiSDK::Shared::Unauthorized), unprocessable_entity: T.nilable(::OpenApiSDK::Shared::UnprocessableEntity)).void }
43
- def initialize(content_type: nil, raw_response: nil, status_code: nil, bad_request: nil, conflict: nil, forbidden: nil, internal_server_error: nil, invite_expired: nil, not_found: nil, rate_limit_exceeded: nil, res: nil, unauthorized: nil, unprocessable_entity: nil)
44
- @content_type = content_type
45
- @raw_response = raw_response
46
- @status_code = status_code
47
- @bad_request = bad_request
48
- @conflict = conflict
49
- @forbidden = forbidden
50
- @internal_server_error = internal_server_error
51
- @invite_expired = invite_expired
52
- @not_found = not_found
53
- @rate_limit_exceeded = rate_limit_exceeded
54
- @res = res
55
- @unauthorized = unauthorized
56
- @unprocessable_entity = unprocessable_entity
57
- end
58
- end
59
- end
60
- end
@@ -1,60 +0,0 @@
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 GetTagsResponse < ::OpenApiSDK::Utils::FieldAugmented
12
- extend T::Sig
13
-
14
- # HTTP response content type for this operation
15
- field :content_type, ::String
16
- # Raw HTTP response; suitable for custom response parsing
17
- field :raw_response, ::Faraday::Response
18
- # HTTP response status code for this operation
19
- field :status_code, ::Integer
20
- # The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
21
- field :bad_request, T.nilable(::OpenApiSDK::Shared::BadRequest)
22
- # This response is sent when a request conflicts with the current state of the server.
23
- field :conflict, T.nilable(::OpenApiSDK::Shared::Conflict)
24
- # The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.
25
- field :forbidden, T.nilable(::OpenApiSDK::Shared::Forbidden)
26
- # The server has encountered a situation it does not know how to handle.
27
- field :internal_server_error, T.nilable(::OpenApiSDK::Shared::InternalServerError)
28
- # This response is sent when the requested content has been permanently deleted from server, with no forwarding address.
29
- field :invite_expired, T.nilable(::OpenApiSDK::Shared::InviteExpired)
30
- # The server cannot find the requested resource.
31
- field :not_found, T.nilable(::OpenApiSDK::Shared::NotFound)
32
- # The user has sent too many requests in a given amount of time ("rate limiting")
33
- field :rate_limit_exceeded, T.nilable(::OpenApiSDK::Shared::RateLimitExceeded)
34
- # A list of tags
35
- field :tag_schemas, T.nilable(T::Array[::OpenApiSDK::Shared::TagSchema])
36
- # Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
37
- field :unauthorized, T.nilable(::OpenApiSDK::Shared::Unauthorized)
38
- # The request was well-formed but was unable to be followed due to semantic errors.
39
- field :unprocessable_entity, T.nilable(::OpenApiSDK::Shared::UnprocessableEntity)
40
-
41
-
42
- sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, bad_request: T.nilable(::OpenApiSDK::Shared::BadRequest), conflict: T.nilable(::OpenApiSDK::Shared::Conflict), forbidden: T.nilable(::OpenApiSDK::Shared::Forbidden), internal_server_error: T.nilable(::OpenApiSDK::Shared::InternalServerError), invite_expired: T.nilable(::OpenApiSDK::Shared::InviteExpired), not_found: T.nilable(::OpenApiSDK::Shared::NotFound), rate_limit_exceeded: T.nilable(::OpenApiSDK::Shared::RateLimitExceeded), tag_schemas: T.nilable(T::Array[::OpenApiSDK::Shared::TagSchema]), unauthorized: T.nilable(::OpenApiSDK::Shared::Unauthorized), unprocessable_entity: T.nilable(::OpenApiSDK::Shared::UnprocessableEntity)).void }
43
- def initialize(content_type: nil, raw_response: nil, status_code: nil, bad_request: nil, conflict: nil, forbidden: nil, internal_server_error: nil, invite_expired: nil, not_found: nil, rate_limit_exceeded: nil, tag_schemas: nil, unauthorized: nil, unprocessable_entity: nil)
44
- @content_type = content_type
45
- @raw_response = raw_response
46
- @status_code = status_code
47
- @bad_request = bad_request
48
- @conflict = conflict
49
- @forbidden = forbidden
50
- @internal_server_error = internal_server_error
51
- @invite_expired = invite_expired
52
- @not_found = not_found
53
- @rate_limit_exceeded = rate_limit_exceeded
54
- @tag_schemas = tag_schemas
55
- @unauthorized = unauthorized
56
- @unprocessable_entity = unprocessable_entity
57
- end
58
- end
59
- end
60
- end
@@ -1,24 +0,0 @@
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 GetWorkspaceRequest < ::OpenApiSDK::Utils::FieldAugmented
12
- extend T::Sig
13
-
14
- # The ID or slug of the workspace.
15
- field :id_or_slug, ::String, { 'path_param': { 'field_name': 'idOrSlug', 'style': 'simple', 'explode': false } }
16
-
17
-
18
- sig { params(id_or_slug: ::String).void }
19
- def initialize(id_or_slug: nil)
20
- @id_or_slug = id_or_slug
21
- end
22
- end
23
- end
24
- end
@@ -1,60 +0,0 @@
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 GetWorkspaceResponse < ::OpenApiSDK::Utils::FieldAugmented
12
- extend T::Sig
13
-
14
- # HTTP response content type for this operation
15
- field :content_type, ::String
16
- # Raw HTTP response; suitable for custom response parsing
17
- field :raw_response, ::Faraday::Response
18
- # HTTP response status code for this operation
19
- field :status_code, ::Integer
20
- # The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
21
- field :bad_request, T.nilable(::OpenApiSDK::Shared::BadRequest)
22
- # This response is sent when a request conflicts with the current state of the server.
23
- field :conflict, T.nilable(::OpenApiSDK::Shared::Conflict)
24
- # The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.
25
- field :forbidden, T.nilable(::OpenApiSDK::Shared::Forbidden)
26
- # The server has encountered a situation it does not know how to handle.
27
- field :internal_server_error, T.nilable(::OpenApiSDK::Shared::InternalServerError)
28
- # This response is sent when the requested content has been permanently deleted from server, with no forwarding address.
29
- field :invite_expired, T.nilable(::OpenApiSDK::Shared::InviteExpired)
30
- # The server cannot find the requested resource.
31
- field :not_found, T.nilable(::OpenApiSDK::Shared::NotFound)
32
- # The user has sent too many requests in a given amount of time ("rate limiting")
33
- field :rate_limit_exceeded, T.nilable(::OpenApiSDK::Shared::RateLimitExceeded)
34
- # Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
35
- field :unauthorized, T.nilable(::OpenApiSDK::Shared::Unauthorized)
36
- # The request was well-formed but was unable to be followed due to semantic errors.
37
- field :unprocessable_entity, T.nilable(::OpenApiSDK::Shared::UnprocessableEntity)
38
- # The retrieved workspace
39
- field :workspace_schema, T.nilable(::OpenApiSDK::Shared::WorkspaceSchema)
40
-
41
-
42
- sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, bad_request: T.nilable(::OpenApiSDK::Shared::BadRequest), conflict: T.nilable(::OpenApiSDK::Shared::Conflict), forbidden: T.nilable(::OpenApiSDK::Shared::Forbidden), internal_server_error: T.nilable(::OpenApiSDK::Shared::InternalServerError), invite_expired: T.nilable(::OpenApiSDK::Shared::InviteExpired), not_found: T.nilable(::OpenApiSDK::Shared::NotFound), rate_limit_exceeded: T.nilable(::OpenApiSDK::Shared::RateLimitExceeded), unauthorized: T.nilable(::OpenApiSDK::Shared::Unauthorized), unprocessable_entity: T.nilable(::OpenApiSDK::Shared::UnprocessableEntity), workspace_schema: T.nilable(::OpenApiSDK::Shared::WorkspaceSchema)).void }
43
- def initialize(content_type: nil, raw_response: nil, status_code: nil, bad_request: nil, conflict: nil, forbidden: nil, internal_server_error: nil, invite_expired: nil, not_found: nil, rate_limit_exceeded: nil, unauthorized: nil, unprocessable_entity: nil, workspace_schema: nil)
44
- @content_type = content_type
45
- @raw_response = raw_response
46
- @status_code = status_code
47
- @bad_request = bad_request
48
- @conflict = conflict
49
- @forbidden = forbidden
50
- @internal_server_error = internal_server_error
51
- @invite_expired = invite_expired
52
- @not_found = not_found
53
- @rate_limit_exceeded = rate_limit_exceeded
54
- @unauthorized = unauthorized
55
- @unprocessable_entity = unprocessable_entity
56
- @workspace_schema = workspace_schema
57
- end
58
- end
59
- end
60
- end
@@ -1,28 +0,0 @@
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
- # GroupBy - The parameter to group the analytics data points by. Defaults to 'count' if undefined.
11
- class GroupBy < T::Enum
12
- enums do
13
- COUNT = new('count')
14
- TIMESERIES = new('timeseries')
15
- COUNTRIES = new('countries')
16
- CITIES = new('cities')
17
- DEVICES = new('devices')
18
- BROWSERS = new('browsers')
19
- OS = new('os')
20
- REFERERS = new('referers')
21
- TOP_LINKS = new('top_links')
22
- TOP_URLS = new('top_urls')
23
- TRIGGER = new('trigger')
24
- end
25
- end
26
-
27
- end
28
- end
@@ -1,25 +0,0 @@
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
- # Interval - The interval to retrieve analytics for. Takes precedence over start and end. If undefined, defaults to 24h.
11
- class Interval < T::Enum
12
- enums do
13
- TWENTY_FOURH = new('24h')
14
- SEVEND = new('7d')
15
- THIRTYD = new('30d')
16
- NINETYD = new('90d')
17
- YTD = new('ytd')
18
- ONEY = new('1y')
19
- ALL = new('all')
20
- ALL_UNFILTERED = new('all_unfiltered')
21
- end
22
- end
23
-
24
- end
25
- end
@@ -1,21 +0,0 @@
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
- # Level - The level of error correction to use for the QR code. Defaults to `L` if not provided.
11
- class Level < T::Enum
12
- enums do
13
- L = new('L')
14
- M = new('M')
15
- Q = new('Q')
16
- H = new('H')
17
- end
18
- end
19
-
20
- end
21
- end
@@ -1,60 +0,0 @@
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 ListDomainsResponse < ::OpenApiSDK::Utils::FieldAugmented
12
- extend T::Sig
13
-
14
- # HTTP response content type for this operation
15
- field :content_type, ::String
16
- # Raw HTTP response; suitable for custom response parsing
17
- field :raw_response, ::Faraday::Response
18
- # HTTP response status code for this operation
19
- field :status_code, ::Integer
20
- # The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, or deceptive request routing).
21
- field :bad_request, T.nilable(::OpenApiSDK::Shared::BadRequest)
22
- # This response is sent when a request conflicts with the current state of the server.
23
- field :conflict, T.nilable(::OpenApiSDK::Shared::Conflict)
24
- # The domains were retrieved.
25
- field :domain_schemas, T.nilable(T::Array[::OpenApiSDK::Shared::DomainSchema])
26
- # The client does not have access rights to the content; that is, it is unauthorized, so the server is refusing to give the requested resource. Unlike 401 Unauthorized, the client's identity is known to the server.
27
- field :forbidden, T.nilable(::OpenApiSDK::Shared::Forbidden)
28
- # The server has encountered a situation it does not know how to handle.
29
- field :internal_server_error, T.nilable(::OpenApiSDK::Shared::InternalServerError)
30
- # This response is sent when the requested content has been permanently deleted from server, with no forwarding address.
31
- field :invite_expired, T.nilable(::OpenApiSDK::Shared::InviteExpired)
32
- # The server cannot find the requested resource.
33
- field :not_found, T.nilable(::OpenApiSDK::Shared::NotFound)
34
- # The user has sent too many requests in a given amount of time ("rate limiting")
35
- field :rate_limit_exceeded, T.nilable(::OpenApiSDK::Shared::RateLimitExceeded)
36
- # Although the HTTP standard specifies "unauthorized", semantically this response means "unauthenticated". That is, the client must authenticate itself to get the requested response.
37
- field :unauthorized, T.nilable(::OpenApiSDK::Shared::Unauthorized)
38
- # The request was well-formed but was unable to be followed due to semantic errors.
39
- field :unprocessable_entity, T.nilable(::OpenApiSDK::Shared::UnprocessableEntity)
40
-
41
-
42
- sig { params(content_type: ::String, raw_response: ::Faraday::Response, status_code: ::Integer, bad_request: T.nilable(::OpenApiSDK::Shared::BadRequest), conflict: T.nilable(::OpenApiSDK::Shared::Conflict), domain_schemas: T.nilable(T::Array[::OpenApiSDK::Shared::DomainSchema]), forbidden: T.nilable(::OpenApiSDK::Shared::Forbidden), internal_server_error: T.nilable(::OpenApiSDK::Shared::InternalServerError), invite_expired: T.nilable(::OpenApiSDK::Shared::InviteExpired), not_found: T.nilable(::OpenApiSDK::Shared::NotFound), rate_limit_exceeded: T.nilable(::OpenApiSDK::Shared::RateLimitExceeded), unauthorized: T.nilable(::OpenApiSDK::Shared::Unauthorized), unprocessable_entity: T.nilable(::OpenApiSDK::Shared::UnprocessableEntity)).void }
43
- def initialize(content_type: nil, raw_response: nil, status_code: nil, bad_request: nil, conflict: nil, domain_schemas: nil, forbidden: nil, internal_server_error: nil, invite_expired: nil, not_found: nil, rate_limit_exceeded: nil, unauthorized: nil, unprocessable_entity: nil)
44
- @content_type = content_type
45
- @raw_response = raw_response
46
- @status_code = status_code
47
- @bad_request = bad_request
48
- @conflict = conflict
49
- @domain_schemas = domain_schemas
50
- @forbidden = forbidden
51
- @internal_server_error = internal_server_error
52
- @invite_expired = invite_expired
53
- @not_found = not_found
54
- @rate_limit_exceeded = rate_limit_exceeded
55
- @unauthorized = unauthorized
56
- @unprocessable_entity = unprocessable_entity
57
- end
58
- end
59
- end
60
- end
@@ -1,20 +0,0 @@
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
- # PaymentProcessor - The payment processor via which the sale was made.
11
- class PaymentProcessor < T::Enum
12
- enums do
13
- STRIPE = new('stripe')
14
- SHOPIFY = new('shopify')
15
- PADDLE = new('paddle')
16
- end
17
- end
18
-
19
- end
20
- end
@@ -1,95 +0,0 @@
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 RequestBody < ::OpenApiSDK::Utils::FieldAugmented
12
- extend T::Sig
13
-
14
- # The destination URL of the short link.
15
- field :url, ::String, { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('url') } }
16
- # The Android destination URL for the short link for Android device targeting.
17
- field :android, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('android') } }
18
- # Whether the short link is archived.
19
- field :archived, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('archived') } }
20
- # The comments for the short link.
21
- field :comments, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('comments') } }
22
- # The description of the short link generated via `api.dub.co/metatags`. Will be used for Custom Social Media Cards if `proxy` is true.
23
- field :description, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('description') } }
24
- # Allow search engines to index your short link. Defaults to `false` if not provided. Learn more: https://d.to/noindex
25
- field :do_index, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('doIndex') } }
26
- # The domain of the short link. If not provided, the primary domain for the workspace will be used (or `dub.sh` if the workspace has no domains).
27
- field :domain, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('domain') } }
28
- # The URL to redirect to when the short link has expired.
29
- field :expired_url, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('expiredUrl') } }
30
- # The date and time when the short link will expire at.
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.
33
- field :external_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('externalId') } }
34
- # Geo targeting information for the short link in JSON format `{[COUNTRY]: https://example.com }`.
35
- field :geo, T.nilable(::OpenApiSDK::Shared::LinkGeoTargeting), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('geo') } }
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
- field :image, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('image') } }
38
- # The iOS destination URL for the short link for iOS device targeting.
39
- field :ios, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('ios') } }
40
- # The short link slug. If not provided, a random 7-character slug will be generated.
41
- field :key, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('key') } }
42
- # The password required to access the destination URL of the short link.
43
- field :password, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('password') } }
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
- field :prefix, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('prefix') } }
46
- # Whether the short link uses Custom Social Media Cards feature.
47
- field :proxy, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('proxy') } }
48
- # Whether the short link's stats are publicly accessible.
49
- field :public_stats, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('publicStats') } }
50
- # Whether the short link uses link cloaking.
51
- field :rewrite, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('rewrite') } }
52
- # The unique ID of the tag assigned to the short link. This field is deprecated – use `tagIds` instead.
53
- #
54
- # @deprecated true: This will be removed in a future release, please migrate away from it as soon as possible.
55
- field :tag_id, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagId') } }
56
- # The unique IDs of the tags assigned to the short link.
57
- field :tag_ids, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagIds') } }
58
- # The unique name of the tags assigned to the short link (case insensitive).
59
- field :tag_names, T.nilable(::Object), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('tagNames') } }
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.
61
- field :title, T.nilable(::String), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('title') } }
62
- # Whether to track conversions for the short link.
63
- field :track_conversion, T.nilable(T::Boolean), { 'format_json': { 'letter_case': ::OpenApiSDK::Utils.field_name('trackConversion') } }
64
-
65
-
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)
68
- @url = url
69
- @android = android
70
- @archived = archived
71
- @comments = comments
72
- @description = description
73
- @do_index = do_index
74
- @domain = domain
75
- @expired_url = expired_url
76
- @expires_at = expires_at
77
- @external_id = external_id
78
- @geo = geo
79
- @image = image
80
- @ios = ios
81
- @key = key
82
- @password = password
83
- @prefix = prefix
84
- @proxy = proxy
85
- @public_stats = public_stats
86
- @rewrite = rewrite
87
- @tag_id = tag_id
88
- @tag_ids = tag_ids
89
- @tag_names = tag_names
90
- @title = title
91
- @track_conversion = track_conversion
92
- end
93
- end
94
- end
95
- end