auth0 5.7.0 → 5.9.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.
Files changed (326) hide show
  1. package/dist/cjs/management/Client.d.ts +3 -0
  2. package/dist/cjs/management/Client.js +67 -62
  3. package/dist/cjs/management/api/errors/GoneError.d.ts +5 -0
  4. package/dist/cjs/management/api/errors/GoneError.js +54 -0
  5. package/dist/cjs/management/api/errors/index.d.ts +1 -0
  6. package/dist/cjs/management/api/errors/index.js +1 -0
  7. package/dist/cjs/management/api/requests/requests.d.ts +56 -10
  8. package/dist/cjs/management/api/resources/actions/client/Client.js +15 -7
  9. package/dist/cjs/management/api/resources/actions/resources/executions/client/Client.js +1 -1
  10. package/dist/cjs/management/api/resources/actions/resources/modules/client/Client.js +15 -7
  11. package/dist/cjs/management/api/resources/actions/resources/modules/resources/versions/client/Client.js +7 -3
  12. package/dist/cjs/management/api/resources/actions/resources/triggers/client/Client.js +1 -1
  13. package/dist/cjs/management/api/resources/actions/resources/triggers/resources/bindings/client/Client.js +6 -2
  14. package/dist/cjs/management/api/resources/actions/resources/versions/client/Client.js +7 -3
  15. package/dist/cjs/management/api/resources/anomaly/resources/blocks/client/Client.js +2 -2
  16. package/dist/cjs/management/api/resources/attackProtection/resources/botDetection/client/Client.js +2 -2
  17. package/dist/cjs/management/api/resources/attackProtection/resources/breachedPasswordDetection/client/Client.js +2 -2
  18. package/dist/cjs/management/api/resources/attackProtection/resources/bruteForceProtection/client/Client.js +2 -2
  19. package/dist/cjs/management/api/resources/attackProtection/resources/captcha/client/Client.js +2 -2
  20. package/dist/cjs/management/api/resources/attackProtection/resources/suspiciousIpThrottling/client/Client.js +2 -2
  21. package/dist/cjs/management/api/resources/branding/client/Client.js +2 -2
  22. package/dist/cjs/management/api/resources/branding/resources/phone/resources/providers/client/Client.js +10 -6
  23. package/dist/cjs/management/api/resources/branding/resources/phone/resources/templates/client/Client.js +11 -7
  24. package/dist/cjs/management/api/resources/branding/resources/templates/client/Client.js +3 -3
  25. package/dist/cjs/management/api/resources/branding/resources/themes/client/Client.js +5 -5
  26. package/dist/cjs/management/api/resources/clientGrants/client/Client.js +9 -5
  27. package/dist/cjs/management/api/resources/clientGrants/resources/organizations/client/Client.js +5 -1
  28. package/dist/cjs/management/api/resources/clients/client/Client.js +16 -8
  29. package/dist/cjs/management/api/resources/clients/resources/connections/client/Client.d.ts +1 -0
  30. package/dist/cjs/management/api/resources/clients/resources/connections/client/Client.js +6 -1
  31. package/dist/cjs/management/api/resources/clients/resources/credentials/client/Client.js +5 -5
  32. package/dist/cjs/management/api/resources/connectionProfiles/client/Client.js +11 -7
  33. package/dist/cjs/management/api/resources/connections/client/Client.d.ts +1 -0
  34. package/dist/cjs/management/api/resources/connections/client/Client.js +15 -6
  35. package/dist/cjs/management/api/resources/connections/resources/clients/client/Client.js +6 -2
  36. package/dist/cjs/management/api/resources/connections/resources/directoryProvisioning/client/Client.js +16 -8
  37. package/dist/cjs/management/api/resources/connections/resources/directoryProvisioning/resources/synchronizations/client/Client.js +1 -1
  38. package/dist/cjs/management/api/resources/connections/resources/keys/client/Client.js +3 -3
  39. package/dist/cjs/management/api/resources/connections/resources/scimConfiguration/client/Client.js +10 -6
  40. package/dist/cjs/management/api/resources/connections/resources/scimConfiguration/resources/tokens/client/Client.js +3 -3
  41. package/dist/cjs/management/api/resources/connections/resources/users/client/Client.js +5 -1
  42. package/dist/cjs/management/api/resources/customDomains/client/Client.js +13 -9
  43. package/dist/cjs/management/api/resources/deviceCredentials/client/Client.js +7 -3
  44. package/dist/cjs/management/api/resources/emailTemplates/client/Client.js +4 -4
  45. package/dist/cjs/management/api/resources/emails/resources/provider/client/Client.js +8 -4
  46. package/dist/cjs/management/api/resources/eventStreams/client/Client.js +10 -6
  47. package/dist/cjs/management/api/resources/eventStreams/resources/deliveries/client/Client.js +6 -2
  48. package/dist/cjs/management/api/resources/eventStreams/resources/redeliveries/client/Client.js +2 -2
  49. package/dist/cjs/management/api/resources/events/client/Client.d.ts +18 -0
  50. package/dist/cjs/management/api/resources/events/client/Client.js +135 -0
  51. package/dist/cjs/management/api/resources/events/client/index.d.ts +1 -0
  52. package/dist/cjs/management/api/resources/events/client/index.js +2 -0
  53. package/dist/cjs/management/api/resources/events/index.d.ts +1 -0
  54. package/dist/cjs/management/api/resources/events/index.js +17 -0
  55. package/dist/cjs/management/api/resources/flows/client/Client.d.ts +4 -1
  56. package/dist/cjs/management/api/resources/flows/client/Client.js +17 -6
  57. package/dist/cjs/management/api/resources/flows/resources/executions/client/Client.d.ts +3 -1
  58. package/dist/cjs/management/api/resources/flows/resources/executions/client/Client.js +14 -4
  59. package/dist/cjs/management/api/resources/flows/resources/vault/resources/connections/client/Client.js +9 -5
  60. package/dist/cjs/management/api/resources/forms/client/Client.d.ts +5 -2
  61. package/dist/cjs/management/api/resources/forms/client/Client.js +18 -7
  62. package/dist/cjs/management/api/resources/groups/client/Client.d.ts +1 -0
  63. package/dist/cjs/management/api/resources/groups/client/Client.js +10 -4
  64. package/dist/cjs/management/api/resources/groups/resources/members/client/Client.js +5 -1
  65. package/dist/cjs/management/api/resources/guardian/resources/enrollments/client/Client.js +3 -3
  66. package/dist/cjs/management/api/resources/guardian/resources/factors/client/Client.js +2 -2
  67. package/dist/cjs/management/api/resources/guardian/resources/factors/resources/duo/resources/settings/client/Client.js +3 -3
  68. package/dist/cjs/management/api/resources/guardian/resources/factors/resources/phone/client/Client.js +8 -8
  69. package/dist/cjs/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.js +12 -12
  70. package/dist/cjs/management/api/resources/guardian/resources/factors/resources/sms/client/Client.js +6 -6
  71. package/dist/cjs/management/api/resources/guardian/resources/policies/client/Client.js +2 -2
  72. package/dist/cjs/management/api/resources/hooks/client/Client.js +13 -5
  73. package/dist/cjs/management/api/resources/hooks/resources/secrets/client/Client.js +4 -4
  74. package/dist/cjs/management/api/resources/index.d.ts +1 -0
  75. package/dist/cjs/management/api/resources/index.js +2 -1
  76. package/dist/cjs/management/api/resources/jobs/client/Client.js +1 -1
  77. package/dist/cjs/management/api/resources/jobs/resources/errors/client/Client.js +1 -1
  78. package/dist/cjs/management/api/resources/jobs/resources/usersExports/client/Client.js +1 -1
  79. package/dist/cjs/management/api/resources/jobs/resources/usersImports/client/Client.js +1 -1
  80. package/dist/cjs/management/api/resources/jobs/resources/verificationEmail/client/Client.js +1 -1
  81. package/dist/cjs/management/api/resources/keys/resources/customSigning/client/Client.js +3 -3
  82. package/dist/cjs/management/api/resources/keys/resources/encryption/client/Client.js +11 -7
  83. package/dist/cjs/management/api/resources/keys/resources/signing/client/Client.js +4 -4
  84. package/dist/cjs/management/api/resources/logStreams/client/Client.d.ts +465 -300
  85. package/dist/cjs/management/api/resources/logStreams/client/Client.js +470 -305
  86. package/dist/cjs/management/api/resources/logs/client/Client.js +6 -2
  87. package/dist/cjs/management/api/resources/networkAcls/client/Client.js +10 -6
  88. package/dist/cjs/management/api/resources/organizations/client/Client.js +10 -6
  89. package/dist/cjs/management/api/resources/organizations/resources/clientGrants/client/Client.d.ts +1 -0
  90. package/dist/cjs/management/api/resources/organizations/resources/clientGrants/client/Client.js +8 -3
  91. package/dist/cjs/management/api/resources/organizations/resources/connections/client/Client.js +9 -5
  92. package/dist/cjs/management/api/resources/organizations/resources/discoveryDomains/client/Client.js +10 -6
  93. package/dist/cjs/management/api/resources/organizations/resources/enabledConnections/client/Client.js +9 -5
  94. package/dist/cjs/management/api/resources/organizations/resources/invitations/client/Client.js +12 -4
  95. package/dist/cjs/management/api/resources/organizations/resources/members/client/Client.js +7 -3
  96. package/dist/cjs/management/api/resources/organizations/resources/members/resources/roles/client/Client.js +7 -3
  97. package/dist/cjs/management/api/resources/prompts/client/Client.js +2 -2
  98. package/dist/cjs/management/api/resources/prompts/resources/customText/client/Client.js +2 -2
  99. package/dist/cjs/management/api/resources/prompts/resources/partials/client/Client.js +2 -2
  100. package/dist/cjs/management/api/resources/prompts/resources/rendering/client/Client.js +8 -4
  101. package/dist/cjs/management/api/resources/refreshTokens/client/Client.d.ts +17 -0
  102. package/dist/cjs/management/api/resources/refreshTokens/client/Client.js +71 -4
  103. package/dist/cjs/management/api/resources/resourceServers/client/Client.d.ts +1 -0
  104. package/dist/cjs/management/api/resources/resourceServers/client/Client.js +14 -5
  105. package/dist/cjs/management/api/resources/riskAssessments/resources/settings/client/Client.js +2 -2
  106. package/dist/cjs/management/api/resources/riskAssessments/resources/settings/resources/newDevice/client/Client.js +2 -2
  107. package/dist/cjs/management/api/resources/roles/client/Client.js +9 -5
  108. package/dist/cjs/management/api/resources/roles/resources/permissions/client/Client.js +7 -3
  109. package/dist/cjs/management/api/resources/roles/resources/users/client/Client.js +6 -2
  110. package/dist/cjs/management/api/resources/rules/client/Client.js +13 -5
  111. package/dist/cjs/management/api/resources/rulesConfigs/client/Client.js +3 -3
  112. package/dist/cjs/management/api/resources/selfServiceProfiles/client/Client.js +9 -5
  113. package/dist/cjs/management/api/resources/selfServiceProfiles/resources/customText/client/Client.d.ts +2 -2
  114. package/dist/cjs/management/api/resources/selfServiceProfiles/resources/customText/client/Client.js +4 -4
  115. package/dist/cjs/management/api/resources/selfServiceProfiles/resources/ssoTicket/client/Client.d.ts +2 -2
  116. package/dist/cjs/management/api/resources/selfServiceProfiles/resources/ssoTicket/client/Client.js +4 -4
  117. package/dist/cjs/management/api/resources/sessions/client/Client.js +4 -4
  118. package/dist/cjs/management/api/resources/stats/client/Client.js +6 -2
  119. package/dist/cjs/management/api/resources/supplementalSignals/client/Client.js +2 -2
  120. package/dist/cjs/management/api/resources/tenants/resources/settings/client/Client.js +6 -2
  121. package/dist/cjs/management/api/resources/tickets/client/Client.js +2 -2
  122. package/dist/cjs/management/api/resources/tokenExchangeProfiles/client/Client.js +9 -5
  123. package/dist/cjs/management/api/resources/userAttributeProfiles/client/Client.d.ts +1 -1
  124. package/dist/cjs/management/api/resources/userAttributeProfiles/client/Client.js +12 -8
  125. package/dist/cjs/management/api/resources/userBlocks/client/Client.js +16 -4
  126. package/dist/cjs/management/api/resources/userGrants/client/Client.js +11 -3
  127. package/dist/cjs/management/api/resources/users/client/Client.js +20 -8
  128. package/dist/cjs/management/api/resources/users/resources/authenticationMethods/client/Client.js +11 -7
  129. package/dist/cjs/management/api/resources/users/resources/authenticators/client/Client.js +1 -1
  130. package/dist/cjs/management/api/resources/users/resources/connectedAccounts/client/Client.js +5 -1
  131. package/dist/cjs/management/api/resources/users/resources/enrollments/client/Client.js +1 -1
  132. package/dist/cjs/management/api/resources/users/resources/federatedConnectionsTokensets/client/Client.js +2 -2
  133. package/dist/cjs/management/api/resources/users/resources/groups/client/Client.js +5 -1
  134. package/dist/cjs/management/api/resources/users/resources/identities/client/Client.js +2 -2
  135. package/dist/cjs/management/api/resources/users/resources/logs/client/Client.js +5 -1
  136. package/dist/cjs/management/api/resources/users/resources/multifactor/client/Client.js +2 -2
  137. package/dist/cjs/management/api/resources/users/resources/organizations/client/Client.js +5 -1
  138. package/dist/cjs/management/api/resources/users/resources/permissions/client/Client.js +7 -3
  139. package/dist/cjs/management/api/resources/users/resources/refreshToken/client/Client.js +6 -2
  140. package/dist/cjs/management/api/resources/users/resources/riskAssessments/client/Client.js +1 -1
  141. package/dist/cjs/management/api/resources/users/resources/roles/client/Client.js +7 -3
  142. package/dist/cjs/management/api/resources/users/resources/sessions/client/Client.js +6 -2
  143. package/dist/cjs/management/api/resources/verifiableCredentials/resources/verification/resources/templates/client/Client.d.ts +1 -1
  144. package/dist/cjs/management/api/resources/verifiableCredentials/resources/verification/resources/templates/client/Client.js +10 -6
  145. package/dist/cjs/management/api/types/types.d.ts +3481 -148
  146. package/dist/cjs/management/api/types/types.js +623 -15
  147. package/dist/cjs/management/core/fetcher/Fetcher.d.ts +6 -0
  148. package/dist/cjs/management/core/fetcher/Fetcher.js +9 -8
  149. package/dist/cjs/management/core/index.d.ts +1 -0
  150. package/dist/cjs/management/core/index.js +1 -0
  151. package/dist/cjs/management/core/stream/Stream.d.ts +56 -0
  152. package/dist/cjs/management/core/stream/Stream.js +267 -0
  153. package/dist/cjs/management/core/stream/index.d.ts +1 -0
  154. package/dist/cjs/management/core/stream/index.js +5 -0
  155. package/dist/cjs/management/core/url/QueryStringBuilder.d.ts +47 -0
  156. package/dist/cjs/management/core/url/QueryStringBuilder.js +83 -0
  157. package/dist/cjs/management/core/url/index.d.ts +1 -0
  158. package/dist/cjs/management/core/url/index.js +3 -1
  159. package/dist/cjs/management/core/url/qs.d.ts +2 -1
  160. package/dist/cjs/management/core/url/qs.js +24 -12
  161. package/dist/cjs/management/version.d.ts +1 -1
  162. package/dist/cjs/management/version.js +1 -1
  163. package/dist/esm/management/Client.d.mts +3 -0
  164. package/dist/esm/management/Client.mjs +5 -0
  165. package/dist/esm/management/api/errors/GoneError.d.mts +5 -0
  166. package/dist/esm/management/api/errors/GoneError.mjs +17 -0
  167. package/dist/esm/management/api/errors/index.d.mts +1 -0
  168. package/dist/esm/management/api/errors/index.mjs +1 -0
  169. package/dist/esm/management/api/requests/requests.d.mts +56 -10
  170. package/dist/esm/management/api/resources/actions/client/Client.mjs +15 -7
  171. package/dist/esm/management/api/resources/actions/resources/executions/client/Client.mjs +1 -1
  172. package/dist/esm/management/api/resources/actions/resources/modules/client/Client.mjs +15 -7
  173. package/dist/esm/management/api/resources/actions/resources/modules/resources/versions/client/Client.mjs +7 -3
  174. package/dist/esm/management/api/resources/actions/resources/triggers/client/Client.mjs +1 -1
  175. package/dist/esm/management/api/resources/actions/resources/triggers/resources/bindings/client/Client.mjs +6 -2
  176. package/dist/esm/management/api/resources/actions/resources/versions/client/Client.mjs +7 -3
  177. package/dist/esm/management/api/resources/anomaly/resources/blocks/client/Client.mjs +2 -2
  178. package/dist/esm/management/api/resources/attackProtection/resources/botDetection/client/Client.mjs +2 -2
  179. package/dist/esm/management/api/resources/attackProtection/resources/breachedPasswordDetection/client/Client.mjs +2 -2
  180. package/dist/esm/management/api/resources/attackProtection/resources/bruteForceProtection/client/Client.mjs +2 -2
  181. package/dist/esm/management/api/resources/attackProtection/resources/captcha/client/Client.mjs +2 -2
  182. package/dist/esm/management/api/resources/attackProtection/resources/suspiciousIpThrottling/client/Client.mjs +2 -2
  183. package/dist/esm/management/api/resources/branding/client/Client.mjs +2 -2
  184. package/dist/esm/management/api/resources/branding/resources/phone/resources/providers/client/Client.mjs +10 -6
  185. package/dist/esm/management/api/resources/branding/resources/phone/resources/templates/client/Client.mjs +11 -7
  186. package/dist/esm/management/api/resources/branding/resources/templates/client/Client.mjs +3 -3
  187. package/dist/esm/management/api/resources/branding/resources/themes/client/Client.mjs +5 -5
  188. package/dist/esm/management/api/resources/clientGrants/client/Client.mjs +9 -5
  189. package/dist/esm/management/api/resources/clientGrants/resources/organizations/client/Client.mjs +5 -1
  190. package/dist/esm/management/api/resources/clients/client/Client.mjs +16 -8
  191. package/dist/esm/management/api/resources/clients/resources/connections/client/Client.d.mts +1 -0
  192. package/dist/esm/management/api/resources/clients/resources/connections/client/Client.mjs +6 -1
  193. package/dist/esm/management/api/resources/clients/resources/credentials/client/Client.mjs +5 -5
  194. package/dist/esm/management/api/resources/connectionProfiles/client/Client.mjs +11 -7
  195. package/dist/esm/management/api/resources/connections/client/Client.d.mts +1 -0
  196. package/dist/esm/management/api/resources/connections/client/Client.mjs +15 -6
  197. package/dist/esm/management/api/resources/connections/resources/clients/client/Client.mjs +6 -2
  198. package/dist/esm/management/api/resources/connections/resources/directoryProvisioning/client/Client.mjs +16 -8
  199. package/dist/esm/management/api/resources/connections/resources/directoryProvisioning/resources/synchronizations/client/Client.mjs +1 -1
  200. package/dist/esm/management/api/resources/connections/resources/keys/client/Client.mjs +3 -3
  201. package/dist/esm/management/api/resources/connections/resources/scimConfiguration/client/Client.mjs +10 -6
  202. package/dist/esm/management/api/resources/connections/resources/scimConfiguration/resources/tokens/client/Client.mjs +3 -3
  203. package/dist/esm/management/api/resources/connections/resources/users/client/Client.mjs +5 -1
  204. package/dist/esm/management/api/resources/customDomains/client/Client.mjs +13 -9
  205. package/dist/esm/management/api/resources/deviceCredentials/client/Client.mjs +7 -3
  206. package/dist/esm/management/api/resources/emailTemplates/client/Client.mjs +4 -4
  207. package/dist/esm/management/api/resources/emails/resources/provider/client/Client.mjs +8 -4
  208. package/dist/esm/management/api/resources/eventStreams/client/Client.mjs +10 -6
  209. package/dist/esm/management/api/resources/eventStreams/resources/deliveries/client/Client.mjs +6 -2
  210. package/dist/esm/management/api/resources/eventStreams/resources/redeliveries/client/Client.mjs +2 -2
  211. package/dist/esm/management/api/resources/events/client/Client.d.mts +18 -0
  212. package/dist/esm/management/api/resources/events/client/Client.mjs +98 -0
  213. package/dist/esm/management/api/resources/events/client/index.d.mts +1 -0
  214. package/dist/esm/management/api/resources/events/client/index.mjs +1 -0
  215. package/dist/esm/management/api/resources/events/index.d.mts +1 -0
  216. package/dist/esm/management/api/resources/events/index.mjs +1 -0
  217. package/dist/esm/management/api/resources/flows/client/Client.d.mts +4 -1
  218. package/dist/esm/management/api/resources/flows/client/Client.mjs +17 -6
  219. package/dist/esm/management/api/resources/flows/resources/executions/client/Client.d.mts +3 -1
  220. package/dist/esm/management/api/resources/flows/resources/executions/client/Client.mjs +14 -4
  221. package/dist/esm/management/api/resources/flows/resources/vault/resources/connections/client/Client.mjs +9 -5
  222. package/dist/esm/management/api/resources/forms/client/Client.d.mts +5 -2
  223. package/dist/esm/management/api/resources/forms/client/Client.mjs +18 -7
  224. package/dist/esm/management/api/resources/groups/client/Client.d.mts +1 -0
  225. package/dist/esm/management/api/resources/groups/client/Client.mjs +10 -4
  226. package/dist/esm/management/api/resources/groups/resources/members/client/Client.mjs +5 -1
  227. package/dist/esm/management/api/resources/guardian/resources/enrollments/client/Client.mjs +3 -3
  228. package/dist/esm/management/api/resources/guardian/resources/factors/client/Client.mjs +2 -2
  229. package/dist/esm/management/api/resources/guardian/resources/factors/resources/duo/resources/settings/client/Client.mjs +3 -3
  230. package/dist/esm/management/api/resources/guardian/resources/factors/resources/phone/client/Client.mjs +8 -8
  231. package/dist/esm/management/api/resources/guardian/resources/factors/resources/pushNotification/client/Client.mjs +12 -12
  232. package/dist/esm/management/api/resources/guardian/resources/factors/resources/sms/client/Client.mjs +6 -6
  233. package/dist/esm/management/api/resources/guardian/resources/policies/client/Client.mjs +2 -2
  234. package/dist/esm/management/api/resources/hooks/client/Client.mjs +13 -5
  235. package/dist/esm/management/api/resources/hooks/resources/secrets/client/Client.mjs +4 -4
  236. package/dist/esm/management/api/resources/index.d.mts +1 -0
  237. package/dist/esm/management/api/resources/index.mjs +1 -0
  238. package/dist/esm/management/api/resources/jobs/client/Client.mjs +1 -1
  239. package/dist/esm/management/api/resources/jobs/resources/errors/client/Client.mjs +1 -1
  240. package/dist/esm/management/api/resources/jobs/resources/usersExports/client/Client.mjs +1 -1
  241. package/dist/esm/management/api/resources/jobs/resources/usersImports/client/Client.mjs +1 -1
  242. package/dist/esm/management/api/resources/jobs/resources/verificationEmail/client/Client.mjs +1 -1
  243. package/dist/esm/management/api/resources/keys/resources/customSigning/client/Client.mjs +3 -3
  244. package/dist/esm/management/api/resources/keys/resources/encryption/client/Client.mjs +11 -7
  245. package/dist/esm/management/api/resources/keys/resources/signing/client/Client.mjs +4 -4
  246. package/dist/esm/management/api/resources/logStreams/client/Client.d.mts +465 -300
  247. package/dist/esm/management/api/resources/logStreams/client/Client.mjs +470 -305
  248. package/dist/esm/management/api/resources/logs/client/Client.mjs +6 -2
  249. package/dist/esm/management/api/resources/networkAcls/client/Client.mjs +10 -6
  250. package/dist/esm/management/api/resources/organizations/client/Client.mjs +10 -6
  251. package/dist/esm/management/api/resources/organizations/resources/clientGrants/client/Client.d.mts +1 -0
  252. package/dist/esm/management/api/resources/organizations/resources/clientGrants/client/Client.mjs +8 -3
  253. package/dist/esm/management/api/resources/organizations/resources/connections/client/Client.mjs +9 -5
  254. package/dist/esm/management/api/resources/organizations/resources/discoveryDomains/client/Client.mjs +10 -6
  255. package/dist/esm/management/api/resources/organizations/resources/enabledConnections/client/Client.mjs +9 -5
  256. package/dist/esm/management/api/resources/organizations/resources/invitations/client/Client.mjs +12 -4
  257. package/dist/esm/management/api/resources/organizations/resources/members/client/Client.mjs +7 -3
  258. package/dist/esm/management/api/resources/organizations/resources/members/resources/roles/client/Client.mjs +7 -3
  259. package/dist/esm/management/api/resources/prompts/client/Client.mjs +2 -2
  260. package/dist/esm/management/api/resources/prompts/resources/customText/client/Client.mjs +2 -2
  261. package/dist/esm/management/api/resources/prompts/resources/partials/client/Client.mjs +2 -2
  262. package/dist/esm/management/api/resources/prompts/resources/rendering/client/Client.mjs +8 -4
  263. package/dist/esm/management/api/resources/refreshTokens/client/Client.d.mts +17 -0
  264. package/dist/esm/management/api/resources/refreshTokens/client/Client.mjs +71 -4
  265. package/dist/esm/management/api/resources/resourceServers/client/Client.d.mts +1 -0
  266. package/dist/esm/management/api/resources/resourceServers/client/Client.mjs +14 -5
  267. package/dist/esm/management/api/resources/riskAssessments/resources/settings/client/Client.mjs +2 -2
  268. package/dist/esm/management/api/resources/riskAssessments/resources/settings/resources/newDevice/client/Client.mjs +2 -2
  269. package/dist/esm/management/api/resources/roles/client/Client.mjs +9 -5
  270. package/dist/esm/management/api/resources/roles/resources/permissions/client/Client.mjs +7 -3
  271. package/dist/esm/management/api/resources/roles/resources/users/client/Client.mjs +6 -2
  272. package/dist/esm/management/api/resources/rules/client/Client.mjs +13 -5
  273. package/dist/esm/management/api/resources/rulesConfigs/client/Client.mjs +3 -3
  274. package/dist/esm/management/api/resources/selfServiceProfiles/client/Client.mjs +9 -5
  275. package/dist/esm/management/api/resources/selfServiceProfiles/resources/customText/client/Client.d.mts +2 -2
  276. package/dist/esm/management/api/resources/selfServiceProfiles/resources/customText/client/Client.mjs +4 -4
  277. package/dist/esm/management/api/resources/selfServiceProfiles/resources/ssoTicket/client/Client.d.mts +2 -2
  278. package/dist/esm/management/api/resources/selfServiceProfiles/resources/ssoTicket/client/Client.mjs +4 -4
  279. package/dist/esm/management/api/resources/sessions/client/Client.mjs +4 -4
  280. package/dist/esm/management/api/resources/stats/client/Client.mjs +6 -2
  281. package/dist/esm/management/api/resources/supplementalSignals/client/Client.mjs +2 -2
  282. package/dist/esm/management/api/resources/tenants/resources/settings/client/Client.mjs +6 -2
  283. package/dist/esm/management/api/resources/tickets/client/Client.mjs +2 -2
  284. package/dist/esm/management/api/resources/tokenExchangeProfiles/client/Client.mjs +9 -5
  285. package/dist/esm/management/api/resources/userAttributeProfiles/client/Client.d.mts +1 -1
  286. package/dist/esm/management/api/resources/userAttributeProfiles/client/Client.mjs +12 -8
  287. package/dist/esm/management/api/resources/userBlocks/client/Client.mjs +16 -4
  288. package/dist/esm/management/api/resources/userGrants/client/Client.mjs +11 -3
  289. package/dist/esm/management/api/resources/users/client/Client.mjs +20 -8
  290. package/dist/esm/management/api/resources/users/resources/authenticationMethods/client/Client.mjs +11 -7
  291. package/dist/esm/management/api/resources/users/resources/authenticators/client/Client.mjs +1 -1
  292. package/dist/esm/management/api/resources/users/resources/connectedAccounts/client/Client.mjs +5 -1
  293. package/dist/esm/management/api/resources/users/resources/enrollments/client/Client.mjs +1 -1
  294. package/dist/esm/management/api/resources/users/resources/federatedConnectionsTokensets/client/Client.mjs +2 -2
  295. package/dist/esm/management/api/resources/users/resources/groups/client/Client.mjs +5 -1
  296. package/dist/esm/management/api/resources/users/resources/identities/client/Client.mjs +2 -2
  297. package/dist/esm/management/api/resources/users/resources/logs/client/Client.mjs +5 -1
  298. package/dist/esm/management/api/resources/users/resources/multifactor/client/Client.mjs +2 -2
  299. package/dist/esm/management/api/resources/users/resources/organizations/client/Client.mjs +5 -1
  300. package/dist/esm/management/api/resources/users/resources/permissions/client/Client.mjs +7 -3
  301. package/dist/esm/management/api/resources/users/resources/refreshToken/client/Client.mjs +6 -2
  302. package/dist/esm/management/api/resources/users/resources/riskAssessments/client/Client.mjs +1 -1
  303. package/dist/esm/management/api/resources/users/resources/roles/client/Client.mjs +7 -3
  304. package/dist/esm/management/api/resources/users/resources/sessions/client/Client.mjs +6 -2
  305. package/dist/esm/management/api/resources/verifiableCredentials/resources/verification/resources/templates/client/Client.d.mts +1 -1
  306. package/dist/esm/management/api/resources/verifiableCredentials/resources/verification/resources/templates/client/Client.mjs +10 -6
  307. package/dist/esm/management/api/types/types.d.mts +3481 -148
  308. package/dist/esm/management/api/types/types.mjs +610 -5
  309. package/dist/esm/management/core/fetcher/Fetcher.d.mts +6 -0
  310. package/dist/esm/management/core/fetcher/Fetcher.mjs +9 -8
  311. package/dist/esm/management/core/index.d.mts +1 -0
  312. package/dist/esm/management/core/index.mjs +1 -0
  313. package/dist/esm/management/core/stream/Stream.d.mts +56 -0
  314. package/dist/esm/management/core/stream/Stream.mjs +262 -0
  315. package/dist/esm/management/core/stream/index.d.mts +1 -0
  316. package/dist/esm/management/core/stream/index.mjs +1 -0
  317. package/dist/esm/management/core/url/QueryStringBuilder.d.mts +47 -0
  318. package/dist/esm/management/core/url/QueryStringBuilder.mjs +80 -0
  319. package/dist/esm/management/core/url/index.d.mts +1 -0
  320. package/dist/esm/management/core/url/index.mjs +1 -0
  321. package/dist/esm/management/core/url/qs.d.mts +2 -1
  322. package/dist/esm/management/core/url/qs.mjs +24 -12
  323. package/dist/esm/management/version.d.mts +1 -1
  324. package/dist/esm/management/version.mjs +1 -1
  325. package/package.json +1 -1
  326. package/reference.md +668 -331
