@keiser/metrics-sdk-admin-typescript 5.0.12

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 (317) hide show
  1. package/.github/ISSUE_TEMPLATE/bug_report.md +41 -0
  2. package/.github/ISSUE_TEMPLATE/enhancement.md +46 -0
  3. package/.github/ISSUE_TEMPLATE/feature_request.md +46 -0
  4. package/.github/workflows/main.yml +63 -0
  5. package/README.md +202 -0
  6. package/dist/apis/MetricsAdminApi.d.ts +328 -0
  7. package/dist/apis/index.d.ts +1 -0
  8. package/dist/connection.d.ts +110 -0
  9. package/dist/error.d.ts +134 -0
  10. package/dist/event.d.ts +51 -0
  11. package/dist/index.d.ts +7 -0
  12. package/dist/index.js +8429 -0
  13. package/dist/index.mjs +7939 -0
  14. package/dist/jwt.d.ts +1 -0
  15. package/dist/models/A500DataSetData.d.ts +93 -0
  16. package/dist/models/A500MachineStateData.d.ts +88 -0
  17. package/dist/models/A500RepDataPointData.d.ts +169 -0
  18. package/dist/models/A500TestResultData.d.ts +103 -0
  19. package/dist/models/A500TimeSeriesPointData.d.ts +145 -0
  20. package/dist/models/AcceptedTermsVersionData.d.ts +43 -0
  21. package/dist/models/BodyCompositionMeasurementData.d.ts +211 -0
  22. package/dist/models/CacheKeysResponse.d.ts +43 -0
  23. package/dist/models/CacheObject.d.ts +55 -0
  24. package/dist/models/CacheObjectResponse.d.ts +44 -0
  25. package/dist/models/CardioExerciseData.d.ts +65 -0
  26. package/dist/models/CardioExerciseVariantData.d.ts +77 -0
  27. package/dist/models/CardioMachineData.d.ts +83 -0
  28. package/dist/models/EmailAddressData.d.ts +49 -0
  29. package/dist/models/ExerciseAliasData.d.ts +73 -0
  30. package/dist/models/ExerciseOrdinalSetAssignmentData.d.ts +65 -0
  31. package/dist/models/ExerciseOrdinalSetData.d.ts +56 -0
  32. package/dist/models/FacilityConfigurationData.d.ts +101 -0
  33. package/dist/models/FacilityData.d.ts +65 -0
  34. package/dist/models/FacilityLicenseData.d.ts +83 -0
  35. package/dist/models/FacilityLicenseListResponse.d.ts +51 -0
  36. package/dist/models/FacilityLicenseListResponseMeta.d.ts +89 -0
  37. package/dist/models/FacilityLicenseResponse.d.ts +44 -0
  38. package/dist/models/FacilityLicenseSorting.d.ts +25 -0
  39. package/dist/models/FacilityProfileData.d.ts +73 -0
  40. package/dist/models/FacilityRelationshipData.d.ts +99 -0
  41. package/dist/models/FacilitySessionUserData.d.ts +112 -0
  42. package/dist/models/FacilityStrengthMachineConfigurationData.d.ts +94 -0
  43. package/dist/models/FacilityStrengthMachineData.d.ts +99 -0
  44. package/dist/models/FingerprintData.d.ts +69 -0
  45. package/dist/models/GlobalAccessControlCreationResponse.d.ts +51 -0
  46. package/dist/models/GlobalAccessControlData.d.ts +148 -0
  47. package/dist/models/GlobalAccessControlListResponse.d.ts +51 -0
  48. package/dist/models/GlobalAccessControlListResponseMeta.d.ts +62 -0
  49. package/dist/models/GlobalAccessControlResponse.d.ts +44 -0
  50. package/dist/models/GlobalAccessControlSecretData.d.ts +37 -0
  51. package/dist/models/GlobalAccessControlSecretResponse.d.ts +44 -0
  52. package/dist/models/GlobalAccessControlSorting.d.ts +23 -0
  53. package/dist/models/HeartRateDataPointData.d.ts +49 -0
  54. package/dist/models/HeartRateDataSetData.d.ts +81 -0
  55. package/dist/models/HeartRateDataSetSessionData.d.ts +56 -0
  56. package/dist/models/HeightMeasurementData.d.ts +55 -0
  57. package/dist/models/High.d.ts +31 -0
  58. package/dist/models/Low.d.ts +31 -0
  59. package/dist/models/MSeriesDataPointData.d.ts +103 -0
  60. package/dist/models/MSeriesDataSetData.d.ts +222 -0
  61. package/dist/models/MSeriesDataSetSegmentData.d.ts +129 -0
  62. package/dist/models/MSeriesFtpMeasurementData.d.ts +74 -0
  63. package/dist/models/MuscleArea.d.ts +24 -0
  64. package/dist/models/MuscleData.d.ts +67 -0
  65. package/dist/models/MuscleGroup.d.ts +35 -0
  66. package/dist/models/MuscleIdentifier.d.ts +86 -0
  67. package/dist/models/OAuthServiceData.d.ts +73 -0
  68. package/dist/models/PrimaryEmailAddressData.d.ts +37 -0
  69. package/dist/models/ProfileData.d.ts +67 -0
  70. package/dist/models/Queue.d.ts +23 -0
  71. package/dist/models/ResqueDetailsData.d.ts +45 -0
  72. package/dist/models/ResqueDetailsResponse.d.ts +44 -0
  73. package/dist/models/SessionData.d.ts +135 -0
  74. package/dist/models/SessionPlanActivitySetData.d.ts +31 -0
  75. package/dist/models/SessionPlanCardioSetData.d.ts +57 -0
  76. package/dist/models/SessionPlanData.d.ts +118 -0
  77. package/dist/models/SessionPlanSequenceAssignmentData.d.ts +44 -0
  78. package/dist/models/SessionPlanSequenceData.d.ts +63 -0
  79. package/dist/models/SessionPlanSequenceInstanceData.d.ts +82 -0
  80. package/dist/models/SessionPlanSetData.d.ts +81 -0
  81. package/dist/models/SessionPlanSetInstanceData.d.ts +87 -0
  82. package/dist/models/SessionPlanStrengthSetData.d.ts +67 -0
  83. package/dist/models/SessionPlanStretchSetData.d.ts +31 -0
  84. package/dist/models/StatData.d.ts +97 -0
  85. package/dist/models/StatListResponse.d.ts +51 -0
  86. package/dist/models/StatListResponseMeta.d.ts +68 -0
  87. package/dist/models/StatSorting.d.ts +23 -0
  88. package/dist/models/StrengthExerciseData.d.ts +125 -0
  89. package/dist/models/StrengthExerciseVariantData.d.ts +115 -0
  90. package/dist/models/StrengthMachineData.d.ts +88 -0
  91. package/dist/models/StrengthMachineDataSetData.d.ts +199 -0
  92. package/dist/models/StrengthMachineDataSetTestData.d.ts +54 -0
  93. package/dist/models/StrengthMachineDataSetTestSubsetData.d.ts +49 -0
  94. package/dist/models/StrengthMachineModelData.d.ts +31 -0
  95. package/dist/models/StretchExerciseData.d.ts +58 -0
  96. package/dist/models/StretchExerciseVariantData.d.ts +70 -0
  97. package/dist/models/TaskFailedResponse.d.ts +51 -0
  98. package/dist/models/TaskFailure.d.ts +69 -0
  99. package/dist/models/TaskPayload.d.ts +44 -0
  100. package/dist/models/TaskQueueResponse.d.ts +51 -0
  101. package/dist/models/TaskQueueResponseMeta.d.ts +68 -0
  102. package/dist/models/TaskQueues.d.ts +39 -0
  103. package/dist/models/TaskStats.d.ts +37 -0
  104. package/dist/models/UserData.d.ts +112 -0
  105. package/dist/models/UserListResponse.d.ts +51 -0
  106. package/dist/models/UserListResponseMeta.d.ts +68 -0
  107. package/dist/models/UserResponse.d.ts +44 -0
  108. package/dist/models/UserSorting.d.ts +24 -0
  109. package/dist/models/WeightMeasurementData.d.ts +68 -0
  110. package/dist/models/WorkersResponse.d.ts +43 -0
  111. package/dist/models/index.d.ts +96 -0
  112. package/dist/runtime.d.ts +134 -0
  113. package/docs/A500DataSetData.md +41 -0
  114. package/docs/A500MachineStateData.md +46 -0
  115. package/docs/A500RepDataPointData.md +56 -0
  116. package/docs/A500TestResultData.md +22 -0
  117. package/docs/A500TimeSeriesPointData.md +29 -0
  118. package/docs/AcceptedTermsVersionData.md +12 -0
  119. package/docs/BodyCompositionMeasurementData.md +40 -0
  120. package/docs/CacheKeysResponse.md +12 -0
  121. package/docs/CacheObject.md +14 -0
  122. package/docs/CacheObjectResponse.md +12 -0
  123. package/docs/CardioExerciseData.md +15 -0
  124. package/docs/CardioExerciseVariantData.md +25 -0
  125. package/docs/CardioMachineData.md +36 -0
  126. package/docs/EmailAddressData.md +13 -0
  127. package/docs/ExerciseAliasData.md +28 -0
  128. package/docs/ExerciseOrdinalSetAssignmentData.md +15 -0
  129. package/docs/ExerciseOrdinalSetData.md +14 -0
  130. package/docs/FacilityConfigurationData.md +41 -0
  131. package/docs/FacilityData.md +15 -0
  132. package/docs/FacilityLicenseData.md +30 -0
  133. package/docs/FacilityLicenseListResponse.md +13 -0
  134. package/docs/FacilityLicenseListResponseMeta.md +31 -0
  135. package/docs/FacilityLicenseResponse.md +12 -0
  136. package/docs/FacilityLicenseSorting.md +15 -0
  137. package/docs/FacilityProfileData.md +17 -0
  138. package/docs/FacilityRelationshipData.md +36 -0
  139. package/docs/FacilitySessionUserData.md +22 -0
  140. package/docs/FacilityStrengthMachineConfigurationData.md +47 -0
  141. package/docs/FacilityStrengthMachineData.md +21 -0
  142. package/docs/FingerprintData.md +24 -0
  143. package/docs/GlobalAccessControlCreationResponse.md +13 -0
  144. package/docs/GlobalAccessControlData.md +103 -0
  145. package/docs/GlobalAccessControlListResponse.md +13 -0
  146. package/docs/GlobalAccessControlListResponseMeta.md +15 -0
  147. package/docs/GlobalAccessControlResponse.md +12 -0
  148. package/docs/GlobalAccessControlSecretData.md +11 -0
  149. package/docs/GlobalAccessControlSecretResponse.md +12 -0
  150. package/docs/GlobalAccessControlSorting.md +11 -0
  151. package/docs/HeartRateDataPointData.md +13 -0
  152. package/docs/HeartRateDataSetData.md +18 -0
  153. package/docs/HeartRateDataSetSessionData.md +14 -0
  154. package/docs/HeightMeasurementData.md +14 -0
  155. package/docs/High.md +10 -0
  156. package/docs/Low.md +10 -0
  157. package/docs/MSeriesDataPointData.md +22 -0
  158. package/docs/MSeriesDataSetData.md +41 -0
  159. package/docs/MSeriesDataSetSegmentData.md +26 -0
  160. package/docs/MSeriesFtpMeasurementData.md +17 -0
  161. package/docs/MetricsAdminApi.md +1576 -0
  162. package/docs/MuscleArea.md +13 -0
  163. package/docs/MuscleData.md +27 -0
  164. package/docs/MuscleGroup.md +35 -0
  165. package/docs/MuscleIdentifier.md +137 -0
  166. package/docs/OAuthServiceData.md +17 -0
  167. package/docs/PrimaryEmailAddressData.md +11 -0
  168. package/docs/ProfileData.md +16 -0
  169. package/docs/Queue.md +11 -0
  170. package/docs/ResqueDetailsData.md +12 -0
  171. package/docs/ResqueDetailsResponse.md +12 -0
  172. package/docs/SessionData.md +26 -0
  173. package/docs/SessionPlanActivitySetData.md +10 -0
  174. package/docs/SessionPlanCardioSetData.md +14 -0
  175. package/docs/SessionPlanData.md +24 -0
  176. package/docs/SessionPlanSequenceAssignmentData.md +12 -0
  177. package/docs/SessionPlanSequenceData.md +15 -0
  178. package/docs/SessionPlanSequenceInstanceData.md +18 -0
  179. package/docs/SessionPlanSetData.md +31 -0
  180. package/docs/SessionPlanSetInstanceData.md +32 -0
  181. package/docs/SessionPlanStrengthSetData.md +29 -0
  182. package/docs/SessionPlanStretchSetData.md +10 -0
  183. package/docs/StatData.md +21 -0
  184. package/docs/StatListResponse.md +13 -0
  185. package/docs/StatListResponseMeta.md +16 -0
  186. package/docs/StatSorting.md +11 -0
  187. package/docs/StrengthExerciseData.md +71 -0
  188. package/docs/StrengthExerciseVariantData.md +69 -0
  189. package/docs/StrengthMachineData.md +38 -0
  190. package/docs/StrengthMachineDataSetData.md +60 -0
  191. package/docs/StrengthMachineDataSetTestData.md +27 -0
  192. package/docs/StrengthMachineDataSetTestSubsetData.md +13 -0
  193. package/docs/StrengthMachineModelData.md +10 -0
  194. package/docs/StretchExerciseData.md +14 -0
  195. package/docs/StretchExerciseVariantData.md +24 -0
  196. package/docs/TaskFailedResponse.md +13 -0
  197. package/docs/TaskFailure.md +16 -0
  198. package/docs/TaskPayload.md +12 -0
  199. package/docs/TaskQueueResponse.md +13 -0
  200. package/docs/TaskQueueResponseMeta.md +24 -0
  201. package/docs/TaskQueues.md +11 -0
  202. package/docs/TaskStats.md +11 -0
  203. package/docs/UserData.md +22 -0
  204. package/docs/UserListResponse.md +13 -0
  205. package/docs/UserListResponseMeta.md +16 -0
  206. package/docs/UserResponse.md +12 -0
  207. package/docs/UserSorting.md +13 -0
  208. package/docs/WeightMeasurementData.md +16 -0
  209. package/docs/WorkersResponse.md +12 -0
  210. package/package.json +37 -0
  211. package/rollup.config.mjs +32 -0
  212. package/src/apis/MetricsAdminApi.ts +1735 -0
  213. package/src/apis/index.ts +3 -0
  214. package/src/connection.ts +256 -0
  215. package/src/error.ts +248 -0
  216. package/src/event.ts +267 -0
  217. package/src/index.ts +9 -0
  218. package/src/jwt.ts +17 -0
  219. package/src/models/A500DataSetData.ts +164 -0
  220. package/src/models/A500MachineStateData.ts +150 -0
  221. package/src/models/A500RepDataPointData.ts +264 -0
  222. package/src/models/A500TestResultData.ts +174 -0
  223. package/src/models/A500TimeSeriesPointData.ts +233 -0
  224. package/src/models/AcceptedTermsVersionData.ts +83 -0
  225. package/src/models/BodyCompositionMeasurementData.ts +336 -0
  226. package/src/models/CacheKeysResponse.ts +82 -0
  227. package/src/models/CacheObject.ts +102 -0
  228. package/src/models/CacheObjectResponse.ts +89 -0
  229. package/src/models/CardioExerciseData.ts +131 -0
  230. package/src/models/CardioExerciseVariantData.ts +144 -0
  231. package/src/models/CardioMachineData.ts +143 -0
  232. package/src/models/EmailAddressData.ts +93 -0
  233. package/src/models/ExerciseAliasData.ts +138 -0
  234. package/src/models/ExerciseOrdinalSetAssignmentData.ts +132 -0
  235. package/src/models/ExerciseOrdinalSetData.ts +107 -0
  236. package/src/models/FacilityConfigurationData.ts +167 -0
  237. package/src/models/FacilityData.ts +132 -0
  238. package/src/models/FacilityLicenseData.ts +144 -0
  239. package/src/models/FacilityLicenseListResponse.ts +104 -0
  240. package/src/models/FacilityLicenseListResponseMeta.ts +152 -0
  241. package/src/models/FacilityLicenseResponse.ts +89 -0
  242. package/src/models/FacilityLicenseSorting.ts +40 -0
  243. package/src/models/FacilityProfileData.ts +121 -0
  244. package/src/models/FacilityRelationshipData.ts +175 -0
  245. package/src/models/FacilitySessionUserData.ts +216 -0
  246. package/src/models/FacilityStrengthMachineConfigurationData.ts +159 -0
  247. package/src/models/FacilityStrengthMachineData.ts +170 -0
  248. package/src/models/FingerprintData.ts +127 -0
  249. package/src/models/GlobalAccessControlCreationResponse.ts +104 -0
  250. package/src/models/GlobalAccessControlData.ts +217 -0
  251. package/src/models/GlobalAccessControlListResponse.ts +104 -0
  252. package/src/models/GlobalAccessControlListResponseMeta.ts +113 -0
  253. package/src/models/GlobalAccessControlResponse.ts +89 -0
  254. package/src/models/GlobalAccessControlSecretData.ts +75 -0
  255. package/src/models/GlobalAccessControlSecretResponse.ts +89 -0
  256. package/src/models/GlobalAccessControlSorting.ts +38 -0
  257. package/src/models/HeartRateDataPointData.ts +91 -0
  258. package/src/models/HeartRateDataSetData.ts +148 -0
  259. package/src/models/HeartRateDataSetSessionData.ts +108 -0
  260. package/src/models/HeightMeasurementData.ts +102 -0
  261. package/src/models/High.ts +66 -0
  262. package/src/models/Low.ts +66 -0
  263. package/src/models/MSeriesDataPointData.ts +167 -0
  264. package/src/models/MSeriesDataSetData.ts +363 -0
  265. package/src/models/MSeriesDataSetSegmentData.ts +219 -0
  266. package/src/models/MSeriesFtpMeasurementData.ts +133 -0
  267. package/src/models/MuscleArea.ts +39 -0
  268. package/src/models/MuscleData.ts +131 -0
  269. package/src/models/MuscleGroup.ts +50 -0
  270. package/src/models/MuscleIdentifier.ts +101 -0
  271. package/src/models/OAuthServiceData.ts +126 -0
  272. package/src/models/PrimaryEmailAddressData.ts +75 -0
  273. package/src/models/ProfileData.ts +115 -0
  274. package/src/models/Queue.ts +38 -0
  275. package/src/models/ResqueDetailsData.ts +97 -0
  276. package/src/models/ResqueDetailsResponse.ts +89 -0
  277. package/src/models/SessionData.ts +249 -0
  278. package/src/models/SessionPlanActivitySetData.ts +66 -0
  279. package/src/models/SessionPlanCardioSetData.ts +113 -0
  280. package/src/models/SessionPlanData.ts +205 -0
  281. package/src/models/SessionPlanSequenceAssignmentData.ts +90 -0
  282. package/src/models/SessionPlanSequenceData.ts +122 -0
  283. package/src/models/SessionPlanSequenceInstanceData.ts +154 -0
  284. package/src/models/SessionPlanSetData.ts +153 -0
  285. package/src/models/SessionPlanSetInstanceData.ts +162 -0
  286. package/src/models/SessionPlanStrengthSetData.ts +126 -0
  287. package/src/models/SessionPlanStretchSetData.ts +66 -0
  288. package/src/models/StatData.ts +165 -0
  289. package/src/models/StatListResponse.ts +104 -0
  290. package/src/models/StatListResponseMeta.ts +121 -0
  291. package/src/models/StatSorting.ts +38 -0
  292. package/src/models/StrengthExerciseData.ts +208 -0
  293. package/src/models/StrengthExerciseVariantData.ts +189 -0
  294. package/src/models/StrengthMachineData.ts +154 -0
  295. package/src/models/StrengthMachineDataSetData.ts +331 -0
  296. package/src/models/StrengthMachineDataSetTestData.ts +104 -0
  297. package/src/models/StrengthMachineDataSetTestSubsetData.ts +93 -0
  298. package/src/models/StrengthMachineModelData.ts +66 -0
  299. package/src/models/StretchExerciseData.ts +117 -0
  300. package/src/models/StretchExerciseVariantData.ts +130 -0
  301. package/src/models/TaskFailedResponse.ts +104 -0
  302. package/src/models/TaskFailure.ts +133 -0
  303. package/src/models/TaskPayload.ts +91 -0
  304. package/src/models/TaskQueueResponse.ts +104 -0
  305. package/src/models/TaskQueueResponseMeta.ts +117 -0
  306. package/src/models/TaskQueues.ts +88 -0
  307. package/src/models/TaskStats.ts +73 -0
  308. package/src/models/UserData.ts +217 -0
  309. package/src/models/UserListResponse.ts +104 -0
  310. package/src/models/UserListResponseMeta.ts +121 -0
  311. package/src/models/UserResponse.ts +89 -0
  312. package/src/models/UserSorting.ts +39 -0
  313. package/src/models/WeightMeasurementData.ts +125 -0
  314. package/src/models/WorkersResponse.ts +82 -0
  315. package/src/models/index.ts +98 -0
  316. package/src/runtime.ts +473 -0
  317. package/tsconfig.json +18 -0
