symbols:
# region models
'ApimodelsAdminUpdateItemReq@py.inventory.mod':
id: 'ApimodelsAdminUpdateItemReq@py.inventory.mod'
name: 'ApimodelsAdminUpdateItemReq'
type: 'model'
fields:
'custom_attributes':
type: 'Dict[str, Any]'
required: true
'server_custom_attributes':
type: 'Dict[str, Any]'
required: true
'slot_id':
type: 'str'
required: true
'source_item_id':
type: 'str'
required: true
'tags':
type: 'List[str]'
required: true
'type_':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_admin_update_item_req.py'
example: |-
apimodels_admin_update_item_req = inventory_models.ApimodelsAdminUpdateItemReq.create(...)
'ApimodelsBulkSaveItemError@py.inventory.mod':
id: 'ApimodelsBulkSaveItemError@py.inventory.mod'
name: 'ApimodelsBulkSaveItemError'
type: 'model'
fields:
'error_code':
type: 'int'
required: true
'error_message':
type: 'str'
required: true
'slot_id':
type: 'str'
required: true
'source_item_id':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_bulk_save_item_error.py'
example: |-
apimodels_bulk_save_item_error = inventory_models.ApimodelsBulkSaveItemError.create(...)
'ApimodelsBulkSaveItemResp@py.inventory.mod':
id: 'ApimodelsBulkSaveItemResp@py.inventory.mod'
name: 'ApimodelsBulkSaveItemResp'
type: 'model'
fields:
'success':
type: 'bool'
required: true
'error_details':
type: 'ApimodelsBulkSaveItemError'
required: false
'item':
type: 'ApimodelsItemResp'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_bulk_save_item_resp.py'
example: |-
apimodels_bulk_save_item_resp = inventory_models.ApimodelsBulkSaveItemResp.create(...)
'ApimodelsChainingOperationReq@py.inventory.mod':
id: 'ApimodelsChainingOperationReq@py.inventory.mod'
name: 'ApimodelsChainingOperationReq'
type: 'model'
fields:
'message':
type: 'str'
required: true
'operations':
type: 'List[ApimodelsOperation]'
required: true
'request_id':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_chaining_operation_req.py'
example: |-
apimodels_chaining_operation_req = inventory_models.ApimodelsChainingOperationReq.create(...)
'ApimodelsChainingOperationResp@py.inventory.mod':
id: 'ApimodelsChainingOperationResp@py.inventory.mod'
name: 'ApimodelsChainingOperationResp'
type: 'model'
fields:
'message':
type: 'str'
required: true
'error_details':
type: 'ApimodelsErrorResponse'
required: false
'replayed':
type: 'bool'
required: false
'request_id':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_chaining_operation_resp.py'
example: |-
apimodels_chaining_operation_resp = inventory_models.ApimodelsChainingOperationResp.create(...)
'ApimodelsConsumeItem@py.inventory.mod':
id: 'ApimodelsConsumeItem@py.inventory.mod'
name: 'ApimodelsConsumeItem'
type: 'model'
fields:
'inventory_id':
type: 'str'
required: true
'qty':
type: 'int'
required: true
'slot_id':
type: 'str'
required: true
'source_item_id':
type: 'str'
required: true
'date_range_validation':
type: 'bool'
required: false
'options':
type: 'List[str]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_consume_item.py'
example: |-
apimodels_consume_item = inventory_models.ApimodelsConsumeItem.create(...)
'ApimodelsConsumeItemReq@py.inventory.mod':
id: 'ApimodelsConsumeItemReq@py.inventory.mod'
name: 'ApimodelsConsumeItemReq'
type: 'model'
fields:
'qty':
type: 'int'
required: true
'slot_id':
type: 'str'
required: true
'source_item_id':
type: 'str'
required: true
'options':
type: 'List[str]'
required: false
description: |-
options, it is only available when item type is OPTIONBOX and value should be item id.
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_consume_item_req.py'
example: |-
apimodels_consume_item_req = inventory_models.ApimodelsConsumeItemReq.create(...)
'ApimodelsCreateIntegrationConfigurationReq@py.inventory.mod':
id: 'ApimodelsCreateIntegrationConfigurationReq@py.inventory.mod'
name: 'ApimodelsCreateIntegrationConfigurationReq'
type: 'model'
fields:
'service_name':
type: 'str'
required: true
'target_inventory_code':
type: 'str'
required: true
'map_item_type':
type: 'List[str]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_create_integration_configuration_req.py'
example: |-
apimodels_create_integration_configuration_req = inventory_models.ApimodelsCreateIntegrationConfigurationReq.create(...)
'ApimodelsCreateInventoryConfigurationReq@py.inventory.mod':
id: 'ApimodelsCreateInventoryConfigurationReq@py.inventory.mod'
name: 'ApimodelsCreateInventoryConfigurationReq'
type: 'model'
fields:
'code':
type: 'str'
required: true
'initial_max_slots':
type: 'int'
required: true
'max_instances_per_user':
type: 'int'
required: true
'max_upgrade_slots':
type: 'int'
required: true
'description':
type: 'str'
required: false
'name':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_create_inventory_configuration_req.py'
example: |-
apimodels_create_inventory_configuration_req = inventory_models.ApimodelsCreateInventoryConfigurationReq.create(...)
'ApimodelsCreateInventoryReq@py.inventory.mod':
id: 'ApimodelsCreateInventoryReq@py.inventory.mod'
name: 'ApimodelsCreateInventoryReq'
type: 'model'
fields:
'inventory_configuration_code':
type: 'str'
required: true
'user_id':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_create_inventory_req.py'
example: |-
apimodels_create_inventory_req = inventory_models.ApimodelsCreateInventoryReq.create(...)
'ApimodelsCreateItem@py.inventory.mod':
id: 'ApimodelsCreateItem@py.inventory.mod'
name: 'ApimodelsCreateItem'
type: 'model'
fields:
'custom_attributes':
type: 'Dict[str, Any]'
required: true
'qty':
type: 'int'
required: true
'server_custom_attributes':
type: 'Dict[str, Any]'
required: true
'slot_id':
type: 'str'
required: true
'slot_used':
type: 'int'
required: true
'source_item_id':
type: 'str'
required: true
'tags':
type: 'List[str]'
required: true
'to_specific_inventory':
type: 'bool'
required: true
'type_':
type: 'str'
required: true
'inventory_configuration_code':
type: 'str'
required: false
'inventory_id':
type: 'str'
required: false
'source':
type: 'Union[str, SourceEnum]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_create_item.py'
example: |-
apimodels_create_item = inventory_models.ApimodelsCreateItem.create(...)
'ApimodelsCreateItemTypeReq@py.inventory.mod':
id: 'ApimodelsCreateItemTypeReq@py.inventory.mod'
name: 'ApimodelsCreateItemTypeReq'
type: 'model'
fields:
'name':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_create_item_type_req.py'
example: |-
apimodels_create_item_type_req = inventory_models.ApimodelsCreateItemTypeReq.create(...)
'ApimodelsCreateItemTypeResp@py.inventory.mod':
id: 'ApimodelsCreateItemTypeResp@py.inventory.mod'
name: 'ApimodelsCreateItemTypeResp'
type: 'model'
fields:
'created_at':
type: 'str'
required: true
'name':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_create_item_type_resp.py'
example: |-
apimodels_create_item_type_resp = inventory_models.ApimodelsCreateItemTypeResp.create(...)
'ApimodelsCreateTagReq@py.inventory.mod':
id: 'ApimodelsCreateTagReq@py.inventory.mod'
name: 'ApimodelsCreateTagReq'
type: 'model'
fields:
'name':
type: 'str'
required: true
'owner':
type: 'Union[str, OwnerEnum]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_create_tag_req.py'
example: |-
apimodels_create_tag_req = inventory_models.ApimodelsCreateTagReq.create(...)
'ApimodelsCreateTagResp@py.inventory.mod':
id: 'ApimodelsCreateTagResp@py.inventory.mod'
name: 'ApimodelsCreateTagResp'
type: 'model'
fields:
'created_at':
type: 'str'
required: true
'name':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
'owner':
type: 'Union[str, OwnerEnum]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_create_tag_resp.py'
example: |-
apimodels_create_tag_resp = inventory_models.ApimodelsCreateTagResp.create(...)
'ApimodelsDeleteInventoryReq@py.inventory.mod':
id: 'ApimodelsDeleteInventoryReq@py.inventory.mod'
name: 'ApimodelsDeleteInventoryReq'
type: 'model'
fields:
'message':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_delete_inventory_req.py'
example: |-
apimodels_delete_inventory_req = inventory_models.ApimodelsDeleteInventoryReq.create(...)
'ApimodelsErrorResponse@py.inventory.mod':
id: 'ApimodelsErrorResponse@py.inventory.mod'
name: 'ApimodelsErrorResponse'
type: 'model'
fields:
'error_code':
type: 'int'
required: true
'error_message':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_error_response.py'
example: |-
apimodels_error_response = inventory_models.ApimodelsErrorResponse.create(...)
'ApimodelsIntegrationConfigurationResp@py.inventory.mod':
id: 'ApimodelsIntegrationConfigurationResp@py.inventory.mod'
name: 'ApimodelsIntegrationConfigurationResp'
type: 'model'
fields:
'created_at':
type: 'str'
required: true
'id_':
type: 'str'
required: true
'item_types':
type: 'List[str]'
required: true
'namespace':
type: 'str'
required: true
'service_name':
type: 'str'
required: true
'status':
type: 'str'
required: true
'target_inventory_code':
type: 'str'
required: true
'updated_at':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_integration_configuration_resp.py'
example: |-
apimodels_integration_configuration_resp = inventory_models.ApimodelsIntegrationConfigurationResp.create(...)
'ApimodelsInventoryConfig@py.inventory.mod':
id: 'ApimodelsInventoryConfig@py.inventory.mod'
name: 'ApimodelsInventoryConfig'
type: 'model'
fields:
'slot_used':
type: 'int'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_inventory_config.py'
example: |-
apimodels_inventory_config = inventory_models.ApimodelsInventoryConfig.create(...)
'ApimodelsInventoryConfigurationReq@py.inventory.mod':
id: 'ApimodelsInventoryConfigurationReq@py.inventory.mod'
name: 'ApimodelsInventoryConfigurationReq'
type: 'model'
fields:
'code':
type: 'str'
required: true
'initial_max_slots':
type: 'int'
required: true
'max_instances_per_user':
type: 'int'
required: true
'max_upgrade_slots':
type: 'int'
required: true
'description':
type: 'str'
required: false
'name':
type: 'str'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_inventory_configuration_req.py'
example: |-
apimodels_inventory_configuration_req = inventory_models.ApimodelsInventoryConfigurationReq.create(...)
'ApimodelsInventoryConfigurationResp@py.inventory.mod':
id: 'ApimodelsInventoryConfigurationResp@py.inventory.mod'
name: 'ApimodelsInventoryConfigurationResp'
type: 'model'
fields:
'code':
type: 'str'
required: true
'created_at':
type: 'str'
required: true
'description':
type: 'str'
required: true
'id_':
type: 'str'
required: true
'initial_max_slots':
type: 'int'
required: true
'max_instances_per_user':
type: 'int'
required: true
'max_upgrade_slots':
type: 'int'
required: true
'name':
type: 'str'
required: true
'namespace':
type: 'str'
required: true
'status':
type: 'Union[str, StatusEnum]'
required: true
'updated_at':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_inventory_configuration_resp.py'
example: |-
apimodels_inventory_configuration_resp = inventory_models.ApimodelsInventoryConfigurationResp.create(...)
'ApimodelsInventoryResp@py.inventory.mod':
id: 'ApimodelsInventoryResp@py.inventory.mod'
name: 'ApimodelsInventoryResp'
type: 'model'
fields:
'created_at':
type: 'str'
required: true
'id_':
type: 'str'
required: true
'inventory_configuration_code':
type: 'str'
required: true
'inventory_configuration_id':
type: 'str'
required: true
'max_slots':
type: 'int'
required: true
'max_upgrade_slots':
type: 'int'
required: true
'namespace':
type: 'str'
required: true
'updated_at':
type: 'str'
required: true
'used_count_slots':
type: 'int'
required: true
'user_id':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_inventory_resp.py'
example: |-
apimodels_inventory_resp = inventory_models.ApimodelsInventoryResp.create(...)
'ApimodelsItemResp@py.inventory.mod':
id: 'ApimodelsItemResp@py.inventory.mod'
name: 'ApimodelsItemResp'
type: 'model'
fields:
'created_at':
type: 'str'
required: true
'custom_attributes':
type: 'Dict[str, Any]'
required: true
'id_':
type: 'str'
required: true
'inventory_id':
type: 'str'
required: true
'item_info':
type: 'Dict[str, Any]'
required: true
'namespace':
type: 'str'
required: true
'qty':
type: 'int'
required: true
'server_custom_attributes':
type: 'Dict[str, Any]'
required: true
'slot_id':
type: 'str'
required: true
'slot_used':
type: 'int'
required: true
'source':
type: 'str'
required: true
'source_item_id':
type: 'str'
required: true
'tags':
type: 'List[str]'
required: true
'type_':
type: 'str'
required: true
'updated_at':
type: 'str'
required: true
'user_id':
type: 'str'
required: true
'platform_available':
type: 'bool'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_item_resp.py'
example: |-
apimodels_item_resp = inventory_models.ApimodelsItemResp.create(...)
'ApimodelsListIntegrationConfigurationsResp@py.inventory.mod':
id: 'ApimodelsListIntegrationConfigurationsResp@py.inventory.mod'
name: 'ApimodelsListIntegrationConfigurationsResp'
type: 'model'
fields:
'data':
type: 'List[ApimodelsIntegrationConfigurationResp]'
required: true
'paging':
type: 'ApimodelsPaging'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_list_integration_configurations_resp.py'
example: |-
apimodels_list_integration_configurations_resp = inventory_models.ApimodelsListIntegrationConfigurationsResp.create(...)
'ApimodelsListInventoryConfigurationsResp@py.inventory.mod':
id: 'ApimodelsListInventoryConfigurationsResp@py.inventory.mod'
name: 'ApimodelsListInventoryConfigurationsResp'
type: 'model'
fields:
'data':
type: 'List[ApimodelsInventoryConfigurationResp]'
required: true
'paging':
type: 'ApimodelsPaging'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_list_inventory_configurations_resp.py'
example: |-
apimodels_list_inventory_configurations_resp = inventory_models.ApimodelsListInventoryConfigurationsResp.create(...)
'ApimodelsListInventoryResp@py.inventory.mod':
id: 'ApimodelsListInventoryResp@py.inventory.mod'
name: 'ApimodelsListInventoryResp'
type: 'model'
fields:
'data':
type: 'List[ApimodelsInventoryResp]'
required: true
'paging':
type: 'ApimodelsPaging'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_list_inventory_resp.py'
example: |-
apimodels_list_inventory_resp = inventory_models.ApimodelsListInventoryResp.create(...)
'ApimodelsListItemResp@py.inventory.mod':
id: 'ApimodelsListItemResp@py.inventory.mod'
name: 'ApimodelsListItemResp'
type: 'model'
fields:
'data':
type: 'List[ApimodelsItemResp]'
required: true
'paging':
type: 'ApimodelsPaging'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_list_item_resp.py'
example: |-
apimodels_list_item_resp = inventory_models.ApimodelsListItemResp.create(...)
'ApimodelsListItemTypesResp@py.inventory.mod':
id: 'ApimodelsListItemTypesResp@py.inventory.mod'
name: 'ApimodelsListItemTypesResp'
type: 'model'
fields:
'data':
type: 'List[ApimodelsCreateItemTypeResp]'
required: true
'paging':
type: 'ApimodelsPaging'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_list_item_types_resp.py'
example: |-
apimodels_list_item_types_resp = inventory_models.ApimodelsListItemTypesResp.create(...)
'ApimodelsListTagsResp@py.inventory.mod':
id: 'ApimodelsListTagsResp@py.inventory.mod'
name: 'ApimodelsListTagsResp'
type: 'model'
fields:
'data':
type: 'List[ApimodelsCreateTagResp]'
required: true
'paging':
type: 'ApimodelsPaging'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_list_tags_resp.py'
example: |-
apimodels_list_tags_resp = inventory_models.ApimodelsListTagsResp.create(...)
'ApimodelsMoveItemsReq@py.inventory.mod':
id: 'ApimodelsMoveItemsReq@py.inventory.mod'
name: 'ApimodelsMoveItemsReq'
type: 'model'
fields:
'items':
type: 'List[ApimodelsTradeItem]'
required: true
'src_inventory_id':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_move_items_req.py'
example: |-
apimodels_move_items_req = inventory_models.ApimodelsMoveItemsReq.create(...)
'ApimodelsMoveItemsResp@py.inventory.mod':
id: 'ApimodelsMoveItemsResp@py.inventory.mod'
name: 'ApimodelsMoveItemsResp'
type: 'model'
fields:
'created_at':
type: 'str'
required: true
'dst_inventory_id':
type: 'str'
required: true
'items':
type: 'List[ApimodelsTradeItemResp]'
required: true
'namespace':
type: 'str'
required: true
'src_inventory_id':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_move_items_resp.py'
example: |-
apimodels_move_items_resp = inventory_models.ApimodelsMoveItemsResp.create(...)
'ApimodelsOperation@py.inventory.mod':
id: 'ApimodelsOperation@py.inventory.mod'
name: 'ApimodelsOperation'
type: 'model'
fields:
'consume_items':
type: 'List[ApimodelsConsumeItem]'
required: true
'create_items':
type: 'List[ApimodelsCreateItem]'
required: true
'remove_items':
type: 'List[ApimodelsRemoveItem]'
required: true
'target_user_id':
type: 'str'
required: true
'update_items':
type: 'List[ApimodelsUpdateItem]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_operation.py'
example: |-
apimodels_operation = inventory_models.ApimodelsOperation.create(...)
'ApimodelsPaging@py.inventory.mod':
id: 'ApimodelsPaging@py.inventory.mod'
name: 'ApimodelsPaging'
type: 'model'
fields:
'first':
type: 'str'
required: true
'last':
type: 'str'
required: true
'next_':
type: 'str'
required: true
'previous':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_paging.py'
example: |-
apimodels_paging = inventory_models.ApimodelsPaging.create(...)
'ApimodelsPurchaseValidationItemReq@py.inventory.mod':
id: 'ApimodelsPurchaseValidationItemReq@py.inventory.mod'
name: 'ApimodelsPurchaseValidationItemReq'
type: 'model'
fields:
'bundled_qty':
type: 'int'
required: true
'entitlement_type':
type: 'str'
required: true
'inventory_config':
type: 'ApimodelsInventoryConfig'
required: true
'item_id':
type: 'str'
required: true
'item_type':
type: 'str'
required: true
'sku':
type: 'str'
required: true
'stackable':
type: 'bool'
required: true
'use_count':
type: 'int'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_purchase_validation_item_req.py'
example: |-
apimodels_purchase_validation_item_req = inventory_models.ApimodelsPurchaseValidationItemReq.create(...)
'ApimodelsPurchaseValidationReq@py.inventory.mod':
id: 'ApimodelsPurchaseValidationReq@py.inventory.mod'
name: 'ApimodelsPurchaseValidationReq'
type: 'model'
fields:
'item_id':
type: 'str'
required: true
'item_type':
type: 'str'
required: true
'quantity':
type: 'int'
required: true
'sku':
type: 'str'
required: true
'entitlement_type':
type: 'str'
required: false
'inventory_config':
type: 'ApimodelsInventoryConfig'
required: false
'items':
type: 'List[ApimodelsPurchaseValidationItemReq]'
required: false
'stackable':
type: 'bool'
required: false
'use_count':
type: 'int'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_purchase_validation_req.py'
example: |-
apimodels_purchase_validation_req = inventory_models.ApimodelsPurchaseValidationReq.create(...)
'ApimodelsRemoveInventoryItemReq@py.inventory.mod':
id: 'ApimodelsRemoveInventoryItemReq@py.inventory.mod'
name: 'ApimodelsRemoveInventoryItemReq'
type: 'model'
fields:
'slot_id':
type: 'str'
required: true
'source_item_id':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_remove_inventory_item_req.py'
example: |-
apimodels_remove_inventory_item_req = inventory_models.ApimodelsRemoveInventoryItemReq.create(...)
'ApimodelsRemoveItem@py.inventory.mod':
id: 'ApimodelsRemoveItem@py.inventory.mod'
name: 'ApimodelsRemoveItem'
type: 'model'
fields:
'inventory_id':
type: 'str'
required: true
'slot_id':
type: 'str'
required: true
'source_item_id':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_remove_item.py'
example: |-
apimodels_remove_item = inventory_models.ApimodelsRemoveItem.create(...)
'ApimodelsSaveItemReq@py.inventory.mod':
id: 'ApimodelsSaveItemReq@py.inventory.mod'
name: 'ApimodelsSaveItemReq'
type: 'model'
fields:
'custom_attributes':
type: 'Dict[str, Any]'
required: true
'inventory_configuration_code':
type: 'str'
required: true
'qty':
type: 'int'
required: true
'server_custom_attributes':
type: 'Dict[str, Any]'
required: true
'slot_id':
type: 'str'
required: true
'slot_used':
type: 'int'
required: true
'source':
type: 'Union[str, SourceEnum]'
required: true
'source_item_id':
type: 'str'
required: true
'tags':
type: 'List[str]'
required: true
'type_':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_save_item_req.py'
example: |-
apimodels_save_item_req = inventory_models.ApimodelsSaveItemReq.create(...)
'ApimodelsSaveItemToInventoryReq@py.inventory.mod':
id: 'ApimodelsSaveItemToInventoryReq@py.inventory.mod'
name: 'ApimodelsSaveItemToInventoryReq'
type: 'model'
fields:
'custom_attributes':
type: 'Dict[str, Any]'
required: true
'qty':
type: 'int'
required: true
'server_custom_attributes':
type: 'Dict[str, Any]'
required: true
'slot_id':
type: 'str'
required: true
'slot_used':
type: 'int'
required: true
'source':
type: 'Union[str, SourceEnum]'
required: true
'source_item_id':
type: 'str'
required: true
'tags':
type: 'List[str]'
required: true
'type_':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_save_item_to_inventory_req.py'
example: |-
apimodels_save_item_to_inventory_req = inventory_models.ApimodelsSaveItemToInventoryReq.create(...)
'ApimodelsTradeItem@py.inventory.mod':
id: 'ApimodelsTradeItem@py.inventory.mod'
name: 'ApimodelsTradeItem'
type: 'model'
fields:
'qty':
type: 'int'
required: true
'slot_id':
type: 'str'
required: true
'source_item_id':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_trade_item.py'
example: |-
apimodels_trade_item = inventory_models.ApimodelsTradeItem.create(...)
'ApimodelsTradeItemResp@py.inventory.mod':
id: 'ApimodelsTradeItemResp@py.inventory.mod'
name: 'ApimodelsTradeItemResp'
type: 'model'
fields:
'id_':
type: 'str'
required: true
'qty':
type: 'int'
required: true
'slot_id':
type: 'str'
required: true
'source_item_id':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_trade_item_resp.py'
example: |-
apimodels_trade_item_resp = inventory_models.ApimodelsTradeItemResp.create(...)
'ApimodelsUpdateIntegrationConfigurationReq@py.inventory.mod':
id: 'ApimodelsUpdateIntegrationConfigurationReq@py.inventory.mod'
name: 'ApimodelsUpdateIntegrationConfigurationReq'
type: 'model'
fields:
'service_name':
type: 'str'
required: true
'target_inventory_code':
type: 'str'
required: true
'map_item_type':
type: 'List[str]'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_update_integration_configuration_req.py'
example: |-
apimodels_update_integration_configuration_req = inventory_models.ApimodelsUpdateIntegrationConfigurationReq.create(...)
'ApimodelsUpdateInventoryReq@py.inventory.mod':
id: 'ApimodelsUpdateInventoryReq@py.inventory.mod'
name: 'ApimodelsUpdateInventoryReq'
type: 'model'
fields:
'inc_max_slots':
type: 'int'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_update_inventory_req.py'
example: |-
apimodels_update_inventory_req = inventory_models.ApimodelsUpdateInventoryReq.create(...)
'ApimodelsUpdateItem@py.inventory.mod':
id: 'ApimodelsUpdateItem@py.inventory.mod'
name: 'ApimodelsUpdateItem'
type: 'model'
fields:
'custom_attributes':
type: 'Dict[str, Any]'
required: true
'inventory_id':
type: 'str'
required: true
'server_custom_attributes':
type: 'Dict[str, Any]'
required: true
'slot_id':
type: 'str'
required: true
'source_item_id':
type: 'str'
required: true
'tags':
type: 'List[str]'
required: true
'type_':
type: 'str'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_update_item.py'
example: |-
apimodels_update_item = inventory_models.ApimodelsUpdateItem.create(...)
'ApimodelsUpdateItemReq@py.inventory.mod':
id: 'ApimodelsUpdateItemReq@py.inventory.mod'
name: 'ApimodelsUpdateItemReq'
type: 'model'
fields:
'custom_attributes':
type: 'Dict[str, Any]'
required: true
'slot_id':
type: 'str'
required: true
'source_item_id':
type: 'str'
required: true
'tags':
type: 'List[str]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_update_item_req.py'
example: |-
apimodels_update_item_req = inventory_models.ApimodelsUpdateItemReq.create(...)
'ApimodelsUpdateItemResp@py.inventory.mod':
id: 'ApimodelsUpdateItemResp@py.inventory.mod'
name: 'ApimodelsUpdateItemResp'
type: 'model'
fields:
'slot_id':
type: 'str'
required: true
'source_item_id':
type: 'str'
required: true
'success':
type: 'bool'
required: true
'error_details':
type: 'ApimodelsErrorResponse'
required: false
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_update_item_resp.py'
example: |-
apimodels_update_item_resp = inventory_models.ApimodelsUpdateItemResp.create(...)
'ApimodelsUpdateStatusIntegrationConfigurationReq@py.inventory.mod':
id: 'ApimodelsUpdateStatusIntegrationConfigurationReq@py.inventory.mod'
name: 'ApimodelsUpdateStatusIntegrationConfigurationReq'
type: 'model'
fields:
'status':
type: 'Union[str, StatusEnum]'
required: true
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/models/apimodels_update_status_integration_configuration_req.py'
example: |-
apimodels_update_status_integration_configuration_req = inventory_models.ApimodelsUpdateStatusIntegrationConfigurationReq.create(...)
# endregion models
# region functions
'admin_bulk_remove_items@py.inventory.fun':
id: 'admin_bulk_remove_items@py.inventory.fun'
name: 'admin_bulk_remove_items'
type: 'function'
description: |-
Bulk remove user's own items'.
Permission: ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY:ITEM [DELETE]
arguments:
'body':
type: 'List[ApimodelsRemoveInventoryItemReq]'
required: true
'inventory_id':
type: 'str'
required: true
description: |-
InventoryID
'namespace':
type: 'str'
required: true
description: |-
Namespace
'user_id':
type: 'str'
required: true
description: |-
userID
return_type: 'Tuple[Union[None, List[ApimodelsUpdateItemResp]], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_items/admin_bulk_remove_items.py'
example: |-
result, error = inventory.admin_bulk_remove_items(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'bulk'
- 'items'
- 'remove'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY:ITEM [DELETE]'
'admin_bulk_save_item@py.inventory.fun':
id: 'admin_bulk_save_item@py.inventory.fun'
name: 'admin_bulk_save_item'
type: 'function'
description: |-
**This endpoint is used used for bulk saving purchased items to the playerâs inventory based on the inventoryConfigurationCode with the following conditions:**
- If the player doesn't have the inventory for the specified inventoryConfigurationCode, a new inventory will be created for the player.
- If the player already has one, it will be added to the existing inventory.
>- If the same item exists within the inventory, the quantity (qty) will be increased.
>- If the inventory is full, the item cannot be added and the request will return the âFailedâ response.
>- If a player has more than one inventory and the initial inventory is full, the service will check the available slot in the other inventory following the order of their creation date and time (createdAt).
- For E-commerce items:
>- Attributes such as slotUsed, serverCustomAttributes, customAttributes, and type will be overridden by the attributes configured in the AccelByte Gaming Services (AGS) Store.
>- Storing E-commerce items in a particular slot will follow its entitlement and item configuration, such as durable, consumable, stackable and non-stackable.
>- The quantity is dynamically set based on an itemâs useCount configured in Store. When saving an item, the specified quantity will be multiplied by configured useCount for that particular item. For example, if an Item is configured with a useCount of 5 in the AGS Store and it is saved with a qty of 2, the itemâs quantity will be stored as 10 in the playerâs inventory.
**When configuring your request, note the following:**
- The source field is mandatory for determining the source of the item. The supported values are OTHER (for items coming from other sources) and E-commerce for items coming from the E-commerce integration.
- For other-sourced items, the type can be manually defined when saving the item.
- A maximum of 10 items can be saved in a single bulk call.
You must have this permission to access this endpoint:
**Permission: ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY:ITEM [CREATE]**
arguments:
'body':
type: 'List[ApimodelsSaveItemReq]'
required: true
'namespace':
type: 'str'
required: true
description: |-
Namespace
'user_id':
type: 'str'
required: true
description: |-
UserID
return_type: 'Tuple[Union[None, List[ApimodelsBulkSaveItemResp]], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_items/admin_bulk_save_item.py'
example: |-
result, error = inventory.admin_bulk_save_item(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'bulk'
- 'item'
- 'items'
- 'save'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY:ITEM [CREATE]'
'admin_bulk_save_item_to_inventory@py.inventory.fun':
id: 'admin_bulk_save_item_to_inventory@py.inventory.fun'
name: 'admin_bulk_save_item_to_inventory'
type: 'function'
description: |-
**This endpoint is used for bulk saving purchased items to a specific inventory of the player, with the following conditions for E-commerce items:**
- Attributes such as slotUsed, serverCustomAttributes, customAttributes, and type will be overridden by the attributes configured in the AccelByte Gaming Services (AGS) Store.
- Storing E-commerce items in a particular slot will follow its entitlement and item configuration, such as durable, consumable, stackable and non-stackable.
- The quantity is dynamically set based on an itemâs useCount configured in Store. When saving an item, the specified quantity will be multiplied by configured useCount for that particular item. For example, if an Item is configured with a useCount of 5 in the AGS Store and it is saved with a qty of 2, the itemâs quantity will be stored as 10 in the playerâs inventory.
**When configuring your request, note the following:**
- The source field is mandatory for determining the source of the item. The supported values are OTHER (for items coming from other sources) and E-commerce for items coming from the E-commerce integration.
- For other-sourced items, the type can be manually defined when saving the item.
- A maximum of 10 items can be saved in a single bulk call.
You must have this permission to access this endpoint:
**Permission: ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY:ITEM[CREATE]**
arguments:
'body':
type: 'List[ApimodelsSaveItemToInventoryReq]'
required: true
'inventory_id':
type: 'str'
required: true
description: |-
inventoryID
'namespace':
type: 'str'
required: true
description: |-
Namespace
'user_id':
type: 'str'
required: true
description: |-
UserID
return_type: 'Tuple[Union[None, List[ApimodelsBulkSaveItemResp]], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_items/admin_bulk_save_item_to_7fa299.py'
example: |-
result, error = inventory.admin_bulk_save_item_to_inventory(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'bulk'
- 'inventory'
- 'item'
- 'items'
- 'save'
- 'to'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY:ITEM [CREATE]'
'admin_bulk_update_my_items@py.inventory.fun':
id: 'admin_bulk_update_my_items@py.inventory.fun'
name: 'admin_bulk_update_my_items'
type: 'function'
description: |-
Bulk Updating user's own items.
Tags will be auto-created.
Permission: ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY:ITEM [UPDATE]
arguments:
'body':
type: 'List[ApimodelsAdminUpdateItemReq]'
required: true
'inventory_id':
type: 'str'
required: true
description: |-
InventoryID
'namespace':
type: 'str'
required: true
description: |-
Namespace
'user_id':
type: 'str'
required: true
description: |-
userID
return_type: 'Tuple[Union[None, List[ApimodelsUpdateItemResp]], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_items/admin_bulk_update_my_items.py'
example: |-
result, error = inventory.admin_bulk_update_my_items(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'bulk'
- 'items'
- 'my'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY:ITEM [UPDATE]'
'admin_consume_user_item@py.inventory.fun':
id: 'admin_consume_user_item@py.inventory.fun'
name: 'admin_consume_user_item'
type: 'function'
description: |-
Consume user's own item
Client should pass item ID in options if item type is OPTIONBOX
Permission: ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY:ITEM [UPDATE]
arguments:
'body':
type: 'ApimodelsConsumeItemReq'
required: true
'date_range_validation':
type: 'Optional[str]'
required: false
description: |-
default is false
'inventory_id':
type: 'str'
required: true
description: |-
InventoryID
'namespace':
type: 'str'
required: true
description: |-
Namespace
'user_id':
type: 'str'
required: true
description: |-
userID
return_type: 'Tuple[Union[None, ApimodelsItemResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_items/admin_consume_user_item.py'
example: |-
result, error = inventory.admin_consume_user_item(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'consume'
- 'item'
- 'items'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY:ITEM [UPDATE]'
'admin_create_chaining_operations@py.inventory.fun':
id: 'admin_create_chaining_operations@py.inventory.fun'
name: 'admin_create_chaining_operations'
type: 'function'
description: |-
Create chaining Operations.
This process will run sequentially
1. remove item process
2. consume item process
3. update item process
4. create item process
if toSpecificInventory set as true, then inventoryId field will be mandatory, vice versa
The behavior of each process is same with current admin level endpoint
requestId: Request id(Optional), client should provide a unique request id to perform at most once execution, When a request id is resubmitted,
it will return original successful response
replayed : replayed, if true,the response is original successful response. This will not be included in response if client have not pass request id.
Permission: ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY:ITEM [CREATE]
arguments:
'body':
type: 'ApimodelsChainingOperationReq'
required: true
'namespace':
type: 'str'
required: true
description: |-
Namespace
return_type: 'Tuple[Union[None, ApimodelsChainingOperationResp], Union[None, ApimodelsChainingOperationResp, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_chaining_operations/admin_create_chaining_o_8801c9.py'
example: |-
result, error = inventory.admin_create_chaining_operations(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'chaining'
- 'create'
- 'operations'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY:ITEM [CREATE]'
'admin_create_integration_configuration@py.inventory.fun':
id: 'admin_create_integration_configuration@py.inventory.fun'
name: 'admin_create_integration_configuration'
type: 'function'
description: |-
Creating integration configuration.
There cannot be one duplicate serviceName per namespace.
Permission: ADMIN:NAMESPACE:{namespace}:INVENTORY:INTEGRATIONCONFIGURATION [CREATE]
arguments:
'body':
type: 'ApimodelsCreateIntegrationConfigurationReq'
required: true
'namespace':
type: 'str'
required: true
description: |-
Namespace
return_type: 'Tuple[Union[None, ApimodelsIntegrationConfigurationResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_integration_configurations/admin_create_integratio_c6b1bd.py'
example: |-
result, error = inventory.admin_create_integration_configuration(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configuration'
- 'configurations'
- 'create'
- 'integration'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INVENTORY:INTEGRATIONCONFIGURATION [CREATE]'
'admin_create_inventory@py.inventory.fun':
id: 'admin_create_inventory@py.inventory.fun'
name: 'admin_create_inventory'
type: 'function'
description: |-
Creating an inventory.
The inventory configuration must exists otherwise it will fail.
The max slots and max upgrade slots of an inventory will be initialized according to the inventory configuration it used,
but it can be changed later when using AdminUpdateInventory endpoint.
Permission: ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY [CREATE]
arguments:
'body':
type: 'ApimodelsCreateInventoryReq'
required: true
'namespace':
type: 'str'
required: true
description: |-
Namespace
return_type: 'Tuple[Union[None, ApimodelsInventoryResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_inventories/admin_create_inventory.py'
example: |-
result, error = inventory.admin_create_inventory(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'create'
- 'inventories'
- 'inventory'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY [CREATE]'
'admin_create_inventory_configuration@py.inventory.fun':
id: 'admin_create_inventory_configuration@py.inventory.fun'
name: 'admin_create_inventory_configuration'
type: 'function'
description: |-
Creating inventory configuration.
There cannot be one inventory configuration duplicate code per namespace.
Permission: ADMIN:NAMESPACE:{namespace}:INVENTORY:CONFIGURATION [CREATE]
arguments:
'body':
type: 'ApimodelsCreateInventoryConfigurationReq'
required: true
'namespace':
type: 'str'
required: true
description: |-
Namespace
return_type: 'Tuple[Union[None, ApimodelsInventoryConfigurationResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_inventory_configurations/admin_create_inventory__71b514.py'
example: |-
result, error = inventory.admin_create_inventory_configuration(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configuration'
- 'configurations'
- 'create'
- 'inventory'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INVENTORY:CONFIGURATION [CREATE]'
'admin_create_item_type@py.inventory.fun':
id: 'admin_create_item_type@py.inventory.fun'
name: 'admin_create_item_type'
type: 'function'
description: |-
This endpoint will create a new itemtype.
The itemtype name must be unique per namespace.
It is safe to call this endpoint even if the itemtype already exists.
Permission: ADMIN:NAMESPACE:{namespace}:INVENTORY:ITEMTYPE [CREATE]
arguments:
'body':
type: 'ApimodelsCreateItemTypeReq'
required: true
'namespace':
type: 'str'
required: true
description: |-
Namespace
return_type: 'Tuple[Union[None, ApimodelsCreateItemTypeResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_item_types/admin_create_item_type.py'
example: |-
result, error = inventory.admin_create_item_type(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'create'
- 'item'
- 'type'
- 'types'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INVENTORY:ITEMTYPE [CREATE]'
'admin_create_tag@py.inventory.fun':
id: 'admin_create_tag@py.inventory.fun'
name: 'admin_create_tag'
type: 'function'
description: |-
This endpoint will create a new tag.
The tag name must be unique per namespace.
It is safe to call this endpoint even if the tag already exists.
Permission: ADMIN:NAMESPACE:{namespace}:INVENTORY:TAG [CREATE]
arguments:
'body':
type: 'ApimodelsCreateTagReq'
required: true
'namespace':
type: 'str'
required: true
description: |-
Namespace
return_type: 'Tuple[Union[None, ApimodelsCreateTagResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_tags/admin_create_tag.py'
example: |-
result, error = inventory.admin_create_tag(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'create'
- 'tag'
- 'tags'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INVENTORY:TAG [CREATE]'
'admin_delete_inventory_configuration@py.inventory.fun':
id: 'admin_delete_inventory_configuration@py.inventory.fun'
name: 'admin_delete_inventory_configuration'
type: 'function'
description: |-
Deleting an inventory configuration.
If an inventory already reference this type (i.e. STATUS is "TIED"), then the type cannot be deleted anymore.
ADMIN:NAMESPACE:{namespace}:INVENTORY:CONFIGURATION [DELETE]
arguments:
'inventory_configuration_id':
type: 'str'
required: true
description: |-
InventoryConfigurationID
'namespace':
type: 'str'
required: true
description: |-
Namespace
return_type: 'Tuple[None, Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_inventory_configurations/admin_delete_inventory__38371e.py'
example: |-
result, error = inventory.admin_delete_inventory_configuration(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configuration'
- 'configurations'
- 'delete'
- 'inventory'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INVENTORY:CONFIGURATION [DELETE]'
'admin_delete_item_type@py.inventory.fun':
id: 'admin_delete_item_type@py.inventory.fun'
name: 'admin_delete_item_type'
type: 'function'
description: |-
This endpoint will delete a item type by itemtypeName in a specified namespace.
If the itemtypeName doesn't exist in a namespace, it'll return not found.
Permission: ADMIN:NAMESPACE:{namespace}:INVENTORY:ITEMTYPE [DELETE]
arguments:
'item_type_name':
type: 'str'
required: true
description: |-
ItemTypeName
'namespace':
type: 'str'
required: true
description: |-
Namespace
return_type: 'Tuple[None, Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_item_types/admin_delete_item_type.py'
example: |-
result, error = inventory.admin_delete_item_type(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'delete'
- 'item'
- 'type'
- 'types'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INVENTORY:ITEMTYPE [DELETE]'
'admin_delete_tag@py.inventory.fun':
id: 'admin_delete_tag@py.inventory.fun'
name: 'admin_delete_tag'
type: 'function'
description: |-
This endpoint will delete a tag by tagName in a specified namespace.
If the tagName doesn't exist in a namespace, it'll return not found.
Permission: ADMIN:NAMESPACE:{namespace}:INVENTORY:TAG [DELETE]
arguments:
'namespace':
type: 'str'
required: true
description: |-
Namespace
'tag_name':
type: 'str'
required: true
description: |-
TagName
return_type: 'Tuple[None, Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_tags/admin_delete_tag.py'
example: |-
result, error = inventory.admin_delete_tag(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'delete'
- 'tag'
- 'tags'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INVENTORY:TAG [DELETE]'
'admin_get_inventory@py.inventory.fun':
id: 'admin_get_inventory@py.inventory.fun'
name: 'admin_get_inventory'
type: 'function'
description: |-
Getting an inventory info.
Permission: ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY [READ]
arguments:
'inventory_id':
type: 'str'
required: true
description: |-
InventoryID
'namespace':
type: 'str'
required: true
description: |-
Namespace
return_type: 'Tuple[Union[None, ApimodelsInventoryResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_inventories/admin_get_inventory.py'
example: |-
result, error = inventory.admin_get_inventory(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'get'
- 'inventories'
- 'inventory'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY [READ]'
'admin_get_inventory_configuration@py.inventory.fun':
id: 'admin_get_inventory_configuration@py.inventory.fun'
name: 'admin_get_inventory_configuration'
type: 'function'
description: |-
Getting an inventory configuration info.
Permission: ADMIN:NAMESPACE:{namespace}:INVENTORY:CONFIGURATION [READ]
arguments:
'inventory_configuration_id':
type: 'str'
required: true
description: |-
InventoryConfigurationID
'namespace':
type: 'str'
required: true
description: |-
Namespace
return_type: 'Tuple[Union[None, ApimodelsInventoryConfigurationResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_inventory_configurations/admin_get_inventory_con_709281.py'
example: |-
result, error = inventory.admin_get_inventory_configuration(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configuration'
- 'configurations'
- 'get'
- 'inventory'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INVENTORY:CONFIGURATION [READ]'
'admin_get_inventory_item@py.inventory.fun':
id: 'admin_get_inventory_item@py.inventory.fun'
name: 'admin_get_inventory_item'
type: 'function'
description: |-
Getting an item info.
Permission: ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY:ITEM [READ]
arguments:
'inventory_id':
type: 'str'
required: true
description: |-
InventoryID
'namespace':
type: 'str'
required: true
description: |-
Namespace
'slot_id':
type: 'str'
required: true
description: |-
slotID
'source_item_id':
type: 'str'
required: true
description: |-
sourceItemID
return_type: 'Tuple[Union[None, ApimodelsItemResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_items/admin_get_inventory_item.py'
example: |-
result, error = inventory.admin_get_inventory_item(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'get'
- 'inventory'
- 'item'
- 'items'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY:ITEM [READ]'
'admin_list_integration_configurations@py.inventory.fun':
id: 'admin_list_integration_configurations@py.inventory.fun'
name: 'admin_list_integration_configurations'
type: 'function'
description: |-
Listing all integration configurations in a namespace.
The response body will be in the form of standard pagination.
Permission: ADMIN:NAMESPACE:{namespace}:INVENTORY:INTEGRATIONCONFIGURATION [READ]
arguments:
'limit':
type: 'Optional[int]'
required: false
description: |-
default 25
'namespace':
type: 'str'
required: true
description: |-
Namespace
'offset':
type: 'Optional[int]'
required: false
'sort_by':
type: 'Optional[Union[str, AdminListIntegrationConfigurationsSortByEnum]]'
required: false
description: |-
Only support one level of sortBy; default createdAt
return_type: 'Tuple[Union[None, ApimodelsListIntegrationConfigurationsResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_integration_configurations/admin_list_integration__420e8d.py'
example: |-
result, error = inventory.admin_list_integration_configurations(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configurations'
- 'integration'
- 'list'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INVENTORY:INTEGRATIONCONFIGURATION [READ]'
'admin_list_inventories@py.inventory.fun':
id: 'admin_list_inventories@py.inventory.fun'
name: 'admin_list_inventories'
type: 'function'
description: |-
Listing all inventories in a namespace.
The response body will be in the form of standard pagination.
Permission: ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY [READ]
arguments:
'inventory_configuration_code':
type: 'Optional[str]'
required: false
description: |-
InventoryConfigurationCode
'limit':
type: 'Optional[int]'
required: false
description: |-
default 25
'namespace':
type: 'str'
required: true
description: |-
Namespace
'offset':
type: 'Optional[int]'
required: false
'sort_by':
type: 'Optional[Union[str, AdminListInventoriesSortByEnum]]'
required: false
description: |-
Only support one level of sortBy; default createdAt
'user_id':
type: 'Optional[str]'
required: false
description: |-
UserID
return_type: 'Tuple[Union[None, ApimodelsListInventoryResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_inventories/admin_list_inventories.py'
example: |-
result, error = inventory.admin_list_inventories(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'inventories'
- 'list'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY [READ]'
'admin_list_inventory_configurations@py.inventory.fun':
id: 'admin_list_inventory_configurations@py.inventory.fun'
name: 'admin_list_inventory_configurations'
type: 'function'
description: |-
Listing all inventory configurations in a namespace.
The response body will be in the form of standard pagination.
Permission: ADMIN:NAMESPACE:{namespace}:INVENTORY:CONFIGURATION [READ]
arguments:
'code':
type: 'Optional[str]'
required: false
description: |-
will partially match inventoryConfigurationCode
'limit':
type: 'Optional[int]'
required: false
description: |-
default 25
'namespace':
type: 'str'
required: true
description: |-
Namespace
'offset':
type: 'Optional[int]'
required: false
'sort_by':
type: 'Optional[Union[str, AdminListInventoryConfigurationsSortByEnum]]'
required: false
description: |-
Only support one level of sortBy; default createdAt
return_type: 'Tuple[Union[None, ApimodelsListInventoryConfigurationsResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_inventory_configurations/admin_list_inventory_co_67d862.py'
example: |-
result, error = inventory.admin_list_inventory_configurations(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configurations'
- 'inventory'
- 'list'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INVENTORY:CONFIGURATION [READ]'
'admin_list_items@py.inventory.fun':
id: 'admin_list_items@py.inventory.fun'
name: 'admin_list_items'
type: 'function'
description: |-
Listing all items in an inventory.
The response body will be in the form of standard pagination.
Permission: ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY:ITEM [READ]
arguments:
'inventory_id':
type: 'str'
required: true
description: |-
InventoryID
'limit':
type: 'Optional[int]'
required: false
description: |-
default 25
'namespace':
type: 'str'
required: true
description: |-
Namespace
'offset':
type: 'Optional[int]'
required: false
'sort_by':
type: 'Optional[Union[str, AdminListItemsSortByEnum]]'
required: false
description: |-
Only support one level of sortBy; default createdAt
'source_item_id':
type: 'Optional[str]'
required: false
description: |-
SourceItemID
'tags':
type: 'Optional[str]'
required: false
description: |-
Tags
return_type: 'Tuple[Union[None, ApimodelsListItemResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_items/admin_list_items.py'
example: |-
result, error = inventory.admin_list_items(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'items'
- 'list'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY:ITEM [READ]'
'admin_list_item_types@py.inventory.fun':
id: 'admin_list_item_types@py.inventory.fun'
name: 'admin_list_item_types'
type: 'function'
description: |-
This endpoint will list all item types in a namespace.
The response body will be in the form of standard pagination.
Permission: ADMIN:NAMESPACE:{namespace}:INVENTORY:ITEMTYPE [READ]
arguments:
'limit':
type: 'Optional[int]'
required: false
description: |-
default 25
'namespace':
type: 'str'
required: true
description: |-
Namespace
'offset':
type: 'Optional[int]'
required: false
'sort_by':
type: 'Optional[Union[str, AdminListItemTypesSortByEnum]]'
required: false
description: |-
Only support one level of sortBy; default createdAt
return_type: 'Tuple[Union[None, ApimodelsListItemTypesResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_item_types/admin_list_item_types.py'
example: |-
result, error = inventory.admin_list_item_types(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'item'
- 'list'
- 'types'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INVENTORY:ITEMTYPE [READ]'
'admin_list_tags@py.inventory.fun':
id: 'admin_list_tags@py.inventory.fun'
name: 'admin_list_tags'
type: 'function'
description: |-
This endpoint will list all tags in a namespace.
The response body will be in the form of standard pagination.
Permission: ADMIN:NAMESPACE:{namespace}:INVENTORY:TAG [READ]
arguments:
'limit':
type: 'Optional[int]'
required: false
description: |-
default 25
'namespace':
type: 'str'
required: true
description: |-
Namespace
'offset':
type: 'Optional[int]'
required: false
'owner':
type: 'Optional[str]'
required: false
description: |-
supported parameter SERVER or CLIENT
'sort_by':
type: 'Optional[Union[str, AdminListTagsSortByEnum]]'
required: false
description: |-
Only support one level of sortBy; default createdAt
return_type: 'Tuple[Union[None, ApimodelsListTagsResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_tags/admin_list_tags.py'
example: |-
result, error = inventory.admin_list_tags(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'list'
- 'tags'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INVENTORY:TAG [READ]'
'admin_purchasable@py.inventory.fun':
id: 'admin_purchasable@py.inventory.fun'
name: 'admin_purchasable'
type: 'function'
description: |-
Validate purchase ecommerce item.
Permission: ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY [UPDATE]
arguments:
'body':
type: 'ApimodelsPurchaseValidationReq'
required: true
'namespace':
type: 'str'
required: true
description: |-
Namespace
'user_id':
type: 'str'
required: true
description: |-
UserID
return_type: 'Tuple[None, Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_inventories/admin_purchasable.py'
example: |-
result, error = inventory.admin_purchasable(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'inventories'
- 'purchasable'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY [UPDATE]'
'admin_save_item@py.inventory.fun':
id: 'admin_save_item@py.inventory.fun'
name: 'admin_save_item'
type: 'function'
description: |-
**This endpoint is used to save items to the playerâs inventory based on the inventoryConfigurationCode with the following conditions:**
- If the player doesn't have the inventory for the specified inventoryConfigurationCode, a new inventory will be created.
- If the user already has one, it will be added to the existing inventory.
- If the same item exists within the inventory, the quantity (qty) will be increased.
- If the inventory is full, the item cannot be added and the request will return the âFailedâ response.
- If a player has more than one inventory and the initial inventory is full, the service will check the available slot in the other inventory following the order of their creation date and time (createdAt).
- For Ecommerce items:
>- Attributes such as slotUsed, serverCustomAttributes, customAttributes, and type will be overridden by the attributes configured in the AccelByte Gaming Services (AGS) Store.
>- Storing E-commerce items in a particular slot will follow its entitlement and item configuration, such as durable, consumable, stackable and non-stackable.
>- The quantity is dynamically set based on an itemâs useCount configured in Store. When saving an item, the specified quantity will be multiplied by configured useCount for that particular item. For example, if an Item is configured with a useCount of 5 in the AGS Store and it is saved with a qty of 2, the itemâs quantity will be stored as 10 in the playerâs inventory.
You must have this permission to access this endpoint:
**Permission:ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY:ITEM [CREATE]**
arguments:
'body':
type: 'ApimodelsSaveItemReq'
required: true
'namespace':
type: 'str'
required: true
description: |-
Namespace
'user_id':
type: 'str'
required: true
description: |-
UserID
return_type: 'Tuple[Union[None, ApimodelsItemResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_items/admin_save_item.py'
example: |-
result, error = inventory.admin_save_item(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'item'
- 'items'
- 'save'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY:ITEM [CREATE]'
'admin_save_item_to_inventory@py.inventory.fun':
id: 'admin_save_item_to_inventory@py.inventory.fun'
name: 'admin_save_item_to_inventory'
type: 'function'
description: |-
**This endpoint is used to save purchased items to a specific inventory of the player, with the following conditions for E-commerce items:**
- Attributes such as slotUsed, serverCustomAttributes, customAttributes, and type will be overridden by the attributes configured in the AccelByte Gaming Services (AGS) Store.
- Storing E-commerce items in a particular slot will follow its entitlement and item configuration, such as durable, consumable, stackable and non-stackable.
- The quantity is dynamically set based on an itemâs useCount configured in Store. When saving an item, the specified quantity will be multiplied by configured useCount for that particular item. For example, if an Item is configured with a useCount of 5 in the AGS Store and it is saved with a qty of 2, the itemâs quantity will be stored as 10 in the playerâs inventory.
**When configuring your request, note the following:**
- The source field is mandatory for determining the source of the item. The supported values are OTHER (for items coming from other sources) and E-commerce for items coming from the E-commerce integration.
- For other-sourced items, the type can be manually defined when saving the item.
You must have this permission to access this endpoint:
**Permission: ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY:ITEM [CREATE]**
arguments:
'body':
type: 'ApimodelsSaveItemToInventoryReq'
required: true
'inventory_id':
type: 'str'
required: true
description: |-
inventoryID
'namespace':
type: 'str'
required: true
description: |-
Namespace
'user_id':
type: 'str'
required: true
description: |-
UserID
return_type: 'Tuple[Union[None, ApimodelsItemResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_items/admin_save_item_to_inventory.py'
example: |-
result, error = inventory.admin_save_item_to_inventory(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'inventory'
- 'item'
- 'items'
- 'save'
- 'to'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY:ITEM [CREATE]'
'admin_sync_user_entitlements@py.inventory.fun':
id: 'admin_sync_user_entitlements@py.inventory.fun'
name: 'admin_sync_user_entitlements'
type: 'function'
description: |-
Sync user's entitlement from e-commerce service to inventory for non exist item at user inventory.
will skip the item if already exist at user inventory.
Permission: ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY:ITEM [UPDATE]
arguments:
'namespace':
type: 'str'
required: true
description: |-
Namespace
'user_id':
type: 'str'
required: true
description: |-
userID
return_type: 'Tuple[None, Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_items/admin_sync_user_entitlements.py'
example: |-
result, error = inventory.admin_sync_user_entitlements(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'entitlements'
- 'items'
- 'sync'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY:ITEM [UPDATE]'
'admin_update_integration_configuration@py.inventory.fun':
id: 'admin_update_integration_configuration@py.inventory.fun'
name: 'admin_update_integration_configuration'
type: 'function'
description: |-
to update integration configuration
There cannot be duplicate serviceName per namespace.
Permission: ADMIN:NAMESPACE:{namespace}:INVENTORY:INTEGRATIONCONFIGURATION [UPDATE]
arguments:
'body':
type: 'ApimodelsUpdateIntegrationConfigurationReq'
required: true
'integration_configuration_id':
type: 'str'
required: true
description: |-
integrationConfigurationID
'namespace':
type: 'str'
required: true
description: |-
Namespace
return_type: 'Tuple[Union[None, ApimodelsIntegrationConfigurationResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_integration_configurations/admin_update_integratio_fe692f.py'
example: |-
result, error = inventory.admin_update_integration_configuration(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configuration'
- 'configurations'
- 'integration'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INVENTORY:INTEGRATIONCONFIGURATION [UPDATE]'
'admin_update_inventory@py.inventory.fun':
id: 'admin_update_inventory@py.inventory.fun'
name: 'admin_update_inventory'
type: 'function'
description: |-
Updating an inventory.
Positive value will increase MaxSlots from existing value
Negative value will decrease MaxSlots from existing value
Limited slots can not be changed to unlimited, vice versa
Permission: ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY [UPDATE]
arguments:
'body':
type: 'ApimodelsUpdateInventoryReq'
required: true
'inventory_id':
type: 'str'
required: true
description: |-
InventoryID
'namespace':
type: 'str'
required: true
description: |-
Namespace
return_type: 'Tuple[Union[None, ApimodelsInventoryResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_inventories/admin_update_inventory.py'
example: |-
result, error = inventory.admin_update_inventory(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'inventories'
- 'inventory'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY [UPDATE]'
'admin_update_inventory_configuration@py.inventory.fun':
id: 'admin_update_inventory_configuration@py.inventory.fun'
name: 'admin_update_inventory_configuration'
type: 'function'
description: |-
Updating inventory configuration.
There cannot be duplicate code per namespace.
Permission: ADMIN:NAMESPACE:{namespace}:INVENTORY:CONFIGURATION [UPDATE]
arguments:
'body':
type: 'ApimodelsInventoryConfigurationReq'
required: true
'inventory_configuration_id':
type: 'str'
required: true
description: |-
InventoryConfigurationID
'namespace':
type: 'str'
required: true
description: |-
Namespace
return_type: 'Tuple[Union[None, ApimodelsInventoryConfigurationResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_inventory_configurations/admin_update_inventory__e10746.py'
example: |-
result, error = inventory.admin_update_inventory_configuration(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configuration'
- 'configurations'
- 'inventory'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INVENTORY:CONFIGURATION [UPDATE]'
'admin_update_status_integration_configuration@py.inventory.fun':
id: 'admin_update_status_integration_configuration@py.inventory.fun'
name: 'admin_update_status_integration_configuration'
type: 'function'
description: |-
to update status integration configuration to be Active / Not Active.
There cannot be duplicate serviceName per namespace.
Permission: ADMIN:NAMESPACE:{namespace}:INVENTORY:INTEGRATIONCONFIGURATION [UPDATE]
arguments:
'body':
type: 'ApimodelsUpdateStatusIntegrationConfigurationReq'
required: true
'integration_configuration_id':
type: 'str'
required: true
description: |-
integrationConfigurationID
'namespace':
type: 'str'
required: true
description: |-
Namespace
return_type: 'Tuple[Union[None, ApimodelsIntegrationConfigurationResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_integration_configurations/admin_update_status_int_703321.py'
example: |-
result, error = inventory.admin_update_status_integration_configuration(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'configuration'
- 'configurations'
- 'integration'
- 'status'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:INVENTORY:INTEGRATIONCONFIGURATION [UPDATE]'
'admin_update_user_inventories_by_inventory_code@py.inventory.fun':
id: 'admin_update_user_inventories_by_inventory_code@py.inventory.fun'
name: 'admin_update_user_inventories_by_inventory_code'
type: 'function'
description: |-
Updating user inventories.
Positive value will increase MaxSlots from existing value
Negative value will decrease MaxSlots from existing value
Limited slots can not be changed to unlimited, vice versa
Permission: ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY [UPDATE]
arguments:
'body':
type: 'ApimodelsUpdateInventoryReq'
required: true
'inventory_configuration_code':
type: 'str'
required: true
description: |-
InventoryConfigurationCode
'namespace':
type: 'str'
required: true
description: |-
Namespace
'user_id':
type: 'str'
required: true
description: |-
UserID
return_type: 'Tuple[Union[None, List[ApimodelsInventoryResp]], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_inventories/admin_update_user_inven_6f94a4.py'
example: |-
result, error = inventory.admin_update_user_inventories_by_inventory_code(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'by'
- 'code'
- 'inventories'
- 'inventory'
- 'update'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY [UPDATE]'
'delete_inventory@py.inventory.fun':
id: 'delete_inventory@py.inventory.fun'
name: 'delete_inventory'
type: 'function'
description: |-
Deleting an inventory.
If an inventory still has items, it cannot be deleted.
ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY [DELETE]
arguments:
'body':
type: 'ApimodelsDeleteInventoryReq'
required: true
'inventory_id':
type: 'str'
required: true
description: |-
InventoryID
'namespace':
type: 'str'
required: true
description: |-
Namespace
return_type: 'Tuple[None, Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/admin_inventories/delete_inventory.py'
example: |-
result, error = inventory.delete_inventory(...)
if error:
# handle_error(error)
tags:
- 'admin'
- 'delete'
- 'inventories'
- 'inventory'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:INVENTORY [DELETE]'
'public_bulk_remove_my_items@py.inventory.fun':
id: 'public_bulk_remove_my_items@py.inventory.fun'
name: 'public_bulk_remove_my_items'
type: 'function'
description: |-
Bulk remove user's own items.
arguments:
'body':
type: 'List[ApimodelsRemoveInventoryItemReq]'
required: true
'inventory_id':
type: 'str'
required: true
description: |-
InventoryID
'namespace':
type: 'str'
required: true
description: |-
Namespace
return_type: 'Tuple[Union[None, List[ApimodelsUpdateItemResp]], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/public_items/public_bulk_remove_my_items.py'
example: |-
result, error = inventory.public_bulk_remove_my_items(...)
if error:
# handle_error(error)
tags:
- 'bulk'
- 'items'
- 'my'
- 'public'
- 'remove'
'public_bulk_update_my_items@py.inventory.fun':
id: 'public_bulk_update_my_items@py.inventory.fun'
name: 'public_bulk_update_my_items'
type: 'function'
description: |-
Bulk Updating user's own items.
arguments:
'body':
type: 'List[ApimodelsUpdateItemReq]'
required: true
'inventory_id':
type: 'str'
required: true
description: |-
InventoryID
'namespace':
type: 'str'
required: true
description: |-
Namespace
return_type: 'Tuple[Union[None, List[ApimodelsUpdateItemResp]], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/public_items/public_bulk_update_my_items.py'
example: |-
result, error = inventory.public_bulk_update_my_items(...)
if error:
# handle_error(error)
tags:
- 'bulk'
- 'items'
- 'my'
- 'public'
- 'update'
'public_consume_my_item@py.inventory.fun':
id: 'public_consume_my_item@py.inventory.fun'
name: 'public_consume_my_item'
type: 'function'
description: |-
Consume user's own item.
Client should pass item ID in options if item type is OPTIONBOX
arguments:
'body':
type: 'ApimodelsConsumeItemReq'
required: true
'inventory_id':
type: 'str'
required: true
description: |-
InventoryID
'namespace':
type: 'str'
required: true
description: |-
Namespace
return_type: 'Tuple[Union[None, ApimodelsItemResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/public_items/public_consume_my_item.py'
example: |-
result, error = inventory.public_consume_my_item(...)
if error:
# handle_error(error)
tags:
- 'consume'
- 'item'
- 'items'
- 'my'
- 'public'
'public_get_item@py.inventory.fun':
id: 'public_get_item@py.inventory.fun'
name: 'public_get_item'
type: 'function'
description: |-
Getting an user's owned item info.
arguments:
'inventory_id':
type: 'str'
required: true
description: |-
InventoryID
'namespace':
type: 'str'
required: true
description: |-
Namespace
'slot_id':
type: 'str'
required: true
description: |-
slotID
'source_item_id':
type: 'str'
required: true
description: |-
sourceItemID
return_type: 'Tuple[Union[None, ApimodelsItemResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/public_items/public_get_item.py'
example: |-
result, error = inventory.public_get_item(...)
if error:
# handle_error(error)
tags:
- 'get'
- 'item'
- 'items'
- 'public'
'public_list_inventories@py.inventory.fun':
id: 'public_list_inventories@py.inventory.fun'
name: 'public_list_inventories'
type: 'function'
description: |-
Listing all my inventories in a namespace.
The response body will be in the form of standard pagination.
arguments:
'inventory_configuration_code':
type: 'Optional[str]'
required: false
description: |-
InventoryConfigurationCode
'limit':
type: 'Optional[int]'
required: false
description: |-
default 25
'namespace':
type: 'str'
required: true
description: |-
Namespace
'offset':
type: 'Optional[int]'
required: false
'sort_by':
type: 'Optional[Union[str, PublicListInventoriesSortByEnum]]'
required: false
description: |-
Only support one level of sortBy; default createdAt
return_type: 'Tuple[Union[None, ApimodelsListInventoryResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/public_inventories/public_list_inventories.py'
example: |-
result, error = inventory.public_list_inventories(...)
if error:
# handle_error(error)
tags:
- 'inventories'
- 'list'
- 'public'
'public_list_inventory_configurations@py.inventory.fun':
id: 'public_list_inventory_configurations@py.inventory.fun'
name: 'public_list_inventory_configurations'
type: 'function'
description: |-
Listing all inventory configurations in a namespace.
The response body will be in the form of standard pagination.
arguments:
'code':
type: 'Optional[str]'
required: false
description: |-
will partially match inventoryConfigurationCode
'limit':
type: 'Optional[int]'
required: false
description: |-
default 25
'namespace':
type: 'str'
required: true
description: |-
Namespace
'offset':
type: 'Optional[int]'
required: false
'sort_by':
type: 'Optional[Union[str, PublicListInventoryConfigurationsSortByEnum]]'
required: false
description: |-
Only support one level of sortBy; default createdAt
return_type: 'Tuple[Union[None, ApimodelsListInventoryConfigurationsResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/public_inventory_configurations/public_list_inventory_c_d1722b.py'
example: |-
result, error = inventory.public_list_inventory_configurations(...)
if error:
# handle_error(error)
tags:
- 'configurations'
- 'inventory'
- 'list'
- 'public'
'public_list_items@py.inventory.fun':
id: 'public_list_items@py.inventory.fun'
name: 'public_list_items'
type: 'function'
description: |-
Listing all user's owned items in an inventory.
The response body will be in the form of standard pagination.
arguments:
'inventory_id':
type: 'str'
required: true
description: |-
InventoryID
'limit':
type: 'Optional[int]'
required: false
description: |-
default 25
'namespace':
type: 'str'
required: true
description: |-
Namespace
'offset':
type: 'Optional[int]'
required: false
'sort_by':
type: 'Optional[Union[str, PublicListItemsSortByEnum]]'
required: false
description: |-
Only support one level of sortBy; default createdAt
'source_item_id':
type: 'Optional[str]'
required: false
description: |-
SourceItemID
'tags':
type: 'Optional[str]'
required: false
description: |-
Tags
return_type: 'Tuple[Union[None, ApimodelsListItemResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/public_items/public_list_items.py'
example: |-
result, error = inventory.public_list_items(...)
if error:
# handle_error(error)
tags:
- 'items'
- 'list'
- 'public'
'public_list_item_types@py.inventory.fun':
id: 'public_list_item_types@py.inventory.fun'
name: 'public_list_item_types'
type: 'function'
description: |-
This endpoint will list all item types in a namespace.
The response body will be in the form of standard pagination.
arguments:
'limit':
type: 'Optional[int]'
required: false
description: |-
default 25
'namespace':
type: 'str'
required: true
description: |-
Namespace
'offset':
type: 'Optional[int]'
required: false
'sort_by':
type: 'Optional[Union[str, PublicListItemTypesSortByEnum]]'
required: false
description: |-
Only support one level of sortBy; default createdAt
return_type: 'Tuple[Union[None, ApimodelsListItemTypesResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/public_item_types/public_list_item_types.py'
example: |-
result, error = inventory.public_list_item_types(...)
if error:
# handle_error(error)
tags:
- 'item'
- 'list'
- 'public'
- 'types'
'public_list_tags@py.inventory.fun':
id: 'public_list_tags@py.inventory.fun'
name: 'public_list_tags'
type: 'function'
description: |-
This endpoint will list all tags in a namespace.
The response body will be in the form of standard pagination.
arguments:
'limit':
type: 'Optional[int]'
required: false
description: |-
default 25
'namespace':
type: 'str'
required: true
description: |-
Namespace
'offset':
type: 'Optional[int]'
required: false
'sort_by':
type: 'Optional[Union[str, PublicListTagsSortByEnum]]'
required: false
description: |-
Only support one level of sortBy; default createdAt
return_type: 'Tuple[Union[None, ApimodelsListTagsResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/public_tags/public_list_tags.py'
example: |-
result, error = inventory.public_list_tags(...)
if error:
# handle_error(error)
tags:
- 'list'
- 'public'
- 'tags'
'public_move_my_items@py.inventory.fun':
id: 'public_move_my_items@py.inventory.fun'
name: 'public_move_my_items'
type: 'function'
description: |-
Move items between inventories that is owned by the same user.
For Ecommerce items, the *qty* is *useCount*. For example, moving 2 of an item's *qty* will move 2 of the entitlement's *useCount*.
arguments:
'body':
type: 'ApimodelsMoveItemsReq'
required: true
'inventory_id':
type: 'str'
required: true
description: |-
InventoryID
'namespace':
type: 'str'
required: true
description: |-
Namespace
return_type: 'Tuple[Union[None, ApimodelsMoveItemsResp], Union[None, ApimodelsErrorResponse, HttpResponse]]'
imports:
- 'from typing import Any, Dict, List, Optional, Tuple, Union'
- 'from accelbyte_py_sdk.core import HttpResponse'
- 'import accelbyte_py_sdk.api.inventory as inventory'
- 'import accelbyte_py_sdk.api.inventory.models as inventory_models'
files:
- 'https://github.com/AccelByte/accelbyte-python-sdk/blob/main/accelbyte_py_sdk/api/inventory/operations/public_items/public_move_my_items.py'
example: |-
result, error = inventory.public_move_my_items(...)
if error:
# handle_error(error)
tags:
- 'items'
- 'move'
- 'my'
- 'public'
# endregion functions
