symbols:
# region models
'AddCountryGroupRequest@jv.basic.mod':
id: 'AddCountryGroupRequest@jv.basic.mod'
name: 'AddCountryGroupRequest'
type: 'model'
fields:
'countries':
type: 'List<CountryObject>'
required: false
'countryGroupCode':
type: 'String'
required: false
'countryGroupName':
type: 'String'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/AddCountryGroupRequest.java'
'AddCountryGroupResponse@jv.basic.mod':
id: 'AddCountryGroupResponse@jv.basic.mod'
name: 'AddCountryGroupResponse'
type: 'model'
fields:
'countries':
type: 'List<CountryObject>'
required: false
'countryGroupCode':
type: 'String'
required: false
'countryGroupName':
type: 'String'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/AddCountryGroupResponse.java'
'ConfigCreate@jv.basic.mod':
id: 'ConfigCreate@jv.basic.mod'
name: 'ConfigCreate'
type: 'model'
fields:
'key':
type: 'String'
required: true
description: |-
key, only accept alphabet and numeric
'value':
type: 'String'
required: true
description: |-
value
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/ConfigCreate.java'
'ConfigInfo@jv.basic.mod':
id: 'ConfigInfo@jv.basic.mod'
name: 'ConfigInfo'
type: 'model'
fields:
'createdAt':
type: 'String'
required: false
'key':
type: 'String'
required: false
'namespace':
type: 'String'
required: false
'updatedAt':
type: 'String'
required: false
'value':
type: 'String'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/ConfigInfo.java'
'ConfigUpdate@jv.basic.mod':
id: 'ConfigUpdate@jv.basic.mod'
name: 'ConfigUpdate'
type: 'model'
fields:
'value':
type: 'String'
required: true
description: |-
value
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/ConfigUpdate.java'
'CountryGroupObject@jv.basic.mod':
id: 'CountryGroupObject@jv.basic.mod'
name: 'CountryGroupObject'
type: 'model'
fields:
'countries':
type: 'List<CountryObject>'
required: false
'countryGroupCode':
type: 'String'
required: false
'countryGroupName':
type: 'String'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/CountryGroupObject.java'
'CountryObject@jv.basic.mod':
id: 'CountryObject@jv.basic.mod'
name: 'CountryObject'
type: 'model'
fields:
'code':
type: 'String'
required: false
'name':
type: 'String'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/CountryObject.java'
'ErrorEntity@jv.basic.mod':
id: 'ErrorEntity@jv.basic.mod'
name: 'ErrorEntity'
type: 'model'
fields:
'errorCode':
type: 'Integer'
required: true
description: |-
numeric error code
'errorMessage':
type: 'String'
required: true
description: |-
error message
'devStackTrace':
type: 'String'
required: false
description: |-
internal server error stack trace in configured environment
'messageVariables':
type: 'Map<String, String>'
required: false
description: |-
message variables
'requiredPermission':
type: 'Permission'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/ErrorEntity.java'
'FieldValidationError@jv.basic.mod':
id: 'FieldValidationError@jv.basic.mod'
name: 'FieldValidationError'
type: 'model'
fields:
'errorCode':
type: 'String'
required: false
'errorField':
type: 'String'
required: false
'errorMessage':
type: 'String'
required: false
'errorValue':
type: 'String'
required: false
'messageVariables':
type: 'Map<String, String>'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/FieldValidationError.java'
'FileUploadUrlInfo@jv.basic.mod':
id: 'FileUploadUrlInfo@jv.basic.mod'
name: 'FileUploadUrlInfo'
type: 'model'
fields:
'accessUrl':
type: 'String'
required: false
description: |-
URL for accessing file
'contentType':
type: 'String'
required: false
description: |-
File content-type
'method':
type: 'String'
required: false
description: |-
HTTP method for uploading file
'url':
type: 'String'
required: false
description: |-
URL for uploading file (S3 presigned URL)
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/FileUploadUrlInfo.java'
'NamespaceContext@jv.basic.mod':
id: 'NamespaceContext@jv.basic.mod'
name: 'NamespaceContext'
type: 'model'
description: |-
This model is used to indicate the context of a namespace
fields:
'namespace':
type: 'String'
required: false
description: |-
target namespace which need to get its context
'publisherNamespace':
type: 'String'
required: false
description: |-
publisher namespace
'studioNamespace':
type: 'String'
required: false
description: |-
studio namespace, it will be empty when input namespace is publisher namespace
'type':
type: 'String'
required: false
description: |-
input namespace type
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/NamespaceContext.java'
'NamespaceCreate@jv.basic.mod':
id: 'NamespaceCreate@jv.basic.mod'
name: 'NamespaceCreate'
type: 'model'
fields:
'displayName':
type: 'String'
required: true
description: |-
display name
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric. Will be converted to lowercase
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/NamespaceCreate.java'
'NamespaceInfo@jv.basic.mod':
id: 'NamespaceInfo@jv.basic.mod'
name: 'NamespaceInfo'
type: 'model'
fields:
'displayName':
type: 'String'
required: true
description: |-
namespace display name
'namespace':
type: 'String'
required: true
description: |-
namespace
'clientId':
type: 'String'
required: false
description: |-
clientId is only present on multi tenant mode with namespace is not publisher namespace
'createdAt':
type: 'String'
required: false
'parentNamespace':
type: 'String'
required: false
description: |-
parentNamespace is only present in multi tenant mode
'status':
type: 'String'
required: false
'updatedAt':
type: 'String'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/NamespaceInfo.java'
'NamespacePublisherInfo@jv.basic.mod':
id: 'NamespacePublisherInfo@jv.basic.mod'
name: 'NamespacePublisherInfo'
type: 'model'
fields:
'publisher':
type: 'Boolean'
required: false
description: |-
inform whether the specified namespace is publisher namespace or not
'publisherNamespace':
type: 'String'
required: false
description: |-
name of publisher namespace
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/NamespacePublisherInfo.java'
'NamespaceSimpleInfo@jv.basic.mod':
id: 'NamespaceSimpleInfo@jv.basic.mod'
name: 'NamespaceSimpleInfo'
type: 'model'
fields:
'displayName':
type: 'String'
required: true
description: |-
namespace display name
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/NamespaceSimpleInfo.java'
'NamespaceStatusUpdate@jv.basic.mod':
id: 'NamespaceStatusUpdate@jv.basic.mod'
name: 'NamespaceStatusUpdate'
type: 'model'
description: |-
A DTO object for updating namespace status API call.
fields:
'status':
type: 'String'
required: true
description: |-
namespace status
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/NamespaceStatusUpdate.java'
'NamespaceUpdate@jv.basic.mod':
id: 'NamespaceUpdate@jv.basic.mod'
name: 'NamespaceUpdate'
type: 'model'
fields:
'displayName':
type: 'String'
required: true
description: |-
display name
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/NamespaceUpdate.java'
'Permission@jv.basic.mod':
id: 'Permission@jv.basic.mod'
name: 'Permission'
type: 'model'
fields:
'action':
type: 'Integer'
required: false
'resource':
type: 'String'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/Permission.java'
'RetrieveCountryGroupResponse@jv.basic.mod':
id: 'RetrieveCountryGroupResponse@jv.basic.mod'
name: 'RetrieveCountryGroupResponse'
type: 'model'
fields:
'countries':
type: 'List<CountryObject>'
required: false
'countryGroupCode':
type: 'String'
required: false
'countryGroupName':
type: 'String'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/RetrieveCountryGroupResponse.java'
'RetrieveTimeResponse@jv.basic.mod':
id: 'RetrieveTimeResponse@jv.basic.mod'
name: 'RetrieveTimeResponse'
type: 'model'
fields:
'currentTime':
type: 'String'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/RetrieveTimeResponse.java'
'UpdateCountryGroupRequest@jv.basic.mod':
id: 'UpdateCountryGroupRequest@jv.basic.mod'
name: 'UpdateCountryGroupRequest'
type: 'model'
fields:
'countries':
type: 'List<CountryObject>'
required: false
'countryGroupName':
type: 'String'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/UpdateCountryGroupRequest.java'
'UserProfileAdmin@jv.basic.mod':
id: 'UserProfileAdmin@jv.basic.mod'
name: 'UserProfileAdmin'
type: 'model'
description: |-
A DTO object for updating user profile API call.
fields:
'avatarLargeUrl':
type: 'String'
required: false
description: |-
should be comply with OWASP url format
'avatarSmallUrl':
type: 'String'
required: false
description: |-
should be comply with OWASP url format
'avatarUrl':
type: 'String'
required: false
description: |-
should be comply with OWASP url format
'customAttributes':
type: 'Map<String, ?>'
required: false
'dateOfBirth':
type: 'String'
required: false
description: |-
date of birth, allowed format: yyyy-MM-dd, valid date range from 1905-01-01 until present
'firstName':
type: 'String'
required: false
description: |-
deprecated
'language':
type: 'String'
required: false
description: |-
language value from language tag, allowed format: en, en-US.<p>Supported language tag : [RFC5646](https://gist.github.com/msikma/8912e62ed866778ff8cd) and [IETF](https://datahub.io/core/language-codes#resource-ietf-language-tags)</p>
'lastName':
type: 'String'
required: false
description: |-
deprecated
'privateCustomAttributes':
type: 'Map<String, ?>'
required: false
'status':
type: 'String'
required: false
'timeZone':
type: 'String'
required: false
description: |-
time zone, allowed IANA time zone, e.g.Asia/Shanghai
'zipCode':
type: 'String'
required: false
description: |-
zip code
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/UserProfileAdmin.java'
'UserProfileBulkRequest@jv.basic.mod':
id: 'UserProfileBulkRequest@jv.basic.mod'
name: 'UserProfileBulkRequest'
type: 'model'
fields:
'userIds':
type: 'List<String>'
required: false
description: |-
User IDs, list of User ID with limit max to 100 User ID
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/UserProfileBulkRequest.java'
'UserProfileCreate@jv.basic.mod':
id: 'UserProfileCreate@jv.basic.mod'
name: 'UserProfileCreate'
type: 'model'
description: |-
A DTO object for creating user profile API call.
fields:
'avatarLargeUrl':
type: 'String'
required: false
description: |-
should be comply with OWASP url format
'avatarSmallUrl':
type: 'String'
required: false
description: |-
should be comply with OWASP url format
'avatarUrl':
type: 'String'
required: false
description: |-
should be comply with OWASP url format
'customAttributes':
type: 'Map<String, ?>'
required: false
'dateOfBirth':
type: 'String'
required: false
description: |-
date of birth, allowed format: yyyy-MM-dd, valid date range from 1905-01-01 until present
'firstName':
type: 'String'
required: false
description: |-
deprecated
'language':
type: 'String'
required: false
description: |-
language value from language tag, allowed format: en, en-US.<p>Supported language tag : [RFC5646](https://gist.github.com/msikma/8912e62ed866778ff8cd) and [IETF](https://datahub.io/core/language-codes#resource-ietf-language-tags)</p>
'lastName':
type: 'String'
required: false
description: |-
deprecated
'timeZone':
type: 'String'
required: false
description: |-
time zone, allowed IANA time zone, e.g.Asia/Shanghai
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/UserProfileCreate.java'
'UserProfileInfo@jv.basic.mod':
id: 'UserProfileInfo@jv.basic.mod'
name: 'UserProfileInfo'
type: 'model'
fields:
'avatarLargeUrl':
type: 'String'
required: false
'avatarSmallUrl':
type: 'String'
required: false
'avatarUrl':
type: 'String'
required: false
'customAttributes':
type: 'Map<String, ?>'
required: false
'dateOfBirth':
type: 'String'
required: false
'firstName':
type: 'String'
required: false
description: |-
deprecated
'language':
type: 'String'
required: false
'lastName':
type: 'String'
required: false
description: |-
deprecated
'namespace':
type: 'String'
required: false
'publicId':
type: 'String'
required: false
'status':
type: 'String'
required: false
'timeZone':
type: 'String'
required: false
'userId':
type: 'String'
required: false
'zipCode':
type: 'String'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/UserProfileInfo.java'
'UserProfilePrivateCreate@jv.basic.mod':
id: 'UserProfilePrivateCreate@jv.basic.mod'
name: 'UserProfilePrivateCreate'
type: 'model'
description: |-
A DTO object for creating user profile API call.
fields:
'avatarLargeUrl':
type: 'String'
required: false
description: |-
should be comply with OWASP url format
'avatarSmallUrl':
type: 'String'
required: false
description: |-
should be comply with OWASP url format
'avatarUrl':
type: 'String'
required: false
description: |-
should be comply with OWASP url format
'customAttributes':
type: 'Map<String, ?>'
required: false
'dateOfBirth':
type: 'String'
required: false
description: |-
date of birth, allowed format: yyyy-MM-dd, valid date range from 1905-01-01 until present
'firstName':
type: 'String'
required: false
description: |-
deprecated
'language':
type: 'String'
required: false
description: |-
language value from language tag, allowed format: en, en-US.<p>Supported language tag : [RFC5646](https://gist.github.com/msikma/8912e62ed866778ff8cd) and [IETF](https://datahub.io/core/language-codes#resource-ietf-language-tags)</p>
'lastName':
type: 'String'
required: false
description: |-
deprecated
'privateCustomAttributes':
type: 'Map<String, ?>'
required: false
'timeZone':
type: 'String'
required: false
description: |-
time zone, allowed IANA time zone, e.g.Asia/Shanghai
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/UserProfilePrivateCreate.java'
'UserProfilePrivateInfo@jv.basic.mod':
id: 'UserProfilePrivateInfo@jv.basic.mod'
name: 'UserProfilePrivateInfo'
type: 'model'
fields:
'avatarLargeUrl':
type: 'String'
required: false
'avatarSmallUrl':
type: 'String'
required: false
'avatarUrl':
type: 'String'
required: false
'customAttributes':
type: 'Map<String, ?>'
required: false
'dateOfBirth':
type: 'String'
required: false
'firstName':
type: 'String'
required: false
description: |-
deprecated
'language':
type: 'String'
required: false
'lastName':
type: 'String'
required: false
description: |-
deprecated
'namespace':
type: 'String'
required: false
'privateCustomAttributes':
type: 'Map<String, ?>'
required: false
'publicId':
type: 'String'
required: false
'status':
type: 'String'
required: false
'timeZone':
type: 'String'
required: false
'userId':
type: 'String'
required: false
'zipCode':
type: 'String'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/UserProfilePrivateInfo.java'
'UserProfilePublicInfo@jv.basic.mod':
id: 'UserProfilePublicInfo@jv.basic.mod'
name: 'UserProfilePublicInfo'
type: 'model'
fields:
'avatarLargeUrl':
type: 'String'
required: false
'avatarSmallUrl':
type: 'String'
required: false
'avatarUrl':
type: 'String'
required: false
'customAttributes':
type: 'Map<String, ?>'
required: false
'namespace':
type: 'String'
required: false
'publicId':
type: 'String'
required: false
'timeZone':
type: 'String'
required: false
'userId':
type: 'String'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/UserProfilePublicInfo.java'
'UserProfileStatusUpdate@jv.basic.mod':
id: 'UserProfileStatusUpdate@jv.basic.mod'
name: 'UserProfileStatusUpdate'
type: 'model'
description: |-
A DTO object for updating user profile status API call.
fields:
'status':
type: 'String'
required: true
description: |-
status, ACTIVE or INACTIVE
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/UserProfileStatusUpdate.java'
'UserProfileUpdate@jv.basic.mod':
id: 'UserProfileUpdate@jv.basic.mod'
name: 'UserProfileUpdate'
type: 'model'
description: |-
A DTO object for updating user profile API call.
fields:
'avatarLargeUrl':
type: 'String'
required: false
description: |-
should be comply with OWASP url format
'avatarSmallUrl':
type: 'String'
required: false
description: |-
should be comply with OWASP url format
'avatarUrl':
type: 'String'
required: false
description: |-
should be comply with OWASP url format
'customAttributes':
type: 'Map<String, ?>'
required: false
'dateOfBirth':
type: 'String'
required: false
description: |-
date of birth, allowed format: yyyy-MM-dd, valid date range from 1905-01-01 until present
'firstName':
type: 'String'
required: false
description: |-
deprecated
'language':
type: 'String'
required: false
description: |-
language value from language tag, allowed format: en, en-US.<p>Supported language tag : [RFC5646](https://gist.github.com/msikma/8912e62ed866778ff8cd) and [IETF](https://datahub.io/core/language-codes#resource-ietf-language-tags)</p>
'lastName':
type: 'String'
required: false
description: |-
deprecated
'privateCustomAttributes':
type: 'Map<String, ?>'
required: false
'timeZone':
type: 'String'
required: false
description: |-
time zone, allowed IANA time zone, e.g.Asia/Shanghai
'zipCode':
type: 'String'
required: false
description: |-
zip code
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/UserProfileUpdate.java'
'UserZipCode@jv.basic.mod':
id: 'UserZipCode@jv.basic.mod'
name: 'UserZipCode'
type: 'model'
fields:
'zipCode':
type: 'String'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/UserZipCode.java'
'UserZipCodeUpdate@jv.basic.mod':
id: 'UserZipCodeUpdate@jv.basic.mod'
name: 'UserZipCodeUpdate'
type: 'model'
fields:
'zipCode':
type: 'String'
required: true
description: |-
zip code, accept alphabet and numeric string default
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/UserZipCodeUpdate.java'
'ValidationErrorEntity@jv.basic.mod':
id: 'ValidationErrorEntity@jv.basic.mod'
name: 'ValidationErrorEntity'
type: 'model'
fields:
'errorCode':
type: 'Integer'
required: true
description: |-
numeric error code
'errorMessage':
type: 'String'
required: true
description: |-
error message
'errors':
type: 'List<FieldValidationError>'
required: false
imports:
- 'import java.util.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/models/ValidationErrorEntity.java'
# endregion models
# region functions
'AddCountryGroup@jv.basic.fun':
id: 'AddCountryGroup@jv.basic.fun'
name: 'AddCountryGroup'
type: 'function'
description: |-
Add a country groups
Country code must follow ISO3166-1 alpha-2.
Other detail info:
* Action code : 11201
* Returns : newly created country group
arguments:
'body':
type: 'AddCountryGroupRequest'
required: false
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'AddCountryGroupResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.misc.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Misc.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/misc/AddCountryGroup.java'
example: |-
try {
final AddCountryGroup operation = AddCountryGroup.builder()
.body(...)
.build(
namespace,
);
final Misc wrapper = new Misc(sdk);
final AddCountryGroupResponse response = wrapper.addCountryGroup(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'add'
- 'country'
- 'group'
- 'misc'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MISC [CREATE]'
'AdminGetUserProfilePublicInfoByIds@jv.basic.fun':
id: 'AdminGetUserProfilePublicInfoByIds@jv.basic.fun'
name: 'AdminGetUserProfilePublicInfoByIds'
type: 'function'
description: |-
Admin get user public profile by ids.
Other detail info:
* Required permission : resource= "ADMIN:NAMESPACE:{namespace}:PROFILE" , action=2 (GET)
* Action code : 11405
* Returns : user public profiles
arguments:
'body':
type: 'UserProfileBulkRequest'
required: false
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'List<UserProfilePublicInfo>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.user_profile.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/UserProfile.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/user_profile/AdminGetUserProfilePublicInfoByIds.java'
example: |-
try {
final AdminGetUserProfilePublicInfoByIds operation = AdminGetUserProfilePublicInfoByIds.builder()
.body(...)
.build(
namespace,
);
final UserProfile wrapper = new UserProfile(sdk);
final List<UserProfilePublicInfo> response = wrapper.adminGetUserProfilePublicInfoByIds(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'admin'
- 'by'
- 'get'
- 'ids'
- 'info'
- 'profile'
- 'public'
- 'user'
'AnonymizeUserProfile@jv.basic.fun':
id: 'AnonymizeUserProfile@jv.basic.fun'
name: 'AnonymizeUserProfile'
type: 'function'
description: |-
Anonymize user profile.
Other detail info:
* Action code : 11501
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
'userId':
type: 'String'
required: true
description: |-
user id, should follow UUID version 4 without hyphen
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.anonymization.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Anonymization.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/anonymization/AnonymizeUserProfile.java'
example: |-
try {
final AnonymizeUserProfile operation = AnonymizeUserProfile.builder()
.build(
namespace,
userId,
);
final Anonymization wrapper = new Anonymization(sdk);
wrapper.anonymizeUserProfile(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'anonymization'
- 'anonymize'
- 'profile'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:ANONYMIZATION [DELETE]'
'ChangeNamespaceStatus@jv.basic.fun':
id: 'ChangeNamespaceStatus@jv.basic.fun'
name: 'ChangeNamespaceStatus'
type: 'function'
description: |-
Change a namespace status.
Other detail info:
* Action code : 11306
* Returns : updated namespace
arguments:
'body':
type: 'NamespaceStatusUpdate'
required: false
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'NamespaceInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.namespace.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Namespace.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/namespace/ChangeNamespaceStatus.java'
example: |-
try {
final ChangeNamespaceStatus operation = ChangeNamespaceStatus.builder()
.body(...)
.build(
namespace,
);
final Namespace wrapper = new Namespace(sdk);
final NamespaceInfo response = wrapper.changeNamespaceStatus(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'change'
- 'namespace'
- 'status'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:NAMESPACE [UPDATE]'
'CreateConfig@jv.basic.fun':
id: 'CreateConfig@jv.basic.fun'
name: 'CreateConfig'
type: 'function'
description: |-
Create a config.
Other detail info:
* Returns : created config
arguments:
'body':
type: 'ConfigCreate'
required: false
'namespace':
type: 'String'
required: true
return_type: 'ConfigInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.config.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Config.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/config/CreateConfig.java'
example: |-
try {
final CreateConfig operation = CreateConfig.builder()
.body(...)
.build(
namespace,
);
final Config wrapper = new Config(sdk);
final ConfigInfo response = wrapper.createConfig(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'config'
- 'create'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:BASIC:CONFIG [CREATE]'
'CreateMyProfile@jv.basic.fun':
id: 'CreateMyProfile@jv.basic.fun'
name: 'CreateMyProfile'
type: 'function'
description: |-
Create my profile.
Client with user token can create user profile in target namespace
Other detail info:
* Action code : 11401
* Returns : Created user profile
* Path's namespace :
* can be filled with publisher namespace in order to create publisher user profile
* can be filled with game namespace in order to create game user profile
* Language : allowed format: en, en-US
* Country : ISO3166-1 alpha-2 two letter, e.g. US
* Timezone : IANA time zone, e.g. Asia/Shanghai
arguments:
'body':
type: 'UserProfilePrivateCreate'
required: false
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'UserProfilePrivateInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.user_profile.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/UserProfile.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/user_profile/CreateMyProfile.java'
example: |-
try {
final CreateMyProfile operation = CreateMyProfile.builder()
.body(...)
.build(
namespace,
);
final UserProfile wrapper = new UserProfile(sdk);
final UserProfilePrivateInfo response = wrapper.createMyProfile(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'create'
- 'my'
- 'profile'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:PROFILE [CREATE]'
'CreateNamespace@jv.basic.fun':
id: 'CreateNamespace@jv.basic.fun'
name: 'CreateNamespace'
type: 'function'
description: |-
Create a namespace.
By default the namespace is enabled.
In multi tenant mode, parentNamespace will be automatically filled with requester namespace if the requester is using studio or publisher token, and it will be filled with studio namespace if the requester uses game token. An oauth client will also be created and the id will be returned.
displayName rule:
* Alphanumeric lowercase and uppercase are allowed
* Allowed Special Character: ',. -
* Must start and end with alphanumeric
* Spaces and special character are allowed but cannot appear twice in a row
Other detail info:
* Action code : 11301
* Returns : created namespace
arguments:
'body':
type: 'NamespaceCreate'
required: false
return_type: 'NamespaceInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.namespace.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Namespace.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/namespace/CreateNamespace.java'
example: |-
try {
final CreateNamespace operation = CreateNamespace.builder()
.body(...)
.build();
final Namespace wrapper = new Namespace(sdk);
final NamespaceInfo response = wrapper.createNamespace(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'create'
- 'namespace'
permissions:
- 'ADMIN:NAMESPACE [CREATE]'
'DeleteConfig@jv.basic.fun':
id: 'DeleteConfig@jv.basic.fun'
name: 'DeleteConfig'
type: 'function'
description: |-
Delete a config.
Other detail info:
* Returns : created config
arguments:
'configKey':
type: 'String'
required: true
'namespace':
type: 'String'
required: true
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.config.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Config.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/config/DeleteConfig.java'
example: |-
try {
final DeleteConfig operation = DeleteConfig.builder()
.build(
configKey,
namespace,
);
final Config wrapper = new Config(sdk);
wrapper.deleteConfig(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'config'
- 'delete'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:BASIC:CONFIG [DELETE]'
'DeleteCountryGroup@jv.basic.fun':
id: 'DeleteCountryGroup@jv.basic.fun'
name: 'DeleteCountryGroup'
type: 'function'
description: |-
Delete a country groups by its country group code. This endpoint usually used for testing purpose to cleanup test data.
arguments:
'countryGroupCode':
type: 'String'
required: true
description: |-
groupCode, only accept alphabet and whitespace
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'void'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.misc.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Misc.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/misc/DeleteCountryGroup.java'
example: |-
try {
final DeleteCountryGroup operation = DeleteCountryGroup.builder()
.build(
countryGroupCode,
namespace,
);
final Misc wrapper = new Misc(sdk);
wrapper.deleteCountryGroup(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'country'
- 'delete'
- 'group'
- 'misc'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MISC [DELETE]'
'DeleteNamespace@jv.basic.fun':
id: 'DeleteNamespace@jv.basic.fun'
name: 'DeleteNamespace'
type: 'function'
description: |-
Delete a namespace.
Other detail info:
* Action code : 11307
* Returns : deleted namespace
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'NamespaceInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.namespace.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Namespace.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/namespace/DeleteNamespace.java'
example: |-
try {
final DeleteNamespace operation = DeleteNamespace.builder()
.build(
namespace,
);
final Namespace wrapper = new Namespace(sdk);
final NamespaceInfo response = wrapper.deleteNamespace(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'delete'
- 'namespace'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:NAMESPACE [DELETE]'
'DeleteUserProfile@jv.basic.fun':
id: 'DeleteUserProfile@jv.basic.fun'
name: 'DeleteUserProfile'
type: 'function'
description: |-
Delete user profile.
Other detail info:
* Action code : 11407
* Returns : Delete user profile
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
'userId':
type: 'String'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'UserProfilePrivateInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.user_profile.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/UserProfile.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/user_profile/DeleteUserProfile.java'
example: |-
try {
final DeleteUserProfile operation = DeleteUserProfile.builder()
.build(
namespace,
userId,
);
final UserProfile wrapper = new UserProfile(sdk);
final UserProfilePrivateInfo response = wrapper.deleteUserProfile(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'delete'
- 'profile'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:PROFILE [DELETE]'
'GeneratedUploadUrl@jv.basic.fun':
id: 'GeneratedUploadUrl@jv.basic.fun'
name: 'GeneratedUploadUrl'
type: 'function'
description: |-
Generate an upload URL. It's valid for 10 minutes.
Other detail info:
* Action code : 11101
* Returns : URL data
arguments:
'fileType':
type: 'String'
required: true
description: |-
one of the these types: jpeg, jpg, png, bmp, gif, mp3, bin, webp, mp4, webm
'folder':
type: 'String'
required: true
description: |-
the name of folder where the file will be uploaded, must be between 1-256 characters, all characters allowed no whitespace
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'FileUploadUrlInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.file_upload.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/FileUpload.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/file_upload/GeneratedUploadUrl.java'
example: |-
try {
final GeneratedUploadUrl operation = GeneratedUploadUrl.builder()
.build(
fileType,
folder,
namespace,
);
final FileUpload wrapper = new FileUpload(sdk);
final FileUploadUrlInfo response = wrapper.generatedUploadUrl(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'file'
- 'generated'
- 'upload'
- 'url'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:FILEUPLOAD [CREATE]'
'GeneratedUserUploadContentUrl@jv.basic.fun':
id: 'GeneratedUserUploadContentUrl@jv.basic.fun'
name: 'GeneratedUserUploadContentUrl'
type: 'function'
description: |-
Generate an upload URL for user content. It's valid for 10 minutes.
Other detail info:
* Action code : 11102
* Returns : URL data
arguments:
'category':
type: 'String'
required: false
description: |-
Upload category. Supported categories: default, reporting
'fileType':
type: 'String'
required: true
description: |-
one of the these types: jpeg, jpg, png, bmp, gif, mp3, bin, webp, mp4, webm
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
'userId':
type: 'String'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'FileUploadUrlInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.file_upload.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/FileUpload.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/file_upload/GeneratedUserUploadContentUrl.java'
example: |-
try {
final GeneratedUserUploadContentUrl operation = GeneratedUserUploadContentUrl.builder()
.category(...)
.build(
fileType,
namespace,
userId,
);
final FileUpload wrapper = new FileUpload(sdk);
final FileUploadUrlInfo response = wrapper.generatedUserUploadContentUrl(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'content'
- 'file'
- 'generated'
- 'upload'
- 'url'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:FILEUPLOAD [CREATE]'
'GetChildNamespaces@jv.basic.fun':
id: 'GetChildNamespaces@jv.basic.fun'
name: 'GetChildNamespaces'
type: 'function'
description: |-
Get child namespaces.
If input namespace is publisher namespace, then it will return its all studio namespace.
If input namespace is studio namespace, then it will return its all game namespace.
Other detail info:
* Returns : list of child namespaces
arguments:
'activeOnly':
type: 'Boolean'
required: false
description: |-
only retrieves active namespaces
'namespace':
type: 'String'
required: true
return_type: 'List<NamespaceInfo>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.namespace.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Namespace.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/namespace/GetChildNamespaces.java'
example: |-
try {
final GetChildNamespaces operation = GetChildNamespaces.builder()
.activeOnly(...)
.build(
namespace,
);
final Namespace wrapper = new Namespace(sdk);
final List<NamespaceInfo> response = wrapper.getChildNamespaces(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'child'
- 'get'
- 'namespace'
- 'namespaces'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:NAMESPACE [READ]'
'GetConfig@jv.basic.fun':
id: 'GetConfig@jv.basic.fun'
name: 'GetConfig'
type: 'function'
description: |-
Get a config.
Other detail info:
* Returns : config
arguments:
'configKey':
type: 'String'
required: true
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'ConfigInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.config.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Config.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/config/GetConfig.java'
example: |-
try {
final GetConfig operation = GetConfig.builder()
.build(
configKey,
namespace,
);
final Config wrapper = new Config(sdk);
final ConfigInfo response = wrapper.getConfig(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'config'
- 'get'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:BASIC:CONFIG [READ]'
'GetCountries@jv.basic.fun':
id: 'GetCountries@jv.basic.fun'
name: 'GetCountries'
type: 'function'
description: |-
List countries.
Other detail info:
* Action code : 11204
* Returns : country code list
arguments:
'lang':
type: 'String'
required: false
description: |-
language value from language tag, allowed format: en, en-US
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'List<CountryObject>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.misc.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Misc.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/misc/GetCountries.java'
example: |-
try {
final GetCountries operation = GetCountries.builder()
.lang(...)
.build(
namespace,
);
final Misc wrapper = new Misc(sdk);
final List<CountryObject> response = wrapper.getCountries(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'countries'
- 'get'
- 'misc'
'GetCountryGroups@jv.basic.fun':
id: 'GetCountryGroups@jv.basic.fun'
name: 'GetCountryGroups'
type: 'function'
description: |-
List country groups. Will return all available country groups if the query param is not specified
Other detail info:
* Action code : 11203
* Returns : list of country groups
arguments:
'groupCode':
type: 'String'
required: false
description: |-
groupCode, only accept alphabet and whitespace
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'List<RetrieveCountryGroupResponse>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.misc.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Misc.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/misc/GetCountryGroups.java'
example: |-
try {
final GetCountryGroups operation = GetCountryGroups.builder()
.groupCode(...)
.build(
namespace,
);
final Misc wrapper = new Misc(sdk);
final List<RetrieveCountryGroupResponse> response = wrapper.getCountryGroups(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'country'
- 'get'
- 'groups'
- 'misc'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MISC [READ]'
'GetCustomAttributesInfo@jv.basic.fun':
id: 'GetCustomAttributesInfo@jv.basic.fun'
name: 'GetCustomAttributesInfo'
type: 'function'
description: |-
Get user custom attributes.
Other detail info:
* Returns : custom attributes
* Action code : 11403
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
'userId':
type: 'String'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'Map<String, ?>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.user_profile.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/UserProfile.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/user_profile/GetCustomAttributesInfo.java'
example: |-
try {
final GetCustomAttributesInfo operation = GetCustomAttributesInfo.builder()
.build(
namespace,
userId,
);
final UserProfile wrapper = new UserProfile(sdk);
final Map<String, ?> response = wrapper.getCustomAttributesInfo(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'attributes'
- 'custom'
- 'get'
- 'info'
- 'profile'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:PROFILE [READ]'
'GetGameNamespaces@jv.basic.fun':
id: 'GetGameNamespaces@jv.basic.fun'
name: 'GetGameNamespaces'
type: 'function'
description: |-
Get game namespaces.
In multi tenant mode, a given super admin namespace will return all game namespaces of studio namespaces
Other detail info:
* Action code : 11308
* Returns : list of namespaces
arguments:
'activeOnly':
type: 'Boolean'
required: false
description: |-
only retrieves active namespaces
'namespace':
type: 'String'
required: true
return_type: 'List<NamespaceInfo>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.namespace.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Namespace.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/namespace/GetGameNamespaces.java'
example: |-
try {
final GetGameNamespaces operation = GetGameNamespaces.builder()
.activeOnly(...)
.build(
namespace,
);
final Namespace wrapper = new Namespace(sdk);
final List<NamespaceInfo> response = wrapper.getGameNamespaces(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'game'
- 'get'
- 'namespace'
- 'namespaces'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:NAMESPACE [READ]'
'GetLanguages@jv.basic.fun':
id: 'GetLanguages@jv.basic.fun'
name: 'GetLanguages'
type: 'function'
description: |-
List languages.
Other detail info:
* Action code : 11206
* Returns : language list
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Map<String, String>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.misc.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Misc.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/misc/GetLanguages.java'
example: |-
try {
final GetLanguages operation = GetLanguages.builder()
.build(
namespace,
);
final Misc wrapper = new Misc(sdk);
final Map<String, String> response = wrapper.getLanguages(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'languages'
- 'misc'
'GetMyPrivateCustomAttributesInfo@jv.basic.fun':
id: 'GetMyPrivateCustomAttributesInfo@jv.basic.fun'
name: 'GetMyPrivateCustomAttributesInfo'
type: 'function'
description: |-
Get my private custom attributes.
Other detail info:
* Returns : custom attributes
* Action code : 11403
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Map<String, ?>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.user_profile.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/UserProfile.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/user_profile/GetMyPrivateCustomAttributesInfo.java'
example: |-
try {
final GetMyPrivateCustomAttributesInfo operation = GetMyPrivateCustomAttributesInfo.builder()
.build(
namespace,
);
final UserProfile wrapper = new UserProfile(sdk);
final Map<String, ?> response = wrapper.getMyPrivateCustomAttributesInfo(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'attributes'
- 'custom'
- 'get'
- 'info'
- 'my'
- 'private'
- 'profile'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:PROFILE [READ]'
'GetMyProfileInfo@jv.basic.fun':
id: 'GetMyProfileInfo@jv.basic.fun'
name: 'GetMyProfileInfo'
type: 'function'
description: |-
Get my profile
Client with user token can get user profile in target namespace
Other detail info:
* Action code : 11403
* Returns : user profile
* Path's namespace :
* can be filled with publisher namespace in order to get publisher user profile
* can be filled with game namespace in order to get game user profile
* Language : allowed format: en, en-US
* Timezone : IANA time zone, e.g. Asia/Shanghai
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'UserProfilePrivateInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.user_profile.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/UserProfile.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/user_profile/GetMyProfileInfo.java'
example: |-
try {
final GetMyProfileInfo operation = GetMyProfileInfo.builder()
.build(
namespace,
);
final UserProfile wrapper = new UserProfile(sdk);
final UserProfilePrivateInfo response = wrapper.getMyProfileInfo(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'info'
- 'my'
- 'profile'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:PROFILE [READ]'
'GetMyZipCode@jv.basic.fun':
id: 'GetMyZipCode@jv.basic.fun'
name: 'GetMyZipCode'
type: 'function'
description: |-
Get my zip code.
Other detail info:
* Action code : 11407
* Returns : user zip code
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'UserZipCode'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.user_profile.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/UserProfile.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/user_profile/GetMyZipCode.java'
example: |-
try {
final GetMyZipCode operation = GetMyZipCode.builder()
.build(
namespace,
);
final UserProfile wrapper = new UserProfile(sdk);
final UserZipCode response = wrapper.getMyZipCode(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'code'
- 'get'
- 'my'
- 'profile'
- 'user'
- 'zip'
permissions:
- 'NAMESPACE:{namespace}:PROFILE [READ]'
'GetNamespace@jv.basic.fun':
id: 'GetNamespace@jv.basic.fun'
name: 'GetNamespace'
type: 'function'
description: |-
Get a namespace.
In multi tenant mode, parentNamespace will be returned.
Other detail info:
* Action code : 11304
* Returns : namespace
arguments:
'activeOnly':
type: 'Boolean'
required: false
description: |-
only retrieves active namespaces
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'NamespaceInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.namespace.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Namespace.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/namespace/GetNamespace.java'
example: |-
try {
final GetNamespace operation = GetNamespace.builder()
.activeOnly(...)
.build(
namespace,
);
final Namespace wrapper = new Namespace(sdk);
final NamespaceInfo response = wrapper.getNamespace(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'namespace'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:NAMESPACE [READ]'
'GetNamespace1@jv.basic.fun':
id: 'GetNamespace1@jv.basic.fun'
name: 'GetNamespace1'
type: 'function'
description: |-
Get a namespace info.
Other detail info:
* Returns : namespace info
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'NamespaceSimpleInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.namespace.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Namespace.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/namespace/GetNamespace1.java'
example: |-
try {
final GetNamespace1 operation = GetNamespace1.builder()
.build(
namespace,
);
final Namespace wrapper = new Namespace(sdk);
final NamespaceSimpleInfo response = wrapper.getNamespace1(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- '1'
- 'get'
- 'namespace'
'GetNamespaceContext@jv.basic.fun':
id: 'GetNamespaceContext@jv.basic.fun'
name: 'GetNamespaceContext'
type: 'function'
description: |-
Get context of namespace.
Other detail info:
* Returns : context of namespace
arguments:
'namespace':
type: 'String'
required: true
'refreshOnCacheMiss':
type: 'Boolean'
required: false
return_type: 'NamespaceContext'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.namespace.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Namespace.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/namespace/GetNamespaceContext.java'
example: |-
try {
final GetNamespaceContext operation = GetNamespaceContext.builder()
.refreshOnCacheMiss(...)
.build(
namespace,
);
final Namespace wrapper = new Namespace(sdk);
final NamespaceContext response = wrapper.getNamespaceContext(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'context'
- 'get'
- 'namespace'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:NAMESPACE [READ]'
'GetNamespacePublisher@jv.basic.fun':
id: 'GetNamespacePublisher@jv.basic.fun'
name: 'GetNamespacePublisher'
type: 'function'
description: |-
Get namespace info related publisher namespace.
Other detail info:
* Action code : 11305
* Returns : Namespace info related publisher namespace
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'NamespacePublisherInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.namespace.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Namespace.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/namespace/GetNamespacePublisher.java'
example: |-
try {
final GetNamespacePublisher operation = GetNamespacePublisher.builder()
.build(
namespace,
);
final Namespace wrapper = new Namespace(sdk);
final NamespacePublisherInfo response = wrapper.getNamespacePublisher(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'namespace'
- 'publisher'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:NAMESPACE [READ]'
'GetNamespaces@jv.basic.fun':
id: 'GetNamespaces@jv.basic.fun'
name: 'GetNamespaces'
type: 'function'
description: |-
Get all namespaces.
Other detail info:
* Action code : 11303
* Returns : list of namespaces
arguments:
'activeOnly':
type: 'Boolean'
required: false
description: |-
only retrieves active namespaces
return_type: 'List<NamespaceInfo>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.namespace.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Namespace.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/namespace/GetNamespaces.java'
example: |-
try {
final GetNamespaces operation = GetNamespaces.builder()
.activeOnly(...)
.build();
final Namespace wrapper = new Namespace(sdk);
final List<NamespaceInfo> response = wrapper.getNamespaces(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'namespace'
- 'namespaces'
permissions:
- 'ADMIN:NAMESPACE [READ]'
'GetPrivateCustomAttributesInfo@jv.basic.fun':
id: 'GetPrivateCustomAttributesInfo@jv.basic.fun'
name: 'GetPrivateCustomAttributesInfo'
type: 'function'
description: |-
Get user private custom attributes.
Other detail info:
* Returns : custom attributes
* Action code : 11403
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
'userId':
type: 'String'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'Map<String, ?>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.user_profile.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/UserProfile.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/user_profile/GetPrivateCustomAttributesInfo.java'
example: |-
try {
final GetPrivateCustomAttributesInfo operation = GetPrivateCustomAttributesInfo.builder()
.build(
namespace,
userId,
);
final UserProfile wrapper = new UserProfile(sdk);
final Map<String, ?> response = wrapper.getPrivateCustomAttributesInfo(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'attributes'
- 'custom'
- 'get'
- 'info'
- 'private'
- 'profile'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:PROFILE [READ]'
'GetPublisherConfig@jv.basic.fun':
id: 'GetPublisherConfig@jv.basic.fun'
name: 'GetPublisherConfig'
type: 'function'
description: |-
Get a publisher config.
It will return a publisher namespace config of the given namespace and key.
Other detail info:
* Returns : config
arguments:
'configKey':
type: 'String'
required: true
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'ConfigInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.config.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Config.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/config/GetPublisherConfig.java'
example: |-
try {
final GetPublisherConfig operation = GetPublisherConfig.builder()
.build(
configKey,
namespace,
);
final Config wrapper = new Config(sdk);
final ConfigInfo response = wrapper.getPublisherConfig(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'config'
- 'get'
- 'publisher'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:BASIC:CONFIG [READ]'
'GetTimeZones@jv.basic.fun':
id: 'GetTimeZones@jv.basic.fun'
name: 'GetTimeZones'
type: 'function'
description: |-
List time zones.
Other detail info:
* Action code : 11205
* Returns : time zones
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'List<String>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.misc.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Misc.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/misc/GetTimeZones.java'
example: |-
try {
final GetTimeZones operation = GetTimeZones.builder()
.build(
namespace,
);
final Misc wrapper = new Misc(sdk);
final List<String> response = wrapper.getTimeZones(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'misc'
- 'time'
- 'zones'
'GetUserProfileInfo@jv.basic.fun':
id: 'GetUserProfileInfo@jv.basic.fun'
name: 'GetUserProfileInfo'
type: 'function'
description: |-
Get user profile.
Other detail info:
* Returns : user profile
* Action code : 11403
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
'userId':
type: 'String'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'UserProfilePrivateInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.user_profile.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/UserProfile.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/user_profile/GetUserProfileInfo.java'
example: |-
try {
final GetUserProfileInfo operation = GetUserProfileInfo.builder()
.build(
namespace,
userId,
);
final UserProfile wrapper = new UserProfile(sdk);
final UserProfilePrivateInfo response = wrapper.getUserProfileInfo(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'info'
- 'profile'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:PROFILE [READ]'
'GetUserProfileInfoByPublicId@jv.basic.fun':
id: 'GetUserProfileInfoByPublicId@jv.basic.fun'
name: 'GetUserProfileInfoByPublicId'
type: 'function'
description: |-
Get user profile by public id.
Other detail info:
* Returns : user profile info
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
'publicId':
type: 'String'
required: true
description: |-
user public id
return_type: 'UserProfileInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.user_profile.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/UserProfile.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/user_profile/GetUserProfileInfoByPublicId.java'
example: |-
try {
final GetUserProfileInfoByPublicId operation = GetUserProfileInfoByPublicId.builder()
.build(
namespace,
publicId,
);
final UserProfile wrapper = new UserProfile(sdk);
final UserProfileInfo response = wrapper.getUserProfileInfoByPublicId(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'by'
- 'get'
- 'id'
- 'info'
- 'profile'
- 'public'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:PROFILE [READ]'
'PublicBulkGetUserProfilePublicInfo@jv.basic.fun':
id: 'PublicBulkGetUserProfilePublicInfo@jv.basic.fun'
name: 'PublicBulkGetUserProfilePublicInfo'
type: 'function'
description: |-
Bulk get user public profile by ids.
Other detail info:
* Returns : user public profiles
arguments:
'body':
type: 'UserProfileBulkRequest'
required: false
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'List<UserProfilePublicInfo>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.user_profile.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/UserProfile.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/user_profile/PublicBulkGetUserProfilePublicInfo.java'
example: |-
try {
final PublicBulkGetUserProfilePublicInfo operation = PublicBulkGetUserProfilePublicInfo.builder()
.body(...)
.build(
namespace,
);
final UserProfile wrapper = new UserProfile(sdk);
final List<UserProfilePublicInfo> response = wrapper.publicBulkGetUserProfilePublicInfo(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'bulk'
- 'get'
- 'info'
- 'profile'
- 'public'
- 'user'
'PublicCreateUserProfile@jv.basic.fun':
id: 'PublicCreateUserProfile@jv.basic.fun'
name: 'PublicCreateUserProfile'
type: 'function'
description: |-
Create user profile.
Other detail info:
* Action code : 11401
* Language : allowed format: en, en-US
* Timezone : IANA time zone, e.g. Asia/Shanghai
* Returns : Created user profile
arguments:
'body':
type: 'UserProfileCreate'
required: false
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
'userId':
type: 'String'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'UserProfileInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.user_profile.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/UserProfile.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/user_profile/PublicCreateUserProfile.java'
example: |-
try {
final PublicCreateUserProfile operation = PublicCreateUserProfile.builder()
.body(...)
.build(
namespace,
userId,
);
final UserProfile wrapper = new UserProfile(sdk);
final UserProfileInfo response = wrapper.publicCreateUserProfile(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'create'
- 'profile'
- 'public'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:PROFILE [CREATE]'
'PublicGeneratedUploadUrl@jv.basic.fun':
id: 'PublicGeneratedUploadUrl@jv.basic.fun'
name: 'PublicGeneratedUploadUrl'
type: 'function'
description: |-
Generate an upload URL. It's valid for 10 minutes.
Other detail info:
* Action code : 11101
* Returns : URL data
arguments:
'fileType':
type: 'String'
required: true
description: |-
one of the these types: jpeg, jpg, png, bmp, gif, mp3, bin, webp
'folder':
type: 'String'
required: true
description: |-
the name of folder where the file will be uploaded, must be between 1-256 characters, all characters allowed no whitespace
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'FileUploadUrlInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.file_upload.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/FileUpload.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/file_upload/PublicGeneratedUploadUrl.java'
example: |-
try {
final PublicGeneratedUploadUrl operation = PublicGeneratedUploadUrl.builder()
.build(
fileType,
folder,
namespace,
);
final FileUpload wrapper = new FileUpload(sdk);
final FileUploadUrlInfo response = wrapper.publicGeneratedUploadUrl(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'file'
- 'generated'
- 'public'
- 'upload'
- 'url'
permissions:
- 'NAMESPACE:{namespace}:FILEUPLOAD [CREATE]'
'PublicGeneratedUserUploadContentUrl@jv.basic.fun':
id: 'PublicGeneratedUserUploadContentUrl@jv.basic.fun'
name: 'PublicGeneratedUserUploadContentUrl'
type: 'function'
description: |-
Generate an upload URL for user content. It's valid for 10 minutes.
There are two types of storage limits per user: maximum file count and maximum total file size.
These limits vary depending on the upload category used.
1. Default category:
- Maximum file count per user: 10 files
- Maximum total file size per user: 100MB
2. Reporting category:
- Maximum file count per user: 3 files every 1 hour
- Maximum total file size per user: 30MB every 1 hour
Other detail info:
* Action code : 11102
* Returns : URL data
arguments:
'category':
type: 'String'
required: false
description: |-
Upload category. Supported categories: default, reporting
'fileType':
type: 'String'
required: true
description: |-
one of the these types: jpeg, jpg, png, bmp, gif, mp3, bin, webp
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
'userId':
type: 'String'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'FileUploadUrlInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.file_upload.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/FileUpload.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/file_upload/PublicGeneratedUserUploadContentUrl.java'
example: |-
try {
final PublicGeneratedUserUploadContentUrl operation = PublicGeneratedUserUploadContentUrl.builder()
.category(...)
.build(
fileType,
namespace,
userId,
);
final FileUpload wrapper = new FileUpload(sdk);
final FileUploadUrlInfo response = wrapper.publicGeneratedUserUploadContentUrl(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'content'
- 'file'
- 'generated'
- 'public'
- 'upload'
- 'url'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:FILEUPLOAD [CREATE]'
'PublicGetCountries@jv.basic.fun':
id: 'PublicGetCountries@jv.basic.fun'
name: 'PublicGetCountries'
type: 'function'
description: |-
List countries.
Other detail info:
* Returns : country code list
arguments:
'lang':
type: 'String'
required: false
description: |-
language value from language tag, allowed format: en, en-US
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'List<CountryObject>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.misc.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Misc.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/misc/PublicGetCountries.java'
example: |-
try {
final PublicGetCountries operation = PublicGetCountries.builder()
.lang(...)
.build(
namespace,
);
final Misc wrapper = new Misc(sdk);
final List<CountryObject> response = wrapper.publicGetCountries(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'countries'
- 'get'
- 'misc'
- 'public'
'PublicGetCustomAttributesInfo@jv.basic.fun':
id: 'PublicGetCustomAttributesInfo@jv.basic.fun'
name: 'PublicGetCustomAttributesInfo'
type: 'function'
description: |-
Get custom attributes info.
Other detail info:
* Action code : 11404
* Returns : user custom attributes
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
'userId':
type: 'String'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'Map<String, ?>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.user_profile.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/UserProfile.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/user_profile/PublicGetCustomAttributesInfo.java'
example: |-
try {
final PublicGetCustomAttributesInfo operation = PublicGetCustomAttributesInfo.builder()
.build(
namespace,
userId,
);
final UserProfile wrapper = new UserProfile(sdk);
final Map<String, ?> response = wrapper.publicGetCustomAttributesInfo(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'attributes'
- 'custom'
- 'get'
- 'info'
- 'profile'
- 'public'
- 'user'
'PublicGetLanguages@jv.basic.fun':
id: 'PublicGetLanguages@jv.basic.fun'
name: 'PublicGetLanguages'
type: 'function'
description: |-
List languages.
Other detail info:
* Returns : language list
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Map<String, ?>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.misc.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Misc.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/misc/PublicGetLanguages.java'
example: |-
try {
final PublicGetLanguages operation = PublicGetLanguages.builder()
.build(
namespace,
);
final Misc wrapper = new Misc(sdk);
final Map<String, ?> response = wrapper.publicGetLanguages(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'languages'
- 'misc'
- 'public'
'PublicGetNamespacePublisher@jv.basic.fun':
id: 'PublicGetNamespacePublisher@jv.basic.fun'
name: 'PublicGetNamespacePublisher'
type: 'function'
description: |-
Get namespace info related publisher namespace.
Other detail info:
* Action code : 11305
* Returns : Namespace info related publisher namespace
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'NamespacePublisherInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.namespace.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Namespace.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/namespace/PublicGetNamespacePublisher.java'
example: |-
try {
final PublicGetNamespacePublisher operation = PublicGetNamespacePublisher.builder()
.build(
namespace,
);
final Namespace wrapper = new Namespace(sdk);
final NamespacePublisherInfo response = wrapper.publicGetNamespacePublisher(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'namespace'
- 'public'
- 'publisher'
permissions:
- 'NAMESPACE:{namespace}:NAMESPACE [READ]'
'PublicGetNamespaces@jv.basic.fun':
id: 'PublicGetNamespaces@jv.basic.fun'
name: 'PublicGetNamespaces'
type: 'function'
description: |-
Get all namespaces.
Other detail info:
* Action code : 11303
* Returns : list of namespaces
arguments:
'activeOnly':
type: 'Boolean'
required: false
description: |-
only retrieves active namespaces
return_type: 'List<NamespaceInfo>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.namespace.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Namespace.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/namespace/PublicGetNamespaces.java'
example: |-
try {
final PublicGetNamespaces operation = PublicGetNamespaces.builder()
.activeOnly(...)
.build();
final Namespace wrapper = new Namespace(sdk);
final List<NamespaceInfo> response = wrapper.publicGetNamespaces(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'namespace'
- 'namespaces'
- 'public'
'PublicGetTime@jv.basic.fun':
id: 'PublicGetTime@jv.basic.fun'
name: 'PublicGetTime'
type: 'function'
description: |-
Get server time
return_type: 'RetrieveTimeResponse'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.misc.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Misc.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/misc/PublicGetTime.java'
example: |-
try {
final PublicGetTime operation = PublicGetTime.builder()
.build();
final Misc wrapper = new Misc(sdk);
final RetrieveTimeResponse response = wrapper.publicGetTime(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'misc'
- 'public'
- 'time'
'PublicGetTimeZones@jv.basic.fun':
id: 'PublicGetTimeZones@jv.basic.fun'
name: 'PublicGetTimeZones'
type: 'function'
description: |-
List time zones.
Other detail info:
* Returns : time zones
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'List<String>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.misc.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Misc.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/misc/PublicGetTimeZones.java'
example: |-
try {
final PublicGetTimeZones operation = PublicGetTimeZones.builder()
.build(
namespace,
);
final Misc wrapper = new Misc(sdk);
final List<String> response = wrapper.publicGetTimeZones(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'misc'
- 'public'
- 'time'
- 'zones'
'PublicGetUserProfileInfo@jv.basic.fun':
id: 'PublicGetUserProfileInfo@jv.basic.fun'
name: 'PublicGetUserProfileInfo'
type: 'function'
description: |-
Get user profile.
Other detail info:
* Action code : 11403
* Returns : user profile
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
'userId':
type: 'String'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'UserProfileInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.user_profile.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/UserProfile.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/user_profile/PublicGetUserProfileInfo.java'
example: |-
try {
final PublicGetUserProfileInfo operation = PublicGetUserProfileInfo.builder()
.build(
namespace,
userId,
);
final UserProfile wrapper = new UserProfile(sdk);
final UserProfileInfo response = wrapper.publicGetUserProfileInfo(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'info'
- 'profile'
- 'public'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:PROFILE [READ]'
'PublicGetUserProfileInfoByPublicId@jv.basic.fun':
id: 'PublicGetUserProfileInfoByPublicId@jv.basic.fun'
name: 'PublicGetUserProfileInfoByPublicId'
type: 'function'
description: |-
Get user public profile by public id.
Other detail info:
* Returns : user public profile
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
'publicId':
type: 'String'
required: true
description: |-
user public id
return_type: 'UserProfilePublicInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.user_profile.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/UserProfile.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/user_profile/PublicGetUserProfileInfoByPublicId.java'
example: |-
try {
final PublicGetUserProfileInfoByPublicId operation = PublicGetUserProfileInfoByPublicId.builder()
.build(
namespace,
publicId,
);
final UserProfile wrapper = new UserProfile(sdk);
final UserProfilePublicInfo response = wrapper.publicGetUserProfileInfoByPublicId(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'by'
- 'get'
- 'id'
- 'info'
- 'profile'
- 'public'
- 'user'
'PublicGetUserProfilePublicInfo@jv.basic.fun':
id: 'PublicGetUserProfilePublicInfo@jv.basic.fun'
name: 'PublicGetUserProfilePublicInfo'
type: 'function'
description: |-
Get user profile public info.
Other detail info:
* Action code : 11404
* Returns : user public profile
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
'userId':
type: 'String'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'UserProfilePublicInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.user_profile.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/UserProfile.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/user_profile/PublicGetUserProfilePublicInfo.java'
example: |-
try {
final PublicGetUserProfilePublicInfo operation = PublicGetUserProfilePublicInfo.builder()
.build(
namespace,
userId,
);
final UserProfile wrapper = new UserProfile(sdk);
final UserProfilePublicInfo response = wrapper.publicGetUserProfilePublicInfo(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'get'
- 'info'
- 'profile'
- 'public'
- 'user'
'PublicGetUserProfilePublicInfoByIds@jv.basic.fun':
id: 'PublicGetUserProfilePublicInfoByIds@jv.basic.fun'
name: 'PublicGetUserProfilePublicInfoByIds'
type: 'function'
description: |-
Get user public profile by ids.
Other detail info:
* Action code : 11405
* Returns : user public profiles
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
'userIds':
type: 'String'
required: true
description: |-
User IDs, should follow UUID version 4 without hyphen, separate the IDs using comma
return_type: 'List<UserProfilePublicInfo>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.user_profile.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/UserProfile.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/user_profile/PublicGetUserProfilePublicInfoByIds.java'
example: |-
try {
final PublicGetUserProfilePublicInfoByIds operation = PublicGetUserProfilePublicInfoByIds.builder()
.build(
namespace,
userIds,
);
final UserProfile wrapper = new UserProfile(sdk);
final List<UserProfilePublicInfo> response = wrapper.publicGetUserProfilePublicInfoByIds(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'by'
- 'get'
- 'ids'
- 'info'
- 'profile'
- 'public'
- 'user'
'PublicUpdateCustomAttributesPartially@jv.basic.fun':
id: 'PublicUpdateCustomAttributesPartially@jv.basic.fun'
name: 'PublicUpdateCustomAttributesPartially'
type: 'function'
description: |-
Update partially custom attributes tied to user id.
Other detail info:
* Action code : 11402
* Request body : allowed format: JSON object
* Returns : Updated custom attributes
arguments:
'body':
type: 'Map<String, ?>'
required: false
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
'userId':
type: 'String'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'Map<String, ?>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.user_profile.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/UserProfile.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/user_profile/PublicUpdateCustomAttributesPartially.java'
example: |-
try {
final PublicUpdateCustomAttributesPartially operation = PublicUpdateCustomAttributesPartially.builder()
.body(...)
.build(
namespace,
userId,
);
final UserProfile wrapper = new UserProfile(sdk);
final Map<String, ?> response = wrapper.publicUpdateCustomAttributesPartially(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'attributes'
- 'custom'
- 'partially'
- 'profile'
- 'public'
- 'update'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:PROFILE [UPDATE]'
'PublicUpdateUserProfile@jv.basic.fun':
id: 'PublicUpdateUserProfile@jv.basic.fun'
name: 'PublicUpdateUserProfile'
type: 'function'
description: |-
Update user profile.
Other detail info:
* Action code : 11402
* Language : allowed format: en, en-US
* Timezone : IANA time zone, e.g. Asia/Shanghai
* Returns : Updated user profile
arguments:
'body':
type: 'UserProfileUpdate'
required: false
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
'userId':
type: 'String'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'UserProfileInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.user_profile.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/UserProfile.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/user_profile/PublicUpdateUserProfile.java'
example: |-
try {
final PublicUpdateUserProfile operation = PublicUpdateUserProfile.builder()
.body(...)
.build(
namespace,
userId,
);
final UserProfile wrapper = new UserProfile(sdk);
final UserProfileInfo response = wrapper.publicUpdateUserProfile(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'profile'
- 'public'
- 'update'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:PROFILE [UPDATE]'
'PublicUpdateUserProfileStatus@jv.basic.fun':
id: 'PublicUpdateUserProfileStatus@jv.basic.fun'
name: 'PublicUpdateUserProfileStatus'
type: 'function'
description: |-
Update user profile status.
Other detail info:
* Action code : 11406
* Returns : user profile
arguments:
'body':
type: 'UserProfileStatusUpdate'
required: false
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
'userId':
type: 'String'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'UserProfileInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.user_profile.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/UserProfile.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/user_profile/PublicUpdateUserProfileStatus.java'
example: |-
try {
final PublicUpdateUserProfileStatus operation = PublicUpdateUserProfileStatus.builder()
.body(...)
.build(
namespace,
userId,
);
final UserProfile wrapper = new UserProfile(sdk);
final UserProfileInfo response = wrapper.publicUpdateUserProfileStatus(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'profile'
- 'public'
- 'status'
- 'update'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:USER:{userId}:PROFILE [UPDATE]'
'UpdateConfig@jv.basic.fun':
id: 'UpdateConfig@jv.basic.fun'
name: 'UpdateConfig'
type: 'function'
description: |-
Update a config.
Other detail info:
* Returns : created config
arguments:
'body':
type: 'ConfigUpdate'
required: false
'configKey':
type: 'String'
required: true
'namespace':
type: 'String'
required: true
return_type: 'ConfigInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.config.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Config.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/config/UpdateConfig.java'
example: |-
try {
final UpdateConfig operation = UpdateConfig.builder()
.body(...)
.build(
configKey,
namespace,
);
final Config wrapper = new Config(sdk);
final ConfigInfo response = wrapper.updateConfig(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'config'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:BASIC:CONFIG [UPDATE]'
'UpdateCountryGroup@jv.basic.fun':
id: 'UpdateCountryGroup@jv.basic.fun'
name: 'UpdateCountryGroup'
type: 'function'
description: |-
Update a country groups. The countryGroupCode must be exist beforehand.
Valid update behaviour :
- To update countryGroupName only, do not include countries key or just specify it with empty array.
- To update countries only, do not include countryGroupName key or just specify it with blank value.
Other detail info:
* Action code : 11202
* Returns : updated country group
arguments:
'body':
type: 'UpdateCountryGroupRequest'
required: false
'countryGroupCode':
type: 'String'
required: true
description: |-
groupCode, only accept alphabet and whitespace
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'CountryGroupObject'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.misc.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Misc.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/misc/UpdateCountryGroup.java'
example: |-
try {
final UpdateCountryGroup operation = UpdateCountryGroup.builder()
.body(...)
.build(
countryGroupCode,
namespace,
);
final Misc wrapper = new Misc(sdk);
final CountryGroupObject response = wrapper.updateCountryGroup(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'country'
- 'group'
- 'misc'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:MISC [UPDATE]'
'UpdateCustomAttributesPartially@jv.basic.fun':
id: 'UpdateCustomAttributesPartially@jv.basic.fun'
name: 'UpdateCustomAttributesPartially'
type: 'function'
description: |-
Update partially custom attributes tied to the user id.
Other detail info:
* Action code : 11402
* Request body : allowed format: JSON object
* Returns : Updated custom attributes
arguments:
'body':
type: 'Map<String, ?>'
required: false
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
'userId':
type: 'String'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'Map<String, ?>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.user_profile.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/UserProfile.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/user_profile/UpdateCustomAttributesPartially.java'
example: |-
try {
final UpdateCustomAttributesPartially operation = UpdateCustomAttributesPartially.builder()
.body(...)
.build(
namespace,
userId,
);
final UserProfile wrapper = new UserProfile(sdk);
final Map<String, ?> response = wrapper.updateCustomAttributesPartially(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'attributes'
- 'custom'
- 'partially'
- 'profile'
- 'update'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:PROFILE [UPDATE]'
'UpdateMyPrivateCustomAttributesPartially@jv.basic.fun':
id: 'UpdateMyPrivateCustomAttributesPartially@jv.basic.fun'
name: 'UpdateMyPrivateCustomAttributesPartially'
type: 'function'
description: |-
Update partially private custom attributes tied to me.
Other detail info:
* Action code : 11402
* Request body : allowed format: JSON object
* Returns : Updated custom attributes
arguments:
'body':
type: 'Map<String, ?>'
required: false
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'Map<String, ?>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.user_profile.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/UserProfile.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/user_profile/UpdateMyPrivateCustomAttributesPartially.java'
example: |-
try {
final UpdateMyPrivateCustomAttributesPartially operation = UpdateMyPrivateCustomAttributesPartially.builder()
.body(...)
.build(
namespace,
);
final UserProfile wrapper = new UserProfile(sdk);
final Map<String, ?> response = wrapper.updateMyPrivateCustomAttributesPartially(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'attributes'
- 'custom'
- 'my'
- 'partially'
- 'private'
- 'profile'
- 'update'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:PROFILE [UPDATE]'
'UpdateMyProfile@jv.basic.fun':
id: 'UpdateMyProfile@jv.basic.fun'
name: 'UpdateMyProfile'
type: 'function'
description: |-
Update my profile.
Updates user profile in the target namespace (namespace in the path). If token's namespace doesn't match the target namespace, the service automatically maps the token's user ID into the user ID in the target namespace. The endpoint returns the updated user profile on a successful call.
Other detail info:
* Action code : 11402
* Returns : user profile
* Path's namespace :
* can be filled with publisher namespace in order to update publisher user profile
* can be filled with game namespace in order to update game user profile
* Language : allowed format: en, en-US
* Timezone : IANA time zone, e.g. Asia/Shanghai
arguments:
'body':
type: 'UserProfileUpdate'
required: false
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'UserProfilePrivateInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.user_profile.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/UserProfile.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/user_profile/UpdateMyProfile.java'
example: |-
try {
final UpdateMyProfile operation = UpdateMyProfile.builder()
.body(...)
.build(
namespace,
);
final UserProfile wrapper = new UserProfile(sdk);
final UserProfilePrivateInfo response = wrapper.updateMyProfile(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'my'
- 'profile'
- 'update'
- 'user'
permissions:
- 'NAMESPACE:{namespace}:PROFILE [UPDATE]'
'UpdateMyZipCode@jv.basic.fun':
id: 'UpdateMyZipCode@jv.basic.fun'
name: 'UpdateMyZipCode'
type: 'function'
description: |-
Update my zip code.
Other detail info:
* Action code : 11408
* Returns : user zip code
arguments:
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
'userZipCodeUpdate':
type: 'UserZipCodeUpdate'
required: true
return_type: 'UserZipCode'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.user_profile.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/UserProfile.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/user_profile/UpdateMyZipCode.java'
example: |-
try {
final UpdateMyZipCode operation = UpdateMyZipCode.builder()
.build(
namespace,
userZipCodeUpdate,
);
final UserProfile wrapper = new UserProfile(sdk);
final UserZipCode response = wrapper.updateMyZipCode(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'code'
- 'my'
- 'profile'
- 'update'
- 'user'
- 'zip'
permissions:
- 'NAMESPACE:{namespace}:PROFILE [UPDATE]'
'UpdateNamespace@jv.basic.fun':
id: 'UpdateNamespace@jv.basic.fun'
name: 'UpdateNamespace'
type: 'function'
description: |-
Update namespace basic info.
displayName rule:
* Alphanumeric lowercase and uppercase are allowed
* Allowed Special Character: ',. -
* Must start and end with alphanumeric
* Spaces and special character are allowed but cannot appear twice in a row
Other detail info:
* Action code : 11302
* Returns : updated namespace
arguments:
'body':
type: 'NamespaceUpdate'
required: false
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
return_type: 'NamespaceInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.namespace.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/Namespace.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/namespace/UpdateNamespace.java'
example: |-
try {
final UpdateNamespace operation = UpdateNamespace.builder()
.body(...)
.build(
namespace,
);
final Namespace wrapper = new Namespace(sdk);
final NamespaceInfo response = wrapper.updateNamespace(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'namespace'
- 'update'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:NAMESPACE [UPDATE]'
'UpdatePrivateCustomAttributesPartially@jv.basic.fun':
id: 'UpdatePrivateCustomAttributesPartially@jv.basic.fun'
name: 'UpdatePrivateCustomAttributesPartially'
type: 'function'
description: |-
Update partially private custom attributes tied to the user id.
Other detail info:
* Action code : 11402
* Request body : allowed format: JSON object
* Returns : Updated custom attributes
arguments:
'body':
type: 'Map<String, ?>'
required: false
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
'userId':
type: 'String'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'Map<String, ?>'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.user_profile.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/UserProfile.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/user_profile/UpdatePrivateCustomAttributesPartially.java'
example: |-
try {
final UpdatePrivateCustomAttributesPartially operation = UpdatePrivateCustomAttributesPartially.builder()
.body(...)
.build(
namespace,
userId,
);
final UserProfile wrapper = new UserProfile(sdk);
final Map<String, ?> response = wrapper.updatePrivateCustomAttributesPartially(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'attributes'
- 'custom'
- 'partially'
- 'private'
- 'profile'
- 'update'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:PROFILE [UPDATE]'
'UpdateUserProfile@jv.basic.fun':
id: 'UpdateUserProfile@jv.basic.fun'
name: 'UpdateUserProfile'
type: 'function'
description: |-
Update user profile.
Other detail info:
* Action code : 11402
* Returns : Updated user profile
arguments:
'body':
type: 'UserProfileAdmin'
required: false
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
'userId':
type: 'String'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'UserProfilePrivateInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.user_profile.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/UserProfile.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/user_profile/UpdateUserProfile.java'
example: |-
try {
final UpdateUserProfile operation = UpdateUserProfile.builder()
.body(...)
.build(
namespace,
userId,
);
final UserProfile wrapper = new UserProfile(sdk);
final UserProfilePrivateInfo response = wrapper.updateUserProfile(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'profile'
- 'update'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:PROFILE [UPDATE]'
'UpdateUserProfileStatus@jv.basic.fun':
id: 'UpdateUserProfileStatus@jv.basic.fun'
name: 'UpdateUserProfileStatus'
type: 'function'
description: |-
Update user profile status.
Other detail info:
* Action code : 11406
* Returns : user profile
arguments:
'body':
type: 'UserProfileStatusUpdate'
required: false
'namespace':
type: 'String'
required: true
description: |-
namespace, only accept alphabet and numeric
'userId':
type: 'String'
required: true
description: |-
user's id, should follow UUID version 4 without hyphen
return_type: 'UserProfilePrivateInfo'
imports:
- 'import net.accelbyte.sdk.core.*;'
- 'import net.accelbyte.sdk.api.basic.models.*;'
- 'import net.accelbyte.sdk.api.basic.operations.user_profile.*;'
- 'import net.accelbyte.sdk.api.basic.wrappers.*;'
files:
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/wrappers/UserProfile.java'
- 'https://github.com/AccelByte/accelbyte-java-sdk/blob/main/src/main/java/net/accelbyte/sdk/api/basic/operations/user_profile/UpdateUserProfileStatus.java'
example: |-
try {
final UpdateUserProfileStatus operation = UpdateUserProfileStatus.builder()
.body(...)
.build(
namespace,
userId,
);
final UserProfile wrapper = new UserProfile(sdk);
final UserProfilePrivateInfo response = wrapper.updateUserProfileStatus(operation);
}
catch (HttpResponseException e) { /* Handle exceptions. */ }
catch (Exception e) { /* Handle exceptions. */ }
tags:
- 'profile'
- 'status'
- 'update'
- 'user'
permissions:
- 'ADMIN:NAMESPACE:{namespace}:USER:{userId}:PROFILE [UPDATE]'
# endregion functions
