Skip to content

Latest commit

 

History

History
131 lines (119 loc) · 26.9 KB

basic.md

File metadata and controls

131 lines (119 loc) · 26.9 KB

Basic Service Index

 

Operations

Namespace Wrapper: Namespace

Endpoint Method ID Class Wrapper Example
/basic/v1/admin/namespaces GET GetNamespacesShort GetNamespacesShort GetNamespacesShort GetNamespacesShort
/basic/v1/admin/namespaces POST CreateNamespaceShort CreateNamespaceShort CreateNamespaceShort CreateNamespaceShort
/basic/v1/admin/namespaces/{namespace} GET GetNamespaceShort GetNamespaceShort GetNamespaceShort GetNamespaceShort
/basic/v1/admin/namespaces/{namespace} DELETE DeleteNamespaceShort DeleteNamespaceShort DeleteNamespaceShort DeleteNamespaceShort
/basic/v1/admin/namespaces/{namespace}/basic PATCH UpdateNamespaceShort UpdateNamespaceShort UpdateNamespaceShort UpdateNamespaceShort
/basic/v1/admin/namespaces/{namespace}/child GET GetChildNamespacesShort GetChildNamespacesShort GetChildNamespacesShort GetChildNamespacesShort
/basic/v1/admin/namespaces/{namespace}/context GET GetNamespaceContextShort GetNamespaceContextShort GetNamespaceContextShort GetNamespaceContextShort
/basic/v1/admin/namespaces/{namespace}/game GET GetGameNamespacesShort GetGameNamespacesShort GetGameNamespacesShort GetGameNamespacesShort
/basic/v1/admin/namespaces/{namespace}/publisher GET GetNamespacePublisherShort GetNamespacePublisherShort GetNamespacePublisherShort GetNamespacePublisherShort
/basic/v1/admin/namespaces/{namespace}/status PATCH ChangeNamespaceStatusShort ChangeNamespaceStatusShort ChangeNamespaceStatusShort ChangeNamespaceStatusShort
/basic/v1/public/namespaces GET PublicGetNamespacesShort PublicGetNamespacesShort PublicGetNamespacesShort PublicGetNamespacesShort
/basic/v1/public/namespaces/{namespace} GET GetNamespace1Short GetNamespace1Short GetNamespace1Short GetNamespace1Short
/basic/v1/public/namespaces/{namespace}/publisher GET PublicGetNamespacePublisherShort PublicGetNamespacePublisherShort PublicGetNamespacePublisherShort PublicGetNamespacePublisherShort

Config Wrapper: Config

Endpoint Method ID Class Wrapper Example
/basic/v1/admin/namespaces/{namespace}/configs POST CreateConfigShort CreateConfigShort CreateConfigShort CreateConfigShort
/basic/v1/admin/namespaces/{namespace}/configs/{configKey} GET GetConfigShort GetConfigShort GetConfigShort GetConfigShort
/basic/v1/admin/namespaces/{namespace}/configs/{configKey} DELETE DeleteConfigShort DeleteConfigShort DeleteConfigShort DeleteConfigShort
/basic/v1/admin/namespaces/{namespace}/configs/{configKey} PATCH UpdateConfigShort UpdateConfigShort UpdateConfigShort UpdateConfigShort
/basic/v1/admin/namespaces/{namespace}/publisher/configs/{configKey} GET GetPublisherConfigShort GetPublisherConfigShort GetPublisherConfigShort GetPublisherConfigShort

FileUpload Wrapper: FileUpload

