symbols:
# region models
'ApiBackFillAcceptRequest@py.match2.mod':
id: 'ApiBackFillAcceptRequest@py.match2.mod'
name: 'ApiBackFillAcceptRequest'
type: 'model'
fields:
'proposal_id':
type: 'str'
required: true
'stop':
type: 'bool'
required: true
'accepted_ticket_ids':
type: 'List[str]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_back_fill_accept_request.py'
example: |-
api_back_fill_accept_request = match2_models.ApiBackFillAcceptRequest.create(...)
'ApiBackFillCreateRequest@py.match2.mod':
id: 'ApiBackFillCreateRequest@py.match2.mod'
name: 'ApiBackFillCreateRequest'
type: 'model'
fields:
'match_pool':
type: 'str'
required: true
'session_id':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_back_fill_create_request.py'
example: |-
api_back_fill_create_request = match2_models.ApiBackFillCreateRequest.create(...)
'ApiBackfillCreateResponse@py.match2.mod':
id: 'ApiBackfillCreateResponse@py.match2.mod'
name: 'ApiBackfillCreateResponse'
type: 'model'
fields:
'id_':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_backfill_create_response.py'
example: |-
api_backfill_create_response = match2_models.ApiBackfillCreateResponse.create(...)
'ApiBackfillGetResponse@py.match2.mod':
id: 'ApiBackfillGetResponse@py.match2.mod'
name: 'ApiBackfillGetResponse'
type: 'model'
fields:
'created_at':
type: 'str'
required: false
'match_pool':
type: 'str'
required: false
'match_session_id':
type: 'str'
required: false
'partial_match':
type: 'ApiMatch'
required: false
'ticket_id':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_backfill_get_response.py'
example: |-
api_backfill_get_response = match2_models.ApiBackfillGetResponse.create(...)
'ApiBackfillProposalResponse@py.match2.mod':
id: 'ApiBackfillProposalResponse@py.match2.mod'
name: 'ApiBackfillProposalResponse'
type: 'model'
fields:
'backfill_ticket_id':
type: 'str'
required: false
'created_at':
type: 'str'
required: false
'match_pool':
type: 'str'
required: false
'match_session_id':
type: 'str'
required: false
'proposal_id':
type: 'str'
required: false
'proposed_teams':
type: 'List[ApiTeam]'
required: false
'tickets':
type: 'List[ApiTicket]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_backfill_proposal_response.py'
example: |-
api_backfill_proposal_response = match2_models.ApiBackfillProposalResponse.create(...)
'ApiBackFillRejectRequest@py.match2.mod':
id: 'ApiBackFillRejectRequest@py.match2.mod'
name: 'ApiBackFillRejectRequest'
type: 'model'
fields:
'proposal_id':
type: 'str'
required: true
'stop':
type: 'bool'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_back_fill_reject_request.py'
example: |-
api_back_fill_reject_request = match2_models.ApiBackFillRejectRequest.create(...)
'ApiExternalFailureMetricRecord@py.match2.mod':
id: 'ApiExternalFailureMetricRecord@py.match2.mod'
name: 'ApiExternalFailureMetricRecord'
type: 'model'
fields:
'type_':
type: 'Union[str, TypeEnum]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_external_failure_metric_record.py'
example: |-
api_external_failure_metric_record = match2_models.ApiExternalFailureMetricRecord.create(...)
'ApiListBackfillQueryResponse@py.match2.mod':
id: 'ApiListBackfillQueryResponse@py.match2.mod'
name: 'ApiListBackfillQueryResponse'
type: 'model'
fields:
'data':
type: 'List[ApiBackfillGetResponse]'
required: true
'pagination':
type: 'ModelsPagination'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_list_backfill_query_response.py'
example: |-
api_list_backfill_query_response = match2_models.ApiListBackfillQueryResponse.create(...)
'ApiListEnvironmentVariablesResponse@py.match2.mod':
id: 'ApiListEnvironmentVariablesResponse@py.match2.mod'
name: 'ApiListEnvironmentVariablesResponse'
type: 'model'
fields:
'data':
type: 'List[ConfigEnvironmentVariable]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_list_environment_variables_response.py'
example: |-
api_list_environment_variables_response = match2_models.ApiListEnvironmentVariablesResponse.create(...)
'ApiListMatchFunctionsResponse@py.match2.mod':
id: 'ApiListMatchFunctionsResponse@py.match2.mod'
name: 'ApiListMatchFunctionsResponse'
type: 'model'
fields:
'functions':
type: 'List[str]'
required: true
'pagination':
type: 'ModelsPagination'
required: true
'configs':
type: 'List[ApiMatchFunctionConfig]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_list_match_functions_response.py'
example: |-
api_list_match_functions_response = match2_models.ApiListMatchFunctionsResponse.create(...)
'ApiListMatchPoolsResponse@py.match2.mod':
id: 'ApiListMatchPoolsResponse@py.match2.mod'
name: 'ApiListMatchPoolsResponse'
type: 'model'
fields:
'data':
type: 'List[ApiMatchPool]'
required: false
'pagination':
type: 'ModelsPagination'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_list_match_pools_response.py'
example: |-
api_list_match_pools_response = match2_models.ApiListMatchPoolsResponse.create(...)
'ApiListMatchPoolTicketsResponse@py.match2.mod':
id: 'ApiListMatchPoolTicketsResponse@py.match2.mod'
name: 'ApiListMatchPoolTicketsResponse'
type: 'model'
fields:
'data':
type: 'List[MatchmakerMatchTicketRecord]'
required: true
'total_data':
type: 'int'
required: true
'pagination':
type: 'ModelsPagination'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_list_match_pool_tickets_response.py'
example: |-
api_list_match_pool_tickets_response = match2_models.ApiListMatchPoolTicketsResponse.create(...)
'ApiListRuleSetsResponse@py.match2.mod':
id: 'ApiListRuleSetsResponse@py.match2.mod'
name: 'ApiListRuleSetsResponse'
type: 'model'
fields:
'data':
type: 'List[ApiMatchRuleSetNameData]'
required: false
'pagination':
type: 'ModelsPagination'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_list_rule_sets_response.py'
example: |-
api_list_rule_sets_response = match2_models.ApiListRuleSetsResponse.create(...)
'ApiMatch@py.match2.mod':
id: 'ApiMatch@py.match2.mod'
name: 'ApiMatch'
type: 'model'
fields:
'backfill':
type: 'bool'
required: false
'client_version':
type: 'str'
required: false
'match_attributes':
type: 'Dict[str, Any]'
required: false
'region_preference':
type: 'List[str]'
required: false
'server_name':
type: 'str'
required: false
'teams':
type: 'List[ApiTeam]'
required: false
'tickets':
type: 'List[ApiTicket]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_match.py'
example: |-
api_match = match2_models.ApiMatch.create(...)
'ApiMatchFunctionConfig@py.match2.mod':
id: 'ApiMatchFunctionConfig@py.match2.mod'
name: 'ApiMatchFunctionConfig'
type: 'model'
fields:
'match_function':
type: 'str'
required: true
'url':
type: 'str'
required: true
'service_app_name':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_match_function_config.py'
example: |-
api_match_function_config = match2_models.ApiMatchFunctionConfig.create(...)
'ApiMatchFunctionOverride@py.match2.mod':
id: 'ApiMatchFunctionOverride@py.match2.mod'
name: 'ApiMatchFunctionOverride'
type: 'model'
fields:
'backfill_matches':
type: 'str'
required: false
'enrichment':
type: 'List[str]'
required: false
'make_matches':
type: 'str'
required: false
'stat_codes':
type: 'List[str]'
required: false
'validation':
type: 'List[str]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_match_function_override.py'
example: |-
api_match_function_override = match2_models.ApiMatchFunctionOverride.create(...)
'ApiMatchFunctionRequest@py.match2.mod':
id: 'ApiMatchFunctionRequest@py.match2.mod'
name: 'ApiMatchFunctionRequest'
type: 'model'
fields:
'match_function':
type: 'str'
required: true
'url':
type: 'str'
required: true
'service_app_name':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_match_function_request.py'
example: |-
api_match_function_request = match2_models.ApiMatchFunctionRequest.create(...)
'ApiMatchPool@py.match2.mod':
id: 'ApiMatchPool@py.match2.mod'
name: 'ApiMatchPool'
type: 'model'
fields:
'auto_accept_backfill_proposal':
type: 'bool'
required: true
'backfill_proposal_expiration_seconds':
type: 'int'
required: true
'backfill_ticket_expiration_seconds':
type: 'int'
required: true
'match_function':
type: 'str'
required: true
'match_function_override':
type: 'ApiMatchFunctionOverride'
required: true
'name':
type: 'str'
required: true
'rule_set':
type: 'str'
required: true
'session_template':
type: 'str'
required: true
'ticket_expiration_seconds':
type: 'int'
required: true
'best_latency_calculation_method':
type: 'str'
required: false
'crossplay_disabled':
type: 'bool'
required: false
'platform_group_enabled':
type: 'bool'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_match_pool.py'
example: |-
api_match_pool = match2_models.ApiMatchPool.create(...)
'ApiMatchPoolConfig@py.match2.mod':
id: 'ApiMatchPoolConfig@py.match2.mod'
name: 'ApiMatchPoolConfig'
type: 'model'
fields:
'auto_accept_backfill_proposal':
type: 'bool'
required: true
'backfill_proposal_expiration_seconds':
type: 'int'
required: true
'backfill_ticket_expiration_seconds':
type: 'int'
required: true
'match_function':
type: 'str'
required: true
'match_function_override':
type: 'ApiMatchFunctionOverride'
required: true
'rule_set':
type: 'str'
required: true
'session_template':
type: 'str'
required: true
'ticket_expiration_seconds':
type: 'int'
required: true
'best_latency_calculation_method':
type: 'str'
required: false
'crossplay_disabled':
type: 'bool'
required: false
'platform_group_enabled':
type: 'bool'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_match_pool_config.py'
example: |-
api_match_pool_config = match2_models.ApiMatchPoolConfig.create(...)
'ApiMatchRuleSetNameData@py.match2.mod':
id: 'ApiMatchRuleSetNameData@py.match2.mod'
name: 'ApiMatchRuleSetNameData'
type: 'model'
fields:
'name':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_match_rule_set_name_data.py'
example: |-
api_match_rule_set_name_data = match2_models.ApiMatchRuleSetNameData.create(...)
'ApiMatchTicketRequest@py.match2.mod':
id: 'ApiMatchTicketRequest@py.match2.mod'
name: 'ApiMatchTicketRequest'
type: 'model'
fields:
'attributes':
type: 'Dict[str, Any]'
required: true
'latencies':
type: 'Dict[str, int]'
required: true
'match_pool':
type: 'str'
required: true
'excluded_sessions':
type: 'List[str]'
required: false
'session_id':
type: 'str'
required: false
'storage':
type: 'Dict[str, Any]'
required: false
description: |-
leader session storage
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_match_ticket_request.py'
example: |-
api_match_ticket_request = match2_models.ApiMatchTicketRequest.create(...)
'ApiMatchTicketResponse@py.match2.mod':
id: 'ApiMatchTicketResponse@py.match2.mod'
name: 'ApiMatchTicketResponse'
type: 'model'
fields:
'match_ticket_id':
type: 'str'
required: true
'queue_time':
type: 'int'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_match_ticket_response.py'
example: |-
api_match_ticket_response = match2_models.ApiMatchTicketResponse.create(...)
'ApiMatchTicketStatus@py.match2.mod':
id: 'ApiMatchTicketStatus@py.match2.mod'
name: 'ApiMatchTicketStatus'
type: 'model'
fields:
'match_found':
type: 'bool'
required: true
'session_id':
type: 'str'
required: true
'is_active':
type: 'bool'
required: false
'match_pool':
type: 'str'
required: false
'match_ticket_id':
type: 'str'
required: false
'proposed_proposal':
type: 'ApiProposedProposal'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_match_ticket_status.py'
example: |-
api_match_ticket_status = match2_models.ApiMatchTicketStatus.create(...)
'ApiMatchTicketStatuses@py.match2.mod':
id: 'ApiMatchTicketStatuses@py.match2.mod'
name: 'ApiMatchTicketStatuses'
type: 'model'
fields:
'data':
type: 'List[ApiMatchTicketStatus]'
required: true
'pagination':
type: 'ModelsPagination'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_match_ticket_statuses.py'
example: |-
api_match_ticket_statuses = match2_models.ApiMatchTicketStatuses.create(...)
'ApiNamespaceConfigList@py.match2.mod':
id: 'ApiNamespaceConfigList@py.match2.mod'
name: 'ApiNamespaceConfigList'
type: 'model'
fields:
'configs':
type: 'List[ConfigmodelsNamespaceConfig]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_namespace_config_list.py'
example: |-
api_namespace_config_list = match2_models.ApiNamespaceConfigList.create(...)
'ApiParty@py.match2.mod':
id: 'ApiParty@py.match2.mod'
name: 'ApiParty'
type: 'model'
fields:
'party_id':
type: 'str'
required: false
'user_i_ds':
type: 'List[str]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_party.py'
example: |-
api_party = match2_models.ApiParty.create(...)
'ApiPatchNamespaceConfigRequest@py.match2.mod':
id: 'ApiPatchNamespaceConfigRequest@py.match2.mod'
name: 'ApiPatchNamespaceConfigRequest'
type: 'model'
fields:
'cross_platform_no_current_platform':
type: 'bool'
required: false
'extra_platforms':
type: 'List[str]'
required: false
description: |-
additional platforms that will be included in the cross_platform attribute alongside the login method
'match_any_common':
type: 'bool'
required: false
'platform_group':
type: 'Dict[str, List[str]]'
required: false
'xray_max_whitelisted_user_count':
type: 'int'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_patch_namespace_config_request.py'
example: |-
api_patch_namespace_config_request = match2_models.ApiPatchNamespaceConfigRequest.create(...)
'ApiPlayerData@py.match2.mod':
id: 'ApiPlayerData@py.match2.mod'
name: 'ApiPlayerData'
type: 'model'
fields:
'attributes':
type: 'Dict[str, Any]'
required: false
'party_id':
type: 'str'
required: false
'player_id':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_player_data.py'
example: |-
api_player_data = match2_models.ApiPlayerData.create(...)
'ApiPlayerMetricRecord@py.match2.mod':
id: 'ApiPlayerMetricRecord@py.match2.mod'
name: 'ApiPlayerMetricRecord'
type: 'model'
fields:
'player_in_queue':
type: 'int'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_player_metric_record.py'
example: |-
api_player_metric_record = match2_models.ApiPlayerMetricRecord.create(...)
'ApiProposedProposal@py.match2.mod':
id: 'ApiProposedProposal@py.match2.mod'
name: 'ApiProposedProposal'
type: 'model'
fields:
'backfill_id':
type: 'str'
required: false
'proposal_id':
type: 'str'
required: false
'status':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_proposed_proposal.py'
example: |-
api_proposed_proposal = match2_models.ApiProposedProposal.create(...)
'ApiRuleSetPayload@py.match2.mod':
id: 'ApiRuleSetPayload@py.match2.mod'
name: 'ApiRuleSetPayload'
type: 'model'
fields:
'data':
type: 'Dict[str, Any]'
required: true
'enable_custom_match_function':
type: 'bool'
required: true
'name':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_rule_set_payload.py'
example: |-
api_rule_set_payload = match2_models.ApiRuleSetPayload.create(...)
'ApiTeam@py.match2.mod':
id: 'ApiTeam@py.match2.mod'
name: 'ApiTeam'
type: 'model'
fields:
'parties':
type: 'List[ApiParty]'
required: false
'team_id':
type: 'str'
required: false
'user_i_ds':
type: 'List[str]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_team.py'
example: |-
api_team = match2_models.ApiTeam.create(...)
'ApiTicket@py.match2.mod':
id: 'ApiTicket@py.match2.mod'
name: 'ApiTicket'
type: 'model'
fields:
'created_at':
type: 'str'
required: false
'latencies':
type: 'Dict[str, int]'
required: false
'match_pool':
type: 'str'
required: false
'namespace':
type: 'str'
required: false
'party_session_id':
type: 'str'
required: false
'players':
type: 'List[ApiPlayerData]'
required: false
'ticket_attributes':
type: 'Dict[str, Any]'
required: false
'ticket_id':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_ticket.py'
example: |-
api_ticket = match2_models.ApiTicket.create(...)
'ApiTicketMetricResultRecord@py.match2.mod':
id: 'ApiTicketMetricResultRecord@py.match2.mod'
name: 'ApiTicketMetricResultRecord'
type: 'model'
fields:
'queue_time':
type: 'int'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/api_ticket_metric_result_record.py'
example: |-
api_ticket_metric_result_record = match2_models.ApiTicketMetricResultRecord.create(...)
'ConfigEnvironmentVariable@py.match2.mod':
id: 'ConfigEnvironmentVariable@py.match2.mod'
name: 'ConfigEnvironmentVariable'
type: 'model'
fields:
'name':
type: 'str'
required: true
'actual_value':
type: 'str'
required: false
'default_value':
type: 'str'
required: false
'description':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/config_environment_variable.py'
example: |-
config_environment_variable = match2_models.ConfigEnvironmentVariable.create(...)
'ConfigmodelsNamespaceConfig@py.match2.mod':
id: 'ConfigmodelsNamespaceConfig@py.match2.mod'
name: 'ConfigmodelsNamespaceConfig'
type: 'model'
fields:
'namespace':
type: 'str'
required: true
'xray_max_whitelisted_user_count':
type: 'int'
required: true
'cross_platform_no_current_platform':
type: 'bool'
required: false
'extra_platforms':
type: 'List[str]'
required: false
'match_any_common':
type: 'bool'
required: false
'platform_group':
type: 'Dict[str, List[str]]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/configmodels_namespace_config.py'
example: |-
configmodels_namespace_config = match2_models.ConfigmodelsNamespaceConfig.create(...)
'LogconfigConfiguration@py.match2.mod':
id: 'LogconfigConfiguration@py.match2.mod'
name: 'LogconfigConfiguration'
type: 'model'
fields:
'log_level':
type: 'Union[str, LogLevelEnum]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/logconfig_configuration.py'
example: |-
logconfig_configuration = match2_models.LogconfigConfiguration.create(...)
'MatchmakerMatchTicketRecord@py.match2.mod':
id: 'MatchmakerMatchTicketRecord@py.match2.mod'
name: 'MatchmakerMatchTicketRecord'
type: 'model'
fields:
'created_at':
type: 'str'
required: true
'expired_at':
type: 'str'
required: true
'is_active':
type: 'bool'
required: true
'party_session_id':
type: 'str'
required: true
'proposed_proposal':
type: 'MatchmakerProposedProposal'
required: true
'session_id':
type: 'str'
required: true
'ticket':
type: 'MatchmakerTicket'
required: true
'ticket_id':
type: 'str'
required: true
'unique_ticket_id':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/matchmaker_match_ticket_record.py'
example: |-
matchmaker_match_ticket_record = match2_models.MatchmakerMatchTicketRecord.create(...)
'MatchmakerParty@py.match2.mod':
id: 'MatchmakerParty@py.match2.mod'
name: 'MatchmakerParty'
type: 'model'
fields:
'party_id':
type: 'str'
required: false
'user_i_ds':
type: 'List[str]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/matchmaker_party.py'
example: |-
matchmaker_party = match2_models.MatchmakerParty.create(...)
'MatchmakerProposedProposal@py.match2.mod':
id: 'MatchmakerProposedProposal@py.match2.mod'
name: 'MatchmakerProposedProposal'
type: 'model'
fields:
'backfill_id':
type: 'str'
required: true
'proposal_id':
type: 'str'
required: true
'status':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/matchmaker_proposed_proposal.py'
example: |-
matchmaker_proposed_proposal = match2_models.MatchmakerProposedProposal.create(...)
'MatchmakerTeam@py.match2.mod':
id: 'MatchmakerTeam@py.match2.mod'
name: 'MatchmakerTeam'
type: 'model'
fields:
'parties':
type: 'List[MatchmakerParty]'
required: false
'team_id':
type: 'str'
required: false
'user_i_ds':
type: 'List[str]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/matchmaker_team.py'
example: |-
matchmaker_team = match2_models.MatchmakerTeam.create(...)
'MatchmakerTicket@py.match2.mod':
id: 'MatchmakerTicket@py.match2.mod'
name: 'MatchmakerTicket'
type: 'model'
fields:
'created_at':
type: 'str'
required: true
'excluded_sessions':
type: 'List[str]'
required: true
'is_active':
type: 'bool'
required: true
'is_pivot':
type: 'bool'
required: true
'is_single_play':
type: 'bool'
required: true
'latencies':
type: 'Dict[str, int]'
required: true
'match_pool':
type: 'str'
required: true
'matched_at':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
'party_session_id':
type: 'str'
required: true
'players':
type: 'List[PlayerPlayerData]'
required: true
'proposed_proposal':
type: 'MatchmakerProposedProposal'
required: true
'ticket_attributes':
type: 'Dict[str, Any]'
required: true
'ticket_id':
type: 'str'
required: true
'ticket_information':
type: 'Dict[str, Any]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/matchmaker_ticket.py'
example: |-
matchmaker_ticket = match2_models.MatchmakerTicket.create(...)
'ModelsConfiguration@py.match2.mod':
id: 'ModelsConfiguration@py.match2.mod'
name: 'ModelsConfiguration'
type: 'model'
fields:
'client_version':
type: 'str'
required: true
'deployment':
type: 'str'
required: true
'inactive_timeout':
type: 'int'
required: true
'invite_timeout':
type: 'int'
required: true
'joinability':
type: 'str'
required: true
'max_players':
type: 'int'
required: true
'min_players':
type: 'int'
required: true
'name':
type: 'str'
required: true
'requested_regions':
type: 'List[str]'
required: true
'type_':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/models_configuration.py'
example: |-
models_configuration = match2_models.ModelsConfiguration.create(...)
'ModelsDSInformation@py.match2.mod':
id: 'ModelsDSInformation@py.match2.mod'
name: 'ModelsDSInformation'
type: 'model'
fields:
'min_players':
type: 'int'
required: true
'requested_at':
type: 'str'
required: true
'requested_regions':
type: 'List[str]'
required: true
'server':
type: 'ModelsServer'
required: true
'status':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/models_ds_information.py'
example: |-
models_ds_information = match2_models.ModelsDSInformation.create(...)
'ModelsGameSession@py.match2.mod':
id: 'ModelsGameSession@py.match2.mod'
name: 'ModelsGameSession'
type: 'model'
fields:
'attributes':
type: 'Dict[str, Any]'
required: true
'backfill_ticket_id':
type: 'str'
required: true
'configuration':
type: 'ModelsConfiguration'
required: true
'created_at':
type: 'str'
required: true
'ds_information':
type: 'ModelsDSInformation'
required: true
'game_mode':
type: 'str'
required: true
'id_':
type: 'str'
required: true
'is_full':
type: 'bool'
required: true
'join_type':
type: 'str'
required: true
'leader_id':
type: 'str'
required: true
'match_pool':
type: 'str'
required: true
'members':
type: 'List[ModelsUser]'
required: true
'namespace':
type: 'str'
required: true
'teams':
type: 'List[MatchmakerTeam]'
required: true
'updated_at':
type: 'str'
required: true
'version':
type: 'int'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/models_game_session.py'
example: |-
models_game_session = match2_models.ModelsGameSession.create(...)
'ModelsPagination@py.match2.mod':
id: 'ModelsPagination@py.match2.mod'
name: 'ModelsPagination'
type: 'model'
fields:
'first':
type: 'str'
required: true
'last':
type: 'str'
required: true
'next_':
type: 'str'
required: true
'previous':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/models_pagination.py'
example: |-
models_pagination = match2_models.ModelsPagination.create(...)
'ModelsPlayFeatureFlag@py.match2.mod':
id: 'ModelsPlayFeatureFlag@py.match2.mod'
name: 'ModelsPlayFeatureFlag'
type: 'model'
fields:
'enable_auto_cancel_match_user_disconnect':
type: 'bool'
required: true
'enable_auto_cancel_match_user_leave':
type: 'bool'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/models_play_feature_flag.py'
example: |-
models_play_feature_flag = match2_models.ModelsPlayFeatureFlag.create(...)
'ModelsServer@py.match2.mod':
id: 'ModelsServer@py.match2.mod'
name: 'ModelsServer'
type: 'model'
fields:
'alternate_ips':
type: 'List[str]'
required: true
'custom_attribute':
type: 'str'
required: true
'deployment':
type: 'str'
required: true
'game_version':
type: 'str'
required: true
'image_version':
type: 'str'
required: true
'ip':
type: 'str'
required: true
'is_override_game_version':
type: 'bool'
required: true
'last_update':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
'pod_name':
type: 'str'
required: true
'port':
type: 'int'
required: true
'ports':
type: 'Dict[str, int]'
required: true
'protocol':
type: 'str'
required: true
'provider':
type: 'str'
required: true
'region':
type: 'str'
required: true
'session_id':
type: 'str'
required: true
'status':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/models_server.py'
example: |-
models_server = match2_models.ModelsServer.create(...)
'ModelsUser@py.match2.mod':
id: 'ModelsUser@py.match2.mod'
name: 'ModelsUser'
type: 'model'
fields:
'id_':
type: 'str'
required: true
'platform_id':
type: 'str'
required: true
'platform_user_id':
type: 'str'
required: true
'status':
type: 'str'
required: true
'status_v2':
type: 'str'
required: true
'updated_at':
type: 'str'
required: true
'previous_status':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/models_user.py'
example: |-
models_user = match2_models.ModelsUser.create(...)
'ModelsXRayConfigHttpResponse@py.match2.mod':
id: 'ModelsXRayConfigHttpResponse@py.match2.mod'
name: 'ModelsXRayConfigHttpResponse'
type: 'model'
fields:
'whitelisted_users':
type: 'List[str]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/models_x_ray_config_http_response.py'
example: |-
models_x_ray_config_http_response = match2_models.ModelsXRayConfigHttpResponse.create(...)
'ModelsXRayConfigHttpUpdateRequest@py.match2.mod':
id: 'ModelsXRayConfigHttpUpdateRequest@py.match2.mod'
name: 'ModelsXRayConfigHttpUpdateRequest'
type: 'model'
fields:
'whitelisted_users':
type: 'List[str]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/models_x_ray_config_http_update_request.py'
example: |-
models_x_ray_config_http_update_request = match2_models.ModelsXRayConfigHttpUpdateRequest.create(...)
'PlayerPlayerData@py.match2.mod':
id: 'PlayerPlayerData@py.match2.mod'
name: 'PlayerPlayerData'
type: 'model'
fields:
'attributes':
type: 'Dict[str, Any]'
required: true
'party_id':
type: 'str'
required: true
'platform_id':
type: 'str'
required: true
'player_id':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/player_player_data.py'
example: |-
player_player_data = match2_models.PlayerPlayerData.create(...)
'ResponseError@py.match2.mod':
id: 'ResponseError@py.match2.mod'
name: 'ResponseError'
type: 'model'
fields:
'error_code':
type: 'int'
required: true
'error_message':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/models/response_error.py'
example: |-
response_error = match2_models.ResponseError.create(...)
# endregion models
# region functions
'accept_backfill@py.match2.fun':
id: 'accept_backfill@py.match2.fun'
name: 'accept_backfill'
type: 'function'
description: |-
Accept backfill proposal.
Field **acceptedTicketIds** can be used to accept specific tickets within a backfill proposal. If the ticketIDs are not mentioned in this field, those tickets will be rejected and reactivated for future proposals.
If **acceptedTicketIds** is nil or not specified, then all tickets in the proposal will be accepted.
arguments:
'backfill_id':
type: 'str'
required: true
description: |-
backfill Ticket ID
'body':
type: 'ApiBackFillAcceptRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ModelsGameSession], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/backfill/accept_backfill.py'
example: |-
result, error = match2.accept_backfill(...)
if error:
# handle_error(error)
tags:
- 'accept'
- 'backfill'
- 'public'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:BACKFILL [UPDATE]'
'admin_delete_play_feature_flag@py.match2.fun':
id: 'admin_delete_play_feature_flag@py.match2.fun'
name: 'admin_delete_play_feature_flag'
type: 'function'
description: |-
Delete matchmaking Play Feature Flag.
Deleting the current namespace's custom config only removes it from the database, the system will then use the environment variable defined in the ConfigMap instead.
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/play_feature_flag/admin_delete_play_feature_flag.py'
example: |-
result, error = match2.admin_delete_play_feature_flag(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'delete'
- 'feature'
- 'flag'
- 'play'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MATCHMAKING:PLAYFEATUREFLAG [DELETE]'
'admin_get_all_config_v1@py.match2.fun':
id: 'admin_get_all_config_v1@py.match2.fun'
name: 'admin_get_all_config_v1'
type: 'function'
description: |-
Get matchmaking config of all namespaces. Will only return namespace configs than have been updated.
return_type: 'Tuple[Union[None, ApiNamespaceConfigList], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/config/admin_get_all_config_v1.py'
example: |-
result, error = match2.admin_get_all_config_v1(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'all'
- 'config'
- 'get'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:*:MATCHMAKING:CONFIG [READ]'
'admin_get_config_v1@py.match2.fun':
id: 'admin_get_config_v1@py.match2.fun'
name: 'admin_get_config_v1'
type: 'function'
description: |-
Get matchmaking config of a namespaces.
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ConfigmodelsNamespaceConfig], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/config/admin_get_config_v1.py'
example: |-
result, error = match2.admin_get_config_v1(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'config'
- 'get'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MATCHMAKING:CONFIG [READ]'
'admin_get_log_config@py.match2.fun':
id: 'admin_get_log_config@py.match2.fun'
name: 'admin_get_log_config'
type: 'function'
description: |-
Get Log Configuration.
return_type: 'Tuple[Union[None, LogconfigConfiguration], Union[None, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/config/admin_get_log_config.py'
example: |-
result, error = match2.admin_get_log_config(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'config'
- 'get'
- 'log'
permissions:
- 'ADMIN:CONFIG:LOG [READ]'
'admin_get_match_pool_tickets@py.match2.fun':
id: 'admin_get_match_pool_tickets@py.match2.fun'
name: 'admin_get_match_pool_tickets'
type: 'function'
description: |-
Get tickets in queue for a specific match pool
Result: number of tickets and list of ticket detail in a match pool.
arguments:
'limit':
type: 'Optional[int]'
required: false
description: |-
Pagination limit
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
Pagination offset
'pool':
type: 'str'
required: true
description: |-
Name of the match pool
return_type: 'Tuple[Union[None, ApiListMatchPoolTicketsResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/match_pools/admin_get_match_pool_tickets.py'
example: |-
result, error = match2.admin_get_match_pool_tickets(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'get'
- 'match'
- 'pool'
- 'pools'
- 'tickets'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MATCHMAKING:POOL:TICKETS [READ]'
'admin_get_play_feature_flag@py.match2.fun':
id: 'admin_get_play_feature_flag@py.match2.fun'
name: 'admin_get_play_feature_flag'
type: 'function'
description: |-
Get matchmaking Play Feature Flag.
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ModelsPlayFeatureFlag], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/play_feature_flag/admin_get_play_feature_flag.py'
example: |-
result, error = match2.admin_get_play_feature_flag(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'feature'
- 'flag'
- 'get'
- 'play'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MATCHMAKING:PLAYFEATUREFLAG [READ]'
'admin_get_x_ray_config@py.match2.fun':
id: 'admin_get_x_ray_config@py.match2.fun'
name: 'admin_get_x_ray_config'
type: 'function'
description: |-
Get XRay config
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ModelsXRayConfigHttpResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/x_ray_config/admin_get_x_ray_config.py'
example: |-
result, error = match2.admin_get_x_ray_config(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'config'
- 'get'
- 'ray'
- 'x'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MATCHMAKING:XRAY [READ]'
'admin_patch_config_v1@py.match2.fun':
id: 'admin_patch_config_v1@py.match2.fun'
name: 'admin_patch_config_v1'
type: 'function'
description: |-
Patch update matchmaking config of a namespaces. Partially update matchmaking config, will only update value that defined on the request.
arguments:
'body':
type: 'ApiPatchNamespaceConfigRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ConfigmodelsNamespaceConfig], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/config/admin_patch_config_v1.py'
example: |-
result, error = match2.admin_patch_config_v1(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'config'
- 'patch'
- 'v1'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MATCHMAKING:CONFIG [UPDATE]'
'admin_patch_update_log_config@py.match2.fun':
id: 'admin_patch_update_log_config@py.match2.fun'
name: 'admin_patch_update_log_config'
type: 'function'
description: |-
Update Log Configuration.
arguments:
'body':
type: 'LogconfigConfiguration'
required: true
return_type: 'Tuple[Union[None, LogconfigConfiguration], Union[None, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/config/admin_patch_update_log_config.py'
example: |-
result, error = match2.admin_patch_update_log_config(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'config'
- 'log'
- 'patch'
- 'update'
permissions:
- 'ADMIN:CONFIG:LOG [UPDATE]'
'admin_query_backfill@py.match2.fun':
id: 'admin_query_backfill@py.match2.fun'
name: 'admin_query_backfill'
type: 'function'
description: |-
Admin Query backfill ticket
arguments:
'from_time':
type: 'Optional[str]'
required: false
description: |-
beginning of backfill ticket creation time range in RFC 3339 format e.g. 2022-10-21T07:20:50Z
'is_active':
type: 'Optional[bool]'
required: false
description: |-
backfill isActive flag
'limit':
type: 'Optional[int]'
required: false
description: |-
limit of the returned data
'match_pool':
type: 'Optional[str]'
required: false
description: |-
ticket match pool
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
offset of the data
'player_id':
type: 'Optional[str]'
required: false
description: |-
player ID of the backfilled session (WARNING: slow)
'region':
type: 'Optional[str]'
required: false
description: |-
preferred region of the backfilled session (WARNING: slow)
'session_id':
type: 'Optional[str]'
required: false
description: |-
backfill Session ID
'to_time':
type: 'Optional[str]'
required: false
description: |-
end of backfill ticket creation time range in RFC 3339 format e.g. 2022-10-21T07:20:50Z
return_type: 'Tuple[Union[None, ApiListBackfillQueryResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/backfill/admin_query_backfill.py'
example: |-
result, error = match2.admin_query_backfill(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'backfill'
- 'query'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MATCHMAKING:BACKFILL [READ]'
'admin_update_x_ray_config@py.match2.fun':
id: 'admin_update_x_ray_config@py.match2.fun'
name: 'admin_update_x_ray_config'
type: 'function'
description: |-
Admin update XRay config
arguments:
'body':
type: 'ModelsXRayConfigHttpUpdateRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/x_ray_config/admin_update_x_ray_config.py'
example: |-
result, error = match2.admin_update_x_ray_config(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'config'
- 'ray'
- 'update'
- 'x'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MATCHMAKING:XRAY [UPDATE]'
'admin_upsert_play_feature_flag@py.match2.fun':
id: 'admin_upsert_play_feature_flag@py.match2.fun'
name: 'admin_upsert_play_feature_flag'
type: 'function'
description: |-
Upsert matchmaking Play Feature Flag.
arguments:
'body':
type: 'ModelsPlayFeatureFlag'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ModelsPlayFeatureFlag], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/play_feature_flag/admin_upsert_play_feature_flag.py'
example: |-
result, error = match2.admin_upsert_play_feature_flag(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'feature'
- 'flag'
- 'play'
- 'upsert'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MATCHMAKING:PLAYFEATUREFLAG [UPDATE]'
'create_backfill@py.match2.fun':
id: 'create_backfill@py.match2.fun'
name: 'create_backfill'
type: 'function'
description: |-
Create backfill ticket.
arguments:
'body':
type: 'ApiBackFillCreateRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ApiBackfillCreateResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/backfill/create_backfill.py'
example: |-
result, error = match2.create_backfill(...)
if error:
# handle_error(error)
tags:
- 'backfill'
- 'create'
- 'public'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:BACKFILL [CREATE]'
'create_match_function@py.match2.fun':
id: 'create_match_function@py.match2.fun'
name: 'create_match_function'
type: 'function'
description: |-
Creates a new matchmaking function.
arguments:
'body':
type: 'ApiMatchFunctionRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, Optional[str]], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/match_functions/create_match_function.py'
example: |-
result, error = match2.create_match_function(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'create'
- 'function'
- 'functions'
- 'match'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:FUNCTIONS [CREATE]'
'create_match_pool@py.match2.fun':
id: 'create_match_pool@py.match2.fun'
name: 'create_match_pool'
type: 'function'
description: |-
Creates a new matchmaking pool.
A pool is isolated from other pools (i.e. tickets may be matched with other tickets in the same pool, but not with tickets in other pools).
Each pool has its own matchmaking rules and/or logic.
ticket_expiration_seconds and backfill_ticket_expiration_seconds will be set to 300 seconds (5 minutes) by default if not filled.
Match Function holds information about the name of the match logic server that matchmaking can refers to. By default we provide ("default" and "basic").
Match Function will be used as reference value for Match Function Overrides if not set.
In case Customer would like to use matchmaking service default match logic, then specify it in "match_function_overrides".
This sample configuration will let matchmaking service will use "default" match logic for make matches, while validation will hit both "default" and "custom" match logics.
e.g.
{
"match_function": "custom",
"match_function_overrides": {
"validation": []{"default","custom"},
"make_matches": "default",
}
}
arguments:
'body':
type: 'ApiMatchPool'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, Optional[str]], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/match_pools/create_match_pool.py'
example: |-
result, error = match2.create_match_pool(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'create'
- 'match'
- 'pool'
- 'pools'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:POOL [CREATE]'
'create_match_ticket@py.match2.fun':
id: 'create_match_ticket@py.match2.fun'
name: 'create_match_ticket'
type: 'function'
description: |-
Creates a new request for matchmaking.
Cross Platform: Allow player to play game with "all" registered platforms.
1. Cross Platform can be enabled through session service or create match ticket.
a. via ticket: specify several cross_platform on create match ticket attributes. **[DEPRECATED]** client should not send from attribute `cross_platform` will be populated from backend
This value will override player attributes in session service. e.g. cross_platform:[xbox,psn,steam]
b. via session service: set player/party cross_platform attributes.
c. Enable match options ruleset with name cross_platform and type "all".
```
{
"name": "co-op",
"data": {
"alliance": {
"min_number": 1,
"max_number": 1,
"player_min_number": 1,
"player_max_number": 4
},
"match_options": {
"options": [
{"name": "cross_platform", "type": "all"}
]
}
}
}
```
2. Cross Platform can be disabled from the matchpool configuration `crossplay_disabled=true`
3. When matchpool `crossplay_disabled=false`
* request attribute cross_platform is empty **[Recommended]**:
* Matchmaking will consider Party leader `crossplayEnabled` preference or Session attribute `crossplayEnabled` preference.
* When `crossplayEnabled=true` `cross_platforms` attributes will be populated from [active login methods](/iam/apidocs/#/Third%20Party%20Credential/RetrieveAllActiveThirdPartyLoginPlatformCredentialPublicV3) otherwise it will set to leader current platform
* When `crossplayEnabled=false` `cross_platforms` attributes will be set to user's currentPlatform
* request attribute cross_platform is not empty **[Not Recommended]**:
* Cross Platform can be disabled with specify only ONE cross_platform. Current matchmaking use this behavior. e.g. cross_platform:[xbox]
* Multiple cross_platform values is considered to be crossplay enabled
4. This behavior only works for Default Matchmaker. Custom matchmaker (custom gRPC matchmaker) need to consider this on its own implementation.
ExcludedSessions: allow player to list out game sessions that they want to avoid matching, for example a match that they've recently left or get kicked out from.
arguments:
'body':
type: 'ApiMatchTicketRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ApiMatchTicketResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/match_tickets/create_match_ticket.py'
example: |-
result, error = match2.create_match_ticket(...)
if error:
# handle_error(error)
tags:
- 'create'
- 'match'
- 'public'
- 'ticket'
- 'tickets'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:TICKET [CREATE]'
'create_rule_set@py.match2.fun':
id: 'create_rule_set@py.match2.fun'
name: 'create_rule_set'
type: 'function'
description: |-
Creates a new rules set.
A rule set has a name and contains arbitrary data which is meaningful to some particular match function(s)
The name is used for a match pool to select the ruleset data that should be sent to the match function when matchmaking in that pool.
To use custom rules set please set enable_custom_match_function=true. Default (false).
When custom enable_custom_match_function=true, the ruleset will only validate if the rule is valid json.
arguments:
'body':
type: 'ApiRuleSetPayload'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, Optional[str]], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/rule_sets/create_rule_set.py'
example: |-
result, error = match2.create_rule_set(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'create'
- 'rule'
- 'set'
- 'sets'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:RULES [CREATE]'
'delete_backfill@py.match2.fun':
id: 'delete_backfill@py.match2.fun'
name: 'delete_backfill'
type: 'function'
description: |-
Delete backfill ticket.
arguments:
'backfill_id':
type: 'str'
required: true
description: |-
backfill Ticket ID
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/backfill/delete_backfill.py'
example: |-
result, error = match2.delete_backfill(...)
if error:
# handle_error(error)
tags:
- 'backfill'
- 'delete'
- 'public'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:BACKFILL [DELETE]'
'delete_match_function@py.match2.fun':
id: 'delete_match_function@py.match2.fun'
name: 'delete_match_function'
type: 'function'
description: |-
Deletes an existing match function.
arguments:
'name':
type: 'str'
required: true
description: |-
name of the match function
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, HttpResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/match_functions/delete_match_function.py'
example: |-
result, error = match2.delete_match_function(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'delete'
- 'function'
- 'functions'
- 'match'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:FUNCTIONS [DELETE]'
'delete_match_pool@py.match2.fun':
id: 'delete_match_pool@py.match2.fun'
name: 'delete_match_pool'
type: 'function'
description: |-
Deletes an existing matchmaking pool.
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'pool':
type: 'str'
required: true
description: |-
Name of the match pool
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/match_pools/delete_match_pool.py'
example: |-
result, error = match2.delete_match_pool(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'delete'
- 'match'
- 'pool'
- 'pools'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:POOL [DELETE]'
'delete_match_ticket@py.match2.fun':
id: 'delete_match_ticket@py.match2.fun'
name: 'delete_match_ticket'
type: 'function'
description: |-
Deletes an existing matchmaking ticket.
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'ticketid':
type: 'str'
required: true
description: |-
ID of the match ticket
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/match_tickets/delete_match_ticket.py'
example: |-
result, error = match2.delete_match_ticket(...)
if error:
# handle_error(error)
tags:
- 'delete'
- 'match'
- 'public'
- 'ticket'
- 'tickets'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:TICKET [DELETE]'
'delete_rule_set@py.match2.fun':
id: 'delete_rule_set@py.match2.fun'
name: 'delete_rule_set'
type: 'function'
description: |-
Deletes an existing rule set.
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'ruleset':
type: 'str'
required: true
description: |-
Name of the rule set
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/rule_sets/delete_rule_set.py'
example: |-
result, error = match2.delete_rule_set(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'delete'
- 'rule'
- 'set'
- 'sets'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:RULES [DELETE]'
'environment_variable_list@py.match2.fun':
id: 'environment_variable_list@py.match2.fun'
name: 'environment_variable_list'
type: 'function'
description: |-
List environment variables.
return_type: 'Tuple[Union[None, ApiListEnvironmentVariablesResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/environment_variables/environment_variable_list.py'
example: |-
result, error = match2.environment_variable_list(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'environment'
- 'list'
- 'variable'
- 'variables'
permissions:
- 'ADMIN:MATCHMAKING:CONFIGURATION:ENVIRONMENTVARIABLE [READ]'
'get_backfill@py.match2.fun':
id: 'get_backfill@py.match2.fun'
name: 'get_backfill'
type: 'function'
description: |-
Get backfill ticket by ID
arguments:
'backfill_id':
type: 'str'
required: true
description: |-
backfill Ticket ID
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ApiBackfillGetResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/backfill/get_backfill.py'
example: |-
result, error = match2.get_backfill(...)
if error:
# handle_error(error)
tags:
- 'backfill'
- 'get'
- 'public'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:BACKFILL [READ]'
'get_backfill_proposal@py.match2.fun':
id: 'get_backfill_proposal@py.match2.fun'
name: 'get_backfill_proposal'
type: 'function'
description: |-
Get backfill proposal
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'session_id':
type: 'str'
required: true
description: |-
Session ID information
return_type: 'Tuple[Union[None, ApiBackfillProposalResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/backfill/get_backfill_proposal.py'
example: |-
result, error = match2.get_backfill_proposal(...)
if error:
# handle_error(error)
tags:
- 'backfill'
- 'get'
- 'proposal'
- 'public'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:BACKFILL [READ]'
'get_healthcheck_info@py.match2.fun':
id: 'get_healthcheck_info@py.match2.fun'
name: 'get_healthcheck_info'
type: 'function'
return_type: 'Tuple[Union[None, HttpResponse], Union[None, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/operations/get_healthcheck_info.py'
example: |-
result, error = match2.get_healthcheck_info(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'healthcheck'
- 'info'
'get_healthcheck_info_v1@py.match2.fun':
id: 'get_healthcheck_info_v1@py.match2.fun'
name: 'get_healthcheck_info_v1'
type: 'function'
return_type: 'Tuple[Union[None, HttpResponse], Union[None, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/operations/get_healthcheck_info_v1.py'
example: |-
result, error = match2.get_healthcheck_info_v1(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'healthcheck'
- 'info'
- 'v1'
'get_my_match_tickets@py.match2.fun':
id: 'get_my_match_tickets@py.match2.fun'
name: 'get_my_match_tickets'
type: 'function'
description: |-
Get my match tickets.
arguments:
'limit':
type: 'Optional[int]'
required: false
description: |-
limit of the returned data
'match_pool':
type: 'Optional[str]'
required: false
description: |-
ticket match pool
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
offset of the data
return_type: 'Tuple[Union[None, ApiMatchTicketStatuses], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/match_tickets/get_my_match_tickets.py'
example: |-
result, error = match2.get_my_match_tickets(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'match'
- 'my'
- 'public'
- 'tickets'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:TICKET [READ]'
'get_player_metric@py.match2.fun':
id: 'get_player_metric@py.match2.fun'
name: 'get_player_metric'
type: 'function'
description: |-
Get player metric for a specific match pool
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'pool':
type: 'str'
required: true
description: |-
Name of the match pool
return_type: 'Tuple[Union[None, ApiPlayerMetricRecord], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/match_pools/get_player_metric.py'
example: |-
result, error = match2.get_player_metric(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'get'
- 'match'
- 'metric'
- 'player'
- 'pools'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MATCHMAKING:POOL:METRICS [READ]'
'match_function_get@py.match2.fun':
id: 'match_function_get@py.match2.fun'
name: 'match_function_get'
type: 'function'
description: |-
Get custom match function by name.
arguments:
'name':
type: 'str'
required: true
description: |-
name of the custom match function
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ApiMatchFunctionConfig], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/match_functions/match_function_get.py'
example: |-
result, error = match2.match_function_get(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'function'
- 'functions'
- 'get'
- 'match'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:FUNCTIONS [READ]'
'match_function_list@py.match2.fun':
id: 'match_function_list@py.match2.fun'
name: 'match_function_list'
type: 'function'
description: |-
List existing match functions.
arguments:
'limit':
type: 'Optional[int]'
required: false
description: |-
Pagination limit
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
Pagination offset
return_type: 'Tuple[Union[None, ApiListMatchFunctionsResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/match_functions/match_function_list.py'
example: |-
result, error = match2.match_function_list(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'function'
- 'functions'
- 'list'
- 'match'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:FUNCTIONS [READ]'
'match_pool_details@py.match2.fun':
id: 'match_pool_details@py.match2.fun'
name: 'match_pool_details'
type: 'function'
description: |-
Get details for a specific match pool
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'pool':
type: 'str'
required: true
description: |-
Name of the match pool
return_type: 'Tuple[Union[None, ApiMatchPool], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/match_pools/match_pool_details.py'
example: |-
result, error = match2.match_pool_details(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'details'
- 'match'
- 'pool'
- 'pools'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:POOL [READ]'
'match_pool_list@py.match2.fun':
id: 'match_pool_list@py.match2.fun'
name: 'match_pool_list'
type: 'function'
description: |-
List matchmaking pools.
arguments:
'limit':
type: 'Optional[int]'
required: false
description: |-
Pagination limit
'name':
type: 'Optional[str]'
required: false
description: |-
Match Pool name
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
Pagination offset
return_type: 'Tuple[Union[None, ApiListMatchPoolsResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/match_pools/match_pool_list.py'
example: |-
result, error = match2.match_pool_list(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'list'
- 'match'
- 'pool'
- 'pools'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:POOL [READ]'
'match_pool_metric@py.match2.fun':
id: 'match_pool_metric@py.match2.fun'
name: 'match_pool_metric'
type: 'function'
description: |-
Get metric for a specific match pool
Result: queueTime in seconds
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'pool':
type: 'str'
required: true
description: |-
Name of the match pool
return_type: 'Tuple[Union[None, ApiTicketMetricResultRecord], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/match_pools/match_pool_metric.py'
example: |-
result, error = match2.match_pool_metric(...)
if error:
# handle_error(error)
tags:
- 'match'
- 'metric'
- 'pool'
- 'pools'
- 'public'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:POOL:METRICS [READ]'
'match_ticket_details@py.match2.fun':
id: 'match_ticket_details@py.match2.fun'
name: 'match_ticket_details'
type: 'function'
description: |-
Get details for a specific match ticket
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'ticketid':
type: 'str'
required: true
description: |-
id of the ticket to get the status of
return_type: 'Tuple[Union[None, ApiMatchTicketStatus], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/match_tickets/match_ticket_details.py'
example: |-
result, error = match2.match_ticket_details(...)
if error:
# handle_error(error)
tags:
- 'details'
- 'match'
- 'public'
- 'ticket'
- 'tickets'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:TICKET [READ]'
'post_match_error_metric@py.match2.fun':
id: 'post_match_error_metric@py.match2.fun'
name: 'post_match_error_metric'
type: 'function'
description: |-
Post metrics for external flow failure in a specific match pool
arguments:
'body':
type: 'ApiExternalFailureMetricRecord'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'pool':
type: 'str'
required: true
description: |-
Name of the match pool
return_type: 'Tuple[None, Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/match_pools/post_match_error_metric.py'
example: |-
result, error = match2.post_match_error_metric(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'error'
- 'match'
- 'metric'
- 'pools'
- 'post'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:POOL:METRICS [CREATE]'
'public_get_player_metric@py.match2.fun':
id: 'public_get_player_metric@py.match2.fun'
name: 'public_get_player_metric'
type: 'function'
description: |-
Public get player metric for a specific match pool
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'pool':
type: 'str'
required: true
description: |-
Name of the match pool
return_type: 'Tuple[Union[None, ApiPlayerMetricRecord], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/match_pools/public_get_player_metric.py'
example: |-
result, error = match2.public_get_player_metric(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'match'
- 'metric'
- 'player'
- 'pools'
- 'public'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:POOL:METRICS [READ]'
'reject_backfill@py.match2.fun':
id: 'reject_backfill@py.match2.fun'
name: 'reject_backfill'
type: 'function'
description: |-
Reject backfill proposal
arguments:
'backfill_id':
type: 'str'
required: true
description: |-
backfill Ticket ID
'body':
type: 'ApiBackFillRejectRequest'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, HttpResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/backfill/reject_backfill.py'
example: |-
result, error = match2.reject_backfill(...)
if error:
# handle_error(error)
tags:
- 'backfill'
- 'public'
- 'reject'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:BACKFILL [UPDATE]'
'rule_set_details@py.match2.fun':
id: 'rule_set_details@py.match2.fun'
name: 'rule_set_details'
type: 'function'
description: |-
Get details for a specific rule set
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'ruleset':
type: 'str'
required: true
description: |-
Name of the rule set
return_type: 'Tuple[Union[None, ApiRuleSetPayload], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/rule_sets/rule_set_details.py'
example: |-
result, error = match2.rule_set_details(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'details'
- 'rule'
- 'set'
- 'sets'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:RULES [READ]'
'rule_set_list@py.match2.fun':
id: 'rule_set_list@py.match2.fun'
name: 'rule_set_list'
type: 'function'
description: |-
List rule sets.
arguments:
'limit':
type: 'Optional[int]'
required: false
description: |-
Pagination limit
'name':
type: 'Optional[str]'
required: false
description: |-
Rule Set name
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'offset':
type: 'Optional[int]'
required: false
description: |-
Pagination offset
return_type: 'Tuple[Union[None, ApiListRuleSetsResponse], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/rule_sets/rule_set_list.py'
example: |-
result, error = match2.rule_set_list(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'list'
- 'rule'
- 'set'
- 'sets'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:RULES [READ]'
'update_match_function@py.match2.fun':
id: 'update_match_function@py.match2.fun'
name: 'update_match_function'
type: 'function'
description: |-
Update existing matchmaking function.
arguments:
'body':
type: 'ApiMatchFunctionRequest'
required: true
'name':
type: 'str'
required: true
description: |-
name of the match function
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
return_type: 'Tuple[Union[None, ApiMatchFunctionConfig], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/match_functions/update_match_function.py'
example: |-
result, error = match2.update_match_function(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'function'
- 'functions'
- 'match'
- 'update'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:FUNCTIONS [UPDATE]'
'update_match_pool@py.match2.fun':
id: 'update_match_pool@py.match2.fun'
name: 'update_match_pool'
type: 'function'
description: |-
Updates an existing matchmaking pool.
ticket_expiration_seconds and backfill_ticket_expiration_seconds will be set to 300 seconds (5 minutes) by default if not filled.
Match Function holds information about the name of the match logic server that matchmaking can refers to. By default we provide ("default" and "basic").
Match Function will be used as reference value for Match Function Overrides if not set.
In case Customer would like to use matchmaking service default match logic, then specify it in "match_function_overrides".
This sample configuration will let matchmaking service will use "default" match logic for make matches, while validation will hit both "default" and "custom" match logics.
e.g.
{
"match_function": "custom",
"match_function_overrides": {
"validation": []{"default","custom"},
"make_matches": "default",
}
}
arguments:
'body':
type: 'ApiMatchPoolConfig'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'pool':
type: 'str'
required: true
description: |-
Name of the match pool
return_type: 'Tuple[Union[None, ApiMatchPool], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/match_pools/update_match_pool.py'
example: |-
result, error = match2.update_match_pool(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'match'
- 'pool'
- 'pools'
- 'update'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:POOL [UPDATE]'
'update_rule_set@py.match2.fun':
id: 'update_rule_set@py.match2.fun'
name: 'update_rule_set'
type: 'function'
description: |-
Updates an existing matchmaking rule set.
To use custom rules set please set enable_custom_match_function=true. Default (false).
When custom enable_custom_match_function=true, the ruleset will only validate if the rule is valid json.
arguments:
'body':
type: 'ApiRuleSetPayload'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace of the game
'ruleset':
type: 'str'
required: true
description: |-
Name of the match rule set
return_type: 'Tuple[Union[None, ApiRuleSetPayload], Union[None, HttpResponse, ResponseError]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/rule_sets/update_rule_set.py'
example: |-
result, error = match2.update_rule_set(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'rule'
- 'set'
- 'sets'
- 'update'
permissions:
- 'NAMESPACE:{namespace}:MATCHMAKING:RULES [UPDATE]'
'version_check_handler@py.match2.fun':
id: 'version_check_handler@py.match2.fun'
name: 'version_check_handler'
type: 'function'
return_type: 'Tuple[Union[None, HttpResponse], Union[None, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.match2 as match2'
- 'import accelbyte_py_sdk.api.match2.models as match2_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/match2/operations/operations/version_check_handler.py'
example: |-
result, error = match2.version_check_handler(...)
if error:
# handle_error(error)
tags:
- 'check'
- 'handler'
- 'version'
# endregion functions
