dub 0.24.0 → 0.24.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 (272) hide show
  1. package/README.md +62 -10
  2. package/docs/sdks/analytics/README.md +130 -40
  3. package/docs/sdks/domains/README.md +114 -44
  4. package/docs/sdks/links/README.md +100 -28
  5. package/docs/sdks/qrcodes/README.md +13 -4
  6. package/docs/sdks/tags/README.md +26 -8
  7. package/docs/sdks/workspaces/README.md +39 -12
  8. package/lib/config.d.ts +3 -3
  9. package/lib/config.js +3 -3
  10. package/models/components/domainschema.d.ts +80 -0
  11. package/models/components/domainschema.d.ts.map +1 -0
  12. package/models/components/domainschema.js +94 -0
  13. package/models/components/domainschema.js.map +1 -0
  14. package/models/components/index.d.ts +1 -9
  15. package/models/components/index.d.ts.map +1 -1
  16. package/models/components/index.js +1 -9
  17. package/models/components/index.js.map +1 -1
  18. package/models/{components → errors}/badrequest.d.ts +13 -1
  19. package/models/errors/badrequest.d.ts.map +1 -0
  20. package/models/{components → errors}/badrequest.js +23 -4
  21. package/models/errors/badrequest.js.map +1 -0
  22. package/models/{components → errors}/conflict.d.ts +13 -1
  23. package/models/errors/conflict.d.ts.map +1 -0
  24. package/models/{components → errors}/conflict.js +23 -4
  25. package/models/errors/conflict.js.map +1 -0
  26. package/models/{components → errors}/forbidden.d.ts +13 -1
  27. package/models/errors/forbidden.d.ts.map +1 -0
  28. package/models/{components → errors}/forbidden.js +23 -4
  29. package/models/errors/forbidden.js.map +1 -0
  30. package/models/errors/index.d.ts +9 -0
  31. package/models/errors/index.d.ts.map +1 -1
  32. package/models/errors/index.js +9 -0
  33. package/models/errors/index.js.map +1 -1
  34. package/models/{components → errors}/internalservererror.d.ts +13 -1
  35. package/models/errors/internalservererror.d.ts.map +1 -0
  36. package/models/{components → errors}/internalservererror.js +23 -4
  37. package/models/errors/internalservererror.js.map +1 -0
  38. package/models/{components → errors}/inviteexpired.d.ts +13 -1
  39. package/models/errors/inviteexpired.d.ts.map +1 -0
  40. package/models/{components → errors}/inviteexpired.js +23 -4
  41. package/models/errors/inviteexpired.js.map +1 -0
  42. package/models/{components → errors}/notfound.d.ts +13 -1
  43. package/models/errors/notfound.d.ts.map +1 -0
  44. package/models/{components → errors}/notfound.js +23 -4
  45. package/models/errors/notfound.js.map +1 -0
  46. package/models/{components → errors}/ratelimitexceeded.d.ts +13 -1
  47. package/models/errors/ratelimitexceeded.d.ts.map +1 -0
  48. package/models/{components → errors}/ratelimitexceeded.js +23 -4
  49. package/models/errors/ratelimitexceeded.js.map +1 -0
  50. package/models/{components → errors}/unauthorized.d.ts +13 -1
  51. package/models/errors/unauthorized.d.ts.map +1 -0
  52. package/models/{components → errors}/unauthorized.js +23 -4
  53. package/models/errors/unauthorized.js.map +1 -0
  54. package/models/{components → errors}/unprocessableentity.d.ts +13 -1
  55. package/models/errors/unprocessableentity.d.ts.map +1 -0
  56. package/models/{components → errors}/unprocessableentity.js +23 -4
  57. package/models/errors/unprocessableentity.js.map +1 -0
  58. package/models/operations/adddomain.d.ts +0 -90
  59. package/models/operations/adddomain.d.ts.map +1 -1
  60. package/models/operations/adddomain.js +1 -93
  61. package/models/operations/adddomain.js.map +1 -1
  62. package/models/operations/bulkcreatelinks.d.ts +17 -9
  63. package/models/operations/bulkcreatelinks.d.ts.map +1 -1
  64. package/models/operations/bulkcreatelinks.js +11 -30
  65. package/models/operations/bulkcreatelinks.js.map +1 -1
  66. package/models/operations/createlink.d.ts +17 -9
  67. package/models/operations/createlink.d.ts.map +1 -1
  68. package/models/operations/createlink.js +17 -30
  69. package/models/operations/createlink.js.map +1 -1
  70. package/models/operations/createtag.d.ts +0 -9
  71. package/models/operations/createtag.d.ts.map +1 -1
  72. package/models/operations/createtag.js +1 -30
  73. package/models/operations/createtag.js.map +1 -1
  74. package/models/operations/createworkspace.d.ts +0 -9
  75. package/models/operations/createworkspace.d.ts.map +1 -1
  76. package/models/operations/createworkspace.js +1 -30
  77. package/models/operations/createworkspace.js.map +1 -1
  78. package/models/operations/deletedomain.d.ts +0 -9
  79. package/models/operations/deletedomain.d.ts.map +1 -1
  80. package/models/operations/deletedomain.js +1 -30
  81. package/models/operations/deletedomain.js.map +1 -1
  82. package/models/operations/deletelink.d.ts +0 -9
  83. package/models/operations/deletelink.d.ts.map +1 -1
  84. package/models/operations/deletelink.js +1 -30
  85. package/models/operations/deletelink.js.map +1 -1
  86. package/models/operations/editdomain.d.ts +0 -90
  87. package/models/operations/editdomain.d.ts.map +1 -1
  88. package/models/operations/editdomain.js +1 -93
  89. package/models/operations/editdomain.js.map +1 -1
  90. package/models/operations/editlink.d.ts +17 -9
  91. package/models/operations/editlink.d.ts.map +1 -1
  92. package/models/operations/editlink.js +17 -30
  93. package/models/operations/editlink.js.map +1 -1
  94. package/models/operations/getbrowseranalytics.d.ts +0 -9
  95. package/models/operations/getbrowseranalytics.d.ts.map +1 -1
  96. package/models/operations/getbrowseranalytics.js +1 -30
  97. package/models/operations/getbrowseranalytics.js.map +1 -1
  98. package/models/operations/getcityanalytics.d.ts +0 -9
  99. package/models/operations/getcityanalytics.d.ts.map +1 -1
  100. package/models/operations/getcityanalytics.js +1 -30
  101. package/models/operations/getcityanalytics.js.map +1 -1
  102. package/models/operations/getclicksanalytics.d.ts +0 -9
  103. package/models/operations/getclicksanalytics.d.ts.map +1 -1
  104. package/models/operations/getclicksanalytics.js +1 -30
  105. package/models/operations/getclicksanalytics.js.map +1 -1
  106. package/models/operations/getcountryanalytics.d.ts +0 -9
  107. package/models/operations/getcountryanalytics.d.ts.map +1 -1
  108. package/models/operations/getcountryanalytics.js +1 -30
  109. package/models/operations/getcountryanalytics.js.map +1 -1
  110. package/models/operations/getdeviceanalytics.d.ts +0 -9
  111. package/models/operations/getdeviceanalytics.d.ts.map +1 -1
  112. package/models/operations/getdeviceanalytics.js +1 -30
  113. package/models/operations/getdeviceanalytics.js.map +1 -1
  114. package/models/operations/getlinkinfo.d.ts +0 -9
  115. package/models/operations/getlinkinfo.d.ts.map +1 -1
  116. package/models/operations/getlinkinfo.js +1 -30
  117. package/models/operations/getlinkinfo.js.map +1 -1
  118. package/models/operations/getlinks.d.ts +17 -9
  119. package/models/operations/getlinks.d.ts.map +1 -1
  120. package/models/operations/getlinks.js +17 -30
  121. package/models/operations/getlinks.js.map +1 -1
  122. package/models/operations/getlinkscount.d.ts +17 -9
  123. package/models/operations/getlinkscount.d.ts.map +1 -1
  124. package/models/operations/getlinkscount.js +11 -30
  125. package/models/operations/getlinkscount.js.map +1 -1
  126. package/models/operations/getosanalytics.d.ts +0 -9
  127. package/models/operations/getosanalytics.d.ts.map +1 -1
  128. package/models/operations/getosanalytics.js +1 -30
  129. package/models/operations/getosanalytics.js.map +1 -1
  130. package/models/operations/getqrcode.d.ts +0 -9
  131. package/models/operations/getqrcode.d.ts.map +1 -1
  132. package/models/operations/getqrcode.js +1 -30
  133. package/models/operations/getqrcode.js.map +1 -1
  134. package/models/operations/getrefereranalytics.d.ts +0 -9
  135. package/models/operations/getrefereranalytics.d.ts.map +1 -1
  136. package/models/operations/getrefereranalytics.js +1 -30
  137. package/models/operations/getrefereranalytics.js.map +1 -1
  138. package/models/operations/gettags.d.ts +0 -9
  139. package/models/operations/gettags.d.ts.map +1 -1
  140. package/models/operations/gettags.js +1 -30
  141. package/models/operations/gettags.js.map +1 -1
  142. package/models/operations/gettimeseriesanalytics.d.ts +0 -9
  143. package/models/operations/gettimeseriesanalytics.d.ts.map +1 -1
  144. package/models/operations/gettimeseriesanalytics.js +1 -30
  145. package/models/operations/gettimeseriesanalytics.js.map +1 -1
  146. package/models/operations/gettoplinks.d.ts +0 -9
  147. package/models/operations/gettoplinks.d.ts.map +1 -1
  148. package/models/operations/gettoplinks.js +1 -30
  149. package/models/operations/gettoplinks.js.map +1 -1
  150. package/models/operations/gettopurls.d.ts +0 -9
  151. package/models/operations/gettopurls.d.ts.map +1 -1
  152. package/models/operations/gettopurls.js +1 -30
  153. package/models/operations/gettopurls.js.map +1 -1
  154. package/models/operations/getworkspace.d.ts +0 -9
  155. package/models/operations/getworkspace.d.ts.map +1 -1
  156. package/models/operations/getworkspace.js +1 -30
  157. package/models/operations/getworkspace.js.map +1 -1
  158. package/models/operations/index.d.ts +0 -1
  159. package/models/operations/index.d.ts.map +1 -1
  160. package/models/operations/index.js +0 -1
  161. package/models/operations/index.js.map +1 -1
  162. package/models/operations/listdomains.d.ts +0 -87
  163. package/models/operations/listdomains.d.ts.map +1 -1
  164. package/models/operations/listdomains.js +1 -93
  165. package/models/operations/listdomains.js.map +1 -1
  166. package/models/operations/setprimarydomain.d.ts +0 -90
  167. package/models/operations/setprimarydomain.d.ts.map +1 -1
  168. package/models/operations/setprimarydomain.js +1 -93
  169. package/models/operations/setprimarydomain.js.map +1 -1
  170. package/models/operations/transferdomain.d.ts +0 -90
  171. package/models/operations/transferdomain.d.ts.map +1 -1
  172. package/models/operations/transferdomain.js +1 -93
  173. package/models/operations/transferdomain.js.map +1 -1
  174. package/package.json +1 -1
  175. package/sdk/analytics.d.ts +10 -10
  176. package/sdk/analytics.d.ts.map +1 -1
  177. package/sdk/analytics.js +693 -200
  178. package/sdk/analytics.js.map +1 -1
  179. package/sdk/domains.d.ts +7 -6
  180. package/sdk/domains.d.ts.map +1 -1
  181. package/sdk/domains.js +422 -124
  182. package/sdk/domains.js.map +1 -1
  183. package/sdk/links.d.ts +8 -7
  184. package/sdk/links.d.ts.map +1 -1
  185. package/sdk/links.js +485 -140
  186. package/sdk/links.js.map +1 -1
  187. package/sdk/metatags.js +1 -1
  188. package/sdk/metatags.js.map +1 -1
  189. package/sdk/qrcodes.d.ts +1 -1
  190. package/sdk/qrcodes.d.ts.map +1 -1
  191. package/sdk/qrcodes.js +69 -20
  192. package/sdk/qrcodes.js.map +1 -1
  193. package/sdk/tags.d.ts +3 -2
  194. package/sdk/tags.d.ts.map +1 -1
  195. package/sdk/tags.js +138 -40
  196. package/sdk/tags.js.map +1 -1
  197. package/sdk/workspaces.d.ts +4 -3
  198. package/sdk/workspaces.d.ts.map +1 -1
  199. package/sdk/workspaces.js +206 -60
  200. package/sdk/workspaces.js.map +1 -1
  201. package/src/lib/config.ts +3 -3
  202. package/src/models/components/domainschema.ts +138 -0
  203. package/src/models/components/index.ts +1 -9
  204. package/src/models/{components → errors}/badrequest.ts +43 -11
  205. package/src/models/{components → errors}/conflict.ts +43 -11
  206. package/src/models/{components → errors}/forbidden.ts +43 -11
  207. package/src/models/errors/index.ts +9 -0
  208. package/src/models/{components → errors}/internalservererror.ts +43 -11
  209. package/src/models/{components → errors}/inviteexpired.ts +43 -11
  210. package/src/models/{components → errors}/notfound.ts +43 -11
  211. package/src/models/{components → errors}/ratelimitexceeded.ts +43 -11
  212. package/src/models/{components → errors}/unauthorized.ts +43 -11
  213. package/src/models/{components → errors}/unprocessableentity.ts +43 -11
  214. package/src/models/operations/adddomain.ts +0 -200
  215. package/src/models/operations/bulkcreatelinks.ts +27 -67
  216. package/src/models/operations/createlink.ts +30 -64
  217. package/src/models/operations/createtag.ts +0 -64
  218. package/src/models/operations/createworkspace.ts +0 -67
  219. package/src/models/operations/deletedomain.ts +0 -64
  220. package/src/models/operations/deletelink.ts +0 -64
  221. package/src/models/operations/editdomain.ts +0 -202
  222. package/src/models/operations/editlink.ts +30 -64
  223. package/src/models/operations/getbrowseranalytics.ts +0 -66
  224. package/src/models/operations/getcityanalytics.ts +0 -66
  225. package/src/models/operations/getclicksanalytics.ts +0 -66
  226. package/src/models/operations/getcountryanalytics.ts +0 -66
  227. package/src/models/operations/getdeviceanalytics.ts +0 -66
  228. package/src/models/operations/getlinkinfo.ts +0 -64
  229. package/src/models/operations/getlinks.ts +30 -64
  230. package/src/models/operations/getlinkscount.ts +29 -66
  231. package/src/models/operations/getosanalytics.ts +0 -65
  232. package/src/models/operations/getqrcode.ts +0 -64
  233. package/src/models/operations/getrefereranalytics.ts +0 -66
  234. package/src/models/operations/gettags.ts +0 -64
  235. package/src/models/operations/gettimeseriesanalytics.ts +0 -66
  236. package/src/models/operations/gettoplinks.ts +0 -64
  237. package/src/models/operations/gettopurls.ts +0 -64
  238. package/src/models/operations/getworkspace.ts +0 -64
  239. package/src/models/operations/index.ts +0 -1
  240. package/src/models/operations/listdomains.ts +0 -198
  241. package/src/models/operations/setprimarydomain.ts +0 -203
  242. package/src/models/operations/transferdomain.ts +0 -202
  243. package/src/sdk/analytics.ts +713 -210
  244. package/src/sdk/domains.ts +436 -130
  245. package/src/sdk/links.ts +502 -150
  246. package/src/sdk/metatags.ts +1 -1
  247. package/src/sdk/qrcodes.ts +71 -21
  248. package/src/sdk/tags.ts +142 -42
  249. package/src/sdk/workspaces.ts +212 -63
  250. package/models/components/badrequest.d.ts.map +0 -1
  251. package/models/components/badrequest.js.map +0 -1
  252. package/models/components/conflict.d.ts.map +0 -1
  253. package/models/components/conflict.js.map +0 -1
  254. package/models/components/forbidden.d.ts.map +0 -1
  255. package/models/components/forbidden.js.map +0 -1
  256. package/models/components/internalservererror.d.ts.map +0 -1
  257. package/models/components/internalservererror.js.map +0 -1
  258. package/models/components/inviteexpired.d.ts.map +0 -1
  259. package/models/components/inviteexpired.js.map +0 -1
  260. package/models/components/notfound.d.ts.map +0 -1
  261. package/models/components/notfound.js.map +0 -1
  262. package/models/components/ratelimitexceeded.d.ts.map +0 -1
  263. package/models/components/ratelimitexceeded.js.map +0 -1
  264. package/models/components/unauthorized.d.ts.map +0 -1
  265. package/models/components/unauthorized.js.map +0 -1
  266. package/models/components/unprocessableentity.d.ts.map +0 -1
  267. package/models/components/unprocessableentity.js.map +0 -1
  268. package/models/operations/getworkspaces.d.ts +0 -11
  269. package/models/operations/getworkspaces.d.ts.map +0 -1
  270. package/models/operations/getworkspaces.js +0 -60
  271. package/models/operations/getworkspaces.js.map +0 -1
  272. package/src/models/operations/getworkspaces.ts +0 -71