Endpoint Method ID Class Wrapper Example
/basic/v1/admin/namespaces/{namespace}/folders/{folder}/files POST GeneratedUploadUrlShort GeneratedUploadUrlShort GeneratedUploadUrlShort GeneratedUploadUrlShort
/basic/v1/admin/namespaces/{namespace}/users/{userId}/files POST GeneratedUserUploadContentUrlShort GeneratedUserUploadContentUrlShort GeneratedUserUploadContentUrlShort GeneratedUserUploadContentUrlShort
/basic/v1/public/namespaces/{namespace}/folders/{folder}/files POST PublicGeneratedUploadUrlShort PublicGeneratedUploadUrlShort PublicGeneratedUploadUrlShort PublicGeneratedUploadUrlShort
/basic/v1/public/namespaces/{namespace}/users/{userId}/files POST PublicGeneratedUserUploadContentUrlShort PublicGeneratedUserUploadContentUrlShort PublicGeneratedUserUploadContentUrlShort PublicGeneratedUserUploadContentUrlShort

Misc Wrapper: Misc

Endpoint Method ID Class Wrapper Example
[DEPRECATED] /basic/v1/admin/namespaces/{namespace}/misc/countries GET GetCountriesShort GetCountriesShort GetCountriesShort GetCountriesShort
/basic/v1/admin/namespaces/{namespace}/misc/countrygroups GET GetCountryGroupsShort GetCountryGroupsShort GetCountryGroupsShort GetCountryGroupsShort
/basic/v1/admin/namespaces/{namespace}/misc/countrygroups POST AddCountryGroupShort AddCountryGroupShort AddCountryGroupShort AddCountryGroupShort
/basic/v1/admin/namespaces/{namespace}/misc/countrygroups/{countryGroupCode} PUT UpdateCountryGroupShort UpdateCountryGroupShort UpdateCountryGroupShort UpdateCountryGroupShort
/basic/v1/admin/namespaces/{namespace}/misc/countrygroups/{countryGroupCode} DELETE DeleteCountryGroupShort DeleteCountryGroupShort DeleteCountryGroupShort DeleteCountryGroupShort
/basic/v1/admin/namespaces/{namespace}/misc/languages GET GetLanguagesShort GetLanguagesShort GetLanguagesShort GetLanguagesShort
/basic/v1/admin/namespaces/{namespace}/misc/timezones GET GetTimeZonesShort GetTimeZonesShort GetTimeZonesShort GetTimeZonesShort
/basic/v1/public/misc/time GET PublicGetTimeShort PublicGetTimeShort PublicGetTimeShort PublicGetTimeShort
[DEPRECATED] /basic/v1/public/namespaces/{namespace}/misc/countries GET PublicGetCountriesShort PublicGetCountriesShort PublicGetCountriesShort PublicGetCountriesShort
/basic/v1/public/namespaces/{namespace}/misc/languages GET PublicGetLanguagesShort PublicGetLanguagesShort PublicGetLanguagesShort PublicGetLanguagesShort
/basic/v1/public/namespaces/{namespace}/misc/timezones GET PublicGetTimeZonesShort PublicGetTimeZonesShort PublicGetTimeZonesShort PublicGetTimeZonesShort

UserProfile Wrapper: UserProfile

