v0.7.0: public domain types in rudder, hide OpenAPI names from callers
CI / build (push) Successful in 51s
CI / build (push) Successful in 51s
This commit is contained in:
@@ -41,6 +41,9 @@ if err != nil {
|
||||
players, err := client.Players.List(ctx, rudder.ListPlayersParameters{Limit: 100})
|
||||
```
|
||||
|
||||
Публичные типы живут в пакете `rudder`. Пакет `models` — сгенерированный
|
||||
wire-формат, в прикладном коде его импортировать не нужно.
|
||||
|
||||
## Handles
|
||||
|
||||
`client.Player(id)` и `client.Leaderboard(slug)` создают handle без
|
||||
@@ -87,13 +90,13 @@ err = player.Delete(ctx, "")
|
||||
board := client.Leaderboard("weekly")
|
||||
|
||||
entries, err := board.List(ctx, rudder.ListLeaderboardEntriesParameters{Limit: 100})
|
||||
// entries.Entries []models.RankEntry, entries.NextCursor
|
||||
// entries.Entries []rudder.Rank, entries.NextCursor
|
||||
|
||||
entry, err := board.Get(ctx, "p1") // *models.RankEntry с rank
|
||||
around, err := board.GetAround(ctx, "p1", 10) // []models.RankEntry вокруг игрока
|
||||
entry, err := board.Get(ctx, "p1") // *rudder.Rank с rank
|
||||
around, err := board.GetAround(ctx, "p1", 10) // []rudder.Rank вокруг игрока
|
||||
|
||||
err = board.Submit(ctx, []models.BatchLeaderboardEntry{{PlayerID: "p1", Score: 1500}})
|
||||
err = board.Update(ctx, []models.BatchLeaderboardEntry{{PlayerID: "p1", Score: 1600}})
|
||||
err = board.Submit(ctx, []rudder.LeaderboardScore{{PlayerID: "p1", Score: 1500}})
|
||||
err = board.Update(ctx, []rudder.LeaderboardScore{{PlayerID: "p1", Score: 1600}})
|
||||
err = board.Delete(ctx, []string{"p1", "p2"})
|
||||
```
|
||||
|
||||
@@ -106,52 +109,52 @@ err = board.Delete(ctx, []string{"p1", "p2"})
|
||||
```go
|
||||
wallets, err := client.Wallet.Adjust(ctx, rudder.AdjustWalletParameters{
|
||||
IdempotencyKey: "grant-001",
|
||||
Items: []models.BatchAdjustPlayerWalletsItem{
|
||||
Items: []rudder.WalletAdjustment{
|
||||
{PlayerID: "p1", CurrencyCode: "coins", Amount: 100, Reason: "compensation"},
|
||||
{PlayerID: "p2", CurrencyCode: "coins", Amount: 100, Reason: "compensation"},
|
||||
},
|
||||
})
|
||||
|
||||
items, err := client.Inventory.Adjust(ctx, rudder.AdjustInventoryParameters{
|
||||
Items: []models.BatchAdjustPlayerInventoryItemsItem{
|
||||
Items: []rudder.InventoryAdjustment{
|
||||
{PlayerID: "p1", Slug: "sword", Amount: 1, Reason: "quest reward"},
|
||||
},
|
||||
})
|
||||
|
||||
updated, err := client.Players.Update(ctx, rudder.UpdatePlayersParameters{
|
||||
Items: []models.BatchUpdatePlayersItem{
|
||||
Items: []rudder.PlayerUpdate{
|
||||
{PlayerID: "p1", Nickname: "Neo"},
|
||||
},
|
||||
})
|
||||
|
||||
banned, err := client.Players.Ban(ctx, rudder.BanPlayersParameters{
|
||||
Items: []models.BatchBanPlayersItem{
|
||||
Items: []rudder.PlayerBan{
|
||||
{PlayerID: "p2", Reason: "cheating", BannedUntil: "2030-01-01T00:00:00Z"},
|
||||
},
|
||||
})
|
||||
|
||||
unbanned, err := client.Players.Unban(ctx, rudder.UnbanPlayersParameters{
|
||||
Items: []models.BatchPlayerItem{{PlayerID: "p2"}},
|
||||
PlayerIDs: []string{"p2"},
|
||||
})
|
||||
|
||||
err = client.Players.Delete(ctx, rudder.DeletePlayersParameters{
|
||||
Items: []models.BatchPlayerItem{{PlayerID: "p3"}},
|
||||
PlayerIDs: []string{"p3"},
|
||||
})
|
||||
|
||||
err = client.Quests.Reset(ctx, rudder.ResetPlayerQuestsParameters{
|
||||
Items: []models.BatchPlayerQuestsItem{
|
||||
err = client.Quests.Reset(ctx, rudder.PlayerQuestsParameters{
|
||||
Items: []rudder.PlayerQuestRef{
|
||||
{PlayerID: "p1", QuestID: "daily-1"},
|
||||
},
|
||||
})
|
||||
// ForceComplete и ForceClaim — аналогично
|
||||
|
||||
err = client.Leaderboards.Submit(ctx, "weekly", []models.BatchLeaderboardEntry{
|
||||
err = client.Leaderboards.Submit(ctx, "weekly", []rudder.LeaderboardScore{
|
||||
{PlayerID: "p1", Score: 1500},
|
||||
})
|
||||
// Update и Delete — аналогично
|
||||
|
||||
err = client.Storage.Upsert(ctx, rudder.UpsertStorageParameters{
|
||||
Items: []models.AdminProjectStorageItem{
|
||||
Items: []rudder.ProjectStorageInput{
|
||||
{Type: "config", Data: `{"event":"x2"}`},
|
||||
},
|
||||
})
|
||||
@@ -168,24 +171,24 @@ err = client.Storage.Delete(ctx, rudder.DeleteStorageParameters{
|
||||
|
||||
```go
|
||||
boards, err := client.Leaderboards.List(ctx, rudder.ListLeaderboardsParameters{Limit: 100})
|
||||
// boards.Items []models.LeaderboardDefinition, boards.NextCursor
|
||||
// boards.Items []rudder.Leaderboard, boards.NextCursor
|
||||
|
||||
quests, err := client.Quests.List(ctx, rudder.ListQuestsParameters{
|
||||
Status: &status, // "active" или "archived", optional
|
||||
Limit: 100,
|
||||
})
|
||||
// quests.Items []models.QuestDefinition, quests.NextCursor
|
||||
// quests.Items []rudder.Quest, quests.NextCursor
|
||||
|
||||
history, err := client.Wallet.History(ctx, playerID, rudder.WalletHistoryParameters{
|
||||
Currency: ¤cy, // optional
|
||||
Limit: 50,
|
||||
})
|
||||
// history.Entries []models.WalletAudit, history.NextCursor
|
||||
// history.Entries []rudder.WalletTransaction, history.NextCursor
|
||||
|
||||
inventory, err := client.Inventory.List(ctx, playerID, rudder.ListInventoryParameters{
|
||||
Limit: 50,
|
||||
})
|
||||
// inventory.Items []models.InventoryItem, inventory.NextCursor
|
||||
// inventory.Items []rudder.InventoryItem, inventory.NextCursor
|
||||
|
||||
storage, err := client.Storage.List(ctx, rudder.ListStorageParameters{
|
||||
Limit: 100,
|
||||
@@ -209,3 +212,4 @@ if errors.As(err, &apiErr) {
|
||||
|
||||
`models/` генерируется apigen'ом из `liveops-gateway/openapi.yaml`
|
||||
(`make generate-openapi` в liveops-gateway). Руками не править.
|
||||
Публичные имена — aliases в корне пакета `rudder` (`types.go`).
|
||||
|
||||
Reference in New Issue
Block a user