package/docs/sdks/domains/README.md CHANGED
@@ -45,12 +45,21 @@ run();
45
45
 
46
46
  ### Response
47
47
 
48
- **Promise<[operations.ListDomainsResponse](../../models/operations/listdomainsresponse.md)>**
48
+ **Promise<[components.DomainSchema[]](../../models/.md)>**
49
49
  ### Errors
50
50
 
51
- | Error Object | Status Code | Content Type |
52
- | --------------- | --------------- | --------------- |
53
- | errors.SDKError | 4xx-5xx | */* |
51
+ | Error Object | Status Code | Content Type |
52
+ | -------------------------- | -------------------------- | -------------------------- |
53
+ | errors.BadRequest | 400 | application/json |
54
+ | errors.Unauthorized | 401 | application/json |
55
+ | errors.Forbidden | 403 | application/json |
56
+ | errors.NotFound | 404 | application/json |
57
+ | errors.Conflict | 409 | application/json |
58
+ | errors.InviteExpired | 410 | application/json |
59
+ | errors.UnprocessableEntity | 422 | application/json |
60
+ | errors.RateLimitExceeded | 429 | application/json |
61
+ | errors.InternalServerError | 500 | application/json |
62
+ | errors.SDKError | 4xx-5xx | */* |
54
63
 