Endpoint Method ID Class Wrapper Example
/basic/v1/admin/namespaces/{namespace}/profiles/byPublicId GET GetUserProfileInfoByPublicIdShort GetUserProfileInfoByPublicIdShort GetUserProfileInfoByPublicIdShort GetUserProfileInfoByPublicIdShort
/basic/v1/admin/namespaces/{namespace}/profiles/public POST AdminGetUserProfilePublicInfoByIdsShort AdminGetUserProfilePublicInfoByIdsShort AdminGetUserProfilePublicInfoByIdsShort AdminGetUserProfilePublicInfoByIdsShort
/basic/v1/admin/namespaces/{namespace}/users/{userId}/profiles GET GetUserProfileInfoShort GetUserProfileInfoShort GetUserProfileInfoShort GetUserProfileInfoShort
/basic/v1/admin/namespaces/{namespace}/users/{userId}/profiles PUT UpdateUserProfileShort UpdateUserProfileShort UpdateUserProfileShort UpdateUserProfileShort
/basic/v1/admin/namespaces/{namespace}/users/{userId}/profiles DELETE DeleteUserProfileShort DeleteUserProfileShort DeleteUserProfileShort DeleteUserProfileShort
/basic/v1/admin/namespaces/{namespace}/users/{userId}/profiles/customAttributes GET GetCustomAttributesInfoShort GetCustomAttributesInfoShort GetCustomAttributesInfoShort GetCustomAttributesInfoShort
/basic/v1/admin/namespaces/{namespace}/users/{userId}/profiles/customAttributes PUT UpdateCustomAttributesPartiallyShort UpdateCustomAttributesPartiallyShort UpdateCustomAttributesPartiallyShort UpdateCustomAttributesPartiallyShort
/basic/v1/admin/namespaces/{namespace}/users/{userId}/profiles/privateCustomAttributes GET GetPrivateCustomAttributesInfoShort GetPrivateCustomAttributesInfoShort GetPrivateCustomAttributesInfoShort GetPrivateCustomAttributesInfoShort
/basic/v1/admin/namespaces/{namespace}/users/{userId}/profiles/privateCustomAttributes PUT UpdatePrivateCustomAttributesPartiallyShort UpdatePrivateCustomAttributesPartiallyShort UpdatePrivateCustomAttributesPartiallyShort UpdatePrivateCustomAttributesPartiallyShort
/basic/v1/admin/namespaces/{namespace}/users/{userId}/profiles/status PATCH UpdateUserProfileStatusShort UpdateUserProfileStatusShort UpdateUserProfileStatusShort UpdateUserProfileStatusShort
/basic/v1/public/namespaces/{namespace}/profiles/public GET PublicGetUserProfilePublicInfoByIdsShort PublicGetUserProfilePublicInfoByIdsShort PublicGetUserProfilePublicInfoByIdsShort PublicGetUserProfilePublicInfoByIdsShort
/basic/v1/public/namespaces/{namespace}/profiles/public POST PublicBulkGetUserProfilePublicInfoShort PublicBulkGetUserProfilePublicInfoShort PublicBulkGetUserProfilePublicInfoShort PublicBulkGetUserProfilePublicInfoShort
/basic/v1/public/namespaces/{namespace}/profiles/public/byPublicId GET PublicGetUserProfileInfoByPublicIdShort PublicGetUserProfileInfoByPublicIdShort PublicGetUserProfileInfoByPublicIdShort PublicGetUserProfileInfoByPublicIdShort
/basic/v1/public/namespaces/{namespace}/users/me/profiles GET GetMyProfileInfoShort GetMyProfileInfoShort GetMyProfileInfoShort GetMyProfileInfoShort
/basic/v1/public/namespaces/{namespace}/users/me/profiles PUT UpdateMyProfileShort UpdateMyProfileShort UpdateMyProfileShort UpdateMyProfileShort
/basic/v1/public/namespaces/{namespace}/users/me/profiles POST CreateMyProfileShort CreateMyProfileShort CreateMyProfileShort CreateMyProfileShort
/basic/v1/public/namespaces/{namespace}/users/me/profiles/privateCustomAttributes GET GetMyPrivateCustomAttributesInfoShort GetMyPrivateCustomAttributesInfoShort GetMyPrivateCustomAttributesInfoShort GetMyPrivateCustomAttributesInfoShort
/basic/v1/public/namespaces/{namespace}/users/me/profiles/privateCustomAttributes PUT UpdateMyPrivateCustomAttributesPartiallyShort UpdateMyPrivateCustomAttributesPartiallyShort UpdateMyPrivateCustomAttributesPartiallyShort UpdateMyPrivateCustomAttributesPartiallyShort
/basic/v1/public/namespaces/{namespace}/users/me/profiles/zipCode GET GetMyZipCodeShort GetMyZipCodeShort GetMyZipCodeShort GetMyZipCodeShort
/basic/v1/public/namespaces/{namespace}/users/me/profiles/zipCode PATCH UpdateMyZipCodeShort UpdateMyZipCodeShort UpdateMyZipCodeShort UpdateMyZipCodeShort
/basic/v1/public/namespaces/{namespace}/users/{userId}/profiles GET PublicGetUserProfileInfoShort PublicGetUserProfileInfoShort PublicGetUserProfileInfoShort PublicGetUserProfileInfoShort
/basic/v1/public/namespaces/{namespace}/users/{userId}/profiles PUT PublicUpdateUserProfileShort PublicUpdateUserProfileShort PublicUpdateUserProfileShort PublicUpdateUserProfileShort
/basic/v1/public/namespaces/{namespace}/users/{userId}/profiles POST PublicCreateUserProfileShort PublicCreateUserProfileShort PublicCreateUserProfileShort PublicCreateUserProfileShort
/basic/v1/public/namespaces/{namespace}/users/{userId}/profiles/customAttributes GET PublicGetCustomAttributesInfoShort PublicGetCustomAttributesInfoShort PublicGetCustomAttributesInfoShort PublicGetCustomAttributesInfoShort
/basic/v1/public/namespaces/{namespace}/users/{userId}/profiles/customAttributes PUT PublicUpdateCustomAttributesPartiallyShort PublicUpdateCustomAttributesPartiallyShort PublicUpdateCustomAttributesPartiallyShort PublicUpdateCustomAttributesPartiallyShort
/basic/v1/public/namespaces/{namespace}/users/{userId}/profiles/public GET PublicGetUserProfilePublicInfoShort PublicGetUserProfilePublicInfoShort PublicGetUserProfilePublicInfoShort PublicGetUserProfilePublicInfoShort
/basic/v1/public/namespaces/{namespace}/users/{userId}/profiles/status PATCH PublicUpdateUserProfileStatusShort PublicUpdateUserProfileStatusShort PublicUpdateUserProfileStatusShort PublicUpdateUserProfileStatusShort

