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.
- vrchatapi/__init__.py +742 -0
- vrchatapi/api/__init__.py +23 -0
- vrchatapi/api/authentication_api.py +6253 -0
- vrchatapi/api/avatars_api.py +4234 -0
- vrchatapi/api/calendar_api.py +4090 -0
- vrchatapi/api/economy_api.py +11547 -0
- vrchatapi/api/favorites_api.py +2368 -0
- vrchatapi/api/files_api.py +6109 -0
- vrchatapi/api/friends_api.py +1708 -0
- vrchatapi/api/groups_api.py +15085 -0
- vrchatapi/api/instances_api.py +1754 -0
- vrchatapi/api/inventory_api.py +4333 -0
- vrchatapi/api/invite_api.py +3337 -0
- vrchatapi/api/jams_api.py +1446 -0
- vrchatapi/api/miscellaneous_api.py +2384 -0
- vrchatapi/api/notifications_api.py +3624 -0
- vrchatapi/api/playermoderation_api.py +1127 -0
- vrchatapi/api/prints_api.py +1478 -0
- vrchatapi/api/props_api.py +2269 -0
- vrchatapi/api/users_api.py +7894 -0
- vrchatapi/api/worlds_api.py +6153 -0
- vrchatapi/api_client.py +865 -0
- vrchatapi/api_response.py +21 -0
- vrchatapi/configuration.py +686 -0
- vrchatapi/exceptions.py +218 -0
- vrchatapi/models/__init__.py +345 -0
- vrchatapi/models/account_deletion_log.py +253 -0
- vrchatapi/models/add_favorite_request.py +246 -0
- vrchatapi/models/add_group_gallery_image_request.py +234 -0
- vrchatapi/models/admin_asset_bundle.py +337 -0
- vrchatapi/models/admin_unity_package.py +261 -0
- vrchatapi/models/age_verification_status.py +38 -0
- vrchatapi/models/agreement.py +280 -0
- vrchatapi/models/agreement_code.py +36 -0
- vrchatapi/models/agreement_request.py +256 -0
- vrchatapi/models/agreement_status.py +261 -0
- vrchatapi/models/api_config.py +1299 -0
- vrchatapi/models/api_config_access_logs_urls.py +258 -0
- vrchatapi/models/api_config_announcement.py +217 -0
- vrchatapi/models/api_config_audio_config.py +311 -0
- vrchatapi/models/api_config_avatar_perf_limiter.py +293 -0
- vrchatapi/models/api_config_constants.py +262 -0
- vrchatapi/models/api_config_constants_groups.py +306 -0
- vrchatapi/models/api_config_constants_instance.py +238 -0
- vrchatapi/models/api_config_constants_instancepopulationbrackets.py +262 -0
- vrchatapi/models/api_config_constants_instancepopulationbracketscrowded.py +216 -0
- vrchatapi/models/api_config_constants_instancepopulationbracketsfew.py +216 -0
- vrchatapi/models/api_config_constants_instancepopulationbracketsmany.py +216 -0
- vrchatapi/models/api_config_constants_language.py +234 -0
- vrchatapi/models/api_config_download_url_list.py +258 -0
- vrchatapi/models/api_config_events.py +314 -0
- vrchatapi/models/api_config_ios_version.py +216 -0
- vrchatapi/models/api_config_min_supported_client_build_number.py +348 -0
- vrchatapi/models/api_config_offline_analysis.py +216 -0
- vrchatapi/models/api_health.py +248 -0
- vrchatapi/models/avatar.py +463 -0
- vrchatapi/models/avatar_moderation.py +249 -0
- vrchatapi/models/avatar_moderation_created.py +248 -0
- vrchatapi/models/avatar_moderation_type.py +36 -0
- vrchatapi/models/avatar_performance.py +265 -0
- vrchatapi/models/avatar_published_listings_inner.py +271 -0
- vrchatapi/models/avatar_style.py +239 -0
- vrchatapi/models/avatar_styles.py +231 -0
- vrchatapi/models/avatar_unity_package_url_object.py +234 -0
- vrchatapi/models/badge.py +308 -0
- vrchatapi/models/balance.py +247 -0
- vrchatapi/models/ban_group_member_request.py +234 -0
- vrchatapi/models/boop_request.py +250 -0
- vrchatapi/models/calendar_day_of_week.py +42 -0
- vrchatapi/models/calendar_event.py +475 -0
- vrchatapi/models/calendar_event_access.py +37 -0
- vrchatapi/models/calendar_event_category.py +48 -0
- vrchatapi/models/calendar_event_discovery.py +247 -0
- vrchatapi/models/calendar_event_discovery_inclusion.py +38 -0
- vrchatapi/models/calendar_event_discovery_scope.py +38 -0
- vrchatapi/models/calendar_event_frequency.py +39 -0
- vrchatapi/models/calendar_event_occurrence_kind.py +38 -0
- vrchatapi/models/calendar_event_platform.py +38 -0
- vrchatapi/models/calendar_event_recurrence.py +261 -0
- vrchatapi/models/calendar_event_recurrence_end.py +246 -0
- vrchatapi/models/calendar_event_recurrence_end_type.py +37 -0
- vrchatapi/models/calendar_event_user_interest.py +251 -0
- vrchatapi/models/change_user_tags_request.py +212 -0
- vrchatapi/models/change_world_tags_request.py +212 -0
- vrchatapi/models/content_filter.py +40 -0
- vrchatapi/models/create_avatar_moderation_request.py +243 -0
- vrchatapi/models/create_avatar_request.py +324 -0
- vrchatapi/models/create_calendar_event_request.py +385 -0
- vrchatapi/models/create_file_request.py +251 -0
- vrchatapi/models/create_file_version_request.py +259 -0
- vrchatapi/models/create_group_announcement_request.py +253 -0
- vrchatapi/models/create_group_gallery_request.py +297 -0
- vrchatapi/models/create_group_invite_request.py +242 -0
- vrchatapi/models/create_group_post_request.py +267 -0
- vrchatapi/models/create_group_request.py +295 -0
- vrchatapi/models/create_group_role_request.py +255 -0
- vrchatapi/models/create_instance_request.py +384 -0
- vrchatapi/models/create_jam_submission_request.py +239 -0
- vrchatapi/models/create_listing_request.py +285 -0
- vrchatapi/models/create_product_request.py +270 -0
- vrchatapi/models/create_prop_request.py +308 -0
- vrchatapi/models/create_world_request.py +322 -0
- vrchatapi/models/current_user.py +909 -0
- vrchatapi/models/current_user_platform_history_inner.py +245 -0
- vrchatapi/models/current_user_presence.py +379 -0
- vrchatapi/models/decline_group_invite_request.py +211 -0
- vrchatapi/models/developer_type.py +39 -0
- vrchatapi/models/disable2_fa_result.py +211 -0
- vrchatapi/models/discord_details.py +216 -0
- vrchatapi/models/dynamic_content_row.py +276 -0
- vrchatapi/models/earnings_metrics.py +248 -0
- vrchatapi/models/earnings_metrics_totals.py +267 -0
- vrchatapi/models/economy_account.py +360 -0
- vrchatapi/models/economy_balances.py +221 -0
- vrchatapi/models/economy_payout.py +385 -0
- vrchatapi/models/economy_payout_eligibility.py +263 -0
- vrchatapi/models/economy_payout_list.py +219 -0
- vrchatapi/models/economy_payout_status.py +295 -0
- vrchatapi/models/equip_inventory_item_request.py +235 -0
- vrchatapi/models/error.py +215 -0
- vrchatapi/models/favorite.py +251 -0
- vrchatapi/models/favorite_group.py +278 -0
- vrchatapi/models/favorite_group_limits.py +249 -0
- vrchatapi/models/favorite_group_visibility.py +38 -0
- vrchatapi/models/favorite_limits.py +265 -0
- vrchatapi/models/favorite_type.py +39 -0
- vrchatapi/models/favorited_world.py +441 -0
- vrchatapi/models/feedback.py +331 -0
- vrchatapi/models/file.py +325 -0
- vrchatapi/models/file_analysis.py +281 -0
- vrchatapi/models/file_analysis_avatar_stats.py +575 -0
- vrchatapi/models/file_data.py +279 -0
- vrchatapi/models/file_status.py +39 -0
- vrchatapi/models/file_upload_url.py +212 -0
- vrchatapi/models/file_version.py +254 -0
- vrchatapi/models/file_version_upload_status.py +269 -0
- vrchatapi/models/finish_file_data_upload_request.py +248 -0
- vrchatapi/models/follow_calendar_event_request.py +234 -0
- vrchatapi/models/friend_status.py +250 -0
- vrchatapi/models/get_group_posts200_response.py +219 -0
- vrchatapi/models/get_user_group_instances200_response.py +248 -0
- vrchatapi/models/group.py +514 -0
- vrchatapi/models/group_access_type.py +38 -0
- vrchatapi/models/group_announcement.py +315 -0
- vrchatapi/models/group_audit_log_entry.py +287 -0
- vrchatapi/models/group_gallery.py +319 -0
- vrchatapi/models/group_gallery_file_order.py +211 -0
- vrchatapi/models/group_gallery_file_order_request.py +239 -0
- vrchatapi/models/group_gallery_image.py +301 -0
- vrchatapi/models/group_instance.py +257 -0
- vrchatapi/models/group_join_request_action.py +37 -0
- vrchatapi/models/group_join_state.py +39 -0
- vrchatapi/models/group_member.py +415 -0
- vrchatapi/models/group_member_limited_user.py +290 -0
- vrchatapi/models/group_member_status.py +41 -0
- vrchatapi/models/group_my_member.py +399 -0
- vrchatapi/models/group_permission.py +260 -0
- vrchatapi/models/group_permissions.py +63 -0
- vrchatapi/models/group_post.py +317 -0
- vrchatapi/models/group_post_visibility.py +37 -0
- vrchatapi/models/group_privacy.py +37 -0
- vrchatapi/models/group_role.py +309 -0
- vrchatapi/models/group_role_template.py +39 -0
- vrchatapi/models/group_role_template_values.py +254 -0
- vrchatapi/models/group_role_template_values_roles.py +253 -0
- vrchatapi/models/group_search_sort.py +37 -0
- vrchatapi/models/group_transferable.py +215 -0
- vrchatapi/models/group_transferable_requirements.py +266 -0
- vrchatapi/models/group_user_visibility.py +38 -0
- vrchatapi/models/image_animation_style.py +62 -0
- vrchatapi/models/image_loop_style.py +37 -0
- vrchatapi/models/image_mask.py +41 -0
- vrchatapi/models/image_purpose.py +46 -0
- vrchatapi/models/info_push.py +306 -0
- vrchatapi/models/info_push_data.py +288 -0
- vrchatapi/models/info_push_data_article.py +215 -0
- vrchatapi/models/info_push_data_article_content.py +251 -0
- vrchatapi/models/info_push_data_clickable.py +224 -0
- vrchatapi/models/instance.py +597 -0
- vrchatapi/models/instance_content_settings.py +236 -0
- vrchatapi/models/instance_platforms.py +222 -0
- vrchatapi/models/instance_region.py +40 -0
- vrchatapi/models/instance_short_name_response.py +248 -0
- vrchatapi/models/instance_type.py +40 -0
- vrchatapi/models/inventory.py +247 -0
- vrchatapi/models/inventory_consumption_results.py +255 -0
- vrchatapi/models/inventory_default_attributes_value.py +243 -0
- vrchatapi/models/inventory_default_attributes_value_validator.py +211 -0
- vrchatapi/models/inventory_drop.py +331 -0
- vrchatapi/models/inventory_equip_slot.py +39 -0
- vrchatapi/models/inventory_flag.py +43 -0
- vrchatapi/models/inventory_item.py +420 -0
- vrchatapi/models/inventory_item_type.py +42 -0
- vrchatapi/models/inventory_metadata.py +287 -0
- vrchatapi/models/inventory_notification_details.py +244 -0
- vrchatapi/models/inventory_spawn.py +216 -0
- vrchatapi/models/inventory_template.py +351 -0
- vrchatapi/models/inventory_user_attributes.py +250 -0
- vrchatapi/models/invite_message.py +276 -0
- vrchatapi/models/invite_message_type.py +39 -0
- vrchatapi/models/invite_request.py +243 -0
- vrchatapi/models/invite_response.py +235 -0
- vrchatapi/models/jam.py +302 -0
- vrchatapi/models/jam_state_change_dates.py +276 -0
- vrchatapi/models/jam_submission.py +275 -0
- vrchatapi/models/join_group_request.py +234 -0
- vrchatapi/models/license.py +261 -0
- vrchatapi/models/license_action.py +37 -0
- vrchatapi/models/license_group.py +235 -0
- vrchatapi/models/license_type.py +39 -0
- vrchatapi/models/limited_group.py +377 -0
- vrchatapi/models/limited_unity_package.py +251 -0
- vrchatapi/models/limited_user_friend.py +399 -0
- vrchatapi/models/limited_user_groups.py +386 -0
- vrchatapi/models/limited_user_instance.py +430 -0
- vrchatapi/models/limited_user_search.py +395 -0
- vrchatapi/models/limited_world.py +410 -0
- vrchatapi/models/mime_type.py +50 -0
- vrchatapi/models/model_print.py +299 -0
- vrchatapi/models/moderate_user_request.py +217 -0
- vrchatapi/models/moderation_report.py +296 -0
- vrchatapi/models/mutual_friend.py +302 -0
- vrchatapi/models/mutuals.py +217 -0
- vrchatapi/models/notification.py +283 -0
- vrchatapi/models/notification_detail_invite.py +250 -0
- vrchatapi/models/notification_detail_invite_response.py +242 -0
- vrchatapi/models/notification_detail_request_invite.py +239 -0
- vrchatapi/models/notification_detail_request_invite_response.py +242 -0
- vrchatapi/models/notification_detail_vote_to_kick.py +242 -0
- vrchatapi/models/notification_type.py +43 -0
- vrchatapi/models/notification_v2.py +466 -0
- vrchatapi/models/notification_v2_details_boop.py +255 -0
- vrchatapi/models/notification_v2_response.py +259 -0
- vrchatapi/models/notification_v2_type.py +58 -0
- vrchatapi/models/ok_status.py +211 -0
- vrchatapi/models/ok_status2.py +234 -0
- vrchatapi/models/order_option.py +37 -0
- vrchatapi/models/order_option_short.py +37 -0
- vrchatapi/models/paginated_calendar_event_list.py +255 -0
- vrchatapi/models/paginated_group_audit_log_entry_list.py +255 -0
- vrchatapi/models/paginated_moderation_report_list.py +255 -0
- vrchatapi/models/past_display_name.py +241 -0
- vrchatapi/models/pending2_fa_result.py +239 -0
- vrchatapi/models/performance_limiter_info.py +234 -0
- vrchatapi/models/performance_ratings.py +41 -0
- vrchatapi/models/permission.py +280 -0
- vrchatapi/models/permission_data.py +258 -0
- vrchatapi/models/platform_build_info.py +242 -0
- vrchatapi/models/player_moderation.py +276 -0
- vrchatapi/models/player_moderation_type.py +44 -0
- vrchatapi/models/print_files.py +239 -0
- vrchatapi/models/private_profile.py +267 -0
- vrchatapi/models/private_profile_activity.py +292 -0
- vrchatapi/models/product.py +389 -0
- vrchatapi/models/product_listing.py +538 -0
- vrchatapi/models/product_listing_type.py +39 -0
- vrchatapi/models/product_listing_variant.py +272 -0
- vrchatapi/models/product_purchase.py +571 -0
- vrchatapi/models/product_purchase_history.py +256 -0
- vrchatapi/models/product_purchase_location_type.py +46 -0
- vrchatapi/models/product_purchase_product.py +269 -0
- vrchatapi/models/product_purchase_purchase_context.py +250 -0
- vrchatapi/models/product_purchase_record.py +312 -0
- vrchatapi/models/product_type.py +39 -0
- vrchatapi/models/profile_represented_group.py +262 -0
- vrchatapi/models/prop.py +358 -0
- vrchatapi/models/prop_publish_status.py +234 -0
- vrchatapi/models/prop_unity_package.py +269 -0
- vrchatapi/models/public_profile.py +398 -0
- vrchatapi/models/purchase_context_data.py +251 -0
- vrchatapi/models/purchase_product_listing_request.py +281 -0
- vrchatapi/models/region.py +42 -0
- vrchatapi/models/register_user_account_request.py +278 -0
- vrchatapi/models/release_status.py +39 -0
- vrchatapi/models/report_category.py +226 -0
- vrchatapi/models/report_reason.py +216 -0
- vrchatapi/models/represented_group.py +348 -0
- vrchatapi/models/request_invite_request.py +235 -0
- vrchatapi/models/respond_group_join_request.py +217 -0
- vrchatapi/models/respond_notification_v2_request.py +242 -0
- vrchatapi/models/response.py +217 -0
- vrchatapi/models/reward_badge.py +308 -0
- vrchatapi/models/reward_redemption.py +220 -0
- vrchatapi/models/reward_redemption_data.py +224 -0
- vrchatapi/models/reward_redemption_request.py +211 -0
- vrchatapi/models/reward_redemption_result.py +250 -0
- vrchatapi/models/search_group_members200_response.py +224 -0
- vrchatapi/models/seller_eligibility.py +211 -0
- vrchatapi/models/sent_notification.py +278 -0
- vrchatapi/models/service_queue_stats.py +234 -0
- vrchatapi/models/service_status.py +281 -0
- vrchatapi/models/share_inventory_item_direct_request.py +239 -0
- vrchatapi/models/sort_option.py +53 -0
- vrchatapi/models/sort_option_product_purchase.py +36 -0
- vrchatapi/models/store.py +372 -0
- vrchatapi/models/store_context.py +249 -0
- vrchatapi/models/store_shelf.py +304 -0
- vrchatapi/models/store_type.py +38 -0
- vrchatapi/models/store_view.py +40 -0
- vrchatapi/models/submit_moderation_report_request.py +263 -0
- vrchatapi/models/submit_moderation_report_request_details.py +283 -0
- vrchatapi/models/subscription.py +301 -0
- vrchatapi/models/subscription_period.py +40 -0
- vrchatapi/models/success.py +215 -0
- vrchatapi/models/success_flag.py +211 -0
- vrchatapi/models/tilia_kyc.py +246 -0
- vrchatapi/models/tilia_status.py +259 -0
- vrchatapi/models/tilia_tos.py +211 -0
- vrchatapi/models/token_bundle.py +286 -0
- vrchatapi/models/transaction.py +322 -0
- vrchatapi/models/transaction_agreement.py +353 -0
- vrchatapi/models/transaction_status.py +39 -0
- vrchatapi/models/transaction_steam_info.py +271 -0
- vrchatapi/models/transaction_steam_wallet_info.py +227 -0
- vrchatapi/models/transfer_group_request.py +234 -0
- vrchatapi/models/tutorial_status.py +255 -0
- vrchatapi/models/two_factor_auth_code.py +211 -0
- vrchatapi/models/two_factor_email_code.py +211 -0
- vrchatapi/models/two_factor_recovery_codes.py +247 -0
- vrchatapi/models/two_factor_recovery_codes_otp_inner.py +216 -0
- vrchatapi/models/unity_package.py +360 -0
- vrchatapi/models/update_asset_review_notes_request.py +234 -0
- vrchatapi/models/update_avatar_request.py +293 -0
- vrchatapi/models/update_calendar_event_request.py +365 -0
- vrchatapi/models/update_favorite_group_request.py +246 -0
- vrchatapi/models/update_group_gallery_request.py +297 -0
- vrchatapi/models/update_group_member_request.py +256 -0
- vrchatapi/models/update_group_representation_request.py +234 -0
- vrchatapi/models/update_group_request.py +300 -0
- vrchatapi/models/update_group_role_request.py +255 -0
- vrchatapi/models/update_inventory_item_request.py +254 -0
- vrchatapi/models/update_invite_message_request.py +211 -0
- vrchatapi/models/update_listing_request.py +211 -0
- vrchatapi/models/update_product_request.py +261 -0
- vrchatapi/models/update_prop_request.py +303 -0
- vrchatapi/models/update_tilia_tos_request.py +211 -0
- vrchatapi/models/update_user_badge_request.py +216 -0
- vrchatapi/models/update_user_note_request.py +239 -0
- vrchatapi/models/update_user_request.py +358 -0
- vrchatapi/models/update_world_request.py +317 -0
- vrchatapi/models/user.py +549 -0
- vrchatapi/models/user_credits_eligible.py +216 -0
- vrchatapi/models/user_exists.py +242 -0
- vrchatapi/models/user_note.py +273 -0
- vrchatapi/models/user_note_target_user.py +277 -0
- vrchatapi/models/user_state.py +38 -0
- vrchatapi/models/user_status.py +40 -0
- vrchatapi/models/user_subscription.py +330 -0
- vrchatapi/models/user_subscription_eligible.py +274 -0
- vrchatapi/models/verify2_fa_email_code_result.py +211 -0
- vrchatapi/models/verify2_fa_result.py +216 -0
- vrchatapi/models/verify_auth_token_result.py +217 -0
- vrchatapi/models/world.py +459 -0
- vrchatapi/models/world_metadata.py +216 -0
- vrchatapi/models/world_publish_status.py +234 -0
- vrchatapi/py.typed +0 -0
- vrchatapi/rest.py +303 -0
- vrchatapi_async-1.20.8.dev1.dist-info/METADATA +137 -0
- vrchatapi_async-1.20.8.dev1.dist-info/RECORD +362 -0
- vrchatapi_async-1.20.8.dev1.dist-info/WHEEL +5 -0
- vrchatapi_async-1.20.8.dev1.dist-info/licenses/LICENSE +21 -0
- vrchatapi_async-1.20.8.dev1.dist-info/top_level.txt +1 -0
|
@@ -0,0 +1,1754 @@
|
|
|
1
|
+
"""
|
|
2
|
+
VRChat API Documentation
|
|
3
|
+
|
|
4
|
+
|
|
5
|
+
The version of the OpenAPI document: 1.20.8
|
|
6
|
+
Contact: vrchatapi.lpv0t@aries.fyi
|
|
7
|
+
Generated by OpenAPI Generator (https://openapi-generator.tech)
|
|
8
|
+
|
|
9
|
+
Do not edit the class manually.
|
|
10
|
+
""" # noqa: E501
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
import warnings
|
|
14
|
+
from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
|
|
15
|
+
from typing import Any, Dict, List, Optional, Tuple, Union
|
|
16
|
+
from typing_extensions import Annotated
|
|
17
|
+
|
|
18
|
+
from datetime import datetime
|
|
19
|
+
from pydantic import Field, StrictBool, StrictStr
|
|
20
|
+
from typing import List, Optional
|
|
21
|
+
from typing_extensions import Annotated
|
|
22
|
+
from vrchatapi.models.create_instance_request import CreateInstanceRequest
|
|
23
|
+
from vrchatapi.models.instance import Instance
|
|
24
|
+
from vrchatapi.models.instance_short_name_response import InstanceShortNameResponse
|
|
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 InstancesApi:
|
|
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 close_instance(
|
|
46
|
+
self,
|
|
47
|
+
world_id: Annotated[StrictStr, Field(description="Must be a valid world ID.")],
|
|
48
|
+
instance_id: Annotated[StrictStr, Field(description="Must be a valid instance ID.")],
|
|
49
|
+
hard_close: Annotated[Optional[StrictBool], Field(description="Whether to hard close the instance. Defaults to false.")] = None,
|
|
50
|
+
closed_at: Annotated[Optional[datetime], Field(description="The time after which users won't be allowed to join the instances. If omitted, the instance will be closed immediately.")] = None,
|
|
51
|
+
_request_timeout: Union[
|
|
52
|
+
None,
|
|
53
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
54
|
+
Tuple[
|
|
55
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
56
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
57
|
+
]
|
|
58
|
+
] = None,
|
|
59
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
60
|
+
_content_type: Optional[StrictStr] = None,
|
|
61
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
62
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
63
|
+
) -> Instance:
|
|
64
|
+
"""Close Instance
|
|
65
|
+
|
|
66
|
+
Close an instance or update the closedAt time when it will be closed. You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-manage` permission.
|
|
67
|
+
|
|
68
|
+
:param world_id: Must be a valid world ID. (required)
|
|
69
|
+
:type world_id: str
|
|
70
|
+
:param instance_id: Must be a valid instance ID. (required)
|
|
71
|
+
:type instance_id: str
|
|
72
|
+
:param hard_close: Whether to hard close the instance. Defaults to false.
|
|
73
|
+
:type hard_close: bool
|
|
74
|
+
:param closed_at: The time after which users won't be allowed to join the instances. If omitted, the instance will be closed immediately.
|
|
75
|
+
:type closed_at: datetime
|
|
76
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
77
|
+
number provided, it will be total request
|
|
78
|
+
timeout. It can also be a pair (tuple) of
|
|
79
|
+
(connection, read) timeouts.
|
|
80
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
81
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
82
|
+
request; this effectively ignores the
|
|
83
|
+
authentication in the spec for a single request.
|
|
84
|
+
:type _request_auth: dict, optional
|
|
85
|
+
:param _content_type: force content-type for the request.
|
|
86
|
+
:type _content_type: str, Optional
|
|
87
|
+
:param _headers: set to override the headers for a single
|
|
88
|
+
request; this effectively ignores the headers
|
|
89
|
+
in the spec for a single request.
|
|
90
|
+
:type _headers: dict, optional
|
|
91
|
+
:param _host_index: set to override the host_index for a single
|
|
92
|
+
request; this effectively ignores the host_index
|
|
93
|
+
in the spec for a single request.
|
|
94
|
+
:type _host_index: int, optional
|
|
95
|
+
:return: Returns the result object.
|
|
96
|
+
""" # noqa: E501
|
|
97
|
+
|
|
98
|
+
_param = self._close_instance_serialize(
|
|
99
|
+
world_id=world_id,
|
|
100
|
+
instance_id=instance_id,
|
|
101
|
+
hard_close=hard_close,
|
|
102
|
+
closed_at=closed_at,
|
|
103
|
+
_request_auth=_request_auth,
|
|
104
|
+
_content_type=_content_type,
|
|
105
|
+
_headers=_headers,
|
|
106
|
+
_host_index=_host_index
|
|
107
|
+
)
|
|
108
|
+
|
|
109
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
110
|
+
'200': "Instance",
|
|
111
|
+
'401': "Error",
|
|
112
|
+
'403': "Error",
|
|
113
|
+
'404': "Error",
|
|
114
|
+
}
|
|
115
|
+
response_data = await self.api_client.call_api(
|
|
116
|
+
*_param,
|
|
117
|
+
_request_timeout=_request_timeout
|
|
118
|
+
)
|
|
119
|
+
await response_data.read()
|
|
120
|
+
return self.api_client.response_deserialize(
|
|
121
|
+
response_data=response_data,
|
|
122
|
+
response_types_map=_response_types_map,
|
|
123
|
+
).data
|
|
124
|
+
|
|
125
|
+
|
|
126
|
+
@validate_call
|
|
127
|
+
async def close_instance_with_http_info(
|
|
128
|
+
self,
|
|
129
|
+
world_id: Annotated[StrictStr, Field(description="Must be a valid world ID.")],
|
|
130
|
+
instance_id: Annotated[StrictStr, Field(description="Must be a valid instance ID.")],
|
|
131
|
+
hard_close: Annotated[Optional[StrictBool], Field(description="Whether to hard close the instance. Defaults to false.")] = None,
|
|
132
|
+
closed_at: Annotated[Optional[datetime], Field(description="The time after which users won't be allowed to join the instances. If omitted, the instance will be closed immediately.")] = None,
|
|
133
|
+
_request_timeout: Union[
|
|
134
|
+
None,
|
|
135
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
136
|
+
Tuple[
|
|
137
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
138
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
139
|
+
]
|
|
140
|
+
] = None,
|
|
141
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
142
|
+
_content_type: Optional[StrictStr] = None,
|
|
143
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
144
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
145
|
+
) -> ApiResponse[Instance]:
|
|
146
|
+
"""Close Instance
|
|
147
|
+
|
|
148
|
+
Close an instance or update the closedAt time when it will be closed. You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-manage` permission.
|
|
149
|
+
|
|
150
|
+
:param world_id: Must be a valid world ID. (required)
|
|
151
|
+
:type world_id: str
|
|
152
|
+
:param instance_id: Must be a valid instance ID. (required)
|
|
153
|
+
:type instance_id: str
|
|
154
|
+
:param hard_close: Whether to hard close the instance. Defaults to false.
|
|
155
|
+
:type hard_close: bool
|
|
156
|
+
:param closed_at: The time after which users won't be allowed to join the instances. If omitted, the instance will be closed immediately.
|
|
157
|
+
:type closed_at: datetime
|
|
158
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
159
|
+
number provided, it will be total request
|
|
160
|
+
timeout. It can also be a pair (tuple) of
|
|
161
|
+
(connection, read) timeouts.
|
|
162
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
163
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
164
|
+
request; this effectively ignores the
|
|
165
|
+
authentication in the spec for a single request.
|
|
166
|
+
:type _request_auth: dict, optional
|
|
167
|
+
:param _content_type: force content-type for the request.
|
|
168
|
+
:type _content_type: str, Optional
|
|
169
|
+
:param _headers: set to override the headers for a single
|
|
170
|
+
request; this effectively ignores the headers
|
|
171
|
+
in the spec for a single request.
|
|
172
|
+
:type _headers: dict, optional
|
|
173
|
+
:param _host_index: set to override the host_index for a single
|
|
174
|
+
request; this effectively ignores the host_index
|
|
175
|
+
in the spec for a single request.
|
|
176
|
+
:type _host_index: int, optional
|
|
177
|
+
:return: Returns the result object.
|
|
178
|
+
""" # noqa: E501
|
|
179
|
+
|
|
180
|
+
_param = self._close_instance_serialize(
|
|
181
|
+
world_id=world_id,
|
|
182
|
+
instance_id=instance_id,
|
|
183
|
+
hard_close=hard_close,
|
|
184
|
+
closed_at=closed_at,
|
|
185
|
+
_request_auth=_request_auth,
|
|
186
|
+
_content_type=_content_type,
|
|
187
|
+
_headers=_headers,
|
|
188
|
+
_host_index=_host_index
|
|
189
|
+
)
|
|
190
|
+
|
|
191
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
192
|
+
'200': "Instance",
|
|
193
|
+
'401': "Error",
|
|
194
|
+
'403': "Error",
|
|
195
|
+
'404': "Error",
|
|
196
|
+
}
|
|
197
|
+
response_data = await self.api_client.call_api(
|
|
198
|
+
*_param,
|
|
199
|
+
_request_timeout=_request_timeout
|
|
200
|
+
)
|
|
201
|
+
await response_data.read()
|
|
202
|
+
return self.api_client.response_deserialize(
|
|
203
|
+
response_data=response_data,
|
|
204
|
+
response_types_map=_response_types_map,
|
|
205
|
+
)
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
@validate_call
|
|
209
|
+
async def close_instance_without_preload_content(
|
|
210
|
+
self,
|
|
211
|
+
world_id: Annotated[StrictStr, Field(description="Must be a valid world ID.")],
|
|
212
|
+
instance_id: Annotated[StrictStr, Field(description="Must be a valid instance ID.")],
|
|
213
|
+
hard_close: Annotated[Optional[StrictBool], Field(description="Whether to hard close the instance. Defaults to false.")] = None,
|
|
214
|
+
closed_at: Annotated[Optional[datetime], Field(description="The time after which users won't be allowed to join the instances. If omitted, the instance will be closed immediately.")] = None,
|
|
215
|
+
_request_timeout: Union[
|
|
216
|
+
None,
|
|
217
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
218
|
+
Tuple[
|
|
219
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
220
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
221
|
+
]
|
|
222
|
+
] = None,
|
|
223
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
224
|
+
_content_type: Optional[StrictStr] = None,
|
|
225
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
226
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
227
|
+
) -> RESTResponseType:
|
|
228
|
+
"""Close Instance
|
|
229
|
+
|
|
230
|
+
Close an instance or update the closedAt time when it will be closed. You can only close an instance if the ownerId is yourself or if the instance owner is a group and you have the `group-instance-manage` permission.
|
|
231
|
+
|
|
232
|
+
:param world_id: Must be a valid world ID. (required)
|
|
233
|
+
:type world_id: str
|
|
234
|
+
:param instance_id: Must be a valid instance ID. (required)
|
|
235
|
+
:type instance_id: str
|
|
236
|
+
:param hard_close: Whether to hard close the instance. Defaults to false.
|
|
237
|
+
:type hard_close: bool
|
|
238
|
+
:param closed_at: The time after which users won't be allowed to join the instances. If omitted, the instance will be closed immediately.
|
|
239
|
+
:type closed_at: datetime
|
|
240
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
241
|
+
number provided, it will be total request
|
|
242
|
+
timeout. It can also be a pair (tuple) of
|
|
243
|
+
(connection, read) timeouts.
|
|
244
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
245
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
246
|
+
request; this effectively ignores the
|
|
247
|
+
authentication in the spec for a single request.
|
|
248
|
+
:type _request_auth: dict, optional
|
|
249
|
+
:param _content_type: force content-type for the request.
|
|
250
|
+
:type _content_type: str, Optional
|
|
251
|
+
:param _headers: set to override the headers for a single
|
|
252
|
+
request; this effectively ignores the headers
|
|
253
|
+
in the spec for a single request.
|
|
254
|
+
:type _headers: dict, optional
|
|
255
|
+
:param _host_index: set to override the host_index for a single
|
|
256
|
+
request; this effectively ignores the host_index
|
|
257
|
+
in the spec for a single request.
|
|
258
|
+
:type _host_index: int, optional
|
|
259
|
+
:return: Returns the result object.
|
|
260
|
+
""" # noqa: E501
|
|
261
|
+
|
|
262
|
+
_param = self._close_instance_serialize(
|
|
263
|
+
world_id=world_id,
|
|
264
|
+
instance_id=instance_id,
|
|
265
|
+
hard_close=hard_close,
|
|
266
|
+
closed_at=closed_at,
|
|
267
|
+
_request_auth=_request_auth,
|
|
268
|
+
_content_type=_content_type,
|
|
269
|
+
_headers=_headers,
|
|
270
|
+
_host_index=_host_index
|
|
271
|
+
)
|
|
272
|
+
|
|
273
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
274
|
+
'200': "Instance",
|
|
275
|
+
'401': "Error",
|
|
276
|
+
'403': "Error",
|
|
277
|
+
'404': "Error",
|
|
278
|
+
}
|
|
279
|
+
response_data = await self.api_client.call_api(
|
|
280
|
+
*_param,
|
|
281
|
+
_request_timeout=_request_timeout
|
|
282
|
+
)
|
|
283
|
+
return response_data.response
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
def _close_instance_serialize(
|
|
287
|
+
self,
|
|
288
|
+
world_id,
|
|
289
|
+
instance_id,
|
|
290
|
+
hard_close,
|
|
291
|
+
closed_at,
|
|
292
|
+
_request_auth,
|
|
293
|
+
_content_type,
|
|
294
|
+
_headers,
|
|
295
|
+
_host_index,
|
|
296
|
+
) -> RequestSerialized:
|
|
297
|
+
|
|
298
|
+
_host = None
|
|
299
|
+
|
|
300
|
+
_collection_formats: Dict[str, str] = {
|
|
301
|
+
}
|
|
302
|
+
|
|
303
|
+
_path_params: Dict[str, str] = {}
|
|
304
|
+
_query_params: List[Tuple[str, str]] = []
|
|
305
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
306
|
+
_form_params: List[Tuple[str, str]] = []
|
|
307
|
+
_files: Dict[
|
|
308
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
309
|
+
] = {}
|
|
310
|
+
_body_params: Optional[bytes] = None
|
|
311
|
+
|
|
312
|
+
# process the path parameters
|
|
313
|
+
if world_id is not None:
|
|
314
|
+
_path_params['worldId'] = world_id
|
|
315
|
+
if instance_id is not None:
|
|
316
|
+
_path_params['instanceId'] = instance_id
|
|
317
|
+
# process the query parameters
|
|
318
|
+
if hard_close is not None:
|
|
319
|
+
|
|
320
|
+
_query_params.append(('hardClose', hard_close))
|
|
321
|
+
|
|
322
|
+
if closed_at is not None:
|
|
323
|
+
if isinstance(closed_at, datetime):
|
|
324
|
+
_query_params.append(
|
|
325
|
+
(
|
|
326
|
+
'closedAt',
|
|
327
|
+
closed_at.strftime(
|
|
328
|
+
self.api_client.configuration.datetime_format
|
|
329
|
+
)
|
|
330
|
+
)
|
|
331
|
+
)
|
|
332
|
+
else:
|
|
333
|
+
_query_params.append(('closedAt', closed_at))
|
|
334
|
+
|
|
335
|
+
# process the header parameters
|
|
336
|
+
# process the form parameters
|
|
337
|
+
# process the body parameter
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
# set the HTTP header `Accept`
|
|
341
|
+
if 'Accept' not in _header_params:
|
|
342
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
343
|
+
[
|
|
344
|
+
'application/json'
|
|
345
|
+
]
|
|
346
|
+
)
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
# authentication setting
|
|
350
|
+
_auth_settings: List[str] = [
|
|
351
|
+
'authCookie'
|
|
352
|
+
]
|
|
353
|
+
|
|
354
|
+
return self.api_client.param_serialize(
|
|
355
|
+
method='DELETE',
|
|
356
|
+
resource_path='/instances/{worldId}:{instanceId}',
|
|
357
|
+
path_params=_path_params,
|
|
358
|
+
query_params=_query_params,
|
|
359
|
+
header_params=_header_params,
|
|
360
|
+
body=_body_params,
|
|
361
|
+
post_params=_form_params,
|
|
362
|
+
files=_files,
|
|
363
|
+
auth_settings=_auth_settings,
|
|
364
|
+
collection_formats=_collection_formats,
|
|
365
|
+
_host=_host,
|
|
366
|
+
_request_auth=_request_auth
|
|
367
|
+
)
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
@validate_call
|
|
373
|
+
async def create_instance(
|
|
374
|
+
self,
|
|
375
|
+
create_instance_request: CreateInstanceRequest,
|
|
376
|
+
_request_timeout: Union[
|
|
377
|
+
None,
|
|
378
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
379
|
+
Tuple[
|
|
380
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
381
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
382
|
+
]
|
|
383
|
+
] = None,
|
|
384
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
385
|
+
_content_type: Optional[StrictStr] = None,
|
|
386
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
387
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
388
|
+
) -> Instance:
|
|
389
|
+
"""Create Instance
|
|
390
|
+
|
|
391
|
+
Create an instance
|
|
392
|
+
|
|
393
|
+
:param create_instance_request: (required)
|
|
394
|
+
:type create_instance_request: CreateInstanceRequest
|
|
395
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
396
|
+
number provided, it will be total request
|
|
397
|
+
timeout. It can also be a pair (tuple) of
|
|
398
|
+
(connection, read) timeouts.
|
|
399
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
400
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
401
|
+
request; this effectively ignores the
|
|
402
|
+
authentication in the spec for a single request.
|
|
403
|
+
:type _request_auth: dict, optional
|
|
404
|
+
:param _content_type: force content-type for the request.
|
|
405
|
+
:type _content_type: str, Optional
|
|
406
|
+
:param _headers: set to override the headers for a single
|
|
407
|
+
request; this effectively ignores the headers
|
|
408
|
+
in the spec for a single request.
|
|
409
|
+
:type _headers: dict, optional
|
|
410
|
+
:param _host_index: set to override the host_index for a single
|
|
411
|
+
request; this effectively ignores the host_index
|
|
412
|
+
in the spec for a single request.
|
|
413
|
+
:type _host_index: int, optional
|
|
414
|
+
:return: Returns the result object.
|
|
415
|
+
""" # noqa: E501
|
|
416
|
+
|
|
417
|
+
_param = self._create_instance_serialize(
|
|
418
|
+
create_instance_request=create_instance_request,
|
|
419
|
+
_request_auth=_request_auth,
|
|
420
|
+
_content_type=_content_type,
|
|
421
|
+
_headers=_headers,
|
|
422
|
+
_host_index=_host_index
|
|
423
|
+
)
|
|
424
|
+
|
|
425
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
426
|
+
'200': "Instance",
|
|
427
|
+
'401': "Error",
|
|
428
|
+
}
|
|
429
|
+
response_data = await self.api_client.call_api(
|
|
430
|
+
*_param,
|
|
431
|
+
_request_timeout=_request_timeout
|
|
432
|
+
)
|
|
433
|
+
await response_data.read()
|
|
434
|
+
return self.api_client.response_deserialize(
|
|
435
|
+
response_data=response_data,
|
|
436
|
+
response_types_map=_response_types_map,
|
|
437
|
+
).data
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
@validate_call
|
|
441
|
+
async def create_instance_with_http_info(
|
|
442
|
+
self,
|
|
443
|
+
create_instance_request: CreateInstanceRequest,
|
|
444
|
+
_request_timeout: Union[
|
|
445
|
+
None,
|
|
446
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
447
|
+
Tuple[
|
|
448
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
449
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
450
|
+
]
|
|
451
|
+
] = None,
|
|
452
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
453
|
+
_content_type: Optional[StrictStr] = None,
|
|
454
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
455
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
456
|
+
) -> ApiResponse[Instance]:
|
|
457
|
+
"""Create Instance
|
|
458
|
+
|
|
459
|
+
Create an instance
|
|
460
|
+
|
|
461
|
+
:param create_instance_request: (required)
|
|
462
|
+
:type create_instance_request: CreateInstanceRequest
|
|
463
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
464
|
+
number provided, it will be total request
|
|
465
|
+
timeout. It can also be a pair (tuple) of
|
|
466
|
+
(connection, read) timeouts.
|
|
467
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
468
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
469
|
+
request; this effectively ignores the
|
|
470
|
+
authentication in the spec for a single request.
|
|
471
|
+
:type _request_auth: dict, optional
|
|
472
|
+
:param _content_type: force content-type for the request.
|
|
473
|
+
:type _content_type: str, Optional
|
|
474
|
+
:param _headers: set to override the headers for a single
|
|
475
|
+
request; this effectively ignores the headers
|
|
476
|
+
in the spec for a single request.
|
|
477
|
+
:type _headers: dict, optional
|
|
478
|
+
:param _host_index: set to override the host_index for a single
|
|
479
|
+
request; this effectively ignores the host_index
|
|
480
|
+
in the spec for a single request.
|
|
481
|
+
:type _host_index: int, optional
|
|
482
|
+
:return: Returns the result object.
|
|
483
|
+
""" # noqa: E501
|
|
484
|
+
|
|
485
|
+
_param = self._create_instance_serialize(
|
|
486
|
+
create_instance_request=create_instance_request,
|
|
487
|
+
_request_auth=_request_auth,
|
|
488
|
+
_content_type=_content_type,
|
|
489
|
+
_headers=_headers,
|
|
490
|
+
_host_index=_host_index
|
|
491
|
+
)
|
|
492
|
+
|
|
493
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
494
|
+
'200': "Instance",
|
|
495
|
+
'401': "Error",
|
|
496
|
+
}
|
|
497
|
+
response_data = await self.api_client.call_api(
|
|
498
|
+
*_param,
|
|
499
|
+
_request_timeout=_request_timeout
|
|
500
|
+
)
|
|
501
|
+
await response_data.read()
|
|
502
|
+
return self.api_client.response_deserialize(
|
|
503
|
+
response_data=response_data,
|
|
504
|
+
response_types_map=_response_types_map,
|
|
505
|
+
)
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
@validate_call
|
|
509
|
+
async def create_instance_without_preload_content(
|
|
510
|
+
self,
|
|
511
|
+
create_instance_request: CreateInstanceRequest,
|
|
512
|
+
_request_timeout: Union[
|
|
513
|
+
None,
|
|
514
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
515
|
+
Tuple[
|
|
516
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
517
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
518
|
+
]
|
|
519
|
+
] = None,
|
|
520
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
521
|
+
_content_type: Optional[StrictStr] = None,
|
|
522
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
523
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
524
|
+
) -> RESTResponseType:
|
|
525
|
+
"""Create Instance
|
|
526
|
+
|
|
527
|
+
Create an instance
|
|
528
|
+
|
|
529
|
+
:param create_instance_request: (required)
|
|
530
|
+
:type create_instance_request: CreateInstanceRequest
|
|
531
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
532
|
+
number provided, it will be total request
|
|
533
|
+
timeout. It can also be a pair (tuple) of
|
|
534
|
+
(connection, read) timeouts.
|
|
535
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
536
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
537
|
+
request; this effectively ignores the
|
|
538
|
+
authentication in the spec for a single request.
|
|
539
|
+
:type _request_auth: dict, optional
|
|
540
|
+
:param _content_type: force content-type for the request.
|
|
541
|
+
:type _content_type: str, Optional
|
|
542
|
+
:param _headers: set to override the headers for a single
|
|
543
|
+
request; this effectively ignores the headers
|
|
544
|
+
in the spec for a single request.
|
|
545
|
+
:type _headers: dict, optional
|
|
546
|
+
:param _host_index: set to override the host_index for a single
|
|
547
|
+
request; this effectively ignores the host_index
|
|
548
|
+
in the spec for a single request.
|
|
549
|
+
:type _host_index: int, optional
|
|
550
|
+
:return: Returns the result object.
|
|
551
|
+
""" # noqa: E501
|
|
552
|
+
|
|
553
|
+
_param = self._create_instance_serialize(
|
|
554
|
+
create_instance_request=create_instance_request,
|
|
555
|
+
_request_auth=_request_auth,
|
|
556
|
+
_content_type=_content_type,
|
|
557
|
+
_headers=_headers,
|
|
558
|
+
_host_index=_host_index
|
|
559
|
+
)
|
|
560
|
+
|
|
561
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
562
|
+
'200': "Instance",
|
|
563
|
+
'401': "Error",
|
|
564
|
+
}
|
|
565
|
+
response_data = await self.api_client.call_api(
|
|
566
|
+
*_param,
|
|
567
|
+
_request_timeout=_request_timeout
|
|
568
|
+
)
|
|
569
|
+
return response_data.response
|
|
570
|
+
|
|
571
|
+
|
|
572
|
+
def _create_instance_serialize(
|
|
573
|
+
self,
|
|
574
|
+
create_instance_request,
|
|
575
|
+
_request_auth,
|
|
576
|
+
_content_type,
|
|
577
|
+
_headers,
|
|
578
|
+
_host_index,
|
|
579
|
+
) -> RequestSerialized:
|
|
580
|
+
|
|
581
|
+
_host = None
|
|
582
|
+
|
|
583
|
+
_collection_formats: Dict[str, str] = {
|
|
584
|
+
}
|
|
585
|
+
|
|
586
|
+
_path_params: Dict[str, str] = {}
|
|
587
|
+
_query_params: List[Tuple[str, str]] = []
|
|
588
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
589
|
+
_form_params: List[Tuple[str, str]] = []
|
|
590
|
+
_files: Dict[
|
|
591
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
592
|
+
] = {}
|
|
593
|
+
_body_params: Optional[bytes] = None
|
|
594
|
+
|
|
595
|
+
# process the path parameters
|
|
596
|
+
# process the query parameters
|
|
597
|
+
# process the header parameters
|
|
598
|
+
# process the form parameters
|
|
599
|
+
# process the body parameter
|
|
600
|
+
if create_instance_request is not None:
|
|
601
|
+
_body_params = create_instance_request
|
|
602
|
+
|
|
603
|
+
|
|
604
|
+
# set the HTTP header `Accept`
|
|
605
|
+
if 'Accept' not in _header_params:
|
|
606
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
607
|
+
[
|
|
608
|
+
'application/json'
|
|
609
|
+
]
|
|
610
|
+
)
|
|
611
|
+
|
|
612
|
+
# set the HTTP header `Content-Type`
|
|
613
|
+
if _content_type:
|
|
614
|
+
_header_params['Content-Type'] = _content_type
|
|
615
|
+
else:
|
|
616
|
+
_default_content_type = (
|
|
617
|
+
self.api_client.select_header_content_type(
|
|
618
|
+
[
|
|
619
|
+
'application/json'
|
|
620
|
+
]
|
|
621
|
+
)
|
|
622
|
+
)
|
|
623
|
+
if _default_content_type is not None:
|
|
624
|
+
_header_params['Content-Type'] = _default_content_type
|
|
625
|
+
|
|
626
|
+
# authentication setting
|
|
627
|
+
_auth_settings: List[str] = [
|
|
628
|
+
'authCookie'
|
|
629
|
+
]
|
|
630
|
+
|
|
631
|
+
return self.api_client.param_serialize(
|
|
632
|
+
method='POST',
|
|
633
|
+
resource_path='/instances',
|
|
634
|
+
path_params=_path_params,
|
|
635
|
+
query_params=_query_params,
|
|
636
|
+
header_params=_header_params,
|
|
637
|
+
body=_body_params,
|
|
638
|
+
post_params=_form_params,
|
|
639
|
+
files=_files,
|
|
640
|
+
auth_settings=_auth_settings,
|
|
641
|
+
collection_formats=_collection_formats,
|
|
642
|
+
_host=_host,
|
|
643
|
+
_request_auth=_request_auth
|
|
644
|
+
)
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
@validate_call
|
|
650
|
+
async def get_instance(
|
|
651
|
+
self,
|
|
652
|
+
world_id: Annotated[StrictStr, Field(description="Must be a valid world ID.")],
|
|
653
|
+
instance_id: Annotated[StrictStr, Field(description="Must be a valid instance ID.")],
|
|
654
|
+
_request_timeout: Union[
|
|
655
|
+
None,
|
|
656
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
657
|
+
Tuple[
|
|
658
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
659
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
660
|
+
]
|
|
661
|
+
] = None,
|
|
662
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
663
|
+
_content_type: Optional[StrictStr] = None,
|
|
664
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
665
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
666
|
+
) -> Instance:
|
|
667
|
+
"""Get Instance
|
|
668
|
+
|
|
669
|
+
Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances. If an invalid instanceId is provided, this endpoint will simply return \"null\"!
|
|
670
|
+
|
|
671
|
+
:param world_id: Must be a valid world ID. (required)
|
|
672
|
+
:type world_id: str
|
|
673
|
+
:param instance_id: Must be a valid instance ID. (required)
|
|
674
|
+
:type instance_id: str
|
|
675
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
676
|
+
number provided, it will be total request
|
|
677
|
+
timeout. It can also be a pair (tuple) of
|
|
678
|
+
(connection, read) timeouts.
|
|
679
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
680
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
681
|
+
request; this effectively ignores the
|
|
682
|
+
authentication in the spec for a single request.
|
|
683
|
+
:type _request_auth: dict, optional
|
|
684
|
+
:param _content_type: force content-type for the request.
|
|
685
|
+
:type _content_type: str, Optional
|
|
686
|
+
:param _headers: set to override the headers for a single
|
|
687
|
+
request; this effectively ignores the headers
|
|
688
|
+
in the spec for a single request.
|
|
689
|
+
:type _headers: dict, optional
|
|
690
|
+
:param _host_index: set to override the host_index for a single
|
|
691
|
+
request; this effectively ignores the host_index
|
|
692
|
+
in the spec for a single request.
|
|
693
|
+
:type _host_index: int, optional
|
|
694
|
+
:return: Returns the result object.
|
|
695
|
+
""" # noqa: E501
|
|
696
|
+
|
|
697
|
+
_param = self._get_instance_serialize(
|
|
698
|
+
world_id=world_id,
|
|
699
|
+
instance_id=instance_id,
|
|
700
|
+
_request_auth=_request_auth,
|
|
701
|
+
_content_type=_content_type,
|
|
702
|
+
_headers=_headers,
|
|
703
|
+
_host_index=_host_index
|
|
704
|
+
)
|
|
705
|
+
|
|
706
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
707
|
+
'200': "Instance",
|
|
708
|
+
'401': "Error",
|
|
709
|
+
}
|
|
710
|
+
response_data = await self.api_client.call_api(
|
|
711
|
+
*_param,
|
|
712
|
+
_request_timeout=_request_timeout
|
|
713
|
+
)
|
|
714
|
+
await response_data.read()
|
|
715
|
+
return self.api_client.response_deserialize(
|
|
716
|
+
response_data=response_data,
|
|
717
|
+
response_types_map=_response_types_map,
|
|
718
|
+
).data
|
|
719
|
+
|
|
720
|
+
|
|
721
|
+
@validate_call
|
|
722
|
+
async def get_instance_with_http_info(
|
|
723
|
+
self,
|
|
724
|
+
world_id: Annotated[StrictStr, Field(description="Must be a valid world ID.")],
|
|
725
|
+
instance_id: Annotated[StrictStr, Field(description="Must be a valid instance ID.")],
|
|
726
|
+
_request_timeout: Union[
|
|
727
|
+
None,
|
|
728
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
729
|
+
Tuple[
|
|
730
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
731
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
732
|
+
]
|
|
733
|
+
] = None,
|
|
734
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
735
|
+
_content_type: Optional[StrictStr] = None,
|
|
736
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
737
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
738
|
+
) -> ApiResponse[Instance]:
|
|
739
|
+
"""Get Instance
|
|
740
|
+
|
|
741
|
+
Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances. If an invalid instanceId is provided, this endpoint will simply return \"null\"!
|
|
742
|
+
|
|
743
|
+
:param world_id: Must be a valid world ID. (required)
|
|
744
|
+
:type world_id: str
|
|
745
|
+
:param instance_id: Must be a valid instance ID. (required)
|
|
746
|
+
:type instance_id: str
|
|
747
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
748
|
+
number provided, it will be total request
|
|
749
|
+
timeout. It can also be a pair (tuple) of
|
|
750
|
+
(connection, read) timeouts.
|
|
751
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
752
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
753
|
+
request; this effectively ignores the
|
|
754
|
+
authentication in the spec for a single request.
|
|
755
|
+
:type _request_auth: dict, optional
|
|
756
|
+
:param _content_type: force content-type for the request.
|
|
757
|
+
:type _content_type: str, Optional
|
|
758
|
+
:param _headers: set to override the headers for a single
|
|
759
|
+
request; this effectively ignores the headers
|
|
760
|
+
in the spec for a single request.
|
|
761
|
+
:type _headers: dict, optional
|
|
762
|
+
:param _host_index: set to override the host_index for a single
|
|
763
|
+
request; this effectively ignores the host_index
|
|
764
|
+
in the spec for a single request.
|
|
765
|
+
:type _host_index: int, optional
|
|
766
|
+
:return: Returns the result object.
|
|
767
|
+
""" # noqa: E501
|
|
768
|
+
|
|
769
|
+
_param = self._get_instance_serialize(
|
|
770
|
+
world_id=world_id,
|
|
771
|
+
instance_id=instance_id,
|
|
772
|
+
_request_auth=_request_auth,
|
|
773
|
+
_content_type=_content_type,
|
|
774
|
+
_headers=_headers,
|
|
775
|
+
_host_index=_host_index
|
|
776
|
+
)
|
|
777
|
+
|
|
778
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
779
|
+
'200': "Instance",
|
|
780
|
+
'401': "Error",
|
|
781
|
+
}
|
|
782
|
+
response_data = await self.api_client.call_api(
|
|
783
|
+
*_param,
|
|
784
|
+
_request_timeout=_request_timeout
|
|
785
|
+
)
|
|
786
|
+
await response_data.read()
|
|
787
|
+
return self.api_client.response_deserialize(
|
|
788
|
+
response_data=response_data,
|
|
789
|
+
response_types_map=_response_types_map,
|
|
790
|
+
)
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
@validate_call
|
|
794
|
+
async def get_instance_without_preload_content(
|
|
795
|
+
self,
|
|
796
|
+
world_id: Annotated[StrictStr, Field(description="Must be a valid world ID.")],
|
|
797
|
+
instance_id: Annotated[StrictStr, Field(description="Must be a valid instance ID.")],
|
|
798
|
+
_request_timeout: Union[
|
|
799
|
+
None,
|
|
800
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
801
|
+
Tuple[
|
|
802
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
803
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
804
|
+
]
|
|
805
|
+
] = None,
|
|
806
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
807
|
+
_content_type: Optional[StrictStr] = None,
|
|
808
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
809
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
810
|
+
) -> RESTResponseType:
|
|
811
|
+
"""Get Instance
|
|
812
|
+
|
|
813
|
+
Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances. If an invalid instanceId is provided, this endpoint will simply return \"null\"!
|
|
814
|
+
|
|
815
|
+
:param world_id: Must be a valid world ID. (required)
|
|
816
|
+
:type world_id: str
|
|
817
|
+
:param instance_id: Must be a valid instance ID. (required)
|
|
818
|
+
:type instance_id: str
|
|
819
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
820
|
+
number provided, it will be total request
|
|
821
|
+
timeout. It can also be a pair (tuple) of
|
|
822
|
+
(connection, read) timeouts.
|
|
823
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
824
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
825
|
+
request; this effectively ignores the
|
|
826
|
+
authentication in the spec for a single request.
|
|
827
|
+
:type _request_auth: dict, optional
|
|
828
|
+
:param _content_type: force content-type for the request.
|
|
829
|
+
:type _content_type: str, Optional
|
|
830
|
+
:param _headers: set to override the headers for a single
|
|
831
|
+
request; this effectively ignores the headers
|
|
832
|
+
in the spec for a single request.
|
|
833
|
+
:type _headers: dict, optional
|
|
834
|
+
:param _host_index: set to override the host_index for a single
|
|
835
|
+
request; this effectively ignores the host_index
|
|
836
|
+
in the spec for a single request.
|
|
837
|
+
:type _host_index: int, optional
|
|
838
|
+
:return: Returns the result object.
|
|
839
|
+
""" # noqa: E501
|
|
840
|
+
|
|
841
|
+
_param = self._get_instance_serialize(
|
|
842
|
+
world_id=world_id,
|
|
843
|
+
instance_id=instance_id,
|
|
844
|
+
_request_auth=_request_auth,
|
|
845
|
+
_content_type=_content_type,
|
|
846
|
+
_headers=_headers,
|
|
847
|
+
_host_index=_host_index
|
|
848
|
+
)
|
|
849
|
+
|
|
850
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
851
|
+
'200': "Instance",
|
|
852
|
+
'401': "Error",
|
|
853
|
+
}
|
|
854
|
+
response_data = await self.api_client.call_api(
|
|
855
|
+
*_param,
|
|
856
|
+
_request_timeout=_request_timeout
|
|
857
|
+
)
|
|
858
|
+
return response_data.response
|
|
859
|
+
|
|
860
|
+
|
|
861
|
+
def _get_instance_serialize(
|
|
862
|
+
self,
|
|
863
|
+
world_id,
|
|
864
|
+
instance_id,
|
|
865
|
+
_request_auth,
|
|
866
|
+
_content_type,
|
|
867
|
+
_headers,
|
|
868
|
+
_host_index,
|
|
869
|
+
) -> RequestSerialized:
|
|
870
|
+
|
|
871
|
+
_host = None
|
|
872
|
+
|
|
873
|
+
_collection_formats: Dict[str, str] = {
|
|
874
|
+
}
|
|
875
|
+
|
|
876
|
+
_path_params: Dict[str, str] = {}
|
|
877
|
+
_query_params: List[Tuple[str, str]] = []
|
|
878
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
879
|
+
_form_params: List[Tuple[str, str]] = []
|
|
880
|
+
_files: Dict[
|
|
881
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
882
|
+
] = {}
|
|
883
|
+
_body_params: Optional[bytes] = None
|
|
884
|
+
|
|
885
|
+
# process the path parameters
|
|
886
|
+
if world_id is not None:
|
|
887
|
+
_path_params['worldId'] = world_id
|
|
888
|
+
if instance_id is not None:
|
|
889
|
+
_path_params['instanceId'] = instance_id
|
|
890
|
+
# process the query parameters
|
|
891
|
+
# process the header parameters
|
|
892
|
+
# process the form parameters
|
|
893
|
+
# process the body parameter
|
|
894
|
+
|
|
895
|
+
|
|
896
|
+
# set the HTTP header `Accept`
|
|
897
|
+
if 'Accept' not in _header_params:
|
|
898
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
899
|
+
[
|
|
900
|
+
'application/json'
|
|
901
|
+
]
|
|
902
|
+
)
|
|
903
|
+
|
|
904
|
+
|
|
905
|
+
# authentication setting
|
|
906
|
+
_auth_settings: List[str] = [
|
|
907
|
+
'authCookie'
|
|
908
|
+
]
|
|
909
|
+
|
|
910
|
+
return self.api_client.param_serialize(
|
|
911
|
+
method='GET',
|
|
912
|
+
resource_path='/instances/{worldId}:{instanceId}',
|
|
913
|
+
path_params=_path_params,
|
|
914
|
+
query_params=_query_params,
|
|
915
|
+
header_params=_header_params,
|
|
916
|
+
body=_body_params,
|
|
917
|
+
post_params=_form_params,
|
|
918
|
+
files=_files,
|
|
919
|
+
auth_settings=_auth_settings,
|
|
920
|
+
collection_formats=_collection_formats,
|
|
921
|
+
_host=_host,
|
|
922
|
+
_request_auth=_request_auth
|
|
923
|
+
)
|
|
924
|
+
|
|
925
|
+
|
|
926
|
+
|
|
927
|
+
|
|
928
|
+
@validate_call
|
|
929
|
+
async def get_instance_by_short_name(
|
|
930
|
+
self,
|
|
931
|
+
short_name: Annotated[StrictStr, Field(description="Must be a valid instance short name.")],
|
|
932
|
+
_request_timeout: Union[
|
|
933
|
+
None,
|
|
934
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
935
|
+
Tuple[
|
|
936
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
937
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
938
|
+
]
|
|
939
|
+
] = None,
|
|
940
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
941
|
+
_content_type: Optional[StrictStr] = None,
|
|
942
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
943
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
944
|
+
) -> Instance:
|
|
945
|
+
"""Get Instance By Short Name
|
|
946
|
+
|
|
947
|
+
Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances.
|
|
948
|
+
|
|
949
|
+
:param short_name: Must be a valid instance short name. (required)
|
|
950
|
+
:type short_name: str
|
|
951
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
952
|
+
number provided, it will be total request
|
|
953
|
+
timeout. It can also be a pair (tuple) of
|
|
954
|
+
(connection, read) timeouts.
|
|
955
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
956
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
957
|
+
request; this effectively ignores the
|
|
958
|
+
authentication in the spec for a single request.
|
|
959
|
+
:type _request_auth: dict, optional
|
|
960
|
+
:param _content_type: force content-type for the request.
|
|
961
|
+
:type _content_type: str, Optional
|
|
962
|
+
:param _headers: set to override the headers for a single
|
|
963
|
+
request; this effectively ignores the headers
|
|
964
|
+
in the spec for a single request.
|
|
965
|
+
:type _headers: dict, optional
|
|
966
|
+
:param _host_index: set to override the host_index for a single
|
|
967
|
+
request; this effectively ignores the host_index
|
|
968
|
+
in the spec for a single request.
|
|
969
|
+
:type _host_index: int, optional
|
|
970
|
+
:return: Returns the result object.
|
|
971
|
+
""" # noqa: E501
|
|
972
|
+
|
|
973
|
+
_param = self._get_instance_by_short_name_serialize(
|
|
974
|
+
short_name=short_name,
|
|
975
|
+
_request_auth=_request_auth,
|
|
976
|
+
_content_type=_content_type,
|
|
977
|
+
_headers=_headers,
|
|
978
|
+
_host_index=_host_index
|
|
979
|
+
)
|
|
980
|
+
|
|
981
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
982
|
+
'200': "Instance",
|
|
983
|
+
'401': "Error",
|
|
984
|
+
'404': "Error",
|
|
985
|
+
}
|
|
986
|
+
response_data = await self.api_client.call_api(
|
|
987
|
+
*_param,
|
|
988
|
+
_request_timeout=_request_timeout
|
|
989
|
+
)
|
|
990
|
+
await response_data.read()
|
|
991
|
+
return self.api_client.response_deserialize(
|
|
992
|
+
response_data=response_data,
|
|
993
|
+
response_types_map=_response_types_map,
|
|
994
|
+
).data
|
|
995
|
+
|
|
996
|
+
|
|
997
|
+
@validate_call
|
|
998
|
+
async def get_instance_by_short_name_with_http_info(
|
|
999
|
+
self,
|
|
1000
|
+
short_name: Annotated[StrictStr, Field(description="Must be a valid instance short name.")],
|
|
1001
|
+
_request_timeout: Union[
|
|
1002
|
+
None,
|
|
1003
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1004
|
+
Tuple[
|
|
1005
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1006
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1007
|
+
]
|
|
1008
|
+
] = None,
|
|
1009
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1010
|
+
_content_type: Optional[StrictStr] = None,
|
|
1011
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1012
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1013
|
+
) -> ApiResponse[Instance]:
|
|
1014
|
+
"""Get Instance By Short Name
|
|
1015
|
+
|
|
1016
|
+
Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances.
|
|
1017
|
+
|
|
1018
|
+
:param short_name: Must be a valid instance short name. (required)
|
|
1019
|
+
:type short_name: str
|
|
1020
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1021
|
+
number provided, it will be total request
|
|
1022
|
+
timeout. It can also be a pair (tuple) of
|
|
1023
|
+
(connection, read) timeouts.
|
|
1024
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1025
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1026
|
+
request; this effectively ignores the
|
|
1027
|
+
authentication in the spec for a single request.
|
|
1028
|
+
:type _request_auth: dict, optional
|
|
1029
|
+
:param _content_type: force content-type for the request.
|
|
1030
|
+
:type _content_type: str, Optional
|
|
1031
|
+
:param _headers: set to override the headers for a single
|
|
1032
|
+
request; this effectively ignores the headers
|
|
1033
|
+
in the spec for a single request.
|
|
1034
|
+
:type _headers: dict, optional
|
|
1035
|
+
:param _host_index: set to override the host_index for a single
|
|
1036
|
+
request; this effectively ignores the host_index
|
|
1037
|
+
in the spec for a single request.
|
|
1038
|
+
:type _host_index: int, optional
|
|
1039
|
+
:return: Returns the result object.
|
|
1040
|
+
""" # noqa: E501
|
|
1041
|
+
|
|
1042
|
+
_param = self._get_instance_by_short_name_serialize(
|
|
1043
|
+
short_name=short_name,
|
|
1044
|
+
_request_auth=_request_auth,
|
|
1045
|
+
_content_type=_content_type,
|
|
1046
|
+
_headers=_headers,
|
|
1047
|
+
_host_index=_host_index
|
|
1048
|
+
)
|
|
1049
|
+
|
|
1050
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1051
|
+
'200': "Instance",
|
|
1052
|
+
'401': "Error",
|
|
1053
|
+
'404': "Error",
|
|
1054
|
+
}
|
|
1055
|
+
response_data = await self.api_client.call_api(
|
|
1056
|
+
*_param,
|
|
1057
|
+
_request_timeout=_request_timeout
|
|
1058
|
+
)
|
|
1059
|
+
await response_data.read()
|
|
1060
|
+
return self.api_client.response_deserialize(
|
|
1061
|
+
response_data=response_data,
|
|
1062
|
+
response_types_map=_response_types_map,
|
|
1063
|
+
)
|
|
1064
|
+
|
|
1065
|
+
|
|
1066
|
+
@validate_call
|
|
1067
|
+
async def get_instance_by_short_name_without_preload_content(
|
|
1068
|
+
self,
|
|
1069
|
+
short_name: Annotated[StrictStr, Field(description="Must be a valid instance short name.")],
|
|
1070
|
+
_request_timeout: Union[
|
|
1071
|
+
None,
|
|
1072
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1073
|
+
Tuple[
|
|
1074
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1075
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1076
|
+
]
|
|
1077
|
+
] = None,
|
|
1078
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1079
|
+
_content_type: Optional[StrictStr] = None,
|
|
1080
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1081
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1082
|
+
) -> RESTResponseType:
|
|
1083
|
+
"""Get Instance By Short Name
|
|
1084
|
+
|
|
1085
|
+
Returns an instance. Please read [Instances Tutorial](https://vrchatapi.github.io/tutorials/instances/) for more information on Instances.
|
|
1086
|
+
|
|
1087
|
+
:param short_name: Must be a valid instance short name. (required)
|
|
1088
|
+
:type short_name: str
|
|
1089
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1090
|
+
number provided, it will be total request
|
|
1091
|
+
timeout. It can also be a pair (tuple) of
|
|
1092
|
+
(connection, read) timeouts.
|
|
1093
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1094
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1095
|
+
request; this effectively ignores the
|
|
1096
|
+
authentication in the spec for a single request.
|
|
1097
|
+
:type _request_auth: dict, optional
|
|
1098
|
+
:param _content_type: force content-type for the request.
|
|
1099
|
+
:type _content_type: str, Optional
|
|
1100
|
+
:param _headers: set to override the headers for a single
|
|
1101
|
+
request; this effectively ignores the headers
|
|
1102
|
+
in the spec for a single request.
|
|
1103
|
+
:type _headers: dict, optional
|
|
1104
|
+
:param _host_index: set to override the host_index for a single
|
|
1105
|
+
request; this effectively ignores the host_index
|
|
1106
|
+
in the spec for a single request.
|
|
1107
|
+
:type _host_index: int, optional
|
|
1108
|
+
:return: Returns the result object.
|
|
1109
|
+
""" # noqa: E501
|
|
1110
|
+
|
|
1111
|
+
_param = self._get_instance_by_short_name_serialize(
|
|
1112
|
+
short_name=short_name,
|
|
1113
|
+
_request_auth=_request_auth,
|
|
1114
|
+
_content_type=_content_type,
|
|
1115
|
+
_headers=_headers,
|
|
1116
|
+
_host_index=_host_index
|
|
1117
|
+
)
|
|
1118
|
+
|
|
1119
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1120
|
+
'200': "Instance",
|
|
1121
|
+
'401': "Error",
|
|
1122
|
+
'404': "Error",
|
|
1123
|
+
}
|
|
1124
|
+
response_data = await self.api_client.call_api(
|
|
1125
|
+
*_param,
|
|
1126
|
+
_request_timeout=_request_timeout
|
|
1127
|
+
)
|
|
1128
|
+
return response_data.response
|
|
1129
|
+
|
|
1130
|
+
|
|
1131
|
+
def _get_instance_by_short_name_serialize(
|
|
1132
|
+
self,
|
|
1133
|
+
short_name,
|
|
1134
|
+
_request_auth,
|
|
1135
|
+
_content_type,
|
|
1136
|
+
_headers,
|
|
1137
|
+
_host_index,
|
|
1138
|
+
) -> RequestSerialized:
|
|
1139
|
+
|
|
1140
|
+
_host = None
|
|
1141
|
+
|
|
1142
|
+
_collection_formats: Dict[str, str] = {
|
|
1143
|
+
}
|
|
1144
|
+
|
|
1145
|
+
_path_params: Dict[str, str] = {}
|
|
1146
|
+
_query_params: List[Tuple[str, str]] = []
|
|
1147
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
1148
|
+
_form_params: List[Tuple[str, str]] = []
|
|
1149
|
+
_files: Dict[
|
|
1150
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
1151
|
+
] = {}
|
|
1152
|
+
_body_params: Optional[bytes] = None
|
|
1153
|
+
|
|
1154
|
+
# process the path parameters
|
|
1155
|
+
if short_name is not None:
|
|
1156
|
+
_path_params['shortName'] = short_name
|
|
1157
|
+
# process the query parameters
|
|
1158
|
+
# process the header parameters
|
|
1159
|
+
# process the form parameters
|
|
1160
|
+
# process the body parameter
|
|
1161
|
+
|
|
1162
|
+
|
|
1163
|
+
# set the HTTP header `Accept`
|
|
1164
|
+
if 'Accept' not in _header_params:
|
|
1165
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
1166
|
+
[
|
|
1167
|
+
'application/json'
|
|
1168
|
+
]
|
|
1169
|
+
)
|
|
1170
|
+
|
|
1171
|
+
|
|
1172
|
+
# authentication setting
|
|
1173
|
+
_auth_settings: List[str] = [
|
|
1174
|
+
'authCookie'
|
|
1175
|
+
]
|
|
1176
|
+
|
|
1177
|
+
return self.api_client.param_serialize(
|
|
1178
|
+
method='GET',
|
|
1179
|
+
resource_path='/instances/s/{shortName}',
|
|
1180
|
+
path_params=_path_params,
|
|
1181
|
+
query_params=_query_params,
|
|
1182
|
+
header_params=_header_params,
|
|
1183
|
+
body=_body_params,
|
|
1184
|
+
post_params=_form_params,
|
|
1185
|
+
files=_files,
|
|
1186
|
+
auth_settings=_auth_settings,
|
|
1187
|
+
collection_formats=_collection_formats,
|
|
1188
|
+
_host=_host,
|
|
1189
|
+
_request_auth=_request_auth
|
|
1190
|
+
)
|
|
1191
|
+
|
|
1192
|
+
|
|
1193
|
+
|
|
1194
|
+
|
|
1195
|
+
@validate_call
|
|
1196
|
+
async def get_recent_locations(
|
|
1197
|
+
self,
|
|
1198
|
+
n: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="The number of objects to return.")] = None,
|
|
1199
|
+
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,
|
|
1200
|
+
_request_timeout: Union[
|
|
1201
|
+
None,
|
|
1202
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1203
|
+
Tuple[
|
|
1204
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1205
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1206
|
+
]
|
|
1207
|
+
] = None,
|
|
1208
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1209
|
+
_content_type: Optional[StrictStr] = None,
|
|
1210
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1211
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1212
|
+
) -> List[str]:
|
|
1213
|
+
"""List Recent Locations
|
|
1214
|
+
|
|
1215
|
+
Returns a list of recently visited locations.
|
|
1216
|
+
|
|
1217
|
+
:param n: The number of objects to return.
|
|
1218
|
+
:type n: int
|
|
1219
|
+
:param offset: A zero-based offset from the default object sorting from where search results start.
|
|
1220
|
+
:type offset: int
|
|
1221
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1222
|
+
number provided, it will be total request
|
|
1223
|
+
timeout. It can also be a pair (tuple) of
|
|
1224
|
+
(connection, read) timeouts.
|
|
1225
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1226
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1227
|
+
request; this effectively ignores the
|
|
1228
|
+
authentication in the spec for a single request.
|
|
1229
|
+
:type _request_auth: dict, optional
|
|
1230
|
+
:param _content_type: force content-type for the request.
|
|
1231
|
+
:type _content_type: str, Optional
|
|
1232
|
+
:param _headers: set to override the headers for a single
|
|
1233
|
+
request; this effectively ignores the headers
|
|
1234
|
+
in the spec for a single request.
|
|
1235
|
+
:type _headers: dict, optional
|
|
1236
|
+
:param _host_index: set to override the host_index for a single
|
|
1237
|
+
request; this effectively ignores the host_index
|
|
1238
|
+
in the spec for a single request.
|
|
1239
|
+
:type _host_index: int, optional
|
|
1240
|
+
:return: Returns the result object.
|
|
1241
|
+
""" # noqa: E501
|
|
1242
|
+
|
|
1243
|
+
_param = self._get_recent_locations_serialize(
|
|
1244
|
+
n=n,
|
|
1245
|
+
offset=offset,
|
|
1246
|
+
_request_auth=_request_auth,
|
|
1247
|
+
_content_type=_content_type,
|
|
1248
|
+
_headers=_headers,
|
|
1249
|
+
_host_index=_host_index
|
|
1250
|
+
)
|
|
1251
|
+
|
|
1252
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1253
|
+
'200': "List[str]",
|
|
1254
|
+
'401': "Error",
|
|
1255
|
+
}
|
|
1256
|
+
response_data = await self.api_client.call_api(
|
|
1257
|
+
*_param,
|
|
1258
|
+
_request_timeout=_request_timeout
|
|
1259
|
+
)
|
|
1260
|
+
await response_data.read()
|
|
1261
|
+
return self.api_client.response_deserialize(
|
|
1262
|
+
response_data=response_data,
|
|
1263
|
+
response_types_map=_response_types_map,
|
|
1264
|
+
).data
|
|
1265
|
+
|
|
1266
|
+
|
|
1267
|
+
@validate_call
|
|
1268
|
+
async def get_recent_locations_with_http_info(
|
|
1269
|
+
self,
|
|
1270
|
+
n: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="The number of objects to return.")] = None,
|
|
1271
|
+
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,
|
|
1272
|
+
_request_timeout: Union[
|
|
1273
|
+
None,
|
|
1274
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1275
|
+
Tuple[
|
|
1276
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1277
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1278
|
+
]
|
|
1279
|
+
] = None,
|
|
1280
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1281
|
+
_content_type: Optional[StrictStr] = None,
|
|
1282
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1283
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1284
|
+
) -> ApiResponse[List[str]]:
|
|
1285
|
+
"""List Recent Locations
|
|
1286
|
+
|
|
1287
|
+
Returns a list of recently visited locations.
|
|
1288
|
+
|
|
1289
|
+
:param n: The number of objects to return.
|
|
1290
|
+
:type n: int
|
|
1291
|
+
:param offset: A zero-based offset from the default object sorting from where search results start.
|
|
1292
|
+
:type offset: int
|
|
1293
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1294
|
+
number provided, it will be total request
|
|
1295
|
+
timeout. It can also be a pair (tuple) of
|
|
1296
|
+
(connection, read) timeouts.
|
|
1297
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1298
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1299
|
+
request; this effectively ignores the
|
|
1300
|
+
authentication in the spec for a single request.
|
|
1301
|
+
:type _request_auth: dict, optional
|
|
1302
|
+
:param _content_type: force content-type for the request.
|
|
1303
|
+
:type _content_type: str, Optional
|
|
1304
|
+
:param _headers: set to override the headers for a single
|
|
1305
|
+
request; this effectively ignores the headers
|
|
1306
|
+
in the spec for a single request.
|
|
1307
|
+
:type _headers: dict, optional
|
|
1308
|
+
:param _host_index: set to override the host_index for a single
|
|
1309
|
+
request; this effectively ignores the host_index
|
|
1310
|
+
in the spec for a single request.
|
|
1311
|
+
:type _host_index: int, optional
|
|
1312
|
+
:return: Returns the result object.
|
|
1313
|
+
""" # noqa: E501
|
|
1314
|
+
|
|
1315
|
+
_param = self._get_recent_locations_serialize(
|
|
1316
|
+
n=n,
|
|
1317
|
+
offset=offset,
|
|
1318
|
+
_request_auth=_request_auth,
|
|
1319
|
+
_content_type=_content_type,
|
|
1320
|
+
_headers=_headers,
|
|
1321
|
+
_host_index=_host_index
|
|
1322
|
+
)
|
|
1323
|
+
|
|
1324
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1325
|
+
'200': "List[str]",
|
|
1326
|
+
'401': "Error",
|
|
1327
|
+
}
|
|
1328
|
+
response_data = await self.api_client.call_api(
|
|
1329
|
+
*_param,
|
|
1330
|
+
_request_timeout=_request_timeout
|
|
1331
|
+
)
|
|
1332
|
+
await response_data.read()
|
|
1333
|
+
return self.api_client.response_deserialize(
|
|
1334
|
+
response_data=response_data,
|
|
1335
|
+
response_types_map=_response_types_map,
|
|
1336
|
+
)
|
|
1337
|
+
|
|
1338
|
+
|
|
1339
|
+
@validate_call
|
|
1340
|
+
async def get_recent_locations_without_preload_content(
|
|
1341
|
+
self,
|
|
1342
|
+
n: Annotated[Optional[Annotated[int, Field(le=100, strict=True, ge=1)]], Field(description="The number of objects to return.")] = None,
|
|
1343
|
+
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,
|
|
1344
|
+
_request_timeout: Union[
|
|
1345
|
+
None,
|
|
1346
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1347
|
+
Tuple[
|
|
1348
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1349
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1350
|
+
]
|
|
1351
|
+
] = None,
|
|
1352
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1353
|
+
_content_type: Optional[StrictStr] = None,
|
|
1354
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1355
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1356
|
+
) -> RESTResponseType:
|
|
1357
|
+
"""List Recent Locations
|
|
1358
|
+
|
|
1359
|
+
Returns a list of recently visited locations.
|
|
1360
|
+
|
|
1361
|
+
:param n: The number of objects to return.
|
|
1362
|
+
:type n: int
|
|
1363
|
+
:param offset: A zero-based offset from the default object sorting from where search results start.
|
|
1364
|
+
:type offset: int
|
|
1365
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1366
|
+
number provided, it will be total request
|
|
1367
|
+
timeout. It can also be a pair (tuple) of
|
|
1368
|
+
(connection, read) timeouts.
|
|
1369
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1370
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1371
|
+
request; this effectively ignores the
|
|
1372
|
+
authentication in the spec for a single request.
|
|
1373
|
+
:type _request_auth: dict, optional
|
|
1374
|
+
:param _content_type: force content-type for the request.
|
|
1375
|
+
:type _content_type: str, Optional
|
|
1376
|
+
:param _headers: set to override the headers for a single
|
|
1377
|
+
request; this effectively ignores the headers
|
|
1378
|
+
in the spec for a single request.
|
|
1379
|
+
:type _headers: dict, optional
|
|
1380
|
+
:param _host_index: set to override the host_index for a single
|
|
1381
|
+
request; this effectively ignores the host_index
|
|
1382
|
+
in the spec for a single request.
|
|
1383
|
+
:type _host_index: int, optional
|
|
1384
|
+
:return: Returns the result object.
|
|
1385
|
+
""" # noqa: E501
|
|
1386
|
+
|
|
1387
|
+
_param = self._get_recent_locations_serialize(
|
|
1388
|
+
n=n,
|
|
1389
|
+
offset=offset,
|
|
1390
|
+
_request_auth=_request_auth,
|
|
1391
|
+
_content_type=_content_type,
|
|
1392
|
+
_headers=_headers,
|
|
1393
|
+
_host_index=_host_index
|
|
1394
|
+
)
|
|
1395
|
+
|
|
1396
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1397
|
+
'200': "List[str]",
|
|
1398
|
+
'401': "Error",
|
|
1399
|
+
}
|
|
1400
|
+
response_data = await self.api_client.call_api(
|
|
1401
|
+
*_param,
|
|
1402
|
+
_request_timeout=_request_timeout
|
|
1403
|
+
)
|
|
1404
|
+
return response_data.response
|
|
1405
|
+
|
|
1406
|
+
|
|
1407
|
+
def _get_recent_locations_serialize(
|
|
1408
|
+
self,
|
|
1409
|
+
n,
|
|
1410
|
+
offset,
|
|
1411
|
+
_request_auth,
|
|
1412
|
+
_content_type,
|
|
1413
|
+
_headers,
|
|
1414
|
+
_host_index,
|
|
1415
|
+
) -> RequestSerialized:
|
|
1416
|
+
|
|
1417
|
+
_host = None
|
|
1418
|
+
|
|
1419
|
+
_collection_formats: Dict[str, str] = {
|
|
1420
|
+
}
|
|
1421
|
+
|
|
1422
|
+
_path_params: Dict[str, str] = {}
|
|
1423
|
+
_query_params: List[Tuple[str, str]] = []
|
|
1424
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
1425
|
+
_form_params: List[Tuple[str, str]] = []
|
|
1426
|
+
_files: Dict[
|
|
1427
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
1428
|
+
] = {}
|
|
1429
|
+
_body_params: Optional[bytes] = None
|
|
1430
|
+
|
|
1431
|
+
# process the path parameters
|
|
1432
|
+
# process the query parameters
|
|
1433
|
+
if n is not None:
|
|
1434
|
+
|
|
1435
|
+
_query_params.append(('n', n))
|
|
1436
|
+
|
|
1437
|
+
if offset is not None:
|
|
1438
|
+
|
|
1439
|
+
_query_params.append(('offset', offset))
|
|
1440
|
+
|
|
1441
|
+
# process the header parameters
|
|
1442
|
+
# process the form parameters
|
|
1443
|
+
# process the body parameter
|
|
1444
|
+
|
|
1445
|
+
|
|
1446
|
+
# set the HTTP header `Accept`
|
|
1447
|
+
if 'Accept' not in _header_params:
|
|
1448
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
1449
|
+
[
|
|
1450
|
+
'application/json'
|
|
1451
|
+
]
|
|
1452
|
+
)
|
|
1453
|
+
|
|
1454
|
+
|
|
1455
|
+
# authentication setting
|
|
1456
|
+
_auth_settings: List[str] = [
|
|
1457
|
+
'authCookie'
|
|
1458
|
+
]
|
|
1459
|
+
|
|
1460
|
+
return self.api_client.param_serialize(
|
|
1461
|
+
method='GET',
|
|
1462
|
+
resource_path='/instances/recent',
|
|
1463
|
+
path_params=_path_params,
|
|
1464
|
+
query_params=_query_params,
|
|
1465
|
+
header_params=_header_params,
|
|
1466
|
+
body=_body_params,
|
|
1467
|
+
post_params=_form_params,
|
|
1468
|
+
files=_files,
|
|
1469
|
+
auth_settings=_auth_settings,
|
|
1470
|
+
collection_formats=_collection_formats,
|
|
1471
|
+
_host=_host,
|
|
1472
|
+
_request_auth=_request_auth
|
|
1473
|
+
)
|
|
1474
|
+
|
|
1475
|
+
|
|
1476
|
+
|
|
1477
|
+
|
|
1478
|
+
@validate_call
|
|
1479
|
+
async def get_short_name(
|
|
1480
|
+
self,
|
|
1481
|
+
world_id: Annotated[StrictStr, Field(description="Must be a valid world ID.")],
|
|
1482
|
+
instance_id: Annotated[StrictStr, Field(description="Must be a valid instance ID.")],
|
|
1483
|
+
_request_timeout: Union[
|
|
1484
|
+
None,
|
|
1485
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1486
|
+
Tuple[
|
|
1487
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1488
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1489
|
+
]
|
|
1490
|
+
] = None,
|
|
1491
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1492
|
+
_content_type: Optional[StrictStr] = None,
|
|
1493
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1494
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1495
|
+
) -> InstanceShortNameResponse:
|
|
1496
|
+
"""Get Instance Short Name
|
|
1497
|
+
|
|
1498
|
+
Returns an instance short name.
|
|
1499
|
+
|
|
1500
|
+
:param world_id: Must be a valid world ID. (required)
|
|
1501
|
+
:type world_id: str
|
|
1502
|
+
:param instance_id: Must be a valid instance ID. (required)
|
|
1503
|
+
:type instance_id: str
|
|
1504
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1505
|
+
number provided, it will be total request
|
|
1506
|
+
timeout. It can also be a pair (tuple) of
|
|
1507
|
+
(connection, read) timeouts.
|
|
1508
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1509
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1510
|
+
request; this effectively ignores the
|
|
1511
|
+
authentication in the spec for a single request.
|
|
1512
|
+
:type _request_auth: dict, optional
|
|
1513
|
+
:param _content_type: force content-type for the request.
|
|
1514
|
+
:type _content_type: str, Optional
|
|
1515
|
+
:param _headers: set to override the headers for a single
|
|
1516
|
+
request; this effectively ignores the headers
|
|
1517
|
+
in the spec for a single request.
|
|
1518
|
+
:type _headers: dict, optional
|
|
1519
|
+
:param _host_index: set to override the host_index for a single
|
|
1520
|
+
request; this effectively ignores the host_index
|
|
1521
|
+
in the spec for a single request.
|
|
1522
|
+
:type _host_index: int, optional
|
|
1523
|
+
:return: Returns the result object.
|
|
1524
|
+
""" # noqa: E501
|
|
1525
|
+
|
|
1526
|
+
_param = self._get_short_name_serialize(
|
|
1527
|
+
world_id=world_id,
|
|
1528
|
+
instance_id=instance_id,
|
|
1529
|
+
_request_auth=_request_auth,
|
|
1530
|
+
_content_type=_content_type,
|
|
1531
|
+
_headers=_headers,
|
|
1532
|
+
_host_index=_host_index
|
|
1533
|
+
)
|
|
1534
|
+
|
|
1535
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1536
|
+
'200': "InstanceShortNameResponse",
|
|
1537
|
+
'401': "Error",
|
|
1538
|
+
}
|
|
1539
|
+
response_data = await self.api_client.call_api(
|
|
1540
|
+
*_param,
|
|
1541
|
+
_request_timeout=_request_timeout
|
|
1542
|
+
)
|
|
1543
|
+
await response_data.read()
|
|
1544
|
+
return self.api_client.response_deserialize(
|
|
1545
|
+
response_data=response_data,
|
|
1546
|
+
response_types_map=_response_types_map,
|
|
1547
|
+
).data
|
|
1548
|
+
|
|
1549
|
+
|
|
1550
|
+
@validate_call
|
|
1551
|
+
async def get_short_name_with_http_info(
|
|
1552
|
+
self,
|
|
1553
|
+
world_id: Annotated[StrictStr, Field(description="Must be a valid world ID.")],
|
|
1554
|
+
instance_id: Annotated[StrictStr, Field(description="Must be a valid instance ID.")],
|
|
1555
|
+
_request_timeout: Union[
|
|
1556
|
+
None,
|
|
1557
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1558
|
+
Tuple[
|
|
1559
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1560
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1561
|
+
]
|
|
1562
|
+
] = None,
|
|
1563
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1564
|
+
_content_type: Optional[StrictStr] = None,
|
|
1565
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1566
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1567
|
+
) -> ApiResponse[InstanceShortNameResponse]:
|
|
1568
|
+
"""Get Instance Short Name
|
|
1569
|
+
|
|
1570
|
+
Returns an instance short name.
|
|
1571
|
+
|
|
1572
|
+
:param world_id: Must be a valid world ID. (required)
|
|
1573
|
+
:type world_id: str
|
|
1574
|
+
:param instance_id: Must be a valid instance ID. (required)
|
|
1575
|
+
:type instance_id: str
|
|
1576
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1577
|
+
number provided, it will be total request
|
|
1578
|
+
timeout. It can also be a pair (tuple) of
|
|
1579
|
+
(connection, read) timeouts.
|
|
1580
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1581
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1582
|
+
request; this effectively ignores the
|
|
1583
|
+
authentication in the spec for a single request.
|
|
1584
|
+
:type _request_auth: dict, optional
|
|
1585
|
+
:param _content_type: force content-type for the request.
|
|
1586
|
+
:type _content_type: str, Optional
|
|
1587
|
+
:param _headers: set to override the headers for a single
|
|
1588
|
+
request; this effectively ignores the headers
|
|
1589
|
+
in the spec for a single request.
|
|
1590
|
+
:type _headers: dict, optional
|
|
1591
|
+
:param _host_index: set to override the host_index for a single
|
|
1592
|
+
request; this effectively ignores the host_index
|
|
1593
|
+
in the spec for a single request.
|
|
1594
|
+
:type _host_index: int, optional
|
|
1595
|
+
:return: Returns the result object.
|
|
1596
|
+
""" # noqa: E501
|
|
1597
|
+
|
|
1598
|
+
_param = self._get_short_name_serialize(
|
|
1599
|
+
world_id=world_id,
|
|
1600
|
+
instance_id=instance_id,
|
|
1601
|
+
_request_auth=_request_auth,
|
|
1602
|
+
_content_type=_content_type,
|
|
1603
|
+
_headers=_headers,
|
|
1604
|
+
_host_index=_host_index
|
|
1605
|
+
)
|
|
1606
|
+
|
|
1607
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1608
|
+
'200': "InstanceShortNameResponse",
|
|
1609
|
+
'401': "Error",
|
|
1610
|
+
}
|
|
1611
|
+
response_data = await self.api_client.call_api(
|
|
1612
|
+
*_param,
|
|
1613
|
+
_request_timeout=_request_timeout
|
|
1614
|
+
)
|
|
1615
|
+
await response_data.read()
|
|
1616
|
+
return self.api_client.response_deserialize(
|
|
1617
|
+
response_data=response_data,
|
|
1618
|
+
response_types_map=_response_types_map,
|
|
1619
|
+
)
|
|
1620
|
+
|
|
1621
|
+
|
|
1622
|
+
@validate_call
|
|
1623
|
+
async def get_short_name_without_preload_content(
|
|
1624
|
+
self,
|
|
1625
|
+
world_id: Annotated[StrictStr, Field(description="Must be a valid world ID.")],
|
|
1626
|
+
instance_id: Annotated[StrictStr, Field(description="Must be a valid instance ID.")],
|
|
1627
|
+
_request_timeout: Union[
|
|
1628
|
+
None,
|
|
1629
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1630
|
+
Tuple[
|
|
1631
|
+
Annotated[StrictFloat, Field(gt=0)],
|
|
1632
|
+
Annotated[StrictFloat, Field(gt=0)]
|
|
1633
|
+
]
|
|
1634
|
+
] = None,
|
|
1635
|
+
_request_auth: Optional[Dict[StrictStr, Any]] = None,
|
|
1636
|
+
_content_type: Optional[StrictStr] = None,
|
|
1637
|
+
_headers: Optional[Dict[StrictStr, Any]] = None,
|
|
1638
|
+
_host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
|
|
1639
|
+
) -> RESTResponseType:
|
|
1640
|
+
"""Get Instance Short Name
|
|
1641
|
+
|
|
1642
|
+
Returns an instance short name.
|
|
1643
|
+
|
|
1644
|
+
:param world_id: Must be a valid world ID. (required)
|
|
1645
|
+
:type world_id: str
|
|
1646
|
+
:param instance_id: Must be a valid instance ID. (required)
|
|
1647
|
+
:type instance_id: str
|
|
1648
|
+
:param _request_timeout: timeout setting for this request. If one
|
|
1649
|
+
number provided, it will be total request
|
|
1650
|
+
timeout. It can also be a pair (tuple) of
|
|
1651
|
+
(connection, read) timeouts.
|
|
1652
|
+
:type _request_timeout: int, tuple(int, int), optional
|
|
1653
|
+
:param _request_auth: set to override the auth_settings for an a single
|
|
1654
|
+
request; this effectively ignores the
|
|
1655
|
+
authentication in the spec for a single request.
|
|
1656
|
+
:type _request_auth: dict, optional
|
|
1657
|
+
:param _content_type: force content-type for the request.
|
|
1658
|
+
:type _content_type: str, Optional
|
|
1659
|
+
:param _headers: set to override the headers for a single
|
|
1660
|
+
request; this effectively ignores the headers
|
|
1661
|
+
in the spec for a single request.
|
|
1662
|
+
:type _headers: dict, optional
|
|
1663
|
+
:param _host_index: set to override the host_index for a single
|
|
1664
|
+
request; this effectively ignores the host_index
|
|
1665
|
+
in the spec for a single request.
|
|
1666
|
+
:type _host_index: int, optional
|
|
1667
|
+
:return: Returns the result object.
|
|
1668
|
+
""" # noqa: E501
|
|
1669
|
+
|
|
1670
|
+
_param = self._get_short_name_serialize(
|
|
1671
|
+
world_id=world_id,
|
|
1672
|
+
instance_id=instance_id,
|
|
1673
|
+
_request_auth=_request_auth,
|
|
1674
|
+
_content_type=_content_type,
|
|
1675
|
+
_headers=_headers,
|
|
1676
|
+
_host_index=_host_index
|
|
1677
|
+
)
|
|
1678
|
+
|
|
1679
|
+
_response_types_map: Dict[str, Optional[str]] = {
|
|
1680
|
+
'200': "InstanceShortNameResponse",
|
|
1681
|
+
'401': "Error",
|
|
1682
|
+
}
|
|
1683
|
+
response_data = await self.api_client.call_api(
|
|
1684
|
+
*_param,
|
|
1685
|
+
_request_timeout=_request_timeout
|
|
1686
|
+
)
|
|
1687
|
+
return response_data.response
|
|
1688
|
+
|
|
1689
|
+
|
|
1690
|
+
def _get_short_name_serialize(
|
|
1691
|
+
self,
|
|
1692
|
+
world_id,
|
|
1693
|
+
instance_id,
|
|
1694
|
+
_request_auth,
|
|
1695
|
+
_content_type,
|
|
1696
|
+
_headers,
|
|
1697
|
+
_host_index,
|
|
1698
|
+
) -> RequestSerialized:
|
|
1699
|
+
|
|
1700
|
+
_host = None
|
|
1701
|
+
|
|
1702
|
+
_collection_formats: Dict[str, str] = {
|
|
1703
|
+
}
|
|
1704
|
+
|
|
1705
|
+
_path_params: Dict[str, str] = {}
|
|
1706
|
+
_query_params: List[Tuple[str, str]] = []
|
|
1707
|
+
_header_params: Dict[str, Optional[str]] = _headers or {}
|
|
1708
|
+
_form_params: List[Tuple[str, str]] = []
|
|
1709
|
+
_files: Dict[
|
|
1710
|
+
str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
|
|
1711
|
+
] = {}
|
|
1712
|
+
_body_params: Optional[bytes] = None
|
|
1713
|
+
|
|
1714
|
+
# process the path parameters
|
|
1715
|
+
if world_id is not None:
|
|
1716
|
+
_path_params['worldId'] = world_id
|
|
1717
|
+
if instance_id is not None:
|
|
1718
|
+
_path_params['instanceId'] = instance_id
|
|
1719
|
+
# process the query parameters
|
|
1720
|
+
# process the header parameters
|
|
1721
|
+
# process the form parameters
|
|
1722
|
+
# process the body parameter
|
|
1723
|
+
|
|
1724
|
+
|
|
1725
|
+
# set the HTTP header `Accept`
|
|
1726
|
+
if 'Accept' not in _header_params:
|
|
1727
|
+
_header_params['Accept'] = self.api_client.select_header_accept(
|
|
1728
|
+
[
|
|
1729
|
+
'application/json'
|
|
1730
|
+
]
|
|
1731
|
+
)
|
|
1732
|
+
|
|
1733
|
+
|
|
1734
|
+
# authentication setting
|
|
1735
|
+
_auth_settings: List[str] = [
|
|
1736
|
+
'authCookie'
|
|
1737
|
+
]
|
|
1738
|
+
|
|
1739
|
+
return self.api_client.param_serialize(
|
|
1740
|
+
method='GET',
|
|
1741
|
+
resource_path='/instances/{worldId}:{instanceId}/shortName',
|
|
1742
|
+
path_params=_path_params,
|
|
1743
|
+
query_params=_query_params,
|
|
1744
|
+
header_params=_header_params,
|
|
1745
|
+
body=_body_params,
|
|
1746
|
+
post_params=_form_params,
|
|
1747
|
+
files=_files,
|
|
1748
|
+
auth_settings=_auth_settings,
|
|
1749
|
+
collection_formats=_collection_formats,
|
|
1750
|
+
_host=_host,
|
|
1751
|
+
_request_auth=_request_auth
|
|
1752
|
+
)
|
|
1753
|
+
|
|
1754
|
+
|