AGS Extend SDK MCP Server

symbols: # region models 'AcceptAgreementRequest@py.legal.mod': id: 'AcceptAgreementRequest@py.legal.mod' name: 'AcceptAgreementRequest' type: 'model' fields: 'is_accepted': type: 'bool' required: true 'localized_policy_version_id': type: 'str' required: true 'policy_id': type: 'str' required: true 'policy_version_id': type: 'str' required: true 'is_need_to_send_event_marketing': type: 'bool' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/accept_agreement_request.py' example: |- accept_agreement_request = legal_models.AcceptAgreementRequest.create(...) 'AcceptAgreementResponse@py.legal.mod': id: 'AcceptAgreementResponse@py.legal.mod' name: 'AcceptAgreementResponse' type: 'model' fields: 'comply': type: 'bool' required: true description: |- Eligibility Status after Accept Agreement 'proceed': type: 'bool' required: true description: |- DEPRECATED the name is not clear, changed with comply imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/accept_agreement_response.py' example: |- accept_agreement_response = legal_models.AcceptAgreementResponse.create(...) 'CreateBasePolicyRequest@py.legal.mod': id: 'CreateBasePolicyRequest@py.legal.mod' name: 'CreateBasePolicyRequest' type: 'model' fields: 'affected_client_ids': type: 'List[str]' required: false 'affected_countries': type: 'List[str]' required: false 'base_policy_name': type: 'str' required: false 'country_group_name': type: 'str' required: false 'country_type': type: 'Union[str, CountryTypeEnum]' required: false description: |- country type, only accept COUNTRY or COUNTRY_GROUP 'description': type: 'str' required: false 'is_hidden': type: 'bool' required: false description: |- active status of this policy, it will affect user's eligibility status check 'is_hidden_public': type: 'bool' required: false description: |- hide the policy from public(e.g. legal website), it will NOT affect user's eligibility status check 'namespace': type: 'str' required: false 'tags': type: 'List[str]' required: false 'type_id': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/create_base_policy_request.py' example: |- create_base_policy_request = legal_models.CreateBasePolicyRequest.create(...) 'CreateBasePolicyRequestV2@py.legal.mod': id: 'CreateBasePolicyRequestV2@py.legal.mod' name: 'CreateBasePolicyRequestV2' type: 'model' fields: 'affected_client_ids': type: 'List[str]' required: false 'affected_countries': type: 'List[str]' required: false 'base_policy_name': type: 'str' required: false 'country_group_name': type: 'str' required: false 'country_type': type: 'Union[str, CountryTypeEnum]' required: false description: |- country type, only accept COUNTRY or COUNTRY_GROUP 'description': type: 'str' required: false 'is_hidden': type: 'bool' required: false description: |- active status of this policy, it will affect user's eligibility status check 'is_hidden_public': type: 'bool' required: false description: |- hide the policy from public(e.g. legal website), it will NOT affect user's eligibility status check 'tags': type: 'List[str]' required: false 'type_id': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/create_base_policy_request_v2.py' example: |- create_base_policy_request_v2 = legal_models.CreateBasePolicyRequestV2.create(...) 'CreateBasePolicyResponse@py.legal.mod': id: 'CreateBasePolicyResponse@py.legal.mod' name: 'CreateBasePolicyResponse' type: 'model' fields: 'id_': type: 'str' required: true 'affected_client_ids': type: 'List[str]' required: false 'affected_countries': type: 'List[str]' required: false 'country_group_name': type: 'str' required: false 'country_type': type: 'Union[str, CountryTypeEnum]' required: false 'created_at': type: 'str' required: false 'description': type: 'str' required: false 'global_policy_name': type: 'str' required: false 'is_hidden': type: 'bool' required: false description: |- active status of this policy, it will affect user's eligibility status check 'is_hidden_public': type: 'bool' required: false description: |- hide the policy from public(e.g. legal website), it will NOT affect user's eligibility status check 'namespace': type: 'str' required: false 'policy_id': type: 'str' required: false 'tags': type: 'List[str]' required: false 'type_id': type: 'str' required: false 'updated_at': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/create_base_policy_response.py' example: |- create_base_policy_response = legal_models.CreateBasePolicyResponse.create(...) 'CreateLocalizedPolicyVersionRequest@py.legal.mod': id: 'CreateLocalizedPolicyVersionRequest@py.legal.mod' name: 'CreateLocalizedPolicyVersionRequest' type: 'model' fields: 'content_type': type: 'str' required: false 'description': type: 'str' required: false 'locale_code': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/create_localized_policy_version_request.py' example: |- create_localized_policy_version_request = legal_models.CreateLocalizedPolicyVersionRequest.create(...) 'CreateLocalizedPolicyVersionResponse@py.legal.mod': id: 'CreateLocalizedPolicyVersionResponse@py.legal.mod' name: 'CreateLocalizedPolicyVersionResponse' type: 'model' fields: 'id_': type: 'str' required: true 'created_at': type: 'str' required: false 'description': type: 'str' required: false 'locale_code': type: 'str' required: false 'updated_at': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/create_localized_policy_version_response.py' example: |- create_localized_policy_version_response = legal_models.CreateLocalizedPolicyVersionResponse.create(...) 'CreatePolicyRequest@py.legal.mod': id: 'CreatePolicyRequest@py.legal.mod' name: 'CreatePolicyRequest' type: 'model' fields: 'countries': type: 'List[str]' required: false 'country_code': type: 'str' required: false 'country_group_name': type: 'str' required: false 'country_type': type: 'Union[str, CountryTypeEnum]' required: false description: |- country type, only accept COUNTRY or COUNTRY_GROUP 'description': type: 'str' required: false 'is_default_selection': type: 'bool' required: false 'is_mandatory': type: 'bool' required: false 'policy_name': type: 'str' required: false 'should_notify_on_update': type: 'bool' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/create_policy_request.py' example: |- create_policy_request = legal_models.CreatePolicyRequest.create(...) 'CreatePolicyResponse@py.legal.mod': id: 'CreatePolicyResponse@py.legal.mod' name: 'CreatePolicyResponse' type: 'model' fields: 'country_code': type: 'str' required: true 'id_': type: 'str' required: true 'is_default_selection': type: 'bool' required: true 'is_mandatory': type: 'bool' required: true 'policy_name': type: 'str' required: true 'should_notify_on_update': type: 'bool' required: true 'countries': type: 'List[str]' required: false 'country_group_name': type: 'str' required: false 'country_type': type: 'str' required: false 'created_at': type: 'str' required: false 'description': type: 'str' required: false 'policy_versions': type: 'List[PolicyVersionObject]' required: false 'readable_id': type: 'str' required: false 'updated_at': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/create_policy_response.py' example: |- create_policy_response = legal_models.CreatePolicyResponse.create(...) 'CreatePolicyVersionRequest@py.legal.mod': id: 'CreatePolicyVersionRequest@py.legal.mod' name: 'CreatePolicyVersionRequest' type: 'model' fields: 'description': type: 'str' required: false 'display_version': type: 'str' required: false 'is_committed': type: 'bool' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/create_policy_version_request.py' example: |- create_policy_version_request = legal_models.CreatePolicyVersionRequest.create(...) 'CreatePolicyVersionResponse@py.legal.mod': id: 'CreatePolicyVersionResponse@py.legal.mod' name: 'CreatePolicyVersionResponse' type: 'model' fields: 'id_': type: 'str' required: true 'base_policy_id': type: 'str' required: false 'created_at': type: 'str' required: false 'description': type: 'str' required: false 'display_version': type: 'str' required: false 'is_committed': type: 'bool' required: false 'updated_at': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/create_policy_version_response.py' example: |- create_policy_version_response = legal_models.CreatePolicyVersionResponse.create(...) 'DownloadExportedAgreementsInCSVResponse@py.legal.mod': id: 'DownloadExportedAgreementsInCSVResponse@py.legal.mod' name: 'DownloadExportedAgreementsInCSVResponse' type: 'model' fields: 'done': type: 'bool' required: true description: |- Flag indicating whether the export process has been completed. 'download_url': type: 'str' required: false description: |- Download url for CSV file, only available once the export process has been completed. imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/download_exported_agreements_in_csv_response.py' example: |- download_exported_agreements_in_csv_response = legal_models.DownloadExportedAgreementsInCSVResponse.create(...) 'ErrorEntity@py.legal.mod': id: 'ErrorEntity@py.legal.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.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/error_entity.py' example: |- error_entity = legal_models.ErrorEntity.create(...) 'FieldValidationError@py.legal.mod': id: 'FieldValidationError@py.legal.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.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/field_validation_error.py' example: |- field_validation_error = legal_models.FieldValidationError.create(...) 'InitiateExportAgreementsToCSVResponse@py.legal.mod': id: 'InitiateExportAgreementsToCSVResponse@py.legal.mod' name: 'InitiateExportAgreementsToCSVResponse' type: 'model' fields: 'export_id': type: 'str' required: true description: |- Export Id is a combination of request timestamp, start time and end time. 'processing': type: 'bool' required: true description: |- Processing the export imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/initiate_export_agreements_to_csv_response.py' example: |- initiate_export_agreements_to_csv_response = legal_models.InitiateExportAgreementsToCSVResponse.create(...) 'LegalReadinessStatusResponse@py.legal.mod': id: 'LegalReadinessStatusResponse@py.legal.mod' name: 'LegalReadinessStatusResponse' type: 'model' fields: 'is_ready': type: 'bool' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/legal_readiness_status_response.py' example: |- legal_readiness_status_response = legal_models.LegalReadinessStatusResponse.create(...) 'LocalizedPolicyVersionObject@py.legal.mod': id: 'LocalizedPolicyVersionObject@py.legal.mod' name: 'LocalizedPolicyVersionObject' type: 'model' fields: 'id_': type: 'str' required: true 'is_default_selection': type: 'bool' required: true 'locale_code': type: 'str' required: true 'attachment_checksum': type: 'str' required: false 'attachment_location': type: 'str' required: false 'attachment_version_identifier': type: 'str' required: false 'content_type': type: 'str' required: false 'created_at': type: 'str' required: false 'description': type: 'str' required: false 'published_date': type: 'str' required: false 'status': type: 'str' required: false 'updated_at': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/localized_policy_version_object.py' example: |- localized_policy_version_object = legal_models.LocalizedPolicyVersionObject.create(...) 'PagedRetrieveUserAcceptedAgreementResponse@py.legal.mod': id: 'PagedRetrieveUserAcceptedAgreementResponse@py.legal.mod' name: 'PagedRetrieveUserAcceptedAgreementResponse' type: 'model' fields: 'data': type: 'List[RetrieveUserAcceptedAgreementResponse]' required: false 'paging': type: 'Paging' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/paged_retrieve_user_accepted_agreement_response.py' example: |- paged_retrieve_user_accepted_agreement_response = legal_models.PagedRetrieveUserAcceptedAgreementResponse.create(...) 'Paging@py.legal.mod': id: 'Paging@py.legal.mod' name: 'Paging' type: 'model' fields: 'next_': type: 'str' required: false 'previous': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/paging.py' example: |- paging = legal_models.Paging.create(...) 'Permission@py.legal.mod': id: 'Permission@py.legal.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.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/permission.py' example: |- permission = legal_models.Permission.create(...) 'PolicyObject@py.legal.mod': id: 'PolicyObject@py.legal.mod' name: 'PolicyObject' type: 'model' fields: 'country_code': type: 'str' required: true 'id_': type: 'str' required: true 'is_default_opted': type: 'bool' required: true 'is_default_selection': type: 'bool' required: true 'is_mandatory': type: 'bool' required: true 'policy_name': type: 'str' required: true 'should_notify_on_update': type: 'bool' required: true 'countries': type: 'List[str]' required: false 'country_group_code': type: 'str' required: false 'country_group_name': type: 'str' required: false 'country_type': type: 'str' required: false 'created_at': type: 'str' required: false 'description': type: 'str' required: false 'readable_id': type: 'str' required: false 'updated_at': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/policy_object.py' example: |- policy_object = legal_models.PolicyObject.create(...) 'PolicyVersionObject@py.legal.mod': id: 'PolicyVersionObject@py.legal.mod' name: 'PolicyVersionObject' type: 'model' fields: 'display_version': type: 'str' required: true 'id_': type: 'str' required: true 'is_committed': type: 'bool' required: true 'is_in_effect': type: 'bool' required: true 'created_at': type: 'str' required: false 'description': type: 'str' required: false 'published_date': type: 'str' required: false 'status': type: 'str' required: false 'updated_at': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/policy_version_object.py' example: |- policy_version_object = legal_models.PolicyVersionObject.create(...) 'PolicyVersionWithLocalizedVersionObject@py.legal.mod': id: 'PolicyVersionWithLocalizedVersionObject@py.legal.mod' name: 'PolicyVersionWithLocalizedVersionObject' type: 'model' fields: 'display_version': type: 'str' required: true 'id_': type: 'str' required: true 'is_committed': type: 'bool' required: true 'is_in_effect': type: 'bool' required: true 'created_at': type: 'str' required: false 'description': type: 'str' required: false 'localized_policy_versions': type: 'List[LocalizedPolicyVersionObject]' required: false 'published_date': type: 'str' required: false 'status': type: 'str' required: false 'updated_at': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/policy_version_with_localized_version_object.py' example: |- policy_version_with_localized_version_object = legal_models.PolicyVersionWithLocalizedVersionObject.create(...) 'RetrieveAcceptedAgreementResponse@py.legal.mod': id: 'RetrieveAcceptedAgreementResponse@py.legal.mod' name: 'RetrieveAcceptedAgreementResponse' type: 'model' fields: 'id_': type: 'str' required: true 'country_code': type: 'str' required: false 'country_group_name': type: 'str' required: false 'country_type': type: 'str' required: false 'created_at': type: 'str' required: false 'description': type: 'str' required: false 'display_version': type: 'str' required: false 'is_accepted': type: 'bool' required: false 'localized_policy_version': type: 'LocalizedPolicyVersionObject' required: false 'namespace': type: 'str' required: false 'policy_id': type: 'str' required: false 'policy_name': type: 'str' required: false 'policy_type': type: 'str' required: false 'signing_date': type: 'str' required: false 'tags': type: 'List[str]' required: false 'updated_at': 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.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/retrieve_accepted_agreement_response.py' example: |- retrieve_accepted_agreement_response = legal_models.RetrieveAcceptedAgreementResponse.create(...) 'RetrieveBasePolicyResponse@py.legal.mod': id: 'RetrieveBasePolicyResponse@py.legal.mod' name: 'RetrieveBasePolicyResponse' type: 'model' fields: 'base_policy_name': type: 'str' required: true 'id_': type: 'str' required: true 'namespace': type: 'str' required: true 'affected_client_ids': type: 'List[str]' required: false 'created_at': type: 'str' required: false 'description': type: 'str' required: false 'is_hidden': type: 'bool' required: false description: |- active status of this policy, it will affect user's eligibility status check 'is_hidden_public': type: 'bool' required: false description: |- hide the policy from public(e.g. legal website), it will NOT affect user's eligibility status check 'policies': type: 'List[PolicyObject]' required: false 'policy_type_id': type: 'str' required: false 'policy_type_name': type: 'str' required: false 'tags': type: 'List[str]' required: false 'updated_at': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/retrieve_base_policy_response.py' example: |- retrieve_base_policy_response = legal_models.RetrieveBasePolicyResponse.create(...) 'RetrieveLocalizedPolicyVersionPublicResponse@py.legal.mod': id: 'RetrieveLocalizedPolicyVersionPublicResponse@py.legal.mod' name: 'RetrieveLocalizedPolicyVersionPublicResponse' type: 'model' fields: 'id_': type: 'str' required: true 'locale_code': type: 'str' required: true 'namespace': type: 'str' required: true 'policy': type: 'PolicyObject' required: true 'policy_version': type: 'PolicyVersionObject' required: true 'attachment_checksum': type: 'str' required: false 'attachment_location': type: 'str' required: false 'attachment_version_identifier': type: 'str' required: false 'base_policy_id': type: 'str' required: false 'base_urls': type: 'List[str]' required: false 'content_type': type: 'str' required: false 'created_at': type: 'str' required: false 'description': type: 'str' required: false 'is_hidden': type: 'bool' required: false 'tags': type: 'List[str]' required: false 'updated_at': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/retrieve_localized_policy_version_public_response.py' example: |- retrieve_localized_policy_version_public_response = legal_models.RetrieveLocalizedPolicyVersionPublicResponse.create(...) 'RetrieveLocalizedPolicyVersionResponse@py.legal.mod': id: 'RetrieveLocalizedPolicyVersionResponse@py.legal.mod' name: 'RetrieveLocalizedPolicyVersionResponse' type: 'model' fields: 'id_': type: 'str' required: true 'locale_code': type: 'str' required: true 'policy_version': type: 'PolicyVersionObject' required: true 'attachment_checksum': type: 'str' required: false 'attachment_location': type: 'str' required: false 'attachment_version_identifier': type: 'str' required: false 'base_urls': type: 'List[str]' required: false 'content_type': type: 'str' required: false 'created_at': type: 'str' required: false 'description': type: 'str' required: false 'policy': type: 'PolicyObject' required: false 'updated_at': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/retrieve_localized_policy_version_response.py' example: |- retrieve_localized_policy_version_response = legal_models.RetrieveLocalizedPolicyVersionResponse.create(...) 'RetrievePoliciesFromBasePolicyResponse@py.legal.mod': id: 'RetrievePoliciesFromBasePolicyResponse@py.legal.mod' name: 'RetrievePoliciesFromBasePolicyResponse' type: 'model' fields: 'country_code': type: 'str' required: true 'id_': type: 'str' required: true 'policy_name': type: 'str' required: true 'active_version': type: 'str' required: false 'countries': type: 'List[str]' required: false 'country_group_name': type: 'str' required: false 'country_type': type: 'str' required: false 'created_at': type: 'str' required: false 'description': type: 'str' required: false 'is_active': type: 'List[str]' required: false 'last_published': type: 'str' required: false 'policy_versions': type: 'List[PolicyVersionObject]' required: false 'updated_at': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/retrieve_policies_from_base_policy_response.py' example: |- retrieve_policies_from_base_policy_response = legal_models.RetrievePoliciesFromBasePolicyResponse.create(...) 'RetrievePolicyPublicResponse@py.legal.mod': id: 'RetrievePolicyPublicResponse@py.legal.mod' name: 'RetrievePolicyPublicResponse' type: 'model' fields: 'base_policy_id': type: 'str' required: true 'country_code': type: 'str' required: true 'id_': type: 'str' required: true 'is_default_opted': type: 'bool' required: true 'is_default_selection': type: 'bool' required: true 'is_mandatory': type: 'bool' required: true 'namespace': type: 'str' required: true 'policy_name': type: 'str' required: true 'policy_type': type: 'str' required: true 'should_notify_on_update': type: 'bool' required: true 'base_urls': type: 'List[str]' required: false 'country_group_code': type: 'str' required: false 'created_at': type: 'str' required: false 'description': type: 'str' required: false 'policy_versions': type: 'List[PolicyVersionWithLocalizedVersionObject]' required: false 'readable_id': type: 'str' required: false 'tags': type: 'List[str]' required: false 'updated_at': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/retrieve_policy_public_response.py' example: |- retrieve_policy_public_response = legal_models.RetrievePolicyPublicResponse.create(...) 'RetrievePolicyResponse@py.legal.mod': id: 'RetrievePolicyResponse@py.legal.mod' name: 'RetrievePolicyResponse' type: 'model' fields: 'country_code': type: 'str' required: true 'id_': type: 'str' required: true 'is_default_opted': type: 'bool' required: true 'is_default_selection': type: 'bool' required: true 'is_mandatory': type: 'bool' required: true 'policy_name': type: 'str' required: true 'should_notify_on_update': type: 'bool' required: true 'countries': type: 'List[str]' required: false 'country_group_code': type: 'str' required: false 'country_group_name': type: 'str' required: false 'country_type': type: 'str' required: false 'created_at': type: 'str' required: false 'description': type: 'str' required: false 'policy_versions': type: 'List[PolicyVersionObject]' required: false 'readable_id': type: 'str' required: false 'updated_at': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/retrieve_policy_response.py' example: |- retrieve_policy_response = legal_models.RetrievePolicyResponse.create(...) 'RetrievePolicyTypeResponse@py.legal.mod': id: 'RetrievePolicyTypeResponse@py.legal.mod' name: 'RetrievePolicyTypeResponse' type: 'model' fields: 'id_': type: 'str' required: true 'is_need_document': type: 'bool' required: true 'policy_type_name': type: 'str' required: true 'created_at': type: 'str' required: false 'description': type: 'str' required: false 'updated_at': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/retrieve_policy_type_response.py' example: |- retrieve_policy_type_response = legal_models.RetrievePolicyTypeResponse.create(...) 'RetrievePolicyVersionResponse@py.legal.mod': id: 'RetrievePolicyVersionResponse@py.legal.mod' name: 'RetrievePolicyVersionResponse' type: 'model' fields: 'display_version': type: 'str' required: true 'id_': type: 'str' required: true 'is_committed': type: 'bool' required: true 'is_in_effect': type: 'bool' required: true 'base_policy_id': type: 'str' required: false 'created_at': type: 'str' required: false 'description': type: 'str' required: false 'localized_policy_versions': type: 'List[LocalizedPolicyVersionObject]' required: false 'policy_id': type: 'str' required: false 'published_date': type: 'str' required: false 'status': type: 'str' required: false 'updated_at': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/retrieve_policy_version_response.py' example: |- retrieve_policy_version_response = legal_models.RetrievePolicyVersionResponse.create(...) 'RetrieveSimplePolicyPublicResponseV2@py.legal.mod': id: 'RetrieveSimplePolicyPublicResponseV2@py.legal.mod' name: 'RetrieveSimplePolicyPublicResponseV2' type: 'model' fields: 'base_policy_id': type: 'str' required: true 'country_code': type: 'str' required: true 'id_': type: 'str' required: true 'is_default_selection': type: 'bool' required: true 'is_mandatory': type: 'bool' required: true 'namespace': type: 'str' required: true 'policy_name': type: 'str' required: true 'policy_type': type: 'str' required: true 'country_group_code': type: 'str' required: false 'created_at': type: 'str' required: false 'description': type: 'str' required: false 'policy_versions': type: 'List[SimplePolicyVersionWithLocalizedVersionObject]' required: false 'tags': type: 'List[str]' required: false 'updated_at': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/retrieve_simple_policy_public_response_v2.py' example: |- retrieve_simple_policy_public_response_v2 = legal_models.RetrieveSimplePolicyPublicResponseV2.create(...) 'RetrieveUserAcceptedAgreementResponse@py.legal.mod': id: 'RetrieveUserAcceptedAgreementResponse@py.legal.mod' name: 'RetrieveUserAcceptedAgreementResponse' type: 'model' fields: 'id_': type: 'str' required: true 'created_at': type: 'str' required: false 'display_name': type: 'str' required: false 'email': type: 'str' required: false 'is_accepted': type: 'bool' required: false 'localized_policy_version': type: 'LocalizedPolicyVersionObject' required: false 'namespace': type: 'str' required: false 'policy_name': type: 'str' required: false 'policy_type': type: 'str' required: false 'publisher_user_id': type: 'str' required: false 'signing_date': type: 'str' required: false 'updated_at': type: 'str' required: false 'user_id': type: 'str' required: false 'username': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/retrieve_user_accepted_agreement_response.py' example: |- retrieve_user_accepted_agreement_response = legal_models.RetrieveUserAcceptedAgreementResponse.create(...) 'RetrieveUserEligibilitiesIndirectResponse@py.legal.mod': id: 'RetrieveUserEligibilitiesIndirectResponse@py.legal.mod' name: 'RetrieveUserEligibilitiesIndirectResponse' type: 'model' fields: 'is_comply': type: 'bool' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/retrieve_user_eligibilities_indirect_response.py' example: |- retrieve_user_eligibilities_indirect_response = legal_models.RetrieveUserEligibilitiesIndirectResponse.create(...) 'RetrieveUserEligibilitiesResponse@py.legal.mod': id: 'RetrieveUserEligibilitiesResponse@py.legal.mod' name: 'RetrieveUserEligibilitiesResponse' type: 'model' fields: 'country_code': type: 'str' required: true 'is_accepted': type: 'bool' required: true 'is_mandatory': type: 'bool' required: true 'namespace': type: 'str' required: true 'policy_id': type: 'str' required: true 'policy_name': type: 'str' required: true 'policy_type': type: 'str' required: true 'base_urls': type: 'List[str]' required: false 'country_group_code': type: 'str' required: false 'description': type: 'str' required: false 'is_hidden_public': type: 'bool' required: false description: |- hide the policy from public(e.g. legal website), it will NOT affect user's eligibility status check 'policy_versions': type: 'List[PolicyVersionWithLocalizedVersionObject]' required: false 'readable_id': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/retrieve_user_eligibilities_response.py' example: |- retrieve_user_eligibilities_response = legal_models.RetrieveUserEligibilitiesResponse.create(...) 'RetrieveUserInfoCacheStatusResponse@py.legal.mod': id: 'RetrieveUserInfoCacheStatusResponse@py.legal.mod' name: 'RetrieveUserInfoCacheStatusResponse' type: 'model' fields: 'last_updated_at': type: 'str' required: true 'namespace': type: 'str' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/retrieve_user_info_cache_status_response.py' example: |- retrieve_user_info_cache_status_response = legal_models.RetrieveUserInfoCacheStatusResponse.create(...) 'SimpleLocalizedPolicyVersionObject@py.legal.mod': id: 'SimpleLocalizedPolicyVersionObject@py.legal.mod' name: 'SimpleLocalizedPolicyVersionObject' type: 'model' fields: 'id_': type: 'str' required: true 'is_default_selection': type: 'bool' required: true 'locale_code': type: 'str' required: true 'created_at': type: 'str' required: false 'description': type: 'str' required: false 'published_date': type: 'str' required: false 'status': type: 'str' required: false 'updated_at': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/simple_localized_policy_version_object.py' example: |- simple_localized_policy_version_object = legal_models.SimpleLocalizedPolicyVersionObject.create(...) 'SimplePolicyVersionWithLocalizedVersionObject@py.legal.mod': id: 'SimplePolicyVersionWithLocalizedVersionObject@py.legal.mod' name: 'SimplePolicyVersionWithLocalizedVersionObject' type: 'model' fields: 'id_': type: 'str' required: true 'created_at': type: 'str' required: false 'description': type: 'str' required: false 'localized_policy_versions': type: 'List[SimpleLocalizedPolicyVersionObject]' required: false 'published_date': type: 'str' required: false 'status': type: 'str' required: false 'updated_at': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/simple_policy_version_with_localized_version_object.py' example: |- simple_policy_version_with_localized_version_object = legal_models.SimplePolicyVersionWithLocalizedVersionObject.create(...) 'UpdateBasePolicyRequest@py.legal.mod': id: 'UpdateBasePolicyRequest@py.legal.mod' name: 'UpdateBasePolicyRequest' type: 'model' fields: 'affected_client_ids': type: 'List[str]' required: false 'affected_countries': type: 'List[str]' required: false 'base_policy_name': type: 'str' required: false 'country_group_name': type: 'str' required: false 'country_type': type: 'Union[str, CountryTypeEnum]' required: false description: |- country type, only accept COUNTRY or COUNTRY_GROUP 'description': type: 'str' required: false 'is_hidden': type: 'bool' required: false description: |- active status of this policy, it will affect user's eligibility status check 'is_hidden_public': type: 'bool' required: false description: |- hide the policy from public(e.g. legal website), it will NOT affect user's eligibility status check 'namespace': type: 'str' required: false 'tags': type: 'List[str]' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/update_base_policy_request.py' example: |- update_base_policy_request = legal_models.UpdateBasePolicyRequest.create(...) 'UpdateBasePolicyRequestV2@py.legal.mod': id: 'UpdateBasePolicyRequestV2@py.legal.mod' name: 'UpdateBasePolicyRequestV2' type: 'model' fields: 'affected_client_ids': type: 'List[str]' required: false 'affected_countries': type: 'List[str]' required: false 'base_policy_name': type: 'str' required: false 'country_group_name': type: 'str' required: false 'country_type': type: 'Union[str, CountryTypeEnum]' required: false description: |- country type, only accept COUNTRY or COUNTRY_GROUP 'description': type: 'str' required: false 'is_hidden': type: 'bool' required: false description: |- active status of this policy, it will affect user's eligibility status check 'is_hidden_public': type: 'bool' required: false description: |- hide the policy from public(e.g. legal website), it will NOT affect user's eligibility status check 'tags': type: 'List[str]' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/update_base_policy_request_v2.py' example: |- update_base_policy_request_v2 = legal_models.UpdateBasePolicyRequestV2.create(...) 'UpdateBasePolicyResponse@py.legal.mod': id: 'UpdateBasePolicyResponse@py.legal.mod' name: 'UpdateBasePolicyResponse' type: 'model' fields: 'id_': type: 'str' required: true 'affected_client_ids': type: 'List[str]' required: false 'affected_countries': type: 'List[str]' required: false 'created_at': type: 'str' required: false 'description': type: 'str' required: false 'global_policy_name': type: 'str' required: false 'is_hidden': type: 'bool' required: false description: |- active status of this policy, it will affect user's eligibility status check 'is_hidden_public': type: 'bool' required: false description: |- hide the policy from public(e.g. legal website), it will NOT affect user's eligibility status check 'namespace': type: 'str' required: false 'policy_id': type: 'str' required: false 'tags': type: 'List[str]' required: false 'type_id': type: 'str' required: false 'updated_at': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/update_base_policy_response.py' example: |- update_base_policy_response = legal_models.UpdateBasePolicyResponse.create(...) 'UpdateLocalizedPolicyVersionRequest@py.legal.mod': id: 'UpdateLocalizedPolicyVersionRequest@py.legal.mod' name: 'UpdateLocalizedPolicyVersionRequest' type: 'model' fields: 'attachment_checksum': type: 'str' required: false 'attachment_location': type: 'str' required: false 'attachment_version_identifier': type: 'str' required: false 'content_type': type: 'str' required: false 'description': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/update_localized_policy_version_request.py' example: |- update_localized_policy_version_request = legal_models.UpdateLocalizedPolicyVersionRequest.create(...) 'UpdateLocalizedPolicyVersionResponse@py.legal.mod': id: 'UpdateLocalizedPolicyVersionResponse@py.legal.mod' name: 'UpdateLocalizedPolicyVersionResponse' type: 'model' fields: 'id_': type: 'str' required: true 'attachment_checksum': type: 'str' required: false 'attachment_location': type: 'str' required: false 'attachment_version_identifier': type: 'str' required: false 'content_type': type: 'str' required: false 'created_at': type: 'str' required: false 'description': type: 'str' required: false 'locale_code': type: 'str' required: false 'updated_at': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/update_localized_policy_version_response.py' example: |- update_localized_policy_version_response = legal_models.UpdateLocalizedPolicyVersionResponse.create(...) 'UpdatePolicyRequest@py.legal.mod': id: 'UpdatePolicyRequest@py.legal.mod' name: 'UpdatePolicyRequest' type: 'model' fields: 'is_default_opted': type: 'bool' required: true 'is_mandatory': type: 'bool' required: true 'policy_name': type: 'str' required: true 'should_notify_on_update': type: 'bool' required: true 'countries': type: 'List[str]' required: false 'country_group_name': type: 'str' required: false 'description': type: 'str' required: false 'readable_id': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/update_policy_request.py' example: |- update_policy_request = legal_models.UpdatePolicyRequest.create(...) 'UpdatePolicyVersionRequest@py.legal.mod': id: 'UpdatePolicyVersionRequest@py.legal.mod' name: 'UpdatePolicyVersionRequest' type: 'model' fields: 'description': type: 'str' required: true 'display_version': type: 'str' required: true 'is_committed': type: 'bool' required: true imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/update_policy_version_request.py' example: |- update_policy_version_request = legal_models.UpdatePolicyVersionRequest.create(...) 'UpdatePolicyVersionResponse@py.legal.mod': id: 'UpdatePolicyVersionResponse@py.legal.mod' name: 'UpdatePolicyVersionResponse' type: 'model' fields: 'id_': type: 'str' required: true 'base_policy_id': type: 'str' required: false 'created_at': type: 'str' required: false 'description': type: 'str' required: false 'display_version': type: 'str' required: false 'is_committed': type: 'bool' required: false 'published_date': type: 'str' required: false 'status': type: 'str' required: false 'updated_at': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/update_policy_version_response.py' example: |- update_policy_version_response = legal_models.UpdatePolicyVersionResponse.create(...) 'UploadLocalizedPolicyVersionAttachmentResponse@py.legal.mod': id: 'UploadLocalizedPolicyVersionAttachmentResponse@py.legal.mod' name: 'UploadLocalizedPolicyVersionAttachmentResponse' type: 'model' fields: 'attachment_checksum': type: 'str' required: false 'attachment_location': type: 'str' required: false 'attachment_upload_url': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/upload_localized_policy_version_attachment_response.py' example: |- upload_localized_policy_version_attachment_response = legal_models.UploadLocalizedPolicyVersionAttachmentResponse.create(...) 'UploadPolicyVersionAttachmentRequest@py.legal.mod': id: 'UploadPolicyVersionAttachmentRequest@py.legal.mod' name: 'UploadPolicyVersionAttachmentRequest' type: 'model' fields: 'content_md5': type: 'str' required: false 'content_type': type: 'str' required: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/upload_policy_version_attachment_request.py' example: |- upload_policy_version_attachment_request = legal_models.UploadPolicyVersionAttachmentRequest.create(...) 'UserAgreementsResponse@py.legal.mod': id: 'UserAgreementsResponse@py.legal.mod' name: 'UserAgreementsResponse' type: 'model' description: |- A DTO object for user agreements response fields: 'agreements': type: 'List[RetrieveAcceptedAgreementResponse]' required: false description: |- agreement records 'user_id': type: 'str' required: false description: |- user id imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/user_agreements_response.py' example: |- user_agreements_response = legal_models.UserAgreementsResponse.create(...) 'UsersAgreementsRequest@py.legal.mod': id: 'UsersAgreementsRequest@py.legal.mod' name: 'UsersAgreementsRequest' type: 'model' description: |- A DTO object for retrieving agreements of multi users fields: 'user_ids': type: 'List[str]' required: true description: |- user ids, min size: 1, max size: 100 'current_published_only': type: 'bool' required: false description: |- if true, the result will only include the status of current published policies, default: false imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/users_agreements_request.py' example: |- users_agreements_request = legal_models.UsersAgreementsRequest.create(...) 'ValidationErrorEntity@py.legal.mod': id: 'ValidationErrorEntity@py.legal.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.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/models/validation_error_entity.py' example: |- validation_error_entity = legal_models.ValidationErrorEntity.create(...) # endregion models # region functions 'accept_versioned_policy@py.legal.fun': id: 'accept_versioned_policy@py.legal.fun' name: 'accept_versioned_policy' type: 'function' description: |- Accepts a legal policy version. Supply with localized version policy id to accept an agreement arguments: 'localized_policy_version_id': type: 'str' required: true description: |- Localized Policy Version Id return_type: 'Tuple[Union[None, Optional[str]], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/agreement/accept_versioned_policy.py' example: |- result, error = legal.accept_versioned_policy(...) if error: # handle_error(error) tags: - 'accept' - 'agreement' - 'policy' - 'versioned' 'admin_retrieve_eligibilities@py.legal.fun': id: 'admin_retrieve_eligibilities@py.legal.fun' name: 'admin_retrieve_eligibilities' type: 'function' description: |- Retrieve the active policies and its conformance status by user. This process only supports cross-namespace checking between game namespace and publisher namespace , that means if the active policy already accepted by the same user in publisher namespace, then it will also be considered as eligible in non-publisher namespace. arguments: 'client_id': type: 'str' required: true description: |- Client Id 'country_code': type: 'str' required: true description: |- Country Code 'namespace': type: 'str' required: true description: |- Namespace 'publisher_user_id': type: 'Optional[str]' required: false description: |- Publisher user Id 'user_id': type: 'str' required: true description: |- User Id return_type: 'Tuple[Union[None, RetrieveUserEligibilitiesIndirectResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/admin_user_eligibilities/admin_retrieve_eligibilities.py' example: |- result, error = legal.admin_retrieve_eligibilities(...) if error: # handle_error(error) tags: - 'admin' - 'eligibilities' - 'retrieve' - 'user' permissions: - 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:LEGAL [READ]' 'anonymize_user_agreement@py.legal.fun': id: 'anonymize_user_agreement@py.legal.fun' name: 'anonymize_user_agreement' type: 'function' description: |- This API will anonymize agreement record for specified user. arguments: 'user_id': type: 'str' required: true description: |- User Id return_type: 'Tuple[None, 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/anonymization/anonymize_user_agreement.py' example: |- result, error = legal.anonymize_user_agreement(...) if error: # handle_error(error) tags: - 'agreement' - 'anonymization' - 'anonymize' - 'user' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [DELETE]' 'bulk_accept_versioned_policy@py.legal.fun': id: 'bulk_accept_versioned_policy@py.legal.fun' name: 'bulk_accept_versioned_policy' type: 'function' description: |- Accepts many legal policy versions all at once. Supply with localized version policy id to accept an agreement. arguments: 'body': type: 'Optional[List[AcceptAgreementRequest]]' required: false return_type: 'Tuple[Union[None, AcceptAgreementResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/agreement/bulk_accept_versioned_policy.py' example: |- result, error = legal.bulk_accept_versioned_policy(...) if error: # handle_error(error) tags: - 'accept' - 'agreement' - 'bulk' - 'policy' - 'versioned' 'change_preference_consent@py.legal.fun': id: 'change_preference_consent@py.legal.fun' name: 'change_preference_consent' type: 'function' description: |- This API will Update Preference Consent arguments: 'body': type: 'Optional[List[AcceptAgreementRequest]]' required: false 'namespace': type: 'str' required: true description: |- namespace 'user_id': type: 'str' required: true description: |- User Id return_type: 'Tuple[Union[None, HttpResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/agreement/change_preference_consent.py' example: |- result, error = legal.change_preference_consent(...) if error: # handle_error(error) tags: - 'agreement' - 'change' - 'consent' - 'preference' permissions: - 'ADMIN:NAMESPACE:{namespace}:LEGAL [UPDATE]' 'check_readiness@py.legal.fun': id: 'check_readiness@py.legal.fun' name: 'check_readiness' type: 'function' description: |- Readiness status defined as at least one legal basePolicy is present and having active basePolicy. return_type: 'Tuple[Union[None, LegalReadinessStatusResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/utility/check_readiness.py' example: |- result, error = legal.check_readiness(...) if error: # handle_error(error) tags: - 'check' - 'readiness' - 'utility' permissions: - 'NAMESPACE:{namespace}:LEGAL [READ]' 'create_localized_policy_version@py.legal.fun': id: 'create_localized_policy_version@py.legal.fun' name: 'create_localized_policy_version' type: 'function' description: |- Create a version of a particular country-specific policy. arguments: 'body': type: 'Optional[CreateLocalizedPolicyVersionRequest]' required: false 'namespace': type: 'str' required: true description: |- Namespace 'policy_version_id': type: 'str' required: true description: |- Policy Version Id return_type: 'Tuple[Union[None, CreateLocalizedPolicyVersionResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/localized_policy_versions_with_namespace/create_localized_policy_19e4a3.py' example: |- result, error = legal.create_localized_policy_version(...) if error: # handle_error(error) tags: - 'create' - 'localized' - 'namespace' - 'policy' - 'version' - 'versions' - 'with' permissions: - 'ADMIN:NAMESPACE:{namespace}:LEGAL [CREATE]' 'create_policy@py.legal.fun': id: 'create_policy@py.legal.fun' name: 'create_policy' type: 'function' description: |- Create a legal policy. Note: * countryType field only accept COUNTRY or COUNTRY_GROUP. * COUNTRY_GROUP countryType requires the countryGroupName and affectedCountries fields to be provided. * policy with COUNTRY_GROUP type include multiple countries and apply the same policy across the entire list of countries arguments: 'body': type: 'Optional[CreateBasePolicyRequestV2]' required: false 'namespace': type: 'str' required: true description: |- Namespace return_type: 'Tuple[Union[None, CreateBasePolicyResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/base_legal_policies_with_namespace/create_policy.py' example: |- result, error = legal.create_policy(...) if error: # handle_error(error) tags: - 'base' - 'create' - 'legal' - 'namespace' - 'policies' - 'policy' - 'with' permissions: - 'ADMIN:NAMESPACE:{namespace}:LEGAL [CREATE]' 'create_policy_under_base_policy@py.legal.fun': id: 'create_policy_under_base_policy@py.legal.fun' name: 'create_policy_under_base_policy' type: 'function' description: |- Create policy under base policy. Note: * countryType field only accept COUNTRY or COUNTRY_GROUP. * COUNTRY_GROUP policy requires the countryGroupName and countries fields to be provided. * policy with COUNTRY_GROUP type include multiple countries and apply the same policy across the entire list of countries arguments: 'base_policy_id': type: 'str' required: true description: |- BasePolicy Id 'body': type: 'Optional[CreatePolicyRequest]' required: false 'namespace': type: 'str' required: true description: |- Namespace return_type: 'Tuple[Union[None, CreatePolicyResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/base_legal_policies_with_namespace/create_policy_under_bas_c3ecba.py' example: |- result, error = legal.create_policy_under_base_policy(...) if error: # handle_error(error) tags: - 'base' - 'create' - 'legal' - 'namespace' - 'policies' - 'policy' - 'under' - 'with' permissions: - 'ADMIN:NAMESPACE:{namespace}:LEGAL [CREATE]' 'create_policy_version@py.legal.fun': id: 'create_policy_version@py.legal.fun' name: 'create_policy_version' type: 'function' description: |- Create a version of a particular country-specific policy. arguments: 'body': type: 'Optional[CreatePolicyVersionRequest]' required: false 'namespace': type: 'str' required: true description: |- Namespace 'policy_id': type: 'str' required: true description: |- Policy Id return_type: 'Tuple[Union[None, CreatePolicyVersionResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/policy_versions_with_namespace/create_policy_version.py' example: |- result, error = legal.create_policy_version(...) if error: # handle_error(error) tags: - 'create' - 'namespace' - 'policy' - 'version' - 'versions' - 'with' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [CREATE]' 'delete_base_policy@py.legal.fun': id: 'delete_base_policy@py.legal.fun' name: 'delete_base_policy' type: 'function' description: |- Delete base legal policy.Can only be deleted if match these criteria: * Base policy don't have published policy version * Policy version under base policy has never been accepted by any user arguments: 'base_policy_id': type: 'str' required: true description: |- BasePolicy Id 'namespace': type: 'str' required: true description: |- Namespace return_type: 'Tuple[None, 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/base_legal_policies_with_namespace/delete_base_policy.py' example: |- result, error = legal.delete_base_policy(...) if error: # handle_error(error) tags: - 'base' - 'delete' - 'legal' - 'namespace' - 'policies' - 'policy' - 'with' permissions: - 'ADMIN:NAMESPACE:{namespace}:LEGAL [DELETE]' 'delete_localized_policy@py.legal.fun': id: 'delete_localized_policy@py.legal.fun' name: 'delete_localized_policy' type: 'function' description: |- Delete localized version policy. Can only be deleted if match these criteria: * Policy Version that this localized policy version belongs to is not active * Has never been accepted by any user arguments: 'localized_policy_version_id': type: 'str' required: true description: |- Localized Policy Version Id 'namespace': type: 'str' required: true description: |- Namespace return_type: 'Tuple[None, 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/localized_policy_versions_with_namespace/delete_localized_policy.py' example: |- result, error = legal.delete_localized_policy(...) if error: # handle_error(error) tags: - 'delete' - 'localized' - 'namespace' - 'policy' - 'versions' - 'with' permissions: - 'ADMIN:NAMESPACE:{namespace}:LEGAL [DELETE]' 'delete_policy@py.legal.fun': id: 'delete_policy@py.legal.fun' name: 'delete_policy' type: 'function' description: |- Delete policy.Can only be deleted if match these criteria: * Policy is not default policy * Policy version under policy has never been accepted by any user arguments: 'namespace': type: 'str' required: true description: |- Namespace 'policy_id': type: 'str' required: true description: |- Policy Id return_type: 'Tuple[None, 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/policies_with_namespace/delete_policy.py' example: |- result, error = legal.delete_policy(...) if error: # handle_error(error) tags: - 'delete' - 'namespace' - 'policies' - 'policy' - 'with' permissions: - 'ADMIN:NAMESPACE:{namespace}:LEGAL [DELETE]' 'delete_policy_version@py.legal.fun': id: 'delete_policy_version@py.legal.fun' name: 'delete_policy_version' type: 'function' description: |- Delete a policy version from policy.Can only be deleted if match these criteria: * Policy version is not published * Policy version has never been accepted by any user arguments: 'namespace': type: 'str' required: true description: |- Namespace 'policy_version_id': type: 'str' required: true description: |- Policy Version Id return_type: 'Tuple[None, 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/policy_versions_with_namespace/delete_policy_version.py' example: |- result, error = legal.delete_policy_version(...) if error: # handle_error(error) tags: - 'delete' - 'namespace' - 'policy' - 'version' - 'versions' - 'with' permissions: - 'ADMIN:NAMESPACE:{namespace}:LEGAL [DELETE]' 'download_exported_agreements_in_csv@py.legal.fun': id: 'download_exported_agreements_in_csv@py.legal.fun' name: 'download_exported_agreements_in_csv' type: 'function' description: |- This API will check the status of export process. If the export process has been completed, the response body will include the download url. arguments: 'export_id': type: 'str' required: true description: |- Export Id 'namespace': type: 'str' required: true description: |- Namespace return_type: 'Tuple[Union[None, DownloadExportedAgreementsInCSVResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/agreement_with_namespace/download_exported_agree_a56e5b.py' example: |- result, error = legal.download_exported_agreements_in_csv(...) if error: # handle_error(error) tags: - 'agreement' - 'agreements' - 'csv' - 'download' - 'exported' - 'in' - 'namespace' - 'with' permissions: - 'ADMIN:NAMESPACE:{namespace}:LEGAL [READ]' 'get_user_info_status@py.legal.fun': id: 'get_user_info_status@py.legal.fun' name: 'get_user_info_status' type: 'function' description: |- Get user info cache last updated time per namespace. The query parameter namespaces can be a list of namespace separated by comma. If query parameter namespaces is empty, user info cache status for all available namespaces will be returned. arguments: 'namespaces': type: 'Optional[str]' required: false return_type: 'Tuple[Union[None, List[RetrieveUserInfoCacheStatusResponse]], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/user_info/get_user_info_status.py' example: |- result, error = legal.get_user_info_status(...) if error: # handle_error(error) tags: - 'get' - 'info' - 'status' - 'user' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [READ]' 'indirect_bulk_accept_versioned_policy@py.legal.fun': id: 'indirect_bulk_accept_versioned_policy@py.legal.fun' name: 'indirect_bulk_accept_versioned_policy' type: 'function' description: |- Accepts many legal policy versions all at once. Supply with localized version policy id and userId to accept an agreement. arguments: 'body': type: 'Optional[List[AcceptAgreementRequest]]' required: false 'client_id': type: 'str' required: true description: |- Client Id 'country_code': type: 'str' required: true description: |- Country Code 'namespace': type: 'str' required: true description: |- Namespace 'publisher_user_id': type: 'Optional[str]' required: false description: |- Publisher user Id 'user_id': type: 'str' required: true description: |- User Id return_type: 'Tuple[Union[None, AcceptAgreementResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/admin_user_agreement/indirect_bulk_accept_ve_9d5446.py' example: |- result, error = legal.indirect_bulk_accept_versioned_policy(...) if error: # handle_error(error) tags: - 'accept' - 'admin' - 'agreement' - 'bulk' - 'indirect' - 'policy' - 'user' - 'versioned' permissions: - 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:LEGAL [CREATE]' 'indirect_bulk_accept_versioned_policy_v2@py.legal.fun': id: 'indirect_bulk_accept_versioned_policy_v2@py.legal.fun' name: 'indirect_bulk_accept_versioned_policy_v2' type: 'function' description: |- Accepts many legal policy versions all at once. Supply with localized version policy id, version policy id, policy id, userId, namespace, country code and client id to accept an agreement. This endpoint used by APIGateway during new user registration. arguments: 'body': type: 'Optional[List[AcceptAgreementRequest]]' required: false 'client_id': type: 'str' required: true description: |- Client ID 'country_code': type: 'str' required: true description: |- Country Code 'namespace': type: 'str' required: true description: |- namespace 'user_id': type: 'str' required: true description: |- User Id return_type: 'Tuple[Union[None, AcceptAgreementResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/agreement/indirect_bulk_accept_ve_34e753.py' example: |- result, error = legal.indirect_bulk_accept_versioned_policy_v2(...) if error: # handle_error(error) tags: - 'accept' - 'agreement' - 'bulk' - 'indirect' - 'policy' - 'v2' - 'versioned' permissions: - 'NAMESPACE:{namespace}:LEGAL [CREATE]' 'initiate_export_agreements_to_csv@py.legal.fun': id: 'initiate_export_agreements_to_csv@py.legal.fun' name: 'initiate_export_agreements_to_csv' type: 'function' description: |- This API will initiate a worker to export list of users who has accepted a specific policy version into a CSV file. To check the export state after initialize it, use `GET /admin/namespaces/{namespace}/agreements/policy-versions/users/export-csv/download` API. This Initiate API is not allow multiple export worker running for the same namespace, it will return 409 http error if so. arguments: 'end': type: 'Optional[str]' required: false description: |- End time of signed_date to retrieve, will use current time if not specified. Using ISO 8601 format yyyy-MM-dd'T'HH:mm:ss'Z', e.g. 2024-01-01T00:00:00Z 'namespace': type: 'str' required: true description: |- Namespace 'policy_version_id': type: 'str' required: true description: |- Policy Version Id 'start': type: 'str' required: true description: |- Start time of signed_date to retrieve. Using ISO 8601 format yyyy-MM-dd'T'HH:mm:ss'Z', e.g. 2024-01-01T00:00:00Z return_type: 'Tuple[Union[None, InitiateExportAgreementsToCSVResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/agreement_with_namespace/initiate_export_agreeme_d92c31.py' example: |- result, error = legal.initiate_export_agreements_to_csv(...) if error: # handle_error(error) tags: - 'agreement' - 'agreements' - 'csv' - 'export' - 'initiate' - 'namespace' - 'to' - 'with' permissions: - 'ADMIN:NAMESPACE:{namespace}:LEGAL [READ]' 'invalidate_user_info_cache@py.legal.fun': id: 'invalidate_user_info_cache@py.legal.fun' name: 'invalidate_user_info_cache' type: 'function' description: |- Invalidate user info cache in agreement service. arguments: 'namespace': type: 'Optional[str]' required: false description: |- If null or empty, will invalidate all namespaces return_type: 'Tuple[None, 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/user_info/invalidate_user_info_cache.py' example: |- result, error = legal.invalidate_user_info_cache(...) if error: # handle_error(error) tags: - 'cache' - 'info' - 'invalidate' - 'user' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [DELETE]' 'old_create_localized_policy_version@py.legal.fun': id: 'old_create_localized_policy_version@py.legal.fun' name: 'old_create_localized_policy_version' type: 'function' description: |- Create a version of a particular country-specific policy. arguments: 'body': type: 'Optional[CreateLocalizedPolicyVersionRequest]' required: false 'policy_version_id': type: 'str' required: true description: |- Policy Version Id return_type: 'Tuple[Union[None, CreateLocalizedPolicyVersionResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/localized_policy_versions/old_create_localized_po_27ca82.py' example: |- result, error = legal.old_create_localized_policy_version(...) if error: # handle_error(error) tags: - 'create' - 'localized' - 'old' - 'policy' - 'version' - 'versions' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [CREATE]' 'old_create_policy@py.legal.fun': id: 'old_create_policy@py.legal.fun' name: 'old_create_policy' type: 'function' description: |- Create a legal policy. Note: * countryType field only accept COUNTRY or COUNTRY_GROUP. * COUNTRY_GROUP countryType requires the countryGroupName and affectedCountries fields to be provided. * policy with COUNTRY_GROUP type include multiple countries and apply the same policy across the entire list of countries arguments: 'body': type: 'Optional[CreateBasePolicyRequest]' required: false return_type: 'Tuple[Union[None, CreateBasePolicyResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/base_legal_policies/old_create_policy.py' example: |- result, error = legal.old_create_policy(...) if error: # handle_error(error) tags: - 'base' - 'create' - 'legal' - 'old' - 'policies' - 'policy' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [CREATE]' 'old_create_policy_version@py.legal.fun': id: 'old_create_policy_version@py.legal.fun' name: 'old_create_policy_version' type: 'function' description: |- Create a version of a particular country-specific policy. arguments: 'body': type: 'Optional[CreatePolicyVersionRequest]' required: false 'policy_id': type: 'str' required: true description: |- Policy Id return_type: 'Tuple[Union[None, CreatePolicyVersionResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/policy_versions/old_create_policy_version.py' example: |- result, error = legal.old_create_policy_version(...) if error: # handle_error(error) tags: - 'create' - 'old' - 'policy' - 'version' - 'versions' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [CREATE]' 'old_partial_update_policy@py.legal.fun': id: 'old_partial_update_policy@py.legal.fun' name: 'old_partial_update_policy' type: 'function' description: |- Update an existing base policy. Note: * countryType field only accept COUNTRY or COUNTRY_GROUP. * COUNTRY_GROUP countryType requires the countryGroupName and affectedCountries fields to be provided. * policy with COUNTRY_GROUP type include multiple countries and apply the same policy across the entire list of countries arguments: 'base_policy_id': type: 'str' required: true description: |- BasePolicy Id 'body': type: 'Optional[UpdateBasePolicyRequest]' required: false return_type: 'Tuple[Union[None, UpdateBasePolicyResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/base_legal_policies/old_partial_update_policy.py' example: |- result, error = legal.old_partial_update_policy(...) if error: # handle_error(error) tags: - 'base' - 'legal' - 'old' - 'partial' - 'policies' - 'policy' - 'update' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [UPDATE]' 'old_public_retrieve_single_localized_policy_version@py.legal.fun': id: 'old_public_retrieve_single_localized_policy_version@py.legal.fun' name: 'old_public_retrieve_single_localized_policy_version' type: 'function' description: |- Retrieve specific localized policy version including the policy version and base policy version where the localized policy version located. Other detail info: arguments: 'localized_policy_version_id': type: 'str' required: true description: |- Localized Policy Version Id return_type: 'Tuple[Union[None, RetrieveLocalizedPolicyVersionPublicResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/localized_policy_versions/old_public_retrieve_sin_4e7606.py' example: |- result, error = legal.old_public_retrieve_single_localized_policy_version(...) if error: # handle_error(error) tags: - 'localized' - 'old' - 'policy' - 'public' - 'retrieve' - 'single' - 'version' - 'versions' 'old_publish_policy_version@py.legal.fun': id: 'old_publish_policy_version@py.legal.fun' name: 'old_publish_policy_version' type: 'function' description: |- Manually publish a version of a particular country-specific policy. arguments: 'policy_version_id': type: 'str' required: true description: |- Policy Version Id 'should_notify': type: 'Optional[bool]' required: false description: |- Should Notify return_type: 'Tuple[Union[None, HttpResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/policy_versions/old_publish_policy_version.py' example: |- result, error = legal.old_publish_policy_version(...) if error: # handle_error(error) tags: - 'old' - 'policy' - 'publish' - 'version' - 'versions' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [UPDATE]' 'old_request_presigned_url@py.legal.fun': id: 'old_request_presigned_url@py.legal.fun' name: 'old_request_presigned_url' type: 'function' description: |- Request presigned URL for upload attachment for a particular localized version of base policy. arguments: 'body': type: 'Optional[UploadPolicyVersionAttachmentRequest]' required: false 'localized_policy_version_id': type: 'str' required: true description: |- Localized Policy Version Id return_type: 'Tuple[Union[None, UploadLocalizedPolicyVersionAttachmentResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/localized_policy_versions/old_request_presigned_url.py' example: |- result, error = legal.old_request_presigned_url(...) if error: # handle_error(error) tags: - 'localized' - 'old' - 'policy' - 'presigned' - 'request' - 'url' - 'versions' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [CREATE]' 'old_retrieve_accepted_agreements@py.legal.fun': id: 'old_retrieve_accepted_agreements@py.legal.fun' name: 'old_retrieve_accepted_agreements' type: 'function' description: |- This API will return all accepted Legal Agreements for specified user arguments: 'user_id': type: 'str' required: true description: |- User Id return_type: 'Tuple[Union[None, List[RetrieveAcceptedAgreementResponse]], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/agreement/old_retrieve_accepted_a_36c88d.py' example: |- result, error = legal.old_retrieve_accepted_agreements(...) if error: # handle_error(error) tags: - 'accepted' - 'agreement' - 'agreements' - 'old' - 'retrieve' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [READ]' 'old_retrieve_all_policy_types@py.legal.fun': id: 'old_retrieve_all_policy_types@py.legal.fun' name: 'old_retrieve_all_policy_types' type: 'function' description: |- Retrieve all supported policy types. arguments: 'limit': type: 'int' required: true description: |- Limit 'offset': type: 'Optional[int]' required: false description: |- Offset return_type: 'Tuple[Union[None, List[RetrievePolicyTypeResponse]], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/base_legal_policies/old_retrieve_all_policy_types.py' example: |- result, error = legal.old_retrieve_all_policy_types(...) if error: # handle_error(error) tags: - 'all' - 'base' - 'legal' - 'old' - 'policies' - 'policy' - 'retrieve' - 'types' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [READ]' 'old_retrieve_all_users_by_policy_version@py.legal.fun': id: 'old_retrieve_all_users_by_policy_version@py.legal.fun' name: 'old_retrieve_all_users_by_policy_version' type: 'function' description: |- This API will return users who has accepted a specific policy version. arguments: 'keyword': type: 'Optional[str]' required: false description: |- display name or email or username 'limit': type: 'Optional[int]' required: false description: |- limit 'offset': type: 'Optional[int]' required: false description: |- offset 'policy_version_id': type: 'str' required: true return_type: 'Tuple[Union[None, PagedRetrieveUserAcceptedAgreementResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/agreement/old_retrieve_all_users__abe0f3.py' example: |- result, error = legal.old_retrieve_all_users_by_policy_version(...) if error: # handle_error(error) tags: - 'agreement' - 'all' - 'by' - 'old' - 'policy' - 'retrieve' - 'users' - 'version' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [READ]' 'old_retrieve_latest_policies_by_namespace_and_country_public@py.legal.fun': id: 'old_retrieve_latest_policies_by_namespace_and_country_public@py.legal.fun' name: 'old_retrieve_latest_policies_by_namespace_and_country_public' type: 'function' description: |- Retrieve all active latest policies based on a namespace and country. Other detail info: * Leave the policyType empty if you want to be responded with all policy type * Fill the tags if you want to filter the responded policy by tags * Fill the defaultOnEmpty with true if you want to be responded with default country-specific policy if your requested country is not exist * Fill the alwaysIncludeDefault with true if you want to be responded with always include default policy. If there are duplicate policies (default policies and country specific policies with same base policy) it'll include policy with same country code, for example: * Document 1 (default): Region US (default), UA * Document 2 (default): Region US (default) * Document 3 (default): Region US (default) * User: Region UA * Query: alwaysIncludeDefault: true * Response: Document 1 (UA), Document 2 (US), Document 3 (US) arguments: 'always_include_default': type: 'Optional[bool]' required: false description: |- Always include default 'country_code': type: 'str' required: true description: |- Country Code 'default_on_empty': type: 'Optional[bool]' required: false description: |- Default On Empty 'namespace': type: 'str' required: true description: |- Namespace 'policy_type': type: 'Optional[Union[str, OldRetrieveLatestPoliciesByNamespaceAndCountryPublicPolicyTypeEnum]]' required: false description: |- Policy Type 'tags': type: 'Optional[str]' required: false description: |- tags, separate multiple value by commas parameter 'visible_only': type: 'Optional[bool]' required: false return_type: 'Tuple[Union[None, List[RetrievePolicyPublicResponse]], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/policies/old_retrieve_latest_pol_6012f3.py' example: |- result, error = legal.old_retrieve_latest_policies_by_namespace_and_country_public(...) if error: # handle_error(error) tags: - 'and' - 'by' - 'country' - 'latest' - 'namespace' - 'old' - 'policies' - 'public' - 'retrieve' 'old_retrieve_localized_policy_versions@py.legal.fun': id: 'old_retrieve_localized_policy_versions@py.legal.fun' name: 'old_retrieve_localized_policy_versions' type: 'function' description: |- Retrieve versions of a particular country-specific policy. arguments: 'policy_version_id': type: 'str' required: true description: |- Policy Version Id return_type: 'Tuple[Union[None, List[RetrieveLocalizedPolicyVersionResponse]], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/localized_policy_versions/old_retrieve_localized__18cbb5.py' example: |- result, error = legal.old_retrieve_localized_policy_versions(...) if error: # handle_error(error) tags: - 'localized' - 'old' - 'policy' - 'retrieve' - 'versions' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [READ]' 'old_retrieve_policy_country@py.legal.fun': id: 'old_retrieve_policy_country@py.legal.fun' name: 'old_retrieve_policy_country' type: 'function' description: |- Retrieve a Base Legal Policy based on a Particular Country. arguments: 'base_policy_id': type: 'str' required: true description: |- BasePolicy Id 'country_code': type: 'str' required: true description: |- Country Code return_type: 'Tuple[Union[None, RetrievePolicyResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/base_legal_policies/old_retrieve_policy_country.py' example: |- result, error = legal.old_retrieve_policy_country(...) if error: # handle_error(error) tags: - 'base' - 'country' - 'legal' - 'old' - 'policies' - 'policy' - 'retrieve' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [READ]' 'old_retrieve_single_localized_policy_version@py.legal.fun': id: 'old_retrieve_single_localized_policy_version@py.legal.fun' name: 'old_retrieve_single_localized_policy_version' type: 'function' description: |- Retrieve a version of a particular country-specific policy. arguments: 'localized_policy_version_id': type: 'str' required: true description: |- Localized Policy Version Id return_type: 'Tuple[Union[None, RetrieveLocalizedPolicyVersionResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/localized_policy_versions/old_retrieve_single_loc_881bb2.py' example: |- result, error = legal.old_retrieve_single_localized_policy_version(...) if error: # handle_error(error) tags: - 'localized' - 'old' - 'policy' - 'retrieve' - 'single' - 'version' - 'versions' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [READ]' 'old_retrieve_single_policy@py.legal.fun': id: 'old_retrieve_single_policy@py.legal.fun' name: 'old_retrieve_single_policy' type: 'function' description: |- Retrieve a base policy. arguments: 'base_policy_id': type: 'str' required: true description: |- BasePolicy Id return_type: 'Tuple[Union[None, RetrieveBasePolicyResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/base_legal_policies/old_retrieve_single_policy.py' example: |- result, error = legal.old_retrieve_single_policy(...) if error: # handle_error(error) tags: - 'base' - 'legal' - 'old' - 'policies' - 'policy' - 'retrieve' - 'single' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [READ]' 'old_retrieve_single_policy_version@py.legal.fun': id: 'old_retrieve_single_policy_version@py.legal.fun' name: 'old_retrieve_single_policy_version' type: 'function' description: |- Retrieve a version of a particular country specific policy. If version is not provided, the Legal Service will assume caller requesting all versions from country-specific policy. arguments: 'policy_id': type: 'str' required: true description: |- Policy Id 'version_id': type: 'Optional[str]' required: false description: |- Version Id return_type: 'Tuple[Union[None, List[RetrievePolicyVersionResponse]], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/policy_versions/old_retrieve_single_pol_7be633.py' example: |- result, error = legal.old_retrieve_single_policy_version(...) if error: # handle_error(error) tags: - 'old' - 'policy' - 'retrieve' - 'single' - 'version' - 'versions' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [READ]' 'old_set_default_localized_policy@py.legal.fun': id: 'old_set_default_localized_policy@py.legal.fun' name: 'old_set_default_localized_policy' type: 'function' description: |- Update a localized version policy to be the default. arguments: 'localized_policy_version_id': type: 'str' required: true description: |- Localized Policy Version Id return_type: 'Tuple[Union[None, HttpResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/localized_policy_versions/old_set_default_localiz_e3b777.py' example: |- result, error = legal.old_set_default_localized_policy(...) if error: # handle_error(error) tags: - 'default' - 'localized' - 'old' - 'policy' - 'set' - 'versions' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [UPDATE]' 'old_set_default_policy@py.legal.fun': id: 'old_set_default_policy@py.legal.fun' name: 'old_set_default_policy' type: 'function' description: |- Update a policy to be the default. arguments: 'policy_id': type: 'str' required: true description: |- Policy Id return_type: 'Tuple[Union[None, HttpResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/policies/old_set_default_policy.py' example: |- result, error = legal.old_set_default_policy(...) if error: # handle_error(error) tags: - 'default' - 'old' - 'policies' - 'policy' - 'set' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [UPDATE]' 'old_update_localized_policy_version@py.legal.fun': id: 'old_update_localized_policy_version@py.legal.fun' name: 'old_update_localized_policy_version' type: 'function' description: |- Update a version of a particular country-specific policy. arguments: 'body': type: 'Optional[UpdateLocalizedPolicyVersionRequest]' required: false 'localized_policy_version_id': type: 'str' required: true description: |- Localized Policy Version Id return_type: 'Tuple[Union[None, UpdateLocalizedPolicyVersionResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/localized_policy_versions/old_update_localized_po_4765cb.py' example: |- result, error = legal.old_update_localized_policy_version(...) if error: # handle_error(error) tags: - 'localized' - 'old' - 'policy' - 'update' - 'version' - 'versions' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [UPDATE]' 'old_update_policy@py.legal.fun': id: 'old_update_policy@py.legal.fun' name: 'old_update_policy' type: 'function' description: |- Update country-specific and country-group policy. arguments: 'body': type: 'Optional[UpdatePolicyRequest]' required: false 'policy_id': type: 'str' required: true description: |- Policy Id return_type: 'Tuple[Union[None, HttpResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/policies/old_update_policy.py' example: |- result, error = legal.old_update_policy(...) if error: # handle_error(error) tags: - 'old' - 'policies' - 'policy' - 'update' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [UPDATE]' 'old_update_policy_version@py.legal.fun': id: 'old_update_policy_version@py.legal.fun' name: 'old_update_policy_version' type: 'function' description: |- Update a particular policy version. arguments: 'body': type: 'Optional[UpdatePolicyVersionRequest]' required: false 'policy_version_id': type: 'str' required: true description: |- Policy Version Id return_type: 'Tuple[Union[None, UpdatePolicyVersionResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/policy_versions/old_update_policy_version.py' example: |- result, error = legal.old_update_policy_version(...) if error: # handle_error(error) tags: - 'old' - 'policy' - 'update' - 'version' - 'versions' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [UPDATE]' 'partial_update_policy@py.legal.fun': id: 'partial_update_policy@py.legal.fun' name: 'partial_update_policy' type: 'function' description: |- Update an existing base policy. Note: * countryType field only accept COUNTRY or COUNTRY_GROUP. * COUNTRY_GROUP countryType requires the countryGroupName and affectedCountries fields to be provided. * policy with COUNTRY_GROUP type include multiple countries and apply the same policy across the entire list of countries arguments: 'base_policy_id': type: 'str' required: true description: |- BasePolicy Id 'body': type: 'Optional[UpdateBasePolicyRequestV2]' required: false 'namespace': type: 'str' required: true description: |- Namespace return_type: 'Tuple[Union[None, UpdateBasePolicyResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/base_legal_policies_with_namespace/partial_update_policy.py' example: |- result, error = legal.partial_update_policy(...) if error: # handle_error(error) tags: - 'base' - 'legal' - 'namespace' - 'partial' - 'policies' - 'policy' - 'update' - 'with' permissions: - 'ADMIN:NAMESPACE:{namespace}:LEGAL [UPDATE]' 'public_change_preference_consent@py.legal.fun': id: 'public_change_preference_consent@py.legal.fun' name: 'public_change_preference_consent' type: 'function' description: |- Change marketing preference consent. arguments: 'body': type: 'Optional[List[AcceptAgreementRequest]]' required: false return_type: 'Tuple[Union[None, HttpResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/agreement/public_change_preferenc_69bf81.py' example: |- result, error = legal.public_change_preference_consent(...) if error: # handle_error(error) tags: - 'agreement' - 'change' - 'consent' - 'preference' - 'public' 'public_indirect_bulk_accept_versioned_policy@py.legal.fun': id: 'public_indirect_bulk_accept_versioned_policy@py.legal.fun' name: 'public_indirect_bulk_accept_versioned_policy' type: 'function' description: |- Accepts many legal policy versions all at once. Supply with localized version policy id and userId to accept an agreement. This endpoint used by Authentication Service during new user registration. arguments: 'body': type: 'Optional[List[AcceptAgreementRequest]]' required: false 'user_id': type: 'str' required: true description: |- User Id return_type: 'Tuple[Union[None, AcceptAgreementResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/agreement/public_indirect_bulk_ac_42b465.py' example: |- result, error = legal.public_indirect_bulk_accept_versioned_policy(...) if error: # handle_error(error) tags: - 'accept' - 'agreement' - 'bulk' - 'indirect' - 'policy' - 'public' - 'versioned' 'public_retrieve_single_localized_policy_version@py.legal.fun': id: 'public_retrieve_single_localized_policy_version@py.legal.fun' name: 'public_retrieve_single_localized_policy_version' type: 'function' description: |- Retrieve specific localized policy version including the policy version and base policy version where the localized policy version located. Other detail info: arguments: 'localized_policy_version_id': type: 'str' required: true description: |- Localized Policy Version Id 'namespace': type: 'str' required: true description: |- Namespace return_type: 'Tuple[Union[None, RetrieveLocalizedPolicyVersionPublicResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/localized_policy_versions_with_namespace/public_retrieve_single__31c235.py' example: |- result, error = legal.public_retrieve_single_localized_policy_version(...) if error: # handle_error(error) tags: - 'localized' - 'namespace' - 'policy' - 'public' - 'retrieve' - 'single' - 'version' - 'versions' - 'with' 'publish_policy_version@py.legal.fun': id: 'publish_policy_version@py.legal.fun' name: 'publish_policy_version' type: 'function' description: |- Manually publish a version of a particular country-specific policy. arguments: 'namespace': type: 'str' required: true description: |- Namespace 'policy_version_id': type: 'str' required: true description: |- Policy Version Id 'should_notify': type: 'Optional[bool]' required: false description: |- Should Notify return_type: 'Tuple[Union[None, HttpResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/policy_versions_with_namespace/publish_policy_version.py' example: |- result, error = legal.publish_policy_version(...) if error: # handle_error(error) tags: - 'namespace' - 'policy' - 'publish' - 'version' - 'versions' - 'with' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [UPDATE]' 'request_presigned_url@py.legal.fun': id: 'request_presigned_url@py.legal.fun' name: 'request_presigned_url' type: 'function' description: |- Request presigned URL for upload attachment for a particular localized version of base policy. arguments: 'body': type: 'Optional[UploadPolicyVersionAttachmentRequest]' required: false 'localized_policy_version_id': type: 'str' required: true description: |- Localized Policy Version Id 'namespace': type: 'str' required: true description: |- Namespace return_type: 'Tuple[Union[None, UploadLocalizedPolicyVersionAttachmentResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/localized_policy_versions_with_namespace/request_presigned_url.py' example: |- result, error = legal.request_presigned_url(...) if error: # handle_error(error) tags: - 'localized' - 'namespace' - 'policy' - 'presigned' - 'request' - 'url' - 'versions' - 'with' permissions: - 'ADMIN:NAMESPACE:{namespace}:LEGAL [CREATE]' 'retrieve_accepted_agreements@py.legal.fun': id: 'retrieve_accepted_agreements@py.legal.fun' name: 'retrieve_accepted_agreements' type: 'function' description: |- This API will return all accepted Legal Agreements for specified user. arguments: 'exclude_other_namespaces_policies': type: 'Optional[bool]' required: false description: |- If it is true, API will only query the policy in this path namespace 'namespace': type: 'str' required: true description: |- Namespace 'user_id': type: 'str' required: true description: |- User Id return_type: 'Tuple[Union[None, List[RetrieveAcceptedAgreementResponse]], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/agreement_with_namespace/retrieve_accepted_agreements.py' example: |- result, error = legal.retrieve_accepted_agreements(...) if error: # handle_error(error) tags: - 'accepted' - 'agreement' - 'agreements' - 'namespace' - 'retrieve' - 'with' permissions: - 'ADMIN:NAMESPACE:{namespace}:LEGAL [READ]' 'retrieve_accepted_agreements_for_multi_users@py.legal.fun': id: 'retrieve_accepted_agreements_for_multi_users@py.legal.fun' name: 'retrieve_accepted_agreements_for_multi_users' type: 'function' description: |- This API will return all accepted Legal Agreements for each user, including agreements of game users if publisher user has corresponding game account. arguments: 'body': type: 'Optional[UsersAgreementsRequest]' required: false 'namespace': type: 'str' required: true description: |- Namespace return_type: 'Tuple[Union[None, List[UserAgreementsResponse]], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/agreement_with_namespace/retrieve_accepted_agree_8c230d.py' example: |- result, error = legal.retrieve_accepted_agreements_for_multi_users(...) if error: # handle_error(error) tags: - 'accepted' - 'agreement' - 'agreements' - 'for' - 'multi' - 'namespace' - 'retrieve' - 'users' - 'with' permissions: - 'ADMIN:NAMESPACE:{namespace}:LEGAL [READ]' 'retrieve_agreements_public@py.legal.fun': id: 'retrieve_agreements_public@py.legal.fun' name: 'retrieve_agreements_public' type: 'function' description: |- Retrieve accepted Legal Agreements. return_type: 'Tuple[Union[None, List[RetrieveAcceptedAgreementResponse]], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/agreement/retrieve_agreements_public.py' example: |- result, error = legal.retrieve_agreements_public(...) if error: # handle_error(error) tags: - 'agreement' - 'agreements' - 'public' - 'retrieve' 'retrieve_all_legal_policies@py.legal.fun': id: 'retrieve_all_legal_policies@py.legal.fun' name: 'retrieve_all_legal_policies' type: 'function' description: |- Retrieve all base policies. arguments: 'visible_only': type: 'Optional[bool]' required: false return_type: 'Tuple[Union[None, List[RetrieveBasePolicyResponse]], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/base_legal_policies/retrieve_all_legal_policies.py' example: |- result, error = legal.retrieve_all_legal_policies(...) if error: # handle_error(error) tags: - 'all' - 'base' - 'legal' - 'policies' - 'retrieve' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [READ]' 'retrieve_all_legal_policies_by_namespace@py.legal.fun': id: 'retrieve_all_legal_policies_by_namespace@py.legal.fun' name: 'retrieve_all_legal_policies_by_namespace' type: 'function' description: |- Retrieve base policies in the namespace. Set `limit = -1` to retrieve all records arguments: 'limit': type: 'Optional[int]' required: false description: |- Limit 'namespace': type: 'str' required: true description: |- Namespace 'offset': type: 'Optional[int]' required: false description: |- Offset 'visible_only': type: 'Optional[bool]' required: false return_type: 'Tuple[Union[None, List[RetrieveBasePolicyResponse]], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/base_legal_policies_with_namespace/retrieve_all_legal_poli_23dd4c.py' example: |- result, error = legal.retrieve_all_legal_policies_by_namespace(...) if error: # handle_error(error) tags: - 'all' - 'base' - 'by' - 'legal' - 'namespace' - 'policies' - 'retrieve' - 'with' permissions: - 'ADMIN:NAMESPACE:{namespace}:LEGAL [READ]' 'retrieve_all_policies_from_base_policy@py.legal.fun': id: 'retrieve_all_policies_from_base_policy@py.legal.fun' name: 'retrieve_all_policies_from_base_policy' type: 'function' description: |- Retrieve all policies from Base Legal Policy. arguments: 'base_policy_id': type: 'str' required: true description: |- BasePolicy Id 'namespace': type: 'str' required: true description: |- Namespace return_type: 'Tuple[Union[None, List[RetrievePoliciesFromBasePolicyResponse]], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/base_legal_policies_with_namespace/retrieve_all_policies_f_7ae86f.py' example: |- result, error = legal.retrieve_all_policies_from_base_policy(...) if error: # handle_error(error) tags: - 'all' - 'base' - 'from' - 'legal' - 'namespace' - 'policies' - 'policy' - 'retrieve' - 'with' permissions: - 'ADMIN:NAMESPACE:{namespace}:LEGAL [READ]' 'retrieve_all_policy_types@py.legal.fun': id: 'retrieve_all_policy_types@py.legal.fun' name: 'retrieve_all_policy_types' type: 'function' description: |- Retrieve all supported policy types. arguments: 'limit': type: 'int' required: true description: |- Limit 'namespace': type: 'str' required: true description: |- Namespace 'offset': type: 'Optional[int]' required: false description: |- Offset return_type: 'Tuple[Union[None, List[RetrievePolicyTypeResponse]], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/base_legal_policies_with_namespace/retrieve_all_policy_types.py' example: |- result, error = legal.retrieve_all_policy_types(...) if error: # handle_error(error) tags: - 'all' - 'base' - 'legal' - 'namespace' - 'policies' - 'policy' - 'retrieve' - 'types' - 'with' permissions: - 'ADMIN:NAMESPACE:{namespace}:LEGAL [READ]' 'retrieve_all_users_by_policy_version@py.legal.fun': id: 'retrieve_all_users_by_policy_version@py.legal.fun' name: 'retrieve_all_users_by_policy_version' type: 'function' description: |- This API will return all users who has accepted a specific policy version. arguments: 'convert_game_user_id': type: 'Optional[bool]' required: false description: |- [Only for publisher legal scenario] If it is true, when a game user accept this publisher legal, API will return publisher user id 'keyword': type: 'Optional[str]' required: false description: |- display name or email or username 'limit': type: 'Optional[int]' required: false description: |- limit 'namespace': type: 'str' required: true description: |- Namespace 'offset': type: 'Optional[int]' required: false description: |- offset 'policy_version_id': type: 'str' required: true return_type: 'Tuple[Union[None, PagedRetrieveUserAcceptedAgreementResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/agreement_with_namespace/retrieve_all_users_by_p_90a012.py' example: |- result, error = legal.retrieve_all_users_by_policy_version(...) if error: # handle_error(error) tags: - 'agreement' - 'all' - 'by' - 'namespace' - 'policy' - 'retrieve' - 'users' - 'version' - 'with' permissions: - 'ADMIN:NAMESPACE:{namespace}:LEGAL [READ]' 'retrieve_country_list_with_policies@py.legal.fun': id: 'retrieve_country_list_with_policies@py.legal.fun' name: 'retrieve_country_list_with_policies' type: 'function' description: |- Retrieve List of Countries that have Active and Visible Legal Policies. return_type: 'Tuple[Union[None, List[str]], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/policies/retrieve_country_list_w_8c69ff.py' example: |- result, error = legal.retrieve_country_list_with_policies(...) if error: # handle_error(error) tags: - 'country' - 'list' - 'policies' - 'retrieve' - 'with' 'retrieve_eligibilities_public@py.legal.fun': id: 'retrieve_eligibilities_public@py.legal.fun' name: 'retrieve_eligibilities_public' type: 'function' description: |- Retrieve the active policies and its conformance status by user. This process supports cross-namespace checking, that means if the active policy already accepted by the same user in other namespace, then it will be considered as eligible. arguments: 'namespace': type: 'str' required: true description: |- Namespace return_type: 'Tuple[Union[None, List[RetrieveUserEligibilitiesResponse]], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/eligibilities/retrieve_eligibilities_public.py' example: |- result, error = legal.retrieve_eligibilities_public(...) if error: # handle_error(error) tags: - 'eligibilities' - 'public' - 'retrieve' 'retrieve_eligibilities_public_indirect@py.legal.fun': id: 'retrieve_eligibilities_public_indirect@py.legal.fun' name: 'retrieve_eligibilities_public_indirect' type: 'function' description: |- Retrieve the active policies and its conformance status by user. This process only supports cross-namespace checking between game namespace and publisher namespace , that means if the active policy already accepted by the same user in publisher namespace, then it will also be considered as eligible in non-publisher namespace. arguments: 'client_id': type: 'str' required: true description: |- Client Id 'country_code': type: 'str' required: true description: |- Country Code 'namespace': type: 'str' required: true description: |- Namespace 'user_id': type: 'str' required: true description: |- User Id return_type: 'Tuple[Union[None, RetrieveUserEligibilitiesIndirectResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/eligibilities/retrieve_eligibilities__345271.py' example: |- result, error = legal.retrieve_eligibilities_public_indirect(...) if error: # handle_error(error) tags: - 'eligibilities' - 'indirect' - 'public' - 'retrieve' 'retrieve_latest_policies@py.legal.fun': id: 'retrieve_latest_policies@py.legal.fun' name: 'retrieve_latest_policies' type: 'function' description: |- Retrieve all active latest policies based on a country. Other detail info: * Leave the policyType empty if you want to be responded with all policy type * Fill the tags if you want to filter the responded policy by tags * Fill the defaultOnEmpty with true if you want to be responded with default country-specific policy if your requested country is not exist arguments: 'country_code': type: 'str' required: true description: |- Country Code 'default_on_empty': type: 'Optional[bool]' required: false description: |- Default On Empty 'policy_type': type: 'Optional[Union[str, RetrieveLatestPoliciesPolicyTypeEnum]]' required: false description: |- Policy Type 'tags': type: 'Optional[str]' required: false description: |- tags, separate multiple value by commas parameter 'visible_only': type: 'Optional[bool]' required: false return_type: 'Tuple[Union[None, List[RetrievePolicyPublicResponse]], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/policies/retrieve_latest_policies.py' example: |- result, error = legal.retrieve_latest_policies(...) if error: # handle_error(error) tags: - 'latest' - 'policies' - 'retrieve' 'retrieve_latest_policies_by_namespace_and_country_public@py.legal.fun': id: 'retrieve_latest_policies_by_namespace_and_country_public@py.legal.fun' name: 'retrieve_latest_policies_by_namespace_and_country_public' type: 'function' description: |- This API is used to list all the related doc in register page, include optional & mandatory (when env config APP_LEGAL_AGREEMENT_ALWAYS_INCLUDE_DEFAULT=true). Other detail info: Here are the result of different cases * Document 1, Region US (default, mandatory), UA (optional); clientID: [client_A] * Document 2, Region US (default, optional), UA (mandatory); clientID: [client_A] * Document 3, Region UA (default, mandatory); clientID: [client_A] * Document 4, Region US (default, optional); clientID: [client_A] * Document 5, Region US (default, optional); clientID: [client_B] * Document 6, Region CA (mandatory, optional), UA (optional); clientID: [client_B] * Query by: Region UA + client_A * Response: Document 1 (UA, optional), Document 2 (UA, mandatory), Document 3 (UA, mandatory), Document 4 (US, optional) * Query by: Region CA + client_A * Response: Document 1 (US, mandatory), Document 2 (US, mandatory), Document 3 (UA, mandatory), Document 4 (US, optional) * Query by: Region UA + client_B * Response: Document 5 (US, optional), Document 6 (UA, optional) * Query by: Region CN + client_B * Response: Document 5 (US, optional), Document 6 (CA, mandatory) Note: If APP_LEGAL_AGREEMENT_ALWAYS_INCLUDE_DEFAULT=false the behavior will be same with `/agreement/public/policies/namespaces/{namespace}/countries/{country_code}?defaultOnEmpty=true&visibleOnly;=true`;Here are the result of different cases * Query by: Region UA + client_A * Response: Document 1 (UA, optional), Document 2 (UA, mandatory), Document 3 (UA, mandatory) * Query by: Region UA + client_B * Response: Document 5 (US, optional) arguments: 'client_id': type: 'str' required: true description: |- clientId, which used to login 'country_code': type: 'str' required: true description: |- Country Code 'namespace': type: 'str' required: true description: |- Namespace return_type: 'Tuple[Union[None, List[RetrieveSimplePolicyPublicResponseV2]], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/policies_with_namespace_v2/retrieve_latest_policie_95ffb6.py' example: |- result, error = legal.retrieve_latest_policies_by_namespace_and_country_public(...) if error: # handle_error(error) tags: - 'and' - 'by' - 'country' - 'latest' - 'namespace' - 'policies' - 'public' - 'retrieve' - 'v2' - 'with' 'retrieve_latest_policies_public@py.legal.fun': id: 'retrieve_latest_policies_public@py.legal.fun' name: 'retrieve_latest_policies_public' type: 'function' description: |- Retrieve all active latest policies based on a namespace and country. The country will be read from user token. Other detail info: * Leave the policyType empty if you want to be responded with all policy type * Fill the tags if you want to filter the responded policy by tags * Fill the defaultOnEmpty with true if you want to be responded with default country-specific policy if your requested country is not exist * Fill the alwaysIncludeDefault with true if you want to be responded with always include default policy. If there are duplicate policies (default policies and country specific policies with same base policy) it'll include policy with same country code, for example: * Document 1 (default): Region US (default), UA * Document 2 (default): Region US (default) * Document 3 (default): Region US (default) * User: Region UA * Query: alwaysIncludeDefault: true * Response: Document 1 (UA), Document 2 (US), Document 3 (US) arguments: 'always_include_default': type: 'Optional[bool]' required: false description: |- Always include default 'default_on_empty': type: 'Optional[bool]' required: false description: |- Default On Empty 'namespace': type: 'str' required: true description: |- Namespace 'policy_type': type: 'Optional[Union[str, RetrieveLatestPoliciesPublicPolicyTypeEnum]]' required: false description: |- Policy Type 'tags': type: 'Optional[str]' required: false description: |- tags, separate multiple value by commas parameter 'visible_only': type: 'Optional[bool]' required: false return_type: 'Tuple[Union[None, List[RetrievePolicyPublicResponse]], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/policies/retrieve_latest_policie_29f65f.py' example: |- result, error = legal.retrieve_latest_policies_public(...) if error: # handle_error(error) tags: - 'latest' - 'policies' - 'public' - 'retrieve' 'retrieve_localized_policy_versions@py.legal.fun': id: 'retrieve_localized_policy_versions@py.legal.fun' name: 'retrieve_localized_policy_versions' type: 'function' description: |- Retrieve versions of a particular country-specific policy. arguments: 'namespace': type: 'str' required: true description: |- Namespace 'policy_version_id': type: 'str' required: true description: |- Policy Version Id return_type: 'Tuple[Union[None, List[RetrieveLocalizedPolicyVersionResponse]], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/localized_policy_versions_with_namespace/retrieve_localized_poli_24a671.py' example: |- result, error = legal.retrieve_localized_policy_versions(...) if error: # handle_error(error) tags: - 'localized' - 'namespace' - 'policy' - 'retrieve' - 'versions' - 'with' permissions: - 'ADMIN:NAMESPACE:{namespace}:LEGAL [READ]' 'retrieve_policies@py.legal.fun': id: 'retrieve_policies@py.legal.fun' name: 'retrieve_policies' type: 'function' description: |- Retrieve all active policies based on a country. arguments: 'country_code': type: 'str' required: true description: |- Country Code return_type: 'Tuple[Union[None, List[RetrievePolicyResponse]], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/policies/retrieve_policies.py' example: |- result, error = legal.retrieve_policies(...) if error: # handle_error(error) tags: - 'policies' - 'retrieve' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [READ]' 'retrieve_policy_country@py.legal.fun': id: 'retrieve_policy_country@py.legal.fun' name: 'retrieve_policy_country' type: 'function' description: |- Retrieve a Base Legal Policy based on a Particular Country. arguments: 'base_policy_id': type: 'str' required: true description: |- BasePolicy Id 'country_code': type: 'str' required: true description: |- Country Code 'namespace': type: 'str' required: true description: |- Namespace return_type: 'Tuple[Union[None, RetrievePolicyResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/base_legal_policies_with_namespace/retrieve_policy_country.py' example: |- result, error = legal.retrieve_policy_country(...) if error: # handle_error(error) tags: - 'base' - 'country' - 'legal' - 'namespace' - 'policies' - 'policy' - 'retrieve' - 'with' permissions: - 'ADMIN:NAMESPACE:{namespace}:LEGAL [READ]' 'retrieve_single_localized_policy_version@py.legal.fun': id: 'retrieve_single_localized_policy_version@py.legal.fun' name: 'retrieve_single_localized_policy_version' type: 'function' description: |- Retrieve a version of a particular country-specific policy. arguments: 'localized_policy_version_id': type: 'str' required: true description: |- Localized Policy Version Id 'namespace': type: 'str' required: true description: |- Namespace return_type: 'Tuple[Union[None, RetrieveLocalizedPolicyVersionResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/localized_policy_versions_with_namespace/retrieve_single_localiz_2f6231.py' example: |- result, error = legal.retrieve_single_localized_policy_version(...) if error: # handle_error(error) tags: - 'localized' - 'namespace' - 'policy' - 'retrieve' - 'single' - 'version' - 'versions' - 'with' permissions: - 'ADMIN:NAMESPACE:{namespace}:LEGAL [READ]' 'retrieve_single_policy@py.legal.fun': id: 'retrieve_single_policy@py.legal.fun' name: 'retrieve_single_policy' type: 'function' description: |- Retrieve a base policy. arguments: 'base_policy_id': type: 'str' required: true description: |- BasePolicy Id 'namespace': type: 'str' required: true description: |- Namespace return_type: 'Tuple[Union[None, RetrieveBasePolicyResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/base_legal_policies_with_namespace/retrieve_single_policy.py' example: |- result, error = legal.retrieve_single_policy(...) if error: # handle_error(error) tags: - 'base' - 'legal' - 'namespace' - 'policies' - 'policy' - 'retrieve' - 'single' - 'with' permissions: - 'ADMIN:NAMESPACE:{namespace}:LEGAL [READ]' 'retrieve_single_policy_version@py.legal.fun': id: 'retrieve_single_policy_version@py.legal.fun' name: 'retrieve_single_policy_version' type: 'function' description: |- Retrieve a version of a particular country specific policy. If version is not provided, the Legal Service will assume caller requesting all versions from country-specific policy. arguments: 'namespace': type: 'str' required: true description: |- Namespace 'policy_id': type: 'str' required: true description: |- Policy Id 'version_id': type: 'Optional[str]' required: false description: |- Version Id return_type: 'Tuple[Union[None, List[RetrievePolicyVersionResponse]], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/policy_versions_with_namespace/retrieve_single_policy_version.py' example: |- result, error = legal.retrieve_single_policy_version(...) if error: # handle_error(error) tags: - 'namespace' - 'policy' - 'retrieve' - 'single' - 'version' - 'versions' - 'with' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [READ]' 'set_default_localized_policy@py.legal.fun': id: 'set_default_localized_policy@py.legal.fun' name: 'set_default_localized_policy' type: 'function' description: |- Update a localized version policy to be the default. arguments: 'localized_policy_version_id': type: 'str' required: true description: |- Localized Policy Version Id 'namespace': type: 'str' required: true description: |- Namespace return_type: 'Tuple[Union[None, HttpResponse], Union[None, HttpResponse]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/localized_policy_versions_with_namespace/set_default_localized_policy.py' example: |- result, error = legal.set_default_localized_policy(...) if error: # handle_error(error) tags: - 'default' - 'localized' - 'namespace' - 'policy' - 'set' - 'versions' - 'with' permissions: - 'ADMIN:NAMESPACE:{namespace}:LEGAL [UPDATE]' 'set_default_policy@py.legal.fun': id: 'set_default_policy@py.legal.fun' name: 'set_default_policy' type: 'function' description: |- Update a policy to be the default. arguments: 'namespace': type: 'str' required: true description: |- Namespace 'policy_id': type: 'str' required: true description: |- Policy Id return_type: 'Tuple[Union[None, HttpResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/policies_with_namespace/set_default_policy.py' example: |- result, error = legal.set_default_policy(...) if error: # handle_error(error) tags: - 'default' - 'namespace' - 'policies' - 'policy' - 'set' - 'with' permissions: - 'ADMIN:NAMESPACE:{namespace}:LEGAL [UPDATE]' 'sync_user_info@py.legal.fun': id: 'sync_user_info@py.legal.fun' name: 'sync_user_info' type: 'function' description: |- Sync user info cache in agreement service with iam service. arguments: 'namespace': type: 'str' required: true return_type: 'Tuple[Union[None, HttpResponse], Union[None, HttpResponse]]' imports: - 'from typing import Any, Dict, List, Optional, Tuple, Union' - 'from accelbyte_py_sdk.core import HttpResponse' - 'import accelbyte_py_sdk.api.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/user_info/sync_user_info.py' example: |- result, error = legal.sync_user_info(...) if error: # handle_error(error) tags: - 'info' - 'sync' - 'user' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [UPDATE]' 'unpublish_policy_version@py.legal.fun': id: 'unpublish_policy_version@py.legal.fun' name: 'unpublish_policy_version' type: 'function' description: |- Un-publish a policy version from policy.Can only be un-publish if match these criteria: * Policy version has never been accepted by any user arguments: 'namespace': type: 'str' required: true description: |- Namespace 'policy_version_id': type: 'str' required: true description: |- Policy Version Id return_type: 'Tuple[None, 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/policy_versions_with_namespace/unpublish_policy_version.py' example: |- result, error = legal.unpublish_policy_version(...) if error: # handle_error(error) tags: - 'namespace' - 'policy' - 'unpublish' - 'version' - 'versions' - 'with' permissions: - 'ADMIN:NAMESPACE:{namespace}:LEGAL [UPDATE]' 'update_localized_policy_version@py.legal.fun': id: 'update_localized_policy_version@py.legal.fun' name: 'update_localized_policy_version' type: 'function' description: |- Update a version of a particular country-specific policy. arguments: 'body': type: 'Optional[UpdateLocalizedPolicyVersionRequest]' required: false 'localized_policy_version_id': type: 'str' required: true description: |- Localized Policy Version Id 'namespace': type: 'str' required: true description: |- Namespace return_type: 'Tuple[Union[None, UpdateLocalizedPolicyVersionResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/localized_policy_versions_with_namespace/update_localized_policy_a8a90f.py' example: |- result, error = legal.update_localized_policy_version(...) if error: # handle_error(error) tags: - 'localized' - 'namespace' - 'policy' - 'update' - 'version' - 'versions' - 'with' permissions: - 'ADMIN:NAMESPACE:{namespace}:LEGAL [UPDATE]' 'update_policy@py.legal.fun': id: 'update_policy@py.legal.fun' name: 'update_policy' type: 'function' description: |- Update country-specific and country-group policy. arguments: 'body': type: 'Optional[UpdatePolicyRequest]' required: false 'namespace': type: 'str' required: true description: |- Namespace 'policy_id': type: 'str' required: true description: |- Policy Id return_type: 'Tuple[Union[None, HttpResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/policies_with_namespace/update_policy.py' example: |- result, error = legal.update_policy(...) if error: # handle_error(error) tags: - 'namespace' - 'policies' - 'policy' - 'update' - 'with' permissions: - 'ADMIN:NAMESPACE:{namespace}:LEGAL [UPDATE]' 'update_policy_version@py.legal.fun': id: 'update_policy_version@py.legal.fun' name: 'update_policy_version' type: 'function' description: |- Update a particular policy version. arguments: 'body': type: 'Optional[UpdatePolicyVersionRequest]' required: false 'namespace': type: 'str' required: true description: |- Namespace 'policy_version_id': type: 'str' required: true description: |- Policy Version Id return_type: 'Tuple[Union[None, UpdatePolicyVersionResponse], 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.legal as legal' - 'import accelbyte_py_sdk.api.legal.models as legal_models' files: - 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/legal/operations/policy_versions_with_namespace/update_policy_version.py' example: |- result, error = legal.update_policy_version(...) if error: # handle_error(error) tags: - 'namespace' - 'policy' - 'update' - 'version' - 'versions' - 'with' permissions: - 'ADMIN:NAMESPACE:*:LEGAL [UPDATE]' # endregion functions