Anonymization Wrapper: Anonymization

Endpoint Method ID Class Wrapper Example
/basic/v1/admin/namespaces/{namespace}/users/{userId}/anonymization/profiles DELETE AnonymizeUserProfileShort AnonymizeUserProfileShort AnonymizeUserProfileShort AnonymizeUserProfileShort

 

Models

Model Struct Class
AddCountryGroupRequest AddCountryGroupRequest
AddCountryGroupResponse AddCountryGroupResponse
ConfigCreate ConfigCreate
ConfigInfo ConfigInfo
ConfigUpdate ConfigUpdate
CountryGroupObject CountryGroupObject
CountryObject CountryObject
ErrorEntity ErrorEntity
FieldValidationError FieldValidationError
FileUploadUrlInfo FileUploadUrlInfo
NamespaceContext NamespaceContext
NamespaceCreate NamespaceCreate
NamespaceInfo NamespaceInfo
NamespacePublisherInfo NamespacePublisherInfo
NamespaceSimpleInfo NamespaceSimpleInfo
NamespaceStatusUpdate NamespaceStatusUpdate
NamespaceUpdate NamespaceUpdate
Permission Permission
RetrieveCountryGroupResponse RetrieveCountryGroupResponse
RetrieveTimeResponse RetrieveTimeResponse
UpdateCountryGroupRequest UpdateCountryGroupRequest
UserProfileAdmin UserProfileAdmin
UserProfileBulkRequest UserProfileBulkRequest
UserProfileCreate UserProfileCreate
UserProfileInfo UserProfileInfo
UserProfilePrivateCreate UserProfilePrivateCreate
UserProfilePrivateInfo UserProfilePrivateInfo
UserProfilePublicInfo UserProfilePublicInfo
UserProfileStatusUpdate UserProfileStatusUpdate
UserProfileUpdate UserProfileUpdate
UserZipCode UserZipCode
UserZipCodeUpdate UserZipCodeUpdate
ValidationErrorEntity ValidationErrorEntity