55
64
  ## add
56
65
 
@@ -60,6 +69,7 @@ Add a domain to the authenticated workspace.
60
69
 
61
70
  ```typescript
62
71
  import { Dub } from "dub";
72
+ import { Type } from "dub/models/operations";
63
73
 
64
74
  const dub = new Dub({
65
75
  token: "DUB_API_KEY",
@@ -68,7 +78,12 @@ const dub = new Dub({
68
78
 
69
79
  async function run() {
70
80
  const result = await dub.domains.add({
71
- slug: "<value>",
81
+ slug: "acme.com",
82
+ type: Type.Redirect,
83
+ target: "https://acme.com/landing",
84
+ expiredUrl: "https://acme.com/expired",
85
+ archived: false,
86
+ placeholder: "https://dub.co/help/article/what-is-dub",
72
87
  });
73
88
 
74
89
  // Handle the result
@@ -89,12 +104,21 @@ run();
89
104
 
90
105
  ### Response
91
106
 
92
- **Promise<[operations.AddDomainResponse](../../models/operations/adddomainresponse.md)>**
107
+ **Promise<[components.DomainSchema](../../models/components/domainschema.md)>**
93
108
  ### Errors
94
109
 
95
- | Error Object | Status Code | Content Type |
96
- | --------------- | --------------- | --------------- |
97
- | errors.SDKError | 4xx-5xx | */* |
110
+ | Error Object | Status Code | Content Type |
111
+ | -------------------------- | -------------------------- | -------------------------- |
112
+ | errors.BadRequest | 400 | application/json |
113
+ | errors.Unauthorized | 401 | application/json |
114
+ | errors.Forbidden | 403 | application/json |
115
+ | errors.NotFound | 404 | application/json |
116
+ | errors.Conflict | 409 | application/json |
117
+ | errors.InviteExpired | 410 | application/json |
118
+ | errors.UnprocessableEntity | 422 | application/json |
119
+ | errors.RateLimitExceeded | 429 | application/json |
120
+ | errors.InternalServerError | 500 | application/json |
121
+ | errors.SDKError | 4xx-5xx | */* |
98
122
 
99
123
  ## delete
100
124
 
@@ -133,12 +157,21 @@ run();
133
157
 
134
158
  ### Response
135
159
 
136
- **Promise<[operations.DeleteDomainResponse](../../models/operations/deletedomainresponse.md)>**
160
+ **Promise<[operations.DeleteDomainResponseBody](../../models/operations/deletedomainresponsebody.md)>**
137
161
  ### Errors
138
162
 
139
- | Error Object | Status Code | Content Type |
140
- | --------------- | --------------- | --------------- |
141
- | errors.SDKError | 4xx-5xx | */* |
163
+ | Error Object | Status Code | Content Type |
164
+ | -------------------------- | -------------------------- | -------------------------- |
165
+ | errors.BadRequest | 400 | application/json |
166
+ | errors.Unauthorized | 401 | application/json |
167
+ | errors.Forbidden | 403 | application/json |
168
+ | errors.NotFound | 404 | application/json |
169
+ | errors.Conflict | 409 | application/json |
170
+ | errors.InviteExpired | 410 | application/json |
171
+ | errors.UnprocessableEntity | 422 | application/json |
172
+ | errors.RateLimitExceeded | 429 | application/json |
173
+ | errors.InternalServerError | 500 | application/json |
174
+ | errors.SDKError | 4xx-5xx | */* |
142
175
 
143
176
  ## update
144
177
 
@@ -148,6 +181,7 @@ Edit a domain for the authenticated workspace.
148
181
 
149
182
  ```typescript
