vrchatapi-async 1.20.8.dev1__py3-none-any.whl

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 (362) hide show
  1. vrchatapi/__init__.py +742 -0
  2. vrchatapi/api/__init__.py +23 -0
  3. vrchatapi/api/authentication_api.py +6253 -0
  4. vrchatapi/api/avatars_api.py +4234 -0
  5. vrchatapi/api/calendar_api.py +4090 -0
  6. vrchatapi/api/economy_api.py +11547 -0
  7. vrchatapi/api/favorites_api.py +2368 -0
  8. vrchatapi/api/files_api.py +6109 -0
  9. vrchatapi/api/friends_api.py +1708 -0
  10. vrchatapi/api/groups_api.py +15085 -0
  11. vrchatapi/api/instances_api.py +1754 -0
  12. vrchatapi/api/inventory_api.py +4333 -0
  13. vrchatapi/api/invite_api.py +3337 -0
  14. vrchatapi/api/jams_api.py +1446 -0
  15. vrchatapi/api/miscellaneous_api.py +2384 -0
  16. vrchatapi/api/notifications_api.py +3624 -0
  17. vrchatapi/api/playermoderation_api.py +1127 -0
  18. vrchatapi/api/prints_api.py +1478 -0
  19. vrchatapi/api/props_api.py +2269 -0
  20. vrchatapi/api/users_api.py +7894 -0
  21. vrchatapi/api/worlds_api.py +6153 -0
  22. vrchatapi/api_client.py +865 -0
  23. vrchatapi/api_response.py +21 -0
  24. vrchatapi/configuration.py +686 -0
  25. vrchatapi/exceptions.py +218 -0
  26. vrchatapi/models/__init__.py +345 -0
  27. vrchatapi/models/account_deletion_log.py +253 -0
  28. vrchatapi/models/add_favorite_request.py +246 -0
  29. vrchatapi/models/add_group_gallery_image_request.py +234 -0
  30. vrchatapi/models/admin_asset_bundle.py +337 -0
  31. vrchatapi/models/admin_unity_package.py +261 -0
  32. vrchatapi/models/age_verification_status.py +38 -0
  33. vrchatapi/models/agreement.py +280 -0
  34. vrchatapi/models/agreement_code.py +36 -0
  35. vrchatapi/models/agreement_request.py +256 -0
  36. vrchatapi/models/agreement_status.py +261 -0
  37. vrchatapi/models/api_config.py +1299 -0
  38. vrchatapi/models/api_config_access_logs_urls.py +258 -0
  39. vrchatapi/models/api_config_announcement.py +217 -0
  40. vrchatapi/models/api_config_audio_config.py +311 -0
  41. vrchatapi/models/api_config_avatar_perf_limiter.py +293 -0
  42. vrchatapi/models/api_config_constants.py +262 -0
  43. vrchatapi/models/api_config_constants_groups.py +306 -0
  44. vrchatapi/models/api_config_constants_instance.py +238 -0
  45. vrchatapi/models/api_config_constants_instancepopulationbrackets.py +262 -0
  46. vrchatapi/models/api_config_constants_instancepopulationbracketscrowded.py +216 -0
  47. vrchatapi/models/api_config_constants_instancepopulationbracketsfew.py +216 -0
  48. vrchatapi/models/api_config_constants_instancepopulationbracketsmany.py +216 -0
  49. vrchatapi/models/api_config_constants_language.py +234 -0
  50. vrchatapi/models/api_config_download_url_list.py +258 -0
  51. vrchatapi/models/api_config_events.py +314 -0
  52. vrchatapi/models/api_config_ios_version.py +216 -0
  53. vrchatapi/models/api_config_min_supported_client_build_number.py +348 -0
  54. vrchatapi/models/api_config_offline_analysis.py +216 -0
  55. vrchatapi/models/api_health.py +248 -0
  56. vrchatapi/models/avatar.py +463 -0
  57. vrchatapi/models/avatar_moderation.py +249 -0
  58. vrchatapi/models/avatar_moderation_created.py +248 -0
  59. vrchatapi/models/avatar_moderation_type.py +36 -0
  60. vrchatapi/models/avatar_performance.py +265 -0
  61. vrchatapi/models/avatar_published_listings_inner.py +271 -0
  62. vrchatapi/models/avatar_style.py +239 -0
  63. vrchatapi/models/avatar_styles.py +231 -0
  64. vrchatapi/models/avatar_unity_package_url_object.py +234 -0
  65. vrchatapi/models/badge.py +308 -0
  66. vrchatapi/models/balance.py +247 -0
  67. vrchatapi/models/ban_group_member_request.py +234 -0
  68. vrchatapi/models/boop_request.py +250 -0
  69. vrchatapi/models/calendar_day_of_week.py +42 -0
  70. vrchatapi/models/calendar_event.py +475 -0
  71. vrchatapi/models/calendar_event_access.py +37 -0
  72. vrchatapi/models/calendar_event_category.py +48 -0
  73. vrchatapi/models/calendar_event_discovery.py +247 -0
  74. vrchatapi/models/calendar_event_discovery_inclusion.py +38 -0
  75. vrchatapi/models/calendar_event_discovery_scope.py +38 -0
  76. vrchatapi/models/calendar_event_frequency.py +39 -0
  77. vrchatapi/models/calendar_event_occurrence_kind.py +38 -0
  78. vrchatapi/models/calendar_event_platform.py +38 -0
  79. vrchatapi/models/calendar_event_recurrence.py +261 -0
  80. vrchatapi/models/calendar_event_recurrence_end.py +246 -0
  81. vrchatapi/models/calendar_event_recurrence_end_type.py +37 -0
  82. vrchatapi/models/calendar_event_user_interest.py +251 -0
  83. vrchatapi/models/change_user_tags_request.py +212 -0
  84. vrchatapi/models/change_world_tags_request.py +212 -0
  85. vrchatapi/models/content_filter.py +40 -0
  86. vrchatapi/models/create_avatar_moderation_request.py +243 -0
  87. vrchatapi/models/create_avatar_request.py +324 -0
  88. vrchatapi/models/create_calendar_event_request.py +385 -0
  89. vrchatapi/models/create_file_request.py +251 -0
  90. vrchatapi/models/create_file_version_request.py +259 -0
  91. vrchatapi/models/create_group_announcement_request.py +253 -0
  92. vrchatapi/models/create_group_gallery_request.py +297 -0
  93. vrchatapi/models/create_group_invite_request.py +242 -0
  94. vrchatapi/models/create_group_post_request.py +267 -0
  95. vrchatapi/models/create_group_request.py +295 -0
  96. vrchatapi/models/create_group_role_request.py +255 -0
  97. vrchatapi/models/create_instance_request.py +384 -0
  98. vrchatapi/models/create_jam_submission_request.py +239 -0
  99. vrchatapi/models/create_listing_request.py +285 -0
  100. vrchatapi/models/create_product_request.py +270 -0
  101. vrchatapi/models/create_prop_request.py +308 -0
  102. vrchatapi/models/create_world_request.py +322 -0
  103. vrchatapi/models/current_user.py +909 -0
  104. vrchatapi/models/current_user_platform_history_inner.py +245 -0
  105. vrchatapi/models/current_user_presence.py +379 -0
  106. vrchatapi/models/decline_group_invite_request.py +211 -0
  107. vrchatapi/models/developer_type.py +39 -0
  108. vrchatapi/models/disable2_fa_result.py +211 -0
  109. vrchatapi/models/discord_details.py +216 -0
  110. vrchatapi/models/dynamic_content_row.py +276 -0
  111. vrchatapi/models/earnings_metrics.py +248 -0
  112. vrchatapi/models/earnings_metrics_totals.py +267 -0
  113. vrchatapi/models/economy_account.py +360 -0
  114. vrchatapi/models/economy_balances.py +221 -0
  115. vrchatapi/models/economy_payout.py +385 -0
  116. vrchatapi/models/economy_payout_eligibility.py +263 -0
  117. vrchatapi/models/economy_payout_list.py +219 -0
  118. vrchatapi/models/economy_payout_status.py +295 -0
  119. vrchatapi/models/equip_inventory_item_request.py +235 -0
  120. vrchatapi/models/error.py +215 -0
  121. vrchatapi/models/favorite.py +251 -0
  122. vrchatapi/models/favorite_group.py +278 -0
  123. vrchatapi/models/favorite_group_limits.py +249 -0
  124. vrchatapi/models/favorite_group_visibility.py +38 -0
  125. vrchatapi/models/favorite_limits.py +265 -0
  126. vrchatapi/models/favorite_type.py +39 -0
  127. vrchatapi/models/favorited_world.py +441 -0
  128. vrchatapi/models/feedback.py +331 -0
  129. vrchatapi/models/file.py +325 -0
  130. vrchatapi/models/file_analysis.py +281 -0
  131. vrchatapi/models/file_analysis_avatar_stats.py +575 -0
  132. vrchatapi/models/file_data.py +279 -0
  133. vrchatapi/models/file_status.py +39 -0
  134. vrchatapi/models/file_upload_url.py +212 -0
  135. vrchatapi/models/file_version.py +254 -0
  136. vrchatapi/models/file_version_upload_status.py +269 -0
  137. vrchatapi/models/finish_file_data_upload_request.py +248 -0
  138. vrchatapi/models/follow_calendar_event_request.py +234 -0
  139. vrchatapi/models/friend_status.py +250 -0
  140. vrchatapi/models/get_group_posts200_response.py +219 -0
  141. vrchatapi/models/get_user_group_instances200_response.py +248 -0
  142. vrchatapi/models/group.py +514 -0
  143. vrchatapi/models/group_access_type.py +38 -0
  144. vrchatapi/models/group_announcement.py +315 -0
  145. vrchatapi/models/group_audit_log_entry.py +287 -0
  146. vrchatapi/models/group_gallery.py +319 -0
  147. vrchatapi/models/group_gallery_file_order.py +211 -0
  148. vrchatapi/models/group_gallery_file_order_request.py +239 -0
  149. vrchatapi/models/group_gallery_image.py +301 -0
  150. vrchatapi/models/group_instance.py +257 -0
  151. vrchatapi/models/group_join_request_action.py +37 -0
  152. vrchatapi/models/group_join_state.py +39 -0
  153. vrchatapi/models/group_member.py +415 -0
  154. vrchatapi/models/group_member_limited_user.py +290 -0
  155. vrchatapi/models/group_member_status.py +41 -0
  156. vrchatapi/models/group_my_member.py +399 -0
  157. vrchatapi/models/group_permission.py +260 -0
  158. vrchatapi/models/group_permissions.py +63 -0
  159. vrchatapi/models/group_post.py +317 -0
  160. vrchatapi/models/group_post_visibility.py +37 -0
  161. vrchatapi/models/group_privacy.py +37 -0
  162. vrchatapi/models/group_role.py +309 -0
  163. vrchatapi/models/group_role_template.py +39 -0
  164. vrchatapi/models/group_role_template_values.py +254 -0
  165. vrchatapi/models/group_role_template_values_roles.py +253 -0
  166. vrchatapi/models/group_search_sort.py +37 -0
  167. vrchatapi/models/group_transferable.py +215 -0
  168. vrchatapi/models/group_transferable_requirements.py +266 -0
  169. vrchatapi/models/group_user_visibility.py +38 -0
  170. vrchatapi/models/image_animation_style.py +62 -0
  171. vrchatapi/models/image_loop_style.py +37 -0
  172. vrchatapi/models/image_mask.py +41 -0
  173. vrchatapi/models/image_purpose.py +46 -0
  174. vrchatapi/models/info_push.py +306 -0
  175. vrchatapi/models/info_push_data.py +288 -0
  176. vrchatapi/models/info_push_data_article.py +215 -0
  177. vrchatapi/models/info_push_data_article_content.py +251 -0
  178. vrchatapi/models/info_push_data_clickable.py +224 -0
  179. vrchatapi/models/instance.py +597 -0
  180. vrchatapi/models/instance_content_settings.py +236 -0
  181. vrchatapi/models/instance_platforms.py +222 -0
  182. vrchatapi/models/instance_region.py +40 -0
  183. vrchatapi/models/instance_short_name_response.py +248 -0
  184. vrchatapi/models/instance_type.py +40 -0
  185. vrchatapi/models/inventory.py +247 -0
  186. vrchatapi/models/inventory_consumption_results.py +255 -0
  187. vrchatapi/models/inventory_default_attributes_value.py +243 -0
  188. vrchatapi/models/inventory_default_attributes_value_validator.py +211 -0
  189. vrchatapi/models/inventory_drop.py +331 -0
  190. vrchatapi/models/inventory_equip_slot.py +39 -0
  191. vrchatapi/models/inventory_flag.py +43 -0
  192. vrchatapi/models/inventory_item.py +420 -0
  193. vrchatapi/models/inventory_item_type.py +42 -0
  194. vrchatapi/models/inventory_metadata.py +287 -0
  195. vrchatapi/models/inventory_notification_details.py +244 -0
  196. vrchatapi/models/inventory_spawn.py +216 -0
  197. vrchatapi/models/inventory_template.py +351 -0
  198. vrchatapi/models/inventory_user_attributes.py +250 -0
  199. vrchatapi/models/invite_message.py +276 -0
  200. vrchatapi/models/invite_message_type.py +39 -0
  201. vrchatapi/models/invite_request.py +243 -0
  202. vrchatapi/models/invite_response.py +235 -0
  203. vrchatapi/models/jam.py +302 -0
  204. vrchatapi/models/jam_state_change_dates.py +276 -0
  205. vrchatapi/models/jam_submission.py +275 -0
  206. vrchatapi/models/join_group_request.py +234 -0
  207. vrchatapi/models/license.py +261 -0
  208. vrchatapi/models/license_action.py +37 -0
  209. vrchatapi/models/license_group.py +235 -0
  210. vrchatapi/models/license_type.py +39 -0
  211. vrchatapi/models/limited_group.py +377 -0
  212. vrchatapi/models/limited_unity_package.py +251 -0
  213. vrchatapi/models/limited_user_friend.py +399 -0
  214. vrchatapi/models/limited_user_groups.py +386 -0
  215. vrchatapi/models/limited_user_instance.py +430 -0
  216. vrchatapi/models/limited_user_search.py +395 -0
  217. vrchatapi/models/limited_world.py +410 -0
  218. vrchatapi/models/mime_type.py +50 -0
  219. vrchatapi/models/model_print.py +299 -0
  220. vrchatapi/models/moderate_user_request.py +217 -0
  221. vrchatapi/models/moderation_report.py +296 -0
  222. vrchatapi/models/mutual_friend.py +302 -0
  223. vrchatapi/models/mutuals.py +217 -0
  224. vrchatapi/models/notification.py +283 -0
  225. vrchatapi/models/notification_detail_invite.py +250 -0
  226. vrchatapi/models/notification_detail_invite_response.py +242 -0
  227. vrchatapi/models/notification_detail_request_invite.py +239 -0
  228. vrchatapi/models/notification_detail_request_invite_response.py +242 -0
  229. vrchatapi/models/notification_detail_vote_to_kick.py +242 -0
  230. vrchatapi/models/notification_type.py +43 -0
  231. vrchatapi/models/notification_v2.py +466 -0
  232. vrchatapi/models/notification_v2_details_boop.py +255 -0
  233. vrchatapi/models/notification_v2_response.py +259 -0
  234. vrchatapi/models/notification_v2_type.py +58 -0
  235. vrchatapi/models/ok_status.py +211 -0
  236. vrchatapi/models/ok_status2.py +234 -0
  237. vrchatapi/models/order_option.py +37 -0
  238. vrchatapi/models/order_option_short.py +37 -0
  239. vrchatapi/models/paginated_calendar_event_list.py +255 -0
  240. vrchatapi/models/paginated_group_audit_log_entry_list.py +255 -0
  241. vrchatapi/models/paginated_moderation_report_list.py +255 -0
  242. vrchatapi/models/past_display_name.py +241 -0
  243. vrchatapi/models/pending2_fa_result.py +239 -0
  244. vrchatapi/models/performance_limiter_info.py +234 -0
  245. vrchatapi/models/performance_ratings.py +41 -0
  246. vrchatapi/models/permission.py +280 -0
  247. vrchatapi/models/permission_data.py +258 -0
  248. vrchatapi/models/platform_build_info.py +242 -0
  249. vrchatapi/models/player_moderation.py +276 -0
  250. vrchatapi/models/player_moderation_type.py +44 -0
  251. vrchatapi/models/print_files.py +239 -0
  252. vrchatapi/models/private_profile.py +267 -0
  253. vrchatapi/models/private_profile_activity.py +292 -0
  254. vrchatapi/models/product.py +389 -0
  255. vrchatapi/models/product_listing.py +538 -0
  256. vrchatapi/models/product_listing_type.py +39 -0
  257. vrchatapi/models/product_listing_variant.py +272 -0
  258. vrchatapi/models/product_purchase.py +571 -0
  259. vrchatapi/models/product_purchase_history.py +256 -0
  260. vrchatapi/models/product_purchase_location_type.py +46 -0
  261. vrchatapi/models/product_purchase_product.py +269 -0
  262. vrchatapi/models/product_purchase_purchase_context.py +250 -0
  263. vrchatapi/models/product_purchase_record.py +312 -0
  264. vrchatapi/models/product_type.py +39 -0
  265. vrchatapi/models/profile_represented_group.py +262 -0
  266. vrchatapi/models/prop.py +358 -0
  267. vrchatapi/models/prop_publish_status.py +234 -0
  268. vrchatapi/models/prop_unity_package.py +269 -0
  269. vrchatapi/models/public_profile.py +398 -0
  270. vrchatapi/models/purchase_context_data.py +251 -0
  271. vrchatapi/models/purchase_product_listing_request.py +281 -0
  272. vrchatapi/models/region.py +42 -0
  273. vrchatapi/models/register_user_account_request.py +278 -0
  274. vrchatapi/models/release_status.py +39 -0
  275. vrchatapi/models/report_category.py +226 -0
  276. vrchatapi/models/report_reason.py +216 -0
  277. vrchatapi/models/represented_group.py +348 -0
  278. vrchatapi/models/request_invite_request.py +235 -0
  279. vrchatapi/models/respond_group_join_request.py +217 -0
  280. vrchatapi/models/respond_notification_v2_request.py +242 -0
  281. vrchatapi/models/response.py +217 -0
  282. vrchatapi/models/reward_badge.py +308 -0
  283. vrchatapi/models/reward_redemption.py +220 -0
  284. vrchatapi/models/reward_redemption_data.py +224 -0
  285. vrchatapi/models/reward_redemption_request.py +211 -0
  286. vrchatapi/models/reward_redemption_result.py +250 -0
  287. vrchatapi/models/search_group_members200_response.py +224 -0
  288. vrchatapi/models/seller_eligibility.py +211 -0
  289. vrchatapi/models/sent_notification.py +278 -0
  290. vrchatapi/models/service_queue_stats.py +234 -0
  291. vrchatapi/models/service_status.py +281 -0
  292. vrchatapi/models/share_inventory_item_direct_request.py +239 -0
  293. vrchatapi/models/sort_option.py +53 -0
  294. vrchatapi/models/sort_option_product_purchase.py +36 -0
  295. vrchatapi/models/store.py +372 -0
  296. vrchatapi/models/store_context.py +249 -0
  297. vrchatapi/models/store_shelf.py +304 -0
  298. vrchatapi/models/store_type.py +38 -0
  299. vrchatapi/models/store_view.py +40 -0
  300. vrchatapi/models/submit_moderation_report_request.py +263 -0
  301. vrchatapi/models/submit_moderation_report_request_details.py +283 -0
  302. vrchatapi/models/subscription.py +301 -0
  303. vrchatapi/models/subscription_period.py +40 -0
  304. vrchatapi/models/success.py +215 -0
  305. vrchatapi/models/success_flag.py +211 -0
  306. vrchatapi/models/tilia_kyc.py +246 -0
  307. vrchatapi/models/tilia_status.py +259 -0
  308. vrchatapi/models/tilia_tos.py +211 -0
  309. vrchatapi/models/token_bundle.py +286 -0
  310. vrchatapi/models/transaction.py +322 -0
  311. vrchatapi/models/transaction_agreement.py +353 -0
  312. vrchatapi/models/transaction_status.py +39 -0
  313. vrchatapi/models/transaction_steam_info.py +271 -0
  314. vrchatapi/models/transaction_steam_wallet_info.py +227 -0
  315. vrchatapi/models/transfer_group_request.py +234 -0
  316. vrchatapi/models/tutorial_status.py +255 -0
  317. vrchatapi/models/two_factor_auth_code.py +211 -0
  318. vrchatapi/models/two_factor_email_code.py +211 -0
  319. vrchatapi/models/two_factor_recovery_codes.py +247 -0
  320. vrchatapi/models/two_factor_recovery_codes_otp_inner.py +216 -0
  321. vrchatapi/models/unity_package.py +360 -0
  322. vrchatapi/models/update_asset_review_notes_request.py +234 -0
  323. vrchatapi/models/update_avatar_request.py +293 -0
  324. vrchatapi/models/update_calendar_event_request.py +365 -0
  325. vrchatapi/models/update_favorite_group_request.py +246 -0
  326. vrchatapi/models/update_group_gallery_request.py +297 -0
  327. vrchatapi/models/update_group_member_request.py +256 -0
  328. vrchatapi/models/update_group_representation_request.py +234 -0
  329. vrchatapi/models/update_group_request.py +300 -0
  330. vrchatapi/models/update_group_role_request.py +255 -0
  331. vrchatapi/models/update_inventory_item_request.py +254 -0
  332. vrchatapi/models/update_invite_message_request.py +211 -0
  333. vrchatapi/models/update_listing_request.py +211 -0
  334. vrchatapi/models/update_product_request.py +261 -0
  335. vrchatapi/models/update_prop_request.py +303 -0
  336. vrchatapi/models/update_tilia_tos_request.py +211 -0
  337. vrchatapi/models/update_user_badge_request.py +216 -0
  338. vrchatapi/models/update_user_note_request.py +239 -0
  339. vrchatapi/models/update_user_request.py +358 -0
  340. vrchatapi/models/update_world_request.py +317 -0
  341. vrchatapi/models/user.py +549 -0
  342. vrchatapi/models/user_credits_eligible.py +216 -0
  343. vrchatapi/models/user_exists.py +242 -0
  344. vrchatapi/models/user_note.py +273 -0
  345. vrchatapi/models/user_note_target_user.py +277 -0
  346. vrchatapi/models/user_state.py +38 -0
  347. vrchatapi/models/user_status.py +40 -0
  348. vrchatapi/models/user_subscription.py +330 -0
  349. vrchatapi/models/user_subscription_eligible.py +274 -0
  350. vrchatapi/models/verify2_fa_email_code_result.py +211 -0
  351. vrchatapi/models/verify2_fa_result.py +216 -0
  352. vrchatapi/models/verify_auth_token_result.py +217 -0
  353. vrchatapi/models/world.py +459 -0
  354. vrchatapi/models/world_metadata.py +216 -0
  355. vrchatapi/models/world_publish_status.py +234 -0
  356. vrchatapi/py.typed +0 -0
  357. vrchatapi/rest.py +303 -0
  358. vrchatapi_async-1.20.8.dev1.dist-info/METADATA +137 -0
  359. vrchatapi_async-1.20.8.dev1.dist-info/RECORD +362 -0
  360. vrchatapi_async-1.20.8.dev1.dist-info/WHEEL +5 -0
  361. vrchatapi_async-1.20.8.dev1.dist-info/licenses/LICENSE +21 -0
  362. vrchatapi_async-1.20.8.dev1.dist-info/top_level.txt +1 -0