@@ -20,72 +20,77 @@ export class LogStreamsClient {
20
20
  this._options = normalizeClientOptionsWithAuth(options);
21
21
  }
22
22
  /**
23
- * Retrieve details on <a href="https://auth0.com/docs/logs/streams">log streams</a>.
24
- * <h5>Sample Response</h5><pre><code>[{
25
- * "id": "string",
26
- * "name": "string",
27
- * "type": "eventbridge",
28
- * "status": "active|paused|suspended",
29
- * "sink": {
30
- * "awsAccountId": "string",
31
- * "awsRegion": "string",
32
- * "awsPartnerEventSource": "string"
33
- * }
23
+ * Retrieve details on [log streams](https://auth0.com/docs/logs/streams).
24
+ *
25
+ * **Sample Response**
26
+ *
27
+ * ```json
28
+ * [{
29
+ * "id": "string",
30
+ * "name": "string",
31
+ * "type": "eventbridge",
32
+ * "status": "active|paused|suspended",
33
+ * "sink": {
34
+ * "awsAccountId": "string",
35
+ * "awsRegion": "string",
36
+ * "awsPartnerEventSource": "string"
37
+ * }
34
38
  * }, {
35
- * "id": "string",
36
- * "name": "string",
37
- * "type": "http",
38
- * "status": "active|paused|suspended",
39
- * "sink": {
40
- * "httpContentFormat": "JSONLINES|JSONARRAY",
41
- * "httpContentType": "string",
42
- * "httpEndpoint": "string",
43
- * "httpAuthorization": "string"
44
- * }
39
+ * "id": "string",
40
+ * "name": "string",
41
+ * "type": "http",
42
+ * "status": "active|paused|suspended",
43
+ * "sink": {
44
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
45
+ * "httpContentType": "string",
46
+ * "httpEndpoint": "string",
47
+ * "httpAuthorization": "string"
48
+ * }
45
49
  * },
46
50
  * {
47
- * "id": "string",
48
- * "name": "string",
49
- * "type": "eventgrid",
50
- * "status": "active|paused|suspended",
51
- * "sink": {
52
- * "azureSubscriptionId": "string",
53
- * "azureResourceGroup": "string",
54
- * "azureRegion": "string",
55
- * "azurePartnerTopic": "string"
56
- * }
51
+ * "id": "string",
52
+ * "name": "string",
53
+ * "type": "eventgrid",
54
+ * "status": "active|paused|suspended",
55
+ * "sink": {
56
+ * "azureSubscriptionId": "string",
57
+ * "azureResourceGroup": "string",
58
+ * "azureRegion": "string",
59
+ * "azurePartnerTopic": "string"
60
+ * }
57
61
  * },
58
62
  * {
59
- * "id": "string",
60
- * "name": "string",
61
- * "type": "splunk",
62
- * "status": "active|paused|suspended",
63
- * "sink": {
64
- * "splunkDomain": "string",
65
- * "splunkToken": "string",
66
- * "splunkPort": "string",
67
- * "splunkSecure": "boolean"
68
- * }
63
+ * "id": "string",
64
+ * "name": "string",
65
+ * "type": "splunk",
66
+ * "status": "active|paused|suspended",
67
+ * "sink": {
68
+ * "splunkDomain": "string",
69
+ * "splunkToken": "string",
70
+ * "splunkPort": "string",
71
+ * "splunkSecure": "boolean"
72
+ * }
69
73
  * },
70
74
  * {
71
- * "id": "string",
72
- * "name": "string",
73
- * "type": "sumo",
74
- * "status": "active|paused|suspended",
75
- * "sink": {
76
- * "sumoSourceAddress": "string",
77
- * }
75
+ * "id": "string",
76
+ * "name": "string",
77
+ * "type": "sumo",
78
+ * "status": "active|paused|suspended",
79
+ * "sink": {
80
+ * "sumoSourceAddress": "string"
81
+ * }
78
82
  * },
79
83
  * {
80
- * "id": "string",
81
- * "name": "string",
82
- * "type": "datadog",
83
- * "status": "active|paused|suspended",
84
- * "sink": {
85
- * "datadogRegion": "string",
86
- * "datadogApiKey": "string"
87
- * }
88
- * }]</code></pre>
84
+ * "id": "string",
85
+ * "name": "string",
86
+ * "type": "datadog",
87
+ * "status": "active|paused|suspended",
88
+ * "sink": {
89
+ * "datadogRegion": "string",
90
+ * "datadogApiKey": "string"
91
+ * }
92
+ * }]
93
+ * ```
89
94
  *
90
95
  * @param {LogStreamsClient.RequestOptions} requestOptions - Request-specific configuration.
91
96
  *
@@ -109,7 +114,7 @@ export class LogStreamsClient {
109
114
  url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ManagementEnvironment.Default, "log-streams"),
110
115
  method: "GET",
111
116
  headers: _headers,
112
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
117
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
113
118
  timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
114
119
  maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.maxRetries,
115
120
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -142,131 +147,202 @@ export class LogStreamsClient {
142
147
  }
143
148
  /**
144
149
  * Create a log stream.
145
- * <h5>Log Stream Types</h5> The <code>type</code> of log stream being created determines the properties required in the <code>sink</code> payload.
146
- * <h5>HTTP Stream</h5> For an <code>http</code> Stream, the <code>sink</code> properties are listed in the payload below
147
- * Request: <pre><code>{
148
- * "name": "string",
149
- * "type": "http",
150
- * "sink": {
151
- * "httpEndpoint": "string",
152
- * "httpContentType": "string",
153
- * "httpContentFormat": "JSONLINES|JSONARRAY",
154
- * "httpAuthorization": "string"
155
- * }
156
- * }</code></pre>
157
- * Response: <pre><code>{
158
- * "id": "string",
159
- * "name": "string",
160
- * "type": "http",
161
- * "status": "active",
162
- * "sink": {
163
- * "httpEndpoint": "string",
164
- * "httpContentType": "string",
165
- * "httpContentFormat": "JSONLINES|JSONARRAY",
166
- * "httpAuthorization": "string"
167
- * }
168
- * }</code></pre>
169
- * <h5>Amazon EventBridge Stream</h5> For an <code>eventbridge</code> Stream, the <code>sink</code> properties are listed in the payload below
170
- * Request: <pre><code>{
171
- * "name": "string",
172
- * "type": "eventbridge",
173
- * "sink": {
174
- * "awsRegion": "string",
175
- * "awsAccountId": "string"
176
- * }
177
- * }</code></pre>
178
- * The response will include an additional field <code>awsPartnerEventSource</code> in the <code>sink</code>: <pre><code>{
179
- * "id": "string",
180
- * "name": "string",
181
- * "type": "eventbridge",
182
- * "status": "active",
183
- * "sink": {
184
- * "awsAccountId": "string",
185
- * "awsRegion": "string",
186
- * "awsPartnerEventSource": "string"
187
- * }
188
- * }</code></pre>
189
- * <h5>Azure Event Grid Stream</h5> For an <code>Azure Event Grid</code> Stream, the <code>sink</code> properties are listed in the payload below
190
- * Request: <pre><code>{
191
- * "name": "string",
192
- * "type": "eventgrid",
193
- * "sink": {
194
- * "azureSubscriptionId": "string",
195
- * "azureResourceGroup": "string",
196
- * "azureRegion": "string"
197
- * }
198
- * }</code></pre>
199
- * Response: <pre><code>{
200
- * "id": "string",
201
- * "name": "string",
202
- * "type": "http",
203
- * "status": "active",
204
- * "sink": {
205
- * "azureSubscriptionId": "string",
206
- * "azureResourceGroup": "string",
207
- * "azureRegion": "string",
208
- * "azurePartnerTopic": "string"
209
- * }
210
- * }</code></pre>
211
- * <h5>Datadog Stream</h5> For a <code>Datadog</code> Stream, the <code>sink</code> properties are listed in the payload below
212
- * Request: <pre><code>{
213
- * "name": "string",
214
- * "type": "datadog",
215
- * "sink": {
216
- * "datadogRegion": "string",
217
- * "datadogApiKey": "string"
218
- * }
219
- * }</code></pre>
220
- * Response: <pre><code>{
221
- * "id": "string",
222
- * "name": "string",
223
- * "type": "datadog",
224
- * "status": "active",
225
- * "sink": {
226
- * "datadogRegion": "string",
227
- * "datadogApiKey": "string"
228
- * }
229
- * }</code></pre>
230
- * <h5>Splunk Stream</h5> For a <code>Splunk</code> Stream, the <code>sink</code> properties are listed in the payload below
231
- * Request: <pre><code>{
232
- * "name": "string",
233
- * "type": "splunk",
234
- * "sink": {
235
- * "splunkDomain": "string",
236
- * "splunkToken": "string",
237
- * "splunkPort": "string",
238
- * "splunkSecure": "boolean"
239
- * }
240
- * }</code></pre>
241
- * Response: <pre><code>{
242
- * "id": "string",
243
- * "name": "string",
244
- * "type": "splunk",
245
- * "status": "active",
246
- * "sink": {
247
- * "splunkDomain": "string",
248
- * "splunkToken": "string",
249
- * "splunkPort": "string",
250
- * "splunkSecure": "boolean"
251
- * }
252
- * }</code></pre>
253
- * <h5>Sumo Logic Stream</h5> For a <code>Sumo Logic</code> Stream, the <code>sink</code> properties are listed in the payload below
254
- * Request: <pre><code>{
255
- * "name": "string",
256
- * "type": "sumo",
257
- * "sink": {
258
- * "sumoSourceAddress": "string",
259
- * }
260
- * }</code></pre>
261
- * Response: <pre><code>{
262
- * "id": "string",
263
- * "name": "string",
264
- * "type": "sumo",
265
- * "status": "active",
266
- * "sink": {
267
- * "sumoSourceAddress": "string",
268
- * }
269
- * }</code></pre>
150
+ *
151
+ * **Log Stream Types**
152
+ *
153
+ * The `type` of log stream being created determines the properties required in the `sink` payload.
154
+ *
155
+ * **HTTP Stream**
156
+ *
157
+ * For an `http` Stream, the `sink` properties are listed in the payload below.
158
+ *
159
+ * **Request:**
160
+ * ```json
161
+ * {
162
+ * "name": "string",
163
+ * "type": "http",
164
+ * "sink": {
165
+ * "httpEndpoint": "string",
166
+ * "httpContentType": "string",
167
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
168
+ * "httpAuthorization": "string"
169
+ * }
170
+ * }
171
+ * ```
172
+ *
173
+ * **Response:**
174
+ * ```json
175
+ * {
176
+ * "id": "string",
177
+ * "name": "string",
178
+ * "type": "http",
179
+ * "status": "active",
180
+ * "sink": {
181
+ * "httpEndpoint": "string",
182
+ * "httpContentType": "string",
183
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
184
+ * "httpAuthorization": "string"
185
+ * }
186
+ * }
187
+ * ```
188
+ *
189
+ * **Amazon EventBridge Stream**
190
+ *
191
+ * For an `eventbridge` Stream, the `sink` properties are listed in the payload below.
192
+ *
193
+ * **Request:**
194
+ * ```json
195
+ * {
196
+ * "name": "string",
197
+ * "type": "eventbridge",
198
+ * "sink": {
199
+ * "awsRegion": "string",
200
+ * "awsAccountId": "string"
201
+ * }
202
+ * }
203
+ * ```
204
+ *
205
+ * The response will include an additional field `awsPartnerEventSource` in the `sink`:
206
+ *
207
+ * **Response:**
208
+ * ```json
209
+ * {
210
+ * "id": "string",
211
+ * "name": "string",
212
+ * "type": "eventbridge",
213
+ * "status": "active",
214
+ * "sink": {
215
+ * "awsAccountId": "string",
216
+ * "awsRegion": "string",
217
+ * "awsPartnerEventSource": "string"
218
+ * }
219
+ * }
220
+ * ```
221
+ *
222
+ * **Azure Event Grid Stream**
223
+ *
224
+ * For an `Azure Event Grid` Stream, the `sink` properties are listed in the payload below.
225
+ *
226
+ * **Request:**
227
+ * ```json
228
+ * {
229
+ * "name": "string",
230
+ * "type": "eventgrid",
231
+ * "sink": {
232
+ * "azureSubscriptionId": "string",
233
+ * "azureResourceGroup": "string",
234
+ * "azureRegion": "string"
235
+ * }
236
+ * }
237
+ * ```
238
+ *
239
+ * **Response:**
240
+ * ```json
241
+ * {
242
+ * "id": "string",
243
+ * "name": "string",
244
+ * "type": "http",
245
+ * "status": "active",
246
+ * "sink": {
247
+ * "azureSubscriptionId": "string",
248
+ * "azureResourceGroup": "string",
249
+ * "azureRegion": "string",
250
+ * "azurePartnerTopic": "string"
251
+ * }
252
+ * }
253
+ * ```
254
+ *
255
+ * **Datadog Stream**
256
+ *
257
+ * For a `Datadog` Stream, the `sink` properties are listed in the payload below.
258
+ *
259
+ * **Request:**
260
+ * ```json
261
+ * {
262
+ * "name": "string",
263
+ * "type": "datadog",
264
+ * "sink": {
265
+ * "datadogRegion": "string",
266
+ * "datadogApiKey": "string"
267
+ * }
268
+ * }
269
+ * ```
270
+ *
271
+ * **Response:**
272
+ * ```json
273
+ * {
274
+ * "id": "string",
275
+ * "name": "string",
276
+ * "type": "datadog",
277
+ * "status": "active",
278
+ * "sink": {
279
+ * "datadogRegion": "string",
280
+ * "datadogApiKey": "string"
281
+ * }
282
+ * }
283
+ * ```
284
+ *
285
+ * **Splunk Stream**
286
+ *
287
+ * For a `Splunk` Stream, the `sink` properties are listed in the payload below.
288
+ *
289
+ * **Request:**
290
+ * ```json
291
+ * {
292
+ * "name": "string",
293
+ * "type": "splunk",
294
+ * "sink": {
295
+ * "splunkDomain": "string",
296
+ * "splunkToken": "string",
297
+ * "splunkPort": "string",
298
+ * "splunkSecure": "boolean"
299
+ * }
300
+ * }
301
+ * ```
302
+ *
303
+ * **Response:**
304
+ * ```json
305
+ * {
306
+ * "id": "string",
307
+ * "name": "string",
308
+ * "type": "splunk",
309
+ * "status": "active",
310
+ * "sink": {
311
+ * "splunkDomain": "string",
312
+ * "splunkToken": "string",
313
+ * "splunkPort": "string",
314
+ * "splunkSecure": "boolean"
315
+ * }
316
+ * }
317
+ * ```
318
+ *
319
+ * **Sumo Logic Stream**
320
+ *
321
+ * For a `Sumo Logic` Stream, the `sink` properties are listed in the payload below.
322
+ *
323
+ * **Request:**
324
+ * ```json
325
+ * {
326
+ * "name": "string",
327
+ * "type": "sumo",
328
+ * "sink": {
329
+ * "sumoSourceAddress": "string"
330
+ * }
331
+ * }
332
+ * ```
333
+ *
334
+ * **Response:**
335
+ * ```json
336
+ * {
337
+ * "id": "string",
338
+ * "name": "string",
339
+ * "type": "sumo",
340
+ * "status": "active",
341
+ * "sink": {
342
+ * "sumoSourceAddress": "string"
343
+ * }
344
+ * }
345
+ * ```
270
346
  *
271
347
  * @param {Management.CreateLogStreamRequestContent} request
272
348
  * @param {LogStreamsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -298,7 +374,7 @@ export class LogStreamsClient {
298
374
  method: "POST",
299
375
  headers: _headers,
300
376
  contentType: "application/json",
301
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
377
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
302
378
  requestType: "json",
303
379
  body: request,
304
380
  timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
@@ -338,107 +414,157 @@ export class LogStreamsClient {
338
414
  }
339
415
  /**
340
416
  * Retrieve a log stream configuration and status.
341
- * <h5>Sample responses</h5><h5>Amazon EventBridge Log Stream</h5><pre><code>{
342
- * "id": "string",
343
- * "name": "string",
344
- * "type": "eventbridge",
345
- * "status": "active|paused|suspended",
346
- * "sink": {
347
- * "awsAccountId": "string",
348
- * "awsRegion": "string",
349
- * "awsPartnerEventSource": "string"
350
- * }
351
- * }</code></pre> <h5>HTTP Log Stream</h5><pre><code>{
352
- * "id": "string",
353
- * "name": "string",
354
- * "type": "http",
355
- * "status": "active|paused|suspended",
356
- * "sink": {
357
- * "httpContentFormat": "JSONLINES|JSONARRAY",
358
- * "httpContentType": "string",
359
- * "httpEndpoint": "string",
360
- * "httpAuthorization": "string"
361
- * }
362
- * }</code></pre> <h5>Datadog Log Stream</h5><pre><code>{
363
- * "id": "string",
364
- * "name": "string",
365
- * "type": "datadog",
366
- * "status": "active|paused|suspended",
367
- * "sink": {
368
- * "datadogRegion": "string",
369
- * "datadogApiKey": "string"
370
- * }
371
- *
372
- * }</code></pre><h5>Mixpanel</h5>
373
- *
374
- * Request: <pre><code>{
375
- * "name": "string",
376
- * "type": "mixpanel",
377
- * "sink": {
378
- * "mixpanelRegion": "string", // "us" | "eu",
379
- * "mixpanelProjectId": "string",
380
- * "mixpanelServiceAccountUsername": "string",
381
- * "mixpanelServiceAccountPassword": "string"
382
- * }
383
- * } </code></pre>
384
- *
385
- *
386
- * Response: <pre><code>{
387
- * "id": "string",
388
- * "name": "string",
389
- * "type": "mixpanel",
390
- * "status": "active",
391
- * "sink": {
392
- * "mixpanelRegion": "string", // "us" | "eu",
393
- * "mixpanelProjectId": "string",
394
- * "mixpanelServiceAccountUsername": "string",
395
- * "mixpanelServiceAccountPassword": "string" // the following is redacted on return
396
- * }
397
- * } </code></pre>
398
- *
399
- * <h5>Segment</h5>
400
- *
401
- * Request: <pre><code> {
402
- * "name": "string",
403
- * "type": "segment",
404
- * "sink": {
405
- * "segmentWriteKey": "string"
406
- * }
407
- * }</code></pre>
408
- *
409
- * Response: <pre><code>{
410
- * "id": "string",
411
- * "name": "string",
412
- * "type": "segment",
413
- * "status": "active",
414
- * "sink": {
415
- * "segmentWriteKey": "string"
416
- * }
417
- * } </code></pre>
418
- *
419
- * <h5>Splunk Log Stream</h5><pre><code>{
420
- * "id": "string",
421
- * "name": "string",
422
- * "type": "splunk",
423
- * "status": "active|paused|suspended",
424
- * "sink": {
425
- * "splunkDomain": "string",
426
- * "splunkToken": "string",
427
- * "splunkPort": "string",
428
- * "splunkSecure": "boolean"
429
- * }
430
- * }</code></pre> <h5>Sumo Logic Log Stream</h5><pre><code>{
431
- * "id": "string",
432
- * "name": "string",
433
- * "type": "sumo",
434
- * "status": "active|paused|suspended",
435
- * "sink": {
436
- * "sumoSourceAddress": "string",
437
- * }
438
- * }</code></pre> <h5>Status</h5> The <code>status</code> of a log stream maybe any of the following:
439
- * 1. <code>active</code> - Stream is currently enabled.
440
- * 2. <code>paused</code> - Stream is currently user disabled and will not attempt log delivery.
441
- * 3. <code>suspended</code> - Stream is currently disabled because of errors and will not attempt log delivery.
417
+ *
418
+ * **Sample responses**
419
+ *
420
+ * **Amazon EventBridge Log Stream**
421
+ *
422
+ * ```json
423
+ * {
424
+ * "id": "string",
425
+ * "name": "string",
426
+ * "type": "eventbridge",
427
+ * "status": "active|paused|suspended",
428
+ * "sink": {
429
+ * "awsAccountId": "string",
430
+ * "awsRegion": "string",
431
+ * "awsPartnerEventSource": "string"
432
+ * }
433
+ * }
434
+ * ```
435
+ *
436
+ * **HTTP Log Stream**
437
+ *
438
+ * ```json
439
+ * {
440
+ * "id": "string",
441
+ * "name": "string",
442
+ * "type": "http",
443
+ * "status": "active|paused|suspended",
444
+ * "sink": {
445
+ * "httpContentFormat": "JSONLINES|JSONARRAY",
446
+ * "httpContentType": "string",
447
+ * "httpEndpoint": "string",
448
+ * "httpAuthorization": "string"
449
+ * }
450
+ * }
451
+ * ```
452
+ *
453
+ * **Datadog Log Stream**
454
+ *
455
+ * ```json
456
+ * {
457
+ * "id": "string",
458
+ * "name": "string",
459
+ * "type": "datadog",
460
+ * "status": "active|paused|suspended",
461
+ * "sink": {
462
+ * "datadogRegion": "string",
463
+ * "datadogApiKey": "string"
464
+ * }
465
+ * }
466
+ * ```
467
+ *
468
+ * **Mixpanel**
469
+ *
470
+ * **Request:**
471
+ *
472
+ * ```json
473
+ * {
474
+ * "name": "string",
475
+ * "type": "mixpanel",
476
+ * "sink": {
477
+ * "mixpanelRegion": "string",
478
+ * "mixpanelProjectId": "string",
479
+ * "mixpanelServiceAccountUsername": "string",
480
+ * "mixpanelServiceAccountPassword": "string"
481
+ * }
482
+ * }
483
+ * ```
484
+ *
485
+ * **Response:**
486
+ *
487
+ * ```json
488
+ * {
489
+ * "id": "string",
490
+ * "name": "string",
491
+ * "type": "mixpanel",
492
+ * "status": "active",
493
+ * "sink": {
494
+ * "mixpanelRegion": "string",
495
+ * "mixpanelProjectId": "string",
496
+ * "mixpanelServiceAccountUsername": "string",
497
+ * "mixpanelServiceAccountPassword": "string"
498
+ * }
499
+ * }
500
+ * ```
501
+ *
502
+ * **Segment**
503
+ *
504
+ * **Request:**
505
+ *
506
+ * ```json
507
+ * {
508
+ * "name": "string",
509
+ * "type": "segment",
510
+ * "sink": {
511
+ * "segmentWriteKey": "string"
512
+ * }
513
+ * }
514
+ * ```
515
+ *
516
+ * **Response:**
517
+ *
518
+ * ```json
519
+ * {
520
+ * "id": "string",
521
+ * "name": "string",
522
+ * "type": "segment",
523
+ * "status": "active",
524
+ * "sink": {
525
+ * "segmentWriteKey": "string"
526
+ * }
527
+ * }
528
+ * ```
529
+ *
530
+ * **Splunk Log Stream**
531
+ *
532
+ * ```json
533
+ * {
534
+ * "id": "string",
535
+ * "name": "string",
536
+ * "type": "splunk",
537
+ * "status": "active|paused|suspended",
538
+ * "sink": {
539
+ * "splunkDomain": "string",
540
+ * "splunkToken": "string",
541
+ * "splunkPort": "string",
542
+ * "splunkSecure": "boolean"
543
+ * }
544
+ * }
545
+ * ```
546
+ *
547
+ * **Sumo Logic Log Stream**
548
+ *
549
+ * ```json
550
+ * {
551
+ * "id": "string",
552
+ * "name": "string",
553
+ * "type": "sumo",
554
+ * "status": "active|paused|suspended",
555
+ * "sink": {
556
+ * "sumoSourceAddress": "string"
557
+ * }
558
+ * }
559
+ * ```
560
+ *
561
+ * **Status**
562
+ *
563
+ * The `status` of a log stream maybe any of the following:
564
+ *
565
+ * 1. `active` - Stream is currently enabled.
566
+ * 2. `paused` - Stream is currently user disabled and will not attempt log delivery.
567
+ * 3. `suspended` - Stream is currently disabled because of errors and will not attempt log delivery.
442
568
  *
443
569
  * @param {string} id - The id of the log stream to get
444
570
  * @param {LogStreamsClient.RequestOptions} requestOptions - Request-specific configuration.
@@ -463,7 +589,7 @@ export class LogStreamsClient {
463
589
  url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ManagementEnvironment.Default, `log-streams/${core.url.encodePathParam(id)}`),
464
590
  method: "GET",
465
591
  headers: _headers,
466
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
592
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
467
593
  timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
468
594
  maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.maxRetries,
469
595
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -524,7 +650,7 @@ export class LogStreamsClient {
524
650
  url: core.url.join((_d = (_c = (yield core.Supplier.get(this._options.baseUrl))) !== null && _c !== void 0 ? _c : (yield core.Supplier.get(this._options.environment))) !== null && _d !== void 0 ? _d : environments.ManagementEnvironment.Default, `log-streams/${core.url.encodePathParam(id)}`),
525
651
  method: "DELETE",
526
652
  headers: _headers,
527
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
653
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
528
654
  timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,
529
655
  maxRetries: (_h = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries) !== null && _h !== void 0 ? _h : (_j = this._options) === null || _j === void 0 ? void 0 : _j.maxRetries,
530
656
  abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -559,40 +685,79 @@ export class LogStreamsClient {
559
685
  }
560
686
  /**
561
687
  * Update a log stream.
562
- * <h4>Examples of how to use the PATCH endpoint.</h4> The following fields may be updated in a PATCH operation: <ul><li>name</li><li>status</li><li>sink</li></ul> Note: For log streams of type <code>eventbridge</code> and <code>eventgrid</code>, updating the <code>sink</code> is not permitted.
563
- * <h5>Update the status of a log stream</h5><pre><code>{
564
- * "status": "active|paused"
565
- * }</code></pre>
566
- * <h5>Update the name of a log stream</h5><pre><code>{
567
- * "name": "string"
568
- * }</code></pre>
569
- * <h5>Update the sink properties of a stream of type <code>http</code></h5><pre><code>{
688
+ *
689
+ * **Examples of how to use the PATCH endpoint.**
690
+ *
691
+ * The following fields may be updated in a PATCH operation:
692
+ *
693
+ * - name
694
+ * - status
695
+ * - sink
696
+ *
697
+ * Note: For log streams of type `eventbridge` and `eventgrid`, updating the `sink` is not permitted.
698
+ *
699
+ * **Update the status of a log stream**
700
+ *
701
+ * ```json
702
+ * {
703
+ * "status": "active|paused"
704
+ * }
705
+ * ```
706
+ *
707
+ * **Update the name of a log stream**
708
+ *
709
+ * ```json
710
+ * {
711
+ * "name": "string"
712
+ * }
713
+ * ```
714
+ *
715
+ * **Update the sink properties of a stream of type `http`**
716
+ *
717
+ * ```json
718
+ * {
570
719
  * "sink": {
571
720
  * "httpEndpoint": "string",
572
721
  * "httpContentType": "string",
573
722
  * "httpContentFormat": "JSONARRAY|JSONLINES",
574
723
  * "httpAuthorization": "string"
575
724
  * }
576
- * }</code></pre>
577
- * <h5>Update the sink properties of a stream of type <code>datadog</code></h5><pre><code>{
725
+ * }
726
+ * ```
727
+ *
728
+ * **Update the sink properties of a stream of type `datadog`**
729
+ *
730
+ * ```json
731
+ * {
578
732
  * "sink": {
579
- * "datadogRegion": "string",
580
- * "datadogApiKey": "string"
733
+ * "datadogRegion": "string",
734
+ * "datadogApiKey": "string"
581
735
  * }
582
- * }</code></pre>
583
- * <h5>Update the sink properties of a stream of type <code>splunk</code></h5><pre><code>{
736
+ * }
737
+ * ```
738
+ *
739
+ * **Update the sink properties of a stream of type `splunk`**
740
+ *
741
+ * ```json
742
+ * {
584
743
  * "sink": {
585
744
  * "splunkDomain": "string",
586
745
  * "splunkToken": "string",
587
746
  * "splunkPort": "string",
588
747
  * "splunkSecure": "boolean"
589
748
  * }
590
- * }</code></pre>
591
- * <h5>Update the sink properties of a stream of type <code>sumo</code></h5><pre><code>{
749
+ * }
750
+ * ```
751
+ *
752
+ * **Update the sink properties of a stream of type `sumo`**
753
+ *
754
+ * ```json
755
+ * {
592
756
  * "sink": {
593
757
  * "sumoSourceAddress": "string"
594
758
  * }
595
- * }</code></pre>
759
+ * }
760
+ * ```
596
761
  *
597
762
  * @param {string} id - The id of the log stream to get
598
763
  * @param {Management.UpdateLogStreamRequestContent} request
@@ -619,7 +784,7 @@ export class LogStreamsClient {
619
784
  method: "PATCH",
620
785
  headers: _headers,
621
786
  contentType: "application/json",
622
- queryParameters: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams,
787
+ queryString: core.url.queryBuilder().mergeAdditional(requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.queryParams).build(),
623
788
  requestType: "json",
624
789
  body: request,
625
790
  timeoutMs: ((_g = (_e = requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) !== null && _e !== void 0 ? _e : (_f = this._options) === null || _f === void 0 ? void 0 : _f.timeoutInSeconds) !== null && _g !== void 0 ? _g : 60) * 1000,