150
183
  import { Dub } from "dub";
184
+ import { EditDomainType } from "dub/models/operations";
151
185
 
152
186
  const dub = new Dub({
153
187
  token: "DUB_API_KEY",
@@ -155,10 +189,17 @@ const dub = new Dub({
155
189
  });
156
190
 
157
191
  async function run() {
158
- const result = await dub.domains.update({
192
+ const slug = "acme.com";
193
+ const requestBody = {
159
194
  slug: "acme.com",
160
- requestBody: {},
161
- });
195
+ type: EditDomainType.Redirect,
196
+ target: "https://acme.com/landing",
197
+ expiredUrl: "https://acme.com/expired",
198
+ archived: false,
199
+ placeholder: "https://dub.co/help/article/what-is-dub",
200
+ };
201
+
202
+ const result = await dub.domains.update(slug, requestBody);
162
203
 
163
204
  // Handle the result
164
205
  console.log(result)
@@ -169,21 +210,31 @@ run();
169
210
 
170
211
  ### Parameters
171
212
 
172
- | Parameter | Type | Required | Description |
173
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
174
- | `request` | [operations.EditDomainRequest](../../models/operations/editdomainrequest.md) | :heavy_check_mark: | The request object to use for the request. |
175
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
176
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
213
+ | Parameter | Type | Required | Description | Example |
214
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
215
+ | `slug` | *string* | :heavy_check_mark: | The domain name. | [object Object] |
216
+ | `requestBody` | [operations.EditDomainRequestBody](../../models/operations/editdomainrequestbody.md) | :heavy_minus_sign: | N/A | |
217
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
218
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
177
219
 
178
220
 
179
221
  ### Response
180
222
 
181
- **Promise<[operations.EditDomainResponse](../../models/operations/editdomainresponse.md)>**
223
+ **Promise<[components.DomainSchema](../../models/components/domainschema.md)>**
182
224
  ### Errors
183
225
 
184
- | Error Object | Status Code | Content Type |
185
- | --------------- | --------------- | --------------- |
186
- | errors.SDKError | 4xx-5xx | */* |
226
+ | Error Object | Status Code | Content Type |
227
+ | -------------------------- | -------------------------- | -------------------------- |
228
+ | errors.BadRequest | 400 | application/json |
229
+ | errors.Unauthorized | 401 | application/json |
230
+ | errors.Forbidden | 403 | application/json |
231
+ | errors.NotFound | 404 | application/json |
232
+ | errors.Conflict | 409 | application/json |
233
+ | errors.InviteExpired | 410 | application/json |
234
+ | errors.UnprocessableEntity | 422 | application/json |
235
+ | errors.RateLimitExceeded | 429 | application/json |
236
+ | errors.InternalServerError | 500 | application/json |
237
+ | errors.SDKError | 4xx-5xx | */* |
187
238
 
188
239
  ## setPrimary
189
240
 
@@ -222,12 +273,21 @@ run();
222
273
 
223
274
  ### Response
224
275
 
225
- **Promise<[operations.SetPrimaryDomainResponse](../../models/operations/setprimarydomainresponse.md)>**
276
+ **Promise<[components.DomainSchema](../../models/components/domainschema.md)>**
226
277
  ### Errors
227
278
 
228
- | Error Object | Status Code | Content Type |
229
- | --------------- | --------------- | --------------- |
230
- | errors.SDKError | 4xx-5xx | */* |
279
+ | Error Object | Status Code | Content Type |
280
+ | -------------------------- | -------------------------- | -------------------------- |
281
+ | errors.BadRequest | 400 | application/json |
282
+ | errors.Unauthorized | 401 | application/json |
283
+ | errors.Forbidden | 403 | application/json |
284
+ | errors.NotFound | 404 | application/json |
285
+ | errors.Conflict | 409 | application/json |
286
+ | errors.InviteExpired | 410 | application/json |
287
+ | errors.UnprocessableEntity | 422 | application/json |
288
+ | errors.RateLimitExceeded | 429 | application/json |
289
+ | errors.InternalServerError | 500 | application/json |
290
+ | errors.SDKError | 4xx-5xx | */* |
231
291
 
232
292
  ## transfer
233
293
 
@@ -244,12 +304,12 @@ const dub = new Dub({
244
304
  });
245
305
 
246
306
  async function run() {
247
- const result = await dub.domains.transfer({
248
- slug: "acme.com",
249
- requestBody: {
250
- newWorkspaceId: "<value>",
251
- },
252
- });
307
+ const slug = "acme.com";
308
+ const requestBody = {
309
+ newWorkspaceId: "<value>",
310
+ };
311
+
312
+ const result = await dub.domains.transfer(slug, requestBody);
253
313
 
254
314
  // Handle the result
255
315
  console.log(result)
@@ -260,18 +320,28 @@ run();
260
320
 
261
321
  ### Parameters
262
322
 
263
- | Parameter | Type | Required | Description |
264
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
265
- | `request` | [operations.TransferDomainRequest](../../models/operations/transferdomainrequest.md) | :heavy_check_mark: | The request object to use for the request. |
266
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
267
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
323
+ | Parameter | Type | Required | Description | Example |
324
+ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
325
+ | `slug` | *string* | :heavy_check_mark: | The domain name. | [object Object] |
326
+ | `requestBody` | [operations.TransferDomainRequestBody](../../models/operations/transferdomainrequestbody.md) | :heavy_minus_sign: | N/A | |
327
+ | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | |
328
+ | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. | |
268
329
 
269
330
 
270
331
  ### Response
271
332
 
272
- **Promise<[operations.TransferDomainResponse](../../models/operations/transferdomainresponse.md)>**
333
+ **Promise<[components.DomainSchema](../../models/components/domainschema.md)>**
273
334
  ### Errors
274
335
 
275
- | Error Object | Status Code | Content Type |
276
- | --------------- | --------------- | --------------- |
277
- | errors.SDKError | 4xx-5xx | */* |
336
+ | Error Object | Status Code | Content Type |
337
+ | -------------------------- | -------------------------- | -------------------------- |
338
+ | errors.BadRequest | 400 | application/json |
339
+ | errors.Unauthorized | 401 | application/json |
340
+ | errors.Forbidden | 403 | application/json |
341
+ | errors.NotFound | 404 | application/json |
342
+ | errors.Conflict | 409 | application/json |
343
+ | errors.InviteExpired | 410 | application/json |
344
+ | errors.UnprocessableEntity | 422 | application/json |
345
+ | errors.RateLimitExceeded | 429 | application/json |
346
+ | errors.InternalServerError | 500 | application/json |
347
+ | errors.SDKError | 4xx-5xx | */* |
package/docs/sdks/links/README.md CHANGED
@@ -30,6 +30,7 @@ async function run() {
30
30
  tagIds: [
31
31
  "<value>",
32
32
  ],
33
+ tagNames: "<value>",
33
34
  });
34
35
 
35
36
  // Handle the result
@@ -50,12 +51,21 @@ run();
50
51
 
51
52
  ### Response
52
53
 
53
- **Promise<[operations.GetLinksResponse](../../models/operations/getlinksresponse.md)>**
54
+ **Promise<[components.LinkSchema[]](../../models/.md)>**
54
55
  ### Errors
55
56
 
56
- | Error Object | Status Code | Content Type |
57
- | --------------- | --------------- | --------------- |
58
- | errors.SDKError | 4xx-5xx | */* |
57
+ | Error Object | Status Code | Content Type |
58
+ | -------------------------- | -------------------------- | -------------------------- |
59
+ | errors.BadRequest | 400 | application/json |
60
+ | errors.Unauthorized | 401 | application/json |
61
+ | errors.Forbidden | 403 | application/json |
62
+ | errors.NotFound | 404 | application/json |
63
+ | errors.Conflict | 409 | application/json |
64
+ | errors.InviteExpired | 410 | application/json |
65
+ | errors.UnprocessableEntity | 422 | application/json |
66
+ | errors.RateLimitExceeded | 429 | application/json |
67
+ | errors.InternalServerError | 500 | application/json |
68
+ | errors.SDKError | 4xx-5xx | */* |
59
69
 
60
70
  ## create
61
71
 
@@ -77,6 +87,7 @@ async function run() {
77
87
  tagIds: [
78
88
  "clux0rgak00011...",
79
89
  ],
90
+ tagNames: "<value>",
80
91
  geo: {},
81
92
  });
82
93
 
@@ -98,12 +109,21 @@ run();
98
109
 
99
110
  ### Response
100
111
 
101
- **Promise<[operations.CreateLinkResponse](../../models/operations/createlinkresponse.md)>**
112
+ **Promise<[components.LinkSchema](../../models/components/linkschema.md)>**
102
113
  ### Errors
103
114
 
104
- | Error Object | Status Code | Content Type |
105
- | --------------- | --------------- | --------------- |
106
- | errors.SDKError | 4xx-5xx | */* |
115
+ | Error Object | Status Code | Content Type |
116
+ | -------------------------- | -------------------------- | -------------------------- |
117
+ | errors.BadRequest | 400 | application/json |
118
+ | errors.Unauthorized | 401 | application/json |
119
+ | errors.Forbidden | 403 | application/json |
120
+ | errors.NotFound | 404 | application/json |
121
+ | errors.Conflict | 409 | application/json |
122
+ | errors.InviteExpired | 410 | application/json |
123
+ | errors.UnprocessableEntity | 422 | application/json |
124
+ | errors.RateLimitExceeded | 429 | application/json |
125
+ | errors.InternalServerError | 500 | application/json |
126
+ | errors.SDKError | 4xx-5xx | */* |
107
127
 
108
128
  ## count
109
129
 
@@ -123,6 +143,7 @@ const dub = new Dub({
123
143
  async function run() {
124
144
  const result = await dub.links.count({
125
145
  tagIds: "<value>",
146
+ tagNames: "<value>",
126
147
  groupBy: One.Domain,
127
148
  });
128
149
 
@@ -144,12 +165,21 @@ run();
144
165
 
145
166
  ### Response
146
167
 
147
- **Promise<[operations.GetLinksCountResponse](../../models/operations/getlinkscountresponse.md)>**
168
+ **Promise<[number](../../models/.md)>**
148
169
  ### Errors
149
170
 
150
- | Error Object | Status Code | Content Type |
151
- | --------------- | --------------- | --------------- |
152
- | errors.SDKError | 4xx-5xx | */* |
171
+ | Error Object | Status Code | Content Type |
172
+ | -------------------------- | -------------------------- | -------------------------- |
173
+ | errors.BadRequest | 400 | application/json |
174
+ | errors.Unauthorized | 401 | application/json |
175
+ | errors.Forbidden | 403 | application/json |
176
+ | errors.NotFound | 404 | application/json |
177
+ | errors.Conflict | 409 | application/json |
178
+ | errors.InviteExpired | 410 | application/json |
179
+ | errors.UnprocessableEntity | 422 | application/json |
180
+ | errors.RateLimitExceeded | 429 | application/json |
181
+ | errors.InternalServerError | 500 | application/json |
182
+ | errors.SDKError | 4xx-5xx | */* |
153
183
 
154
184
  ## get
155
185
 
@@ -189,12 +219,21 @@ run();
189
219
 
190
220
  ### Response
191
221
 
192
- **Promise<[operations.GetLinkInfoResponse](../../models/operations/getlinkinforesponse.md)>**
222
+ **Promise<[components.LinkSchema](../../models/components/linkschema.md)>**
193
223
  ### Errors
194
224
 
195
- | Error Object | Status Code | Content Type |
196
- | --------------- | --------------- | --------------- |
197
- | errors.SDKError | 4xx-5xx | */* |
225
+ | Error Object | Status Code | Content Type |
226
+ | -------------------------- | -------------------------- | -------------------------- |
227
+ | errors.BadRequest | 400 | application/json |
228
+ | errors.Unauthorized | 401 | application/json |
229
+ | errors.Forbidden | 403 | application/json |
230
+ | errors.NotFound | 404 | application/json |
231
+ | errors.Conflict | 409 | application/json |
232
+ | errors.InviteExpired | 410 | application/json |
233
+ | errors.UnprocessableEntity | 422 | application/json |
234
+ | errors.RateLimitExceeded | 429 | application/json |
235
+ | errors.InternalServerError | 500 | application/json |
236
+ | errors.SDKError | 4xx-5xx | */* |
198
237
 
199
238
  ## update
200
239
 
@@ -217,6 +256,9 @@ async function run() {
217
256
  tagIds: [
218
257
  "clux0rgak00011...",
219
258
  ],
259
+ tagNames: [
260
+ "<value>",
261
+ ],
220
262
  geo: {},
221
263
  };
222
264
 
@@ -241,12 +283,21 @@ run();
241
283
 
242
284
  ### Response
243
285
 
244
- **Promise<[operations.EditLinkResponse](../../models/operations/editlinkresponse.md)>**
286
+ **Promise<[components.LinkSchema](../../models/components/linkschema.md)>**
245
287
  ### Errors
246
288
 
247
- | Error Object | Status Code | Content Type |
248
- | --------------- | --------------- | --------------- |
249
- | errors.SDKError | 4xx-5xx | */* |
289
+ | Error Object | Status Code | Content Type |
290
+ | -------------------------- | -------------------------- | -------------------------- |
291
+ | errors.BadRequest | 400 | application/json |
292
+ | errors.Unauthorized | 401 | application/json |
293
+ | errors.Forbidden | 403 | application/json |
294
+ | errors.NotFound | 404 | application/json |
295
+ | errors.Conflict | 409 | application/json |
296
+ | errors.InviteExpired | 410 | application/json |
297
+ | errors.UnprocessableEntity | 422 | application/json |
298
+ | errors.RateLimitExceeded | 429 | application/json |
299
+ | errors.InternalServerError | 500 | application/json |
300
+ | errors.SDKError | 4xx-5xx | */* |
250
301
 
251
302
  ## delete
252
303
 
@@ -285,12 +336,21 @@ run();
285
336
 
286
337
  ### Response
287
338
 
288
- **Promise<[operations.DeleteLinkResponse](../../models/operations/deletelinkresponse.md)>**
339
+ **Promise<[operations.DeleteLinkResponseBody](../../models/operations/deletelinkresponsebody.md)>**
289
340
  ### Errors
290
341
 
291
- | Error Object | Status Code | Content Type |
292
- | --------------- | --------------- | --------------- |
293
- | errors.SDKError | 4xx-5xx | */* |
342
+ | Error Object | Status Code | Content Type |
343
+ | -------------------------- | -------------------------- | -------------------------- |
344
+ | errors.BadRequest | 400 | application/json |
345
+ | errors.Unauthorized | 401 | application/json |
346
+ | errors.Forbidden | 403 | application/json |
347
+ | errors.NotFound | 404 | application/json |
348
+ | errors.Conflict | 409 | application/json |
349
+ | errors.InviteExpired | 410 | application/json |
350
+ | errors.UnprocessableEntity | 422 | application/json |
351
+ | errors.RateLimitExceeded | 429 | application/json |
352
+ | errors.InternalServerError | 500 | application/json |
353
+ | errors.SDKError | 4xx-5xx | */* |
294
354
 
295
355
  ## createMany
296
356
 
@@ -313,6 +373,9 @@ async function run() {
313
373
  tagIds: [
314
374
  "clux0rgak00011...",
315
375
  ],
376
+ tagNames: [
377
+ "<value>",
378
+ ],
316
379
  geo: {},
317
380
  },
318
381
  ]);
@@ -335,9 +398,18 @@ run();
335
398
 
336
399
  ### Response
337
400
 
338
- **Promise<[operations.BulkCreateLinksResponse](../../models/operations/bulkcreatelinksresponse.md)>**
401
+ **Promise<[components.LinkSchema[]](../../models/.md)>**
339
402
  ### Errors
340
403
 
341
- | Error Object | Status Code | Content Type |
342
- | --------------- | --------------- | --------------- |
343
- | errors.SDKError | 4xx-5xx | */* |
404
+ | Error Object | Status Code | Content Type |
405
+ | -------------------------- | -------------------------- | -------------------------- |
406
+ | errors.BadRequest | 400 | application/json |
407
+ | errors.Unauthorized | 401 | application/json |
408
+ | errors.Forbidden | 403 | application/json |
409
+ | errors.NotFound | 404 | application/json |
410
+ | errors.Conflict | 409 | application/json |
411
+ | errors.InviteExpired | 410 | application/json |
412
+ | errors.UnprocessableEntity | 422 | application/json |
413
+ | errors.RateLimitExceeded | 429 | application/json |
414
+ | errors.InternalServerError | 500 | application/json |
415
+ | errors.SDKError | 4xx-5xx | */* |
package/docs/sdks/qrcodes/README.md CHANGED
@@ -40,9 +40,18 @@ run();
40
40
 
41
41
  ### Response
42
42
 
43
- **Promise<[operations.GetQRCodeResponse](../../models/operations/getqrcoderesponse.md)>**
43
+ **Promise<[string](../../models/.md)>**
44
44
  ### Errors
45
45
 
46
- | Error Object | Status Code | Content Type |
47
- | --------------- | --------------- | --------------- |
48
- | errors.SDKError | 4xx-5xx | */* |
46
+ | Error Object | Status Code | Content Type |
47
+ | -------------------------- | -------------------------- | -------------------------- |
48
+ | errors.BadRequest | 400 | application/json |
49
+ | errors.Unauthorized | 401 | application/json |
50
+ | errors.Forbidden | 403 | application/json |
51
+ | errors.NotFound | 404 | application/json |
52
+ | errors.Conflict | 409 | application/json |
53
+ | errors.InviteExpired | 410 | application/json |
54
+ | errors.UnprocessableEntity | 422 | application/json |
55
+ | errors.RateLimitExceeded | 429 | application/json |
56
+ | errors.InternalServerError | 500 | application/json |
57
+ | errors.SDKError | 4xx-5xx | */* |
package/docs/sdks/tags/README.md CHANGED
@@ -41,12 +41,21 @@ run();
41
41
 
42
42
  ### Response
43
43
 
44
- **Promise<[operations.GetTagsResponse](../../models/operations/gettagsresponse.md)>**
44
+ **Promise<[components.TagSchema[]](../../models/.md)>**
45
45
  ### Errors
46
46
 
47
- | Error Object | Status Code | Content Type |
48
- | --------------- | --------------- | --------------- |
49
- | errors.SDKError | 4xx-5xx | */* |
47
+ | Error Object | Status Code | Content Type |
48
+ | -------------------------- | -------------------------- | -------------------------- |
49
+ | errors.BadRequest | 400 | application/json |
50
+ | errors.Unauthorized | 401 | application/json |
51
+ | errors.Forbidden | 403 | application/json |
52
+ | errors.NotFound | 404 | application/json |
53
+ | errors.Conflict | 409 | application/json |
54
+ | errors.InviteExpired | 410 | application/json |
55
+ | errors.UnprocessableEntity | 422 | application/json |
56
+ | errors.RateLimitExceeded | 429 | application/json |
57
+ | errors.InternalServerError | 500 | application/json |
58
+ | errors.SDKError | 4xx-5xx | */* |
50
59
 
51
60
  ## create
52
61
 
@@ -85,9 +94,18 @@ run();
85
94
 
86
95
  ### Response
87
96
 
88
- **Promise<[operations.CreateTagResponse](../../models/operations/createtagresponse.md)>**
97
+ **Promise<[components.TagSchema](../../models/components/tagschema.md)>**
89
98
  ### Errors
90
99
 
91
- | Error Object | Status Code | Content Type |
92
- | --------------- | --------------- | --------------- |
93
- | errors.SDKError | 4xx-5xx | */* |
100
+ | Error Object | Status Code | Content Type |
101
+ | -------------------------- | -------------------------- | -------------------------- |
102
+ | errors.BadRequest | 400 | application/json |
103
+ | errors.Unauthorized | 401 | application/json |
104
+ | errors.Forbidden | 403 | application/json |
105
+ | errors.NotFound | 404 | application/json |
106
+ | errors.Conflict | 409 | application/json |
107
+ | errors.InviteExpired | 410 | application/json |
108
+ | errors.UnprocessableEntity | 422 | application/json |
109
+ | errors.RateLimitExceeded | 429 | application/json |
110
+ | errors.InternalServerError | 500 | application/json |
111
+ | errors.SDKError | 4xx-5xx | */* |