symbols:
# region models
'AddCountryGroupRequest@py.basic.mod':
id: 'AddCountryGroupRequest@py.basic.mod'
name: 'AddCountryGroupRequest'
type: 'model'
fields:
'countries':
type: 'List[CountryObject]'
required: false
'country_group_code':
type: 'str'
required: false
'country_group_name':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/add_country_group_request.py'
example: |-
add_country_group_request = basic_models.AddCountryGroupRequest.create(...)
'AddCountryGroupResponse@py.basic.mod':
id: 'AddCountryGroupResponse@py.basic.mod'
name: 'AddCountryGroupResponse'
type: 'model'
fields:
'countries':
type: 'List[CountryObject]'
required: false
'country_group_code':
type: 'str'
required: false
'country_group_name':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/add_country_group_response.py'
example: |-
add_country_group_response = basic_models.AddCountryGroupResponse.create(...)
'ConfigCreate@py.basic.mod':
id: 'ConfigCreate@py.basic.mod'
name: 'ConfigCreate'
type: 'model'
fields:
'key':
type: 'str'
required: true
description: |-
key, only accept alphabet and numeric
'value':
type: 'str'
required: true
description: |-
value
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/config_create.py'
example: |-
config_create = basic_models.ConfigCreate.create(...)
'ConfigInfo@py.basic.mod':
id: 'ConfigInfo@py.basic.mod'
name: 'ConfigInfo'
type: 'model'
fields:
'created_at':
type: 'str'
required: false
'key':
type: 'str'
required: false
'namespace':
type: 'str'
required: false
'updated_at':
type: 'str'
required: false
'value':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/config_info.py'
example: |-
config_info = basic_models.ConfigInfo.create(...)
'ConfigUpdate@py.basic.mod':
id: 'ConfigUpdate@py.basic.mod'
name: 'ConfigUpdate'
type: 'model'
fields:
'value':
type: 'str'
required: true
description: |-
value
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/config_update.py'
example: |-
config_update = basic_models.ConfigUpdate.create(...)
'CountryGroupObject@py.basic.mod':
id: 'CountryGroupObject@py.basic.mod'
name: 'CountryGroupObject'
type: 'model'
fields:
'countries':
type: 'List[CountryObject]'
required: false
'country_group_code':
type: 'str'
required: false
'country_group_name':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/country_group_object.py'
example: |-
country_group_object = basic_models.CountryGroupObject.create(...)
'CountryObject@py.basic.mod':
id: 'CountryObject@py.basic.mod'
name: 'CountryObject'
type: 'model'
fields:
'code':
type: 'str'
required: false
'name':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/country_object.py'
example: |-
country_object = basic_models.CountryObject.create(...)
'ErrorEntity@py.basic.mod':
id: 'ErrorEntity@py.basic.mod'
name: 'ErrorEntity'
type: 'model'
fields:
'error_code':
type: 'int'
required: true
description: |-
numeric error code
'error_message':
type: 'str'
required: true
description: |-
error message
'dev_stack_trace':
type: 'str'
required: false
description: |-
internal server error stack trace in configured environment
'message_variables':
type: 'Dict[str, str]'
required: false
description: |-
message variables
'required_permission':
type: 'Permission'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/error_entity.py'
example: |-
error_entity = basic_models.ErrorEntity.create(...)
'FieldValidationError@py.basic.mod':
id: 'FieldValidationError@py.basic.mod'
name: 'FieldValidationError'
type: 'model'
fields:
'error_code':
type: 'str'
required: false
'error_field':
type: 'str'
required: false
'error_message':
type: 'str'
required: false
'error_value':
type: 'str'
required: false
'message_variables':
type: 'Dict[str, str]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/field_validation_error.py'
example: |-
field_validation_error = basic_models.FieldValidationError.create(...)
'FileUploadUrlInfo@py.basic.mod':
id: 'FileUploadUrlInfo@py.basic.mod'
name: 'FileUploadUrlInfo'
type: 'model'
fields:
'access_url':
type: 'str'
required: false
description: |-
URL for accessing file
'content_type':
type: 'str'
required: false
description: |-
File content-type
'method':
type: 'str'
required: false
description: |-
HTTP method for uploading file
'url':
type: 'str'
required: false
description: |-
URL for uploading file (S3 presigned URL)
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/file_upload_url_info.py'
example: |-
file_upload_url_info = basic_models.FileUploadUrlInfo.create(...)
'NamespaceContext@py.basic.mod':
id: 'NamespaceContext@py.basic.mod'
name: 'NamespaceContext'
type: 'model'
description: |-
This model is used to indicate the context of a namespace
fields:
'namespace':
type: 'str'
required: false
description: |-
target namespace which need to get its context
'publisher_namespace':
type: 'str'
required: false
description: |-
publisher namespace
'studio_namespace':
type: 'str'
required: false
description: |-
studio namespace, it will be empty when input namespace is publisher namespace
'type_':
type: 'Union[str, TypeEnum]'
required: false
description: |-
input namespace type
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/namespace_context.py'
example: |-
namespace_context = basic_models.NamespaceContext.create(...)
'NamespaceCreate@py.basic.mod':
id: 'NamespaceCreate@py.basic.mod'
name: 'NamespaceCreate'
type: 'model'
fields:
'display_name':
type: 'str'
required: true
description: |-
display name
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric. Will be converted to lowercase
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/namespace_create.py'
example: |-
namespace_create = basic_models.NamespaceCreate.create(...)
'NamespaceInfo@py.basic.mod':
id: 'NamespaceInfo@py.basic.mod'
name: 'NamespaceInfo'
type: 'model'
fields:
'display_name':
type: 'str'
required: true
description: |-
namespace display name
'namespace':
type: 'str'
required: true
description: |-
namespace
'client_id':
type: 'str'
required: false
description: |-
clientId is only present on multi tenant mode with namespace is not publisher namespace
'created_at':
type: 'str'
required: false
'parent_namespace':
type: 'str'
required: false
description: |-
parentNamespace is only present in multi tenant mode
'status':
type: 'Union[str, StatusEnum]'
required: false
'updated_at':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/namespace_info.py'
example: |-
namespace_info = basic_models.NamespaceInfo.create(...)
'NamespacePublisherInfo@py.basic.mod':
id: 'NamespacePublisherInfo@py.basic.mod'
name: 'NamespacePublisherInfo'
type: 'model'
fields:
'publisher':
type: 'bool'
required: false
description: |-
inform whether the specified namespace is publisher namespace or not
'publisher_namespace':
type: 'str'
required: false
description: |-
name of publisher namespace
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/namespace_publisher_info.py'
example: |-
namespace_publisher_info = basic_models.NamespacePublisherInfo.create(...)
'NamespaceSimpleInfo@py.basic.mod':
id: 'NamespaceSimpleInfo@py.basic.mod'
name: 'NamespaceSimpleInfo'
type: 'model'
fields:
'display_name':
type: 'str'
required: true
description: |-
namespace display name
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/namespace_simple_info.py'
example: |-
namespace_simple_info = basic_models.NamespaceSimpleInfo.create(...)
'NamespaceStatusUpdate@py.basic.mod':
id: 'NamespaceStatusUpdate@py.basic.mod'
name: 'NamespaceStatusUpdate'
type: 'model'
description: |-
A DTO object for updating namespace status API call.
fields:
'status':
type: 'Union[str, StatusEnum]'
required: true
description: |-
namespace status
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/namespace_status_update.py'
example: |-
namespace_status_update = basic_models.NamespaceStatusUpdate.create(...)
'NamespaceUpdate@py.basic.mod':
id: 'NamespaceUpdate@py.basic.mod'
name: 'NamespaceUpdate'
type: 'model'
fields:
'display_name':
type: 'str'
required: true
description: |-
display name
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/namespace_update.py'
example: |-
namespace_update = basic_models.NamespaceUpdate.create(...)
'Permission@py.basic.mod':
id: 'Permission@py.basic.mod'
name: 'Permission'
type: 'model'
fields:
'action':
type: 'int'
required: false
'resource':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/permission.py'
example: |-
permission = basic_models.Permission.create(...)
'RetrieveCountryGroupResponse@py.basic.mod':
id: 'RetrieveCountryGroupResponse@py.basic.mod'
name: 'RetrieveCountryGroupResponse'
type: 'model'
fields:
'countries':
type: 'List[CountryObject]'
required: false
'country_group_code':
type: 'str'
required: false
'country_group_name':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/retrieve_country_group_response.py'
example: |-
retrieve_country_group_response = basic_models.RetrieveCountryGroupResponse.create(...)
'RetrieveTimeResponse@py.basic.mod':
id: 'RetrieveTimeResponse@py.basic.mod'
name: 'RetrieveTimeResponse'
type: 'model'
fields:
'current_time':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/retrieve_time_response.py'
example: |-
retrieve_time_response = basic_models.RetrieveTimeResponse.create(...)
'UpdateCountryGroupRequest@py.basic.mod':
id: 'UpdateCountryGroupRequest@py.basic.mod'
name: 'UpdateCountryGroupRequest'
type: 'model'
fields:
'countries':
type: 'List[CountryObject]'
required: false
'country_group_name':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/update_country_group_request.py'
example: |-
update_country_group_request = basic_models.UpdateCountryGroupRequest.create(...)
'UserProfileAdmin@py.basic.mod':
id: 'UserProfileAdmin@py.basic.mod'
name: 'UserProfileAdmin'
type: 'model'
description: |-
A DTO object for updating user profile API call.
fields:
'avatar_large_url':
type: 'str'
required: false
description: |-
should be comply with OWASP url format
'avatar_small_url':
type: 'str'
required: false
description: |-
should be comply with OWASP url format
'avatar_url':
type: 'str'
required: false
description: |-
should be comply with OWASP url format
'custom_attributes':
type: 'Dict[str, Any]'
required: false
'date_of_birth':
type: 'str'
required: false
description: |-
date of birth, allowed format: yyyy-MM-dd, valid date range from 1905-01-01 until present
'first_name':
type: 'str'
required: false
description: |-
deprecated
'language':
type: 'str'
required: false
description: |-
language value from language tag, allowed format: en, en-US.<p>Supported language tag : [RFC5646](https://gist.github.com/msikma/8912e62ed866778ff8cd) and [IETF](https://datahub.io/core/language-codes#resource-ietf-language-tags)</p>
'last_name':
type: 'str'
required: false
description: |-
deprecated
'private_custom_attributes':
type: 'Dict[str, Any]'
required: false
'status':
type: 'Union[str, StatusEnum]'
required: false
'time_zone':
type: 'str'
required: false
description: |-
time zone, allowed IANA time zone, e.g.Asia/Shanghai
'zip_code':
type: 'str'
required: false
description: |-
zip code
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/user_profile_admin.py'
example: |-
user_profile_admin = basic_models.UserProfileAdmin.create(...)
'UserProfileBulkRequest@py.basic.mod':
id: 'UserProfileBulkRequest@py.basic.mod'
name: 'UserProfileBulkRequest'
type: 'model'
fields:
'user_ids':
type: 'List[str]'
required: false
description: |-
User IDs, list of User ID with limit max to 100 User ID
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/user_profile_bulk_request.py'
example: |-
user_profile_bulk_request = basic_models.UserProfileBulkRequest.create(...)
'UserProfileCreate@py.basic.mod':
id: 'UserProfileCreate@py.basic.mod'
name: 'UserProfileCreate'
type: 'model'
description: |-
A DTO object for creating user profile API call.
fields:
'avatar_large_url':
type: 'str'
required: false
description: |-
should be comply with OWASP url format
'avatar_small_url':
type: 'str'
required: false
description: |-
should be comply with OWASP url format
'avatar_url':
type: 'str'
required: false
description: |-
should be comply with OWASP url format
'custom_attributes':
type: 'Dict[str, Any]'
required: false
'date_of_birth':
type: 'str'
required: false
description: |-
date of birth, allowed format: yyyy-MM-dd, valid date range from 1905-01-01 until present
'first_name':
type: 'str'
required: false
description: |-
deprecated
'language':
type: 'str'
required: false
description: |-
language value from language tag, allowed format: en, en-US.<p>Supported language tag : [RFC5646](https://gist.github.com/msikma/8912e62ed866778ff8cd) and [IETF](https://datahub.io/core/language-codes#resource-ietf-language-tags)</p>
'last_name':
type: 'str'
required: false
description: |-
deprecated
'time_zone':
type: 'str'
required: false
description: |-
time zone, allowed IANA time zone, e.g.Asia/Shanghai
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/user_profile_create.py'
example: |-
user_profile_create = basic_models.UserProfileCreate.create(...)
'UserProfileInfo@py.basic.mod':
id: 'UserProfileInfo@py.basic.mod'
name: 'UserProfileInfo'
type: 'model'
fields:
'avatar_large_url':
type: 'str'
required: false
'avatar_small_url':
type: 'str'
required: false
'avatar_url':
type: 'str'
required: false
'custom_attributes':
type: 'Dict[str, Any]'
required: false
'date_of_birth':
type: 'str'
required: false
'first_name':
type: 'str'
required: false
description: |-
deprecated
'language':
type: 'str'
required: false
'last_name':
type: 'str'
required: false
description: |-
deprecated
'namespace':
type: 'str'
required: false
'public_id':
type: 'str'
required: false
'status':
type: 'Union[str, StatusEnum]'
required: false
'time_zone':
type: 'str'
required: false
'user_id':
type: 'str'
required: false
'zip_code':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/user_profile_info.py'
example: |-
user_profile_info = basic_models.UserProfileInfo.create(...)
'UserProfilePrivateCreate@py.basic.mod':
id: 'UserProfilePrivateCreate@py.basic.mod'
name: 'UserProfilePrivateCreate'
type: 'model'
description: |-
A DTO object for creating user profile API call.
fields:
'avatar_large_url':
type: 'str'
required: false
description: |-
should be comply with OWASP url format
'avatar_small_url':
type: 'str'
required: false
description: |-
should be comply with OWASP url format
'avatar_url':
type: 'str'
required: false
description: |-
should be comply with OWASP url format
'custom_attributes':
type: 'Dict[str, Any]'
required: false
'date_of_birth':
type: 'str'
required: false
description: |-
date of birth, allowed format: yyyy-MM-dd, valid date range from 1905-01-01 until present
'first_name':
type: 'str'
required: false
description: |-
deprecated
'language':
type: 'str'
required: false
description: |-
language value from language tag, allowed format: en, en-US.<p>Supported language tag : [RFC5646](https://gist.github.com/msikma/8912e62ed866778ff8cd) and [IETF](https://datahub.io/core/language-codes#resource-ietf-language-tags)</p>
'last_name':
type: 'str'
required: false
description: |-
deprecated
'private_custom_attributes':
type: 'Dict[str, Any]'
required: false
'time_zone':
type: 'str'
required: false
description: |-
time zone, allowed IANA time zone, e.g.Asia/Shanghai
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/user_profile_private_create.py'
example: |-
user_profile_private_create = basic_models.UserProfilePrivateCreate.create(...)
'UserProfilePrivateInfo@py.basic.mod':
id: 'UserProfilePrivateInfo@py.basic.mod'
name: 'UserProfilePrivateInfo'
type: 'model'
fields:
'avatar_large_url':
type: 'str'
required: false
'avatar_small_url':
type: 'str'
required: false
'avatar_url':
type: 'str'
required: false
'custom_attributes':
type: 'Dict[str, Any]'
required: false
'date_of_birth':
type: 'str'
required: false
'first_name':
type: 'str'
required: false
description: |-
deprecated
'language':
type: 'str'
required: false
'last_name':
type: 'str'
required: false
description: |-
deprecated
'namespace':
type: 'str'
required: false
'private_custom_attributes':
type: 'Dict[str, Any]'
required: false
'public_id':
type: 'str'
required: false
'status':
type: 'Union[str, StatusEnum]'
required: false
'time_zone':
type: 'str'
required: false
'user_id':
type: 'str'
required: false
'zip_code':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/user_profile_private_info.py'
example: |-
user_profile_private_info = basic_models.UserProfilePrivateInfo.create(...)
'UserProfilePublicInfo@py.basic.mod':
id: 'UserProfilePublicInfo@py.basic.mod'
name: 'UserProfilePublicInfo'
type: 'model'
fields:
'avatar_large_url':
type: 'str'
required: false
'avatar_small_url':
type: 'str'
required: false
'avatar_url':
type: 'str'
required: false
'custom_attributes':
type: 'Dict[str, Any]'
required: false
'namespace':
type: 'str'
required: false
'public_id':
type: 'str'
required: false
'time_zone':
type: 'str'
required: false
'user_id':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/user_profile_public_info.py'
example: |-
user_profile_public_info = basic_models.UserProfilePublicInfo.create(...)
'UserProfileStatusUpdate@py.basic.mod':
id: 'UserProfileStatusUpdate@py.basic.mod'
name: 'UserProfileStatusUpdate'
type: 'model'
description: |-
A DTO object for updating user profile status API call.
fields:
'status':
type: 'Union[str, StatusEnum]'
required: true
description: |-
status, ACTIVE or INACTIVE
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/user_profile_status_update.py'
example: |-
user_profile_status_update = basic_models.UserProfileStatusUpdate.create(...)
'UserProfileUpdate@py.basic.mod':
id: 'UserProfileUpdate@py.basic.mod'
name: 'UserProfileUpdate'
type: 'model'
description: |-
A DTO object for updating user profile API call.
fields:
'avatar_large_url':
type: 'str'
required: false
description: |-
should be comply with OWASP url format
'avatar_small_url':
type: 'str'
required: false
description: |-
should be comply with OWASP url format
'avatar_url':
type: 'str'
required: false
description: |-
should be comply with OWASP url format
'custom_attributes':
type: 'Dict[str, Any]'
required: false
'date_of_birth':
type: 'str'
required: false
description: |-
date of birth, allowed format: yyyy-MM-dd, valid date range from 1905-01-01 until present
'first_name':
type: 'str'
required: false
description: |-
deprecated
'language':
type: 'str'
required: false
description: |-
language value from language tag, allowed format: en, en-US.<p>Supported language tag : [RFC5646](https://gist.github.com/msikma/8912e62ed866778ff8cd) and [IETF](https://datahub.io/core/language-codes#resource-ietf-language-tags)</p>
'last_name':
type: 'str'
required: false
description: |-
deprecated
'private_custom_attributes':
type: 'Dict[str, Any]'
required: false
'time_zone':
type: 'str'
required: false
description: |-
time zone, allowed IANA time zone, e.g.Asia/Shanghai
'zip_code':
type: 'str'
required: false
description: |-
zip code
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/user_profile_update.py'
example: |-
user_profile_update = basic_models.UserProfileUpdate.create(...)
'UserZipCode@py.basic.mod':
id: 'UserZipCode@py.basic.mod'
name: 'UserZipCode'
type: 'model'
fields:
'zip_code':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/user_zip_code.py'
example: |-
user_zip_code = basic_models.UserZipCode.create(...)
'UserZipCodeUpdate@py.basic.mod':
id: 'UserZipCodeUpdate@py.basic.mod'
name: 'UserZipCodeUpdate'
type: 'model'
fields:
'zip_code':
type: 'str'
required: true
description: |-
zip code, accept alphabet and numeric string default
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/user_zip_code_update.py'
example: |-
user_zip_code_update = basic_models.UserZipCodeUpdate.create(...)
'ValidationErrorEntity@py.basic.mod':
id: 'ValidationErrorEntity@py.basic.mod'
name: 'ValidationErrorEntity'
type: 'model'
fields:
'error_code':
type: 'int'
required: true
description: |-
numeric error code
'error_message':
type: 'str'
required: true
description: |-
error message
'errors':
type: 'List[FieldValidationError]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/models/validation_error_entity.py'
example: |-
validation_error_entity = basic_models.ValidationErrorEntity.create(...)
# endregion models
# region functions
'add_country_group@py.basic.fun':
id: 'add_country_group@py.basic.fun'
name: 'add_country_group'
type: 'function'
description: |-
Add a country groups
Country code must follow ISO3166-1 alpha-2.
Other detail info:
* Action code : 11201
* Returns : newly created country group
arguments:
'body':
type: 'Optional[AddCountryGroupRequest]'
required: false
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, AddCountryGroupResponse], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/misc/add_country_group.py'
example: |-
result, error = basic.add_country_group(...)
if error:
# handle_error(error)
tags:
- 'add'
- 'country'
- 'group'
- 'misc'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MISC [CREATE]'
'admin_get_user_profile_public_info_by_ids@py.basic.fun':
id: 'admin_get_user_profile_public_info_by_ids@py.basic.fun'
name: 'admin_get_user_profile_public_info_by_ids'
type: 'function'
description: |-
Admin get user public profile by ids.
Other detail info:
* Required permission : resource= "ADMIN:NAMESPACE:{namespace}:PROFILE" , action=2 (GET)
* Action code : 11405
* Returns : user public profiles
arguments:
'body':
type: 'Optional[UserProfileBulkRequest]'
required: false
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, List[UserProfilePublicInfo]], Union[None, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/user_profile/admin_get_user_profile__eda78b.py'
example: |-
result, error = basic.admin_get_user_profile_public_info_by_ids(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'by'
- 'get'
- 'ids'
- 'info'
- 'profile'
- 'public'
- 'user'
'anonymize_user_profile@py.basic.fun':
id: 'anonymize_user_profile@py.basic.fun'
name: 'anonymize_user_profile'
type: 'function'
description: |-
Anonymize user profile.
Other detail info:
* Action code : 11501
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
'user_id':
type: 'str'
required: true
description: |-
user id, should follow UUID version 4 without hyphen
return_type: 'Tuple[None, Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/anonymization/anonymize_user_profile.py'
example: |-
result, error = basic.anonymize_user_profile(...)
if error:
# handle_error(error)
tags:
- 'anonymization'
- 'anonymize'
- 'profile'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:ANONYMIZATION [DELETE]'
'change_namespace_status@py.basic.fun':
id: 'change_namespace_status@py.basic.fun'
name: 'change_namespace_status'
type: 'function'
description: |-
Change a namespace status.
Other detail info:
* Action code : 11306
* Returns : updated namespace
arguments:
'body':
type: 'Optional[NamespaceStatusUpdate]'
required: false
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, NamespaceInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/namespace/change_namespace_status.py'
example: |-
result, error = basic.change_namespace_status(...)
if error:
# handle_error(error)
tags:
- 'change'
- 'namespace'
- 'status'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:NAMESPACE [UPDATE]'
'create_config@py.basic.fun':
id: 'create_config@py.basic.fun'
name: 'create_config'
type: 'function'
description: |-
Create a config.
Other detail info:
* Returns : created config
arguments:
'body':
type: 'Optional[ConfigCreate]'
required: false
'namespace':
type: 'str'
required: true
return_type: 'Tuple[Union[None, ConfigInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/config/create_config.py'
example: |-
result, error = basic.create_config(...)
if error:
# handle_error(error)
tags:
- 'config'
- 'create'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:BASIC:CONFIG [CREATE]'
'create_my_profile@py.basic.fun':
id: 'create_my_profile@py.basic.fun'
name: 'create_my_profile'
type: 'function'
description: |-
Create my profile.
Client with user token can create user profile in target namespace
Other detail info:
* Action code : 11401
* Returns : Created user profile
* Path's namespace :
* can be filled with publisher namespace in order to create publisher user profile
* can be filled with game namespace in order to create game user profile
* Language : allowed format: en, en-US
* Country : ISO3166-1 alpha-2 two letter, e.g. US
* Timezone : IANA time zone, e.g. Asia/Shanghai
arguments:
'body':
type: 'Optional[UserProfilePrivateCreate]'
required: false
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, UserProfilePrivateInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/user_profile/create_my_profile.py'
example: |-
result, error = basic.create_my_profile(...)
if error:
# handle_error(error)
tags:
- 'create'
- 'my'
- 'profile'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:PROFILE [CREATE]'
'create_namespace@py.basic.fun':
id: 'create_namespace@py.basic.fun'
name: 'create_namespace'
type: 'function'
description: |-
Create a namespace.
By default the namespace is enabled.
In multi tenant mode, parentNamespace will be automatically filled with requester namespace if the requester is using studio or publisher token, and it will be filled with studio namespace if the requester uses game token. An oauth client will also be created and the id will be returned.
displayName rule:
* Alphanumeric lowercase and uppercase are allowed
* Allowed Special Character: ',. -
* Must start and end with alphanumeric
* Spaces and special character are allowed but cannot appear twice in a row
Other detail info:
* Action code : 11301
* Returns : created namespace
arguments:
'body':
type: 'Optional[NamespaceCreate]'
required: false
return_type: 'Tuple[Union[None, NamespaceInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/namespace/create_namespace.py'
example: |-
result, error = basic.create_namespace(...)
if error:
# handle_error(error)
tags:
- 'create'
- 'namespace'
permissions:
- 'ADMIN:NAMESPACE [CREATE]'
'delete_config@py.basic.fun':
id: 'delete_config@py.basic.fun'
name: 'delete_config'
type: 'function'
description: |-
Delete a config.
Other detail info:
* Returns : created config
arguments:
'config_key':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
return_type: 'Tuple[None, Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/config/delete_config.py'
example: |-
result, error = basic.delete_config(...)
if error:
# handle_error(error)
tags:
- 'config'
- 'delete'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:BASIC:CONFIG [DELETE]'
'delete_country_group@py.basic.fun':
id: 'delete_country_group@py.basic.fun'
name: 'delete_country_group'
type: 'function'
description: |-
Delete a country groups by its country group code. This endpoint usually used for testing purpose to cleanup test data.
arguments:
'country_group_code':
type: 'str'
required: true
description: |-
groupCode, only accept alphabet and whitespace
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, HttpResponse], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/misc/delete_country_group.py'
example: |-
result, error = basic.delete_country_group(...)
if error:
# handle_error(error)
tags:
- 'country'
- 'delete'
- 'group'
- 'misc'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MISC [DELETE]'
'delete_namespace@py.basic.fun':
id: 'delete_namespace@py.basic.fun'
name: 'delete_namespace'
type: 'function'
description: |-
Delete a namespace.
Other detail info:
* Action code : 11307
* Returns : deleted namespace
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, NamespaceInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/namespace/delete_namespace.py'
example: |-
result, error = basic.delete_namespace(...)
if error:
# handle_error(error)
tags:
- 'delete'
- 'namespace'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:NAMESPACE [DELETE]'
'delete_user_profile@py.basic.fun':
id: 'delete_user_profile@py.basic.fun'
name: 'delete_user_profile'
type: 'function'
description: |-
Delete user profile.
Other detail info:
* Action code : 11407
* Returns : Delete user profile
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
'user_id':
type: 'str'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'Tuple[Union[None, UserProfilePrivateInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/user_profile/delete_user_profile.py'
example: |-
result, error = basic.delete_user_profile(...)
if error:
# handle_error(error)
tags:
- 'delete'
- 'profile'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:PROFILE [DELETE]'
'generated_upload_url@py.basic.fun':
id: 'generated_upload_url@py.basic.fun'
name: 'generated_upload_url'
type: 'function'
description: |-
Generate an upload URL. It's valid for 10 minutes.
Other detail info:
* Action code : 11101
* Returns : URL data
arguments:
'file_type':
type: 'str'
required: true
description: |-
one of the these types: jpeg, jpg, png, bmp, gif, mp3, bin, webp, mp4, webm
'folder':
type: 'str'
required: true
description: |-
the name of folder where the file will be uploaded, must be between 1-256 characters, all characters allowed no whitespace
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, FileUploadUrlInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/file_upload/generated_upload_url.py'
example: |-
result, error = basic.generated_upload_url(...)
if error:
# handle_error(error)
tags:
- 'file'
- 'generated'
- 'upload'
- 'url'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:FILEUPLOAD [CREATE]'
'generated_user_upload_content_url@py.basic.fun':
id: 'generated_user_upload_content_url@py.basic.fun'
name: 'generated_user_upload_content_url'
type: 'function'
description: |-
Generate an upload URL for user content. It's valid for 10 minutes.
Other detail info:
* Action code : 11102
* Returns : URL data
arguments:
'category':
type: 'Optional[str]'
required: false
description: |-
Upload category. Supported categories: default, reporting
'file_type':
type: 'str'
required: true
description: |-
one of the these types: jpeg, jpg, png, bmp, gif, mp3, bin, webp, mp4, webm
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
'user_id':
type: 'str'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'Tuple[Union[None, FileUploadUrlInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/file_upload/generated_user_upload_c_8f862a.py'
example: |-
result, error = basic.generated_user_upload_content_url(...)
if error:
# handle_error(error)
tags:
- 'content'
- 'file'
- 'generated'
- 'upload'
- 'url'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:FILEUPLOAD [CREATE]'
'get_child_namespaces@py.basic.fun':
id: 'get_child_namespaces@py.basic.fun'
name: 'get_child_namespaces'
type: 'function'
description: |-
Get child namespaces.
If input namespace is publisher namespace, then it will return its all studio namespace.
If input namespace is studio namespace, then it will return its all game namespace.
Other detail info:
* Returns : list of child namespaces
arguments:
'active_only':
type: 'Optional[bool]'
required: false
description: |-
only retrieves active namespaces
'namespace':
type: 'str'
required: true
return_type: 'Tuple[Union[None, List[NamespaceInfo]], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/namespace/get_child_namespaces.py'
example: |-
result, error = basic.get_child_namespaces(...)
if error:
# handle_error(error)
tags:
- 'child'
- 'get'
- 'namespace'
- 'namespaces'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:NAMESPACE [READ]'
'get_config@py.basic.fun':
id: 'get_config@py.basic.fun'
name: 'get_config'
type: 'function'
description: |-
Get a config.
Other detail info:
* Returns : config
arguments:
'config_key':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, ConfigInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/config/get_config.py'
example: |-
result, error = basic.get_config(...)
if error:
# handle_error(error)
tags:
- 'config'
- 'get'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:BASIC:CONFIG [READ]'
'get_countries@py.basic.fun':
id: 'get_countries@py.basic.fun'
name: 'get_countries'
type: 'function'
description: |-
List countries.
Other detail info:
* Action code : 11204
* Returns : country code list
arguments:
'lang':
type: 'Optional[str]'
required: false
description: |-
language value from language tag, allowed format: en, en-US
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, List[CountryObject]], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/misc/get_countries.py'
example: |-
result, error = basic.get_countries(...)
if error:
# handle_error(error)
tags:
- 'countries'
- 'get'
- 'misc'
'get_country_groups@py.basic.fun':
id: 'get_country_groups@py.basic.fun'
name: 'get_country_groups'
type: 'function'
description: |-
List country groups. Will return all available country groups if the query param is not specified
Other detail info:
* Action code : 11203
* Returns : list of country groups
arguments:
'group_code':
type: 'Optional[str]'
required: false
description: |-
groupCode, only accept alphabet and whitespace
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, List[RetrieveCountryGroupResponse]], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/misc/get_country_groups.py'
example: |-
result, error = basic.get_country_groups(...)
if error:
# handle_error(error)
tags:
- 'country'
- 'get'
- 'groups'
- 'misc'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MISC [READ]'
'get_custom_attributes_info@py.basic.fun':
id: 'get_custom_attributes_info@py.basic.fun'
name: 'get_custom_attributes_info'
type: 'function'
description: |-
Get user custom attributes.
Other detail info:
* Returns : custom attributes
* Action code : 11403
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
'user_id':
type: 'str'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'Tuple[Union[None, Dict[str, Any]], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/user_profile/get_custom_attributes_info.py'
example: |-
result, error = basic.get_custom_attributes_info(...)
if error:
# handle_error(error)
tags:
- 'attributes'
- 'custom'
- 'get'
- 'info'
- 'profile'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:PROFILE [READ]'
'get_game_namespaces@py.basic.fun':
id: 'get_game_namespaces@py.basic.fun'
name: 'get_game_namespaces'
type: 'function'
description: |-
Get game namespaces.
In multi tenant mode, a given super admin namespace will return all game namespaces of studio namespaces
Other detail info:
* Action code : 11308
* Returns : list of namespaces
arguments:
'active_only':
type: 'Optional[bool]'
required: false
description: |-
only retrieves active namespaces
'namespace':
type: 'str'
required: true
return_type: 'Tuple[Union[None, List[NamespaceInfo]], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/namespace/get_game_namespaces.py'
example: |-
result, error = basic.get_game_namespaces(...)
if error:
# handle_error(error)
tags:
- 'game'
- 'get'
- 'namespace'
- 'namespaces'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:NAMESPACE [READ]'
'get_languages@py.basic.fun':
id: 'get_languages@py.basic.fun'
name: 'get_languages'
type: 'function'
description: |-
List languages.
Other detail info:
* Action code : 11206
* Returns : language list
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, Dict[str, str]], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/misc/get_languages.py'
example: |-
result, error = basic.get_languages(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'languages'
- 'misc'
'get_my_private_custom_attributes_info@py.basic.fun':
id: 'get_my_private_custom_attributes_info@py.basic.fun'
name: 'get_my_private_custom_attributes_info'
type: 'function'
description: |-
Get my private custom attributes.
Other detail info:
* Returns : custom attributes
* Action code : 11403
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, Dict[str, Any]], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/user_profile/get_my_private_custom_a_61114d.py'
example: |-
result, error = basic.get_my_private_custom_attributes_info(...)
if error:
# handle_error(error)
tags:
- 'attributes'
- 'custom'
- 'get'
- 'info'
- 'my'
- 'private'
- 'profile'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:PROFILE [READ]'
'get_my_profile_info@py.basic.fun':
id: 'get_my_profile_info@py.basic.fun'
name: 'get_my_profile_info'
type: 'function'
description: |-
Get my profile
Client with user token can get user profile in target namespace
Other detail info:
* Action code : 11403
* Returns : user profile
* Path's namespace :
* can be filled with publisher namespace in order to get publisher user profile
* can be filled with game namespace in order to get game user profile
* Language : allowed format: en, en-US
* Timezone : IANA time zone, e.g. Asia/Shanghai
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, UserProfilePrivateInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/user_profile/get_my_profile_info.py'
example: |-
result, error = basic.get_my_profile_info(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'info'
- 'my'
- 'profile'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:PROFILE [READ]'
'get_my_zip_code@py.basic.fun':
id: 'get_my_zip_code@py.basic.fun'
name: 'get_my_zip_code'
type: 'function'
description: |-
Get my zip code.
Other detail info:
* Action code : 11407
* Returns : user zip code
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, UserZipCode], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/user_profile/get_my_zip_code.py'
example: |-
result, error = basic.get_my_zip_code(...)
if error:
# handle_error(error)
tags:
- 'code'
- 'get'
- 'my'
- 'profile'
- 'user'
- 'zip'
permissions:
- 'NAMESPACE:{namespace}:PROFILE [READ]'
'get_namespace@py.basic.fun':
id: 'get_namespace@py.basic.fun'
name: 'get_namespace'
type: 'function'
description: |-
Get a namespace.
In multi tenant mode, parentNamespace will be returned.
Other detail info:
* Action code : 11304
* Returns : namespace
arguments:
'active_only':
type: 'Optional[bool]'
required: false
description: |-
only retrieves active namespaces
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, NamespaceInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/namespace/get_namespace.py'
example: |-
result, error = basic.get_namespace(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'namespace'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:NAMESPACE [READ]'
'get_namespace_1@py.basic.fun':
id: 'get_namespace_1@py.basic.fun'
name: 'get_namespace_1'
type: 'function'
description: |-
Get a namespace info.
Other detail info:
* Returns : namespace info
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, NamespaceSimpleInfo], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/namespace/get_namespace_1.py'
example: |-
result, error = basic.get_namespace_1(...)
if error:
# handle_error(error)
tags:
- '1'
- 'get'
- 'namespace'
'get_namespace_context@py.basic.fun':
id: 'get_namespace_context@py.basic.fun'
name: 'get_namespace_context'
type: 'function'
description: |-
Get context of namespace.
Other detail info:
* Returns : context of namespace
arguments:
'namespace':
type: 'str'
required: true
'refresh_on_cache_miss':
type: 'Optional[bool]'
required: false
return_type: 'Tuple[Union[None, NamespaceContext], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/namespace/get_namespace_context.py'
example: |-
result, error = basic.get_namespace_context(...)
if error:
# handle_error(error)
tags:
- 'context'
- 'get'
- 'namespace'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:NAMESPACE [READ]'
'get_namespace_publisher@py.basic.fun':
id: 'get_namespace_publisher@py.basic.fun'
name: 'get_namespace_publisher'
type: 'function'
description: |-
Get namespace info related publisher namespace.
Other detail info:
* Action code : 11305
* Returns : Namespace info related publisher namespace
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, NamespacePublisherInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/namespace/get_namespace_publisher.py'
example: |-
result, error = basic.get_namespace_publisher(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'namespace'
- 'publisher'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:NAMESPACE [READ]'
'get_namespaces@py.basic.fun':
id: 'get_namespaces@py.basic.fun'
name: 'get_namespaces'
type: 'function'
description: |-
Get all namespaces.
Other detail info:
* Action code : 11303
* Returns : list of namespaces
arguments:
'active_only':
type: 'Optional[bool]'
required: false
description: |-
only retrieves active namespaces
return_type: 'Tuple[Union[None, List[NamespaceInfo]], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/namespace/get_namespaces.py'
example: |-
result, error = basic.get_namespaces(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'namespace'
- 'namespaces'
permissions:
- 'ADMIN:NAMESPACE [READ]'
'get_private_custom_attributes_info@py.basic.fun':
id: 'get_private_custom_attributes_info@py.basic.fun'
name: 'get_private_custom_attributes_info'
type: 'function'
description: |-
Get user private custom attributes.
Other detail info:
* Returns : custom attributes
* Action code : 11403
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
'user_id':
type: 'str'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'Tuple[Union[None, Dict[str, Any]], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/user_profile/get_private_custom_attr_322032.py'
example: |-
result, error = basic.get_private_custom_attributes_info(...)
if error:
# handle_error(error)
tags:
- 'attributes'
- 'custom'
- 'get'
- 'info'
- 'private'
- 'profile'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:PROFILE [READ]'
'get_publisher_config@py.basic.fun':
id: 'get_publisher_config@py.basic.fun'
name: 'get_publisher_config'
type: 'function'
description: |-
Get a publisher config.
It will return a publisher namespace config of the given namespace and key.
Other detail info:
* Returns : config
arguments:
'config_key':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, ConfigInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/config/get_publisher_config.py'
example: |-
result, error = basic.get_publisher_config(...)
if error:
# handle_error(error)
tags:
- 'config'
- 'get'
- 'publisher'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:BASIC:CONFIG [READ]'
'get_time_zones@py.basic.fun':
id: 'get_time_zones@py.basic.fun'
name: 'get_time_zones'
type: 'function'
description: |-
List time zones.
Other detail info:
* Action code : 11205
* Returns : time zones
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, List[str]], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/misc/get_time_zones.py'
example: |-
result, error = basic.get_time_zones(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'misc'
- 'time'
- 'zones'
'get_user_profile_info@py.basic.fun':
id: 'get_user_profile_info@py.basic.fun'
name: 'get_user_profile_info'
type: 'function'
description: |-
Get user profile.
Other detail info:
* Returns : user profile
* Action code : 11403
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
'user_id':
type: 'str'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'Tuple[Union[None, UserProfilePrivateInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/user_profile/get_user_profile_info.py'
example: |-
result, error = basic.get_user_profile_info(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'info'
- 'profile'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:PROFILE [READ]'
'get_user_profile_info_by_public_id@py.basic.fun':
id: 'get_user_profile_info_by_public_id@py.basic.fun'
name: 'get_user_profile_info_by_public_id'
type: 'function'
description: |-
Get user profile by public id.
Other detail info:
* Returns : user profile info
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
'public_id':
type: 'str'
required: true
description: |-
user public id
return_type: 'Tuple[Union[None, UserProfileInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/user_profile/get_user_profile_info_b_5dfc7f.py'
example: |-
result, error = basic.get_user_profile_info_by_public_id(...)
if error:
# handle_error(error)
tags:
- 'by'
- 'get'
- 'id'
- 'info'
- 'profile'
- 'public'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:PROFILE [READ]'
'public_bulk_get_user_profile_public_info@py.basic.fun':
id: 'public_bulk_get_user_profile_public_info@py.basic.fun'
name: 'public_bulk_get_user_profile_public_info'
type: 'function'
description: |-
Bulk get user public profile by ids.
Other detail info:
* Returns : user public profiles
arguments:
'body':
type: 'Optional[UserProfileBulkRequest]'
required: false
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, List[UserProfilePublicInfo]], Union[None, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/user_profile/public_bulk_get_user_pr_20583a.py'
example: |-
result, error = basic.public_bulk_get_user_profile_public_info(...)
if error:
# handle_error(error)
tags:
- 'bulk'
- 'get'
- 'info'
- 'profile'
- 'public'
- 'user'
'public_create_user_profile@py.basic.fun':
id: 'public_create_user_profile@py.basic.fun'
name: 'public_create_user_profile'
type: 'function'
description: |-
Create user profile.
Other detail info:
* Action code : 11401
* Language : allowed format: en, en-US
* Timezone : IANA time zone, e.g. Asia/Shanghai
* Returns : Created user profile
arguments:
'body':
type: 'Optional[UserProfileCreate]'
required: false
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
'user_id':
type: 'str'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'Tuple[Union[None, UserProfileInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/user_profile/public_create_user_profile.py'
example: |-
result, error = basic.public_create_user_profile(...)
if error:
# handle_error(error)
tags:
- 'create'
- 'profile'
- 'public'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:PROFILE [CREATE]'
'public_generated_upload_url@py.basic.fun':
id: 'public_generated_upload_url@py.basic.fun'
name: 'public_generated_upload_url'
type: 'function'
description: |-
Generate an upload URL. It's valid for 10 minutes.
Other detail info:
* Action code : 11101
* Returns : URL data
arguments:
'file_type':
type: 'str'
required: true
description: |-
one of the these types: jpeg, jpg, png, bmp, gif, mp3, bin, webp
'folder':
type: 'str'
required: true
description: |-
the name of folder where the file will be uploaded, must be between 1-256 characters, all characters allowed no whitespace
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, FileUploadUrlInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/file_upload/public_generated_upload_url.py'
example: |-
result, error = basic.public_generated_upload_url(...)
if error:
# handle_error(error)
tags:
- 'file'
- 'generated'
- 'public'
- 'upload'
- 'url'
permissions:
- 'NAMESPACE:{namespace}:FILEUPLOAD [CREATE]'
'public_generated_user_upload_content_url@py.basic.fun':
id: 'public_generated_user_upload_content_url@py.basic.fun'
name: 'public_generated_user_upload_content_url'
type: 'function'
description: |-
Generate an upload URL for user content. It's valid for 10 minutes.
There are two types of storage limits per user: maximum file count and maximum total file size.
These limits vary depending on the upload category used.
1. Default category:
- Maximum file count per user: 10 files
- Maximum total file size per user: 100MB
2. Reporting category:
- Maximum file count per user: 3 files every 1 hour
- Maximum total file size per user: 30MB every 1 hour
Other detail info:
* Action code : 11102
* Returns : URL data
arguments:
'category':
type: 'Optional[str]'
required: false
description: |-
Upload category. Supported categories: default, reporting
'file_type':
type: 'str'
required: true
description: |-
one of the these types: jpeg, jpg, png, bmp, gif, mp3, bin, webp
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
'user_id':
type: 'str'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'Tuple[Union[None, FileUploadUrlInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/file_upload/public_generated_user_u_2061db.py'
example: |-
result, error = basic.public_generated_user_upload_content_url(...)
if error:
# handle_error(error)
tags:
- 'content'
- 'file'
- 'generated'
- 'public'
- 'upload'
- 'url'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:FILEUPLOAD [CREATE]'
'public_get_countries@py.basic.fun':
id: 'public_get_countries@py.basic.fun'
name: 'public_get_countries'
type: 'function'
description: |-
List countries.
Other detail info:
* Returns : country code list
arguments:
'lang':
type: 'Optional[str]'
required: false
description: |-
language value from language tag, allowed format: en, en-US
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, List[CountryObject]], Union[None, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/misc/public_get_countries.py'
example: |-
result, error = basic.public_get_countries(...)
if error:
# handle_error(error)
tags:
- 'countries'
- 'get'
- 'misc'
- 'public'
'public_get_custom_attributes_info@py.basic.fun':
id: 'public_get_custom_attributes_info@py.basic.fun'
name: 'public_get_custom_attributes_info'
type: 'function'
description: |-
Get custom attributes info.
Other detail info:
* Action code : 11404
* Returns : user custom attributes
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
'user_id':
type: 'str'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'Tuple[Union[None, Dict[str, Any]], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/user_profile/public_get_custom_attri_5323c2.py'
example: |-
result, error = basic.public_get_custom_attributes_info(...)
if error:
# handle_error(error)
tags:
- 'attributes'
- 'custom'
- 'get'
- 'info'
- 'profile'
- 'public'
- 'user'
'public_get_languages@py.basic.fun':
id: 'public_get_languages@py.basic.fun'
name: 'public_get_languages'
type: 'function'
description: |-
List languages.
Other detail info:
* Returns : language list
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, Dict[str, Any]], Union[None, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/misc/public_get_languages.py'
example: |-
result, error = basic.public_get_languages(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'languages'
- 'misc'
- 'public'
'public_get_namespace_publisher@py.basic.fun':
id: 'public_get_namespace_publisher@py.basic.fun'
name: 'public_get_namespace_publisher'
type: 'function'
description: |-
Get namespace info related publisher namespace.
Other detail info:
* Action code : 11305
* Returns : Namespace info related publisher namespace
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, NamespacePublisherInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/namespace/public_get_namespace_publisher.py'
example: |-
result, error = basic.public_get_namespace_publisher(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'namespace'
- 'public'
- 'publisher'
permissions:
- 'NAMESPACE:{namespace}:NAMESPACE [READ]'
'public_get_namespaces@py.basic.fun':
id: 'public_get_namespaces@py.basic.fun'
name: 'public_get_namespaces'
type: 'function'
description: |-
Get all namespaces.
Other detail info:
* Action code : 11303
* Returns : list of namespaces
arguments:
'active_only':
type: 'Optional[bool]'
required: false
description: |-
only retrieves active namespaces
return_type: 'Tuple[Union[None, List[NamespaceInfo]], Union[None, ErrorEntity, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/namespace/public_get_namespaces.py'
example: |-
result, error = basic.public_get_namespaces(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'namespace'
- 'namespaces'
- 'public'
'public_get_time@py.basic.fun':
id: 'public_get_time@py.basic.fun'
name: 'public_get_time'
type: 'function'
description: |-
Get server time
return_type: 'Tuple[Union[None, RetrieveTimeResponse], 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.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/misc/public_get_time.py'
example: |-
result, error = basic.public_get_time(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'misc'
- 'public'
- 'time'
'public_get_time_zones@py.basic.fun':
id: 'public_get_time_zones@py.basic.fun'
name: 'public_get_time_zones'
type: 'function'
description: |-
List time zones.
Other detail info:
* Returns : time zones
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, List[str]], Union[None, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/misc/public_get_time_zones.py'
example: |-
result, error = basic.public_get_time_zones(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'misc'
- 'public'
- 'time'
- 'zones'
'public_get_user_profile_info@py.basic.fun':
id: 'public_get_user_profile_info@py.basic.fun'
name: 'public_get_user_profile_info'
type: 'function'
description: |-
Get user profile.
Other detail info:
* Action code : 11403
* Returns : user profile
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
'user_id':
type: 'str'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'Tuple[Union[None, UserProfileInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/user_profile/public_get_user_profile_info.py'
example: |-
result, error = basic.public_get_user_profile_info(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'info'
- 'profile'
- 'public'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:PROFILE [READ]'
'public_get_user_profile_info_by_public_id@py.basic.fun':
id: 'public_get_user_profile_info_by_public_id@py.basic.fun'
name: 'public_get_user_profile_info_by_public_id'
type: 'function'
description: |-
Get user public profile by public id.
Other detail info:
* Returns : user public profile
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
'public_id':
type: 'str'
required: true
description: |-
user public id
return_type: 'Tuple[Union[None, UserProfilePublicInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/user_profile/public_get_user_profile_0d683e.py'
example: |-
result, error = basic.public_get_user_profile_info_by_public_id(...)
if error:
# handle_error(error)
tags:
- 'by'
- 'get'
- 'id'
- 'info'
- 'profile'
- 'public'
- 'user'
'public_get_user_profile_public_info@py.basic.fun':
id: 'public_get_user_profile_public_info@py.basic.fun'
name: 'public_get_user_profile_public_info'
type: 'function'
description: |-
Get user profile public info.
Other detail info:
* Action code : 11404
* Returns : user public profile
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
'user_id':
type: 'str'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'Tuple[Union[None, UserProfilePublicInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/user_profile/public_get_user_profile_64cc50.py'
example: |-
result, error = basic.public_get_user_profile_public_info(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'info'
- 'profile'
- 'public'
- 'user'
'public_get_user_profile_public_info_by_ids@py.basic.fun':
id: 'public_get_user_profile_public_info_by_ids@py.basic.fun'
name: 'public_get_user_profile_public_info_by_ids'
type: 'function'
description: |-
Get user public profile by ids.
Other detail info:
* Action code : 11405
* Returns : user public profiles
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
'user_ids':
type: 'str'
required: true
description: |-
User IDs, should follow UUID version 4 without hyphen, separate the IDs using comma
return_type: 'Tuple[Union[None, List[UserProfilePublicInfo]], Union[None, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/user_profile/public_get_user_profile_cdd77a.py'
example: |-
result, error = basic.public_get_user_profile_public_info_by_ids(...)
if error:
# handle_error(error)
tags:
- 'by'
- 'get'
- 'ids'
- 'info'
- 'profile'
- 'public'
- 'user'
'public_update_custom_attributes_partially@py.basic.fun':
id: 'public_update_custom_attributes_partially@py.basic.fun'
name: 'public_update_custom_attributes_partially'
type: 'function'
description: |-
Update partially custom attributes tied to user id.
Other detail info:
* Action code : 11402
* Request body : allowed format: JSON object
* Returns : Updated custom attributes
arguments:
'body':
type: 'Optional[Dict[str, Any]]'
required: false
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
'user_id':
type: 'str'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'Tuple[Union[None, Dict[str, Any]], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/user_profile/public_update_custom_at_7dcf23.py'
example: |-
result, error = basic.public_update_custom_attributes_partially(...)
if error:
# handle_error(error)
tags:
- 'attributes'
- 'custom'
- 'partially'
- 'profile'
- 'public'
- 'update'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:PROFILE [UPDATE]'
'public_update_user_profile@py.basic.fun':
id: 'public_update_user_profile@py.basic.fun'
name: 'public_update_user_profile'
type: 'function'
description: |-
Update user profile.
Other detail info:
* Action code : 11402
* Language : allowed format: en, en-US
* Timezone : IANA time zone, e.g. Asia/Shanghai
* Returns : Updated user profile
arguments:
'body':
type: 'Optional[UserProfileUpdate]'
required: false
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
'user_id':
type: 'str'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'Tuple[Union[None, UserProfileInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/user_profile/public_update_user_profile.py'
example: |-
result, error = basic.public_update_user_profile(...)
if error:
# handle_error(error)
tags:
- 'profile'
- 'public'
- 'update'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:PROFILE [UPDATE]'
'public_update_user_profile_status@py.basic.fun':
id: 'public_update_user_profile_status@py.basic.fun'
name: 'public_update_user_profile_status'
type: 'function'
description: |-
Update user profile status.
Other detail info:
* Action code : 11406
* Returns : user profile
arguments:
'body':
type: 'Optional[UserProfileStatusUpdate]'
required: false
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
'user_id':
type: 'str'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'Tuple[Union[None, UserProfileInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/user_profile/public_update_user_prof_c93172.py'
example: |-
result, error = basic.public_update_user_profile_status(...)
if error:
# handle_error(error)
tags:
- 'profile'
- 'public'
- 'status'
- 'update'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:PROFILE [UPDATE]'
'update_config@py.basic.fun':
id: 'update_config@py.basic.fun'
name: 'update_config'
type: 'function'
description: |-
Update a config.
Other detail info:
* Returns : created config
arguments:
'body':
type: 'Optional[ConfigUpdate]'
required: false
'config_key':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
return_type: 'Tuple[Union[None, ConfigInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/config/update_config.py'
example: |-
result, error = basic.update_config(...)
if error:
# handle_error(error)
tags:
- 'config'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:BASIC:CONFIG [UPDATE]'
'update_country_group@py.basic.fun':
id: 'update_country_group@py.basic.fun'
name: 'update_country_group'
type: 'function'
description: |-
Update a country groups. The countryGroupCode must be exist beforehand.
Valid update behaviour :
- To update countryGroupName only, do not include countries key or just specify it with empty array.
- To update countries only, do not include countryGroupName key or just specify it with blank value.
Other detail info:
* Action code : 11202
* Returns : updated country group
arguments:
'body':
type: 'Optional[UpdateCountryGroupRequest]'
required: false
'country_group_code':
type: 'str'
required: true
description: |-
groupCode, only accept alphabet and whitespace
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, CountryGroupObject], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/misc/update_country_group.py'
example: |-
result, error = basic.update_country_group(...)
if error:
# handle_error(error)
tags:
- 'country'
- 'group'
- 'misc'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MISC [UPDATE]'
'update_custom_attributes_partially@py.basic.fun':
id: 'update_custom_attributes_partially@py.basic.fun'
name: 'update_custom_attributes_partially'
type: 'function'
description: |-
Update partially custom attributes tied to the user id.
Other detail info:
* Action code : 11402
* Request body : allowed format: JSON object
* Returns : Updated custom attributes
arguments:
'body':
type: 'Optional[Dict[str, Any]]'
required: false
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
'user_id':
type: 'str'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'Tuple[Union[None, Dict[str, Any]], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/user_profile/update_custom_attribute_105f42.py'
example: |-
result, error = basic.update_custom_attributes_partially(...)
if error:
# handle_error(error)
tags:
- 'attributes'
- 'custom'
- 'partially'
- 'profile'
- 'update'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:PROFILE [UPDATE]'
'update_my_private_custom_attributes_partially@py.basic.fun':
id: 'update_my_private_custom_attributes_partially@py.basic.fun'
name: 'update_my_private_custom_attributes_partially'
type: 'function'
description: |-
Update partially private custom attributes tied to me.
Other detail info:
* Action code : 11402
* Request body : allowed format: JSON object
* Returns : Updated custom attributes
arguments:
'body':
type: 'Optional[Dict[str, Any]]'
required: false
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, Dict[str, Any]], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/user_profile/update_my_private_custo_49ebda.py'
example: |-
result, error = basic.update_my_private_custom_attributes_partially(...)
if error:
# handle_error(error)
tags:
- 'attributes'
- 'custom'
- 'my'
- 'partially'
- 'private'
- 'profile'
- 'update'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:PROFILE [UPDATE]'
'update_my_profile@py.basic.fun':
id: 'update_my_profile@py.basic.fun'
name: 'update_my_profile'
type: 'function'
description: |-
Update my profile.
Updates user profile in the target namespace (namespace in the path). If token's namespace doesn't match the target namespace, the service automatically maps the token's user ID into the user ID in the target namespace. The endpoint returns the updated user profile on a successful call.
Other detail info:
* Action code : 11402
* Returns : user profile
* Path's namespace :
* can be filled with publisher namespace in order to update publisher user profile
* can be filled with game namespace in order to update game user profile
* Language : allowed format: en, en-US
* Timezone : IANA time zone, e.g. Asia/Shanghai
arguments:
'body':
type: 'Optional[UserProfileUpdate]'
required: false
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, UserProfilePrivateInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/user_profile/update_my_profile.py'
example: |-
result, error = basic.update_my_profile(...)
if error:
# handle_error(error)
tags:
- 'my'
- 'profile'
- 'update'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:PROFILE [UPDATE]'
'update_my_zip_code@py.basic.fun':
id: 'update_my_zip_code@py.basic.fun'
name: 'update_my_zip_code'
type: 'function'
description: |-
Update my zip code.
Other detail info:
* Action code : 11408
* Returns : user zip code
arguments:
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
'user_zip_code_update':
type: 'UserZipCodeUpdate'
required: true
return_type: 'Tuple[Union[None, UserZipCode], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/user_profile/update_my_zip_code.py'
example: |-
result, error = basic.update_my_zip_code(...)
if error:
# handle_error(error)
tags:
- 'code'
- 'my'
- 'profile'
- 'update'
- 'user'
- 'zip'
permissions:
- 'NAMESPACE:{namespace}:PROFILE [UPDATE]'
'update_namespace@py.basic.fun':
id: 'update_namespace@py.basic.fun'
name: 'update_namespace'
type: 'function'
description: |-
Update namespace basic info.
displayName rule:
* Alphanumeric lowercase and uppercase are allowed
* Allowed Special Character: ',. -
* Must start and end with alphanumeric
* Spaces and special character are allowed but cannot appear twice in a row
Other detail info:
* Action code : 11302
* Returns : updated namespace
arguments:
'body':
type: 'Optional[NamespaceUpdate]'
required: false
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Tuple[Union[None, NamespaceInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/namespace/update_namespace.py'
example: |-
result, error = basic.update_namespace(...)
if error:
# handle_error(error)
tags:
- 'namespace'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:NAMESPACE [UPDATE]'
'update_private_custom_attributes_partially@py.basic.fun':
id: 'update_private_custom_attributes_partially@py.basic.fun'
name: 'update_private_custom_attributes_partially'
type: 'function'
description: |-
Update partially private custom attributes tied to the user id.
Other detail info:
* Action code : 11402
* Request body : allowed format: JSON object
* Returns : Updated custom attributes
arguments:
'body':
type: 'Optional[Dict[str, Any]]'
required: false
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
'user_id':
type: 'str'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'Tuple[Union[None, Dict[str, Any]], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/user_profile/update_private_custom_a_62b74f.py'
example: |-
result, error = basic.update_private_custom_attributes_partially(...)
if error:
# handle_error(error)
tags:
- 'attributes'
- 'custom'
- 'partially'
- 'private'
- 'profile'
- 'update'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:PROFILE [UPDATE]'
'update_user_profile@py.basic.fun':
id: 'update_user_profile@py.basic.fun'
name: 'update_user_profile'
type: 'function'
description: |-
Update user profile.
Other detail info:
* Action code : 11402
* Returns : Updated user profile
arguments:
'body':
type: 'Optional[UserProfileAdmin]'
required: false
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
'user_id':
type: 'str'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'Tuple[Union[None, UserProfilePrivateInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/user_profile/update_user_profile.py'
example: |-
result, error = basic.update_user_profile(...)
if error:
# handle_error(error)
tags:
- 'profile'
- 'update'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:PROFILE [UPDATE]'
'update_user_profile_status@py.basic.fun':
id: 'update_user_profile_status@py.basic.fun'
name: 'update_user_profile_status'
type: 'function'
description: |-
Update user profile status.
Other detail info:
* Action code : 11406
* Returns : user profile
arguments:
'body':
type: 'Optional[UserProfileStatusUpdate]'
required: false
'namespace':
type: 'str'
required: true
description: |-
namespace, only accept alphabet and numeric
'user_id':
type: 'str'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'Tuple[Union[None, UserProfilePrivateInfo], Union[None, ErrorEntity, HttpResponse, ValidationErrorEntity]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.basic as basic'
- 'import accelbyte_py_sdk.api.basic.models as basic_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/basic/operations/user_profile/update_user_profile_status.py'
example: |-
result, error = basic.update_user_profile_status(...)
if error:
# handle_error(error)
tags:
- 'profile'
- 'status'
- 'update'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:PROFILE [UPDATE]'
# endregion functions