@@ -0,0 +1,2384 @@
1
+ """
2
+ VRChat API Documentation
3
+
4
+
5
+ The version of the OpenAPI document: 1.20.8
6
+ Contact: vrchatapi.lpv0t@aries.fyi
7
+ Generated by OpenAPI Generator (https://openapi-generator.tech)
8
+
9
+ Do not edit the class manually.
10
+ """ # noqa: E501
11
+
12
+
13
+ import warnings
14
+ from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
15
+ from typing import Any, Dict, List, Optional, Tuple, Union
16
+ from typing_extensions import Annotated
17
+
18
+ from datetime import datetime
19
+ from pydantic import Field, StrictStr, field_validator
20
+ from typing import List, Optional
21
+ from typing_extensions import Annotated
22
+ from vrchatapi.models.api_config import APIConfig
23
+ from vrchatapi.models.api_health import APIHealth
24
+ from vrchatapi.models.info_push import InfoPush
25
+ from vrchatapi.models.permission import Permission
26
+
27
+ from vrchatapi.api_client import ApiClient, RequestSerialized
28
+ from vrchatapi.api_response import ApiResponse
29
+ from vrchatapi.rest import RESTResponseType
30
+
31
+
32
+ class MiscellaneousApi:
33
+ """NOTE: This class is auto generated by OpenAPI Generator
34
+ Ref: https://openapi-generator.tech
35
+
36
+ Do not edit the class manually.
37
+ """
38
+
39
+ def __init__(self, api_client=None) -> None:
40
+ if api_client is None:
41
+ api_client = ApiClient.get_default()
42
+ self.api_client = api_client
43
+
44
+
45
+ @validate_call
46
+ async def get_assigned_permissions(
47
+ self,
48
+ _request_timeout: Union[
49
+ None,
50
+ Annotated[StrictFloat, Field(gt=0)],
51
+ Tuple[
52
+ Annotated[StrictFloat, Field(gt=0)],
53
+ Annotated[StrictFloat, Field(gt=0)]
54
+ ]
55
+ ] = None,
56
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
57
+ _content_type: Optional[StrictStr] = None,
58
+ _headers: Optional[Dict[StrictStr, Any]] = None,
59
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
60
+ ) -> List[Permission]:
61
+ """Get Assigned Permissions
62
+
63
+ Returns a list of all permissions currently granted by the user. Permissions are assigned e.g. by subscribing to VRC+.
64
+
65
+ :param _request_timeout: timeout setting for this request. If one
66
+ number provided, it will be total request
67
+ timeout. It can also be a pair (tuple) of
68
+ (connection, read) timeouts.
69
+ :type _request_timeout: int, tuple(int, int), optional
70
+ :param _request_auth: set to override the auth_settings for an a single
71
+ request; this effectively ignores the
72
+ authentication in the spec for a single request.
73
+ :type _request_auth: dict, optional
74
+ :param _content_type: force content-type for the request.
75
+ :type _content_type: str, Optional
76
+ :param _headers: set to override the headers for a single
77
+ request; this effectively ignores the headers
78
+ in the spec for a single request.
79
+ :type _headers: dict, optional
80
+ :param _host_index: set to override the host_index for a single
81
+ request; this effectively ignores the host_index
82
+ in the spec for a single request.
83
+ :type _host_index: int, optional
84
+ :return: Returns the result object.
85
+ """ # noqa: E501
86
+
87
+ _param = self._get_assigned_permissions_serialize(
88
+ _request_auth=_request_auth,
89
+ _content_type=_content_type,
90
+ _headers=_headers,
91
+ _host_index=_host_index
92
+ )
93
+
94
+ _response_types_map: Dict[str, Optional[str]] = {
95
+ '200': "List[Permission]",
96
+ '401': "Error",
97
+ }
98
+ response_data = await self.api_client.call_api(
99
+ *_param,
100
+ _request_timeout=_request_timeout
101
+ )
102
+ await response_data.read()
103
+ return self.api_client.response_deserialize(
104
+ response_data=response_data,
105
+ response_types_map=_response_types_map,
106
+ ).data
107
+
108
+
109
+ @validate_call
110
+ async def get_assigned_permissions_with_http_info(
111
+ self,
112
+ _request_timeout: Union[
113
+ None,
114
+ Annotated[StrictFloat, Field(gt=0)],
115
+ Tuple[
116
+ Annotated[StrictFloat, Field(gt=0)],
117
+ Annotated[StrictFloat, Field(gt=0)]
118
+ ]
119
+ ] = None,
120
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
121
+ _content_type: Optional[StrictStr] = None,
122
+ _headers: Optional[Dict[StrictStr, Any]] = None,
123
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
124
+ ) -> ApiResponse[List[Permission]]:
125
+ """Get Assigned Permissions
126
+
127
+ Returns a list of all permissions currently granted by the user. Permissions are assigned e.g. by subscribing to VRC+.
128
+
129
+ :param _request_timeout: timeout setting for this request. If one
130
+ number provided, it will be total request
131
+ timeout. It can also be a pair (tuple) of
132
+ (connection, read) timeouts.
133
+ :type _request_timeout: int, tuple(int, int), optional
134
+ :param _request_auth: set to override the auth_settings for an a single
135
+ request; this effectively ignores the
136
+ authentication in the spec for a single request.
137
+ :type _request_auth: dict, optional
138
+ :param _content_type: force content-type for the request.
139
+ :type _content_type: str, Optional
140
+ :param _headers: set to override the headers for a single
141
+ request; this effectively ignores the headers
142
+ in the spec for a single request.
143
+ :type _headers: dict, optional
144
+ :param _host_index: set to override the host_index for a single
145
+ request; this effectively ignores the host_index
146
+ in the spec for a single request.
147
+ :type _host_index: int, optional
148
+ :return: Returns the result object.
149
+ """ # noqa: E501
150
+
151
+ _param = self._get_assigned_permissions_serialize(
152
+ _request_auth=_request_auth,
153
+ _content_type=_content_type,
154
+ _headers=_headers,
155
+ _host_index=_host_index
156
+ )
157
+
158
+ _response_types_map: Dict[str, Optional[str]] = {
159
+ '200': "List[Permission]",
160
+ '401': "Error",
161
+ }
162
+ response_data = await self.api_client.call_api(
163
+ *_param,
164
+ _request_timeout=_request_timeout
165
+ )
166
+ await response_data.read()
167
+ return self.api_client.response_deserialize(
168
+ response_data=response_data,
169
+ response_types_map=_response_types_map,
170
+ )
171
+
172
+
173
+ @validate_call
174
+ async def get_assigned_permissions_without_preload_content(
175
+ self,
176
+ _request_timeout: Union[
177
+ None,
178
+ Annotated[StrictFloat, Field(gt=0)],
179
+ Tuple[
180
+ Annotated[StrictFloat, Field(gt=0)],
181
+ Annotated[StrictFloat, Field(gt=0)]
182
+ ]
183
+ ] = None,
184
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
185
+ _content_type: Optional[StrictStr] = None,
186
+ _headers: Optional[Dict[StrictStr, Any]] = None,
187
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
188
+ ) -> RESTResponseType:
189
+ """Get Assigned Permissions
190
+
191
+ Returns a list of all permissions currently granted by the user. Permissions are assigned e.g. by subscribing to VRC+.
192
+
193
+ :param _request_timeout: timeout setting for this request. If one
194
+ number provided, it will be total request
195
+ timeout. It can also be a pair (tuple) of
196
+ (connection, read) timeouts.
197
+ :type _request_timeout: int, tuple(int, int), optional
198
+ :param _request_auth: set to override the auth_settings for an a single
199
+ request; this effectively ignores the
200
+ authentication in the spec for a single request.
201
+ :type _request_auth: dict, optional
202
+ :param _content_type: force content-type for the request.
203
+ :type _content_type: str, Optional
204
+ :param _headers: set to override the headers for a single
205
+ request; this effectively ignores the headers
206
+ in the spec for a single request.
207
+ :type _headers: dict, optional
208
+ :param _host_index: set to override the host_index for a single
209
+ request; this effectively ignores the host_index
210
+ in the spec for a single request.
211
+ :type _host_index: int, optional
212
+ :return: Returns the result object.
213
+ """ # noqa: E501
214
+
215
+ _param = self._get_assigned_permissions_serialize(
216
+ _request_auth=_request_auth,
217
+ _content_type=_content_type,
218
+ _headers=_headers,
219
+ _host_index=_host_index
220
+ )
221
+
222
+ _response_types_map: Dict[str, Optional[str]] = {
223
+ '200': "List[Permission]",
224
+ '401': "Error",
225
+ }
226
+ response_data = await self.api_client.call_api(
227
+ *_param,
228
+ _request_timeout=_request_timeout
229
+ )
230
+ return response_data.response
231
+
232
+
233
+ def _get_assigned_permissions_serialize(
234
+ self,
235
+ _request_auth,
236
+ _content_type,
237
+ _headers,
238
+ _host_index,
239
+ ) -> RequestSerialized:
240
+
241
+ _host = None
242
+
243
+ _collection_formats: Dict[str, str] = {
244
+ }
245
+
246
+ _path_params: Dict[str, str] = {}
247
+ _query_params: List[Tuple[str, str]] = []
248
+ _header_params: Dict[str, Optional[str]] = _headers or {}
249
+ _form_params: List[Tuple[str, str]] = []
250
+ _files: Dict[
251
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
252
+ ] = {}
253
+ _body_params: Optional[bytes] = None
254
+
255
+ # process the path parameters
256
+ # process the query parameters
257
+ # process the header parameters
258
+ # process the form parameters
259
+ # process the body parameter
260
+
261
+
262
+ # set the HTTP header `Accept`
263
+ if 'Accept' not in _header_params:
264
+ _header_params['Accept'] = self.api_client.select_header_accept(
265
+ [
266
+ 'application/json'
267
+ ]
268
+ )
269
+
270
+
271
+ # authentication setting
272
+ _auth_settings: List[str] = [
273
+ 'authCookie'
274
+ ]
275
+
276
+ return self.api_client.param_serialize(
277
+ method='GET',
278
+ resource_path='/auth/permissions',
279
+ path_params=_path_params,
280
+ query_params=_query_params,
281
+ header_params=_header_params,
282
+ body=_body_params,
283
+ post_params=_form_params,
284
+ files=_files,
285
+ auth_settings=_auth_settings,
286
+ collection_formats=_collection_formats,
287
+ _host=_host,
288
+ _request_auth=_request_auth
289
+ )
290
+
291
+
292
+
293
+
294
+ @validate_call
295
+ async def get_config(
296
+ self,
297
+ _request_timeout: Union[
298
+ None,
299
+ Annotated[StrictFloat, Field(gt=0)],
300
+ Tuple[
301
+ Annotated[StrictFloat, Field(gt=0)],
302
+ Annotated[StrictFloat, Field(gt=0)]
303
+ ]
304
+ ] = None,
305
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
306
+ _content_type: Optional[StrictStr] = None,
307
+ _headers: Optional[Dict[StrictStr, Any]] = None,
308
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
309
+ ) -> APIConfig:
310
+ """Fetch API Config
311
+
312
+ API config contains configuration that the clients needs to work properly. Currently the most important value here is `clientApiKey` which is used for all other API endpoints.
313
+
314
+ :param _request_timeout: timeout setting for this request. If one
315
+ number provided, it will be total request
316
+ timeout. It can also be a pair (tuple) of
317
+ (connection, read) timeouts.
318
+ :type _request_timeout: int, tuple(int, int), optional
319
+ :param _request_auth: set to override the auth_settings for an a single
320
+ request; this effectively ignores the
321
+ authentication in the spec for a single request.
322
+ :type _request_auth: dict, optional
323
+ :param _content_type: force content-type for the request.
324
+ :type _content_type: str, Optional
325
+ :param _headers: set to override the headers for a single
326
+ request; this effectively ignores the headers
327
+ in the spec for a single request.
328
+ :type _headers: dict, optional
329
+ :param _host_index: set to override the host_index for a single
330
+ request; this effectively ignores the host_index
331
+ in the spec for a single request.
332
+ :type _host_index: int, optional
333
+ :return: Returns the result object.
334
+ """ # noqa: E501
335
+
336
+ _param = self._get_config_serialize(
337
+ _request_auth=_request_auth,
338
+ _content_type=_content_type,
339
+ _headers=_headers,
340
+ _host_index=_host_index
341
+ )
342
+
343
+ _response_types_map: Dict[str, Optional[str]] = {
344
+ '200': "APIConfig",
345
+ }
346
+ response_data = await self.api_client.call_api(
347
+ *_param,
348
+ _request_timeout=_request_timeout
349
+ )
350
+ await response_data.read()
351
+ return self.api_client.response_deserialize(
352
+ response_data=response_data,
353
+ response_types_map=_response_types_map,
354
+ ).data
355
+
356
+
357
+ @validate_call
358
+ async def get_config_with_http_info(
359
+ self,
360
+ _request_timeout: Union[
361
+ None,
362
+ Annotated[StrictFloat, Field(gt=0)],
363
+ Tuple[
364
+ Annotated[StrictFloat, Field(gt=0)],
365
+ Annotated[StrictFloat, Field(gt=0)]
366
+ ]
367
+ ] = None,
368
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
369
+ _content_type: Optional[StrictStr] = None,
370
+ _headers: Optional[Dict[StrictStr, Any]] = None,
371
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
372
+ ) -> ApiResponse[APIConfig]:
373
+ """Fetch API Config
374
+
375
+ API config contains configuration that the clients needs to work properly. Currently the most important value here is `clientApiKey` which is used for all other API endpoints.
376
+
377
+ :param _request_timeout: timeout setting for this request. If one
378
+ number provided, it will be total request
379
+ timeout. It can also be a pair (tuple) of
380
+ (connection, read) timeouts.
381
+ :type _request_timeout: int, tuple(int, int), optional
382
+ :param _request_auth: set to override the auth_settings for an a single
383
+ request; this effectively ignores the
384
+ authentication in the spec for a single request.
385
+ :type _request_auth: dict, optional
386
+ :param _content_type: force content-type for the request.
387
+ :type _content_type: str, Optional
388
+ :param _headers: set to override the headers for a single
389
+ request; this effectively ignores the headers
390
+ in the spec for a single request.
391
+ :type _headers: dict, optional
392
+ :param _host_index: set to override the host_index for a single
393
+ request; this effectively ignores the host_index
394
+ in the spec for a single request.
395
+ :type _host_index: int, optional
396
+ :return: Returns the result object.
397
+ """ # noqa: E501
398
+
399
+ _param = self._get_config_serialize(
400
+ _request_auth=_request_auth,
401
+ _content_type=_content_type,
402
+ _headers=_headers,
403
+ _host_index=_host_index
404
+ )
405
+
406
+ _response_types_map: Dict[str, Optional[str]] = {
407
+ '200': "APIConfig",
408
+ }
409
+ response_data = await self.api_client.call_api(
410
+ *_param,
411
+ _request_timeout=_request_timeout
412
+ )
413
+ await response_data.read()
414
+ return self.api_client.response_deserialize(
415
+ response_data=response_data,
416
+ response_types_map=_response_types_map,
417
+ )
418
+
419
+
420
+ @validate_call
421
+ async def get_config_without_preload_content(
422
+ self,
423
+ _request_timeout: Union[
424
+ None,
425
+ Annotated[StrictFloat, Field(gt=0)],
426
+ Tuple[
427
+ Annotated[StrictFloat, Field(gt=0)],
428
+ Annotated[StrictFloat, Field(gt=0)]
429
+ ]
430
+ ] = None,
431
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
432
+ _content_type: Optional[StrictStr] = None,
433
+ _headers: Optional[Dict[StrictStr, Any]] = None,
434
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
435
+ ) -> RESTResponseType:
436
+ """Fetch API Config
437
+
438
+ API config contains configuration that the clients needs to work properly. Currently the most important value here is `clientApiKey` which is used for all other API endpoints.
439
+
440
+ :param _request_timeout: timeout setting for this request. If one
441
+ number provided, it will be total request
442
+ timeout. It can also be a pair (tuple) of
443
+ (connection, read) timeouts.
444
+ :type _request_timeout: int, tuple(int, int), optional
445
+ :param _request_auth: set to override the auth_settings for an a single
446
+ request; this effectively ignores the
447
+ authentication in the spec for a single request.
448
+ :type _request_auth: dict, optional
449
+ :param _content_type: force content-type for the request.
450
+ :type _content_type: str, Optional
451
+ :param _headers: set to override the headers for a single
452
+ request; this effectively ignores the headers
453
+ in the spec for a single request.
454
+ :type _headers: dict, optional
455
+ :param _host_index: set to override the host_index for a single
456
+ request; this effectively ignores the host_index
457
+ in the spec for a single request.
458
+ :type _host_index: int, optional
459
+ :return: Returns the result object.
460
+ """ # noqa: E501
461
+
462
+ _param = self._get_config_serialize(
463
+ _request_auth=_request_auth,
464
+ _content_type=_content_type,
465
+ _headers=_headers,
466
+ _host_index=_host_index
467
+ )
468
+
469
+ _response_types_map: Dict[str, Optional[str]] = {
470
+ '200': "APIConfig",
471
+ }
472
+ response_data = await self.api_client.call_api(
473
+ *_param,
474
+ _request_timeout=_request_timeout
475
+ )
476
+ return response_data.response
477
+
478
+
479
+ def _get_config_serialize(
480
+ self,
481
+ _request_auth,
482
+ _content_type,
483
+ _headers,
484
+ _host_index,
485
+ ) -> RequestSerialized:
486
+
487
+ _host = None
488
+
489
+ _collection_formats: Dict[str, str] = {
490
+ }
491
+
492
+ _path_params: Dict[str, str] = {}
493
+ _query_params: List[Tuple[str, str]] = []
494
+ _header_params: Dict[str, Optional[str]] = _headers or {}
495
+ _form_params: List[Tuple[str, str]] = []
496
+ _files: Dict[
497
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
498
+ ] = {}
499
+ _body_params: Optional[bytes] = None
500
+
501
+ # process the path parameters
502
+ # process the query parameters
503
+ # process the header parameters
504
+ # process the form parameters
505
+ # process the body parameter
506
+
507
+
508
+ # set the HTTP header `Accept`
509
+ if 'Accept' not in _header_params:
510
+ _header_params['Accept'] = self.api_client.select_header_accept(
511
+ [
512
+ 'application/json'
513
+ ]
514
+ )
515
+
516
+
517
+ # authentication setting
518
+ _auth_settings: List[str] = [
519
+ ]
520
+
521
+ return self.api_client.param_serialize(
522
+ method='GET',
523
+ resource_path='/config',
524
+ path_params=_path_params,
525
+ query_params=_query_params,
526
+ header_params=_header_params,
527
+ body=_body_params,
528
+ post_params=_form_params,
529
+ files=_files,
530
+ auth_settings=_auth_settings,
531
+ collection_formats=_collection_formats,
532
+ _host=_host,
533
+ _request_auth=_request_auth
534
+ )
535
+
536
+
537
+
538
+
539
+ @validate_call
540
+ async def get_css(
541
+ self,
542
+ variant: Annotated[Optional[StrictStr], Field(description="Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.")] = None,
543
+ branch: Annotated[Optional[StrictStr], Field(description="Specifies which git branch the site should load frontend source code from.")] = None,
544
+ _request_timeout: Union[
545
+ None,
546
+ Annotated[StrictFloat, Field(gt=0)],
547
+ Tuple[
548
+ Annotated[StrictFloat, Field(gt=0)],
549
+ Annotated[StrictFloat, Field(gt=0)]
550
+ ]
551
+ ] = None,
552
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
553
+ _content_type: Optional[StrictStr] = None,
554
+ _headers: Optional[Dict[StrictStr, Any]] = None,
555
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
556
+ ) -> str:
557
+ """Download CSS
558
+
559
+ Fetches the CSS code to the frontend React website.
560
+
561
+ :param variant: Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
562
+ :type variant: str
563
+ :param branch: Specifies which git branch the site should load frontend source code from.
564
+ :type branch: str
565
+ :param _request_timeout: timeout setting for this request. If one
566
+ number provided, it will be total request
567
+ timeout. It can also be a pair (tuple) of
568
+ (connection, read) timeouts.
569
+ :type _request_timeout: int, tuple(int, int), optional
570
+ :param _request_auth: set to override the auth_settings for an a single
571
+ request; this effectively ignores the
572
+ authentication in the spec for a single request.
573
+ :type _request_auth: dict, optional
574
+ :param _content_type: force content-type for the request.
575
+ :type _content_type: str, Optional
576
+ :param _headers: set to override the headers for a single
577
+ request; this effectively ignores the headers
578
+ in the spec for a single request.
579
+ :type _headers: dict, optional
580
+ :param _host_index: set to override the host_index for a single
581
+ request; this effectively ignores the host_index
582
+ in the spec for a single request.
583
+ :type _host_index: int, optional
584
+ :return: Returns the result object.
585
+ """ # noqa: E501
586
+
587
+ _param = self._get_css_serialize(
588
+ variant=variant,
589
+ branch=branch,
590
+ _request_auth=_request_auth,
591
+ _content_type=_content_type,
592
+ _headers=_headers,
593
+ _host_index=_host_index
594
+ )
595
+
596
+ _response_types_map: Dict[str, Optional[str]] = {
597
+ '200': "str",
598
+ '400': "Error",
599
+ }
600
+ response_data = await self.api_client.call_api(
601
+ *_param,
602
+ _request_timeout=_request_timeout
603
+ )
604
+ await response_data.read()
605
+ return self.api_client.response_deserialize(
606
+ response_data=response_data,
607
+ response_types_map=_response_types_map,
608
+ ).data
609
+
610
+
611
+ @validate_call
612
+ async def get_css_with_http_info(
613
+ self,
614
+ variant: Annotated[Optional[StrictStr], Field(description="Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.")] = None,
615
+ branch: Annotated[Optional[StrictStr], Field(description="Specifies which git branch the site should load frontend source code from.")] = None,
616
+ _request_timeout: Union[
617
+ None,
618
+ Annotated[StrictFloat, Field(gt=0)],
619
+ Tuple[
620
+ Annotated[StrictFloat, Field(gt=0)],
621
+ Annotated[StrictFloat, Field(gt=0)]
622
+ ]
623
+ ] = None,
624
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
625
+ _content_type: Optional[StrictStr] = None,
626
+ _headers: Optional[Dict[StrictStr, Any]] = None,
627
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
628
+ ) -> ApiResponse[str]:
629
+ """Download CSS
630
+
631
+ Fetches the CSS code to the frontend React website.
632
+
633
+ :param variant: Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
634
+ :type variant: str
635
+ :param branch: Specifies which git branch the site should load frontend source code from.
636
+ :type branch: str
637
+ :param _request_timeout: timeout setting for this request. If one
638
+ number provided, it will be total request
639
+ timeout. It can also be a pair (tuple) of
640
+ (connection, read) timeouts.
641
+ :type _request_timeout: int, tuple(int, int), optional
642
+ :param _request_auth: set to override the auth_settings for an a single
643
+ request; this effectively ignores the
644
+ authentication in the spec for a single request.
645
+ :type _request_auth: dict, optional
646
+ :param _content_type: force content-type for the request.
647
+ :type _content_type: str, Optional
648
+ :param _headers: set to override the headers for a single
649
+ request; this effectively ignores the headers
650
+ in the spec for a single request.
651
+ :type _headers: dict, optional
652
+ :param _host_index: set to override the host_index for a single
653
+ request; this effectively ignores the host_index
654
+ in the spec for a single request.
655
+ :type _host_index: int, optional
656
+ :return: Returns the result object.
657
+ """ # noqa: E501
658
+
659
+ _param = self._get_css_serialize(
660
+ variant=variant,
661
+ branch=branch,
662
+ _request_auth=_request_auth,
663
+ _content_type=_content_type,
664
+ _headers=_headers,
665
+ _host_index=_host_index
666
+ )
667
+
668
+ _response_types_map: Dict[str, Optional[str]] = {
669
+ '200': "str",
670
+ '400': "Error",
671
+ }
672
+ response_data = await self.api_client.call_api(
673
+ *_param,
674
+ _request_timeout=_request_timeout
675
+ )
676
+ await response_data.read()
677
+ return self.api_client.response_deserialize(
678
+ response_data=response_data,
679
+ response_types_map=_response_types_map,
680
+ )
681
+
682
+
683
+ @validate_call
684
+ async def get_css_without_preload_content(
685
+ self,
686
+ variant: Annotated[Optional[StrictStr], Field(description="Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.")] = None,
687
+ branch: Annotated[Optional[StrictStr], Field(description="Specifies which git branch the site should load frontend source code from.")] = None,
688
+ _request_timeout: Union[
689
+ None,
690
+ Annotated[StrictFloat, Field(gt=0)],
691
+ Tuple[
692
+ Annotated[StrictFloat, Field(gt=0)],
693
+ Annotated[StrictFloat, Field(gt=0)]
694
+ ]
695
+ ] = None,
696
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
697
+ _content_type: Optional[StrictStr] = None,
698
+ _headers: Optional[Dict[StrictStr, Any]] = None,
699
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
700
+ ) -> RESTResponseType:
701
+ """Download CSS
702
+
703
+ Fetches the CSS code to the frontend React website.
704
+
705
+ :param variant: Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
706
+ :type variant: str
707
+ :param branch: Specifies which git branch the site should load frontend source code from.
708
+ :type branch: str
709
+ :param _request_timeout: timeout setting for this request. If one
710
+ number provided, it will be total request
711
+ timeout. It can also be a pair (tuple) of
712
+ (connection, read) timeouts.
713
+ :type _request_timeout: int, tuple(int, int), optional
714
+ :param _request_auth: set to override the auth_settings for an a single
715
+ request; this effectively ignores the
716
+ authentication in the spec for a single request.
717
+ :type _request_auth: dict, optional
718
+ :param _content_type: force content-type for the request.
719
+ :type _content_type: str, Optional
720
+ :param _headers: set to override the headers for a single
721
+ request; this effectively ignores the headers
722
+ in the spec for a single request.
723
+ :type _headers: dict, optional
724
+ :param _host_index: set to override the host_index for a single
725
+ request; this effectively ignores the host_index
726
+ in the spec for a single request.
727
+ :type _host_index: int, optional
728
+ :return: Returns the result object.
729
+ """ # noqa: E501
730
+
731
+ _param = self._get_css_serialize(
732
+ variant=variant,
733
+ branch=branch,
734
+ _request_auth=_request_auth,
735
+ _content_type=_content_type,
736
+ _headers=_headers,
737
+ _host_index=_host_index
738
+ )
739
+
740
+ _response_types_map: Dict[str, Optional[str]] = {
741
+ '200': "str",
742
+ '400': "Error",
743
+ }
744
+ response_data = await self.api_client.call_api(
745
+ *_param,
746
+ _request_timeout=_request_timeout
747
+ )
748
+ return response_data.response
749
+
750
+
751
+ def _get_css_serialize(
752
+ self,
753
+ variant,
754
+ branch,
755
+ _request_auth,
756
+ _content_type,
757
+ _headers,
758
+ _host_index,
759
+ ) -> RequestSerialized:
760
+
761
+ _host = None
762
+
763
+ _collection_formats: Dict[str, str] = {
764
+ }
765
+
766
+ _path_params: Dict[str, str] = {}
767
+ _query_params: List[Tuple[str, str]] = []
768
+ _header_params: Dict[str, Optional[str]] = _headers or {}
769
+ _form_params: List[Tuple[str, str]] = []
770
+ _files: Dict[
771
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
772
+ ] = {}
773
+ _body_params: Optional[bytes] = None
774
+
775
+ # process the path parameters
776
+ # process the query parameters
777
+ if variant is not None:
778
+
779
+ _query_params.append(('variant', variant))
780
+
781
+ if branch is not None:
782
+
783
+ _query_params.append(('branch', branch))
784
+
785
+ # process the header parameters
786
+ # process the form parameters
787
+ # process the body parameter
788
+
789
+
790
+ # set the HTTP header `Accept`
791
+ if 'Accept' not in _header_params:
792
+ _header_params['Accept'] = self.api_client.select_header_accept(
793
+ [
794
+ 'text/css',
795
+ 'application/json'
796
+ ]
797
+ )
798
+
799
+
800
+ # authentication setting
801
+ _auth_settings: List[str] = [
802
+ ]
803
+
804
+ return self.api_client.param_serialize(
805
+ method='GET',
806
+ resource_path='/css/app.css',
807
+ path_params=_path_params,
808
+ query_params=_query_params,
809
+ header_params=_header_params,
810
+ body=_body_params,
811
+ post_params=_form_params,
812
+ files=_files,
813
+ auth_settings=_auth_settings,
814
+ collection_formats=_collection_formats,
815
+ _host=_host,
816
+ _request_auth=_request_auth
817
+ )
818
+
819
+
820
+
821
+
822
+ @validate_call
823
+ async def get_current_online_users(
824
+ self,
825
+ _request_timeout: Union[
826
+ None,
827
+ Annotated[StrictFloat, Field(gt=0)],
828
+ Tuple[
829
+ Annotated[StrictFloat, Field(gt=0)],
830
+ Annotated[StrictFloat, Field(gt=0)]
831
+ ]
832
+ ] = None,
833
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
834
+ _content_type: Optional[StrictStr] = None,
835
+ _headers: Optional[Dict[StrictStr, Any]] = None,
836
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
837
+ ) -> int:
838
+ """Current Online Users
839
+
840
+ Returns the current number of online users. **NOTE:** The response type is not a JSON object, but a simple JSON integer.
841
+
842
+ :param _request_timeout: timeout setting for this request. If one
843
+ number provided, it will be total request
844
+ timeout. It can also be a pair (tuple) of
845
+ (connection, read) timeouts.
846
+ :type _request_timeout: int, tuple(int, int), optional
847
+ :param _request_auth: set to override the auth_settings for an a single
848
+ request; this effectively ignores the
849
+ authentication in the spec for a single request.
850
+ :type _request_auth: dict, optional
851
+ :param _content_type: force content-type for the request.
852
+ :type _content_type: str, Optional
853
+ :param _headers: set to override the headers for a single
854
+ request; this effectively ignores the headers
855
+ in the spec for a single request.
856
+ :type _headers: dict, optional
857
+ :param _host_index: set to override the host_index for a single
858
+ request; this effectively ignores the host_index
859
+ in the spec for a single request.
860
+ :type _host_index: int, optional
861
+ :return: Returns the result object.
862
+ """ # noqa: E501
863
+
864
+ _param = self._get_current_online_users_serialize(
865
+ _request_auth=_request_auth,
866
+ _content_type=_content_type,
867
+ _headers=_headers,
868
+ _host_index=_host_index
869
+ )
870
+
871
+ _response_types_map: Dict[str, Optional[str]] = {
872
+ '200': "int",
873
+ }
874
+ response_data = await self.api_client.call_api(
875
+ *_param,
876
+ _request_timeout=_request_timeout
877
+ )
878
+ await response_data.read()
879
+ return self.api_client.response_deserialize(
880
+ response_data=response_data,
881
+ response_types_map=_response_types_map,
882
+ ).data
883
+
884
+
885
+ @validate_call
886
+ async def get_current_online_users_with_http_info(
887
+ self,
888
+ _request_timeout: Union[
889
+ None,
890
+ Annotated[StrictFloat, Field(gt=0)],
891
+ Tuple[
892
+ Annotated[StrictFloat, Field(gt=0)],
893
+ Annotated[StrictFloat, Field(gt=0)]
894
+ ]
895
+ ] = None,
896
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
897
+ _content_type: Optional[StrictStr] = None,
898
+ _headers: Optional[Dict[StrictStr, Any]] = None,
899
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
900
+ ) -> ApiResponse[int]:
901
+ """Current Online Users
902
+
903
+ Returns the current number of online users. **NOTE:** The response type is not a JSON object, but a simple JSON integer.
904
+
905
+ :param _request_timeout: timeout setting for this request. If one
906
+ number provided, it will be total request
907
+ timeout. It can also be a pair (tuple) of
908
+ (connection, read) timeouts.
909
+ :type _request_timeout: int, tuple(int, int), optional
910
+ :param _request_auth: set to override the auth_settings for an a single
911
+ request; this effectively ignores the
912
+ authentication in the spec for a single request.
913
+ :type _request_auth: dict, optional
914
+ :param _content_type: force content-type for the request.
915
+ :type _content_type: str, Optional
916
+ :param _headers: set to override the headers for a single
917
+ request; this effectively ignores the headers
918
+ in the spec for a single request.
919
+ :type _headers: dict, optional
920
+ :param _host_index: set to override the host_index for a single
921
+ request; this effectively ignores the host_index
922
+ in the spec for a single request.
923
+ :type _host_index: int, optional
924
+ :return: Returns the result object.
925
+ """ # noqa: E501
926
+
927
+ _param = self._get_current_online_users_serialize(
928
+ _request_auth=_request_auth,
929
+ _content_type=_content_type,
930
+ _headers=_headers,
931
+ _host_index=_host_index
932
+ )
933
+
934
+ _response_types_map: Dict[str, Optional[str]] = {
935
+ '200': "int",
936
+ }
937
+ response_data = await self.api_client.call_api(
938
+ *_param,
939
+ _request_timeout=_request_timeout
940
+ )
941
+ await response_data.read()
942
+ return self.api_client.response_deserialize(
943
+ response_data=response_data,
944
+ response_types_map=_response_types_map,
945
+ )
946
+
947
+
948
+ @validate_call
949
+ async def get_current_online_users_without_preload_content(
950
+ self,
951
+ _request_timeout: Union[
952
+ None,
953
+ Annotated[StrictFloat, Field(gt=0)],
954
+ Tuple[
955
+ Annotated[StrictFloat, Field(gt=0)],
956
+ Annotated[StrictFloat, Field(gt=0)]
957
+ ]
958
+ ] = None,
959
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
960
+ _content_type: Optional[StrictStr] = None,
961
+ _headers: Optional[Dict[StrictStr, Any]] = None,
962
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
963
+ ) -> RESTResponseType:
964
+ """Current Online Users
965
+
966
+ Returns the current number of online users. **NOTE:** The response type is not a JSON object, but a simple JSON integer.
967
+
968
+ :param _request_timeout: timeout setting for this request. If one
969
+ number provided, it will be total request
970
+ timeout. It can also be a pair (tuple) of
971
+ (connection, read) timeouts.
972
+ :type _request_timeout: int, tuple(int, int), optional
973
+ :param _request_auth: set to override the auth_settings for an a single
974
+ request; this effectively ignores the
975
+ authentication in the spec for a single request.
976
+ :type _request_auth: dict, optional
977
+ :param _content_type: force content-type for the request.
978
+ :type _content_type: str, Optional
979
+ :param _headers: set to override the headers for a single
980
+ request; this effectively ignores the headers
981
+ in the spec for a single request.
982
+ :type _headers: dict, optional
983
+ :param _host_index: set to override the host_index for a single
984
+ request; this effectively ignores the host_index
985
+ in the spec for a single request.
986
+ :type _host_index: int, optional
987
+ :return: Returns the result object.
988
+ """ # noqa: E501
989
+
990
+ _param = self._get_current_online_users_serialize(
991
+ _request_auth=_request_auth,
992
+ _content_type=_content_type,
993
+ _headers=_headers,
994
+ _host_index=_host_index
995
+ )
996
+
997
+ _response_types_map: Dict[str, Optional[str]] = {
998
+ '200': "int",
999
+ }
1000
+ response_data = await self.api_client.call_api(
1001
+ *_param,
1002
+ _request_timeout=_request_timeout
1003
+ )
1004
+ return response_data.response
1005
+
1006
+
1007
+ def _get_current_online_users_serialize(
1008
+ self,
1009
+ _request_auth,
1010
+ _content_type,
1011
+ _headers,
1012
+ _host_index,
1013
+ ) -> RequestSerialized:
1014
+
1015
+ _host = None
1016
+
1017
+ _collection_formats: Dict[str, str] = {
1018
+ }
1019
+
1020
+ _path_params: Dict[str, str] = {}
1021
+ _query_params: List[Tuple[str, str]] = []
1022
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1023
+ _form_params: List[Tuple[str, str]] = []
1024
+ _files: Dict[
1025
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1026
+ ] = {}
1027
+ _body_params: Optional[bytes] = None
1028
+
1029
+ # process the path parameters
1030
+ # process the query parameters
1031
+ # process the header parameters
1032
+ # process the form parameters
1033
+ # process the body parameter
1034
+
1035
+
1036
+ # set the HTTP header `Accept`
1037
+ if 'Accept' not in _header_params:
1038
+ _header_params['Accept'] = self.api_client.select_header_accept(
1039
+ [
1040
+ 'application/json'
1041
+ ]
1042
+ )
1043
+
1044
+
1045
+ # authentication setting
1046
+ _auth_settings: List[str] = [
1047
+ ]
1048
+
1049
+ return self.api_client.param_serialize(
1050
+ method='GET',
1051
+ resource_path='/visits',
1052
+ path_params=_path_params,
1053
+ query_params=_query_params,
1054
+ header_params=_header_params,
1055
+ body=_body_params,
1056
+ post_params=_form_params,
1057
+ files=_files,
1058
+ auth_settings=_auth_settings,
1059
+ collection_formats=_collection_formats,
1060
+ _host=_host,
1061
+ _request_auth=_request_auth
1062
+ )
1063
+
1064
+
1065
+
1066
+
1067
+ @validate_call
1068
+ async def get_health(
1069
+ self,
1070
+ _request_timeout: Union[
1071
+ None,
1072
+ Annotated[StrictFloat, Field(gt=0)],
1073
+ Tuple[
1074
+ Annotated[StrictFloat, Field(gt=0)],
1075
+ Annotated[StrictFloat, Field(gt=0)]
1076
+ ]
1077
+ ] = None,
1078
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1079
+ _content_type: Optional[StrictStr] = None,
1080
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1081
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1082
+ ) -> APIHealth:
1083
+ """(Deprecated) Check API Health
1084
+
1085
+ ~~Gets the overall health status, the server name, and the current build version tag of the API.~~ **DEPRECATED:** VRChat has suddenly restricted this endpoint for unknown reasons, and now always return 401 Unauthorized.
1086
+
1087
+ :param _request_timeout: timeout setting for this request. If one
1088
+ number provided, it will be total request
1089
+ timeout. It can also be a pair (tuple) of
1090
+ (connection, read) timeouts.
1091
+ :type _request_timeout: int, tuple(int, int), optional
1092
+ :param _request_auth: set to override the auth_settings for an a single
1093
+ request; this effectively ignores the
1094
+ authentication in the spec for a single request.
1095
+ :type _request_auth: dict, optional
1096
+ :param _content_type: force content-type for the request.
1097
+ :type _content_type: str, Optional
1098
+ :param _headers: set to override the headers for a single
1099
+ request; this effectively ignores the headers
1100
+ in the spec for a single request.
1101
+ :type _headers: dict, optional
1102
+ :param _host_index: set to override the host_index for a single
1103
+ request; this effectively ignores the host_index
1104
+ in the spec for a single request.
1105
+ :type _host_index: int, optional
1106
+ :return: Returns the result object.
1107
+ """ # noqa: E501
1108
+ warnings.warn("GET /health is deprecated.", DeprecationWarning)
1109
+
1110
+ _param = self._get_health_serialize(
1111
+ _request_auth=_request_auth,
1112
+ _content_type=_content_type,
1113
+ _headers=_headers,
1114
+ _host_index=_host_index
1115
+ )
1116
+
1117
+ _response_types_map: Dict[str, Optional[str]] = {
1118
+ '200': "APIHealth",
1119
+ }
1120
+ response_data = await self.api_client.call_api(
1121
+ *_param,
1122
+ _request_timeout=_request_timeout
1123
+ )
1124
+ await response_data.read()
1125
+ return self.api_client.response_deserialize(
1126
+ response_data=response_data,
1127
+ response_types_map=_response_types_map,
1128
+ ).data
1129
+
1130
+
1131
+ @validate_call
1132
+ async def get_health_with_http_info(
1133
+ self,
1134
+ _request_timeout: Union[
1135
+ None,
1136
+ Annotated[StrictFloat, Field(gt=0)],
1137
+ Tuple[
1138
+ Annotated[StrictFloat, Field(gt=0)],
1139
+ Annotated[StrictFloat, Field(gt=0)]
1140
+ ]
1141
+ ] = None,
1142
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1143
+ _content_type: Optional[StrictStr] = None,
1144
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1145
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1146
+ ) -> ApiResponse[APIHealth]:
1147
+ """(Deprecated) Check API Health
1148
+
1149
+ ~~Gets the overall health status, the server name, and the current build version tag of the API.~~ **DEPRECATED:** VRChat has suddenly restricted this endpoint for unknown reasons, and now always return 401 Unauthorized.
1150
+
1151
+ :param _request_timeout: timeout setting for this request. If one
1152
+ number provided, it will be total request
1153
+ timeout. It can also be a pair (tuple) of
1154
+ (connection, read) timeouts.
1155
+ :type _request_timeout: int, tuple(int, int), optional
1156
+ :param _request_auth: set to override the auth_settings for an a single
1157
+ request; this effectively ignores the
1158
+ authentication in the spec for a single request.
1159
+ :type _request_auth: dict, optional
1160
+ :param _content_type: force content-type for the request.
1161
+ :type _content_type: str, Optional
1162
+ :param _headers: set to override the headers for a single
1163
+ request; this effectively ignores the headers
1164
+ in the spec for a single request.
1165
+ :type _headers: dict, optional
1166
+ :param _host_index: set to override the host_index for a single
1167
+ request; this effectively ignores the host_index
1168
+ in the spec for a single request.
1169
+ :type _host_index: int, optional
1170
+ :return: Returns the result object.
1171
+ """ # noqa: E501
1172
+ warnings.warn("GET /health is deprecated.", DeprecationWarning)
1173
+
1174
+ _param = self._get_health_serialize(
1175
+ _request_auth=_request_auth,
1176
+ _content_type=_content_type,
1177
+ _headers=_headers,
1178
+ _host_index=_host_index
1179
+ )
1180
+
1181
+ _response_types_map: Dict[str, Optional[str]] = {
1182
+ '200': "APIHealth",
1183
+ }
1184
+ response_data = await self.api_client.call_api(
1185
+ *_param,
1186
+ _request_timeout=_request_timeout
1187
+ )
1188
+ await response_data.read()
1189
+ return self.api_client.response_deserialize(
1190
+ response_data=response_data,
1191
+ response_types_map=_response_types_map,
1192
+ )
1193
+
1194
+
1195
+ @validate_call
1196
+ async def get_health_without_preload_content(
1197
+ self,
1198
+ _request_timeout: Union[
1199
+ None,
1200
+ Annotated[StrictFloat, Field(gt=0)],
1201
+ Tuple[
1202
+ Annotated[StrictFloat, Field(gt=0)],
1203
+ Annotated[StrictFloat, Field(gt=0)]
1204
+ ]
1205
+ ] = None,
1206
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1207
+ _content_type: Optional[StrictStr] = None,
1208
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1209
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1210
+ ) -> RESTResponseType:
1211
+ """(Deprecated) Check API Health
1212
+
1213
+ ~~Gets the overall health status, the server name, and the current build version tag of the API.~~ **DEPRECATED:** VRChat has suddenly restricted this endpoint for unknown reasons, and now always return 401 Unauthorized.
1214
+
1215
+ :param _request_timeout: timeout setting for this request. If one
1216
+ number provided, it will be total request
1217
+ timeout. It can also be a pair (tuple) of
1218
+ (connection, read) timeouts.
1219
+ :type _request_timeout: int, tuple(int, int), optional
1220
+ :param _request_auth: set to override the auth_settings for an a single
1221
+ request; this effectively ignores the
1222
+ authentication in the spec for a single request.
1223
+ :type _request_auth: dict, optional
1224
+ :param _content_type: force content-type for the request.
1225
+ :type _content_type: str, Optional
1226
+ :param _headers: set to override the headers for a single
1227
+ request; this effectively ignores the headers
1228
+ in the spec for a single request.
1229
+ :type _headers: dict, optional
1230
+ :param _host_index: set to override the host_index for a single
1231
+ request; this effectively ignores the host_index
1232
+ in the spec for a single request.
1233
+ :type _host_index: int, optional
1234
+ :return: Returns the result object.
1235
+ """ # noqa: E501
1236
+ warnings.warn("GET /health is deprecated.", DeprecationWarning)
1237
+
1238
+ _param = self._get_health_serialize(
1239
+ _request_auth=_request_auth,
1240
+ _content_type=_content_type,
1241
+ _headers=_headers,
1242
+ _host_index=_host_index
1243
+ )
1244
+
1245
+ _response_types_map: Dict[str, Optional[str]] = {
1246
+ '200': "APIHealth",
1247
+ }
1248
+ response_data = await self.api_client.call_api(
1249
+ *_param,
1250
+ _request_timeout=_request_timeout
1251
+ )
1252
+ return response_data.response
1253
+
1254
+
1255
+ def _get_health_serialize(
1256
+ self,
1257
+ _request_auth,
1258
+ _content_type,
1259
+ _headers,
1260
+ _host_index,
1261
+ ) -> RequestSerialized:
1262
+
1263
+ _host = None
1264
+
1265
+ _collection_formats: Dict[str, str] = {
1266
+ }
1267
+
1268
+ _path_params: Dict[str, str] = {}
1269
+ _query_params: List[Tuple[str, str]] = []
1270
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1271
+ _form_params: List[Tuple[str, str]] = []
1272
+ _files: Dict[
1273
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1274
+ ] = {}
1275
+ _body_params: Optional[bytes] = None
1276
+
1277
+ # process the path parameters
1278
+ # process the query parameters
1279
+ # process the header parameters
1280
+ # process the form parameters
1281
+ # process the body parameter
1282
+
1283
+
1284
+ # set the HTTP header `Accept`
1285
+ if 'Accept' not in _header_params:
1286
+ _header_params['Accept'] = self.api_client.select_header_accept(
1287
+ [
1288
+ 'application/json'
1289
+ ]
1290
+ )
1291
+
1292
+
1293
+ # authentication setting
1294
+ _auth_settings: List[str] = [
1295
+ ]
1296
+
1297
+ return self.api_client.param_serialize(
1298
+ method='GET',
1299
+ resource_path='/health',
1300
+ path_params=_path_params,
1301
+ query_params=_query_params,
1302
+ header_params=_header_params,
1303
+ body=_body_params,
1304
+ post_params=_form_params,
1305
+ files=_files,
1306
+ auth_settings=_auth_settings,
1307
+ collection_formats=_collection_formats,
1308
+ _host=_host,
1309
+ _request_auth=_request_auth
1310
+ )
1311
+
1312
+
1313
+
1314
+
1315
+ @validate_call
1316
+ async def get_info_push(
1317
+ self,
1318
+ require: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Tags to include (comma-separated). All of the tags needs to be present.")] = None,
1319
+ include: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Tags to include (comma-separated). Any of the tags needs to be present.")] = None,
1320
+ _request_timeout: Union[
1321
+ None,
1322
+ Annotated[StrictFloat, Field(gt=0)],
1323
+ Tuple[
1324
+ Annotated[StrictFloat, Field(gt=0)],
1325
+ Annotated[StrictFloat, Field(gt=0)]
1326
+ ]
1327
+ ] = None,
1328
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1329
+ _content_type: Optional[StrictStr] = None,
1330
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1331
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1332
+ ) -> List[InfoPush]:
1333
+ """Show Information Notices
1334
+
1335
+ IPS (Info Push System) is a system for VRChat to push out dynamic information to the client. This is primarily used by the Quick-Menu info banners, but can also be used to e.g. alert you to update your game to the latest version. `include` is used to query what Information Pushes should be included in the response. If include is missing or empty, then no notices will normally be returned. This is an \"any of\" search. `require` is used to limit what Information Pushes should be included in the response. This is usually used in combination with `include`, and is an \"all of\" search.
1336
+
1337
+ :param require: Tags to include (comma-separated). All of the tags needs to be present.
1338
+ :type require: str
1339
+ :param include: Tags to include (comma-separated). Any of the tags needs to be present.
1340
+ :type include: str
1341
+ :param _request_timeout: timeout setting for this request. If one
1342
+ number provided, it will be total request
1343
+ timeout. It can also be a pair (tuple) of
1344
+ (connection, read) timeouts.
1345
+ :type _request_timeout: int, tuple(int, int), optional
1346
+ :param _request_auth: set to override the auth_settings for an a single
1347
+ request; this effectively ignores the
1348
+ authentication in the spec for a single request.
1349
+ :type _request_auth: dict, optional
1350
+ :param _content_type: force content-type for the request.
1351
+ :type _content_type: str, Optional
1352
+ :param _headers: set to override the headers for a single
1353
+ request; this effectively ignores the headers
1354
+ in the spec for a single request.
1355
+ :type _headers: dict, optional
1356
+ :param _host_index: set to override the host_index for a single
1357
+ request; this effectively ignores the host_index
1358
+ in the spec for a single request.
1359
+ :type _host_index: int, optional
1360
+ :return: Returns the result object.
1361
+ """ # noqa: E501
1362
+
1363
+ _param = self._get_info_push_serialize(
1364
+ require=require,
1365
+ include=include,
1366
+ _request_auth=_request_auth,
1367
+ _content_type=_content_type,
1368
+ _headers=_headers,
1369
+ _host_index=_host_index
1370
+ )
1371
+
1372
+ _response_types_map: Dict[str, Optional[str]] = {
1373
+ '200': "List[InfoPush]",
1374
+ }
1375
+ response_data = await self.api_client.call_api(
1376
+ *_param,
1377
+ _request_timeout=_request_timeout
1378
+ )
1379
+ await response_data.read()
1380
+ return self.api_client.response_deserialize(
1381
+ response_data=response_data,
1382
+ response_types_map=_response_types_map,
1383
+ ).data
1384
+
1385
+
1386
+ @validate_call
1387
+ async def get_info_push_with_http_info(
1388
+ self,
1389
+ require: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Tags to include (comma-separated). All of the tags needs to be present.")] = None,
1390
+ include: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Tags to include (comma-separated). Any of the tags needs to be present.")] = None,
1391
+ _request_timeout: Union[
1392
+ None,
1393
+ Annotated[StrictFloat, Field(gt=0)],
1394
+ Tuple[
1395
+ Annotated[StrictFloat, Field(gt=0)],
1396
+ Annotated[StrictFloat, Field(gt=0)]
1397
+ ]
1398
+ ] = None,
1399
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1400
+ _content_type: Optional[StrictStr] = None,
1401
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1402
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1403
+ ) -> ApiResponse[List[InfoPush]]:
1404
+ """Show Information Notices
1405
+
1406
+ IPS (Info Push System) is a system for VRChat to push out dynamic information to the client. This is primarily used by the Quick-Menu info banners, but can also be used to e.g. alert you to update your game to the latest version. `include` is used to query what Information Pushes should be included in the response. If include is missing or empty, then no notices will normally be returned. This is an \"any of\" search. `require` is used to limit what Information Pushes should be included in the response. This is usually used in combination with `include`, and is an \"all of\" search.
1407
+
1408
+ :param require: Tags to include (comma-separated). All of the tags needs to be present.
1409
+ :type require: str
1410
+ :param include: Tags to include (comma-separated). Any of the tags needs to be present.
1411
+ :type include: str
1412
+ :param _request_timeout: timeout setting for this request. If one
1413
+ number provided, it will be total request
1414
+ timeout. It can also be a pair (tuple) of
1415
+ (connection, read) timeouts.
1416
+ :type _request_timeout: int, tuple(int, int), optional
1417
+ :param _request_auth: set to override the auth_settings for an a single
1418
+ request; this effectively ignores the
1419
+ authentication in the spec for a single request.
1420
+ :type _request_auth: dict, optional
1421
+ :param _content_type: force content-type for the request.
1422
+ :type _content_type: str, Optional
1423
+ :param _headers: set to override the headers for a single
1424
+ request; this effectively ignores the headers
1425
+ in the spec for a single request.
1426
+ :type _headers: dict, optional
1427
+ :param _host_index: set to override the host_index for a single
1428
+ request; this effectively ignores the host_index
1429
+ in the spec for a single request.
1430
+ :type _host_index: int, optional
1431
+ :return: Returns the result object.
1432
+ """ # noqa: E501
1433
+
1434
+ _param = self._get_info_push_serialize(
1435
+ require=require,
1436
+ include=include,
1437
+ _request_auth=_request_auth,
1438
+ _content_type=_content_type,
1439
+ _headers=_headers,
1440
+ _host_index=_host_index
1441
+ )
1442
+
1443
+ _response_types_map: Dict[str, Optional[str]] = {
1444
+ '200': "List[InfoPush]",
1445
+ }
1446
+ response_data = await self.api_client.call_api(
1447
+ *_param,
1448
+ _request_timeout=_request_timeout
1449
+ )
1450
+ await response_data.read()
1451
+ return self.api_client.response_deserialize(
1452
+ response_data=response_data,
1453
+ response_types_map=_response_types_map,
1454
+ )
1455
+
1456
+
1457
+ @validate_call
1458
+ async def get_info_push_without_preload_content(
1459
+ self,
1460
+ require: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Tags to include (comma-separated). All of the tags needs to be present.")] = None,
1461
+ include: Annotated[Optional[Annotated[str, Field(min_length=1, strict=True)]], Field(description="Tags to include (comma-separated). Any of the tags needs to be present.")] = None,
1462
+ _request_timeout: Union[
1463
+ None,
1464
+ Annotated[StrictFloat, Field(gt=0)],
1465
+ Tuple[
1466
+ Annotated[StrictFloat, Field(gt=0)],
1467
+ Annotated[StrictFloat, Field(gt=0)]
1468
+ ]
1469
+ ] = None,
1470
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1471
+ _content_type: Optional[StrictStr] = None,
1472
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1473
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1474
+ ) -> RESTResponseType:
1475
+ """Show Information Notices
1476
+
1477
+ IPS (Info Push System) is a system for VRChat to push out dynamic information to the client. This is primarily used by the Quick-Menu info banners, but can also be used to e.g. alert you to update your game to the latest version. `include` is used to query what Information Pushes should be included in the response. If include is missing or empty, then no notices will normally be returned. This is an \"any of\" search. `require` is used to limit what Information Pushes should be included in the response. This is usually used in combination with `include`, and is an \"all of\" search.
1478
+
1479
+ :param require: Tags to include (comma-separated). All of the tags needs to be present.
1480
+ :type require: str
1481
+ :param include: Tags to include (comma-separated). Any of the tags needs to be present.
1482
+ :type include: str
1483
+ :param _request_timeout: timeout setting for this request. If one
1484
+ number provided, it will be total request
1485
+ timeout. It can also be a pair (tuple) of
1486
+ (connection, read) timeouts.
1487
+ :type _request_timeout: int, tuple(int, int), optional
1488
+ :param _request_auth: set to override the auth_settings for an a single
1489
+ request; this effectively ignores the
1490
+ authentication in the spec for a single request.
1491
+ :type _request_auth: dict, optional
1492
+ :param _content_type: force content-type for the request.
1493
+ :type _content_type: str, Optional
1494
+ :param _headers: set to override the headers for a single
1495
+ request; this effectively ignores the headers
1496
+ in the spec for a single request.
1497
+ :type _headers: dict, optional
1498
+ :param _host_index: set to override the host_index for a single
1499
+ request; this effectively ignores the host_index
1500
+ in the spec for a single request.
1501
+ :type _host_index: int, optional
1502
+ :return: Returns the result object.
1503
+ """ # noqa: E501
1504
+
1505
+ _param = self._get_info_push_serialize(
1506
+ require=require,
1507
+ include=include,
1508
+ _request_auth=_request_auth,
1509
+ _content_type=_content_type,
1510
+ _headers=_headers,
1511
+ _host_index=_host_index
1512
+ )
1513
+
1514
+ _response_types_map: Dict[str, Optional[str]] = {
1515
+ '200': "List[InfoPush]",
1516
+ }
1517
+ response_data = await self.api_client.call_api(
1518
+ *_param,
1519
+ _request_timeout=_request_timeout
1520
+ )
1521
+ return response_data.response
1522
+
1523
+
1524
+ def _get_info_push_serialize(
1525
+ self,
1526
+ require,
1527
+ include,
1528
+ _request_auth,
1529
+ _content_type,
1530
+ _headers,
1531
+ _host_index,
1532
+ ) -> RequestSerialized:
1533
+
1534
+ _host = None
1535
+
1536
+ _collection_formats: Dict[str, str] = {
1537
+ }
1538
+
1539
+ _path_params: Dict[str, str] = {}
1540
+ _query_params: List[Tuple[str, str]] = []
1541
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1542
+ _form_params: List[Tuple[str, str]] = []
1543
+ _files: Dict[
1544
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1545
+ ] = {}
1546
+ _body_params: Optional[bytes] = None
1547
+
1548
+ # process the path parameters
1549
+ # process the query parameters
1550
+ if require is not None:
1551
+
1552
+ _query_params.append(('require', require))
1553
+
1554
+ if include is not None:
1555
+
1556
+ _query_params.append(('include', include))
1557
+
1558
+ # process the header parameters
1559
+ # process the form parameters
1560
+ # process the body parameter
1561
+
1562
+
1563
+ # set the HTTP header `Accept`
1564
+ if 'Accept' not in _header_params:
1565
+ _header_params['Accept'] = self.api_client.select_header_accept(
1566
+ [
1567
+ 'application/json'
1568
+ ]
1569
+ )
1570
+
1571
+
1572
+ # authentication setting
1573
+ _auth_settings: List[str] = [
1574
+ 'authCookie'
1575
+ ]
1576
+
1577
+ return self.api_client.param_serialize(
1578
+ method='GET',
1579
+ resource_path='/infoPush',
1580
+ path_params=_path_params,
1581
+ query_params=_query_params,
1582
+ header_params=_header_params,
1583
+ body=_body_params,
1584
+ post_params=_form_params,
1585
+ files=_files,
1586
+ auth_settings=_auth_settings,
1587
+ collection_formats=_collection_formats,
1588
+ _host=_host,
1589
+ _request_auth=_request_auth
1590
+ )
1591
+
1592
+
1593
+
1594
+
1595
+ @validate_call
1596
+ async def get_java_script(
1597
+ self,
1598
+ variant: Annotated[Optional[StrictStr], Field(description="Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.")] = None,
1599
+ branch: Annotated[Optional[StrictStr], Field(description="Specifies which git branch the site should load frontend source code from.")] = None,
1600
+ _request_timeout: Union[
1601
+ None,
1602
+ Annotated[StrictFloat, Field(gt=0)],
1603
+ Tuple[
1604
+ Annotated[StrictFloat, Field(gt=0)],
1605
+ Annotated[StrictFloat, Field(gt=0)]
1606
+ ]
1607
+ ] = None,
1608
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1609
+ _content_type: Optional[StrictStr] = None,
1610
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1611
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1612
+ ) -> str:
1613
+ """Download JavaScript
1614
+
1615
+ Fetches the JavaScript code to the frontend React website.
1616
+
1617
+ :param variant: Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
1618
+ :type variant: str
1619
+ :param branch: Specifies which git branch the site should load frontend source code from.
1620
+ :type branch: str
1621
+ :param _request_timeout: timeout setting for this request. If one
1622
+ number provided, it will be total request
1623
+ timeout. It can also be a pair (tuple) of
1624
+ (connection, read) timeouts.
1625
+ :type _request_timeout: int, tuple(int, int), optional
1626
+ :param _request_auth: set to override the auth_settings for an a single
1627
+ request; this effectively ignores the
1628
+ authentication in the spec for a single request.
1629
+ :type _request_auth: dict, optional
1630
+ :param _content_type: force content-type for the request.
1631
+ :type _content_type: str, Optional
1632
+ :param _headers: set to override the headers for a single
1633
+ request; this effectively ignores the headers
1634
+ in the spec for a single request.
1635
+ :type _headers: dict, optional
1636
+ :param _host_index: set to override the host_index for a single
1637
+ request; this effectively ignores the host_index
1638
+ in the spec for a single request.
1639
+ :type _host_index: int, optional
1640
+ :return: Returns the result object.
1641
+ """ # noqa: E501
1642
+
1643
+ _param = self._get_java_script_serialize(
1644
+ variant=variant,
1645
+ branch=branch,
1646
+ _request_auth=_request_auth,
1647
+ _content_type=_content_type,
1648
+ _headers=_headers,
1649
+ _host_index=_host_index
1650
+ )
1651
+
1652
+ _response_types_map: Dict[str, Optional[str]] = {
1653
+ '200': "str",
1654
+ '400': "Error",
1655
+ }
1656
+ response_data = await self.api_client.call_api(
1657
+ *_param,
1658
+ _request_timeout=_request_timeout
1659
+ )
1660
+ await response_data.read()
1661
+ return self.api_client.response_deserialize(
1662
+ response_data=response_data,
1663
+ response_types_map=_response_types_map,
1664
+ ).data
1665
+
1666
+
1667
+ @validate_call
1668
+ async def get_java_script_with_http_info(
1669
+ self,
1670
+ variant: Annotated[Optional[StrictStr], Field(description="Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.")] = None,
1671
+ branch: Annotated[Optional[StrictStr], Field(description="Specifies which git branch the site should load frontend source code from.")] = None,
1672
+ _request_timeout: Union[
1673
+ None,
1674
+ Annotated[StrictFloat, Field(gt=0)],
1675
+ Tuple[
1676
+ Annotated[StrictFloat, Field(gt=0)],
1677
+ Annotated[StrictFloat, Field(gt=0)]
1678
+ ]
1679
+ ] = None,
1680
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1681
+ _content_type: Optional[StrictStr] = None,
1682
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1683
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1684
+ ) -> ApiResponse[str]:
1685
+ """Download JavaScript
1686
+
1687
+ Fetches the JavaScript code to the frontend React website.
1688
+
1689
+ :param variant: Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
1690
+ :type variant: str
1691
+ :param branch: Specifies which git branch the site should load frontend source code from.
1692
+ :type branch: str
1693
+ :param _request_timeout: timeout setting for this request. If one
1694
+ number provided, it will be total request
1695
+ timeout. It can also be a pair (tuple) of
1696
+ (connection, read) timeouts.
1697
+ :type _request_timeout: int, tuple(int, int), optional
1698
+ :param _request_auth: set to override the auth_settings for an a single
1699
+ request; this effectively ignores the
1700
+ authentication in the spec for a single request.
1701
+ :type _request_auth: dict, optional
1702
+ :param _content_type: force content-type for the request.
1703
+ :type _content_type: str, Optional
1704
+ :param _headers: set to override the headers for a single
1705
+ request; this effectively ignores the headers
1706
+ in the spec for a single request.
1707
+ :type _headers: dict, optional
1708
+ :param _host_index: set to override the host_index for a single
1709
+ request; this effectively ignores the host_index
1710
+ in the spec for a single request.
1711
+ :type _host_index: int, optional
1712
+ :return: Returns the result object.
1713
+ """ # noqa: E501
1714
+
1715
+ _param = self._get_java_script_serialize(
1716
+ variant=variant,
1717
+ branch=branch,
1718
+ _request_auth=_request_auth,
1719
+ _content_type=_content_type,
1720
+ _headers=_headers,
1721
+ _host_index=_host_index
1722
+ )
1723
+
1724
+ _response_types_map: Dict[str, Optional[str]] = {
1725
+ '200': "str",
1726
+ '400': "Error",
1727
+ }
1728
+ response_data = await self.api_client.call_api(
1729
+ *_param,
1730
+ _request_timeout=_request_timeout
1731
+ )
1732
+ await response_data.read()
1733
+ return self.api_client.response_deserialize(
1734
+ response_data=response_data,
1735
+ response_types_map=_response_types_map,
1736
+ )
1737
+
1738
+
1739
+ @validate_call
1740
+ async def get_java_script_without_preload_content(
1741
+ self,
1742
+ variant: Annotated[Optional[StrictStr], Field(description="Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.")] = None,
1743
+ branch: Annotated[Optional[StrictStr], Field(description="Specifies which git branch the site should load frontend source code from.")] = None,
1744
+ _request_timeout: Union[
1745
+ None,
1746
+ Annotated[StrictFloat, Field(gt=0)],
1747
+ Tuple[
1748
+ Annotated[StrictFloat, Field(gt=0)],
1749
+ Annotated[StrictFloat, Field(gt=0)]
1750
+ ]
1751
+ ] = None,
1752
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1753
+ _content_type: Optional[StrictStr] = None,
1754
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1755
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1756
+ ) -> RESTResponseType:
1757
+ """Download JavaScript
1758
+
1759
+ Fetches the JavaScript code to the frontend React website.
1760
+
1761
+ :param variant: Specifies which `variant` of the site. Public is the end-user site, while `internal` is the staff-only site with special pages for moderation and management.
1762
+ :type variant: str
1763
+ :param branch: Specifies which git branch the site should load frontend source code from.
1764
+ :type branch: str
1765
+ :param _request_timeout: timeout setting for this request. If one
1766
+ number provided, it will be total request
1767
+ timeout. It can also be a pair (tuple) of
1768
+ (connection, read) timeouts.
1769
+ :type _request_timeout: int, tuple(int, int), optional
1770
+ :param _request_auth: set to override the auth_settings for an a single
1771
+ request; this effectively ignores the
1772
+ authentication in the spec for a single request.
1773
+ :type _request_auth: dict, optional
1774
+ :param _content_type: force content-type for the request.
1775
+ :type _content_type: str, Optional
1776
+ :param _headers: set to override the headers for a single
1777
+ request; this effectively ignores the headers
1778
+ in the spec for a single request.
1779
+ :type _headers: dict, optional
1780
+ :param _host_index: set to override the host_index for a single
1781
+ request; this effectively ignores the host_index
1782
+ in the spec for a single request.
1783
+ :type _host_index: int, optional
1784
+ :return: Returns the result object.
1785
+ """ # noqa: E501
1786
+
1787
+ _param = self._get_java_script_serialize(
1788
+ variant=variant,
1789
+ branch=branch,
1790
+ _request_auth=_request_auth,
1791
+ _content_type=_content_type,
1792
+ _headers=_headers,
1793
+ _host_index=_host_index
1794
+ )
1795
+
1796
+ _response_types_map: Dict[str, Optional[str]] = {
1797
+ '200': "str",
1798
+ '400': "Error",
1799
+ }
1800
+ response_data = await self.api_client.call_api(
1801
+ *_param,
1802
+ _request_timeout=_request_timeout
1803
+ )
1804
+ return response_data.response
1805
+
1806
+
1807
+ def _get_java_script_serialize(
1808
+ self,
1809
+ variant,
1810
+ branch,
1811
+ _request_auth,
1812
+ _content_type,
1813
+ _headers,
1814
+ _host_index,
1815
+ ) -> RequestSerialized:
1816
+
1817
+ _host = None
1818
+
1819
+ _collection_formats: Dict[str, str] = {
1820
+ }
1821
+
1822
+ _path_params: Dict[str, str] = {}
1823
+ _query_params: List[Tuple[str, str]] = []
1824
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1825
+ _form_params: List[Tuple[str, str]] = []
1826
+ _files: Dict[
1827
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1828
+ ] = {}
1829
+ _body_params: Optional[bytes] = None
1830
+
1831
+ # process the path parameters
1832
+ # process the query parameters
1833
+ if variant is not None:
1834
+
1835
+ _query_params.append(('variant', variant))
1836
+
1837
+ if branch is not None:
1838
+
1839
+ _query_params.append(('branch', branch))
1840
+
1841
+ # process the header parameters
1842
+ # process the form parameters
1843
+ # process the body parameter
1844
+
1845
+
1846
+ # set the HTTP header `Accept`
1847
+ if 'Accept' not in _header_params:
1848
+ _header_params['Accept'] = self.api_client.select_header_accept(
1849
+ [
1850
+ 'application/javascript',
1851
+ 'application/json'
1852
+ ]
1853
+ )
1854
+
1855
+
1856
+ # authentication setting
1857
+ _auth_settings: List[str] = [
1858
+ ]
1859
+
1860
+ return self.api_client.param_serialize(
1861
+ method='GET',
1862
+ resource_path='/js/app.js',
1863
+ path_params=_path_params,
1864
+ query_params=_query_params,
1865
+ header_params=_header_params,
1866
+ body=_body_params,
1867
+ post_params=_form_params,
1868
+ files=_files,
1869
+ auth_settings=_auth_settings,
1870
+ collection_formats=_collection_formats,
1871
+ _host=_host,
1872
+ _request_auth=_request_auth
1873
+ )
1874
+
1875
+
1876
+
1877
+
1878
+ @validate_call
1879
+ async def get_permission(
1880
+ self,
1881
+ permission_id: Annotated[StrictStr, Field(description="Must be a valid permission ID.")],
1882
+ _request_timeout: Union[
1883
+ None,
1884
+ Annotated[StrictFloat, Field(gt=0)],
1885
+ Tuple[
1886
+ Annotated[StrictFloat, Field(gt=0)],
1887
+ Annotated[StrictFloat, Field(gt=0)]
1888
+ ]
1889
+ ] = None,
1890
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1891
+ _content_type: Optional[StrictStr] = None,
1892
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1893
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1894
+ ) -> Permission:
1895
+ """Get Permission
1896
+
1897
+ Returns a single permission. This endpoint is pretty useless, as it returns the exact same information as `/auth/permissions`.
1898
+
1899
+ :param permission_id: Must be a valid permission ID. (required)
1900
+ :type permission_id: str
1901
+ :param _request_timeout: timeout setting for this request. If one
1902
+ number provided, it will be total request
1903
+ timeout. It can also be a pair (tuple) of
1904
+ (connection, read) timeouts.
1905
+ :type _request_timeout: int, tuple(int, int), optional
1906
+ :param _request_auth: set to override the auth_settings for an a single
1907
+ request; this effectively ignores the
1908
+ authentication in the spec for a single request.
1909
+ :type _request_auth: dict, optional
1910
+ :param _content_type: force content-type for the request.
1911
+ :type _content_type: str, Optional
1912
+ :param _headers: set to override the headers for a single
1913
+ request; this effectively ignores the headers
1914
+ in the spec for a single request.
1915
+ :type _headers: dict, optional
1916
+ :param _host_index: set to override the host_index for a single
1917
+ request; this effectively ignores the host_index
1918
+ in the spec for a single request.
1919
+ :type _host_index: int, optional
1920
+ :return: Returns the result object.
1921
+ """ # noqa: E501
1922
+
1923
+ _param = self._get_permission_serialize(
1924
+ permission_id=permission_id,
1925
+ _request_auth=_request_auth,
1926
+ _content_type=_content_type,
1927
+ _headers=_headers,
1928
+ _host_index=_host_index
1929
+ )
1930
+
1931
+ _response_types_map: Dict[str, Optional[str]] = {
1932
+ '200': "Permission",
1933
+ '401': "Error",
1934
+ }
1935
+ response_data = await self.api_client.call_api(
1936
+ *_param,
1937
+ _request_timeout=_request_timeout
1938
+ )
1939
+ await response_data.read()
1940
+ return self.api_client.response_deserialize(
1941
+ response_data=response_data,
1942
+ response_types_map=_response_types_map,
1943
+ ).data
1944
+
1945
+
1946
+ @validate_call
1947
+ async def get_permission_with_http_info(
1948
+ self,
1949
+ permission_id: Annotated[StrictStr, Field(description="Must be a valid permission ID.")],
1950
+ _request_timeout: Union[
1951
+ None,
1952
+ Annotated[StrictFloat, Field(gt=0)],
1953
+ Tuple[
1954
+ Annotated[StrictFloat, Field(gt=0)],
1955
+ Annotated[StrictFloat, Field(gt=0)]
1956
+ ]
1957
+ ] = None,
1958
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1959
+ _content_type: Optional[StrictStr] = None,
1960
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1961
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1962
+ ) -> ApiResponse[Permission]:
1963
+ """Get Permission
1964
+
1965
+ Returns a single permission. This endpoint is pretty useless, as it returns the exact same information as `/auth/permissions`.
1966
+
1967
+ :param permission_id: Must be a valid permission ID. (required)
1968
+ :type permission_id: str
1969
+ :param _request_timeout: timeout setting for this request. If one
1970
+ number provided, it will be total request
1971
+ timeout. It can also be a pair (tuple) of
1972
+ (connection, read) timeouts.
1973
+ :type _request_timeout: int, tuple(int, int), optional
1974
+ :param _request_auth: set to override the auth_settings for an a single
1975
+ request; this effectively ignores the
1976
+ authentication in the spec for a single request.
1977
+ :type _request_auth: dict, optional
1978
+ :param _content_type: force content-type for the request.
1979
+ :type _content_type: str, Optional
1980
+ :param _headers: set to override the headers for a single
1981
+ request; this effectively ignores the headers
1982
+ in the spec for a single request.
1983
+ :type _headers: dict, optional
1984
+ :param _host_index: set to override the host_index for a single
1985
+ request; this effectively ignores the host_index
1986
+ in the spec for a single request.
1987
+ :type _host_index: int, optional
1988
+ :return: Returns the result object.
1989
+ """ # noqa: E501
1990
+
1991
+ _param = self._get_permission_serialize(
1992
+ permission_id=permission_id,
1993
+ _request_auth=_request_auth,
1994
+ _content_type=_content_type,
1995
+ _headers=_headers,
1996
+ _host_index=_host_index
1997
+ )
1998
+
1999
+ _response_types_map: Dict[str, Optional[str]] = {
2000
+ '200': "Permission",
2001
+ '401': "Error",
2002
+ }
2003
+ response_data = await self.api_client.call_api(
2004
+ *_param,
2005
+ _request_timeout=_request_timeout
2006
+ )
2007
+ await response_data.read()
2008
+ return self.api_client.response_deserialize(
2009
+ response_data=response_data,
2010
+ response_types_map=_response_types_map,
2011
+ )
2012
+
2013
+
2014
+ @validate_call
2015
+ async def get_permission_without_preload_content(
2016
+ self,
2017
+ permission_id: Annotated[StrictStr, Field(description="Must be a valid permission ID.")],
2018
+ _request_timeout: Union[
2019
+ None,
2020
+ Annotated[StrictFloat, Field(gt=0)],
2021
+ Tuple[
2022
+ Annotated[StrictFloat, Field(gt=0)],
2023
+ Annotated[StrictFloat, Field(gt=0)]
2024
+ ]
2025
+ ] = None,
2026
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2027
+ _content_type: Optional[StrictStr] = None,
2028
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2029
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2030
+ ) -> RESTResponseType:
2031
+ """Get Permission
2032
+
2033
+ Returns a single permission. This endpoint is pretty useless, as it returns the exact same information as `/auth/permissions`.
2034
+
2035
+ :param permission_id: Must be a valid permission ID. (required)
2036
+ :type permission_id: str
2037
+ :param _request_timeout: timeout setting for this request. If one
2038
+ number provided, it will be total request
2039
+ timeout. It can also be a pair (tuple) of
2040
+ (connection, read) timeouts.
2041
+ :type _request_timeout: int, tuple(int, int), optional
2042
+ :param _request_auth: set to override the auth_settings for an a single
2043
+ request; this effectively ignores the
2044
+ authentication in the spec for a single request.
2045
+ :type _request_auth: dict, optional
2046
+ :param _content_type: force content-type for the request.
2047
+ :type _content_type: str, Optional
2048
+ :param _headers: set to override the headers for a single
2049
+ request; this effectively ignores the headers
2050
+ in the spec for a single request.
2051
+ :type _headers: dict, optional
2052
+ :param _host_index: set to override the host_index for a single
2053
+ request; this effectively ignores the host_index
2054
+ in the spec for a single request.
2055
+ :type _host_index: int, optional
2056
+ :return: Returns the result object.
2057
+ """ # noqa: E501
2058
+
2059
+ _param = self._get_permission_serialize(
2060
+ permission_id=permission_id,
2061
+ _request_auth=_request_auth,
2062
+ _content_type=_content_type,
2063
+ _headers=_headers,
2064
+ _host_index=_host_index
2065
+ )
2066
+
2067
+ _response_types_map: Dict[str, Optional[str]] = {
2068
+ '200': "Permission",
2069
+ '401': "Error",
2070
+ }
2071
+ response_data = await self.api_client.call_api(
2072
+ *_param,
2073
+ _request_timeout=_request_timeout
2074
+ )
2075
+ return response_data.response
2076
+
2077
+
2078
+ def _get_permission_serialize(
2079
+ self,
2080
+ permission_id,
2081
+ _request_auth,
2082
+ _content_type,
2083
+ _headers,
2084
+ _host_index,
2085
+ ) -> RequestSerialized:
2086
+
2087
+ _host = None
2088
+
2089
+ _collection_formats: Dict[str, str] = {
2090
+ }
2091
+
2092
+ _path_params: Dict[str, str] = {}
2093
+ _query_params: List[Tuple[str, str]] = []
2094
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2095
+ _form_params: List[Tuple[str, str]] = []
2096
+ _files: Dict[
2097
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2098
+ ] = {}
2099
+ _body_params: Optional[bytes] = None
2100
+
2101
+ # process the path parameters
2102
+ if permission_id is not None:
2103
+ _path_params['permissionId'] = permission_id
2104
+ # process the query parameters
2105
+ # process the header parameters
2106
+ # process the form parameters
2107
+ # process the body parameter
2108
+
2109
+
2110
+ # set the HTTP header `Accept`
2111
+ if 'Accept' not in _header_params:
2112
+ _header_params['Accept'] = self.api_client.select_header_accept(
2113
+ [
2114
+ 'application/json'
2115
+ ]
2116
+ )
2117
+
2118
+
2119
+ # authentication setting
2120
+ _auth_settings: List[str] = [
2121
+ 'authCookie'
2122
+ ]
2123
+
2124
+ return self.api_client.param_serialize(
2125
+ method='GET',
2126
+ resource_path='/permissions/{permissionId}',
2127
+ path_params=_path_params,
2128
+ query_params=_query_params,
2129
+ header_params=_header_params,
2130
+ body=_body_params,
2131
+ post_params=_form_params,
2132
+ files=_files,
2133
+ auth_settings=_auth_settings,
2134
+ collection_formats=_collection_formats,
2135
+ _host=_host,
2136
+ _request_auth=_request_auth
2137
+ )
2138
+
2139
+
2140
+
2141
+
2142
+ @validate_call
2143
+ async def get_system_time(
2144
+ self,
2145
+ _request_timeout: Union[
2146
+ None,
2147
+ Annotated[StrictFloat, Field(gt=0)],
2148
+ Tuple[
2149
+ Annotated[StrictFloat, Field(gt=0)],
2150
+ Annotated[StrictFloat, Field(gt=0)]
2151
+ ]
2152
+ ] = None,
2153
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2154
+ _content_type: Optional[StrictStr] = None,
2155
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2156
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2157
+ ) -> datetime:
2158
+ """Current System Time
2159
+
2160
+ Returns the current time of the API server. **NOTE:** The response type is not a JSON object, but a simple JSON string.
2161
+
2162
+ :param _request_timeout: timeout setting for this request. If one
2163
+ number provided, it will be total request
2164
+ timeout. It can also be a pair (tuple) of
2165
+ (connection, read) timeouts.
2166
+ :type _request_timeout: int, tuple(int, int), optional
2167
+ :param _request_auth: set to override the auth_settings for an a single
2168
+ request; this effectively ignores the
2169
+ authentication in the spec for a single request.
2170
+ :type _request_auth: dict, optional
2171
+ :param _content_type: force content-type for the request.
2172
+ :type _content_type: str, Optional
2173
+ :param _headers: set to override the headers for a single
2174
+ request; this effectively ignores the headers
2175
+ in the spec for a single request.
2176
+ :type _headers: dict, optional
2177
+ :param _host_index: set to override the host_index for a single
2178
+ request; this effectively ignores the host_index
2179
+ in the spec for a single request.
2180
+ :type _host_index: int, optional
2181
+ :return: Returns the result object.
2182
+ """ # noqa: E501
2183
+
2184
+ _param = self._get_system_time_serialize(
2185
+ _request_auth=_request_auth,
2186
+ _content_type=_content_type,
2187
+ _headers=_headers,
2188
+ _host_index=_host_index
2189
+ )
2190
+
2191
+ _response_types_map: Dict[str, Optional[str]] = {
2192
+ '200': "datetime",
2193
+ }
2194
+ response_data = await self.api_client.call_api(
2195
+ *_param,
2196
+ _request_timeout=_request_timeout
2197
+ )
2198
+ await response_data.read()
2199
+ return self.api_client.response_deserialize(
2200
+ response_data=response_data,
2201
+ response_types_map=_response_types_map,
2202
+ ).data
2203
+
2204
+
2205
+ @validate_call
2206
+ async def get_system_time_with_http_info(
2207
+ self,
2208
+ _request_timeout: Union[
2209
+ None,
2210
+ Annotated[StrictFloat, Field(gt=0)],
2211
+ Tuple[
2212
+ Annotated[StrictFloat, Field(gt=0)],
2213
+ Annotated[StrictFloat, Field(gt=0)]
2214
+ ]
2215
+ ] = None,
2216
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2217
+ _content_type: Optional[StrictStr] = None,
2218
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2219
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2220
+ ) -> ApiResponse[datetime]:
2221
+ """Current System Time
2222
+
2223
+ Returns the current time of the API server. **NOTE:** The response type is not a JSON object, but a simple JSON string.
2224
+
2225
+ :param _request_timeout: timeout setting for this request. If one
2226
+ number provided, it will be total request
2227
+ timeout. It can also be a pair (tuple) of
2228
+ (connection, read) timeouts.
2229
+ :type _request_timeout: int, tuple(int, int), optional
2230
+ :param _request_auth: set to override the auth_settings for an a single
2231
+ request; this effectively ignores the
2232
+ authentication in the spec for a single request.
2233
+ :type _request_auth: dict, optional
2234
+ :param _content_type: force content-type for the request.
2235
+ :type _content_type: str, Optional
2236
+ :param _headers: set to override the headers for a single
2237
+ request; this effectively ignores the headers
2238
+ in the spec for a single request.
2239
+ :type _headers: dict, optional
2240
+ :param _host_index: set to override the host_index for a single
2241
+ request; this effectively ignores the host_index
2242
+ in the spec for a single request.
2243
+ :type _host_index: int, optional
2244
+ :return: Returns the result object.
2245
+ """ # noqa: E501
2246
+
2247
+ _param = self._get_system_time_serialize(
2248
+ _request_auth=_request_auth,
2249
+ _content_type=_content_type,
2250
+ _headers=_headers,
2251
+ _host_index=_host_index
2252
+ )
2253
+
2254
+ _response_types_map: Dict[str, Optional[str]] = {
2255
+ '200': "datetime",
2256
+ }
2257
+ response_data = await self.api_client.call_api(
2258
+ *_param,
2259
+ _request_timeout=_request_timeout
2260
+ )
2261
+ await response_data.read()
2262
+ return self.api_client.response_deserialize(
2263
+ response_data=response_data,
2264
+ response_types_map=_response_types_map,
2265
+ )
2266
+
2267
+
2268
+ @validate_call
2269
+ async def get_system_time_without_preload_content(
2270
+ self,
2271
+ _request_timeout: Union[
2272
+ None,
2273
+ Annotated[StrictFloat, Field(gt=0)],
2274
+ Tuple[
2275
+ Annotated[StrictFloat, Field(gt=0)],
2276
+ Annotated[StrictFloat, Field(gt=0)]
2277
+ ]
2278
+ ] = None,
2279
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2280
+ _content_type: Optional[StrictStr] = None,
2281
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2282
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2283
+ ) -> RESTResponseType:
2284
+ """Current System Time
2285
+
2286
+ Returns the current time of the API server. **NOTE:** The response type is not a JSON object, but a simple JSON string.
2287
+
2288
+ :param _request_timeout: timeout setting for this request. If one
2289
+ number provided, it will be total request
2290
+ timeout. It can also be a pair (tuple) of
2291
+ (connection, read) timeouts.
2292
+ :type _request_timeout: int, tuple(int, int), optional
2293
+ :param _request_auth: set to override the auth_settings for an a single
2294
+ request; this effectively ignores the
2295
+ authentication in the spec for a single request.
2296
+ :type _request_auth: dict, optional
2297
+ :param _content_type: force content-type for the request.
2298
+ :type _content_type: str, Optional
2299
+ :param _headers: set to override the headers for a single
2300
+ request; this effectively ignores the headers
2301
+ in the spec for a single request.
2302
+ :type _headers: dict, optional
2303
+ :param _host_index: set to override the host_index for a single
2304
+ request; this effectively ignores the host_index
2305
+ in the spec for a single request.
2306
+ :type _host_index: int, optional
2307
+ :return: Returns the result object.
2308
+ """ # noqa: E501
2309
+
2310
+ _param = self._get_system_time_serialize(
2311
+ _request_auth=_request_auth,
2312
+ _content_type=_content_type,
2313
+ _headers=_headers,
2314
+ _host_index=_host_index
2315
+ )
2316
+
2317
+ _response_types_map: Dict[str, Optional[str]] = {
2318
+ '200': "datetime",
2319
+ }
2320
+ response_data = await self.api_client.call_api(
2321
+ *_param,
2322
+ _request_timeout=_request_timeout
2323
+ )
2324
+ return response_data.response
2325
+
2326
+
2327
+ def _get_system_time_serialize(
2328
+ self,
2329
+ _request_auth,
2330
+ _content_type,
2331
+ _headers,
2332
+ _host_index,
2333
+ ) -> RequestSerialized:
2334
+
2335
+ _host = None
2336
+
2337
+ _collection_formats: Dict[str, str] = {
2338
+ }
2339
+
2340
+ _path_params: Dict[str, str] = {}
2341
+ _query_params: List[Tuple[str, str]] = []
2342
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2343
+ _form_params: List[Tuple[str, str]] = []
2344
+ _files: Dict[
2345
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2346
+ ] = {}
2347
+ _body_params: Optional[bytes] = None
2348
+
2349
+ # process the path parameters
2350
+ # process the query parameters
2351
+ # process the header parameters
2352
+ # process the form parameters
2353
+ # process the body parameter
2354
+
2355
+
2356
+ # set the HTTP header `Accept`
2357
+ if 'Accept' not in _header_params:
2358
+ _header_params['Accept'] = self.api_client.select_header_accept(
2359
+ [
2360
+ 'application/json'
2361
+ ]
2362
+ )
2363
+
2364
+
2365
+ # authentication setting
2366
+ _auth_settings: List[str] = [
2367
+ ]
2368
+
2369
+ return self.api_client.param_serialize(
2370
+ method='GET',
2371
+ resource_path='/time',
2372
+ path_params=_path_params,
2373
+ query_params=_query_params,
2374
+ header_params=_header_params,
2375
+ body=_body_params,
2376
+ post_params=_form_params,
2377
+ files=_files,
2378
+ auth_settings=_auth_settings,
2379
+ collection_formats=_collection_formats,
2380
+ _host=_host,
2381
+ _request_auth=_request_auth
2382
+ )
2383
+
2384
+