@@ -0,0 +1,1576 @@
1
+ # MetricsAdminApi
2
+
3
+ All URIs are relative to *https://metrics-api-v3.keiser.com/api*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**adminLogin**](MetricsAdminApi.md#adminLogin) | **POST** /admin/login | Login admin user using email, password, and 2FA token
8
+ [**authExchangeFulfillment**](MetricsAdminApi.md#authExchangeFulfillment) | **POST** /auth/exchange/fulfillment | Exchanges an authorization token for access and refresh tokens
9
+ [**facilityLicenseCreate**](MetricsAdminApi.md#facilityLicenseCreate) | **POST** /facility/license | Create a facility license
10
+ [**facilityLicenseDelete**](MetricsAdminApi.md#facilityLicenseDelete) | **DELETE** /facility/license/{id} | Delete a facility license
11
+ [**facilityLicenseList**](MetricsAdminApi.md#facilityLicenseList) | **GET** /facility/license/list | List facility licenses
12
+ [**globalAccessControlCreate**](MetricsAdminApi.md#globalAccessControlCreate) | **POST** /global-access-control | Create a user\'s global access control rights
13
+ [**globalAccessControlDelete**](MetricsAdminApi.md#globalAccessControlDelete) | **DELETE** /global-access-control/{userId} | Delete a user\'s global access control
14
+ [**globalAccessControlList**](MetricsAdminApi.md#globalAccessControlList) | **GET** /global-access-control/list | List global access control for users
15
+ [**globalAccessControlRecreateSecret**](MetricsAdminApi.md#globalAccessControlRecreateSecret) | **POST** /global-access-control/recreate-secret | Recreate a user\'s authenticator secret
16
+ [**globalAccessControlShow**](MetricsAdminApi.md#globalAccessControlShow) | **GET** /global-access-control | Show a global access control
17
+ [**globalAccessControlUpdate**](MetricsAdminApi.md#globalAccessControlUpdate) | **PUT** /global-access-control | Update a user global access control rights
18
+ [**resqueCacheCreate**](MetricsAdminApi.md#resqueCacheCreate) | **POST** /resque/cache | Create cached object
19
+ [**resqueCacheDelete**](MetricsAdminApi.md#resqueCacheDelete) | **DELETE** /resque/cache/{key} | Delete cached object
20
+ [**resqueCacheShow**](MetricsAdminApi.md#resqueCacheShow) | **GET** /resque/cache | Show cache object
21
+ [**resqueCacheUpdate**](MetricsAdminApi.md#resqueCacheUpdate) | **PUT** /resque/cache/{key} | Update cached object
22
+ [**resqueDetails**](MetricsAdminApi.md#resqueDetails) | **GET** /resque/details | Show wholistic details about resque system
23
+ [**resqueTaskDeleteAllFailed**](MetricsAdminApi.md#resqueTaskDeleteAllFailed) | **DELETE** /resque/task/delete-all-failed | Delete all failed task
24
+ [**resqueTaskDeleteFailed**](MetricsAdminApi.md#resqueTaskDeleteFailed) | **DELETE** /resque/task/delete-failed | Delete a failed task
25
+ [**resqueTaskDeleteTask**](MetricsAdminApi.md#resqueTaskDeleteTask) | **DELETE** /resque/task/delete-task | Delete a task from the queue
26
+ [**resqueTaskFailures**](MetricsAdminApi.md#resqueTaskFailures) | **GET** /resque/task/failures | Lists failed tasks
27
+ [**resqueTaskQueue**](MetricsAdminApi.md#resqueTaskQueue) | **GET** /resque/task/queue | Lists enqueued tasks
28
+ [**resqueTaskRetryAllFailed**](MetricsAdminApi.md#resqueTaskRetryAllFailed) | **POST** /resque/task/retry-all-failed | Remove and retry all failed task
29
+ [**resqueTaskRetryFailed**](MetricsAdminApi.md#resqueTaskRetryFailed) | **POST** /resque/task/retry-failed | Remove and retry a failed task
30
+ [**resqueWorkerList**](MetricsAdminApi.md#resqueWorkerList) | **GET** /resque/worker | List resque workers
31
+ [**statsList**](MetricsAdminApi.md#statsList) | **GET** /stats | Shows stats queries
32
+ [**userDelete**](MetricsAdminApi.md#userDelete) | **DELETE** /user | Delete a user
33
+ [**userList**](MetricsAdminApi.md#userList) | **GET** /user/list | List users
34
+ [**userMerge**](MetricsAdminApi.md#userMerge) | **PUT** /user/merge | Merge two user together
35
+ [**userShow**](MetricsAdminApi.md#userShow) | **GET** /user | Show a user
36
+
37
+
38
+ # **adminLogin**
39
+ > UserResponse adminLogin()
40
+
41
+
42
+ ### Example
43
+
44
+
45
+ ```typescript
46
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
47
+ import * as fs from 'fs';
48
+
49
+ const api = new MetricsAdminApi();
50
+
51
+ let body:MetricsAdminApiAdminLoginRequest = {
52
+ // string
53
+ email: email_example,
54
+ // string
55
+ password: password_example,
56
+ // boolean (optional)
57
+ refreshable: true,
58
+ // string (optional)
59
+ token: token_example,
60
+ // string (optional)
61
+ apiVersion: apiVersion_example,
62
+ };
63
+
64
+ try {
65
+ const data = await api.adminLogin(body);
66
+ console.log('API called successfully. Returned data: ' + data);
67
+ } catch (error) {
68
+ console.error(error);
69
+ }
70
+ ```
71
+
72
+
73
+ ### Parameters
74
+
75
+ Name | Type | Description | Notes
76
+ ------------- | ------------- | ------------- | -------------
77
+ **email** | [**string**] | | defaults to undefined
78
+ **password** | [**string**] | | defaults to undefined
79
+ **refreshable** | [**boolean**] | | (optional) defaults to undefined
80
+ **token** | [**string**] | | (optional) defaults to undefined
81
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
82
+
83
+
84
+ ### Return type
85
+
86
+ **UserResponse**
87
+
88
+ ### Authorization
89
+
90
+ No authorization required
91
+
92
+
93
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
94
+
95
+ # **authExchangeFulfillment**
96
+ > UserResponse authExchangeFulfillment()
97
+
98
+
99
+ ### Example
100
+
101
+
102
+ ```typescript
103
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
104
+ import * as fs from 'fs';
105
+
106
+ const api = new MetricsAdminApi();
107
+
108
+ let body:MetricsAdminApiAuthExchangeFulfillmentRequest = {
109
+ // string
110
+ exchangeToken: exchangeToken_example,
111
+ // string (optional)
112
+ apiVersion: apiVersion_example,
113
+ };
114
+
115
+ try {
116
+ const data = await api.authExchangeFulfillment(body);
117
+ console.log('API called successfully. Returned data: ' + data);
118
+ } catch (error) {
119
+ console.error(error);
120
+ }
121
+ ```
122
+
123
+
124
+ ### Parameters
125
+
126
+ Name | Type | Description | Notes
127
+ ------------- | ------------- | ------------- | -------------
128
+ **exchangeToken** | [**string**] | | defaults to undefined
129
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
130
+
131
+
132
+ ### Return type
133
+
134
+ **UserResponse**
135
+
136
+ ### Authorization
137
+
138
+ No authorization required
139
+
140
+
141
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
142
+
143
+ # **facilityLicenseCreate**
144
+ > FacilityLicenseResponse facilityLicenseCreate()
145
+
146
+
147
+ ### Example
148
+
149
+
150
+ ```typescript
151
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
152
+ import * as fs from 'fs';
153
+
154
+ const api = new MetricsAdminApi();
155
+
156
+ let body:MetricsAdminApiFacilityLicenseCreateRequest = {
157
+ // number
158
+ term: 8.14,
159
+ // string
160
+ type: type_example,
161
+ // string (optional)
162
+ accountId: accountId_example,
163
+ // string (optional)
164
+ email: email_example,
165
+ // string (optional)
166
+ name: name_example,
167
+ // string (optional)
168
+ apiVersion: apiVersion_example,
169
+ };
170
+
171
+ try {
172
+ const data = await api.facilityLicenseCreate(body);
173
+ console.log('API called successfully. Returned data: ' + data);
174
+ } catch (error) {
175
+ console.error(error);
176
+ }
177
+ ```
178
+
179
+
180
+ ### Parameters
181
+
182
+ Name | Type | Description | Notes
183
+ ------------- | ------------- | ------------- | -------------
184
+ **term** | [**number**] | | defaults to undefined
185
+ **type** | [**string**] | Allowed values: normal, demo, test | defaults to undefined
186
+ **accountId** | [**string**] | | (optional) defaults to undefined
187
+ **email** | [**string**] | | (optional) defaults to undefined
188
+ **name** | [**string**] | | (optional) defaults to undefined
189
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
190
+
191
+
192
+ ### Return type
193
+
194
+ **FacilityLicenseResponse**
195
+
196
+ ### Authorization
197
+
198
+ [bearerAuth](../README.md#bearerAuth)
199
+
200
+
201
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
202
+
203
+ # **facilityLicenseDelete**
204
+ > facilityLicenseDelete()
205
+
206
+
207
+ ### Example
208
+
209
+
210
+ ```typescript
211
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
212
+ import * as fs from 'fs';
213
+
214
+ const api = new MetricsAdminApi();
215
+
216
+ let body:MetricsAdminApiFacilityLicenseDeleteRequest = {
217
+ // number
218
+ id: 8.14,
219
+ // string (optional)
220
+ apiVersion: apiVersion_example,
221
+ };
222
+
223
+ try {
224
+ const data = await api.facilityLicenseDelete(body);
225
+ console.log('API called successfully. Returned data: ' + data);
226
+ } catch (error) {
227
+ console.error(error);
228
+ }
229
+ ```
230
+
231
+
232
+ ### Parameters
233
+
234
+ Name | Type | Description | Notes
235
+ ------------- | ------------- | ------------- | -------------
236
+ **id** | [**number**] | | defaults to undefined
237
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
238
+
239
+
240
+ ### Return type
241
+
242
+ void (empty response body)
243
+
244
+ ### Authorization
245
+
246
+ [bearerAuth](../README.md#bearerAuth)
247
+
248
+
249
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
250
+
251
+ # **facilityLicenseList**
252
+ > FacilityLicenseListResponse facilityLicenseList()
253
+
254
+
255
+ ### Example
256
+
257
+
258
+ ```typescript
259
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
260
+ import * as fs from 'fs';
261
+
262
+ const api = new MetricsAdminApi();
263
+
264
+ let body:MetricsAdminApiFacilityLicenseListRequest = {
265
+ // string (optional)
266
+ accountId: accountId_example,
267
+ // boolean (optional)
268
+ ascending: true,
269
+ // string (optional)
270
+ key: key_example,
271
+ // number (optional)
272
+ limit: 8.14,
273
+ // string (optional)
274
+ name: name_example,
275
+ // number (optional)
276
+ offset: 8.14,
277
+ // string (optional)
278
+ sort: sort_example,
279
+ // string (optional)
280
+ type: type_example,
281
+ // string (optional)
282
+ apiVersion: apiVersion_example,
283
+ };
284
+
285
+ try {
286
+ const data = await api.facilityLicenseList(body);
287
+ console.log('API called successfully. Returned data: ' + data);
288
+ } catch (error) {
289
+ console.error(error);
290
+ }
291
+ ```
292
+
293
+
294
+ ### Parameters
295
+
296
+ Name | Type | Description | Notes
297
+ ------------- | ------------- | ------------- | -------------
298
+ **accountId** | [**string**] | | (optional) defaults to undefined
299
+ **ascending** | [**boolean**] | | (optional) defaults to true
300
+ **key** | [**string**] | | (optional) defaults to undefined
301
+ **limit** | [**number**] | | (optional) defaults to undefined
302
+ **name** | [**string**] | | (optional) defaults to undefined
303
+ **offset** | [**number**] | | (optional) defaults to undefined
304
+ **sort** | [**string**] | Allowed values: id, type, term, effectiveDate | (optional) defaults to 'id'
305
+ **type** | [**string**] | Allowed values: normal, demo, test | (optional) defaults to undefined
306
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
307
+
308
+
309
+ ### Return type
310
+
311
+ **FacilityLicenseListResponse**
312
+
313
+ ### Authorization
314
+
315
+ [bearerAuth](../README.md#bearerAuth)
316
+
317
+
318
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
319
+
320
+ # **globalAccessControlCreate**
321
+ > GlobalAccessControlCreationResponse globalAccessControlCreate()
322
+
323
+
324
+ ### Example
325
+
326
+
327
+ ```typescript
328
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
329
+ import * as fs from 'fs';
330
+
331
+ const api = new MetricsAdminApi();
332
+
333
+ let body:MetricsAdminApiGlobalAccessControlCreateRequest = {
334
+ // string (optional)
335
+ accessControlRights: accessControlRights_example,
336
+ // string (optional)
337
+ analyticRights: analyticRights_example,
338
+ // string (optional)
339
+ exerciseRights: exerciseRights_example,
340
+ // string (optional)
341
+ facilityRights: facilityRights_example,
342
+ // string (optional)
343
+ licenseRights: licenseRights_example,
344
+ // string (optional)
345
+ mSeriesGuidedSessionRights: mSeriesGuidedSessionRights_example,
346
+ // string (optional)
347
+ resqueRights: resqueRights_example,
348
+ // number (optional)
349
+ userId: 8.14,
350
+ // string (optional)
351
+ userRights: userRights_example,
352
+ // string (optional)
353
+ apiVersion: apiVersion_example,
354
+ };
355
+
356
+ try {
357
+ const data = await api.globalAccessControlCreate(body);
358
+ console.log('API called successfully. Returned data: ' + data);
359
+ } catch (error) {
360
+ console.error(error);
361
+ }
362
+ ```
363
+
364
+
365
+ ### Parameters
366
+
367
+ Name | Type | Description | Notes
368
+ ------------- | ------------- | ------------- | -------------
369
+ **accessControlRights** | [**string**] | Allowed values: view, edit | (optional) defaults to undefined
370
+ **analyticRights** | [**string**] | Allowed values: view | (optional) defaults to undefined
371
+ **exerciseRights** | [**string**] | Allowed values: edit | (optional) defaults to undefined
372
+ **facilityRights** | [**string**] | Allowed values: view, edit | (optional) defaults to undefined
373
+ **licenseRights** | [**string**] | Allowed values: view, edit | (optional) defaults to undefined
374
+ **mSeriesGuidedSessionRights** | [**string**] | Allowed values: access, publish | (optional) defaults to undefined
375
+ **resqueRights** | [**string**] | Allowed values: view, edit | (optional) defaults to undefined
376
+ **userId** | [**number**] | | (optional) defaults to undefined
377
+ **userRights** | [**string**] | Allowed values: view, edit | (optional) defaults to undefined
378
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
379
+
380
+
381
+ ### Return type
382
+
383
+ **GlobalAccessControlCreationResponse**
384
+
385
+ ### Authorization
386
+
387
+ [bearerAuth](../README.md#bearerAuth)
388
+
389
+
390
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
391
+
392
+ # **globalAccessControlDelete**
393
+ > globalAccessControlDelete()
394
+
395
+
396
+ ### Example
397
+
398
+
399
+ ```typescript
400
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
401
+ import * as fs from 'fs';
402
+
403
+ const api = new MetricsAdminApi();
404
+
405
+ let body:MetricsAdminApiGlobalAccessControlDeleteRequest = {
406
+ // number
407
+ userId: 8.14,
408
+ // string (optional)
409
+ apiVersion: apiVersion_example,
410
+ };
411
+
412
+ try {
413
+ const data = await api.globalAccessControlDelete(body);
414
+ console.log('API called successfully. Returned data: ' + data);
415
+ } catch (error) {
416
+ console.error(error);
417
+ }
418
+ ```
419
+
420
+
421
+ ### Parameters
422
+
423
+ Name | Type | Description | Notes
424
+ ------------- | ------------- | ------------- | -------------
425
+ **userId** | [**number**] | | defaults to undefined
426
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
427
+
428
+
429
+ ### Return type
430
+
431
+ void (empty response body)
432
+
433
+ ### Authorization
434
+
435
+ [bearerAuth](../README.md#bearerAuth)
436
+
437
+
438
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
439
+
440
+ # **globalAccessControlList**
441
+ > GlobalAccessControlListResponse globalAccessControlList()
442
+
443
+
444
+ ### Example
445
+
446
+
447
+ ```typescript
448
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
449
+ import * as fs from 'fs';
450
+
451
+ const api = new MetricsAdminApi();
452
+
453
+ let body:MetricsAdminApiGlobalAccessControlListRequest = {
454
+ // boolean (optional)
455
+ ascending: true,
456
+ // number (optional)
457
+ limit: 8.14,
458
+ // string (optional)
459
+ name: name_example,
460
+ // number (optional)
461
+ offset: 8.14,
462
+ // string (optional)
463
+ sort: sort_example,
464
+ // string (optional)
465
+ apiVersion: apiVersion_example,
466
+ };
467
+
468
+ try {
469
+ const data = await api.globalAccessControlList(body);
470
+ console.log('API called successfully. Returned data: ' + data);
471
+ } catch (error) {
472
+ console.error(error);
473
+ }
474
+ ```
475
+
476
+
477
+ ### Parameters
478
+
479
+ Name | Type | Description | Notes
480
+ ------------- | ------------- | ------------- | -------------
481
+ **ascending** | [**boolean**] | | (optional) defaults to true
482
+ **limit** | [**number**] | | (optional) defaults to undefined
483
+ **name** | [**string**] | | (optional) defaults to undefined
484
+ **offset** | [**number**] | | (optional) defaults to undefined
485
+ **sort** | [**string**] | Allowed values: id, name | (optional) defaults to 'id'
486
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
487
+
488
+
489
+ ### Return type
490
+
491
+ **GlobalAccessControlListResponse**
492
+
493
+ ### Authorization
494
+
495
+ [bearerAuth](../README.md#bearerAuth)
496
+
497
+
498
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
499
+
500
+ # **globalAccessControlRecreateSecret**
501
+ > GlobalAccessControlSecretResponse globalAccessControlRecreateSecret()
502
+
503
+
504
+ ### Example
505
+
506
+
507
+ ```typescript
508
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
509
+ import * as fs from 'fs';
510
+
511
+ const api = new MetricsAdminApi();
512
+
513
+ let body:MetricsAdminApiGlobalAccessControlRecreateSecretRequest = {
514
+ // string (optional)
515
+ apiVersion: apiVersion_example,
516
+ };
517
+
518
+ try {
519
+ const data = await api.globalAccessControlRecreateSecret(body);
520
+ console.log('API called successfully. Returned data: ' + data);
521
+ } catch (error) {
522
+ console.error(error);
523
+ }
524
+ ```
525
+
526
+
527
+ ### Parameters
528
+
529
+ Name | Type | Description | Notes
530
+ ------------- | ------------- | ------------- | -------------
531
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
532
+
533
+
534
+ ### Return type
535
+
536
+ **GlobalAccessControlSecretResponse**
537
+
538
+ ### Authorization
539
+
540
+ [bearerAuth](../README.md#bearerAuth)
541
+
542
+
543
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
544
+
545
+ # **globalAccessControlShow**
546
+ > GlobalAccessControlResponse globalAccessControlShow()
547
+
548
+
549
+ ### Example
550
+
551
+
552
+ ```typescript
553
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
554
+ import * as fs from 'fs';
555
+
556
+ const api = new MetricsAdminApi();
557
+
558
+ let body:MetricsAdminApiGlobalAccessControlShowRequest = {
559
+ // number (optional)
560
+ userId: 8.14,
561
+ // string (optional)
562
+ apiVersion: apiVersion_example,
563
+ };
564
+
565
+ try {
566
+ const data = await api.globalAccessControlShow(body);
567
+ console.log('API called successfully. Returned data: ' + data);
568
+ } catch (error) {
569
+ console.error(error);
570
+ }
571
+ ```
572
+
573
+
574
+ ### Parameters
575
+
576
+ Name | Type | Description | Notes
577
+ ------------- | ------------- | ------------- | -------------
578
+ **userId** | [**number**] | | (optional) defaults to undefined
579
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
580
+
581
+
582
+ ### Return type
583
+
584
+ **GlobalAccessControlResponse**
585
+
586
+ ### Authorization
587
+
588
+ [bearerAuth](../README.md#bearerAuth)
589
+
590
+
591
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
592
+
593
+ # **globalAccessControlUpdate**
594
+ > GlobalAccessControlResponse globalAccessControlUpdate()
595
+
596
+
597
+ ### Example
598
+
599
+
600
+ ```typescript
601
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
602
+ import * as fs from 'fs';
603
+
604
+ const api = new MetricsAdminApi();
605
+
606
+ let body:MetricsAdminApiGlobalAccessControlUpdateRequest = {
607
+ // string (optional)
608
+ accessControlRights: accessControlRights_example,
609
+ // string (optional)
610
+ analyticRights: analyticRights_example,
611
+ // string (optional)
612
+ exerciseRights: exerciseRights_example,
613
+ // string (optional)
614
+ facilityRights: facilityRights_example,
615
+ // string (optional)
616
+ licenseRights: licenseRights_example,
617
+ // string (optional)
618
+ mSeriesGuidedSessionRights: mSeriesGuidedSessionRights_example,
619
+ // string (optional)
620
+ resqueRights: resqueRights_example,
621
+ // number (optional)
622
+ userId: 8.14,
623
+ // string (optional)
624
+ userRights: userRights_example,
625
+ // string (optional)
626
+ apiVersion: apiVersion_example,
627
+ };
628
+
629
+ try {
630
+ const data = await api.globalAccessControlUpdate(body);
631
+ console.log('API called successfully. Returned data: ' + data);
632
+ } catch (error) {
633
+ console.error(error);
634
+ }
635
+ ```
636
+
637
+
638
+ ### Parameters
639
+
640
+ Name | Type | Description | Notes
641
+ ------------- | ------------- | ------------- | -------------
642
+ **accessControlRights** | [**string**] | Allowed values: view, edit | (optional) defaults to undefined
643
+ **analyticRights** | [**string**] | Allowed values: view | (optional) defaults to undefined
644
+ **exerciseRights** | [**string**] | Allowed values: edit | (optional) defaults to undefined
645
+ **facilityRights** | [**string**] | Allowed values: view, edit | (optional) defaults to undefined
646
+ **licenseRights** | [**string**] | Allowed values: view, edit | (optional) defaults to undefined
647
+ **mSeriesGuidedSessionRights** | [**string**] | Allowed values: access, publish | (optional) defaults to undefined
648
+ **resqueRights** | [**string**] | Allowed values: view, edit | (optional) defaults to undefined
649
+ **userId** | [**number**] | | (optional) defaults to undefined
650
+ **userRights** | [**string**] | Allowed values: view, edit | (optional) defaults to undefined
651
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
652
+
653
+
654
+ ### Return type
655
+
656
+ **GlobalAccessControlResponse**
657
+
658
+ ### Authorization
659
+
660
+ [bearerAuth](../README.md#bearerAuth)
661
+
662
+
663
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
664
+
665
+ # **resqueCacheCreate**
666
+ > CacheObjectResponse resqueCacheCreate()
667
+
668
+
669
+ ### Example
670
+
671
+
672
+ ```typescript
673
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
674
+ import * as fs from 'fs';
675
+
676
+ const api = new MetricsAdminApi();
677
+
678
+ let body:MetricsAdminApiResqueCacheCreateRequest = {
679
+ // string
680
+ key: key_example,
681
+ // string
682
+ value: value_example,
683
+ // number (optional)
684
+ expireIn: 8.14,
685
+ // string (optional)
686
+ apiVersion: apiVersion_example,
687
+ };
688
+
689
+ try {
690
+ const data = await api.resqueCacheCreate(body);
691
+ console.log('API called successfully. Returned data: ' + data);
692
+ } catch (error) {
693
+ console.error(error);
694
+ }
695
+ ```
696
+
697
+
698
+ ### Parameters
699
+
700
+ Name | Type | Description | Notes
701
+ ------------- | ------------- | ------------- | -------------
702
+ **key** | [**string**] | | defaults to undefined
703
+ **value** | [**string**] | | defaults to undefined
704
+ **expireIn** | [**number**] | | (optional) defaults to undefined
705
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
706
+
707
+
708
+ ### Return type
709
+
710
+ **CacheObjectResponse**
711
+
712
+ ### Authorization
713
+
714
+ [bearerAuth](../README.md#bearerAuth)
715
+
716
+
717
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
718
+
719
+ # **resqueCacheDelete**
720
+ > resqueCacheDelete()
721
+
722
+
723
+ ### Example
724
+
725
+
726
+ ```typescript
727
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
728
+ import * as fs from 'fs';
729
+
730
+ const api = new MetricsAdminApi();
731
+
732
+ let body:MetricsAdminApiResqueCacheDeleteRequest = {
733
+ // string
734
+ key: key_example,
735
+ // string (optional)
736
+ apiVersion: apiVersion_example,
737
+ };
738
+
739
+ try {
740
+ const data = await api.resqueCacheDelete(body);
741
+ console.log('API called successfully. Returned data: ' + data);
742
+ } catch (error) {
743
+ console.error(error);
744
+ }
745
+ ```
746
+
747
+
748
+ ### Parameters
749
+
750
+ Name | Type | Description | Notes
751
+ ------------- | ------------- | ------------- | -------------
752
+ **key** | [**string**] | | defaults to undefined
753
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
754
+
755
+
756
+ ### Return type
757
+
758
+ void (empty response body)
759
+
760
+ ### Authorization
761
+
762
+ [bearerAuth](../README.md#bearerAuth)
763
+
764
+
765
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
766
+
767
+ # **resqueCacheShow**
768
+ > CacheObjectResponse resqueCacheShow()
769
+
770
+
771
+ ### Example
772
+
773
+
774
+ ```typescript
775
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
776
+ import * as fs from 'fs';
777
+
778
+ const api = new MetricsAdminApi();
779
+
780
+ let body:MetricsAdminApiResqueCacheShowRequest = {
781
+ // string
782
+ key: key_example,
783
+ // string (optional)
784
+ apiVersion: apiVersion_example,
785
+ };
786
+
787
+ try {
788
+ const data = await api.resqueCacheShow(body);
789
+ console.log('API called successfully. Returned data: ' + data);
790
+ } catch (error) {
791
+ console.error(error);
792
+ }
793
+ ```
794
+
795
+
796
+ ### Parameters
797
+
798
+ Name | Type | Description | Notes
799
+ ------------- | ------------- | ------------- | -------------
800
+ **key** | [**string**] | | defaults to undefined
801
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
802
+
803
+
804
+ ### Return type
805
+
806
+ **CacheObjectResponse**
807
+
808
+ ### Authorization
809
+
810
+ [bearerAuth](../README.md#bearerAuth)
811
+
812
+
813
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
814
+
815
+ # **resqueCacheUpdate**
816
+ > CacheObjectResponse resqueCacheUpdate()
817
+
818
+
819
+ ### Example
820
+
821
+
822
+ ```typescript
823
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
824
+ import * as fs from 'fs';
825
+
826
+ const api = new MetricsAdminApi();
827
+
828
+ let body:MetricsAdminApiResqueCacheUpdateRequest = {
829
+ // string
830
+ key: key_example,
831
+ // string
832
+ value: value_example,
833
+ // number (optional)
834
+ expireIn: 8.14,
835
+ // string (optional)
836
+ apiVersion: apiVersion_example,
837
+ };
838
+
839
+ try {
840
+ const data = await api.resqueCacheUpdate(body);
841
+ console.log('API called successfully. Returned data: ' + data);
842
+ } catch (error) {
843
+ console.error(error);
844
+ }
845
+ ```
846
+
847
+
848
+ ### Parameters
849
+
850
+ Name | Type | Description | Notes
851
+ ------------- | ------------- | ------------- | -------------
852
+ **key** | [**string**] | | defaults to undefined
853
+ **value** | [**string**] | | defaults to undefined
854
+ **expireIn** | [**number**] | | (optional) defaults to undefined
855
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
856
+
857
+
858
+ ### Return type
859
+
860
+ **CacheObjectResponse**
861
+
862
+ ### Authorization
863
+
864
+ [bearerAuth](../README.md#bearerAuth)
865
+
866
+
867
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
868
+
869
+ # **resqueDetails**
870
+ > ResqueDetailsResponse resqueDetails()
871
+
872
+
873
+ ### Example
874
+
875
+
876
+ ```typescript
877
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
878
+ import * as fs from 'fs';
879
+
880
+ const api = new MetricsAdminApi();
881
+
882
+ let body:MetricsAdminApiResqueDetailsRequest = {
883
+ // string (optional)
884
+ apiVersion: apiVersion_example,
885
+ };
886
+
887
+ try {
888
+ const data = await api.resqueDetails(body);
889
+ console.log('API called successfully. Returned data: ' + data);
890
+ } catch (error) {
891
+ console.error(error);
892
+ }
893
+ ```
894
+
895
+
896
+ ### Parameters
897
+
898
+ Name | Type | Description | Notes
899
+ ------------- | ------------- | ------------- | -------------
900
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
901
+
902
+
903
+ ### Return type
904
+
905
+ **ResqueDetailsResponse**
906
+
907
+ ### Authorization
908
+
909
+ [bearerAuth](../README.md#bearerAuth)
910
+
911
+
912
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
913
+
914
+ # **resqueTaskDeleteAllFailed**
915
+ > resqueTaskDeleteAllFailed()
916
+
917
+
918
+ ### Example
919
+
920
+
921
+ ```typescript
922
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
923
+ import * as fs from 'fs';
924
+
925
+ const api = new MetricsAdminApi();
926
+
927
+ let body:MetricsAdminApiResqueTaskDeleteAllFailedRequest = {
928
+ // string (optional)
929
+ apiVersion: apiVersion_example,
930
+ };
931
+
932
+ try {
933
+ const data = await api.resqueTaskDeleteAllFailed(body);
934
+ console.log('API called successfully. Returned data: ' + data);
935
+ } catch (error) {
936
+ console.error(error);
937
+ }
938
+ ```
939
+
940
+
941
+ ### Parameters
942
+
943
+ Name | Type | Description | Notes
944
+ ------------- | ------------- | ------------- | -------------
945
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
946
+
947
+
948
+ ### Return type
949
+
950
+ void (empty response body)
951
+
952
+ ### Authorization
953
+
954
+ [bearerAuth](../README.md#bearerAuth)
955
+
956
+
957
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
958
+
959
+ # **resqueTaskDeleteFailed**
960
+ > resqueTaskDeleteFailed()
961
+
962
+
963
+ ### Example
964
+
965
+
966
+ ```typescript
967
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
968
+ import * as fs from 'fs';
969
+
970
+ const api = new MetricsAdminApi();
971
+
972
+ let body:MetricsAdminApiResqueTaskDeleteFailedRequest = {
973
+ // string
974
+ failedTask: failedTask_example,
975
+ // string (optional)
976
+ apiVersion: apiVersion_example,
977
+ };
978
+
979
+ try {
980
+ const data = await api.resqueTaskDeleteFailed(body);
981
+ console.log('API called successfully. Returned data: ' + data);
982
+ } catch (error) {
983
+ console.error(error);
984
+ }
985
+ ```
986
+
987
+
988
+ ### Parameters
989
+
990
+ Name | Type | Description | Notes
991
+ ------------- | ------------- | ------------- | -------------
992
+ **failedTask** | [**string**] | | defaults to undefined
993
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
994
+
995
+
996
+ ### Return type
997
+
998
+ void (empty response body)
999
+
1000
+ ### Authorization
1001
+
1002
+ [bearerAuth](../README.md#bearerAuth)
1003
+
1004
+
1005
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1006
+
1007
+ # **resqueTaskDeleteTask**
1008
+ > resqueTaskDeleteTask()
1009
+
1010
+
1011
+ ### Example
1012
+
1013
+
1014
+ ```typescript
1015
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
1016
+ import * as fs from 'fs';
1017
+
1018
+ const api = new MetricsAdminApi();
1019
+
1020
+ let body:MetricsAdminApiResqueTaskDeleteTaskRequest = {
1021
+ // string
1022
+ args: args_example,
1023
+ // string
1024
+ queue: queue_example,
1025
+ // string
1026
+ taskName: taskName_example,
1027
+ // string (optional)
1028
+ apiVersion: apiVersion_example,
1029
+ };
1030
+
1031
+ try {
1032
+ const data = await api.resqueTaskDeleteTask(body);
1033
+ console.log('API called successfully. Returned data: ' + data);
1034
+ } catch (error) {
1035
+ console.error(error);
1036
+ }
1037
+ ```
1038
+
1039
+
1040
+ ### Parameters
1041
+
1042
+ Name | Type | Description | Notes
1043
+ ------------- | ------------- | ------------- | -------------
1044
+ **args** | [**string**] | | defaults to undefined
1045
+ **queue** | [**string**] | | defaults to undefined
1046
+ **taskName** | [**string**] | | defaults to undefined
1047
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
1048
+
1049
+
1050
+ ### Return type
1051
+
1052
+ void (empty response body)
1053
+
1054
+ ### Authorization
1055
+
1056
+ [bearerAuth](../README.md#bearerAuth)
1057
+
1058
+
1059
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1060
+
1061
+ # **resqueTaskFailures**
1062
+ > TaskFailedResponse resqueTaskFailures()
1063
+
1064
+
1065
+ ### Example
1066
+
1067
+
1068
+ ```typescript
1069
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
1070
+ import * as fs from 'fs';
1071
+
1072
+ const api = new MetricsAdminApi();
1073
+
1074
+ let body:MetricsAdminApiResqueTaskFailuresRequest = {
1075
+ // number (optional)
1076
+ limit: 8.14,
1077
+ // number (optional)
1078
+ offset: 8.14,
1079
+ // string (optional)
1080
+ apiVersion: apiVersion_example,
1081
+ };
1082
+
1083
+ try {
1084
+ const data = await api.resqueTaskFailures(body);
1085
+ console.log('API called successfully. Returned data: ' + data);
1086
+ } catch (error) {
1087
+ console.error(error);
1088
+ }
1089
+ ```
1090
+
1091
+
1092
+ ### Parameters
1093
+
1094
+ Name | Type | Description | Notes
1095
+ ------------- | ------------- | ------------- | -------------
1096
+ **limit** | [**number**] | | (optional) defaults to undefined
1097
+ **offset** | [**number**] | | (optional) defaults to undefined
1098
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
1099
+
1100
+
1101
+ ### Return type
1102
+
1103
+ **TaskFailedResponse**
1104
+
1105
+ ### Authorization
1106
+
1107
+ [bearerAuth](../README.md#bearerAuth)
1108
+
1109
+
1110
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1111
+
1112
+ # **resqueTaskQueue**
1113
+ > TaskQueueResponse resqueTaskQueue()
1114
+
1115
+
1116
+ ### Example
1117
+
1118
+
1119
+ ```typescript
1120
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
1121
+ import * as fs from 'fs';
1122
+
1123
+ const api = new MetricsAdminApi();
1124
+
1125
+ let body:MetricsAdminApiResqueTaskQueueRequest = {
1126
+ // string
1127
+ queue: queue_example,
1128
+ // number (optional)
1129
+ limit: 8.14,
1130
+ // number (optional)
1131
+ offset: 8.14,
1132
+ // string (optional)
1133
+ apiVersion: apiVersion_example,
1134
+ };
1135
+
1136
+ try {
1137
+ const data = await api.resqueTaskQueue(body);
1138
+ console.log('API called successfully. Returned data: ' + data);
1139
+ } catch (error) {
1140
+ console.error(error);
1141
+ }
1142
+ ```
1143
+
1144
+
1145
+ ### Parameters
1146
+
1147
+ Name | Type | Description | Notes
1148
+ ------------- | ------------- | ------------- | -------------
1149
+ **queue** | [**string**] | | defaults to undefined
1150
+ **limit** | [**number**] | | (optional) defaults to undefined
1151
+ **offset** | [**number**] | | (optional) defaults to undefined
1152
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
1153
+
1154
+
1155
+ ### Return type
1156
+
1157
+ **TaskQueueResponse**
1158
+
1159
+ ### Authorization
1160
+
1161
+ [bearerAuth](../README.md#bearerAuth)
1162
+
1163
+
1164
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1165
+
1166
+ # **resqueTaskRetryAllFailed**
1167
+ > resqueTaskRetryAllFailed()
1168
+
1169
+
1170
+ ### Example
1171
+
1172
+
1173
+ ```typescript
1174
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
1175
+ import * as fs from 'fs';
1176
+
1177
+ const api = new MetricsAdminApi();
1178
+
1179
+ let body:MetricsAdminApiResqueTaskRetryAllFailedRequest = {
1180
+ // string (optional)
1181
+ apiVersion: apiVersion_example,
1182
+ };
1183
+
1184
+ try {
1185
+ const data = await api.resqueTaskRetryAllFailed(body);
1186
+ console.log('API called successfully. Returned data: ' + data);
1187
+ } catch (error) {
1188
+ console.error(error);
1189
+ }
1190
+ ```
1191
+
1192
+
1193
+ ### Parameters
1194
+
1195
+ Name | Type | Description | Notes
1196
+ ------------- | ------------- | ------------- | -------------
1197
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
1198
+
1199
+
1200
+ ### Return type
1201
+
1202
+ void (empty response body)
1203
+
1204
+ ### Authorization
1205
+
1206
+ [bearerAuth](../README.md#bearerAuth)
1207
+
1208
+
1209
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1210
+
1211
+ # **resqueTaskRetryFailed**
1212
+ > resqueTaskRetryFailed()
1213
+
1214
+
1215
+ ### Example
1216
+
1217
+
1218
+ ```typescript
1219
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
1220
+ import * as fs from 'fs';
1221
+
1222
+ const api = new MetricsAdminApi();
1223
+
1224
+ let body:MetricsAdminApiResqueTaskRetryFailedRequest = {
1225
+ // string
1226
+ failedTask: failedTask_example,
1227
+ // string (optional)
1228
+ apiVersion: apiVersion_example,
1229
+ };
1230
+
1231
+ try {
1232
+ const data = await api.resqueTaskRetryFailed(body);
1233
+ console.log('API called successfully. Returned data: ' + data);
1234
+ } catch (error) {
1235
+ console.error(error);
1236
+ }
1237
+ ```
1238
+
1239
+
1240
+ ### Parameters
1241
+
1242
+ Name | Type | Description | Notes
1243
+ ------------- | ------------- | ------------- | -------------
1244
+ **failedTask** | [**string**] | | defaults to undefined
1245
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
1246
+
1247
+
1248
+ ### Return type
1249
+
1250
+ void (empty response body)
1251
+
1252
+ ### Authorization
1253
+
1254
+ [bearerAuth](../README.md#bearerAuth)
1255
+
1256
+
1257
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1258
+
1259
+ # **resqueWorkerList**
1260
+ > WorkersResponse resqueWorkerList()
1261
+
1262
+
1263
+ ### Example
1264
+
1265
+
1266
+ ```typescript
1267
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
1268
+ import * as fs from 'fs';
1269
+
1270
+ const api = new MetricsAdminApi();
1271
+
1272
+ let body:MetricsAdminApiResqueWorkerListRequest = {
1273
+ // string (optional)
1274
+ apiVersion: apiVersion_example,
1275
+ };
1276
+
1277
+ try {
1278
+ const data = await api.resqueWorkerList(body);
1279
+ console.log('API called successfully. Returned data: ' + data);
1280
+ } catch (error) {
1281
+ console.error(error);
1282
+ }
1283
+ ```
1284
+
1285
+
1286
+ ### Parameters
1287
+
1288
+ Name | Type | Description | Notes
1289
+ ------------- | ------------- | ------------- | -------------
1290
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
1291
+
1292
+
1293
+ ### Return type
1294
+
1295
+ **WorkersResponse**
1296
+
1297
+ ### Authorization
1298
+
1299
+ [bearerAuth](../README.md#bearerAuth)
1300
+
1301
+
1302
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1303
+
1304
+ # **statsList**
1305
+ > StatListResponse statsList()
1306
+
1307
+
1308
+ ### Example
1309
+
1310
+
1311
+ ```typescript
1312
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
1313
+ import * as fs from 'fs';
1314
+
1315
+ const api = new MetricsAdminApi();
1316
+
1317
+ let body:MetricsAdminApiStatsListRequest = {
1318
+ // boolean (optional)
1319
+ ascending: true,
1320
+ // Date (optional)
1321
+ from: 2013-10-20T19:20:30+01:00,
1322
+ // number (optional)
1323
+ limit: 8.14,
1324
+ // number (optional)
1325
+ offset: 8.14,
1326
+ // string (optional)
1327
+ sort: sort_example,
1328
+ // Date (optional)
1329
+ to: 2013-10-20T19:20:30+01:00,
1330
+ // string (optional)
1331
+ apiVersion: apiVersion_example,
1332
+ };
1333
+
1334
+ try {
1335
+ const data = await api.statsList(body);
1336
+ console.log('API called successfully. Returned data: ' + data);
1337
+ } catch (error) {
1338
+ console.error(error);
1339
+ }
1340
+ ```
1341
+
1342
+
1343
+ ### Parameters
1344
+
1345
+ Name | Type | Description | Notes
1346
+ ------------- | ------------- | ------------- | -------------
1347
+ **ascending** | [**boolean**] | | (optional) defaults to false
1348
+ **from** | [**Date**] | | (optional) defaults to undefined
1349
+ **limit** | [**number**] | | (optional) defaults to undefined
1350
+ **offset** | [**number**] | | (optional) defaults to undefined
1351
+ **sort** | [**string**] | Allowed values: id, createdAt | (optional) defaults to 'createdAt'
1352
+ **to** | [**Date**] | | (optional) defaults to undefined
1353
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
1354
+
1355
+
1356
+ ### Return type
1357
+
1358
+ **StatListResponse**
1359
+
1360
+ ### Authorization
1361
+
1362
+ [bearerAuth](../README.md#bearerAuth)
1363
+
1364
+
1365
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1366
+
1367
+ # **userDelete**
1368
+ > userDelete()
1369
+
1370
+
1371
+ ### Example
1372
+
1373
+
1374
+ ```typescript
1375
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
1376
+ import * as fs from 'fs';
1377
+
1378
+ const api = new MetricsAdminApi();
1379
+
1380
+ let body:MetricsAdminApiUserDeleteRequest = {
1381
+ // number (optional)
1382
+ userId: 8.14,
1383
+ // string (optional)
1384
+ apiVersion: apiVersion_example,
1385
+ };
1386
+
1387
+ try {
1388
+ const data = await api.userDelete(body);
1389
+ console.log('API called successfully. Returned data: ' + data);
1390
+ } catch (error) {
1391
+ console.error(error);
1392
+ }
1393
+ ```
1394
+
1395
+
1396
+ ### Parameters
1397
+
1398
+ Name | Type | Description | Notes
1399
+ ------------- | ------------- | ------------- | -------------
1400
+ **userId** | [**number**] | | (optional) defaults to undefined
1401
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
1402
+
1403
+
1404
+ ### Return type
1405
+
1406
+ void (empty response body)
1407
+
1408
+ ### Authorization
1409
+
1410
+ [bearerAuth](../README.md#bearerAuth)
1411
+
1412
+
1413
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1414
+
1415
+ # **userList**
1416
+ > UserListResponse userList()
1417
+
1418
+
1419
+ ### Example
1420
+
1421
+
1422
+ ```typescript
1423
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
1424
+ import * as fs from 'fs';
1425
+
1426
+ const api = new MetricsAdminApi();
1427
+
1428
+ let body:MetricsAdminApiUserListRequest = {
1429
+ // boolean (optional)
1430
+ ascending: true,
1431
+ // string (optional)
1432
+ email: email_example,
1433
+ // number (optional)
1434
+ limit: 8.14,
1435
+ // string (optional)
1436
+ name: name_example,
1437
+ // number (optional)
1438
+ offset: 8.14,
1439
+ // string (optional)
1440
+ sort: sort_example,
1441
+ // string (optional)
1442
+ apiVersion: apiVersion_example,
1443
+ };
1444
+
1445
+ try {
1446
+ const data = await api.userList(body);
1447
+ console.log('API called successfully. Returned data: ' + data);
1448
+ } catch (error) {
1449
+ console.error(error);
1450
+ }
1451
+ ```
1452
+
1453
+
1454
+ ### Parameters
1455
+
1456
+ Name | Type | Description | Notes
1457
+ ------------- | ------------- | ------------- | -------------
1458
+ **ascending** | [**boolean**] | | (optional) defaults to true
1459
+ **email** | [**string**] | | (optional) defaults to undefined
1460
+ **limit** | [**number**] | | (optional) defaults to undefined
1461
+ **name** | [**string**] | | (optional) defaults to undefined
1462
+ **offset** | [**number**] | | (optional) defaults to undefined
1463
+ **sort** | [**string**] | Allowed values: id, name, createdAt | (optional) defaults to 'id'
1464
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
1465
+
1466
+
1467
+ ### Return type
1468
+
1469
+ **UserListResponse**
1470
+
1471
+ ### Authorization
1472
+
1473
+ [bearerAuth](../README.md#bearerAuth)
1474
+
1475
+
1476
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1477
+
1478
+ # **userMerge**
1479
+ > UserResponse userMerge()
1480
+
1481
+
1482
+ ### Example
1483
+
1484
+
1485
+ ```typescript
1486
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
1487
+ import * as fs from 'fs';
1488
+
1489
+ const api = new MetricsAdminApi();
1490
+
1491
+ let body:MetricsAdminApiUserMergeRequest = {
1492
+ // number
1493
+ fromUserId: 8.14,
1494
+ // number
1495
+ toUserId: 8.14,
1496
+ // string (optional)
1497
+ apiVersion: apiVersion_example,
1498
+ };
1499
+
1500
+ try {
1501
+ const data = await api.userMerge(body);
1502
+ console.log('API called successfully. Returned data: ' + data);
1503
+ } catch (error) {
1504
+ console.error(error);
1505
+ }
1506
+ ```
1507
+
1508
+
1509
+ ### Parameters
1510
+
1511
+ Name | Type | Description | Notes
1512
+ ------------- | ------------- | ------------- | -------------
1513
+ **fromUserId** | [**number**] | | defaults to undefined
1514
+ **toUserId** | [**number**] | | defaults to undefined
1515
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
1516
+
1517
+
1518
+ ### Return type
1519
+
1520
+ **UserResponse**
1521
+
1522
+ ### Authorization
1523
+
1524
+ [bearerAuth](../README.md#bearerAuth)
1525
+
1526
+
1527
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1528
+
1529
+ # **userShow**
1530
+ > UserResponse userShow()
1531
+
1532
+
1533
+ ### Example
1534
+
1535
+
1536
+ ```typescript
1537
+ import { MetricsAdminApi } from '@keiser/metrics-sdk-admin-typescript';
1538
+ import * as fs from 'fs';
1539
+
1540
+ const api = new MetricsAdminApi();
1541
+
1542
+ let body:MetricsAdminApiUserShowRequest = {
1543
+ // number (optional)
1544
+ userId: 8.14,
1545
+ // string (optional)
1546
+ apiVersion: apiVersion_example,
1547
+ };
1548
+
1549
+ try {
1550
+ const data = await api.userShow(body);
1551
+ console.log('API called successfully. Returned data: ' + data);
1552
+ } catch (error) {
1553
+ console.error(error);
1554
+ }
1555
+ ```
1556
+
1557
+
1558
+ ### Parameters
1559
+
1560
+ Name | Type | Description | Notes
1561
+ ------------- | ------------- | ------------- | -------------
1562
+ **userId** | [**number**] | | (optional) defaults to undefined
1563
+ **apiVersion** | [**string**] | | (optional) defaults to undefined
1564
+
1565
+
1566
+ ### Return type
1567
+
1568
+ **UserResponse**
1569
+
1570
+ ### Authorization
1571
+
1572
+ [bearerAuth](../README.md#bearerAuth)
1573
+
1574
+
1575
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
1576
+