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,2269 @@
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 pydantic import Field, StrictStr
19
+ from typing import List, Optional
20
+ from typing_extensions import Annotated
21
+ from vrchatapi.models.create_prop_request import CreatePropRequest
22
+ from vrchatapi.models.prop import Prop
23
+ from vrchatapi.models.prop_publish_status import PropPublishStatus
24
+ from vrchatapi.models.update_prop_request import UpdatePropRequest
25
+
26
+ from vrchatapi.api_client import ApiClient, RequestSerialized
27
+ from vrchatapi.api_response import ApiResponse
28
+ from vrchatapi.rest import RESTResponseType
29
+
30
+
31
+ class PropsApi:
32
+ """NOTE: This class is auto generated by OpenAPI Generator
33
+ Ref: https://openapi-generator.tech
34
+
35
+ Do not edit the class manually.
36
+ """
37
+
38
+ def __init__(self, api_client=None) -> None:
39
+ if api_client is None:
40
+ api_client = ApiClient.get_default()
41
+ self.api_client = api_client
42
+
43
+
44
+ @validate_call
45
+ async def create_prop(
46
+ self,
47
+ create_prop_request: CreatePropRequest,
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
+ ) -> Prop:
61
+ """Create Prop
62
+
63
+ Create a Prop and return the new Prop object.
64
+
65
+ :param create_prop_request: (required)
66
+ :type create_prop_request: CreatePropRequest
67
+ :param _request_timeout: timeout setting for this request. If one
68
+ number provided, it will be total request
69
+ timeout. It can also be a pair (tuple) of
70
+ (connection, read) timeouts.
71
+ :type _request_timeout: int, tuple(int, int), optional
72
+ :param _request_auth: set to override the auth_settings for an a single
73
+ request; this effectively ignores the
74
+ authentication in the spec for a single request.
75
+ :type _request_auth: dict, optional
76
+ :param _content_type: force content-type for the request.
77
+ :type _content_type: str, Optional
78
+ :param _headers: set to override the headers for a single
79
+ request; this effectively ignores the headers
80
+ in the spec for a single request.
81
+ :type _headers: dict, optional
82
+ :param _host_index: set to override the host_index for a single
83
+ request; this effectively ignores the host_index
84
+ in the spec for a single request.
85
+ :type _host_index: int, optional
86
+ :return: Returns the result object.
87
+ """ # noqa: E501
88
+
89
+ _param = self._create_prop_serialize(
90
+ create_prop_request=create_prop_request,
91
+ _request_auth=_request_auth,
92
+ _content_type=_content_type,
93
+ _headers=_headers,
94
+ _host_index=_host_index
95
+ )
96
+
97
+ _response_types_map: Dict[str, Optional[str]] = {
98
+ '200': "Prop",
99
+ '401': "Error",
100
+ '403': "Error",
101
+ }
102
+ response_data = await self.api_client.call_api(
103
+ *_param,
104
+ _request_timeout=_request_timeout
105
+ )
106
+ await response_data.read()
107
+ return self.api_client.response_deserialize(
108
+ response_data=response_data,
109
+ response_types_map=_response_types_map,
110
+ ).data
111
+
112
+
113
+ @validate_call
114
+ async def create_prop_with_http_info(
115
+ self,
116
+ create_prop_request: CreatePropRequest,
117
+ _request_timeout: Union[
118
+ None,
119
+ Annotated[StrictFloat, Field(gt=0)],
120
+ Tuple[
121
+ Annotated[StrictFloat, Field(gt=0)],
122
+ Annotated[StrictFloat, Field(gt=0)]
123
+ ]
124
+ ] = None,
125
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
126
+ _content_type: Optional[StrictStr] = None,
127
+ _headers: Optional[Dict[StrictStr, Any]] = None,
128
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
129
+ ) -> ApiResponse[Prop]:
130
+ """Create Prop
131
+
132
+ Create a Prop and return the new Prop object.
133
+
134
+ :param create_prop_request: (required)
135
+ :type create_prop_request: CreatePropRequest
136
+ :param _request_timeout: timeout setting for this request. If one
137
+ number provided, it will be total request
138
+ timeout. It can also be a pair (tuple) of
139
+ (connection, read) timeouts.
140
+ :type _request_timeout: int, tuple(int, int), optional
141
+ :param _request_auth: set to override the auth_settings for an a single
142
+ request; this effectively ignores the
143
+ authentication in the spec for a single request.
144
+ :type _request_auth: dict, optional
145
+ :param _content_type: force content-type for the request.
146
+ :type _content_type: str, Optional
147
+ :param _headers: set to override the headers for a single
148
+ request; this effectively ignores the headers
149
+ in the spec for a single request.
150
+ :type _headers: dict, optional
151
+ :param _host_index: set to override the host_index for a single
152
+ request; this effectively ignores the host_index
153
+ in the spec for a single request.
154
+ :type _host_index: int, optional
155
+ :return: Returns the result object.
156
+ """ # noqa: E501
157
+
158
+ _param = self._create_prop_serialize(
159
+ create_prop_request=create_prop_request,
160
+ _request_auth=_request_auth,
161
+ _content_type=_content_type,
162
+ _headers=_headers,
163
+ _host_index=_host_index
164
+ )
165
+
166
+ _response_types_map: Dict[str, Optional[str]] = {
167
+ '200': "Prop",
168
+ '401': "Error",
169
+ '403': "Error",
170
+ }
171
+ response_data = await self.api_client.call_api(
172
+ *_param,
173
+ _request_timeout=_request_timeout
174
+ )
175
+ await response_data.read()
176
+ return self.api_client.response_deserialize(
177
+ response_data=response_data,
178
+ response_types_map=_response_types_map,
179
+ )
180
+
181
+
182
+ @validate_call
183
+ async def create_prop_without_preload_content(
184
+ self,
185
+ create_prop_request: CreatePropRequest,
186
+ _request_timeout: Union[
187
+ None,
188
+ Annotated[StrictFloat, Field(gt=0)],
189
+ Tuple[
190
+ Annotated[StrictFloat, Field(gt=0)],
191
+ Annotated[StrictFloat, Field(gt=0)]
192
+ ]
193
+ ] = None,
194
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
195
+ _content_type: Optional[StrictStr] = None,
196
+ _headers: Optional[Dict[StrictStr, Any]] = None,
197
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
198
+ ) -> RESTResponseType:
199
+ """Create Prop
200
+
201
+ Create a Prop and return the new Prop object.
202
+
203
+ :param create_prop_request: (required)
204
+ :type create_prop_request: CreatePropRequest
205
+ :param _request_timeout: timeout setting for this request. If one
206
+ number provided, it will be total request
207
+ timeout. It can also be a pair (tuple) of
208
+ (connection, read) timeouts.
209
+ :type _request_timeout: int, tuple(int, int), optional
210
+ :param _request_auth: set to override the auth_settings for an a single
211
+ request; this effectively ignores the
212
+ authentication in the spec for a single request.
213
+ :type _request_auth: dict, optional
214
+ :param _content_type: force content-type for the request.
215
+ :type _content_type: str, Optional
216
+ :param _headers: set to override the headers for a single
217
+ request; this effectively ignores the headers
218
+ in the spec for a single request.
219
+ :type _headers: dict, optional
220
+ :param _host_index: set to override the host_index for a single
221
+ request; this effectively ignores the host_index
222
+ in the spec for a single request.
223
+ :type _host_index: int, optional
224
+ :return: Returns the result object.
225
+ """ # noqa: E501
226
+
227
+ _param = self._create_prop_serialize(
228
+ create_prop_request=create_prop_request,
229
+ _request_auth=_request_auth,
230
+ _content_type=_content_type,
231
+ _headers=_headers,
232
+ _host_index=_host_index
233
+ )
234
+
235
+ _response_types_map: Dict[str, Optional[str]] = {
236
+ '200': "Prop",
237
+ '401': "Error",
238
+ '403': "Error",
239
+ }
240
+ response_data = await self.api_client.call_api(
241
+ *_param,
242
+ _request_timeout=_request_timeout
243
+ )
244
+ return response_data.response
245
+
246
+
247
+ def _create_prop_serialize(
248
+ self,
249
+ create_prop_request,
250
+ _request_auth,
251
+ _content_type,
252
+ _headers,
253
+ _host_index,
254
+ ) -> RequestSerialized:
255
+
256
+ _host = None
257
+
258
+ _collection_formats: Dict[str, str] = {
259
+ }
260
+
261
+ _path_params: Dict[str, str] = {}
262
+ _query_params: List[Tuple[str, str]] = []
263
+ _header_params: Dict[str, Optional[str]] = _headers or {}
264
+ _form_params: List[Tuple[str, str]] = []
265
+ _files: Dict[
266
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
267
+ ] = {}
268
+ _body_params: Optional[bytes] = None
269
+
270
+ # process the path parameters
271
+ # process the query parameters
272
+ # process the header parameters
273
+ # process the form parameters
274
+ # process the body parameter
275
+ if create_prop_request is not None:
276
+ _body_params = create_prop_request
277
+
278
+
279
+ # set the HTTP header `Accept`
280
+ if 'Accept' not in _header_params:
281
+ _header_params['Accept'] = self.api_client.select_header_accept(
282
+ [
283
+ 'application/json'
284
+ ]
285
+ )
286
+
287
+ # set the HTTP header `Content-Type`
288
+ if _content_type:
289
+ _header_params['Content-Type'] = _content_type
290
+ else:
291
+ _default_content_type = (
292
+ self.api_client.select_header_content_type(
293
+ [
294
+ 'application/json'
295
+ ]
296
+ )
297
+ )
298
+ if _default_content_type is not None:
299
+ _header_params['Content-Type'] = _default_content_type
300
+
301
+ # authentication setting
302
+ _auth_settings: List[str] = [
303
+ 'authCookie'
304
+ ]
305
+
306
+ return self.api_client.param_serialize(
307
+ method='POST',
308
+ resource_path='/props',
309
+ path_params=_path_params,
310
+ query_params=_query_params,
311
+ header_params=_header_params,
312
+ body=_body_params,
313
+ post_params=_form_params,
314
+ files=_files,
315
+ auth_settings=_auth_settings,
316
+ collection_formats=_collection_formats,
317
+ _host=_host,
318
+ _request_auth=_request_auth
319
+ )
320
+
321
+
322
+
323
+
324
+ @validate_call
325
+ async def delete_prop(
326
+ self,
327
+ prop_id: Annotated[StrictStr, Field(description="Prop ID.")],
328
+ _request_timeout: Union[
329
+ None,
330
+ Annotated[StrictFloat, Field(gt=0)],
331
+ Tuple[
332
+ Annotated[StrictFloat, Field(gt=0)],
333
+ Annotated[StrictFloat, Field(gt=0)]
334
+ ]
335
+ ] = None,
336
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
337
+ _content_type: Optional[StrictStr] = None,
338
+ _headers: Optional[Dict[StrictStr, Any]] = None,
339
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
340
+ ) -> None:
341
+ """Delete Prop
342
+
343
+ Delete a Prop.
344
+
345
+ :param prop_id: Prop ID. (required)
346
+ :type prop_id: str
347
+ :param _request_timeout: timeout setting for this request. If one
348
+ number provided, it will be total request
349
+ timeout. It can also be a pair (tuple) of
350
+ (connection, read) timeouts.
351
+ :type _request_timeout: int, tuple(int, int), optional
352
+ :param _request_auth: set to override the auth_settings for an a single
353
+ request; this effectively ignores the
354
+ authentication in the spec for a single request.
355
+ :type _request_auth: dict, optional
356
+ :param _content_type: force content-type for the request.
357
+ :type _content_type: str, Optional
358
+ :param _headers: set to override the headers for a single
359
+ request; this effectively ignores the headers
360
+ in the spec for a single request.
361
+ :type _headers: dict, optional
362
+ :param _host_index: set to override the host_index for a single
363
+ request; this effectively ignores the host_index
364
+ in the spec for a single request.
365
+ :type _host_index: int, optional
366
+ :return: Returns the result object.
367
+ """ # noqa: E501
368
+
369
+ _param = self._delete_prop_serialize(
370
+ prop_id=prop_id,
371
+ _request_auth=_request_auth,
372
+ _content_type=_content_type,
373
+ _headers=_headers,
374
+ _host_index=_host_index
375
+ )
376
+
377
+ _response_types_map: Dict[str, Optional[str]] = {
378
+ '200': None,
379
+ '401': "Error",
380
+ '403': "Error",
381
+ '404': "Error",
382
+ }
383
+ response_data = await self.api_client.call_api(
384
+ *_param,
385
+ _request_timeout=_request_timeout
386
+ )
387
+ await response_data.read()
388
+ return self.api_client.response_deserialize(
389
+ response_data=response_data,
390
+ response_types_map=_response_types_map,
391
+ ).data
392
+
393
+
394
+ @validate_call
395
+ async def delete_prop_with_http_info(
396
+ self,
397
+ prop_id: Annotated[StrictStr, Field(description="Prop ID.")],
398
+ _request_timeout: Union[
399
+ None,
400
+ Annotated[StrictFloat, Field(gt=0)],
401
+ Tuple[
402
+ Annotated[StrictFloat, Field(gt=0)],
403
+ Annotated[StrictFloat, Field(gt=0)]
404
+ ]
405
+ ] = None,
406
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
407
+ _content_type: Optional[StrictStr] = None,
408
+ _headers: Optional[Dict[StrictStr, Any]] = None,
409
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
410
+ ) -> ApiResponse[None]:
411
+ """Delete Prop
412
+
413
+ Delete a Prop.
414
+
415
+ :param prop_id: Prop ID. (required)
416
+ :type prop_id: str
417
+ :param _request_timeout: timeout setting for this request. If one
418
+ number provided, it will be total request
419
+ timeout. It can also be a pair (tuple) of
420
+ (connection, read) timeouts.
421
+ :type _request_timeout: int, tuple(int, int), optional
422
+ :param _request_auth: set to override the auth_settings for an a single
423
+ request; this effectively ignores the
424
+ authentication in the spec for a single request.
425
+ :type _request_auth: dict, optional
426
+ :param _content_type: force content-type for the request.
427
+ :type _content_type: str, Optional
428
+ :param _headers: set to override the headers for a single
429
+ request; this effectively ignores the headers
430
+ in the spec for a single request.
431
+ :type _headers: dict, optional
432
+ :param _host_index: set to override the host_index for a single
433
+ request; this effectively ignores the host_index
434
+ in the spec for a single request.
435
+ :type _host_index: int, optional
436
+ :return: Returns the result object.
437
+ """ # noqa: E501
438
+
439
+ _param = self._delete_prop_serialize(
440
+ prop_id=prop_id,
441
+ _request_auth=_request_auth,
442
+ _content_type=_content_type,
443
+ _headers=_headers,
444
+ _host_index=_host_index
445
+ )
446
+
447
+ _response_types_map: Dict[str, Optional[str]] = {
448
+ '200': None,
449
+ '401': "Error",
450
+ '403': "Error",
451
+ '404': "Error",
452
+ }
453
+ response_data = await self.api_client.call_api(
454
+ *_param,
455
+ _request_timeout=_request_timeout
456
+ )
457
+ await response_data.read()
458
+ return self.api_client.response_deserialize(
459
+ response_data=response_data,
460
+ response_types_map=_response_types_map,
461
+ )
462
+
463
+
464
+ @validate_call
465
+ async def delete_prop_without_preload_content(
466
+ self,
467
+ prop_id: Annotated[StrictStr, Field(description="Prop ID.")],
468
+ _request_timeout: Union[
469
+ None,
470
+ Annotated[StrictFloat, Field(gt=0)],
471
+ Tuple[
472
+ Annotated[StrictFloat, Field(gt=0)],
473
+ Annotated[StrictFloat, Field(gt=0)]
474
+ ]
475
+ ] = None,
476
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
477
+ _content_type: Optional[StrictStr] = None,
478
+ _headers: Optional[Dict[StrictStr, Any]] = None,
479
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
480
+ ) -> RESTResponseType:
481
+ """Delete Prop
482
+
483
+ Delete a Prop.
484
+
485
+ :param prop_id: Prop ID. (required)
486
+ :type prop_id: str
487
+ :param _request_timeout: timeout setting for this request. If one
488
+ number provided, it will be total request
489
+ timeout. It can also be a pair (tuple) of
490
+ (connection, read) timeouts.
491
+ :type _request_timeout: int, tuple(int, int), optional
492
+ :param _request_auth: set to override the auth_settings for an a single
493
+ request; this effectively ignores the
494
+ authentication in the spec for a single request.
495
+ :type _request_auth: dict, optional
496
+ :param _content_type: force content-type for the request.
497
+ :type _content_type: str, Optional
498
+ :param _headers: set to override the headers for a single
499
+ request; this effectively ignores the headers
500
+ in the spec for a single request.
501
+ :type _headers: dict, optional
502
+ :param _host_index: set to override the host_index for a single
503
+ request; this effectively ignores the host_index
504
+ in the spec for a single request.
505
+ :type _host_index: int, optional
506
+ :return: Returns the result object.
507
+ """ # noqa: E501
508
+
509
+ _param = self._delete_prop_serialize(
510
+ prop_id=prop_id,
511
+ _request_auth=_request_auth,
512
+ _content_type=_content_type,
513
+ _headers=_headers,
514
+ _host_index=_host_index
515
+ )
516
+
517
+ _response_types_map: Dict[str, Optional[str]] = {
518
+ '200': None,
519
+ '401': "Error",
520
+ '403': "Error",
521
+ '404': "Error",
522
+ }
523
+ response_data = await self.api_client.call_api(
524
+ *_param,
525
+ _request_timeout=_request_timeout
526
+ )
527
+ return response_data.response
528
+
529
+
530
+ def _delete_prop_serialize(
531
+ self,
532
+ prop_id,
533
+ _request_auth,
534
+ _content_type,
535
+ _headers,
536
+ _host_index,
537
+ ) -> RequestSerialized:
538
+
539
+ _host = None
540
+
541
+ _collection_formats: Dict[str, str] = {
542
+ }
543
+
544
+ _path_params: Dict[str, str] = {}
545
+ _query_params: List[Tuple[str, str]] = []
546
+ _header_params: Dict[str, Optional[str]] = _headers or {}
547
+ _form_params: List[Tuple[str, str]] = []
548
+ _files: Dict[
549
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
550
+ ] = {}
551
+ _body_params: Optional[bytes] = None
552
+
553
+ # process the path parameters
554
+ if prop_id is not None:
555
+ _path_params['propId'] = prop_id
556
+ # process the query parameters
557
+ # process the header parameters
558
+ # process the form parameters
559
+ # process the body parameter
560
+
561
+
562
+ # set the HTTP header `Accept`
563
+ if 'Accept' not in _header_params:
564
+ _header_params['Accept'] = self.api_client.select_header_accept(
565
+ [
566
+ 'application/json'
567
+ ]
568
+ )
569
+
570
+
571
+ # authentication setting
572
+ _auth_settings: List[str] = [
573
+ 'authCookie'
574
+ ]
575
+
576
+ return self.api_client.param_serialize(
577
+ method='DELETE',
578
+ resource_path='/props/{propId}',
579
+ path_params=_path_params,
580
+ query_params=_query_params,
581
+ header_params=_header_params,
582
+ body=_body_params,
583
+ post_params=_form_params,
584
+ files=_files,
585
+ auth_settings=_auth_settings,
586
+ collection_formats=_collection_formats,
587
+ _host=_host,
588
+ _request_auth=_request_auth
589
+ )
590
+
591
+
592
+
593
+
594
+ @validate_call
595
+ async def get_prop(
596
+ self,
597
+ prop_id: Annotated[StrictStr, Field(description="Prop ID.")],
598
+ _request_timeout: Union[
599
+ None,
600
+ Annotated[StrictFloat, Field(gt=0)],
601
+ Tuple[
602
+ Annotated[StrictFloat, Field(gt=0)],
603
+ Annotated[StrictFloat, Field(gt=0)]
604
+ ]
605
+ ] = None,
606
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
607
+ _content_type: Optional[StrictStr] = None,
608
+ _headers: Optional[Dict[StrictStr, Any]] = None,
609
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
610
+ ) -> Prop:
611
+ """Get Prop
612
+
613
+ Returns a Prop object.
614
+
615
+ :param prop_id: Prop ID. (required)
616
+ :type prop_id: str
617
+ :param _request_timeout: timeout setting for this request. If one
618
+ number provided, it will be total request
619
+ timeout. It can also be a pair (tuple) of
620
+ (connection, read) timeouts.
621
+ :type _request_timeout: int, tuple(int, int), optional
622
+ :param _request_auth: set to override the auth_settings for an a single
623
+ request; this effectively ignores the
624
+ authentication in the spec for a single request.
625
+ :type _request_auth: dict, optional
626
+ :param _content_type: force content-type for the request.
627
+ :type _content_type: str, Optional
628
+ :param _headers: set to override the headers for a single
629
+ request; this effectively ignores the headers
630
+ in the spec for a single request.
631
+ :type _headers: dict, optional
632
+ :param _host_index: set to override the host_index for a single
633
+ request; this effectively ignores the host_index
634
+ in the spec for a single request.
635
+ :type _host_index: int, optional
636
+ :return: Returns the result object.
637
+ """ # noqa: E501
638
+
639
+ _param = self._get_prop_serialize(
640
+ prop_id=prop_id,
641
+ _request_auth=_request_auth,
642
+ _content_type=_content_type,
643
+ _headers=_headers,
644
+ _host_index=_host_index
645
+ )
646
+
647
+ _response_types_map: Dict[str, Optional[str]] = {
648
+ '200': "Prop",
649
+ '401': "Error",
650
+ '404': "Error",
651
+ }
652
+ response_data = await self.api_client.call_api(
653
+ *_param,
654
+ _request_timeout=_request_timeout
655
+ )
656
+ await response_data.read()
657
+ return self.api_client.response_deserialize(
658
+ response_data=response_data,
659
+ response_types_map=_response_types_map,
660
+ ).data
661
+
662
+
663
+ @validate_call
664
+ async def get_prop_with_http_info(
665
+ self,
666
+ prop_id: Annotated[StrictStr, Field(description="Prop ID.")],
667
+ _request_timeout: Union[
668
+ None,
669
+ Annotated[StrictFloat, Field(gt=0)],
670
+ Tuple[
671
+ Annotated[StrictFloat, Field(gt=0)],
672
+ Annotated[StrictFloat, Field(gt=0)]
673
+ ]
674
+ ] = None,
675
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
676
+ _content_type: Optional[StrictStr] = None,
677
+ _headers: Optional[Dict[StrictStr, Any]] = None,
678
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
679
+ ) -> ApiResponse[Prop]:
680
+ """Get Prop
681
+
682
+ Returns a Prop object.
683
+
684
+ :param prop_id: Prop ID. (required)
685
+ :type prop_id: str
686
+ :param _request_timeout: timeout setting for this request. If one
687
+ number provided, it will be total request
688
+ timeout. It can also be a pair (tuple) of
689
+ (connection, read) timeouts.
690
+ :type _request_timeout: int, tuple(int, int), optional
691
+ :param _request_auth: set to override the auth_settings for an a single
692
+ request; this effectively ignores the
693
+ authentication in the spec for a single request.
694
+ :type _request_auth: dict, optional
695
+ :param _content_type: force content-type for the request.
696
+ :type _content_type: str, Optional
697
+ :param _headers: set to override the headers for a single
698
+ request; this effectively ignores the headers
699
+ in the spec for a single request.
700
+ :type _headers: dict, optional
701
+ :param _host_index: set to override the host_index for a single
702
+ request; this effectively ignores the host_index
703
+ in the spec for a single request.
704
+ :type _host_index: int, optional
705
+ :return: Returns the result object.
706
+ """ # noqa: E501
707
+
708
+ _param = self._get_prop_serialize(
709
+ prop_id=prop_id,
710
+ _request_auth=_request_auth,
711
+ _content_type=_content_type,
712
+ _headers=_headers,
713
+ _host_index=_host_index
714
+ )
715
+
716
+ _response_types_map: Dict[str, Optional[str]] = {
717
+ '200': "Prop",
718
+ '401': "Error",
719
+ '404': "Error",
720
+ }
721
+ response_data = await self.api_client.call_api(
722
+ *_param,
723
+ _request_timeout=_request_timeout
724
+ )
725
+ await response_data.read()
726
+ return self.api_client.response_deserialize(
727
+ response_data=response_data,
728
+ response_types_map=_response_types_map,
729
+ )
730
+
731
+
732
+ @validate_call
733
+ async def get_prop_without_preload_content(
734
+ self,
735
+ prop_id: Annotated[StrictStr, Field(description="Prop ID.")],
736
+ _request_timeout: Union[
737
+ None,
738
+ Annotated[StrictFloat, Field(gt=0)],
739
+ Tuple[
740
+ Annotated[StrictFloat, Field(gt=0)],
741
+ Annotated[StrictFloat, Field(gt=0)]
742
+ ]
743
+ ] = None,
744
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
745
+ _content_type: Optional[StrictStr] = None,
746
+ _headers: Optional[Dict[StrictStr, Any]] = None,
747
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
748
+ ) -> RESTResponseType:
749
+ """Get Prop
750
+
751
+ Returns a Prop object.
752
+
753
+ :param prop_id: Prop ID. (required)
754
+ :type prop_id: str
755
+ :param _request_timeout: timeout setting for this request. If one
756
+ number provided, it will be total request
757
+ timeout. It can also be a pair (tuple) of
758
+ (connection, read) timeouts.
759
+ :type _request_timeout: int, tuple(int, int), optional
760
+ :param _request_auth: set to override the auth_settings for an a single
761
+ request; this effectively ignores the
762
+ authentication in the spec for a single request.
763
+ :type _request_auth: dict, optional
764
+ :param _content_type: force content-type for the request.
765
+ :type _content_type: str, Optional
766
+ :param _headers: set to override the headers for a single
767
+ request; this effectively ignores the headers
768
+ in the spec for a single request.
769
+ :type _headers: dict, optional
770
+ :param _host_index: set to override the host_index for a single
771
+ request; this effectively ignores the host_index
772
+ in the spec for a single request.
773
+ :type _host_index: int, optional
774
+ :return: Returns the result object.
775
+ """ # noqa: E501
776
+
777
+ _param = self._get_prop_serialize(
778
+ prop_id=prop_id,
779
+ _request_auth=_request_auth,
780
+ _content_type=_content_type,
781
+ _headers=_headers,
782
+ _host_index=_host_index
783
+ )
784
+
785
+ _response_types_map: Dict[str, Optional[str]] = {
786
+ '200': "Prop",
787
+ '401': "Error",
788
+ '404': "Error",
789
+ }
790
+ response_data = await self.api_client.call_api(
791
+ *_param,
792
+ _request_timeout=_request_timeout
793
+ )
794
+ return response_data.response
795
+
796
+
797
+ def _get_prop_serialize(
798
+ self,
799
+ prop_id,
800
+ _request_auth,
801
+ _content_type,
802
+ _headers,
803
+ _host_index,
804
+ ) -> RequestSerialized:
805
+
806
+ _host = None
807
+
808
+ _collection_formats: Dict[str, str] = {
809
+ }
810
+
811
+ _path_params: Dict[str, str] = {}
812
+ _query_params: List[Tuple[str, str]] = []
813
+ _header_params: Dict[str, Optional[str]] = _headers or {}
814
+ _form_params: List[Tuple[str, str]] = []
815
+ _files: Dict[
816
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
817
+ ] = {}
818
+ _body_params: Optional[bytes] = None
819
+
820
+ # process the path parameters
821
+ if prop_id is not None:
822
+ _path_params['propId'] = prop_id
823
+ # process the query parameters
824
+ # process the header parameters
825
+ # process the form parameters
826
+ # process the body parameter
827
+
828
+
829
+ # set the HTTP header `Accept`
830
+ if 'Accept' not in _header_params:
831
+ _header_params['Accept'] = self.api_client.select_header_accept(
832
+ [
833
+ 'application/json'
834
+ ]
835
+ )
836
+
837
+
838
+ # authentication setting
839
+ _auth_settings: List[str] = [
840
+ 'authCookie'
841
+ ]
842
+
843
+ return self.api_client.param_serialize(
844
+ method='GET',
845
+ resource_path='/props/{propId}',
846
+ path_params=_path_params,
847
+ query_params=_query_params,
848
+ header_params=_header_params,
849
+ body=_body_params,
850
+ post_params=_form_params,
851
+ files=_files,
852
+ auth_settings=_auth_settings,
853
+ collection_formats=_collection_formats,
854
+ _host=_host,
855
+ _request_auth=_request_auth
856
+ )
857
+
858
+
859
+
860
+
861
+ @validate_call
862
+ async def get_prop_publish_status(
863
+ self,
864
+ prop_id: Annotated[StrictStr, Field(description="Prop ID.")],
865
+ _request_timeout: Union[
866
+ None,
867
+ Annotated[StrictFloat, Field(gt=0)],
868
+ Tuple[
869
+ Annotated[StrictFloat, Field(gt=0)],
870
+ Annotated[StrictFloat, Field(gt=0)]
871
+ ]
872
+ ] = None,
873
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
874
+ _content_type: Optional[StrictStr] = None,
875
+ _headers: Optional[Dict[StrictStr, Any]] = None,
876
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
877
+ ) -> PropPublishStatus:
878
+ """Get Prop Publish Status
879
+
880
+ Returns a PropPublishStatus object.
881
+
882
+ :param prop_id: Prop ID. (required)
883
+ :type prop_id: str
884
+ :param _request_timeout: timeout setting for this request. If one
885
+ number provided, it will be total request
886
+ timeout. It can also be a pair (tuple) of
887
+ (connection, read) timeouts.
888
+ :type _request_timeout: int, tuple(int, int), optional
889
+ :param _request_auth: set to override the auth_settings for an a single
890
+ request; this effectively ignores the
891
+ authentication in the spec for a single request.
892
+ :type _request_auth: dict, optional
893
+ :param _content_type: force content-type for the request.
894
+ :type _content_type: str, Optional
895
+ :param _headers: set to override the headers for a single
896
+ request; this effectively ignores the headers
897
+ in the spec for a single request.
898
+ :type _headers: dict, optional
899
+ :param _host_index: set to override the host_index for a single
900
+ request; this effectively ignores the host_index
901
+ in the spec for a single request.
902
+ :type _host_index: int, optional
903
+ :return: Returns the result object.
904
+ """ # noqa: E501
905
+
906
+ _param = self._get_prop_publish_status_serialize(
907
+ prop_id=prop_id,
908
+ _request_auth=_request_auth,
909
+ _content_type=_content_type,
910
+ _headers=_headers,
911
+ _host_index=_host_index
912
+ )
913
+
914
+ _response_types_map: Dict[str, Optional[str]] = {
915
+ '200': "PropPublishStatus",
916
+ '401': "Error",
917
+ '403': "Error",
918
+ '404': "Error",
919
+ }
920
+ response_data = await self.api_client.call_api(
921
+ *_param,
922
+ _request_timeout=_request_timeout
923
+ )
924
+ await response_data.read()
925
+ return self.api_client.response_deserialize(
926
+ response_data=response_data,
927
+ response_types_map=_response_types_map,
928
+ ).data
929
+
930
+
931
+ @validate_call
932
+ async def get_prop_publish_status_with_http_info(
933
+ self,
934
+ prop_id: Annotated[StrictStr, Field(description="Prop ID.")],
935
+ _request_timeout: Union[
936
+ None,
937
+ Annotated[StrictFloat, Field(gt=0)],
938
+ Tuple[
939
+ Annotated[StrictFloat, Field(gt=0)],
940
+ Annotated[StrictFloat, Field(gt=0)]
941
+ ]
942
+ ] = None,
943
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
944
+ _content_type: Optional[StrictStr] = None,
945
+ _headers: Optional[Dict[StrictStr, Any]] = None,
946
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
947
+ ) -> ApiResponse[PropPublishStatus]:
948
+ """Get Prop Publish Status
949
+
950
+ Returns a PropPublishStatus object.
951
+
952
+ :param prop_id: Prop ID. (required)
953
+ :type prop_id: str
954
+ :param _request_timeout: timeout setting for this request. If one
955
+ number provided, it will be total request
956
+ timeout. It can also be a pair (tuple) of
957
+ (connection, read) timeouts.
958
+ :type _request_timeout: int, tuple(int, int), optional
959
+ :param _request_auth: set to override the auth_settings for an a single
960
+ request; this effectively ignores the
961
+ authentication in the spec for a single request.
962
+ :type _request_auth: dict, optional
963
+ :param _content_type: force content-type for the request.
964
+ :type _content_type: str, Optional
965
+ :param _headers: set to override the headers for a single
966
+ request; this effectively ignores the headers
967
+ in the spec for a single request.
968
+ :type _headers: dict, optional
969
+ :param _host_index: set to override the host_index for a single
970
+ request; this effectively ignores the host_index
971
+ in the spec for a single request.
972
+ :type _host_index: int, optional
973
+ :return: Returns the result object.
974
+ """ # noqa: E501
975
+
976
+ _param = self._get_prop_publish_status_serialize(
977
+ prop_id=prop_id,
978
+ _request_auth=_request_auth,
979
+ _content_type=_content_type,
980
+ _headers=_headers,
981
+ _host_index=_host_index
982
+ )
983
+
984
+ _response_types_map: Dict[str, Optional[str]] = {
985
+ '200': "PropPublishStatus",
986
+ '401': "Error",
987
+ '403': "Error",
988
+ '404': "Error",
989
+ }
990
+ response_data = await self.api_client.call_api(
991
+ *_param,
992
+ _request_timeout=_request_timeout
993
+ )
994
+ await response_data.read()
995
+ return self.api_client.response_deserialize(
996
+ response_data=response_data,
997
+ response_types_map=_response_types_map,
998
+ )
999
+
1000
+
1001
+ @validate_call
1002
+ async def get_prop_publish_status_without_preload_content(
1003
+ self,
1004
+ prop_id: Annotated[StrictStr, Field(description="Prop ID.")],
1005
+ _request_timeout: Union[
1006
+ None,
1007
+ Annotated[StrictFloat, Field(gt=0)],
1008
+ Tuple[
1009
+ Annotated[StrictFloat, Field(gt=0)],
1010
+ Annotated[StrictFloat, Field(gt=0)]
1011
+ ]
1012
+ ] = None,
1013
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1014
+ _content_type: Optional[StrictStr] = None,
1015
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1016
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1017
+ ) -> RESTResponseType:
1018
+ """Get Prop Publish Status
1019
+
1020
+ Returns a PropPublishStatus object.
1021
+
1022
+ :param prop_id: Prop ID. (required)
1023
+ :type prop_id: str
1024
+ :param _request_timeout: timeout setting for this request. If one
1025
+ number provided, it will be total request
1026
+ timeout. It can also be a pair (tuple) of
1027
+ (connection, read) timeouts.
1028
+ :type _request_timeout: int, tuple(int, int), optional
1029
+ :param _request_auth: set to override the auth_settings for an a single
1030
+ request; this effectively ignores the
1031
+ authentication in the spec for a single request.
1032
+ :type _request_auth: dict, optional
1033
+ :param _content_type: force content-type for the request.
1034
+ :type _content_type: str, Optional
1035
+ :param _headers: set to override the headers for a single
1036
+ request; this effectively ignores the headers
1037
+ in the spec for a single request.
1038
+ :type _headers: dict, optional
1039
+ :param _host_index: set to override the host_index for a single
1040
+ request; this effectively ignores the host_index
1041
+ in the spec for a single request.
1042
+ :type _host_index: int, optional
1043
+ :return: Returns the result object.
1044
+ """ # noqa: E501
1045
+
1046
+ _param = self._get_prop_publish_status_serialize(
1047
+ prop_id=prop_id,
1048
+ _request_auth=_request_auth,
1049
+ _content_type=_content_type,
1050
+ _headers=_headers,
1051
+ _host_index=_host_index
1052
+ )
1053
+
1054
+ _response_types_map: Dict[str, Optional[str]] = {
1055
+ '200': "PropPublishStatus",
1056
+ '401': "Error",
1057
+ '403': "Error",
1058
+ '404': "Error",
1059
+ }
1060
+ response_data = await self.api_client.call_api(
1061
+ *_param,
1062
+ _request_timeout=_request_timeout
1063
+ )
1064
+ return response_data.response
1065
+
1066
+
1067
+ def _get_prop_publish_status_serialize(
1068
+ self,
1069
+ prop_id,
1070
+ _request_auth,
1071
+ _content_type,
1072
+ _headers,
1073
+ _host_index,
1074
+ ) -> RequestSerialized:
1075
+
1076
+ _host = None
1077
+
1078
+ _collection_formats: Dict[str, str] = {
1079
+ }
1080
+
1081
+ _path_params: Dict[str, str] = {}
1082
+ _query_params: List[Tuple[str, str]] = []
1083
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1084
+ _form_params: List[Tuple[str, str]] = []
1085
+ _files: Dict[
1086
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1087
+ ] = {}
1088
+ _body_params: Optional[bytes] = None
1089
+
1090
+ # process the path parameters
1091
+ if prop_id is not None:
1092
+ _path_params['propId'] = prop_id
1093
+ # process the query parameters
1094
+ # process the header parameters
1095
+ # process the form parameters
1096
+ # process the body parameter
1097
+
1098
+
1099
+ # set the HTTP header `Accept`
1100
+ if 'Accept' not in _header_params:
1101
+ _header_params['Accept'] = self.api_client.select_header_accept(
1102
+ [
1103
+ 'application/json'
1104
+ ]
1105
+ )
1106
+
1107
+
1108
+ # authentication setting
1109
+ _auth_settings: List[str] = [
1110
+ 'authCookie'
1111
+ ]
1112
+
1113
+ return self.api_client.param_serialize(
1114
+ method='GET',
1115
+ resource_path='/props/{propId}/publish',
1116
+ path_params=_path_params,
1117
+ query_params=_query_params,
1118
+ header_params=_header_params,
1119
+ body=_body_params,
1120
+ post_params=_form_params,
1121
+ files=_files,
1122
+ auth_settings=_auth_settings,
1123
+ collection_formats=_collection_formats,
1124
+ _host=_host,
1125
+ _request_auth=_request_auth
1126
+ )
1127
+
1128
+
1129
+
1130
+
1131
+ @validate_call
1132
+ async def list_props(
1133
+ self,
1134
+ author_id: Annotated[StrictStr, Field(description="Must be a valid user ID.")],
1135
+ n: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="The number of objects to return.")] = None,
1136
+ offset: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="A zero-based offset from the default object sorting from where search results start.")] = None,
1137
+ _request_timeout: Union[
1138
+ None,
1139
+ Annotated[StrictFloat, Field(gt=0)],
1140
+ Tuple[
1141
+ Annotated[StrictFloat, Field(gt=0)],
1142
+ Annotated[StrictFloat, Field(gt=0)]
1143
+ ]
1144
+ ] = None,
1145
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1146
+ _content_type: Optional[StrictStr] = None,
1147
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1148
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1149
+ ) -> List[Prop]:
1150
+ """List Props
1151
+
1152
+ Returns a list Prop objects.
1153
+
1154
+ :param author_id: Must be a valid user ID. (required)
1155
+ :type author_id: str
1156
+ :param n: The number of objects to return.
1157
+ :type n: int
1158
+ :param offset: A zero-based offset from the default object sorting from where search results start.
1159
+ :type offset: int
1160
+ :param _request_timeout: timeout setting for this request. If one
1161
+ number provided, it will be total request
1162
+ timeout. It can also be a pair (tuple) of
1163
+ (connection, read) timeouts.
1164
+ :type _request_timeout: int, tuple(int, int), optional
1165
+ :param _request_auth: set to override the auth_settings for an a single
1166
+ request; this effectively ignores the
1167
+ authentication in the spec for a single request.
1168
+ :type _request_auth: dict, optional
1169
+ :param _content_type: force content-type for the request.
1170
+ :type _content_type: str, Optional
1171
+ :param _headers: set to override the headers for a single
1172
+ request; this effectively ignores the headers
1173
+ in the spec for a single request.
1174
+ :type _headers: dict, optional
1175
+ :param _host_index: set to override the host_index for a single
1176
+ request; this effectively ignores the host_index
1177
+ in the spec for a single request.
1178
+ :type _host_index: int, optional
1179
+ :return: Returns the result object.
1180
+ """ # noqa: E501
1181
+
1182
+ _param = self._list_props_serialize(
1183
+ author_id=author_id,
1184
+ n=n,
1185
+ offset=offset,
1186
+ _request_auth=_request_auth,
1187
+ _content_type=_content_type,
1188
+ _headers=_headers,
1189
+ _host_index=_host_index
1190
+ )
1191
+
1192
+ _response_types_map: Dict[str, Optional[str]] = {
1193
+ '200': "List[Prop]",
1194
+ '401': "Error",
1195
+ '403': "Error",
1196
+ }
1197
+ response_data = await self.api_client.call_api(
1198
+ *_param,
1199
+ _request_timeout=_request_timeout
1200
+ )
1201
+ await response_data.read()
1202
+ return self.api_client.response_deserialize(
1203
+ response_data=response_data,
1204
+ response_types_map=_response_types_map,
1205
+ ).data
1206
+
1207
+
1208
+ @validate_call
1209
+ async def list_props_with_http_info(
1210
+ self,
1211
+ author_id: Annotated[StrictStr, Field(description="Must be a valid user ID.")],
1212
+ n: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="The number of objects to return.")] = None,
1213
+ offset: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="A zero-based offset from the default object sorting from where search results start.")] = None,
1214
+ _request_timeout: Union[
1215
+ None,
1216
+ Annotated[StrictFloat, Field(gt=0)],
1217
+ Tuple[
1218
+ Annotated[StrictFloat, Field(gt=0)],
1219
+ Annotated[StrictFloat, Field(gt=0)]
1220
+ ]
1221
+ ] = None,
1222
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1223
+ _content_type: Optional[StrictStr] = None,
1224
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1225
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1226
+ ) -> ApiResponse[List[Prop]]:
1227
+ """List Props
1228
+
1229
+ Returns a list Prop objects.
1230
+
1231
+ :param author_id: Must be a valid user ID. (required)
1232
+ :type author_id: str
1233
+ :param n: The number of objects to return.
1234
+ :type n: int
1235
+ :param offset: A zero-based offset from the default object sorting from where search results start.
1236
+ :type offset: int
1237
+ :param _request_timeout: timeout setting for this request. If one
1238
+ number provided, it will be total request
1239
+ timeout. It can also be a pair (tuple) of
1240
+ (connection, read) timeouts.
1241
+ :type _request_timeout: int, tuple(int, int), optional
1242
+ :param _request_auth: set to override the auth_settings for an a single
1243
+ request; this effectively ignores the
1244
+ authentication in the spec for a single request.
1245
+ :type _request_auth: dict, optional
1246
+ :param _content_type: force content-type for the request.
1247
+ :type _content_type: str, Optional
1248
+ :param _headers: set to override the headers for a single
1249
+ request; this effectively ignores the headers
1250
+ in the spec for a single request.
1251
+ :type _headers: dict, optional
1252
+ :param _host_index: set to override the host_index for a single
1253
+ request; this effectively ignores the host_index
1254
+ in the spec for a single request.
1255
+ :type _host_index: int, optional
1256
+ :return: Returns the result object.
1257
+ """ # noqa: E501
1258
+
1259
+ _param = self._list_props_serialize(
1260
+ author_id=author_id,
1261
+ n=n,
1262
+ offset=offset,
1263
+ _request_auth=_request_auth,
1264
+ _content_type=_content_type,
1265
+ _headers=_headers,
1266
+ _host_index=_host_index
1267
+ )
1268
+
1269
+ _response_types_map: Dict[str, Optional[str]] = {
1270
+ '200': "List[Prop]",
1271
+ '401': "Error",
1272
+ '403': "Error",
1273
+ }
1274
+ response_data = await self.api_client.call_api(
1275
+ *_param,
1276
+ _request_timeout=_request_timeout
1277
+ )
1278
+ await response_data.read()
1279
+ return self.api_client.response_deserialize(
1280
+ response_data=response_data,
1281
+ response_types_map=_response_types_map,
1282
+ )
1283
+
1284
+
1285
+ @validate_call
1286
+ async def list_props_without_preload_content(
1287
+ self,
1288
+ author_id: Annotated[StrictStr, Field(description="Must be a valid user ID.")],
1289
+ n: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="The number of objects to return.")] = None,
1290
+ offset: Annotated[Optional[Annotated[int, Field(strict=True, ge=0)]], Field(description="A zero-based offset from the default object sorting from where search results start.")] = None,
1291
+ _request_timeout: Union[
1292
+ None,
1293
+ Annotated[StrictFloat, Field(gt=0)],
1294
+ Tuple[
1295
+ Annotated[StrictFloat, Field(gt=0)],
1296
+ Annotated[StrictFloat, Field(gt=0)]
1297
+ ]
1298
+ ] = None,
1299
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1300
+ _content_type: Optional[StrictStr] = None,
1301
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1302
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1303
+ ) -> RESTResponseType:
1304
+ """List Props
1305
+
1306
+ Returns a list Prop objects.
1307
+
1308
+ :param author_id: Must be a valid user ID. (required)
1309
+ :type author_id: str
1310
+ :param n: The number of objects to return.
1311
+ :type n: int
1312
+ :param offset: A zero-based offset from the default object sorting from where search results start.
1313
+ :type offset: int
1314
+ :param _request_timeout: timeout setting for this request. If one
1315
+ number provided, it will be total request
1316
+ timeout. It can also be a pair (tuple) of
1317
+ (connection, read) timeouts.
1318
+ :type _request_timeout: int, tuple(int, int), optional
1319
+ :param _request_auth: set to override the auth_settings for an a single
1320
+ request; this effectively ignores the
1321
+ authentication in the spec for a single request.
1322
+ :type _request_auth: dict, optional
1323
+ :param _content_type: force content-type for the request.
1324
+ :type _content_type: str, Optional
1325
+ :param _headers: set to override the headers for a single
1326
+ request; this effectively ignores the headers
1327
+ in the spec for a single request.
1328
+ :type _headers: dict, optional
1329
+ :param _host_index: set to override the host_index for a single
1330
+ request; this effectively ignores the host_index
1331
+ in the spec for a single request.
1332
+ :type _host_index: int, optional
1333
+ :return: Returns the result object.
1334
+ """ # noqa: E501
1335
+
1336
+ _param = self._list_props_serialize(
1337
+ author_id=author_id,
1338
+ n=n,
1339
+ offset=offset,
1340
+ _request_auth=_request_auth,
1341
+ _content_type=_content_type,
1342
+ _headers=_headers,
1343
+ _host_index=_host_index
1344
+ )
1345
+
1346
+ _response_types_map: Dict[str, Optional[str]] = {
1347
+ '200': "List[Prop]",
1348
+ '401': "Error",
1349
+ '403': "Error",
1350
+ }
1351
+ response_data = await self.api_client.call_api(
1352
+ *_param,
1353
+ _request_timeout=_request_timeout
1354
+ )
1355
+ return response_data.response
1356
+
1357
+
1358
+ def _list_props_serialize(
1359
+ self,
1360
+ author_id,
1361
+ n,
1362
+ offset,
1363
+ _request_auth,
1364
+ _content_type,
1365
+ _headers,
1366
+ _host_index,
1367
+ ) -> RequestSerialized:
1368
+
1369
+ _host = None
1370
+
1371
+ _collection_formats: Dict[str, str] = {
1372
+ }
1373
+
1374
+ _path_params: Dict[str, str] = {}
1375
+ _query_params: List[Tuple[str, str]] = []
1376
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1377
+ _form_params: List[Tuple[str, str]] = []
1378
+ _files: Dict[
1379
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1380
+ ] = {}
1381
+ _body_params: Optional[bytes] = None
1382
+
1383
+ # process the path parameters
1384
+ # process the query parameters
1385
+ if n is not None:
1386
+
1387
+ _query_params.append(('n', n))
1388
+
1389
+ if offset is not None:
1390
+
1391
+ _query_params.append(('offset', offset))
1392
+
1393
+ if author_id is not None:
1394
+
1395
+ _query_params.append(('authorId', author_id))
1396
+
1397
+ # process the header parameters
1398
+ # process the form parameters
1399
+ # process the body parameter
1400
+
1401
+
1402
+ # set the HTTP header `Accept`
1403
+ if 'Accept' not in _header_params:
1404
+ _header_params['Accept'] = self.api_client.select_header_accept(
1405
+ [
1406
+ 'application/json'
1407
+ ]
1408
+ )
1409
+
1410
+
1411
+ # authentication setting
1412
+ _auth_settings: List[str] = [
1413
+ 'authCookie'
1414
+ ]
1415
+
1416
+ return self.api_client.param_serialize(
1417
+ method='GET',
1418
+ resource_path='/props',
1419
+ path_params=_path_params,
1420
+ query_params=_query_params,
1421
+ header_params=_header_params,
1422
+ body=_body_params,
1423
+ post_params=_form_params,
1424
+ files=_files,
1425
+ auth_settings=_auth_settings,
1426
+ collection_formats=_collection_formats,
1427
+ _host=_host,
1428
+ _request_auth=_request_auth
1429
+ )
1430
+
1431
+
1432
+
1433
+
1434
+ @validate_call
1435
+ async def publish_prop(
1436
+ self,
1437
+ prop_id: Annotated[StrictStr, Field(description="Prop ID.")],
1438
+ _request_timeout: Union[
1439
+ None,
1440
+ Annotated[StrictFloat, Field(gt=0)],
1441
+ Tuple[
1442
+ Annotated[StrictFloat, Field(gt=0)],
1443
+ Annotated[StrictFloat, Field(gt=0)]
1444
+ ]
1445
+ ] = None,
1446
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1447
+ _content_type: Optional[StrictStr] = None,
1448
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1449
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1450
+ ) -> PropPublishStatus:
1451
+ """Publish Prop
1452
+
1453
+ Publish a Prop and return the updated PropPublishStatus object.
1454
+
1455
+ :param prop_id: Prop ID. (required)
1456
+ :type prop_id: str
1457
+ :param _request_timeout: timeout setting for this request. If one
1458
+ number provided, it will be total request
1459
+ timeout. It can also be a pair (tuple) of
1460
+ (connection, read) timeouts.
1461
+ :type _request_timeout: int, tuple(int, int), optional
1462
+ :param _request_auth: set to override the auth_settings for an a single
1463
+ request; this effectively ignores the
1464
+ authentication in the spec for a single request.
1465
+ :type _request_auth: dict, optional
1466
+ :param _content_type: force content-type for the request.
1467
+ :type _content_type: str, Optional
1468
+ :param _headers: set to override the headers for a single
1469
+ request; this effectively ignores the headers
1470
+ in the spec for a single request.
1471
+ :type _headers: dict, optional
1472
+ :param _host_index: set to override the host_index for a single
1473
+ request; this effectively ignores the host_index
1474
+ in the spec for a single request.
1475
+ :type _host_index: int, optional
1476
+ :return: Returns the result object.
1477
+ """ # noqa: E501
1478
+
1479
+ _param = self._publish_prop_serialize(
1480
+ prop_id=prop_id,
1481
+ _request_auth=_request_auth,
1482
+ _content_type=_content_type,
1483
+ _headers=_headers,
1484
+ _host_index=_host_index
1485
+ )
1486
+
1487
+ _response_types_map: Dict[str, Optional[str]] = {
1488
+ '200': "PropPublishStatus",
1489
+ '401': "Error",
1490
+ '403': "Error",
1491
+ '404': "Error",
1492
+ }
1493
+ response_data = await self.api_client.call_api(
1494
+ *_param,
1495
+ _request_timeout=_request_timeout
1496
+ )
1497
+ await response_data.read()
1498
+ return self.api_client.response_deserialize(
1499
+ response_data=response_data,
1500
+ response_types_map=_response_types_map,
1501
+ ).data
1502
+
1503
+
1504
+ @validate_call
1505
+ async def publish_prop_with_http_info(
1506
+ self,
1507
+ prop_id: Annotated[StrictStr, Field(description="Prop ID.")],
1508
+ _request_timeout: Union[
1509
+ None,
1510
+ Annotated[StrictFloat, Field(gt=0)],
1511
+ Tuple[
1512
+ Annotated[StrictFloat, Field(gt=0)],
1513
+ Annotated[StrictFloat, Field(gt=0)]
1514
+ ]
1515
+ ] = None,
1516
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1517
+ _content_type: Optional[StrictStr] = None,
1518
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1519
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1520
+ ) -> ApiResponse[PropPublishStatus]:
1521
+ """Publish Prop
1522
+
1523
+ Publish a Prop and return the updated PropPublishStatus object.
1524
+
1525
+ :param prop_id: Prop ID. (required)
1526
+ :type prop_id: str
1527
+ :param _request_timeout: timeout setting for this request. If one
1528
+ number provided, it will be total request
1529
+ timeout. It can also be a pair (tuple) of
1530
+ (connection, read) timeouts.
1531
+ :type _request_timeout: int, tuple(int, int), optional
1532
+ :param _request_auth: set to override the auth_settings for an a single
1533
+ request; this effectively ignores the
1534
+ authentication in the spec for a single request.
1535
+ :type _request_auth: dict, optional
1536
+ :param _content_type: force content-type for the request.
1537
+ :type _content_type: str, Optional
1538
+ :param _headers: set to override the headers for a single
1539
+ request; this effectively ignores the headers
1540
+ in the spec for a single request.
1541
+ :type _headers: dict, optional
1542
+ :param _host_index: set to override the host_index for a single
1543
+ request; this effectively ignores the host_index
1544
+ in the spec for a single request.
1545
+ :type _host_index: int, optional
1546
+ :return: Returns the result object.
1547
+ """ # noqa: E501
1548
+
1549
+ _param = self._publish_prop_serialize(
1550
+ prop_id=prop_id,
1551
+ _request_auth=_request_auth,
1552
+ _content_type=_content_type,
1553
+ _headers=_headers,
1554
+ _host_index=_host_index
1555
+ )
1556
+
1557
+ _response_types_map: Dict[str, Optional[str]] = {
1558
+ '200': "PropPublishStatus",
1559
+ '401': "Error",
1560
+ '403': "Error",
1561
+ '404': "Error",
1562
+ }
1563
+ response_data = await self.api_client.call_api(
1564
+ *_param,
1565
+ _request_timeout=_request_timeout
1566
+ )
1567
+ await response_data.read()
1568
+ return self.api_client.response_deserialize(
1569
+ response_data=response_data,
1570
+ response_types_map=_response_types_map,
1571
+ )
1572
+
1573
+
1574
+ @validate_call
1575
+ async def publish_prop_without_preload_content(
1576
+ self,
1577
+ prop_id: Annotated[StrictStr, Field(description="Prop ID.")],
1578
+ _request_timeout: Union[
1579
+ None,
1580
+ Annotated[StrictFloat, Field(gt=0)],
1581
+ Tuple[
1582
+ Annotated[StrictFloat, Field(gt=0)],
1583
+ Annotated[StrictFloat, Field(gt=0)]
1584
+ ]
1585
+ ] = None,
1586
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1587
+ _content_type: Optional[StrictStr] = None,
1588
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1589
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1590
+ ) -> RESTResponseType:
1591
+ """Publish Prop
1592
+
1593
+ Publish a Prop and return the updated PropPublishStatus object.
1594
+
1595
+ :param prop_id: Prop ID. (required)
1596
+ :type prop_id: str
1597
+ :param _request_timeout: timeout setting for this request. If one
1598
+ number provided, it will be total request
1599
+ timeout. It can also be a pair (tuple) of
1600
+ (connection, read) timeouts.
1601
+ :type _request_timeout: int, tuple(int, int), optional
1602
+ :param _request_auth: set to override the auth_settings for an a single
1603
+ request; this effectively ignores the
1604
+ authentication in the spec for a single request.
1605
+ :type _request_auth: dict, optional
1606
+ :param _content_type: force content-type for the request.
1607
+ :type _content_type: str, Optional
1608
+ :param _headers: set to override the headers for a single
1609
+ request; this effectively ignores the headers
1610
+ in the spec for a single request.
1611
+ :type _headers: dict, optional
1612
+ :param _host_index: set to override the host_index for a single
1613
+ request; this effectively ignores the host_index
1614
+ in the spec for a single request.
1615
+ :type _host_index: int, optional
1616
+ :return: Returns the result object.
1617
+ """ # noqa: E501
1618
+
1619
+ _param = self._publish_prop_serialize(
1620
+ prop_id=prop_id,
1621
+ _request_auth=_request_auth,
1622
+ _content_type=_content_type,
1623
+ _headers=_headers,
1624
+ _host_index=_host_index
1625
+ )
1626
+
1627
+ _response_types_map: Dict[str, Optional[str]] = {
1628
+ '200': "PropPublishStatus",
1629
+ '401': "Error",
1630
+ '403': "Error",
1631
+ '404': "Error",
1632
+ }
1633
+ response_data = await self.api_client.call_api(
1634
+ *_param,
1635
+ _request_timeout=_request_timeout
1636
+ )
1637
+ return response_data.response
1638
+
1639
+
1640
+ def _publish_prop_serialize(
1641
+ self,
1642
+ prop_id,
1643
+ _request_auth,
1644
+ _content_type,
1645
+ _headers,
1646
+ _host_index,
1647
+ ) -> RequestSerialized:
1648
+
1649
+ _host = None
1650
+
1651
+ _collection_formats: Dict[str, str] = {
1652
+ }
1653
+
1654
+ _path_params: Dict[str, str] = {}
1655
+ _query_params: List[Tuple[str, str]] = []
1656
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1657
+ _form_params: List[Tuple[str, str]] = []
1658
+ _files: Dict[
1659
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1660
+ ] = {}
1661
+ _body_params: Optional[bytes] = None
1662
+
1663
+ # process the path parameters
1664
+ if prop_id is not None:
1665
+ _path_params['propId'] = prop_id
1666
+ # process the query parameters
1667
+ # process the header parameters
1668
+ # process the form parameters
1669
+ # process the body parameter
1670
+
1671
+
1672
+ # set the HTTP header `Accept`
1673
+ if 'Accept' not in _header_params:
1674
+ _header_params['Accept'] = self.api_client.select_header_accept(
1675
+ [
1676
+ 'application/json'
1677
+ ]
1678
+ )
1679
+
1680
+
1681
+ # authentication setting
1682
+ _auth_settings: List[str] = [
1683
+ 'authCookie'
1684
+ ]
1685
+
1686
+ return self.api_client.param_serialize(
1687
+ method='PUT',
1688
+ resource_path='/props/{propId}/publish',
1689
+ path_params=_path_params,
1690
+ query_params=_query_params,
1691
+ header_params=_header_params,
1692
+ body=_body_params,
1693
+ post_params=_form_params,
1694
+ files=_files,
1695
+ auth_settings=_auth_settings,
1696
+ collection_formats=_collection_formats,
1697
+ _host=_host,
1698
+ _request_auth=_request_auth
1699
+ )
1700
+
1701
+
1702
+
1703
+
1704
+ @validate_call
1705
+ async def unpublish_prop(
1706
+ self,
1707
+ prop_id: Annotated[StrictStr, Field(description="Prop ID.")],
1708
+ _request_timeout: Union[
1709
+ None,
1710
+ Annotated[StrictFloat, Field(gt=0)],
1711
+ Tuple[
1712
+ Annotated[StrictFloat, Field(gt=0)],
1713
+ Annotated[StrictFloat, Field(gt=0)]
1714
+ ]
1715
+ ] = None,
1716
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1717
+ _content_type: Optional[StrictStr] = None,
1718
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1719
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1720
+ ) -> PropPublishStatus:
1721
+ """Unpublish Prop
1722
+
1723
+ Unpublish a Prop and return the updated PropPublishStatus object.
1724
+
1725
+ :param prop_id: Prop ID. (required)
1726
+ :type prop_id: str
1727
+ :param _request_timeout: timeout setting for this request. If one
1728
+ number provided, it will be total request
1729
+ timeout. It can also be a pair (tuple) of
1730
+ (connection, read) timeouts.
1731
+ :type _request_timeout: int, tuple(int, int), optional
1732
+ :param _request_auth: set to override the auth_settings for an a single
1733
+ request; this effectively ignores the
1734
+ authentication in the spec for a single request.
1735
+ :type _request_auth: dict, optional
1736
+ :param _content_type: force content-type for the request.
1737
+ :type _content_type: str, Optional
1738
+ :param _headers: set to override the headers for a single
1739
+ request; this effectively ignores the headers
1740
+ in the spec for a single request.
1741
+ :type _headers: dict, optional
1742
+ :param _host_index: set to override the host_index for a single
1743
+ request; this effectively ignores the host_index
1744
+ in the spec for a single request.
1745
+ :type _host_index: int, optional
1746
+ :return: Returns the result object.
1747
+ """ # noqa: E501
1748
+
1749
+ _param = self._unpublish_prop_serialize(
1750
+ prop_id=prop_id,
1751
+ _request_auth=_request_auth,
1752
+ _content_type=_content_type,
1753
+ _headers=_headers,
1754
+ _host_index=_host_index
1755
+ )
1756
+
1757
+ _response_types_map: Dict[str, Optional[str]] = {
1758
+ '200': "PropPublishStatus",
1759
+ '401': "Error",
1760
+ '403': "Error",
1761
+ '404': "Error",
1762
+ }
1763
+ response_data = await self.api_client.call_api(
1764
+ *_param,
1765
+ _request_timeout=_request_timeout
1766
+ )
1767
+ await response_data.read()
1768
+ return self.api_client.response_deserialize(
1769
+ response_data=response_data,
1770
+ response_types_map=_response_types_map,
1771
+ ).data
1772
+
1773
+
1774
+ @validate_call
1775
+ async def unpublish_prop_with_http_info(
1776
+ self,
1777
+ prop_id: Annotated[StrictStr, Field(description="Prop ID.")],
1778
+ _request_timeout: Union[
1779
+ None,
1780
+ Annotated[StrictFloat, Field(gt=0)],
1781
+ Tuple[
1782
+ Annotated[StrictFloat, Field(gt=0)],
1783
+ Annotated[StrictFloat, Field(gt=0)]
1784
+ ]
1785
+ ] = None,
1786
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1787
+ _content_type: Optional[StrictStr] = None,
1788
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1789
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1790
+ ) -> ApiResponse[PropPublishStatus]:
1791
+ """Unpublish Prop
1792
+
1793
+ Unpublish a Prop and return the updated PropPublishStatus object.
1794
+
1795
+ :param prop_id: Prop ID. (required)
1796
+ :type prop_id: str
1797
+ :param _request_timeout: timeout setting for this request. If one
1798
+ number provided, it will be total request
1799
+ timeout. It can also be a pair (tuple) of
1800
+ (connection, read) timeouts.
1801
+ :type _request_timeout: int, tuple(int, int), optional
1802
+ :param _request_auth: set to override the auth_settings for an a single
1803
+ request; this effectively ignores the
1804
+ authentication in the spec for a single request.
1805
+ :type _request_auth: dict, optional
1806
+ :param _content_type: force content-type for the request.
1807
+ :type _content_type: str, Optional
1808
+ :param _headers: set to override the headers for a single
1809
+ request; this effectively ignores the headers
1810
+ in the spec for a single request.
1811
+ :type _headers: dict, optional
1812
+ :param _host_index: set to override the host_index for a single
1813
+ request; this effectively ignores the host_index
1814
+ in the spec for a single request.
1815
+ :type _host_index: int, optional
1816
+ :return: Returns the result object.
1817
+ """ # noqa: E501
1818
+
1819
+ _param = self._unpublish_prop_serialize(
1820
+ prop_id=prop_id,
1821
+ _request_auth=_request_auth,
1822
+ _content_type=_content_type,
1823
+ _headers=_headers,
1824
+ _host_index=_host_index
1825
+ )
1826
+
1827
+ _response_types_map: Dict[str, Optional[str]] = {
1828
+ '200': "PropPublishStatus",
1829
+ '401': "Error",
1830
+ '403': "Error",
1831
+ '404': "Error",
1832
+ }
1833
+ response_data = await self.api_client.call_api(
1834
+ *_param,
1835
+ _request_timeout=_request_timeout
1836
+ )
1837
+ await response_data.read()
1838
+ return self.api_client.response_deserialize(
1839
+ response_data=response_data,
1840
+ response_types_map=_response_types_map,
1841
+ )
1842
+
1843
+
1844
+ @validate_call
1845
+ async def unpublish_prop_without_preload_content(
1846
+ self,
1847
+ prop_id: Annotated[StrictStr, Field(description="Prop ID.")],
1848
+ _request_timeout: Union[
1849
+ None,
1850
+ Annotated[StrictFloat, Field(gt=0)],
1851
+ Tuple[
1852
+ Annotated[StrictFloat, Field(gt=0)],
1853
+ Annotated[StrictFloat, Field(gt=0)]
1854
+ ]
1855
+ ] = None,
1856
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1857
+ _content_type: Optional[StrictStr] = None,
1858
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1859
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1860
+ ) -> RESTResponseType:
1861
+ """Unpublish Prop
1862
+
1863
+ Unpublish a Prop and return the updated PropPublishStatus object.
1864
+
1865
+ :param prop_id: Prop ID. (required)
1866
+ :type prop_id: str
1867
+ :param _request_timeout: timeout setting for this request. If one
1868
+ number provided, it will be total request
1869
+ timeout. It can also be a pair (tuple) of
1870
+ (connection, read) timeouts.
1871
+ :type _request_timeout: int, tuple(int, int), optional
1872
+ :param _request_auth: set to override the auth_settings for an a single
1873
+ request; this effectively ignores the
1874
+ authentication in the spec for a single request.
1875
+ :type _request_auth: dict, optional
1876
+ :param _content_type: force content-type for the request.
1877
+ :type _content_type: str, Optional
1878
+ :param _headers: set to override the headers for a single
1879
+ request; this effectively ignores the headers
1880
+ in the spec for a single request.
1881
+ :type _headers: dict, optional
1882
+ :param _host_index: set to override the host_index for a single
1883
+ request; this effectively ignores the host_index
1884
+ in the spec for a single request.
1885
+ :type _host_index: int, optional
1886
+ :return: Returns the result object.
1887
+ """ # noqa: E501
1888
+
1889
+ _param = self._unpublish_prop_serialize(
1890
+ prop_id=prop_id,
1891
+ _request_auth=_request_auth,
1892
+ _content_type=_content_type,
1893
+ _headers=_headers,
1894
+ _host_index=_host_index
1895
+ )
1896
+
1897
+ _response_types_map: Dict[str, Optional[str]] = {
1898
+ '200': "PropPublishStatus",
1899
+ '401': "Error",
1900
+ '403': "Error",
1901
+ '404': "Error",
1902
+ }
1903
+ response_data = await self.api_client.call_api(
1904
+ *_param,
1905
+ _request_timeout=_request_timeout
1906
+ )
1907
+ return response_data.response
1908
+
1909
+
1910
+ def _unpublish_prop_serialize(
1911
+ self,
1912
+ prop_id,
1913
+ _request_auth,
1914
+ _content_type,
1915
+ _headers,
1916
+ _host_index,
1917
+ ) -> RequestSerialized:
1918
+
1919
+ _host = None
1920
+
1921
+ _collection_formats: Dict[str, str] = {
1922
+ }
1923
+
1924
+ _path_params: Dict[str, str] = {}
1925
+ _query_params: List[Tuple[str, str]] = []
1926
+ _header_params: Dict[str, Optional[str]] = _headers or {}
1927
+ _form_params: List[Tuple[str, str]] = []
1928
+ _files: Dict[
1929
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
1930
+ ] = {}
1931
+ _body_params: Optional[bytes] = None
1932
+
1933
+ # process the path parameters
1934
+ if prop_id is not None:
1935
+ _path_params['propId'] = prop_id
1936
+ # process the query parameters
1937
+ # process the header parameters
1938
+ # process the form parameters
1939
+ # process the body parameter
1940
+
1941
+
1942
+ # set the HTTP header `Accept`
1943
+ if 'Accept' not in _header_params:
1944
+ _header_params['Accept'] = self.api_client.select_header_accept(
1945
+ [
1946
+ 'application/json'
1947
+ ]
1948
+ )
1949
+
1950
+
1951
+ # authentication setting
1952
+ _auth_settings: List[str] = [
1953
+ 'authCookie'
1954
+ ]
1955
+
1956
+ return self.api_client.param_serialize(
1957
+ method='DELETE',
1958
+ resource_path='/props/{propId}/publish',
1959
+ path_params=_path_params,
1960
+ query_params=_query_params,
1961
+ header_params=_header_params,
1962
+ body=_body_params,
1963
+ post_params=_form_params,
1964
+ files=_files,
1965
+ auth_settings=_auth_settings,
1966
+ collection_formats=_collection_formats,
1967
+ _host=_host,
1968
+ _request_auth=_request_auth
1969
+ )
1970
+
1971
+
1972
+
1973
+
1974
+ @validate_call
1975
+ async def update_prop(
1976
+ self,
1977
+ prop_id: Annotated[StrictStr, Field(description="Prop ID.")],
1978
+ update_prop_request: UpdatePropRequest,
1979
+ _request_timeout: Union[
1980
+ None,
1981
+ Annotated[StrictFloat, Field(gt=0)],
1982
+ Tuple[
1983
+ Annotated[StrictFloat, Field(gt=0)],
1984
+ Annotated[StrictFloat, Field(gt=0)]
1985
+ ]
1986
+ ] = None,
1987
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
1988
+ _content_type: Optional[StrictStr] = None,
1989
+ _headers: Optional[Dict[StrictStr, Any]] = None,
1990
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
1991
+ ) -> Prop:
1992
+ """Update Prop
1993
+
1994
+ Updates a Prop and returns the updated Prop object. When updating the asset bundle, all of `name`, `assetUrl`, `platform`, `unityVersion`, `assetVersion`, `spawnType`, and `worldPlacementMask` must be present, as well as `propSignature` if this value is not blank.
1995
+
1996
+ :param prop_id: Prop ID. (required)
1997
+ :type prop_id: str
1998
+ :param update_prop_request: (required)
1999
+ :type update_prop_request: UpdatePropRequest
2000
+ :param _request_timeout: timeout setting for this request. If one
2001
+ number provided, it will be total request
2002
+ timeout. It can also be a pair (tuple) of
2003
+ (connection, read) timeouts.
2004
+ :type _request_timeout: int, tuple(int, int), optional
2005
+ :param _request_auth: set to override the auth_settings for an a single
2006
+ request; this effectively ignores the
2007
+ authentication in the spec for a single request.
2008
+ :type _request_auth: dict, optional
2009
+ :param _content_type: force content-type for the request.
2010
+ :type _content_type: str, Optional
2011
+ :param _headers: set to override the headers for a single
2012
+ request; this effectively ignores the headers
2013
+ in the spec for a single request.
2014
+ :type _headers: dict, optional
2015
+ :param _host_index: set to override the host_index for a single
2016
+ request; this effectively ignores the host_index
2017
+ in the spec for a single request.
2018
+ :type _host_index: int, optional
2019
+ :return: Returns the result object.
2020
+ """ # noqa: E501
2021
+
2022
+ _param = self._update_prop_serialize(
2023
+ prop_id=prop_id,
2024
+ update_prop_request=update_prop_request,
2025
+ _request_auth=_request_auth,
2026
+ _content_type=_content_type,
2027
+ _headers=_headers,
2028
+ _host_index=_host_index
2029
+ )
2030
+
2031
+ _response_types_map: Dict[str, Optional[str]] = {
2032
+ '200': "Prop",
2033
+ '401': "Error",
2034
+ '403': "Error",
2035
+ '404': "Error",
2036
+ }
2037
+ response_data = await self.api_client.call_api(
2038
+ *_param,
2039
+ _request_timeout=_request_timeout
2040
+ )
2041
+ await response_data.read()
2042
+ return self.api_client.response_deserialize(
2043
+ response_data=response_data,
2044
+ response_types_map=_response_types_map,
2045
+ ).data
2046
+
2047
+
2048
+ @validate_call
2049
+ async def update_prop_with_http_info(
2050
+ self,
2051
+ prop_id: Annotated[StrictStr, Field(description="Prop ID.")],
2052
+ update_prop_request: UpdatePropRequest,
2053
+ _request_timeout: Union[
2054
+ None,
2055
+ Annotated[StrictFloat, Field(gt=0)],
2056
+ Tuple[
2057
+ Annotated[StrictFloat, Field(gt=0)],
2058
+ Annotated[StrictFloat, Field(gt=0)]
2059
+ ]
2060
+ ] = None,
2061
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2062
+ _content_type: Optional[StrictStr] = None,
2063
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2064
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2065
+ ) -> ApiResponse[Prop]:
2066
+ """Update Prop
2067
+
2068
+ Updates a Prop and returns the updated Prop object. When updating the asset bundle, all of `name`, `assetUrl`, `platform`, `unityVersion`, `assetVersion`, `spawnType`, and `worldPlacementMask` must be present, as well as `propSignature` if this value is not blank.
2069
+
2070
+ :param prop_id: Prop ID. (required)
2071
+ :type prop_id: str
2072
+ :param update_prop_request: (required)
2073
+ :type update_prop_request: UpdatePropRequest
2074
+ :param _request_timeout: timeout setting for this request. If one
2075
+ number provided, it will be total request
2076
+ timeout. It can also be a pair (tuple) of
2077
+ (connection, read) timeouts.
2078
+ :type _request_timeout: int, tuple(int, int), optional
2079
+ :param _request_auth: set to override the auth_settings for an a single
2080
+ request; this effectively ignores the
2081
+ authentication in the spec for a single request.
2082
+ :type _request_auth: dict, optional
2083
+ :param _content_type: force content-type for the request.
2084
+ :type _content_type: str, Optional
2085
+ :param _headers: set to override the headers for a single
2086
+ request; this effectively ignores the headers
2087
+ in the spec for a single request.
2088
+ :type _headers: dict, optional
2089
+ :param _host_index: set to override the host_index for a single
2090
+ request; this effectively ignores the host_index
2091
+ in the spec for a single request.
2092
+ :type _host_index: int, optional
2093
+ :return: Returns the result object.
2094
+ """ # noqa: E501
2095
+
2096
+ _param = self._update_prop_serialize(
2097
+ prop_id=prop_id,
2098
+ update_prop_request=update_prop_request,
2099
+ _request_auth=_request_auth,
2100
+ _content_type=_content_type,
2101
+ _headers=_headers,
2102
+ _host_index=_host_index
2103
+ )
2104
+
2105
+ _response_types_map: Dict[str, Optional[str]] = {
2106
+ '200': "Prop",
2107
+ '401': "Error",
2108
+ '403': "Error",
2109
+ '404': "Error",
2110
+ }
2111
+ response_data = await self.api_client.call_api(
2112
+ *_param,
2113
+ _request_timeout=_request_timeout
2114
+ )
2115
+ await response_data.read()
2116
+ return self.api_client.response_deserialize(
2117
+ response_data=response_data,
2118
+ response_types_map=_response_types_map,
2119
+ )
2120
+
2121
+
2122
+ @validate_call
2123
+ async def update_prop_without_preload_content(
2124
+ self,
2125
+ prop_id: Annotated[StrictStr, Field(description="Prop ID.")],
2126
+ update_prop_request: UpdatePropRequest,
2127
+ _request_timeout: Union[
2128
+ None,
2129
+ Annotated[StrictFloat, Field(gt=0)],
2130
+ Tuple[
2131
+ Annotated[StrictFloat, Field(gt=0)],
2132
+ Annotated[StrictFloat, Field(gt=0)]
2133
+ ]
2134
+ ] = None,
2135
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
2136
+ _content_type: Optional[StrictStr] = None,
2137
+ _headers: Optional[Dict[StrictStr, Any]] = None,
2138
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
2139
+ ) -> RESTResponseType:
2140
+ """Update Prop
2141
+
2142
+ Updates a Prop and returns the updated Prop object. When updating the asset bundle, all of `name`, `assetUrl`, `platform`, `unityVersion`, `assetVersion`, `spawnType`, and `worldPlacementMask` must be present, as well as `propSignature` if this value is not blank.
2143
+
2144
+ :param prop_id: Prop ID. (required)
2145
+ :type prop_id: str
2146
+ :param update_prop_request: (required)
2147
+ :type update_prop_request: UpdatePropRequest
2148
+ :param _request_timeout: timeout setting for this request. If one
2149
+ number provided, it will be total request
2150
+ timeout. It can also be a pair (tuple) of
2151
+ (connection, read) timeouts.
2152
+ :type _request_timeout: int, tuple(int, int), optional
2153
+ :param _request_auth: set to override the auth_settings for an a single
2154
+ request; this effectively ignores the
2155
+ authentication in the spec for a single request.
2156
+ :type _request_auth: dict, optional
2157
+ :param _content_type: force content-type for the request.
2158
+ :type _content_type: str, Optional
2159
+ :param _headers: set to override the headers for a single
2160
+ request; this effectively ignores the headers
2161
+ in the spec for a single request.
2162
+ :type _headers: dict, optional
2163
+ :param _host_index: set to override the host_index for a single
2164
+ request; this effectively ignores the host_index
2165
+ in the spec for a single request.
2166
+ :type _host_index: int, optional
2167
+ :return: Returns the result object.
2168
+ """ # noqa: E501
2169
+
2170
+ _param = self._update_prop_serialize(
2171
+ prop_id=prop_id,
2172
+ update_prop_request=update_prop_request,
2173
+ _request_auth=_request_auth,
2174
+ _content_type=_content_type,
2175
+ _headers=_headers,
2176
+ _host_index=_host_index
2177
+ )
2178
+
2179
+ _response_types_map: Dict[str, Optional[str]] = {
2180
+ '200': "Prop",
2181
+ '401': "Error",
2182
+ '403': "Error",
2183
+ '404': "Error",
2184
+ }
2185
+ response_data = await self.api_client.call_api(
2186
+ *_param,
2187
+ _request_timeout=_request_timeout
2188
+ )
2189
+ return response_data.response
2190
+
2191
+
2192
+ def _update_prop_serialize(
2193
+ self,
2194
+ prop_id,
2195
+ update_prop_request,
2196
+ _request_auth,
2197
+ _content_type,
2198
+ _headers,
2199
+ _host_index,
2200
+ ) -> RequestSerialized:
2201
+
2202
+ _host = None
2203
+
2204
+ _collection_formats: Dict[str, str] = {
2205
+ }
2206
+
2207
+ _path_params: Dict[str, str] = {}
2208
+ _query_params: List[Tuple[str, str]] = []
2209
+ _header_params: Dict[str, Optional[str]] = _headers or {}
2210
+ _form_params: List[Tuple[str, str]] = []
2211
+ _files: Dict[
2212
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
2213
+ ] = {}
2214
+ _body_params: Optional[bytes] = None
2215
+
2216
+ # process the path parameters
2217
+ if prop_id is not None:
2218
+ _path_params['propId'] = prop_id
2219
+ # process the query parameters
2220
+ # process the header parameters
2221
+ # process the form parameters
2222
+ # process the body parameter
2223
+ if update_prop_request is not None:
2224
+ _body_params = update_prop_request
2225
+
2226
+
2227
+ # set the HTTP header `Accept`
2228
+ if 'Accept' not in _header_params:
2229
+ _header_params['Accept'] = self.api_client.select_header_accept(
2230
+ [
2231
+ 'application/json'
2232
+ ]
2233
+ )
2234
+
2235
+ # set the HTTP header `Content-Type`
2236
+ if _content_type:
2237
+ _header_params['Content-Type'] = _content_type
2238
+ else:
2239
+ _default_content_type = (
2240
+ self.api_client.select_header_content_type(
2241
+ [
2242
+ 'application/json'
2243
+ ]
2244
+ )
2245
+ )
2246
+ if _default_content_type is not None:
2247
+ _header_params['Content-Type'] = _default_content_type
2248
+
2249
+ # authentication setting
2250
+ _auth_settings: List[str] = [
2251
+ 'authCookie'
2252
+ ]
2253
+
2254
+ return self.api_client.param_serialize(
2255
+ method='PUT',
2256
+ resource_path='/props/{propId}',
2257
+ path_params=_path_params,
2258
+ query_params=_query_params,
2259
+ header_params=_header_params,
2260
+ body=_body_params,
2261
+ post_params=_form_params,
2262
+ files=_files,
2263
+ auth_settings=_auth_settings,
2264
+ collection_formats=_collection_formats,
2265
+ _host=_host,
2266
+ _request_auth=_request_auth
2267
+ )
2268
+
2269
+