trophy_api_client 1.27.0 → 1.29.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/trophy/admin/client.rb +5 -0
- data/lib/trophy/admin/rewards/client.rb +207 -0
- data/lib/trophy/admin/rewards/triggers/client.rb +209 -0
- data/lib/trophy/admin/rewards/triggers/types/triggers_delete_request.rb +17 -0
- data/lib/trophy/admin/rewards/triggers/types/triggers_list_request.rb +19 -0
- data/lib/trophy/admin/rewards/types/rewards_delete_request.rb +13 -0
- data/lib/trophy/admin/rewards/types/rewards_list_request.rb +15 -0
- data/lib/trophy/client.rb +6 -1
- data/lib/trophy/rewards/client.rb +57 -0
- data/lib/trophy/rewards/types/rewards_redeem_request.rb +13 -0
- data/lib/trophy/types/achievement_completion_response.rb +4 -0
- data/lib/trophy/types/admin_reward.rb +28 -0
- data/lib/trophy/types/admin_reward_status.rb +12 -0
- data/lib/trophy/types/admin_reward_trigger.rb +30 -0
- data/lib/trophy/types/admin_reward_trigger_event_attributes_item.rb +11 -0
- data/lib/trophy/types/admin_reward_trigger_status.rb +12 -0
- data/lib/trophy/types/admin_reward_trigger_type.rb +14 -0
- data/lib/trophy/types/admin_reward_trigger_user_attributes_item.rb +11 -0
- data/lib/trophy/types/admin_reward_type.rb +12 -0
- data/lib/trophy/types/admin_reward_user_attributes_item.rb +11 -0
- data/lib/trophy/types/create_reward_request_item.rb +28 -0
- data/lib/trophy/types/create_reward_request_item_status.rb +12 -0
- data/lib/trophy/types/create_reward_request_item_type.rb +12 -0
- data/lib/trophy/types/create_reward_request_item_user_attributes_item.rb +11 -0
- data/lib/trophy/types/create_reward_trigger_request_item.rb +28 -0
- data/lib/trophy/types/create_reward_trigger_request_item_event_attributes_item.rb +11 -0
- data/lib/trophy/types/create_reward_trigger_request_item_status.rb +12 -0
- data/lib/trophy/types/create_reward_trigger_request_item_type.rb +14 -0
- data/lib/trophy/types/create_reward_trigger_request_item_user_attributes_item.rb +11 -0
- data/lib/trophy/types/create_reward_triggers_request.rb +23 -0
- data/lib/trophy/types/create_reward_triggers_response.rb +12 -0
- data/lib/trophy/types/create_rewards_request.rb +23 -0
- data/lib/trophy/types/create_rewards_response.rb +12 -0
- data/lib/trophy/types/created_admin_reward.rb +31 -0
- data/lib/trophy/types/delete_reward_triggers_response.rb +12 -0
- data/lib/trophy/types/delete_rewards_response.rb +12 -0
- data/lib/trophy/types/event_response.rb +2 -0
- data/lib/trophy/types/list_reward_triggers_response.rb +23 -0
- data/lib/trophy/types/list_rewards_response.rb +23 -0
- data/lib/trophy/types/points_trigger.rb +4 -0
- data/lib/trophy/types/points_trigger_type.rb +1 -0
- data/lib/trophy/types/redeem_reward_response.rb +15 -0
- data/lib/trophy/types/redeemed_reward.rb +13 -0
- data/lib/trophy/types/reward_summary.rb +23 -0
- data/lib/trophy/types/reward_summary_type.rb +12 -0
- data/lib/trophy/types/reward_webhook_event.rb +17 -0
- data/lib/trophy/types/reward_webhook_event_redemption.rb +17 -0
- data/lib/trophy/types/reward_webhook_event_type.rb +12 -0
- data/lib/trophy/types/update_reward_request_item.rb +27 -0
- data/lib/trophy/types/update_reward_request_item_status.rb +12 -0
- data/lib/trophy/types/update_reward_request_item_type.rb +12 -0
- data/lib/trophy/types/update_reward_request_item_user_attributes_item.rb +11 -0
- data/lib/trophy/types/update_reward_triggers_request.rb +23 -0
- data/lib/trophy/types/update_reward_triggers_request_item.rb +29 -0
- data/lib/trophy/types/update_reward_triggers_request_item_event_attributes_item.rb +11 -0
- data/lib/trophy/types/update_reward_triggers_request_item_status.rb +12 -0
- data/lib/trophy/types/update_reward_triggers_request_item_type.rb +14 -0
- data/lib/trophy/types/update_reward_triggers_request_item_user_attributes_item.rb +11 -0
- data/lib/trophy/types/update_reward_triggers_response.rb +12 -0
- data/lib/trophy/types/update_rewards_request.rb +23 -0
- data/lib/trophy/types/update_rewards_response.rb +12 -0
- data/lib/trophy/types/user.rb +2 -0
- data/lib/trophy/types/user_reward_response.rb +19 -0
- data/lib/trophy/types/user_reward_trigger.rb +25 -0
- data/lib/trophy/types/user_reward_trigger_type.rb +14 -0
- data/lib/trophy/users/client.rb +45 -0
- data/lib/trophy/users/types/users_rewards_request.rb +21 -0
- data/lib/trophy/version.rb +1 -1
- data/lib/trophy.rb +59 -0
- data/reference.md +1274 -368
- metadata +60 -1
data/reference.md
CHANGED
|
@@ -136,6 +136,82 @@ client.achievements.complete(
|
|
|
136
136
|
</dl>
|
|
137
137
|
|
|
138
138
|
|
|
139
|
+
</dd>
|
|
140
|
+
</dl>
|
|
141
|
+
</details>
|
|
142
|
+
|
|
143
|
+
## Rewards
|
|
144
|
+
<details><summary><code>client.rewards.<a href="/lib/trophy/rewards/client.rb">redeem</a>(key, request) -> Trophy::Types::RedeemRewardResponse</code></summary>
|
|
145
|
+
<dl>
|
|
146
|
+
<dd>
|
|
147
|
+
|
|
148
|
+
#### 📝 Description
|
|
149
|
+
|
|
150
|
+
<dl>
|
|
151
|
+
<dd>
|
|
152
|
+
|
|
153
|
+
<dl>
|
|
154
|
+
<dd>
|
|
155
|
+
|
|
156
|
+
Redeem a reward for a user.
|
|
157
|
+
</dd>
|
|
158
|
+
</dl>
|
|
159
|
+
</dd>
|
|
160
|
+
</dl>
|
|
161
|
+
|
|
162
|
+
#### 🔌 Usage
|
|
163
|
+
|
|
164
|
+
<dl>
|
|
165
|
+
<dd>
|
|
166
|
+
|
|
167
|
+
<dl>
|
|
168
|
+
<dd>
|
|
169
|
+
|
|
170
|
+
```ruby
|
|
171
|
+
client.rewards.redeem(
|
|
172
|
+
key: "key",
|
|
173
|
+
user: {
|
|
174
|
+
id: "user-id"
|
|
175
|
+
}
|
|
176
|
+
)
|
|
177
|
+
```
|
|
178
|
+
</dd>
|
|
179
|
+
</dl>
|
|
180
|
+
</dd>
|
|
181
|
+
</dl>
|
|
182
|
+
|
|
183
|
+
#### ⚙️ Parameters
|
|
184
|
+
|
|
185
|
+
<dl>
|
|
186
|
+
<dd>
|
|
187
|
+
|
|
188
|
+
<dl>
|
|
189
|
+
<dd>
|
|
190
|
+
|
|
191
|
+
**key:** `String` — The key of the reward to redeem.
|
|
192
|
+
|
|
193
|
+
</dd>
|
|
194
|
+
</dl>
|
|
195
|
+
|
|
196
|
+
<dl>
|
|
197
|
+
<dd>
|
|
198
|
+
|
|
199
|
+
**user:** `Trophy::Types::UpsertedUser` — The user redeeming the reward. The user must already exist.
|
|
200
|
+
|
|
201
|
+
</dd>
|
|
202
|
+
</dl>
|
|
203
|
+
|
|
204
|
+
<dl>
|
|
205
|
+
<dd>
|
|
206
|
+
|
|
207
|
+
**request_options:** `Trophy::Rewards::RequestOptions`
|
|
208
|
+
|
|
209
|
+
</dd>
|
|
210
|
+
</dl>
|
|
211
|
+
</dd>
|
|
212
|
+
</dl>
|
|
213
|
+
|
|
214
|
+
|
|
139
215
|
</dd>
|
|
140
216
|
</dl>
|
|
141
217
|
</details>
|
|
@@ -983,6 +1059,115 @@ client.users.achievements(
|
|
|
983
1059
|
</dl>
|
|
984
1060
|
|
|
985
1061
|
|
|
1062
|
+
</dd>
|
|
1063
|
+
</dl>
|
|
1064
|
+
</details>
|
|
1065
|
+
|
|
1066
|
+
<details><summary><code>client.users.<a href="/lib/trophy/users/client.rb">rewards</a>(id) -> Internal::Types::Array[Trophy::Types::UserRewardResponse]</code></summary>
|
|
1067
|
+
<dl>
|
|
1068
|
+
<dd>
|
|
1069
|
+
|
|
1070
|
+
#### 📝 Description
|
|
1071
|
+
|
|
1072
|
+
<dl>
|
|
1073
|
+
<dd>
|
|
1074
|
+
|
|
1075
|
+
<dl>
|
|
1076
|
+
<dd>
|
|
1077
|
+
|
|
1078
|
+
Get rewards awarded to a user. Filter by redeemed state and the date the reward was awarded.
|
|
1079
|
+
</dd>
|
|
1080
|
+
</dl>
|
|
1081
|
+
</dd>
|
|
1082
|
+
</dl>
|
|
1083
|
+
|
|
1084
|
+
#### 🔌 Usage
|
|
1085
|
+
|
|
1086
|
+
<dl>
|
|
1087
|
+
<dd>
|
|
1088
|
+
|
|
1089
|
+
<dl>
|
|
1090
|
+
<dd>
|
|
1091
|
+
|
|
1092
|
+
```ruby
|
|
1093
|
+
client.users.rewards(
|
|
1094
|
+
id: "id",
|
|
1095
|
+
redeemed: true,
|
|
1096
|
+
start_date: "startDate",
|
|
1097
|
+
end_date: "endDate",
|
|
1098
|
+
skip: 1,
|
|
1099
|
+
limit: 1
|
|
1100
|
+
)
|
|
1101
|
+
```
|
|
1102
|
+
</dd>
|
|
1103
|
+
</dl>
|
|
1104
|
+
</dd>
|
|
1105
|
+
</dl>
|
|
1106
|
+
|
|
1107
|
+
#### ⚙️ Parameters
|
|
1108
|
+
|
|
1109
|
+
<dl>
|
|
1110
|
+
<dd>
|
|
1111
|
+
|
|
1112
|
+
<dl>
|
|
1113
|
+
<dd>
|
|
1114
|
+
|
|
1115
|
+
**id:** `String` — The ID of the user in your database.
|
|
1116
|
+
|
|
1117
|
+
</dd>
|
|
1118
|
+
</dl>
|
|
1119
|
+
|
|
1120
|
+
<dl>
|
|
1121
|
+
<dd>
|
|
1122
|
+
|
|
1123
|
+
**redeemed:** `Internal::Types::Boolean` — When set, only return rewards that have or have not been redeemed.
|
|
1124
|
+
|
|
1125
|
+
</dd>
|
|
1126
|
+
</dl>
|
|
1127
|
+
|
|
1128
|
+
<dl>
|
|
1129
|
+
<dd>
|
|
1130
|
+
|
|
1131
|
+
**start_date:** `String` — Inclusive start of the awarded-at range, as YYYY-MM-DD in UTC.
|
|
1132
|
+
|
|
1133
|
+
</dd>
|
|
1134
|
+
</dl>
|
|
1135
|
+
|
|
1136
|
+
<dl>
|
|
1137
|
+
<dd>
|
|
1138
|
+
|
|
1139
|
+
**end_date:** `String` — Inclusive end of the awarded-at range, as YYYY-MM-DD in UTC.
|
|
1140
|
+
|
|
1141
|
+
</dd>
|
|
1142
|
+
</dl>
|
|
1143
|
+
|
|
1144
|
+
<dl>
|
|
1145
|
+
<dd>
|
|
1146
|
+
|
|
1147
|
+
**skip:** `Integer` — Number of rewards to skip. Defaults to 0.
|
|
1148
|
+
|
|
1149
|
+
</dd>
|
|
1150
|
+
</dl>
|
|
1151
|
+
|
|
1152
|
+
<dl>
|
|
1153
|
+
<dd>
|
|
1154
|
+
|
|
1155
|
+
**limit:** `Integer` — Maximum number of rewards to return. Defaults to 100 and cannot exceed 100.
|
|
1156
|
+
|
|
1157
|
+
</dd>
|
|
1158
|
+
</dl>
|
|
1159
|
+
|
|
1160
|
+
<dl>
|
|
1161
|
+
<dd>
|
|
1162
|
+
|
|
1163
|
+
**request_options:** `Trophy::Users::RequestOptions`
|
|
1164
|
+
|
|
1165
|
+
</dd>
|
|
1166
|
+
</dl>
|
|
1167
|
+
</dd>
|
|
1168
|
+
</dl>
|
|
1169
|
+
|
|
1170
|
+
|
|
986
1171
|
</dd>
|
|
987
1172
|
</dl>
|
|
988
1173
|
</details>
|
|
@@ -2712,8 +2897,8 @@ client.admin.achievements.get(id: "550e8400-e29b-41d4-a716-446655440000")
|
|
|
2712
2897
|
</dl>
|
|
2713
2898
|
</details>
|
|
2714
2899
|
|
|
2715
|
-
## Admin
|
|
2716
|
-
<details><summary><code>client.admin.
|
|
2900
|
+
## Admin Rewards
|
|
2901
|
+
<details><summary><code>client.admin.rewards.<a href="/lib/trophy/admin/rewards/client.rb">list</a>() -> Internal::Types::Array[Trophy::Types::AdminReward]</code></summary>
|
|
2717
2902
|
<dl>
|
|
2718
2903
|
<dd>
|
|
2719
2904
|
|
|
@@ -2725,7 +2910,7 @@ client.admin.achievements.get(id: "550e8400-e29b-41d4-a716-446655440000")
|
|
|
2725
2910
|
<dl>
|
|
2726
2911
|
<dd>
|
|
2727
2912
|
|
|
2728
|
-
List
|
|
2913
|
+
List rewards.
|
|
2729
2914
|
</dd>
|
|
2730
2915
|
</dl>
|
|
2731
2916
|
</dd>
|
|
@@ -2740,7 +2925,7 @@ List metrics.
|
|
|
2740
2925
|
<dd>
|
|
2741
2926
|
|
|
2742
2927
|
```ruby
|
|
2743
|
-
client.admin.
|
|
2928
|
+
client.admin.rewards.list(
|
|
2744
2929
|
limit: 1,
|
|
2745
2930
|
skip: 1
|
|
2746
2931
|
)
|
|
@@ -2774,7 +2959,7 @@ client.admin.metrics.list(
|
|
|
2774
2959
|
<dl>
|
|
2775
2960
|
<dd>
|
|
2776
2961
|
|
|
2777
|
-
**request_options:** `Trophy::Admin::
|
|
2962
|
+
**request_options:** `Trophy::Admin::Rewards::RequestOptions`
|
|
2778
2963
|
|
|
2779
2964
|
</dd>
|
|
2780
2965
|
</dl>
|
|
@@ -2786,7 +2971,7 @@ client.admin.metrics.list(
|
|
|
2786
2971
|
</dl>
|
|
2787
2972
|
</details>
|
|
2788
2973
|
|
|
2789
|
-
<details><summary><code>client.admin.
|
|
2974
|
+
<details><summary><code>client.admin.rewards.<a href="/lib/trophy/admin/rewards/client.rb">create</a>(request) -> Trophy::Types::CreateRewardsResponse</code></summary>
|
|
2790
2975
|
<dl>
|
|
2791
2976
|
<dd>
|
|
2792
2977
|
|
|
@@ -2798,7 +2983,7 @@ client.admin.metrics.list(
|
|
|
2798
2983
|
<dl>
|
|
2799
2984
|
<dd>
|
|
2800
2985
|
|
|
2801
|
-
Create
|
|
2986
|
+
Create rewards. Optionally include triggers in each reward payload to create them alongside the reward. A reward with any invalid trigger is not created.
|
|
2802
2987
|
</dd>
|
|
2803
2988
|
</dl>
|
|
2804
2989
|
</dd>
|
|
@@ -2813,14 +2998,19 @@ Create metrics.
|
|
|
2813
2998
|
<dd>
|
|
2814
2999
|
|
|
2815
3000
|
```ruby
|
|
2816
|
-
client.admin.
|
|
2817
|
-
name: "
|
|
2818
|
-
key: "
|
|
2819
|
-
|
|
2820
|
-
|
|
2821
|
-
|
|
2822
|
-
|
|
2823
|
-
|
|
3001
|
+
client.admin.rewards.create(request: [{
|
|
3002
|
+
name: "Welcome bonus",
|
|
3003
|
+
key: "welcome-bonus",
|
|
3004
|
+
description: "Points for finishing onboarding",
|
|
3005
|
+
type: "points",
|
|
3006
|
+
points_system_id: "660f9500-f30c-42e5-b827-557766550001",
|
|
3007
|
+
points: 100,
|
|
3008
|
+
max_redemptions: 1,
|
|
3009
|
+
triggers: [{
|
|
3010
|
+
type: "achievement",
|
|
3011
|
+
status: "active",
|
|
3012
|
+
achievement_id: "770a0600-a41d-43f6-c938-668877660002"
|
|
3013
|
+
}]
|
|
2824
3014
|
}])
|
|
2825
3015
|
```
|
|
2826
3016
|
</dd>
|
|
@@ -2836,7 +3026,7 @@ client.admin.metrics.create(request: [{
|
|
|
2836
3026
|
<dl>
|
|
2837
3027
|
<dd>
|
|
2838
3028
|
|
|
2839
|
-
**request:** `Internal::Types::Array[Trophy::Types::
|
|
3029
|
+
**request:** `Internal::Types::Array[Trophy::Types::CreateRewardRequestItem]`
|
|
2840
3030
|
|
|
2841
3031
|
</dd>
|
|
2842
3032
|
</dl>
|
|
@@ -2844,7 +3034,7 @@ client.admin.metrics.create(request: [{
|
|
|
2844
3034
|
<dl>
|
|
2845
3035
|
<dd>
|
|
2846
3036
|
|
|
2847
|
-
**request_options:** `Trophy::Admin::
|
|
3037
|
+
**request_options:** `Trophy::Admin::Rewards::RequestOptions`
|
|
2848
3038
|
|
|
2849
3039
|
</dd>
|
|
2850
3040
|
</dl>
|
|
@@ -2856,7 +3046,7 @@ client.admin.metrics.create(request: [{
|
|
|
2856
3046
|
</dl>
|
|
2857
3047
|
</details>
|
|
2858
3048
|
|
|
2859
|
-
<details><summary><code>client.admin.
|
|
3049
|
+
<details><summary><code>client.admin.rewards.<a href="/lib/trophy/admin/rewards/client.rb">delete</a>() -> Trophy::Types::DeleteRewardsResponse</code></summary>
|
|
2860
3050
|
<dl>
|
|
2861
3051
|
<dd>
|
|
2862
3052
|
|
|
@@ -2868,7 +3058,7 @@ client.admin.metrics.create(request: [{
|
|
|
2868
3058
|
<dl>
|
|
2869
3059
|
<dd>
|
|
2870
3060
|
|
|
2871
|
-
Delete
|
|
3061
|
+
Delete rewards by ID. Maximum 100 reward IDs per request. A deleted reward's triggers are deleted too.
|
|
2872
3062
|
</dd>
|
|
2873
3063
|
</dl>
|
|
2874
3064
|
</dd>
|
|
@@ -2883,7 +3073,7 @@ Delete metrics by ID.
|
|
|
2883
3073
|
<dd>
|
|
2884
3074
|
|
|
2885
3075
|
```ruby
|
|
2886
|
-
client.admin.
|
|
3076
|
+
client.admin.rewards.delete(ids: ["550e8400-e29b-41d4-a716-446655440000"])
|
|
2887
3077
|
```
|
|
2888
3078
|
</dd>
|
|
2889
3079
|
</dl>
|
|
@@ -2898,7 +3088,7 @@ client.admin.metrics.delete(ids: %w[550e8400-e29b-41d4-a716-446655440000 550e840
|
|
|
2898
3088
|
<dl>
|
|
2899
3089
|
<dd>
|
|
2900
3090
|
|
|
2901
|
-
**ids:** `String` —
|
|
3091
|
+
**ids:** `String` — Reward IDs to delete. Can be repeated or comma-separated.
|
|
2902
3092
|
|
|
2903
3093
|
</dd>
|
|
2904
3094
|
</dl>
|
|
@@ -2906,7 +3096,7 @@ client.admin.metrics.delete(ids: %w[550e8400-e29b-41d4-a716-446655440000 550e840
|
|
|
2906
3096
|
<dl>
|
|
2907
3097
|
<dd>
|
|
2908
3098
|
|
|
2909
|
-
**request_options:** `Trophy::Admin::
|
|
3099
|
+
**request_options:** `Trophy::Admin::Rewards::RequestOptions`
|
|
2910
3100
|
|
|
2911
3101
|
</dd>
|
|
2912
3102
|
</dl>
|
|
@@ -2918,7 +3108,7 @@ client.admin.metrics.delete(ids: %w[550e8400-e29b-41d4-a716-446655440000 550e840
|
|
|
2918
3108
|
</dl>
|
|
2919
3109
|
</details>
|
|
2920
3110
|
|
|
2921
|
-
<details><summary><code>client.admin.
|
|
3111
|
+
<details><summary><code>client.admin.rewards.<a href="/lib/trophy/admin/rewards/client.rb">update</a>(request) -> Trophy::Types::UpdateRewardsResponse</code></summary>
|
|
2922
3112
|
<dl>
|
|
2923
3113
|
<dd>
|
|
2924
3114
|
|
|
@@ -2930,7 +3120,7 @@ client.admin.metrics.delete(ids: %w[550e8400-e29b-41d4-a716-446655440000 550e840
|
|
|
2930
3120
|
<dl>
|
|
2931
3121
|
<dd>
|
|
2932
3122
|
|
|
2933
|
-
Update
|
|
3123
|
+
Update rewards by ID. Maximum 100 rewards per request. Only provided fields are updated; omitted fields are preserved. Use the reward triggers endpoints to change a reward's triggers.
|
|
2934
3124
|
</dd>
|
|
2935
3125
|
</dl>
|
|
2936
3126
|
</dd>
|
|
@@ -2945,14 +3135,10 @@ Update metrics by ID.
|
|
|
2945
3135
|
<dd>
|
|
2946
3136
|
|
|
2947
3137
|
```ruby
|
|
2948
|
-
client.admin.
|
|
3138
|
+
client.admin.rewards.update(request: [{
|
|
2949
3139
|
id: "550e8400-e29b-41d4-a716-446655440000",
|
|
2950
|
-
|
|
2951
|
-
|
|
2952
|
-
}, {
|
|
2953
|
-
id: "550e8400-e29b-41d4-a716-446655440001",
|
|
2954
|
-
unit_type: "number",
|
|
2955
|
-
units: "dollars"
|
|
3140
|
+
status: "active",
|
|
3141
|
+
points: 150
|
|
2956
3142
|
}])
|
|
2957
3143
|
```
|
|
2958
3144
|
</dd>
|
|
@@ -2968,7 +3154,7 @@ client.admin.metrics.update(request: [{
|
|
|
2968
3154
|
<dl>
|
|
2969
3155
|
<dd>
|
|
2970
3156
|
|
|
2971
|
-
**request:** `Internal::Types::Array[Trophy::Types::
|
|
3157
|
+
**request:** `Internal::Types::Array[Trophy::Types::UpdateRewardRequestItem]`
|
|
2972
3158
|
|
|
2973
3159
|
</dd>
|
|
2974
3160
|
</dl>
|
|
@@ -2976,7 +3162,7 @@ client.admin.metrics.update(request: [{
|
|
|
2976
3162
|
<dl>
|
|
2977
3163
|
<dd>
|
|
2978
3164
|
|
|
2979
|
-
**request_options:** `Trophy::Admin::
|
|
3165
|
+
**request_options:** `Trophy::Admin::Rewards::RequestOptions`
|
|
2980
3166
|
|
|
2981
3167
|
</dd>
|
|
2982
3168
|
</dl>
|
|
@@ -2988,7 +3174,7 @@ client.admin.metrics.update(request: [{
|
|
|
2988
3174
|
</dl>
|
|
2989
3175
|
</details>
|
|
2990
3176
|
|
|
2991
|
-
<details><summary><code>client.admin.
|
|
3177
|
+
<details><summary><code>client.admin.rewards.<a href="/lib/trophy/admin/rewards/client.rb">get</a>(id) -> Trophy::Types::AdminReward</code></summary>
|
|
2992
3178
|
<dl>
|
|
2993
3179
|
<dd>
|
|
2994
3180
|
|
|
@@ -3000,7 +3186,7 @@ client.admin.metrics.update(request: [{
|
|
|
3000
3186
|
<dl>
|
|
3001
3187
|
<dd>
|
|
3002
3188
|
|
|
3003
|
-
Get a
|
|
3189
|
+
Get a reward by ID.
|
|
3004
3190
|
</dd>
|
|
3005
3191
|
</dl>
|
|
3006
3192
|
</dd>
|
|
@@ -3015,7 +3201,7 @@ Get a metric by ID.
|
|
|
3015
3201
|
<dd>
|
|
3016
3202
|
|
|
3017
3203
|
```ruby
|
|
3018
|
-
client.admin.
|
|
3204
|
+
client.admin.rewards.get(id: "550e8400-e29b-41d4-a716-446655440000")
|
|
3019
3205
|
```
|
|
3020
3206
|
</dd>
|
|
3021
3207
|
</dl>
|
|
@@ -3030,7 +3216,7 @@ client.admin.metrics.get(id: "550e8400-e29b-41d4-a716-446655440000")
|
|
|
3030
3216
|
<dl>
|
|
3031
3217
|
<dd>
|
|
3032
3218
|
|
|
3033
|
-
**id:** `String` — The
|
|
3219
|
+
**id:** `String` — The ID of the reward.
|
|
3034
3220
|
|
|
3035
3221
|
</dd>
|
|
3036
3222
|
</dl>
|
|
@@ -3038,7 +3224,7 @@ client.admin.metrics.get(id: "550e8400-e29b-41d4-a716-446655440000")
|
|
|
3038
3224
|
<dl>
|
|
3039
3225
|
<dd>
|
|
3040
3226
|
|
|
3041
|
-
**request_options:** `Trophy::Admin::
|
|
3227
|
+
**request_options:** `Trophy::Admin::Rewards::RequestOptions`
|
|
3042
3228
|
|
|
3043
3229
|
</dd>
|
|
3044
3230
|
</dl>
|
|
@@ -3050,7 +3236,8 @@ client.admin.metrics.get(id: "550e8400-e29b-41d4-a716-446655440000")
|
|
|
3050
3236
|
</dl>
|
|
3051
3237
|
</details>
|
|
3052
3238
|
|
|
3053
|
-
|
|
3239
|
+
## Admin Metrics
|
|
3240
|
+
<details><summary><code>client.admin.metrics.<a href="/lib/trophy/admin/metrics/client.rb">list</a>() -> Internal::Types::Array[Trophy::Types::CreatedMetric]</code></summary>
|
|
3054
3241
|
<dl>
|
|
3055
3242
|
<dd>
|
|
3056
3243
|
|
|
@@ -3062,7 +3249,7 @@ client.admin.metrics.get(id: "550e8400-e29b-41d4-a716-446655440000")
|
|
|
3062
3249
|
<dl>
|
|
3063
3250
|
<dd>
|
|
3064
3251
|
|
|
3065
|
-
|
|
3252
|
+
List metrics.
|
|
3066
3253
|
</dd>
|
|
3067
3254
|
</dl>
|
|
3068
3255
|
</dd>
|
|
@@ -3077,24 +3264,10 @@ Submit up to 1,000 metric events for asynchronous processing.
|
|
|
3077
3264
|
<dd>
|
|
3078
3265
|
|
|
3079
3266
|
```ruby
|
|
3080
|
-
client.admin.metrics.
|
|
3081
|
-
|
|
3082
|
-
|
|
3083
|
-
|
|
3084
|
-
email: "user@example.com",
|
|
3085
|
-
tz: "Europe/London",
|
|
3086
|
-
attributes: {
|
|
3087
|
-
department: "engineering",
|
|
3088
|
-
role: "developer"
|
|
3089
|
-
}
|
|
3090
|
-
},
|
|
3091
|
-
value: 750,
|
|
3092
|
-
attributes: {
|
|
3093
|
-
category: "writing",
|
|
3094
|
-
source: "mobile-app"
|
|
3095
|
-
},
|
|
3096
|
-
idempotency_key: "e4296e4b-8493-4bd1-9c30-5a1a9ac4d78f"
|
|
3097
|
-
}])
|
|
3267
|
+
client.admin.metrics.list(
|
|
3268
|
+
limit: 1,
|
|
3269
|
+
skip: 1
|
|
3270
|
+
)
|
|
3098
3271
|
```
|
|
3099
3272
|
</dd>
|
|
3100
3273
|
</dl>
|
|
@@ -3109,7 +3282,15 @@ client.admin.metrics.batch_events(request: [{
|
|
|
3109
3282
|
<dl>
|
|
3110
3283
|
<dd>
|
|
3111
3284
|
|
|
3112
|
-
**
|
|
3285
|
+
**limit:** `Integer` — Number of records to return.
|
|
3286
|
+
|
|
3287
|
+
</dd>
|
|
3288
|
+
</dl>
|
|
3289
|
+
|
|
3290
|
+
<dl>
|
|
3291
|
+
<dd>
|
|
3292
|
+
|
|
3293
|
+
**skip:** `Integer` — Number of records to skip from the start of the list.
|
|
3113
3294
|
|
|
3114
3295
|
</dd>
|
|
3115
3296
|
</dl>
|
|
@@ -3129,8 +3310,7 @@ client.admin.metrics.batch_events(request: [{
|
|
|
3129
3310
|
</dl>
|
|
3130
3311
|
</details>
|
|
3131
3312
|
|
|
3132
|
-
|
|
3133
|
-
<details><summary><code>client.admin.leaderboards.<a href="/lib/trophy/admin/leaderboards/client.rb">list</a>() -> Internal::Types::Array[Trophy::Types::AdminLeaderboard]</code></summary>
|
|
3313
|
+
<details><summary><code>client.admin.metrics.<a href="/lib/trophy/admin/metrics/client.rb">create</a>(request) -> Trophy::Types::CreateMetricsResponse</code></summary>
|
|
3134
3314
|
<dl>
|
|
3135
3315
|
<dd>
|
|
3136
3316
|
|
|
@@ -3142,7 +3322,7 @@ client.admin.metrics.batch_events(request: [{
|
|
|
3142
3322
|
<dl>
|
|
3143
3323
|
<dd>
|
|
3144
3324
|
|
|
3145
|
-
|
|
3325
|
+
Create metrics.
|
|
3146
3326
|
</dd>
|
|
3147
3327
|
</dl>
|
|
3148
3328
|
</dd>
|
|
@@ -3157,7 +3337,15 @@ List leaderboards.
|
|
|
3157
3337
|
<dd>
|
|
3158
3338
|
|
|
3159
3339
|
```ruby
|
|
3160
|
-
client.
|
|
3340
|
+
client.admin.metrics.create(request: [{
|
|
3341
|
+
name: "Invites Sent",
|
|
3342
|
+
key: "invites-sent"
|
|
3343
|
+
}, {
|
|
3344
|
+
name: "Revenue",
|
|
3345
|
+
key: "revenue",
|
|
3346
|
+
unit_type: "currency",
|
|
3347
|
+
units: "USD"
|
|
3348
|
+
}])
|
|
3161
3349
|
```
|
|
3162
3350
|
</dd>
|
|
3163
3351
|
</dl>
|
|
@@ -3172,7 +3360,343 @@ client.leaderboards.all
|
|
|
3172
3360
|
<dl>
|
|
3173
3361
|
<dd>
|
|
3174
3362
|
|
|
3175
|
-
**
|
|
3363
|
+
**request:** `Internal::Types::Array[Trophy::Types::CreateMetricRequestItem]`
|
|
3364
|
+
|
|
3365
|
+
</dd>
|
|
3366
|
+
</dl>
|
|
3367
|
+
|
|
3368
|
+
<dl>
|
|
3369
|
+
<dd>
|
|
3370
|
+
|
|
3371
|
+
**request_options:** `Trophy::Admin::Metrics::RequestOptions`
|
|
3372
|
+
|
|
3373
|
+
</dd>
|
|
3374
|
+
</dl>
|
|
3375
|
+
</dd>
|
|
3376
|
+
</dl>
|
|
3377
|
+
|
|
3378
|
+
|
|
3379
|
+
</dd>
|
|
3380
|
+
</dl>
|
|
3381
|
+
</details>
|
|
3382
|
+
|
|
3383
|
+
<details><summary><code>client.admin.metrics.<a href="/lib/trophy/admin/metrics/client.rb">delete</a>() -> Trophy::Types::DeleteMetricsResponse</code></summary>
|
|
3384
|
+
<dl>
|
|
3385
|
+
<dd>
|
|
3386
|
+
|
|
3387
|
+
#### 📝 Description
|
|
3388
|
+
|
|
3389
|
+
<dl>
|
|
3390
|
+
<dd>
|
|
3391
|
+
|
|
3392
|
+
<dl>
|
|
3393
|
+
<dd>
|
|
3394
|
+
|
|
3395
|
+
Delete metrics by ID.
|
|
3396
|
+
</dd>
|
|
3397
|
+
</dl>
|
|
3398
|
+
</dd>
|
|
3399
|
+
</dl>
|
|
3400
|
+
|
|
3401
|
+
#### 🔌 Usage
|
|
3402
|
+
|
|
3403
|
+
<dl>
|
|
3404
|
+
<dd>
|
|
3405
|
+
|
|
3406
|
+
<dl>
|
|
3407
|
+
<dd>
|
|
3408
|
+
|
|
3409
|
+
```ruby
|
|
3410
|
+
client.admin.metrics.delete(ids: %w[550e8400-e29b-41d4-a716-446655440000 550e8400-e29b-41d4-a716-446655440001])
|
|
3411
|
+
```
|
|
3412
|
+
</dd>
|
|
3413
|
+
</dl>
|
|
3414
|
+
</dd>
|
|
3415
|
+
</dl>
|
|
3416
|
+
|
|
3417
|
+
#### ⚙️ Parameters
|
|
3418
|
+
|
|
3419
|
+
<dl>
|
|
3420
|
+
<dd>
|
|
3421
|
+
|
|
3422
|
+
<dl>
|
|
3423
|
+
<dd>
|
|
3424
|
+
|
|
3425
|
+
**ids:** `String` — Metric IDs to delete. Repeat the query param or provide a comma-separated list.
|
|
3426
|
+
|
|
3427
|
+
</dd>
|
|
3428
|
+
</dl>
|
|
3429
|
+
|
|
3430
|
+
<dl>
|
|
3431
|
+
<dd>
|
|
3432
|
+
|
|
3433
|
+
**request_options:** `Trophy::Admin::Metrics::RequestOptions`
|
|
3434
|
+
|
|
3435
|
+
</dd>
|
|
3436
|
+
</dl>
|
|
3437
|
+
</dd>
|
|
3438
|
+
</dl>
|
|
3439
|
+
|
|
3440
|
+
|
|
3441
|
+
</dd>
|
|
3442
|
+
</dl>
|
|
3443
|
+
</details>
|
|
3444
|
+
|
|
3445
|
+
<details><summary><code>client.admin.metrics.<a href="/lib/trophy/admin/metrics/client.rb">update</a>(request) -> Trophy::Types::UpdateMetricsResponse</code></summary>
|
|
3446
|
+
<dl>
|
|
3447
|
+
<dd>
|
|
3448
|
+
|
|
3449
|
+
#### 📝 Description
|
|
3450
|
+
|
|
3451
|
+
<dl>
|
|
3452
|
+
<dd>
|
|
3453
|
+
|
|
3454
|
+
<dl>
|
|
3455
|
+
<dd>
|
|
3456
|
+
|
|
3457
|
+
Update metrics by ID.
|
|
3458
|
+
</dd>
|
|
3459
|
+
</dl>
|
|
3460
|
+
</dd>
|
|
3461
|
+
</dl>
|
|
3462
|
+
|
|
3463
|
+
#### 🔌 Usage
|
|
3464
|
+
|
|
3465
|
+
<dl>
|
|
3466
|
+
<dd>
|
|
3467
|
+
|
|
3468
|
+
<dl>
|
|
3469
|
+
<dd>
|
|
3470
|
+
|
|
3471
|
+
```ruby
|
|
3472
|
+
client.admin.metrics.update(request: [{
|
|
3473
|
+
id: "550e8400-e29b-41d4-a716-446655440000",
|
|
3474
|
+
name: "Invites Completed",
|
|
3475
|
+
units: "invites"
|
|
3476
|
+
}, {
|
|
3477
|
+
id: "550e8400-e29b-41d4-a716-446655440001",
|
|
3478
|
+
unit_type: "number",
|
|
3479
|
+
units: "dollars"
|
|
3480
|
+
}])
|
|
3481
|
+
```
|
|
3482
|
+
</dd>
|
|
3483
|
+
</dl>
|
|
3484
|
+
</dd>
|
|
3485
|
+
</dl>
|
|
3486
|
+
|
|
3487
|
+
#### ⚙️ Parameters
|
|
3488
|
+
|
|
3489
|
+
<dl>
|
|
3490
|
+
<dd>
|
|
3491
|
+
|
|
3492
|
+
<dl>
|
|
3493
|
+
<dd>
|
|
3494
|
+
|
|
3495
|
+
**request:** `Internal::Types::Array[Trophy::Types::UpdateMetricRequestItem]`
|
|
3496
|
+
|
|
3497
|
+
</dd>
|
|
3498
|
+
</dl>
|
|
3499
|
+
|
|
3500
|
+
<dl>
|
|
3501
|
+
<dd>
|
|
3502
|
+
|
|
3503
|
+
**request_options:** `Trophy::Admin::Metrics::RequestOptions`
|
|
3504
|
+
|
|
3505
|
+
</dd>
|
|
3506
|
+
</dl>
|
|
3507
|
+
</dd>
|
|
3508
|
+
</dl>
|
|
3509
|
+
|
|
3510
|
+
|
|
3511
|
+
</dd>
|
|
3512
|
+
</dl>
|
|
3513
|
+
</details>
|
|
3514
|
+
|
|
3515
|
+
<details><summary><code>client.admin.metrics.<a href="/lib/trophy/admin/metrics/client.rb">get</a>(id) -> Trophy::Types::CreatedMetric</code></summary>
|
|
3516
|
+
<dl>
|
|
3517
|
+
<dd>
|
|
3518
|
+
|
|
3519
|
+
#### 📝 Description
|
|
3520
|
+
|
|
3521
|
+
<dl>
|
|
3522
|
+
<dd>
|
|
3523
|
+
|
|
3524
|
+
<dl>
|
|
3525
|
+
<dd>
|
|
3526
|
+
|
|
3527
|
+
Get a metric by ID.
|
|
3528
|
+
</dd>
|
|
3529
|
+
</dl>
|
|
3530
|
+
</dd>
|
|
3531
|
+
</dl>
|
|
3532
|
+
|
|
3533
|
+
#### 🔌 Usage
|
|
3534
|
+
|
|
3535
|
+
<dl>
|
|
3536
|
+
<dd>
|
|
3537
|
+
|
|
3538
|
+
<dl>
|
|
3539
|
+
<dd>
|
|
3540
|
+
|
|
3541
|
+
```ruby
|
|
3542
|
+
client.admin.metrics.get(id: "550e8400-e29b-41d4-a716-446655440000")
|
|
3543
|
+
```
|
|
3544
|
+
</dd>
|
|
3545
|
+
</dl>
|
|
3546
|
+
</dd>
|
|
3547
|
+
</dl>
|
|
3548
|
+
|
|
3549
|
+
#### ⚙️ Parameters
|
|
3550
|
+
|
|
3551
|
+
<dl>
|
|
3552
|
+
<dd>
|
|
3553
|
+
|
|
3554
|
+
<dl>
|
|
3555
|
+
<dd>
|
|
3556
|
+
|
|
3557
|
+
**id:** `String` — The UUID of the metric to retrieve.
|
|
3558
|
+
|
|
3559
|
+
</dd>
|
|
3560
|
+
</dl>
|
|
3561
|
+
|
|
3562
|
+
<dl>
|
|
3563
|
+
<dd>
|
|
3564
|
+
|
|
3565
|
+
**request_options:** `Trophy::Admin::Metrics::RequestOptions`
|
|
3566
|
+
|
|
3567
|
+
</dd>
|
|
3568
|
+
</dl>
|
|
3569
|
+
</dd>
|
|
3570
|
+
</dl>
|
|
3571
|
+
|
|
3572
|
+
|
|
3573
|
+
</dd>
|
|
3574
|
+
</dl>
|
|
3575
|
+
</details>
|
|
3576
|
+
|
|
3577
|
+
<details><summary><code>client.admin.metrics.<a href="/lib/trophy/admin/metrics/client.rb">batch_events</a>(request) -> Trophy::Types::BatchEventsResponse</code></summary>
|
|
3578
|
+
<dl>
|
|
3579
|
+
<dd>
|
|
3580
|
+
|
|
3581
|
+
#### 📝 Description
|
|
3582
|
+
|
|
3583
|
+
<dl>
|
|
3584
|
+
<dd>
|
|
3585
|
+
|
|
3586
|
+
<dl>
|
|
3587
|
+
<dd>
|
|
3588
|
+
|
|
3589
|
+
Submit up to 1,000 metric events for asynchronous processing.
|
|
3590
|
+
</dd>
|
|
3591
|
+
</dl>
|
|
3592
|
+
</dd>
|
|
3593
|
+
</dl>
|
|
3594
|
+
|
|
3595
|
+
#### 🔌 Usage
|
|
3596
|
+
|
|
3597
|
+
<dl>
|
|
3598
|
+
<dd>
|
|
3599
|
+
|
|
3600
|
+
<dl>
|
|
3601
|
+
<dd>
|
|
3602
|
+
|
|
3603
|
+
```ruby
|
|
3604
|
+
client.admin.metrics.batch_events(request: [{
|
|
3605
|
+
key: "words-written",
|
|
3606
|
+
user: {
|
|
3607
|
+
id: "18",
|
|
3608
|
+
email: "user@example.com",
|
|
3609
|
+
tz: "Europe/London",
|
|
3610
|
+
attributes: {
|
|
3611
|
+
department: "engineering",
|
|
3612
|
+
role: "developer"
|
|
3613
|
+
}
|
|
3614
|
+
},
|
|
3615
|
+
value: 750,
|
|
3616
|
+
attributes: {
|
|
3617
|
+
category: "writing",
|
|
3618
|
+
source: "mobile-app"
|
|
3619
|
+
},
|
|
3620
|
+
idempotency_key: "e4296e4b-8493-4bd1-9c30-5a1a9ac4d78f"
|
|
3621
|
+
}])
|
|
3622
|
+
```
|
|
3623
|
+
</dd>
|
|
3624
|
+
</dl>
|
|
3625
|
+
</dd>
|
|
3626
|
+
</dl>
|
|
3627
|
+
|
|
3628
|
+
#### ⚙️ Parameters
|
|
3629
|
+
|
|
3630
|
+
<dl>
|
|
3631
|
+
<dd>
|
|
3632
|
+
|
|
3633
|
+
<dl>
|
|
3634
|
+
<dd>
|
|
3635
|
+
|
|
3636
|
+
**request:** `Internal::Types::Array[Trophy::Types::BatchMetricEvent]`
|
|
3637
|
+
|
|
3638
|
+
</dd>
|
|
3639
|
+
</dl>
|
|
3640
|
+
|
|
3641
|
+
<dl>
|
|
3642
|
+
<dd>
|
|
3643
|
+
|
|
3644
|
+
**request_options:** `Trophy::Admin::Metrics::RequestOptions`
|
|
3645
|
+
|
|
3646
|
+
</dd>
|
|
3647
|
+
</dl>
|
|
3648
|
+
</dd>
|
|
3649
|
+
</dl>
|
|
3650
|
+
|
|
3651
|
+
|
|
3652
|
+
</dd>
|
|
3653
|
+
</dl>
|
|
3654
|
+
</details>
|
|
3655
|
+
|
|
3656
|
+
## Admin Leaderboards
|
|
3657
|
+
<details><summary><code>client.admin.leaderboards.<a href="/lib/trophy/admin/leaderboards/client.rb">list</a>() -> Internal::Types::Array[Trophy::Types::AdminLeaderboard]</code></summary>
|
|
3658
|
+
<dl>
|
|
3659
|
+
<dd>
|
|
3660
|
+
|
|
3661
|
+
#### 📝 Description
|
|
3662
|
+
|
|
3663
|
+
<dl>
|
|
3664
|
+
<dd>
|
|
3665
|
+
|
|
3666
|
+
<dl>
|
|
3667
|
+
<dd>
|
|
3668
|
+
|
|
3669
|
+
List leaderboards.
|
|
3670
|
+
</dd>
|
|
3671
|
+
</dl>
|
|
3672
|
+
</dd>
|
|
3673
|
+
</dl>
|
|
3674
|
+
|
|
3675
|
+
#### 🔌 Usage
|
|
3676
|
+
|
|
3677
|
+
<dl>
|
|
3678
|
+
<dd>
|
|
3679
|
+
|
|
3680
|
+
<dl>
|
|
3681
|
+
<dd>
|
|
3682
|
+
|
|
3683
|
+
```ruby
|
|
3684
|
+
client.leaderboards.all
|
|
3685
|
+
```
|
|
3686
|
+
</dd>
|
|
3687
|
+
</dl>
|
|
3688
|
+
</dd>
|
|
3689
|
+
</dl>
|
|
3690
|
+
|
|
3691
|
+
#### ⚙️ Parameters
|
|
3692
|
+
|
|
3693
|
+
<dl>
|
|
3694
|
+
<dd>
|
|
3695
|
+
|
|
3696
|
+
<dl>
|
|
3697
|
+
<dd>
|
|
3698
|
+
|
|
3699
|
+
**limit:** `Integer` — Number of records to return.
|
|
3176
3700
|
|
|
3177
3701
|
</dd>
|
|
3178
3702
|
</dl>
|
|
@@ -3200,7 +3724,218 @@ client.leaderboards.all
|
|
|
3200
3724
|
</dl>
|
|
3201
3725
|
</details>
|
|
3202
3726
|
|
|
3203
|
-
<details><summary><code>client.admin.leaderboards.<a href="/lib/trophy/admin/leaderboards/client.rb">create</a>(request) -> Trophy::Types::CreateLeaderboardsResponse</code></summary>
|
|
3727
|
+
<details><summary><code>client.admin.leaderboards.<a href="/lib/trophy/admin/leaderboards/client.rb">create</a>(request) -> Trophy::Types::CreateLeaderboardsResponse</code></summary>
|
|
3728
|
+
<dl>
|
|
3729
|
+
<dd>
|
|
3730
|
+
|
|
3731
|
+
#### 📝 Description
|
|
3732
|
+
|
|
3733
|
+
<dl>
|
|
3734
|
+
<dd>
|
|
3735
|
+
|
|
3736
|
+
<dl>
|
|
3737
|
+
<dd>
|
|
3738
|
+
|
|
3739
|
+
Create leaderboards.
|
|
3740
|
+
</dd>
|
|
3741
|
+
</dl>
|
|
3742
|
+
</dd>
|
|
3743
|
+
</dl>
|
|
3744
|
+
|
|
3745
|
+
#### 🔌 Usage
|
|
3746
|
+
|
|
3747
|
+
<dl>
|
|
3748
|
+
<dd>
|
|
3749
|
+
|
|
3750
|
+
<dl>
|
|
3751
|
+
<dd>
|
|
3752
|
+
|
|
3753
|
+
```ruby
|
|
3754
|
+
client.admin.leaderboards.create(request: [{
|
|
3755
|
+
name: "Revenue Champions",
|
|
3756
|
+
key: "revenue-champions",
|
|
3757
|
+
status: "inactive",
|
|
3758
|
+
rank_by: "metric",
|
|
3759
|
+
metric_id: "550e8400-e29b-41d4-a716-446655440000",
|
|
3760
|
+
max_participants: 100,
|
|
3761
|
+
start: "2026-04-20",
|
|
3762
|
+
breakdown_attributes: ["550e8400-e29b-41d4-a716-446655440010"],
|
|
3763
|
+
run_unit: "month",
|
|
3764
|
+
run_interval: 1
|
|
3765
|
+
}, {
|
|
3766
|
+
name: "Streak Legends",
|
|
3767
|
+
key: "streak-legends",
|
|
3768
|
+
status: "scheduled",
|
|
3769
|
+
rank_by: "streak",
|
|
3770
|
+
start: "2026-04-27"
|
|
3771
|
+
}])
|
|
3772
|
+
```
|
|
3773
|
+
</dd>
|
|
3774
|
+
</dl>
|
|
3775
|
+
</dd>
|
|
3776
|
+
</dl>
|
|
3777
|
+
|
|
3778
|
+
#### ⚙️ Parameters
|
|
3779
|
+
|
|
3780
|
+
<dl>
|
|
3781
|
+
<dd>
|
|
3782
|
+
|
|
3783
|
+
<dl>
|
|
3784
|
+
<dd>
|
|
3785
|
+
|
|
3786
|
+
**request:** `Internal::Types::Array[Trophy::Types::CreateLeaderboardRequestItem]`
|
|
3787
|
+
|
|
3788
|
+
</dd>
|
|
3789
|
+
</dl>
|
|
3790
|
+
|
|
3791
|
+
<dl>
|
|
3792
|
+
<dd>
|
|
3793
|
+
|
|
3794
|
+
**request_options:** `Trophy::Admin::Leaderboards::RequestOptions`
|
|
3795
|
+
|
|
3796
|
+
</dd>
|
|
3797
|
+
</dl>
|
|
3798
|
+
</dd>
|
|
3799
|
+
</dl>
|
|
3800
|
+
|
|
3801
|
+
|
|
3802
|
+
</dd>
|
|
3803
|
+
</dl>
|
|
3804
|
+
</details>
|
|
3805
|
+
|
|
3806
|
+
<details><summary><code>client.admin.leaderboards.<a href="/lib/trophy/admin/leaderboards/client.rb">delete</a>() -> Trophy::Types::DeleteLeaderboardsResponse</code></summary>
|
|
3807
|
+
<dl>
|
|
3808
|
+
<dd>
|
|
3809
|
+
|
|
3810
|
+
#### 📝 Description
|
|
3811
|
+
|
|
3812
|
+
<dl>
|
|
3813
|
+
<dd>
|
|
3814
|
+
|
|
3815
|
+
<dl>
|
|
3816
|
+
<dd>
|
|
3817
|
+
|
|
3818
|
+
Delete leaderboards by ID.
|
|
3819
|
+
</dd>
|
|
3820
|
+
</dl>
|
|
3821
|
+
</dd>
|
|
3822
|
+
</dl>
|
|
3823
|
+
|
|
3824
|
+
#### 🔌 Usage
|
|
3825
|
+
|
|
3826
|
+
<dl>
|
|
3827
|
+
<dd>
|
|
3828
|
+
|
|
3829
|
+
<dl>
|
|
3830
|
+
<dd>
|
|
3831
|
+
|
|
3832
|
+
```ruby
|
|
3833
|
+
client.admin.leaderboards.delete(ids: ["ids"])
|
|
3834
|
+
```
|
|
3835
|
+
</dd>
|
|
3836
|
+
</dl>
|
|
3837
|
+
</dd>
|
|
3838
|
+
</dl>
|
|
3839
|
+
|
|
3840
|
+
#### ⚙️ Parameters
|
|
3841
|
+
|
|
3842
|
+
<dl>
|
|
3843
|
+
<dd>
|
|
3844
|
+
|
|
3845
|
+
<dl>
|
|
3846
|
+
<dd>
|
|
3847
|
+
|
|
3848
|
+
**ids:** `String` — Leaderboard IDs to delete. Repeat the query param or provide a comma-separated list.
|
|
3849
|
+
|
|
3850
|
+
</dd>
|
|
3851
|
+
</dl>
|
|
3852
|
+
|
|
3853
|
+
<dl>
|
|
3854
|
+
<dd>
|
|
3855
|
+
|
|
3856
|
+
**request_options:** `Trophy::Admin::Leaderboards::RequestOptions`
|
|
3857
|
+
|
|
3858
|
+
</dd>
|
|
3859
|
+
</dl>
|
|
3860
|
+
</dd>
|
|
3861
|
+
</dl>
|
|
3862
|
+
|
|
3863
|
+
|
|
3864
|
+
</dd>
|
|
3865
|
+
</dl>
|
|
3866
|
+
</details>
|
|
3867
|
+
|
|
3868
|
+
<details><summary><code>client.admin.leaderboards.<a href="/lib/trophy/admin/leaderboards/client.rb">update</a>(request) -> Trophy::Types::UpdateLeaderboardsResponse</code></summary>
|
|
3869
|
+
<dl>
|
|
3870
|
+
<dd>
|
|
3871
|
+
|
|
3872
|
+
#### 📝 Description
|
|
3873
|
+
|
|
3874
|
+
<dl>
|
|
3875
|
+
<dd>
|
|
3876
|
+
|
|
3877
|
+
<dl>
|
|
3878
|
+
<dd>
|
|
3879
|
+
|
|
3880
|
+
Update leaderboards by ID. Updating `status` behaves the same as activating, scheduling, deactivating, or finishing a leaderboard in the dashboard.
|
|
3881
|
+
</dd>
|
|
3882
|
+
</dl>
|
|
3883
|
+
</dd>
|
|
3884
|
+
</dl>
|
|
3885
|
+
|
|
3886
|
+
#### 🔌 Usage
|
|
3887
|
+
|
|
3888
|
+
<dl>
|
|
3889
|
+
<dd>
|
|
3890
|
+
|
|
3891
|
+
<dl>
|
|
3892
|
+
<dd>
|
|
3893
|
+
|
|
3894
|
+
```ruby
|
|
3895
|
+
client.admin.leaderboards.update(request: [{
|
|
3896
|
+
id: "550e8400-e29b-41d4-a716-446655440100",
|
|
3897
|
+
name: "Monthly Revenue Champions",
|
|
3898
|
+
description: "Ranked by monthly revenue",
|
|
3899
|
+
status: "active"
|
|
3900
|
+
}, {
|
|
3901
|
+
id: "550e8400-e29b-41d4-a716-446655440101",
|
|
3902
|
+
status: "finished"
|
|
3903
|
+
}])
|
|
3904
|
+
```
|
|
3905
|
+
</dd>
|
|
3906
|
+
</dl>
|
|
3907
|
+
</dd>
|
|
3908
|
+
</dl>
|
|
3909
|
+
|
|
3910
|
+
#### ⚙️ Parameters
|
|
3911
|
+
|
|
3912
|
+
<dl>
|
|
3913
|
+
<dd>
|
|
3914
|
+
|
|
3915
|
+
<dl>
|
|
3916
|
+
<dd>
|
|
3917
|
+
|
|
3918
|
+
**request:** `Internal::Types::Array[Trophy::Types::UpdateLeaderboardRequestItem]`
|
|
3919
|
+
|
|
3920
|
+
</dd>
|
|
3921
|
+
</dl>
|
|
3922
|
+
|
|
3923
|
+
<dl>
|
|
3924
|
+
<dd>
|
|
3925
|
+
|
|
3926
|
+
**request_options:** `Trophy::Admin::Leaderboards::RequestOptions`
|
|
3927
|
+
|
|
3928
|
+
</dd>
|
|
3929
|
+
</dl>
|
|
3930
|
+
</dd>
|
|
3931
|
+
</dl>
|
|
3932
|
+
|
|
3933
|
+
|
|
3934
|
+
</dd>
|
|
3935
|
+
</dl>
|
|
3936
|
+
</details>
|
|
3937
|
+
|
|
3938
|
+
<details><summary><code>client.admin.leaderboards.<a href="/lib/trophy/admin/leaderboards/client.rb">get</a>(id) -> Trophy::Types::AdminLeaderboard</code></summary>
|
|
3204
3939
|
<dl>
|
|
3205
3940
|
<dd>
|
|
3206
3941
|
|
|
@@ -3212,7 +3947,7 @@ client.leaderboards.all
|
|
|
3212
3947
|
<dl>
|
|
3213
3948
|
<dd>
|
|
3214
3949
|
|
|
3215
|
-
|
|
3950
|
+
Get a leaderboard by ID.
|
|
3216
3951
|
</dd>
|
|
3217
3952
|
</dl>
|
|
3218
3953
|
</dd>
|
|
@@ -3227,24 +3962,7 @@ Create leaderboards.
|
|
|
3227
3962
|
<dd>
|
|
3228
3963
|
|
|
3229
3964
|
```ruby
|
|
3230
|
-
client.admin.leaderboards.
|
|
3231
|
-
name: "Revenue Champions",
|
|
3232
|
-
key: "revenue-champions",
|
|
3233
|
-
status: "inactive",
|
|
3234
|
-
rank_by: "metric",
|
|
3235
|
-
metric_id: "550e8400-e29b-41d4-a716-446655440000",
|
|
3236
|
-
max_participants: 100,
|
|
3237
|
-
start: "2026-04-20",
|
|
3238
|
-
breakdown_attributes: ["550e8400-e29b-41d4-a716-446655440010"],
|
|
3239
|
-
run_unit: "month",
|
|
3240
|
-
run_interval: 1
|
|
3241
|
-
}, {
|
|
3242
|
-
name: "Streak Legends",
|
|
3243
|
-
key: "streak-legends",
|
|
3244
|
-
status: "scheduled",
|
|
3245
|
-
rank_by: "streak",
|
|
3246
|
-
start: "2026-04-27"
|
|
3247
|
-
}])
|
|
3965
|
+
client.admin.leaderboards.get(id: "550e8400-e29b-41d4-a716-446655440100")
|
|
3248
3966
|
```
|
|
3249
3967
|
</dd>
|
|
3250
3968
|
</dl>
|
|
@@ -3259,7 +3977,7 @@ client.admin.leaderboards.create(request: [{
|
|
|
3259
3977
|
<dl>
|
|
3260
3978
|
<dd>
|
|
3261
3979
|
|
|
3262
|
-
**
|
|
3980
|
+
**id:** `String` — The UUID of the leaderboard to retrieve.
|
|
3263
3981
|
|
|
3264
3982
|
</dd>
|
|
3265
3983
|
</dl>
|
|
@@ -3279,7 +3997,8 @@ client.admin.leaderboards.create(request: [{
|
|
|
3279
3997
|
</dl>
|
|
3280
3998
|
</details>
|
|
3281
3999
|
|
|
3282
|
-
|
|
4000
|
+
## Admin Streaks
|
|
4001
|
+
<details><summary><code>client.admin.streaks.<a href="/lib/trophy/admin/streaks/client.rb">restore</a>(request) -> Trophy::Types::RestoreStreaksResponse</code></summary>
|
|
3283
4002
|
<dl>
|
|
3284
4003
|
<dd>
|
|
3285
4004
|
|
|
@@ -3291,7 +4010,7 @@ client.admin.leaderboards.create(request: [{
|
|
|
3291
4010
|
<dl>
|
|
3292
4011
|
<dd>
|
|
3293
4012
|
|
|
3294
|
-
|
|
4013
|
+
Restore streaks for multiple users to the maximum previously achieved streak length found within the current restore window: the last 90 days for daily streaks, weekly periods starting with the week containing the start of the current calendar year for weekly streaks, and monthly periods starting at the beginning of the previous calendar year for monthly streaks.
|
|
3295
4014
|
</dd>
|
|
3296
4015
|
</dl>
|
|
3297
4016
|
</dd>
|
|
@@ -3306,7 +4025,11 @@ Delete leaderboards by ID.
|
|
|
3306
4025
|
<dd>
|
|
3307
4026
|
|
|
3308
4027
|
```ruby
|
|
3309
|
-
client.admin.
|
|
4028
|
+
client.admin.streaks.restore(users: [{
|
|
4029
|
+
id: "user-123"
|
|
4030
|
+
}, {
|
|
4031
|
+
id: "user-456"
|
|
4032
|
+
}])
|
|
3310
4033
|
```
|
|
3311
4034
|
</dd>
|
|
3312
4035
|
</dl>
|
|
@@ -3321,7 +4044,7 @@ client.admin.leaderboards.delete(ids: ["ids"])
|
|
|
3321
4044
|
<dl>
|
|
3322
4045
|
<dd>
|
|
3323
4046
|
|
|
3324
|
-
**
|
|
4047
|
+
**users:** `Internal::Types::Array[Trophy::Admin::Streaks::Types::RestoreStreaksRequestUsersItem]` — Array of users to restore streaks for. Maximum 100 users per request.
|
|
3325
4048
|
|
|
3326
4049
|
</dd>
|
|
3327
4050
|
</dl>
|
|
@@ -3329,7 +4052,7 @@ client.admin.leaderboards.delete(ids: ["ids"])
|
|
|
3329
4052
|
<dl>
|
|
3330
4053
|
<dd>
|
|
3331
4054
|
|
|
3332
|
-
**request_options:** `Trophy::Admin::
|
|
4055
|
+
**request_options:** `Trophy::Admin::Streaks::RequestOptions`
|
|
3333
4056
|
|
|
3334
4057
|
</dd>
|
|
3335
4058
|
</dl>
|
|
@@ -3341,7 +4064,7 @@ client.admin.leaderboards.delete(ids: ["ids"])
|
|
|
3341
4064
|
</dl>
|
|
3342
4065
|
</details>
|
|
3343
4066
|
|
|
3344
|
-
<details><summary><code>client.admin.
|
|
4067
|
+
<details><summary><code>client.admin.streaks.<a href="/lib/trophy/admin/streaks/client.rb">reset</a>(request) -> Trophy::Types::ResetStreaksResponse</code></summary>
|
|
3345
4068
|
<dl>
|
|
3346
4069
|
<dd>
|
|
3347
4070
|
|
|
@@ -3353,7 +4076,7 @@ client.admin.leaderboards.delete(ids: ["ids"])
|
|
|
3353
4076
|
<dl>
|
|
3354
4077
|
<dd>
|
|
3355
4078
|
|
|
3356
|
-
|
|
4079
|
+
Reset the current streak to zero for multiple users.
|
|
3357
4080
|
</dd>
|
|
3358
4081
|
</dl>
|
|
3359
4082
|
</dd>
|
|
@@ -3368,14 +4091,10 @@ Update leaderboards by ID. Updating `status` behaves the same as activating, sch
|
|
|
3368
4091
|
<dd>
|
|
3369
4092
|
|
|
3370
4093
|
```ruby
|
|
3371
|
-
client.admin.
|
|
3372
|
-
id: "
|
|
3373
|
-
name: "Monthly Revenue Champions",
|
|
3374
|
-
description: "Ranked by monthly revenue",
|
|
3375
|
-
status: "active"
|
|
4094
|
+
client.admin.streaks.reset(users: [{
|
|
4095
|
+
id: "user-123"
|
|
3376
4096
|
}, {
|
|
3377
|
-
id: "
|
|
3378
|
-
status: "finished"
|
|
4097
|
+
id: "user-456"
|
|
3379
4098
|
}])
|
|
3380
4099
|
```
|
|
3381
4100
|
</dd>
|
|
@@ -3391,7 +4110,7 @@ client.admin.leaderboards.update(request: [{
|
|
|
3391
4110
|
<dl>
|
|
3392
4111
|
<dd>
|
|
3393
4112
|
|
|
3394
|
-
**
|
|
4113
|
+
**users:** `Internal::Types::Array[Trophy::Admin::Streaks::Types::ResetStreaksRequestUsersItem]` — Array of users to reset streaks for. Maximum 100 users per request.
|
|
3395
4114
|
|
|
3396
4115
|
</dd>
|
|
3397
4116
|
</dl>
|
|
@@ -3399,7 +4118,7 @@ client.admin.leaderboards.update(request: [{
|
|
|
3399
4118
|
<dl>
|
|
3400
4119
|
<dd>
|
|
3401
4120
|
|
|
3402
|
-
**request_options:** `Trophy::Admin::
|
|
4121
|
+
**request_options:** `Trophy::Admin::Streaks::RequestOptions`
|
|
3403
4122
|
|
|
3404
4123
|
</dd>
|
|
3405
4124
|
</dl>
|
|
@@ -3411,7 +4130,8 @@ client.admin.leaderboards.update(request: [{
|
|
|
3411
4130
|
</dl>
|
|
3412
4131
|
</details>
|
|
3413
4132
|
|
|
3414
|
-
|
|
4133
|
+
## Admin Settings
|
|
4134
|
+
<details><summary><code>client.admin.settings.<a href="/lib/trophy/admin/settings/client.rb">get</a>() -> Trophy::Types::AdminSettings</code></summary>
|
|
3415
4135
|
<dl>
|
|
3416
4136
|
<dd>
|
|
3417
4137
|
|
|
@@ -3423,7 +4143,7 @@ client.admin.leaderboards.update(request: [{
|
|
|
3423
4143
|
<dl>
|
|
3424
4144
|
<dd>
|
|
3425
4145
|
|
|
3426
|
-
Get
|
|
4146
|
+
Get branding, experimentation, and aggregation settings.
|
|
3427
4147
|
</dd>
|
|
3428
4148
|
</dl>
|
|
3429
4149
|
</dd>
|
|
@@ -3438,7 +4158,7 @@ Get a leaderboard by ID.
|
|
|
3438
4158
|
<dd>
|
|
3439
4159
|
|
|
3440
4160
|
```ruby
|
|
3441
|
-
client.admin.
|
|
4161
|
+
client.admin.settings.get
|
|
3442
4162
|
```
|
|
3443
4163
|
</dd>
|
|
3444
4164
|
</dl>
|
|
@@ -3453,15 +4173,99 @@ client.admin.leaderboards.get(id: "550e8400-e29b-41d4-a716-446655440100")
|
|
|
3453
4173
|
<dl>
|
|
3454
4174
|
<dd>
|
|
3455
4175
|
|
|
3456
|
-
**
|
|
4176
|
+
**request_options:** `Trophy::Admin::Settings::RequestOptions`
|
|
3457
4177
|
|
|
3458
4178
|
</dd>
|
|
3459
4179
|
</dl>
|
|
4180
|
+
</dd>
|
|
4181
|
+
</dl>
|
|
4182
|
+
|
|
4183
|
+
|
|
4184
|
+
</dd>
|
|
4185
|
+
</dl>
|
|
4186
|
+
</details>
|
|
4187
|
+
|
|
4188
|
+
<details><summary><code>client.admin.settings.<a href="/lib/trophy/admin/settings/client.rb">update</a>(request) -> Trophy::Types::AdminSettings</code></summary>
|
|
4189
|
+
<dl>
|
|
4190
|
+
<dd>
|
|
4191
|
+
|
|
4192
|
+
#### 📝 Description
|
|
3460
4193
|
|
|
3461
4194
|
<dl>
|
|
3462
4195
|
<dd>
|
|
3463
4196
|
|
|
3464
|
-
|
|
4197
|
+
<dl>
|
|
4198
|
+
<dd>
|
|
4199
|
+
|
|
4200
|
+
Update branding, experimentation, and aggregation settings.
|
|
4201
|
+
</dd>
|
|
4202
|
+
</dl>
|
|
4203
|
+
</dd>
|
|
4204
|
+
</dl>
|
|
4205
|
+
|
|
4206
|
+
#### 🔌 Usage
|
|
4207
|
+
|
|
4208
|
+
<dl>
|
|
4209
|
+
<dd>
|
|
4210
|
+
|
|
4211
|
+
<dl>
|
|
4212
|
+
<dd>
|
|
4213
|
+
|
|
4214
|
+
```ruby
|
|
4215
|
+
client.admin.settings.update(
|
|
4216
|
+
branding: {
|
|
4217
|
+
app_name: "Trophy",
|
|
4218
|
+
app_url: "https://app.example.com",
|
|
4219
|
+
brand_color: "#1a2b3c",
|
|
4220
|
+
logo: {
|
|
4221
|
+
url: "https://cdn.example.com/logo.png"
|
|
4222
|
+
}
|
|
4223
|
+
},
|
|
4224
|
+
experimentation: {
|
|
4225
|
+
control_ratio: 10,
|
|
4226
|
+
user_activation_window: 14
|
|
4227
|
+
},
|
|
4228
|
+
aggregation_period: "weekly"
|
|
4229
|
+
)
|
|
4230
|
+
```
|
|
4231
|
+
</dd>
|
|
4232
|
+
</dl>
|
|
4233
|
+
</dd>
|
|
4234
|
+
</dl>
|
|
4235
|
+
|
|
4236
|
+
#### ⚙️ Parameters
|
|
4237
|
+
|
|
4238
|
+
<dl>
|
|
4239
|
+
<dd>
|
|
4240
|
+
|
|
4241
|
+
<dl>
|
|
4242
|
+
<dd>
|
|
4243
|
+
|
|
4244
|
+
**branding:** `Trophy::Types::UpdateAdminSettingsBranding`
|
|
4245
|
+
|
|
4246
|
+
</dd>
|
|
4247
|
+
</dl>
|
|
4248
|
+
|
|
4249
|
+
<dl>
|
|
4250
|
+
<dd>
|
|
4251
|
+
|
|
4252
|
+
**experimentation:** `Trophy::Types::UpdateAdminSettingsExperimentation`
|
|
4253
|
+
|
|
4254
|
+
</dd>
|
|
4255
|
+
</dl>
|
|
4256
|
+
|
|
4257
|
+
<dl>
|
|
4258
|
+
<dd>
|
|
4259
|
+
|
|
4260
|
+
**aggregation_period:** `Trophy::Types::AdminAggregationPeriod`
|
|
4261
|
+
|
|
4262
|
+
</dd>
|
|
4263
|
+
</dl>
|
|
4264
|
+
|
|
4265
|
+
<dl>
|
|
4266
|
+
<dd>
|
|
4267
|
+
|
|
4268
|
+
**request_options:** `Trophy::Admin::Settings::RequestOptions`
|
|
3465
4269
|
|
|
3466
4270
|
</dd>
|
|
3467
4271
|
</dl>
|
|
@@ -3473,8 +4277,8 @@ client.admin.leaderboards.get(id: "550e8400-e29b-41d4-a716-446655440100")
|
|
|
3473
4277
|
</dl>
|
|
3474
4278
|
</details>
|
|
3475
4279
|
|
|
3476
|
-
## Admin
|
|
3477
|
-
<details><summary><code>client.admin.
|
|
4280
|
+
## Admin ApplicationApiKeys
|
|
4281
|
+
<details><summary><code>client.admin.application_api_keys.<a href="/lib/trophy/admin/application_api_keys/client.rb">create</a>(request) -> Trophy::Types::CreateApplicationKeysResponse</code></summary>
|
|
3478
4282
|
<dl>
|
|
3479
4283
|
<dd>
|
|
3480
4284
|
|
|
@@ -3486,7 +4290,7 @@ client.admin.leaderboards.get(id: "550e8400-e29b-41d4-a716-446655440100")
|
|
|
3486
4290
|
<dl>
|
|
3487
4291
|
<dd>
|
|
3488
4292
|
|
|
3489
|
-
|
|
4293
|
+
Create application API keys scoped to specific users. Each key can only perform operations on behalf of the user it was created for.
|
|
3490
4294
|
</dd>
|
|
3491
4295
|
</dl>
|
|
3492
4296
|
</dd>
|
|
@@ -3501,10 +4305,10 @@ Restore streaks for multiple users to the maximum previously achieved streak len
|
|
|
3501
4305
|
<dd>
|
|
3502
4306
|
|
|
3503
4307
|
```ruby
|
|
3504
|
-
client.admin.
|
|
3505
|
-
|
|
4308
|
+
client.admin.application_api_keys.create(request: [{
|
|
4309
|
+
user_id: "user_123"
|
|
3506
4310
|
}, {
|
|
3507
|
-
|
|
4311
|
+
user_id: "user_456"
|
|
3508
4312
|
}])
|
|
3509
4313
|
```
|
|
3510
4314
|
</dd>
|
|
@@ -3520,7 +4324,69 @@ client.admin.streaks.restore(users: [{
|
|
|
3520
4324
|
<dl>
|
|
3521
4325
|
<dd>
|
|
3522
4326
|
|
|
3523
|
-
**
|
|
4327
|
+
**request:** `Internal::Types::Array[Trophy::Types::CreateApplicationKeyRequestItem]`
|
|
4328
|
+
|
|
4329
|
+
</dd>
|
|
4330
|
+
</dl>
|
|
4331
|
+
|
|
4332
|
+
<dl>
|
|
4333
|
+
<dd>
|
|
4334
|
+
|
|
4335
|
+
**request_options:** `Trophy::Admin::ApplicationApiKeys::RequestOptions`
|
|
4336
|
+
|
|
4337
|
+
</dd>
|
|
4338
|
+
</dl>
|
|
4339
|
+
</dd>
|
|
4340
|
+
</dl>
|
|
4341
|
+
|
|
4342
|
+
|
|
4343
|
+
</dd>
|
|
4344
|
+
</dl>
|
|
4345
|
+
</details>
|
|
4346
|
+
|
|
4347
|
+
<details><summary><code>client.admin.application_api_keys.<a href="/lib/trophy/admin/application_api_keys/client.rb">delete</a>() -> Trophy::Types::DeleteApplicationKeysResponse</code></summary>
|
|
4348
|
+
<dl>
|
|
4349
|
+
<dd>
|
|
4350
|
+
|
|
4351
|
+
#### 📝 Description
|
|
4352
|
+
|
|
4353
|
+
<dl>
|
|
4354
|
+
<dd>
|
|
4355
|
+
|
|
4356
|
+
<dl>
|
|
4357
|
+
<dd>
|
|
4358
|
+
|
|
4359
|
+
Delete application API keys by ID.
|
|
4360
|
+
</dd>
|
|
4361
|
+
</dl>
|
|
4362
|
+
</dd>
|
|
4363
|
+
</dl>
|
|
4364
|
+
|
|
4365
|
+
#### 🔌 Usage
|
|
4366
|
+
|
|
4367
|
+
<dl>
|
|
4368
|
+
<dd>
|
|
4369
|
+
|
|
4370
|
+
<dl>
|
|
4371
|
+
<dd>
|
|
4372
|
+
|
|
4373
|
+
```ruby
|
|
4374
|
+
client.admin.application_api_keys.delete(ids: ["550e8400-e29b-41d4-a716-446655440000"])
|
|
4375
|
+
```
|
|
4376
|
+
</dd>
|
|
4377
|
+
</dl>
|
|
4378
|
+
</dd>
|
|
4379
|
+
</dl>
|
|
4380
|
+
|
|
4381
|
+
#### ⚙️ Parameters
|
|
4382
|
+
|
|
4383
|
+
<dl>
|
|
4384
|
+
<dd>
|
|
4385
|
+
|
|
4386
|
+
<dl>
|
|
4387
|
+
<dd>
|
|
4388
|
+
|
|
4389
|
+
**ids:** `String` — Application API key IDs (UUIDs returned at creation time). Repeat the query param or provide a comma-separated list. Maximum 100 IDs per request.
|
|
3524
4390
|
|
|
3525
4391
|
</dd>
|
|
3526
4392
|
</dl>
|
|
@@ -3528,7 +4394,7 @@ client.admin.streaks.restore(users: [{
|
|
|
3528
4394
|
<dl>
|
|
3529
4395
|
<dd>
|
|
3530
4396
|
|
|
3531
|
-
**request_options:** `Trophy::Admin::
|
|
4397
|
+
**request_options:** `Trophy::Admin::ApplicationApiKeys::RequestOptions`
|
|
3532
4398
|
|
|
3533
4399
|
</dd>
|
|
3534
4400
|
</dl>
|
|
@@ -3540,7 +4406,8 @@ client.admin.streaks.restore(users: [{
|
|
|
3540
4406
|
</dl>
|
|
3541
4407
|
</details>
|
|
3542
4408
|
|
|
3543
|
-
|
|
4409
|
+
## Admin Environments
|
|
4410
|
+
<details><summary><code>client.admin.environments.<a href="/lib/trophy/admin/environments/client.rb">list</a>() -> Internal::Types::Array[Trophy::Types::AdminEnvironment]</code></summary>
|
|
3544
4411
|
<dl>
|
|
3545
4412
|
<dd>
|
|
3546
4413
|
|
|
@@ -3552,7 +4419,7 @@ client.admin.streaks.restore(users: [{
|
|
|
3552
4419
|
<dl>
|
|
3553
4420
|
<dd>
|
|
3554
4421
|
|
|
3555
|
-
|
|
4422
|
+
List active environments.
|
|
3556
4423
|
</dd>
|
|
3557
4424
|
</dl>
|
|
3558
4425
|
</dd>
|
|
@@ -3567,11 +4434,7 @@ Reset the current streak to zero for multiple users.
|
|
|
3567
4434
|
<dd>
|
|
3568
4435
|
|
|
3569
4436
|
```ruby
|
|
3570
|
-
client.admin.
|
|
3571
|
-
id: "user-123"
|
|
3572
|
-
}, {
|
|
3573
|
-
id: "user-456"
|
|
3574
|
-
}])
|
|
4437
|
+
client.admin.environments.list
|
|
3575
4438
|
```
|
|
3576
4439
|
</dd>
|
|
3577
4440
|
</dl>
|
|
@@ -3586,15 +4449,7 @@ client.admin.streaks.reset(users: [{
|
|
|
3586
4449
|
<dl>
|
|
3587
4450
|
<dd>
|
|
3588
4451
|
|
|
3589
|
-
**
|
|
3590
|
-
|
|
3591
|
-
</dd>
|
|
3592
|
-
</dl>
|
|
3593
|
-
|
|
3594
|
-
<dl>
|
|
3595
|
-
<dd>
|
|
3596
|
-
|
|
3597
|
-
**request_options:** `Trophy::Admin::Streaks::RequestOptions`
|
|
4452
|
+
**request_options:** `Trophy::Admin::Environments::RequestOptions`
|
|
3598
4453
|
|
|
3599
4454
|
</dd>
|
|
3600
4455
|
</dl>
|
|
@@ -3606,8 +4461,8 @@ client.admin.streaks.reset(users: [{
|
|
|
3606
4461
|
</dl>
|
|
3607
4462
|
</details>
|
|
3608
4463
|
|
|
3609
|
-
## Admin
|
|
3610
|
-
<details><summary><code>client.admin.
|
|
4464
|
+
## Admin Tenants
|
|
4465
|
+
<details><summary><code>client.admin.tenants.<a href="/lib/trophy/admin/tenants/client.rb">list</a>() -> Internal::Types::Array[Trophy::Types::AdminTenant]</code></summary>
|
|
3611
4466
|
<dl>
|
|
3612
4467
|
<dd>
|
|
3613
4468
|
|
|
@@ -3619,7 +4474,7 @@ client.admin.streaks.reset(users: [{
|
|
|
3619
4474
|
<dl>
|
|
3620
4475
|
<dd>
|
|
3621
4476
|
|
|
3622
|
-
|
|
4477
|
+
List tenants in the current environment.
|
|
3623
4478
|
</dd>
|
|
3624
4479
|
</dl>
|
|
3625
4480
|
</dd>
|
|
@@ -3634,7 +4489,10 @@ Get branding, experimentation, and aggregation settings.
|
|
|
3634
4489
|
<dd>
|
|
3635
4490
|
|
|
3636
4491
|
```ruby
|
|
3637
|
-
client.admin.
|
|
4492
|
+
client.admin.tenants.list(
|
|
4493
|
+
limit: 1,
|
|
4494
|
+
skip: 1
|
|
4495
|
+
)
|
|
3638
4496
|
```
|
|
3639
4497
|
</dd>
|
|
3640
4498
|
</dl>
|
|
@@ -3649,7 +4507,23 @@ client.admin.settings.get
|
|
|
3649
4507
|
<dl>
|
|
3650
4508
|
<dd>
|
|
3651
4509
|
|
|
3652
|
-
**
|
|
4510
|
+
**limit:** `Integer` — Number of records to return.
|
|
4511
|
+
|
|
4512
|
+
</dd>
|
|
4513
|
+
</dl>
|
|
4514
|
+
|
|
4515
|
+
<dl>
|
|
4516
|
+
<dd>
|
|
4517
|
+
|
|
4518
|
+
**skip:** `Integer` — Number of records to skip from the start of the list.
|
|
4519
|
+
|
|
4520
|
+
</dd>
|
|
4521
|
+
</dl>
|
|
4522
|
+
|
|
4523
|
+
<dl>
|
|
4524
|
+
<dd>
|
|
4525
|
+
|
|
4526
|
+
**request_options:** `Trophy::Admin::Tenants::RequestOptions`
|
|
3653
4527
|
|
|
3654
4528
|
</dd>
|
|
3655
4529
|
</dl>
|
|
@@ -3661,7 +4535,7 @@ client.admin.settings.get
|
|
|
3661
4535
|
</dl>
|
|
3662
4536
|
</details>
|
|
3663
4537
|
|
|
3664
|
-
<details><summary><code>client.admin.
|
|
4538
|
+
<details><summary><code>client.admin.tenants.<a href="/lib/trophy/admin/tenants/client.rb">create</a>(request) -> Trophy::Types::CreateTenantsResponse</code></summary>
|
|
3665
4539
|
<dl>
|
|
3666
4540
|
<dd>
|
|
3667
4541
|
|
|
@@ -3673,7 +4547,7 @@ client.admin.settings.get
|
|
|
3673
4547
|
<dl>
|
|
3674
4548
|
<dd>
|
|
3675
4549
|
|
|
3676
|
-
|
|
4550
|
+
Create tenants.
|
|
3677
4551
|
</dd>
|
|
3678
4552
|
</dl>
|
|
3679
4553
|
</dd>
|
|
@@ -3688,21 +4562,13 @@ Update branding, experimentation, and aggregation settings.
|
|
|
3688
4562
|
<dd>
|
|
3689
4563
|
|
|
3690
4564
|
```ruby
|
|
3691
|
-
client.admin.
|
|
3692
|
-
|
|
3693
|
-
|
|
3694
|
-
|
|
3695
|
-
|
|
3696
|
-
|
|
3697
|
-
|
|
3698
|
-
}
|
|
3699
|
-
},
|
|
3700
|
-
experimentation: {
|
|
3701
|
-
control_ratio: 10,
|
|
3702
|
-
user_activation_window: 14
|
|
3703
|
-
},
|
|
3704
|
-
aggregation_period: "weekly"
|
|
3705
|
-
)
|
|
4565
|
+
client.admin.tenants.create(request: [{
|
|
4566
|
+
customer_id: "customer_12345",
|
|
4567
|
+
name: "Acme Corp"
|
|
4568
|
+
}, {
|
|
4569
|
+
customer_id: "customer_67890",
|
|
4570
|
+
name: "Globex Inc"
|
|
4571
|
+
}])
|
|
3706
4572
|
```
|
|
3707
4573
|
</dd>
|
|
3708
4574
|
</dl>
|
|
@@ -3717,23 +4583,7 @@ client.admin.settings.update(
|
|
|
3717
4583
|
<dl>
|
|
3718
4584
|
<dd>
|
|
3719
4585
|
|
|
3720
|
-
**
|
|
3721
|
-
|
|
3722
|
-
</dd>
|
|
3723
|
-
</dl>
|
|
3724
|
-
|
|
3725
|
-
<dl>
|
|
3726
|
-
<dd>
|
|
3727
|
-
|
|
3728
|
-
**experimentation:** `Trophy::Types::UpdateAdminSettingsExperimentation`
|
|
3729
|
-
|
|
3730
|
-
</dd>
|
|
3731
|
-
</dl>
|
|
3732
|
-
|
|
3733
|
-
<dl>
|
|
3734
|
-
<dd>
|
|
3735
|
-
|
|
3736
|
-
**aggregation_period:** `Trophy::Types::AdminAggregationPeriod`
|
|
4586
|
+
**request:** `Internal::Types::Array[Trophy::Types::CreateTenantRequestItem]`
|
|
3737
4587
|
|
|
3738
4588
|
</dd>
|
|
3739
4589
|
</dl>
|
|
@@ -3741,7 +4591,7 @@ client.admin.settings.update(
|
|
|
3741
4591
|
<dl>
|
|
3742
4592
|
<dd>
|
|
3743
4593
|
|
|
3744
|
-
**request_options:** `Trophy::Admin::
|
|
4594
|
+
**request_options:** `Trophy::Admin::Tenants::RequestOptions`
|
|
3745
4595
|
|
|
3746
4596
|
</dd>
|
|
3747
4597
|
</dl>
|
|
@@ -3753,8 +4603,7 @@ client.admin.settings.update(
|
|
|
3753
4603
|
</dl>
|
|
3754
4604
|
</details>
|
|
3755
4605
|
|
|
3756
|
-
|
|
3757
|
-
<details><summary><code>client.admin.application_api_keys.<a href="/lib/trophy/admin/application_api_keys/client.rb">create</a>(request) -> Trophy::Types::CreateApplicationKeysResponse</code></summary>
|
|
4606
|
+
<details><summary><code>client.admin.tenants.<a href="/lib/trophy/admin/tenants/client.rb">delete</a>() -> Trophy::Types::DeleteTenantsResponse</code></summary>
|
|
3758
4607
|
<dl>
|
|
3759
4608
|
<dd>
|
|
3760
4609
|
|
|
@@ -3766,7 +4615,7 @@ client.admin.settings.update(
|
|
|
3766
4615
|
<dl>
|
|
3767
4616
|
<dd>
|
|
3768
4617
|
|
|
3769
|
-
|
|
4618
|
+
Delete tenants by ID.
|
|
3770
4619
|
</dd>
|
|
3771
4620
|
</dl>
|
|
3772
4621
|
</dd>
|
|
@@ -3781,11 +4630,7 @@ Create application API keys scoped to specific users. Each key can only perform
|
|
|
3781
4630
|
<dd>
|
|
3782
4631
|
|
|
3783
4632
|
```ruby
|
|
3784
|
-
client.admin.
|
|
3785
|
-
user_id: "user_123"
|
|
3786
|
-
}, {
|
|
3787
|
-
user_id: "user_456"
|
|
3788
|
-
}])
|
|
4633
|
+
client.admin.tenants.delete(ids: %w[550e8400-e29b-41d4-a716-446655440000 550e8400-e29b-41d4-a716-446655440001])
|
|
3789
4634
|
```
|
|
3790
4635
|
</dd>
|
|
3791
4636
|
</dl>
|
|
@@ -3800,7 +4645,7 @@ client.admin.application_api_keys.create(request: [{
|
|
|
3800
4645
|
<dl>
|
|
3801
4646
|
<dd>
|
|
3802
4647
|
|
|
3803
|
-
**
|
|
4648
|
+
**ids:** `String` — Tenant IDs to delete. Repeat the query param or provide a comma-separated list.
|
|
3804
4649
|
|
|
3805
4650
|
</dd>
|
|
3806
4651
|
</dl>
|
|
@@ -3808,7 +4653,7 @@ client.admin.application_api_keys.create(request: [{
|
|
|
3808
4653
|
<dl>
|
|
3809
4654
|
<dd>
|
|
3810
4655
|
|
|
3811
|
-
**request_options:** `Trophy::Admin::
|
|
4656
|
+
**request_options:** `Trophy::Admin::Tenants::RequestOptions`
|
|
3812
4657
|
|
|
3813
4658
|
</dd>
|
|
3814
4659
|
</dl>
|
|
@@ -3820,7 +4665,7 @@ client.admin.application_api_keys.create(request: [{
|
|
|
3820
4665
|
</dl>
|
|
3821
4666
|
</details>
|
|
3822
4667
|
|
|
3823
|
-
<details><summary><code>client.admin.
|
|
4668
|
+
<details><summary><code>client.admin.tenants.<a href="/lib/trophy/admin/tenants/client.rb">update</a>(request) -> Trophy::Types::UpdateTenantsResponse</code></summary>
|
|
3824
4669
|
<dl>
|
|
3825
4670
|
<dd>
|
|
3826
4671
|
|
|
@@ -3832,7 +4677,7 @@ client.admin.application_api_keys.create(request: [{
|
|
|
3832
4677
|
<dl>
|
|
3833
4678
|
<dd>
|
|
3834
4679
|
|
|
3835
|
-
|
|
4680
|
+
Update tenants by ID.
|
|
3836
4681
|
</dd>
|
|
3837
4682
|
</dl>
|
|
3838
4683
|
</dd>
|
|
@@ -3847,7 +4692,10 @@ Delete application API keys by ID.
|
|
|
3847
4692
|
<dd>
|
|
3848
4693
|
|
|
3849
4694
|
```ruby
|
|
3850
|
-
client.admin.
|
|
4695
|
+
client.admin.tenants.update(request: [{
|
|
4696
|
+
id: "550e8400-e29b-41d4-a716-446655440000",
|
|
4697
|
+
name: "Acme Corporation"
|
|
4698
|
+
}])
|
|
3851
4699
|
```
|
|
3852
4700
|
</dd>
|
|
3853
4701
|
</dl>
|
|
@@ -3862,7 +4710,7 @@ client.admin.application_api_keys.delete(ids: ["550e8400-e29b-41d4-a716-44665544
|
|
|
3862
4710
|
<dl>
|
|
3863
4711
|
<dd>
|
|
3864
4712
|
|
|
3865
|
-
**
|
|
4713
|
+
**request:** `Internal::Types::Array[Trophy::Types::UpdateTenantRequestItem]`
|
|
3866
4714
|
|
|
3867
4715
|
</dd>
|
|
3868
4716
|
</dl>
|
|
@@ -3870,7 +4718,7 @@ client.admin.application_api_keys.delete(ids: ["550e8400-e29b-41d4-a716-44665544
|
|
|
3870
4718
|
<dl>
|
|
3871
4719
|
<dd>
|
|
3872
4720
|
|
|
3873
|
-
**request_options:** `Trophy::Admin::
|
|
4721
|
+
**request_options:** `Trophy::Admin::Tenants::RequestOptions`
|
|
3874
4722
|
|
|
3875
4723
|
</dd>
|
|
3876
4724
|
</dl>
|
|
@@ -3882,8 +4730,7 @@ client.admin.application_api_keys.delete(ids: ["550e8400-e29b-41d4-a716-44665544
|
|
|
3882
4730
|
</dl>
|
|
3883
4731
|
</details>
|
|
3884
4732
|
|
|
3885
|
-
|
|
3886
|
-
<details><summary><code>client.admin.environments.<a href="/lib/trophy/admin/environments/client.rb">list</a>() -> Internal::Types::Array[Trophy::Types::AdminEnvironment]</code></summary>
|
|
4733
|
+
<details><summary><code>client.admin.tenants.<a href="/lib/trophy/admin/tenants/client.rb">get</a>(id) -> Trophy::Types::AdminTenant</code></summary>
|
|
3887
4734
|
<dl>
|
|
3888
4735
|
<dd>
|
|
3889
4736
|
|
|
@@ -3895,7 +4742,7 @@ client.admin.application_api_keys.delete(ids: ["550e8400-e29b-41d4-a716-44665544
|
|
|
3895
4742
|
<dl>
|
|
3896
4743
|
<dd>
|
|
3897
4744
|
|
|
3898
|
-
|
|
4745
|
+
Get a tenant by ID.
|
|
3899
4746
|
</dd>
|
|
3900
4747
|
</dl>
|
|
3901
4748
|
</dd>
|
|
@@ -3910,7 +4757,7 @@ List active environments.
|
|
|
3910
4757
|
<dd>
|
|
3911
4758
|
|
|
3912
4759
|
```ruby
|
|
3913
|
-
client.admin.
|
|
4760
|
+
client.admin.tenants.get(id: "550e8400-e29b-41d4-a716-446655440000")
|
|
3914
4761
|
```
|
|
3915
4762
|
</dd>
|
|
3916
4763
|
</dl>
|
|
@@ -3925,7 +4772,15 @@ client.admin.environments.list
|
|
|
3925
4772
|
<dl>
|
|
3926
4773
|
<dd>
|
|
3927
4774
|
|
|
3928
|
-
**
|
|
4775
|
+
**id:** `String` — The UUID of the tenant to retrieve.
|
|
4776
|
+
|
|
4777
|
+
</dd>
|
|
4778
|
+
</dl>
|
|
4779
|
+
|
|
4780
|
+
<dl>
|
|
4781
|
+
<dd>
|
|
4782
|
+
|
|
4783
|
+
**request_options:** `Trophy::Admin::Tenants::RequestOptions`
|
|
3929
4784
|
|
|
3930
4785
|
</dd>
|
|
3931
4786
|
</dl>
|
|
@@ -3937,8 +4792,8 @@ client.admin.environments.list
|
|
|
3937
4792
|
</dl>
|
|
3938
4793
|
</details>
|
|
3939
4794
|
|
|
3940
|
-
## Admin
|
|
3941
|
-
<details><summary><code>client.admin.
|
|
4795
|
+
## Admin Points Systems
|
|
4796
|
+
<details><summary><code>client.admin.points.systems.<a href="/lib/trophy/admin/points/systems/client.rb">list</a>() -> Internal::Types::Array[Trophy::Types::AdminPointsSystem]</code></summary>
|
|
3942
4797
|
<dl>
|
|
3943
4798
|
<dd>
|
|
3944
4799
|
|
|
@@ -3950,7 +4805,7 @@ client.admin.environments.list
|
|
|
3950
4805
|
<dl>
|
|
3951
4806
|
<dd>
|
|
3952
4807
|
|
|
3953
|
-
List
|
|
4808
|
+
List points systems.
|
|
3954
4809
|
</dd>
|
|
3955
4810
|
</dl>
|
|
3956
4811
|
</dd>
|
|
@@ -3965,7 +4820,7 @@ List tenants in the current environment.
|
|
|
3965
4820
|
<dd>
|
|
3966
4821
|
|
|
3967
4822
|
```ruby
|
|
3968
|
-
client.admin.
|
|
4823
|
+
client.admin.points.systems.list(
|
|
3969
4824
|
limit: 1,
|
|
3970
4825
|
skip: 1
|
|
3971
4826
|
)
|
|
@@ -3999,7 +4854,7 @@ client.admin.tenants.list(
|
|
|
3999
4854
|
<dl>
|
|
4000
4855
|
<dd>
|
|
4001
4856
|
|
|
4002
|
-
**request_options:** `Trophy::Admin::
|
|
4857
|
+
**request_options:** `Trophy::Admin::Points::Systems::RequestOptions`
|
|
4003
4858
|
|
|
4004
4859
|
</dd>
|
|
4005
4860
|
</dl>
|
|
@@ -4011,7 +4866,7 @@ client.admin.tenants.list(
|
|
|
4011
4866
|
</dl>
|
|
4012
4867
|
</details>
|
|
4013
4868
|
|
|
4014
|
-
<details><summary><code>client.admin.
|
|
4869
|
+
<details><summary><code>client.admin.points.systems.<a href="/lib/trophy/admin/points/systems/client.rb">create</a>(request) -> Trophy::Types::CreatePointsSystemsResponse</code></summary>
|
|
4015
4870
|
<dl>
|
|
4016
4871
|
<dd>
|
|
4017
4872
|
|
|
@@ -4023,7 +4878,7 @@ client.admin.tenants.list(
|
|
|
4023
4878
|
<dl>
|
|
4024
4879
|
<dd>
|
|
4025
4880
|
|
|
4026
|
-
Create
|
|
4881
|
+
Create points systems. Optionally include sub-entities (levels, boosts, triggers) in each system payload to create them alongside the system.
|
|
4027
4882
|
</dd>
|
|
4028
4883
|
</dl>
|
|
4029
4884
|
</dd>
|
|
@@ -4038,12 +4893,19 @@ Create tenants.
|
|
|
4038
4893
|
<dd>
|
|
4039
4894
|
|
|
4040
4895
|
```ruby
|
|
4041
|
-
client.admin.
|
|
4042
|
-
|
|
4043
|
-
|
|
4044
|
-
|
|
4045
|
-
|
|
4046
|
-
|
|
4896
|
+
client.admin.points.systems.create(request: [{
|
|
4897
|
+
name: "XP",
|
|
4898
|
+
key: "xp",
|
|
4899
|
+
description: "Experience points",
|
|
4900
|
+
levels: [{
|
|
4901
|
+
name: "Bronze",
|
|
4902
|
+
key: "bronze",
|
|
4903
|
+
points: 100
|
|
4904
|
+
}, {
|
|
4905
|
+
name: "Silver",
|
|
4906
|
+
key: "silver",
|
|
4907
|
+
points: 500
|
|
4908
|
+
}]
|
|
4047
4909
|
}])
|
|
4048
4910
|
```
|
|
4049
4911
|
</dd>
|
|
@@ -4059,7 +4921,7 @@ client.admin.tenants.create(request: [{
|
|
|
4059
4921
|
<dl>
|
|
4060
4922
|
<dd>
|
|
4061
4923
|
|
|
4062
|
-
**request:** `Internal::Types::Array[Trophy::Types::
|
|
4924
|
+
**request:** `Internal::Types::Array[Trophy::Types::CreatePointsSystemRequestItem]`
|
|
4063
4925
|
|
|
4064
4926
|
</dd>
|
|
4065
4927
|
</dl>
|
|
@@ -4067,7 +4929,7 @@ client.admin.tenants.create(request: [{
|
|
|
4067
4929
|
<dl>
|
|
4068
4930
|
<dd>
|
|
4069
4931
|
|
|
4070
|
-
**request_options:** `Trophy::Admin::
|
|
4932
|
+
**request_options:** `Trophy::Admin::Points::Systems::RequestOptions`
|
|
4071
4933
|
|
|
4072
4934
|
</dd>
|
|
4073
4935
|
</dl>
|
|
@@ -4079,7 +4941,7 @@ client.admin.tenants.create(request: [{
|
|
|
4079
4941
|
</dl>
|
|
4080
4942
|
</details>
|
|
4081
4943
|
|
|
4082
|
-
<details><summary><code>client.admin.
|
|
4944
|
+
<details><summary><code>client.admin.points.systems.<a href="/lib/trophy/admin/points/systems/client.rb">delete</a>() -> Trophy::Types::DeletePointsSystemsResponse</code></summary>
|
|
4083
4945
|
<dl>
|
|
4084
4946
|
<dd>
|
|
4085
4947
|
|
|
@@ -4091,7 +4953,7 @@ client.admin.tenants.create(request: [{
|
|
|
4091
4953
|
<dl>
|
|
4092
4954
|
<dd>
|
|
4093
4955
|
|
|
4094
|
-
Delete
|
|
4956
|
+
Delete points systems by ID.
|
|
4095
4957
|
</dd>
|
|
4096
4958
|
</dl>
|
|
4097
4959
|
</dd>
|
|
@@ -4106,7 +4968,7 @@ Delete tenants by ID.
|
|
|
4106
4968
|
<dd>
|
|
4107
4969
|
|
|
4108
4970
|
```ruby
|
|
4109
|
-
client.admin.
|
|
4971
|
+
client.admin.points.systems.delete(ids: ["550e8400-e29b-41d4-a716-446655440000"])
|
|
4110
4972
|
```
|
|
4111
4973
|
</dd>
|
|
4112
4974
|
</dl>
|
|
@@ -4121,7 +4983,7 @@ client.admin.tenants.delete(ids: %w[550e8400-e29b-41d4-a716-446655440000 550e840
|
|
|
4121
4983
|
<dl>
|
|
4122
4984
|
<dd>
|
|
4123
4985
|
|
|
4124
|
-
**ids:** `String` —
|
|
4986
|
+
**ids:** `String` — The IDs of the points systems to delete.
|
|
4125
4987
|
|
|
4126
4988
|
</dd>
|
|
4127
4989
|
</dl>
|
|
@@ -4129,7 +4991,7 @@ client.admin.tenants.delete(ids: %w[550e8400-e29b-41d4-a716-446655440000 550e840
|
|
|
4129
4991
|
<dl>
|
|
4130
4992
|
<dd>
|
|
4131
4993
|
|
|
4132
|
-
**request_options:** `Trophy::Admin::
|
|
4994
|
+
**request_options:** `Trophy::Admin::Points::Systems::RequestOptions`
|
|
4133
4995
|
|
|
4134
4996
|
</dd>
|
|
4135
4997
|
</dl>
|
|
@@ -4141,7 +5003,7 @@ client.admin.tenants.delete(ids: %w[550e8400-e29b-41d4-a716-446655440000 550e840
|
|
|
4141
5003
|
</dl>
|
|
4142
5004
|
</details>
|
|
4143
5005
|
|
|
4144
|
-
<details><summary><code>client.admin.
|
|
5006
|
+
<details><summary><code>client.admin.points.systems.<a href="/lib/trophy/admin/points/systems/client.rb">update</a>(request) -> Trophy::Types::UpdatePointsSystemsResponse</code></summary>
|
|
4145
5007
|
<dl>
|
|
4146
5008
|
<dd>
|
|
4147
5009
|
|
|
@@ -4153,7 +5015,7 @@ client.admin.tenants.delete(ids: %w[550e8400-e29b-41d4-a716-446655440000 550e840
|
|
|
4153
5015
|
<dl>
|
|
4154
5016
|
<dd>
|
|
4155
5017
|
|
|
4156
|
-
Update
|
|
5018
|
+
Update points systems by ID.
|
|
4157
5019
|
</dd>
|
|
4158
5020
|
</dl>
|
|
4159
5021
|
</dd>
|
|
@@ -4168,9 +5030,9 @@ Update tenants by ID.
|
|
|
4168
5030
|
<dd>
|
|
4169
5031
|
|
|
4170
5032
|
```ruby
|
|
4171
|
-
client.admin.
|
|
5033
|
+
client.admin.points.systems.update(request: [{
|
|
4172
5034
|
id: "550e8400-e29b-41d4-a716-446655440000",
|
|
4173
|
-
name: "
|
|
5035
|
+
name: "New Name"
|
|
4174
5036
|
}])
|
|
4175
5037
|
```
|
|
4176
5038
|
</dd>
|
|
@@ -4186,7 +5048,7 @@ client.admin.tenants.update(request: [{
|
|
|
4186
5048
|
<dl>
|
|
4187
5049
|
<dd>
|
|
4188
5050
|
|
|
4189
|
-
**request:** `Internal::Types::Array[Trophy::Types::
|
|
5051
|
+
**request:** `Internal::Types::Array[Trophy::Types::UpdatePointsSystemRequestItem]`
|
|
4190
5052
|
|
|
4191
5053
|
</dd>
|
|
4192
5054
|
</dl>
|
|
@@ -4194,7 +5056,7 @@ client.admin.tenants.update(request: [{
|
|
|
4194
5056
|
<dl>
|
|
4195
5057
|
<dd>
|
|
4196
5058
|
|
|
4197
|
-
**request_options:** `Trophy::Admin::
|
|
5059
|
+
**request_options:** `Trophy::Admin::Points::Systems::RequestOptions`
|
|
4198
5060
|
|
|
4199
5061
|
</dd>
|
|
4200
5062
|
</dl>
|
|
@@ -4206,7 +5068,7 @@ client.admin.tenants.update(request: [{
|
|
|
4206
5068
|
</dl>
|
|
4207
5069
|
</details>
|
|
4208
5070
|
|
|
4209
|
-
<details><summary><code>client.admin.
|
|
5071
|
+
<details><summary><code>client.admin.points.systems.<a href="/lib/trophy/admin/points/systems/client.rb">get</a>(id) -> Trophy::Types::AdminPointsSystem</code></summary>
|
|
4210
5072
|
<dl>
|
|
4211
5073
|
<dd>
|
|
4212
5074
|
|
|
@@ -4218,7 +5080,7 @@ client.admin.tenants.update(request: [{
|
|
|
4218
5080
|
<dl>
|
|
4219
5081
|
<dd>
|
|
4220
5082
|
|
|
4221
|
-
Get a
|
|
5083
|
+
Get a points system by ID.
|
|
4222
5084
|
</dd>
|
|
4223
5085
|
</dl>
|
|
4224
5086
|
</dd>
|
|
@@ -4233,7 +5095,7 @@ Get a tenant by ID.
|
|
|
4233
5095
|
<dd>
|
|
4234
5096
|
|
|
4235
5097
|
```ruby
|
|
4236
|
-
client.admin.
|
|
5098
|
+
client.admin.points.systems.get(id: "550e8400-e29b-41d4-a716-446655440000")
|
|
4237
5099
|
```
|
|
4238
5100
|
</dd>
|
|
4239
5101
|
</dl>
|
|
@@ -4248,7 +5110,7 @@ client.admin.tenants.get(id: "550e8400-e29b-41d4-a716-446655440000")
|
|
|
4248
5110
|
<dl>
|
|
4249
5111
|
<dd>
|
|
4250
5112
|
|
|
4251
|
-
**id:** `String` — The
|
|
5113
|
+
**id:** `String` — The ID of the points system.
|
|
4252
5114
|
|
|
4253
5115
|
</dd>
|
|
4254
5116
|
</dl>
|
|
@@ -4256,7 +5118,7 @@ client.admin.tenants.get(id: "550e8400-e29b-41d4-a716-446655440000")
|
|
|
4256
5118
|
<dl>
|
|
4257
5119
|
<dd>
|
|
4258
5120
|
|
|
4259
|
-
**request_options:** `Trophy::Admin::
|
|
5121
|
+
**request_options:** `Trophy::Admin::Points::Systems::RequestOptions`
|
|
4260
5122
|
|
|
4261
5123
|
</dd>
|
|
4262
5124
|
</dl>
|
|
@@ -4268,8 +5130,8 @@ client.admin.tenants.get(id: "550e8400-e29b-41d4-a716-446655440000")
|
|
|
4268
5130
|
</dl>
|
|
4269
5131
|
</details>
|
|
4270
5132
|
|
|
4271
|
-
## Admin Points
|
|
4272
|
-
<details><summary><code>client.admin.points.
|
|
5133
|
+
## Admin Points Boosts
|
|
5134
|
+
<details><summary><code>client.admin.points.boosts.<a href="/lib/trophy/admin/points/boosts/client.rb">list</a>(system_id) -> Internal::Types::Array[Trophy::Types::AdminPointsBoost]</code></summary>
|
|
4273
5135
|
<dl>
|
|
4274
5136
|
<dd>
|
|
4275
5137
|
|
|
@@ -4281,7 +5143,7 @@ client.admin.tenants.get(id: "550e8400-e29b-41d4-a716-446655440000")
|
|
|
4281
5143
|
<dl>
|
|
4282
5144
|
<dd>
|
|
4283
5145
|
|
|
4284
|
-
List points
|
|
5146
|
+
List points boosts for a system.
|
|
4285
5147
|
</dd>
|
|
4286
5148
|
</dl>
|
|
4287
5149
|
</dd>
|
|
@@ -4296,7 +5158,8 @@ List points systems.
|
|
|
4296
5158
|
<dd>
|
|
4297
5159
|
|
|
4298
5160
|
```ruby
|
|
4299
|
-
client.admin.points.
|
|
5161
|
+
client.admin.points.boosts.list(
|
|
5162
|
+
system_id: "550e8400-e29b-41d4-a716-446655440000",
|
|
4300
5163
|
limit: 1,
|
|
4301
5164
|
skip: 1
|
|
4302
5165
|
)
|
|
@@ -4314,7 +5177,7 @@ client.admin.points.systems.list(
|
|
|
4314
5177
|
<dl>
|
|
4315
5178
|
<dd>
|
|
4316
5179
|
|
|
4317
|
-
**
|
|
5180
|
+
**system_id:** `String` — The UUID of the points system.
|
|
4318
5181
|
|
|
4319
5182
|
</dd>
|
|
4320
5183
|
</dl>
|
|
@@ -4322,7 +5185,7 @@ client.admin.points.systems.list(
|
|
|
4322
5185
|
<dl>
|
|
4323
5186
|
<dd>
|
|
4324
5187
|
|
|
4325
|
-
**
|
|
5188
|
+
**limit:** `Integer` — Maximum number of results to return (1-100, default 10).
|
|
4326
5189
|
|
|
4327
5190
|
</dd>
|
|
4328
5191
|
</dl>
|
|
@@ -4330,7 +5193,15 @@ client.admin.points.systems.list(
|
|
|
4330
5193
|
<dl>
|
|
4331
5194
|
<dd>
|
|
4332
5195
|
|
|
4333
|
-
**
|
|
5196
|
+
**skip:** `Integer` — Number of results to skip for pagination (default 0).
|
|
5197
|
+
|
|
5198
|
+
</dd>
|
|
5199
|
+
</dl>
|
|
5200
|
+
|
|
5201
|
+
<dl>
|
|
5202
|
+
<dd>
|
|
5203
|
+
|
|
5204
|
+
**request_options:** `Trophy::Admin::Points::Boosts::RequestOptions`
|
|
4334
5205
|
|
|
4335
5206
|
</dd>
|
|
4336
5207
|
</dl>
|
|
@@ -4342,7 +5213,7 @@ client.admin.points.systems.list(
|
|
|
4342
5213
|
</dl>
|
|
4343
5214
|
</details>
|
|
4344
5215
|
|
|
4345
|
-
<details><summary><code>client.admin.points.
|
|
5216
|
+
<details><summary><code>client.admin.points.boosts.<a href="/lib/trophy/admin/points/boosts/client.rb">create</a>(system_id, request) -> Trophy::Types::CreatePointsBoostsResponse</code></summary>
|
|
4346
5217
|
<dl>
|
|
4347
5218
|
<dd>
|
|
4348
5219
|
|
|
@@ -4354,7 +5225,7 @@ client.admin.points.systems.list(
|
|
|
4354
5225
|
<dl>
|
|
4355
5226
|
<dd>
|
|
4356
5227
|
|
|
4357
|
-
Create points
|
|
5228
|
+
Create points boosts.
|
|
4358
5229
|
</dd>
|
|
4359
5230
|
</dl>
|
|
4360
5231
|
</dd>
|
|
@@ -4369,20 +5240,16 @@ Create points systems. Optionally include sub-entities (levels, boosts, triggers
|
|
|
4369
5240
|
<dd>
|
|
4370
5241
|
|
|
4371
5242
|
```ruby
|
|
4372
|
-
client.admin.points.
|
|
4373
|
-
|
|
4374
|
-
|
|
4375
|
-
|
|
4376
|
-
|
|
4377
|
-
|
|
4378
|
-
|
|
4379
|
-
|
|
4380
|
-
}, {
|
|
4381
|
-
name: "Silver",
|
|
4382
|
-
key: "silver",
|
|
4383
|
-
points: 500
|
|
5243
|
+
client.admin.points.boosts.create(
|
|
5244
|
+
system_id: "550e8400-e29b-41d4-a716-446655440000",
|
|
5245
|
+
request: [{
|
|
5246
|
+
user_id: "user-123",
|
|
5247
|
+
name: "Double XP Weekend",
|
|
5248
|
+
start: "2024-01-01",
|
|
5249
|
+
end_: "2024-01-03",
|
|
5250
|
+
multiplier: 2
|
|
4384
5251
|
}]
|
|
4385
|
-
|
|
5252
|
+
)
|
|
4386
5253
|
```
|
|
4387
5254
|
</dd>
|
|
4388
5255
|
</dl>
|
|
@@ -4397,7 +5264,7 @@ client.admin.points.systems.create(request: [{
|
|
|
4397
5264
|
<dl>
|
|
4398
5265
|
<dd>
|
|
4399
5266
|
|
|
4400
|
-
**
|
|
5267
|
+
**system_id:** `String` — The UUID of the points system.
|
|
4401
5268
|
|
|
4402
5269
|
</dd>
|
|
4403
5270
|
</dl>
|
|
@@ -4405,7 +5272,15 @@ client.admin.points.systems.create(request: [{
|
|
|
4405
5272
|
<dl>
|
|
4406
5273
|
<dd>
|
|
4407
5274
|
|
|
4408
|
-
**
|
|
5275
|
+
**request:** `Internal::Types::Array[Trophy::Types::CreatePointsBoostRequestItem]`
|
|
5276
|
+
|
|
5277
|
+
</dd>
|
|
5278
|
+
</dl>
|
|
5279
|
+
|
|
5280
|
+
<dl>
|
|
5281
|
+
<dd>
|
|
5282
|
+
|
|
5283
|
+
**request_options:** `Trophy::Admin::Points::Boosts::RequestOptions`
|
|
4409
5284
|
|
|
4410
5285
|
</dd>
|
|
4411
5286
|
</dl>
|
|
@@ -4417,7 +5292,7 @@ client.admin.points.systems.create(request: [{
|
|
|
4417
5292
|
</dl>
|
|
4418
5293
|
</details>
|
|
4419
5294
|
|
|
4420
|
-
<details><summary><code>client.admin.points.
|
|
5295
|
+
<details><summary><code>client.admin.points.boosts.<a href="/lib/trophy/admin/points/boosts/client.rb">delete</a>(system_id) -> Trophy::Types::DeletePointsBoostsResponse</code></summary>
|
|
4421
5296
|
<dl>
|
|
4422
5297
|
<dd>
|
|
4423
5298
|
|
|
@@ -4429,7 +5304,7 @@ client.admin.points.systems.create(request: [{
|
|
|
4429
5304
|
<dl>
|
|
4430
5305
|
<dd>
|
|
4431
5306
|
|
|
4432
|
-
Delete points
|
|
5307
|
+
Delete multiple points boosts by ID.
|
|
4433
5308
|
</dd>
|
|
4434
5309
|
</dl>
|
|
4435
5310
|
</dd>
|
|
@@ -4444,7 +5319,10 @@ Delete points systems by ID.
|
|
|
4444
5319
|
<dd>
|
|
4445
5320
|
|
|
4446
5321
|
```ruby
|
|
4447
|
-
client.admin.points.
|
|
5322
|
+
client.admin.points.boosts.delete(
|
|
5323
|
+
system_id: "550e8400-e29b-41d4-a716-446655440000",
|
|
5324
|
+
ids: ["ids"]
|
|
5325
|
+
)
|
|
4448
5326
|
```
|
|
4449
5327
|
</dd>
|
|
4450
5328
|
</dl>
|
|
@@ -4459,7 +5337,7 @@ client.admin.points.systems.delete(ids: ["550e8400-e29b-41d4-a716-446655440000"]
|
|
|
4459
5337
|
<dl>
|
|
4460
5338
|
<dd>
|
|
4461
5339
|
|
|
4462
|
-
**
|
|
5340
|
+
**system_id:** `String` — The UUID of the points system.
|
|
4463
5341
|
|
|
4464
5342
|
</dd>
|
|
4465
5343
|
</dl>
|
|
@@ -4467,7 +5345,15 @@ client.admin.points.systems.delete(ids: ["550e8400-e29b-41d4-a716-446655440000"]
|
|
|
4467
5345
|
<dl>
|
|
4468
5346
|
<dd>
|
|
4469
5347
|
|
|
4470
|
-
**
|
|
5348
|
+
**ids:** `String` — A list of up to 100 boost IDs.
|
|
5349
|
+
|
|
5350
|
+
</dd>
|
|
5351
|
+
</dl>
|
|
5352
|
+
|
|
5353
|
+
<dl>
|
|
5354
|
+
<dd>
|
|
5355
|
+
|
|
5356
|
+
**request_options:** `Trophy::Admin::Points::Boosts::RequestOptions`
|
|
4471
5357
|
|
|
4472
5358
|
</dd>
|
|
4473
5359
|
</dl>
|
|
@@ -4479,7 +5365,7 @@ client.admin.points.systems.delete(ids: ["550e8400-e29b-41d4-a716-446655440000"]
|
|
|
4479
5365
|
</dl>
|
|
4480
5366
|
</details>
|
|
4481
5367
|
|
|
4482
|
-
<details><summary><code>client.admin.points.
|
|
5368
|
+
<details><summary><code>client.admin.points.boosts.<a href="/lib/trophy/admin/points/boosts/client.rb">update</a>(system_id, request) -> Trophy::Types::PatchPointsBoostsResponse</code></summary>
|
|
4483
5369
|
<dl>
|
|
4484
5370
|
<dd>
|
|
4485
5371
|
|
|
@@ -4491,7 +5377,7 @@ client.admin.points.systems.delete(ids: ["550e8400-e29b-41d4-a716-446655440000"]
|
|
|
4491
5377
|
<dl>
|
|
4492
5378
|
<dd>
|
|
4493
5379
|
|
|
4494
|
-
Update points
|
|
5380
|
+
Update multiple points boosts.
|
|
4495
5381
|
</dd>
|
|
4496
5382
|
</dl>
|
|
4497
5383
|
</dd>
|
|
@@ -4506,10 +5392,14 @@ Update points systems by ID.
|
|
|
4506
5392
|
<dd>
|
|
4507
5393
|
|
|
4508
5394
|
```ruby
|
|
4509
|
-
client.admin.points.
|
|
4510
|
-
|
|
4511
|
-
|
|
4512
|
-
|
|
5395
|
+
client.admin.points.boosts.update(
|
|
5396
|
+
system_id: "550e8400-e29b-41d4-a716-446655440000",
|
|
5397
|
+
request: [{
|
|
5398
|
+
id: "550e8400-e29b-41d4-a716-446655440000",
|
|
5399
|
+
name: "Updated Boost Name",
|
|
5400
|
+
multiplier: 3
|
|
5401
|
+
}]
|
|
5402
|
+
)
|
|
4513
5403
|
```
|
|
4514
5404
|
</dd>
|
|
4515
5405
|
</dl>
|
|
@@ -4524,7 +5414,7 @@ client.admin.points.systems.update(request: [{
|
|
|
4524
5414
|
<dl>
|
|
4525
5415
|
<dd>
|
|
4526
5416
|
|
|
4527
|
-
**
|
|
5417
|
+
**system_id:** `String` — The UUID of the points system.
|
|
4528
5418
|
|
|
4529
5419
|
</dd>
|
|
4530
5420
|
</dl>
|
|
@@ -4532,7 +5422,15 @@ client.admin.points.systems.update(request: [{
|
|
|
4532
5422
|
<dl>
|
|
4533
5423
|
<dd>
|
|
4534
5424
|
|
|
4535
|
-
**
|
|
5425
|
+
**request:** `Internal::Types::Array[Trophy::Types::PatchPointsBoostsRequestItem]`
|
|
5426
|
+
|
|
5427
|
+
</dd>
|
|
5428
|
+
</dl>
|
|
5429
|
+
|
|
5430
|
+
<dl>
|
|
5431
|
+
<dd>
|
|
5432
|
+
|
|
5433
|
+
**request_options:** `Trophy::Admin::Points::Boosts::RequestOptions`
|
|
4536
5434
|
|
|
4537
5435
|
</dd>
|
|
4538
5436
|
</dl>
|
|
@@ -4544,7 +5442,7 @@ client.admin.points.systems.update(request: [{
|
|
|
4544
5442
|
</dl>
|
|
4545
5443
|
</details>
|
|
4546
5444
|
|
|
4547
|
-
<details><summary><code>client.admin.points.
|
|
5445
|
+
<details><summary><code>client.admin.points.boosts.<a href="/lib/trophy/admin/points/boosts/client.rb">get</a>(system_id, id) -> Trophy::Types::AdminPointsBoost</code></summary>
|
|
4548
5446
|
<dl>
|
|
4549
5447
|
<dd>
|
|
4550
5448
|
|
|
@@ -4556,7 +5454,7 @@ client.admin.points.systems.update(request: [{
|
|
|
4556
5454
|
<dl>
|
|
4557
5455
|
<dd>
|
|
4558
5456
|
|
|
4559
|
-
Get a points
|
|
5457
|
+
Get a single points boost by ID.
|
|
4560
5458
|
</dd>
|
|
4561
5459
|
</dl>
|
|
4562
5460
|
</dd>
|
|
@@ -4571,7 +5469,10 @@ Get a points system by ID.
|
|
|
4571
5469
|
<dd>
|
|
4572
5470
|
|
|
4573
5471
|
```ruby
|
|
4574
|
-
client.admin.points.
|
|
5472
|
+
client.admin.points.boosts.get(
|
|
5473
|
+
system_id: "550e8400-e29b-41d4-a716-446655440000",
|
|
5474
|
+
id: "660f9500-f30c-42e5-b827-557766550001"
|
|
5475
|
+
)
|
|
4575
5476
|
```
|
|
4576
5477
|
</dd>
|
|
4577
5478
|
</dl>
|
|
@@ -4586,7 +5487,7 @@ client.admin.points.systems.get(id: "550e8400-e29b-41d4-a716-446655440000")
|
|
|
4586
5487
|
<dl>
|
|
4587
5488
|
<dd>
|
|
4588
5489
|
|
|
4589
|
-
**
|
|
5490
|
+
**system_id:** `String` — The UUID of the points system.
|
|
4590
5491
|
|
|
4591
5492
|
</dd>
|
|
4592
5493
|
</dl>
|
|
@@ -4594,7 +5495,15 @@ client.admin.points.systems.get(id: "550e8400-e29b-41d4-a716-446655440000")
|
|
|
4594
5495
|
<dl>
|
|
4595
5496
|
<dd>
|
|
4596
5497
|
|
|
4597
|
-
**
|
|
5498
|
+
**id:** `String` — The UUID of the points boost.
|
|
5499
|
+
|
|
5500
|
+
</dd>
|
|
5501
|
+
</dl>
|
|
5502
|
+
|
|
5503
|
+
<dl>
|
|
5504
|
+
<dd>
|
|
5505
|
+
|
|
5506
|
+
**request_options:** `Trophy::Admin::Points::Boosts::RequestOptions`
|
|
4598
5507
|
|
|
4599
5508
|
</dd>
|
|
4600
5509
|
</dl>
|
|
@@ -4606,8 +5515,8 @@ client.admin.points.systems.get(id: "550e8400-e29b-41d4-a716-446655440000")
|
|
|
4606
5515
|
</dl>
|
|
4607
5516
|
</details>
|
|
4608
5517
|
|
|
4609
|
-
## Admin Points
|
|
4610
|
-
<details><summary><code>client.admin.points.
|
|
5518
|
+
## Admin Points Levels
|
|
5519
|
+
<details><summary><code>client.admin.points.levels.<a href="/lib/trophy/admin/points/levels/client.rb">list</a>(system_id) -> Internal::Types::Array[Trophy::Types::AdminPointsLevel]</code></summary>
|
|
4611
5520
|
<dl>
|
|
4612
5521
|
<dd>
|
|
4613
5522
|
|
|
@@ -4619,7 +5528,7 @@ client.admin.points.systems.get(id: "550e8400-e29b-41d4-a716-446655440000")
|
|
|
4619
5528
|
<dl>
|
|
4620
5529
|
<dd>
|
|
4621
5530
|
|
|
4622
|
-
List points
|
|
5531
|
+
List points levels for a system.
|
|
4623
5532
|
</dd>
|
|
4624
5533
|
</dl>
|
|
4625
5534
|
</dd>
|
|
@@ -4634,7 +5543,7 @@ List points boosts for a system.
|
|
|
4634
5543
|
<dd>
|
|
4635
5544
|
|
|
4636
5545
|
```ruby
|
|
4637
|
-
client.admin.points.
|
|
5546
|
+
client.admin.points.levels.list(
|
|
4638
5547
|
system_id: "550e8400-e29b-41d4-a716-446655440000",
|
|
4639
5548
|
limit: 1,
|
|
4640
5549
|
skip: 1
|
|
@@ -4661,7 +5570,7 @@ client.admin.points.boosts.list(
|
|
|
4661
5570
|
<dl>
|
|
4662
5571
|
<dd>
|
|
4663
5572
|
|
|
4664
|
-
**limit:** `Integer` —
|
|
5573
|
+
**limit:** `Integer` — Number of records to return.
|
|
4665
5574
|
|
|
4666
5575
|
</dd>
|
|
4667
5576
|
</dl>
|
|
@@ -4669,7 +5578,7 @@ client.admin.points.boosts.list(
|
|
|
4669
5578
|
<dl>
|
|
4670
5579
|
<dd>
|
|
4671
5580
|
|
|
4672
|
-
**skip:** `Integer` — Number of
|
|
5581
|
+
**skip:** `Integer` — Number of records to skip from the start of the list.
|
|
4673
5582
|
|
|
4674
5583
|
</dd>
|
|
4675
5584
|
</dl>
|
|
@@ -4677,7 +5586,7 @@ client.admin.points.boosts.list(
|
|
|
4677
5586
|
<dl>
|
|
4678
5587
|
<dd>
|
|
4679
5588
|
|
|
4680
|
-
**request_options:** `Trophy::Admin::Points::
|
|
5589
|
+
**request_options:** `Trophy::Admin::Points::Levels::RequestOptions`
|
|
4681
5590
|
|
|
4682
5591
|
</dd>
|
|
4683
5592
|
</dl>
|
|
@@ -4689,7 +5598,7 @@ client.admin.points.boosts.list(
|
|
|
4689
5598
|
</dl>
|
|
4690
5599
|
</details>
|
|
4691
5600
|
|
|
4692
|
-
<details><summary><code>client.admin.points.
|
|
5601
|
+
<details><summary><code>client.admin.points.levels.<a href="/lib/trophy/admin/points/levels/client.rb">create</a>(system_id, request) -> Trophy::Types::CreatePointsLevelsResponse</code></summary>
|
|
4693
5602
|
<dl>
|
|
4694
5603
|
<dd>
|
|
4695
5604
|
|
|
@@ -4701,7 +5610,7 @@ client.admin.points.boosts.list(
|
|
|
4701
5610
|
<dl>
|
|
4702
5611
|
<dd>
|
|
4703
5612
|
|
|
4704
|
-
Create points
|
|
5613
|
+
Create points levels.
|
|
4705
5614
|
</dd>
|
|
4706
5615
|
</dl>
|
|
4707
5616
|
</dd>
|
|
@@ -4716,14 +5625,12 @@ Create points boosts.
|
|
|
4716
5625
|
<dd>
|
|
4717
5626
|
|
|
4718
5627
|
```ruby
|
|
4719
|
-
client.admin.points.
|
|
5628
|
+
client.admin.points.levels.create(
|
|
4720
5629
|
system_id: "550e8400-e29b-41d4-a716-446655440000",
|
|
4721
5630
|
request: [{
|
|
4722
|
-
|
|
4723
|
-
|
|
4724
|
-
|
|
4725
|
-
end_: "2024-01-03",
|
|
4726
|
-
multiplier: 2
|
|
5631
|
+
name: "Bronze",
|
|
5632
|
+
key: "bronze",
|
|
5633
|
+
points: 100
|
|
4727
5634
|
}]
|
|
4728
5635
|
)
|
|
4729
5636
|
```
|
|
@@ -4748,7 +5655,7 @@ client.admin.points.boosts.create(
|
|
|
4748
5655
|
<dl>
|
|
4749
5656
|
<dd>
|
|
4750
5657
|
|
|
4751
|
-
**request:** `Internal::Types::Array[Trophy::Types::
|
|
5658
|
+
**request:** `Internal::Types::Array[Trophy::Types::CreatePointsLevelRequestItem]`
|
|
4752
5659
|
|
|
4753
5660
|
</dd>
|
|
4754
5661
|
</dl>
|
|
@@ -4756,7 +5663,7 @@ client.admin.points.boosts.create(
|
|
|
4756
5663
|
<dl>
|
|
4757
5664
|
<dd>
|
|
4758
5665
|
|
|
4759
|
-
**request_options:** `Trophy::Admin::Points::
|
|
5666
|
+
**request_options:** `Trophy::Admin::Points::Levels::RequestOptions`
|
|
4760
5667
|
|
|
4761
5668
|
</dd>
|
|
4762
5669
|
</dl>
|
|
@@ -4768,7 +5675,7 @@ client.admin.points.boosts.create(
|
|
|
4768
5675
|
</dl>
|
|
4769
5676
|
</details>
|
|
4770
5677
|
|
|
4771
|
-
<details><summary><code>client.admin.points.
|
|
5678
|
+
<details><summary><code>client.admin.points.levels.<a href="/lib/trophy/admin/points/levels/client.rb">delete</a>(system_id) -> Trophy::Types::DeletePointsLevelsResponse</code></summary>
|
|
4772
5679
|
<dl>
|
|
4773
5680
|
<dd>
|
|
4774
5681
|
|
|
@@ -4780,7 +5687,7 @@ client.admin.points.boosts.create(
|
|
|
4780
5687
|
<dl>
|
|
4781
5688
|
<dd>
|
|
4782
5689
|
|
|
4783
|
-
Delete multiple points
|
|
5690
|
+
Delete multiple points levels by ID.
|
|
4784
5691
|
</dd>
|
|
4785
5692
|
</dl>
|
|
4786
5693
|
</dd>
|
|
@@ -4795,7 +5702,7 @@ Delete multiple points boosts by ID.
|
|
|
4795
5702
|
<dd>
|
|
4796
5703
|
|
|
4797
5704
|
```ruby
|
|
4798
|
-
client.admin.points.
|
|
5705
|
+
client.admin.points.levels.delete(
|
|
4799
5706
|
system_id: "550e8400-e29b-41d4-a716-446655440000",
|
|
4800
5707
|
ids: ["ids"]
|
|
4801
5708
|
)
|
|
@@ -4821,7 +5728,7 @@ client.admin.points.boosts.delete(
|
|
|
4821
5728
|
<dl>
|
|
4822
5729
|
<dd>
|
|
4823
5730
|
|
|
4824
|
-
**ids:** `String` —
|
|
5731
|
+
**ids:** `String` — Comma-separated list of level UUIDs to delete.
|
|
4825
5732
|
|
|
4826
5733
|
</dd>
|
|
4827
5734
|
</dl>
|
|
@@ -4829,7 +5736,7 @@ client.admin.points.boosts.delete(
|
|
|
4829
5736
|
<dl>
|
|
4830
5737
|
<dd>
|
|
4831
5738
|
|
|
4832
|
-
**request_options:** `Trophy::Admin::Points::
|
|
5739
|
+
**request_options:** `Trophy::Admin::Points::Levels::RequestOptions`
|
|
4833
5740
|
|
|
4834
5741
|
</dd>
|
|
4835
5742
|
</dl>
|
|
@@ -4841,7 +5748,7 @@ client.admin.points.boosts.delete(
|
|
|
4841
5748
|
</dl>
|
|
4842
5749
|
</details>
|
|
4843
5750
|
|
|
4844
|
-
<details><summary><code>client.admin.points.
|
|
5751
|
+
<details><summary><code>client.admin.points.levels.<a href="/lib/trophy/admin/points/levels/client.rb">update</a>(system_id, request) -> Trophy::Types::PatchPointsLevelsResponse</code></summary>
|
|
4845
5752
|
<dl>
|
|
4846
5753
|
<dd>
|
|
4847
5754
|
|
|
@@ -4853,7 +5760,7 @@ client.admin.points.boosts.delete(
|
|
|
4853
5760
|
<dl>
|
|
4854
5761
|
<dd>
|
|
4855
5762
|
|
|
4856
|
-
Update multiple points
|
|
5763
|
+
Update multiple points levels. Each item must include an ID. `key` cannot be changed.
|
|
4857
5764
|
</dd>
|
|
4858
5765
|
</dl>
|
|
4859
5766
|
</dd>
|
|
@@ -4868,12 +5775,10 @@ Update multiple points boosts.
|
|
|
4868
5775
|
<dd>
|
|
4869
5776
|
|
|
4870
5777
|
```ruby
|
|
4871
|
-
client.admin.points.
|
|
5778
|
+
client.admin.points.levels.update(
|
|
4872
5779
|
system_id: "550e8400-e29b-41d4-a716-446655440000",
|
|
4873
5780
|
request: [{
|
|
4874
|
-
id: "550e8400-e29b-41d4-a716-446655440000"
|
|
4875
|
-
name: "Updated Boost Name",
|
|
4876
|
-
multiplier: 3
|
|
5781
|
+
id: "550e8400-e29b-41d4-a716-446655440000"
|
|
4877
5782
|
}]
|
|
4878
5783
|
)
|
|
4879
5784
|
```
|
|
@@ -4898,7 +5803,7 @@ client.admin.points.boosts.update(
|
|
|
4898
5803
|
<dl>
|
|
4899
5804
|
<dd>
|
|
4900
5805
|
|
|
4901
|
-
**request:** `Internal::Types::Array[Trophy::Types::
|
|
5806
|
+
**request:** `Internal::Types::Array[Trophy::Types::PatchPointsLevelsRequestItem]`
|
|
4902
5807
|
|
|
4903
5808
|
</dd>
|
|
4904
5809
|
</dl>
|
|
@@ -4906,7 +5811,7 @@ client.admin.points.boosts.update(
|
|
|
4906
5811
|
<dl>
|
|
4907
5812
|
<dd>
|
|
4908
5813
|
|
|
4909
|
-
**request_options:** `Trophy::Admin::Points::
|
|
5814
|
+
**request_options:** `Trophy::Admin::Points::Levels::RequestOptions`
|
|
4910
5815
|
|
|
4911
5816
|
</dd>
|
|
4912
5817
|
</dl>
|
|
@@ -4918,7 +5823,7 @@ client.admin.points.boosts.update(
|
|
|
4918
5823
|
</dl>
|
|
4919
5824
|
</details>
|
|
4920
5825
|
|
|
4921
|
-
<details><summary><code>client.admin.points.
|
|
5826
|
+
<details><summary><code>client.admin.points.levels.<a href="/lib/trophy/admin/points/levels/client.rb">get</a>(system_id, id) -> Trophy::Types::AdminPointsLevel</code></summary>
|
|
4922
5827
|
<dl>
|
|
4923
5828
|
<dd>
|
|
4924
5829
|
|
|
@@ -4930,7 +5835,7 @@ client.admin.points.boosts.update(
|
|
|
4930
5835
|
<dl>
|
|
4931
5836
|
<dd>
|
|
4932
5837
|
|
|
4933
|
-
Get a single points
|
|
5838
|
+
Get a single points level by ID.
|
|
4934
5839
|
</dd>
|
|
4935
5840
|
</dl>
|
|
4936
5841
|
</dd>
|
|
@@ -4945,7 +5850,7 @@ Get a single points boost by ID.
|
|
|
4945
5850
|
<dd>
|
|
4946
5851
|
|
|
4947
5852
|
```ruby
|
|
4948
|
-
client.admin.points.
|
|
5853
|
+
client.admin.points.levels.get(
|
|
4949
5854
|
system_id: "550e8400-e29b-41d4-a716-446655440000",
|
|
4950
5855
|
id: "660f9500-f30c-42e5-b827-557766550001"
|
|
4951
5856
|
)
|
|
@@ -4971,7 +5876,7 @@ client.admin.points.boosts.get(
|
|
|
4971
5876
|
<dl>
|
|
4972
5877
|
<dd>
|
|
4973
5878
|
|
|
4974
|
-
**id:** `String` — The UUID of the points
|
|
5879
|
+
**id:** `String` — The UUID of the points level.
|
|
4975
5880
|
|
|
4976
5881
|
</dd>
|
|
4977
5882
|
</dl>
|
|
@@ -4979,7 +5884,7 @@ client.admin.points.boosts.get(
|
|
|
4979
5884
|
<dl>
|
|
4980
5885
|
<dd>
|
|
4981
5886
|
|
|
4982
|
-
**request_options:** `Trophy::Admin::Points::
|
|
5887
|
+
**request_options:** `Trophy::Admin::Points::Levels::RequestOptions`
|
|
4983
5888
|
|
|
4984
5889
|
</dd>
|
|
4985
5890
|
</dl>
|
|
@@ -4991,8 +5896,8 @@ client.admin.points.boosts.get(
|
|
|
4991
5896
|
</dl>
|
|
4992
5897
|
</details>
|
|
4993
5898
|
|
|
4994
|
-
## Admin Points
|
|
4995
|
-
<details><summary><code>client.admin.points.
|
|
5899
|
+
## Admin Points Triggers
|
|
5900
|
+
<details><summary><code>client.admin.points.triggers.<a href="/lib/trophy/admin/points/triggers/client.rb">list</a>(system_id) -> Internal::Types::Array[Trophy::Types::AdminPointsTrigger]</code></summary>
|
|
4996
5901
|
<dl>
|
|
4997
5902
|
<dd>
|
|
4998
5903
|
|
|
@@ -5004,7 +5909,7 @@ client.admin.points.boosts.get(
|
|
|
5004
5909
|
<dl>
|
|
5005
5910
|
<dd>
|
|
5006
5911
|
|
|
5007
|
-
List points
|
|
5912
|
+
List points triggers for a system.
|
|
5008
5913
|
</dd>
|
|
5009
5914
|
</dl>
|
|
5010
5915
|
</dd>
|
|
@@ -5019,7 +5924,7 @@ List points levels for a system.
|
|
|
5019
5924
|
<dd>
|
|
5020
5925
|
|
|
5021
5926
|
```ruby
|
|
5022
|
-
client.admin.points.
|
|
5927
|
+
client.admin.points.triggers.list(
|
|
5023
5928
|
system_id: "550e8400-e29b-41d4-a716-446655440000",
|
|
5024
5929
|
limit: 1,
|
|
5025
5930
|
skip: 1
|
|
@@ -5046,7 +5951,7 @@ client.admin.points.levels.list(
|
|
|
5046
5951
|
<dl>
|
|
5047
5952
|
<dd>
|
|
5048
5953
|
|
|
5049
|
-
**limit:** `Integer` —
|
|
5954
|
+
**limit:** `Integer` — Maximum number of results to return (1-100, default 10).
|
|
5050
5955
|
|
|
5051
5956
|
</dd>
|
|
5052
5957
|
</dl>
|
|
@@ -5054,7 +5959,7 @@ client.admin.points.levels.list(
|
|
|
5054
5959
|
<dl>
|
|
5055
5960
|
<dd>
|
|
5056
5961
|
|
|
5057
|
-
**skip:** `Integer` — Number of
|
|
5962
|
+
**skip:** `Integer` — Number of results to skip for pagination (default 0).
|
|
5058
5963
|
|
|
5059
5964
|
</dd>
|
|
5060
5965
|
</dl>
|
|
@@ -5062,7 +5967,7 @@ client.admin.points.levels.list(
|
|
|
5062
5967
|
<dl>
|
|
5063
5968
|
<dd>
|
|
5064
5969
|
|
|
5065
|
-
**request_options:** `Trophy::Admin::Points::
|
|
5970
|
+
**request_options:** `Trophy::Admin::Points::Triggers::RequestOptions`
|
|
5066
5971
|
|
|
5067
5972
|
</dd>
|
|
5068
5973
|
</dl>
|
|
@@ -5074,7 +5979,7 @@ client.admin.points.levels.list(
|
|
|
5074
5979
|
</dl>
|
|
5075
5980
|
</details>
|
|
5076
5981
|
|
|
5077
|
-
<details><summary><code>client.admin.points.
|
|
5982
|
+
<details><summary><code>client.admin.points.triggers.<a href="/lib/trophy/admin/points/triggers/client.rb">create</a>(system_id, request) -> Trophy::Types::CreatePointsTriggersResponse</code></summary>
|
|
5078
5983
|
<dl>
|
|
5079
5984
|
<dd>
|
|
5080
5985
|
|
|
@@ -5086,7 +5991,7 @@ client.admin.points.levels.list(
|
|
|
5086
5991
|
<dl>
|
|
5087
5992
|
<dd>
|
|
5088
5993
|
|
|
5089
|
-
Create points
|
|
5994
|
+
Create points triggers in bulk.
|
|
5090
5995
|
</dd>
|
|
5091
5996
|
</dl>
|
|
5092
5997
|
</dd>
|
|
@@ -5101,12 +6006,11 @@ Create points levels.
|
|
|
5101
6006
|
<dd>
|
|
5102
6007
|
|
|
5103
6008
|
```ruby
|
|
5104
|
-
client.admin.points.
|
|
6009
|
+
client.admin.points.triggers.create(
|
|
5105
6010
|
system_id: "550e8400-e29b-41d4-a716-446655440000",
|
|
5106
6011
|
request: [{
|
|
5107
|
-
|
|
5108
|
-
|
|
5109
|
-
points: 100
|
|
6012
|
+
type: "metric",
|
|
6013
|
+
points: 10
|
|
5110
6014
|
}]
|
|
5111
6015
|
)
|
|
5112
6016
|
```
|
|
@@ -5131,7 +6035,7 @@ client.admin.points.levels.create(
|
|
|
5131
6035
|
<dl>
|
|
5132
6036
|
<dd>
|
|
5133
6037
|
|
|
5134
|
-
**request:** `Internal::Types::Array[Trophy::Types::
|
|
6038
|
+
**request:** `Internal::Types::Array[Trophy::Types::CreatePointsTriggerRequestItem]`
|
|
5135
6039
|
|
|
5136
6040
|
</dd>
|
|
5137
6041
|
</dl>
|
|
@@ -5139,7 +6043,7 @@ client.admin.points.levels.create(
|
|
|
5139
6043
|
<dl>
|
|
5140
6044
|
<dd>
|
|
5141
6045
|
|
|
5142
|
-
**request_options:** `Trophy::Admin::Points::
|
|
6046
|
+
**request_options:** `Trophy::Admin::Points::Triggers::RequestOptions`
|
|
5143
6047
|
|
|
5144
6048
|
</dd>
|
|
5145
6049
|
</dl>
|
|
@@ -5151,7 +6055,7 @@ client.admin.points.levels.create(
|
|
|
5151
6055
|
</dl>
|
|
5152
6056
|
</details>
|
|
5153
6057
|
|
|
5154
|
-
<details><summary><code>client.admin.points.
|
|
6058
|
+
<details><summary><code>client.admin.points.triggers.<a href="/lib/trophy/admin/points/triggers/client.rb">delete</a>(system_id) -> Trophy::Types::DeletePointsTriggersResponse</code></summary>
|
|
5155
6059
|
<dl>
|
|
5156
6060
|
<dd>
|
|
5157
6061
|
|
|
@@ -5163,7 +6067,7 @@ client.admin.points.levels.create(
|
|
|
5163
6067
|
<dl>
|
|
5164
6068
|
<dd>
|
|
5165
6069
|
|
|
5166
|
-
Delete
|
|
6070
|
+
Delete points triggers by ID. Maximum 100 trigger IDs per request.
|
|
5167
6071
|
</dd>
|
|
5168
6072
|
</dl>
|
|
5169
6073
|
</dd>
|
|
@@ -5178,9 +6082,9 @@ Delete multiple points levels by ID.
|
|
|
5178
6082
|
<dd>
|
|
5179
6083
|
|
|
5180
6084
|
```ruby
|
|
5181
|
-
client.admin.points.
|
|
6085
|
+
client.admin.points.triggers.delete(
|
|
5182
6086
|
system_id: "550e8400-e29b-41d4-a716-446655440000",
|
|
5183
|
-
ids: ["
|
|
6087
|
+
ids: ["550e8400-e29b-41d4-a716-446655440000"]
|
|
5184
6088
|
)
|
|
5185
6089
|
```
|
|
5186
6090
|
</dd>
|
|
@@ -5204,7 +6108,7 @@ client.admin.points.levels.delete(
|
|
|
5204
6108
|
<dl>
|
|
5205
6109
|
<dd>
|
|
5206
6110
|
|
|
5207
|
-
**ids:** `String` —
|
|
6111
|
+
**ids:** `String` — Trigger IDs to delete. Can be repeated or comma-separated.
|
|
5208
6112
|
|
|
5209
6113
|
</dd>
|
|
5210
6114
|
</dl>
|
|
@@ -5212,7 +6116,7 @@ client.admin.points.levels.delete(
|
|
|
5212
6116
|
<dl>
|
|
5213
6117
|
<dd>
|
|
5214
6118
|
|
|
5215
|
-
**request_options:** `Trophy::Admin::Points::
|
|
6119
|
+
**request_options:** `Trophy::Admin::Points::Triggers::RequestOptions`
|
|
5216
6120
|
|
|
5217
6121
|
</dd>
|
|
5218
6122
|
</dl>
|
|
@@ -5224,7 +6128,7 @@ client.admin.points.levels.delete(
|
|
|
5224
6128
|
</dl>
|
|
5225
6129
|
</details>
|
|
5226
6130
|
|
|
5227
|
-
<details><summary><code>client.admin.points.
|
|
6131
|
+
<details><summary><code>client.admin.points.triggers.<a href="/lib/trophy/admin/points/triggers/client.rb">update</a>(system_id, request) -> Trophy::Types::PatchPointsTriggersResponse</code></summary>
|
|
5228
6132
|
<dl>
|
|
5229
6133
|
<dd>
|
|
5230
6134
|
|
|
@@ -5236,7 +6140,7 @@ client.admin.points.levels.delete(
|
|
|
5236
6140
|
<dl>
|
|
5237
6141
|
<dd>
|
|
5238
6142
|
|
|
5239
|
-
Update
|
|
6143
|
+
Update points triggers in bulk. Maximum 100 triggers per request. Only provided fields are updated; omitted fields are preserved.
|
|
5240
6144
|
</dd>
|
|
5241
6145
|
</dl>
|
|
5242
6146
|
</dd>
|
|
@@ -5251,10 +6155,10 @@ Update multiple points levels. Each item must include an ID. `key` cannot be cha
|
|
|
5251
6155
|
<dd>
|
|
5252
6156
|
|
|
5253
6157
|
```ruby
|
|
5254
|
-
client.admin.points.
|
|
6158
|
+
client.admin.points.triggers.update(
|
|
5255
6159
|
system_id: "550e8400-e29b-41d4-a716-446655440000",
|
|
5256
6160
|
request: [{
|
|
5257
|
-
id: "
|
|
6161
|
+
id: "id"
|
|
5258
6162
|
}]
|
|
5259
6163
|
)
|
|
5260
6164
|
```
|
|
@@ -5279,7 +6183,7 @@ client.admin.points.levels.update(
|
|
|
5279
6183
|
<dl>
|
|
5280
6184
|
<dd>
|
|
5281
6185
|
|
|
5282
|
-
**request:** `Internal::Types::Array[Trophy::Types::
|
|
6186
|
+
**request:** `Internal::Types::Array[Trophy::Types::PatchPointsTriggersRequestItem]`
|
|
5283
6187
|
|
|
5284
6188
|
</dd>
|
|
5285
6189
|
</dl>
|
|
@@ -5287,7 +6191,7 @@ client.admin.points.levels.update(
|
|
|
5287
6191
|
<dl>
|
|
5288
6192
|
<dd>
|
|
5289
6193
|
|
|
5290
|
-
**request_options:** `Trophy::Admin::Points::
|
|
6194
|
+
**request_options:** `Trophy::Admin::Points::Triggers::RequestOptions`
|
|
5291
6195
|
|
|
5292
6196
|
</dd>
|
|
5293
6197
|
</dl>
|
|
@@ -5299,7 +6203,7 @@ client.admin.points.levels.update(
|
|
|
5299
6203
|
</dl>
|
|
5300
6204
|
</details>
|
|
5301
6205
|
|
|
5302
|
-
<details><summary><code>client.admin.points.
|
|
6206
|
+
<details><summary><code>client.admin.points.triggers.<a href="/lib/trophy/admin/points/triggers/client.rb">get</a>(system_id, id) -> Trophy::Types::AdminPointsTrigger</code></summary>
|
|
5303
6207
|
<dl>
|
|
5304
6208
|
<dd>
|
|
5305
6209
|
|
|
@@ -5311,7 +6215,7 @@ client.admin.points.levels.update(
|
|
|
5311
6215
|
<dl>
|
|
5312
6216
|
<dd>
|
|
5313
6217
|
|
|
5314
|
-
Get a single points
|
|
6218
|
+
Get a single points trigger by ID.
|
|
5315
6219
|
</dd>
|
|
5316
6220
|
</dl>
|
|
5317
6221
|
</dd>
|
|
@@ -5326,7 +6230,7 @@ Get a single points level by ID.
|
|
|
5326
6230
|
<dd>
|
|
5327
6231
|
|
|
5328
6232
|
```ruby
|
|
5329
|
-
client.admin.points.
|
|
6233
|
+
client.admin.points.triggers.get(
|
|
5330
6234
|
system_id: "550e8400-e29b-41d4-a716-446655440000",
|
|
5331
6235
|
id: "660f9500-f30c-42e5-b827-557766550001"
|
|
5332
6236
|
)
|
|
@@ -5352,7 +6256,7 @@ client.admin.points.levels.get(
|
|
|
5352
6256
|
<dl>
|
|
5353
6257
|
<dd>
|
|
5354
6258
|
|
|
5355
|
-
**id:** `String` — The UUID of the points
|
|
6259
|
+
**id:** `String` — The UUID of the points trigger.
|
|
5356
6260
|
|
|
5357
6261
|
</dd>
|
|
5358
6262
|
</dl>
|
|
@@ -5360,7 +6264,7 @@ client.admin.points.levels.get(
|
|
|
5360
6264
|
<dl>
|
|
5361
6265
|
<dd>
|
|
5362
6266
|
|
|
5363
|
-
**request_options:** `Trophy::Admin::Points::
|
|
6267
|
+
**request_options:** `Trophy::Admin::Points::Triggers::RequestOptions`
|
|
5364
6268
|
|
|
5365
6269
|
</dd>
|
|
5366
6270
|
</dl>
|
|
@@ -5372,8 +6276,8 @@ client.admin.points.levels.get(
|
|
|
5372
6276
|
</dl>
|
|
5373
6277
|
</details>
|
|
5374
6278
|
|
|
5375
|
-
## Admin
|
|
5376
|
-
<details><summary><code>client.admin.
|
|
6279
|
+
## Admin Rewards Triggers
|
|
6280
|
+
<details><summary><code>client.admin.rewards.triggers.<a href="/lib/trophy/admin/rewards/triggers/client.rb">list</a>(reward_id) -> Internal::Types::Array[Trophy::Types::AdminRewardTrigger]</code></summary>
|
|
5377
6281
|
<dl>
|
|
5378
6282
|
<dd>
|
|
5379
6283
|
|
|
@@ -5385,7 +6289,7 @@ client.admin.points.levels.get(
|
|
|
5385
6289
|
<dl>
|
|
5386
6290
|
<dd>
|
|
5387
6291
|
|
|
5388
|
-
List
|
|
6292
|
+
List triggers for a reward. Active triggers are listed first.
|
|
5389
6293
|
</dd>
|
|
5390
6294
|
</dl>
|
|
5391
6295
|
</dd>
|
|
@@ -5400,8 +6304,8 @@ List points triggers for a system.
|
|
|
5400
6304
|
<dd>
|
|
5401
6305
|
|
|
5402
6306
|
```ruby
|
|
5403
|
-
client.admin.
|
|
5404
|
-
|
|
6307
|
+
client.admin.rewards.triggers.list(
|
|
6308
|
+
reward_id: "550e8400-e29b-41d4-a716-446655440000",
|
|
5405
6309
|
limit: 1,
|
|
5406
6310
|
skip: 1
|
|
5407
6311
|
)
|
|
@@ -5419,7 +6323,7 @@ client.admin.points.triggers.list(
|
|
|
5419
6323
|
<dl>
|
|
5420
6324
|
<dd>
|
|
5421
6325
|
|
|
5422
|
-
**
|
|
6326
|
+
**reward_id:** `String` — The UUID of the reward.
|
|
5423
6327
|
|
|
5424
6328
|
</dd>
|
|
5425
6329
|
</dl>
|
|
@@ -5443,7 +6347,7 @@ client.admin.points.triggers.list(
|
|
|
5443
6347
|
<dl>
|
|
5444
6348
|
<dd>
|
|
5445
6349
|
|
|
5446
|
-
**request_options:** `Trophy::Admin::
|
|
6350
|
+
**request_options:** `Trophy::Admin::Rewards::Triggers::RequestOptions`
|
|
5447
6351
|
|
|
5448
6352
|
</dd>
|
|
5449
6353
|
</dl>
|
|
@@ -5455,7 +6359,7 @@ client.admin.points.triggers.list(
|
|
|
5455
6359
|
</dl>
|
|
5456
6360
|
</details>
|
|
5457
6361
|
|
|
5458
|
-
<details><summary><code>client.admin.
|
|
6362
|
+
<details><summary><code>client.admin.rewards.triggers.<a href="/lib/trophy/admin/rewards/triggers/client.rb">create</a>(reward_id, request) -> Trophy::Types::CreateRewardTriggersResponse</code></summary>
|
|
5459
6363
|
<dl>
|
|
5460
6364
|
<dd>
|
|
5461
6365
|
|
|
@@ -5467,7 +6371,7 @@ client.admin.points.triggers.list(
|
|
|
5467
6371
|
<dl>
|
|
5468
6372
|
<dd>
|
|
5469
6373
|
|
|
5470
|
-
Create
|
|
6374
|
+
Create reward triggers in bulk. Maximum 100 triggers per request.
|
|
5471
6375
|
</dd>
|
|
5472
6376
|
</dl>
|
|
5473
6377
|
</dd>
|
|
@@ -5482,11 +6386,12 @@ Create points triggers in bulk.
|
|
|
5482
6386
|
<dd>
|
|
5483
6387
|
|
|
5484
6388
|
```ruby
|
|
5485
|
-
client.admin.
|
|
5486
|
-
|
|
6389
|
+
client.admin.rewards.triggers.create(
|
|
6390
|
+
reward_id: "550e8400-e29b-41d4-a716-446655440000",
|
|
5487
6391
|
request: [{
|
|
5488
6392
|
type: "metric",
|
|
5489
|
-
|
|
6393
|
+
metric_id: "990c2800-c63f-45b8-e15a-88aa99880004",
|
|
6394
|
+
metric_threshold: 10
|
|
5490
6395
|
}]
|
|
5491
6396
|
)
|
|
5492
6397
|
```
|
|
@@ -5503,7 +6408,7 @@ client.admin.points.triggers.create(
|
|
|
5503
6408
|
<dl>
|
|
5504
6409
|
<dd>
|
|
5505
6410
|
|
|
5506
|
-
**
|
|
6411
|
+
**reward_id:** `String` — The UUID of the reward.
|
|
5507
6412
|
|
|
5508
6413
|
</dd>
|
|
5509
6414
|
</dl>
|
|
@@ -5511,7 +6416,7 @@ client.admin.points.triggers.create(
|
|
|
5511
6416
|
<dl>
|
|
5512
6417
|
<dd>
|
|
5513
6418
|
|
|
5514
|
-
**request:** `Internal::Types::Array[Trophy::Types::
|
|
6419
|
+
**request:** `Internal::Types::Array[Trophy::Types::CreateRewardTriggerRequestItem]`
|
|
5515
6420
|
|
|
5516
6421
|
</dd>
|
|
5517
6422
|
</dl>
|
|
@@ -5519,7 +6424,7 @@ client.admin.points.triggers.create(
|
|
|
5519
6424
|
<dl>
|
|
5520
6425
|
<dd>
|
|
5521
6426
|
|
|
5522
|
-
**request_options:** `Trophy::Admin::
|
|
6427
|
+
**request_options:** `Trophy::Admin::Rewards::Triggers::RequestOptions`
|
|
5523
6428
|
|
|
5524
6429
|
</dd>
|
|
5525
6430
|
</dl>
|
|
@@ -5531,7 +6436,7 @@ client.admin.points.triggers.create(
|
|
|
5531
6436
|
</dl>
|
|
5532
6437
|
</details>
|
|
5533
6438
|
|
|
5534
|
-
<details><summary><code>client.admin.
|
|
6439
|
+
<details><summary><code>client.admin.rewards.triggers.<a href="/lib/trophy/admin/rewards/triggers/client.rb">delete</a>(reward_id) -> Trophy::Types::DeleteRewardTriggersResponse</code></summary>
|
|
5535
6440
|
<dl>
|
|
5536
6441
|
<dd>
|
|
5537
6442
|
|
|
@@ -5543,7 +6448,7 @@ client.admin.points.triggers.create(
|
|
|
5543
6448
|
<dl>
|
|
5544
6449
|
<dd>
|
|
5545
6450
|
|
|
5546
|
-
Delete
|
|
6451
|
+
Delete reward triggers by ID. Maximum 100 trigger IDs per request. A reward with no triggers is not awarded until a trigger is added.
|
|
5547
6452
|
</dd>
|
|
5548
6453
|
</dl>
|
|
5549
6454
|
</dd>
|
|
@@ -5558,9 +6463,9 @@ Delete points triggers by ID. Maximum 100 trigger IDs per request.
|
|
|
5558
6463
|
<dd>
|
|
5559
6464
|
|
|
5560
6465
|
```ruby
|
|
5561
|
-
client.admin.
|
|
5562
|
-
|
|
5563
|
-
ids: ["
|
|
6466
|
+
client.admin.rewards.triggers.delete(
|
|
6467
|
+
reward_id: "550e8400-e29b-41d4-a716-446655440000",
|
|
6468
|
+
ids: ["880b1700-b52e-44a7-d049-779988770003"]
|
|
5564
6469
|
)
|
|
5565
6470
|
```
|
|
5566
6471
|
</dd>
|
|
@@ -5576,7 +6481,7 @@ client.admin.points.triggers.delete(
|
|
|
5576
6481
|
<dl>
|
|
5577
6482
|
<dd>
|
|
5578
6483
|
|
|
5579
|
-
**
|
|
6484
|
+
**reward_id:** `String` — The UUID of the reward.
|
|
5580
6485
|
|
|
5581
6486
|
</dd>
|
|
5582
6487
|
</dl>
|
|
@@ -5592,7 +6497,7 @@ client.admin.points.triggers.delete(
|
|
|
5592
6497
|
<dl>
|
|
5593
6498
|
<dd>
|
|
5594
6499
|
|
|
5595
|
-
**request_options:** `Trophy::Admin::
|
|
6500
|
+
**request_options:** `Trophy::Admin::Rewards::Triggers::RequestOptions`
|
|
5596
6501
|
|
|
5597
6502
|
</dd>
|
|
5598
6503
|
</dl>
|
|
@@ -5604,7 +6509,7 @@ client.admin.points.triggers.delete(
|
|
|
5604
6509
|
</dl>
|
|
5605
6510
|
</details>
|
|
5606
6511
|
|
|
5607
|
-
<details><summary><code>client.admin.
|
|
6512
|
+
<details><summary><code>client.admin.rewards.triggers.<a href="/lib/trophy/admin/rewards/triggers/client.rb">update</a>(reward_id, request) -> Trophy::Types::UpdateRewardTriggersResponse</code></summary>
|
|
5608
6513
|
<dl>
|
|
5609
6514
|
<dd>
|
|
5610
6515
|
|
|
@@ -5616,7 +6521,7 @@ client.admin.points.triggers.delete(
|
|
|
5616
6521
|
<dl>
|
|
5617
6522
|
<dd>
|
|
5618
6523
|
|
|
5619
|
-
Update
|
|
6524
|
+
Update reward triggers in bulk. Maximum 100 triggers per request. Only provided fields are updated; omitted fields are preserved. A trigger keeps its ID when its criteria change.
|
|
5620
6525
|
</dd>
|
|
5621
6526
|
</dl>
|
|
5622
6527
|
</dd>
|
|
@@ -5631,10 +6536,11 @@ Update points triggers in bulk. Maximum 100 triggers per request. Only provided
|
|
|
5631
6536
|
<dd>
|
|
5632
6537
|
|
|
5633
6538
|
```ruby
|
|
5634
|
-
client.admin.
|
|
5635
|
-
|
|
6539
|
+
client.admin.rewards.triggers.update(
|
|
6540
|
+
reward_id: "550e8400-e29b-41d4-a716-446655440000",
|
|
5636
6541
|
request: [{
|
|
5637
|
-
id: "
|
|
6542
|
+
id: "880b1700-b52e-44a7-d049-779988770003",
|
|
6543
|
+
status: "active"
|
|
5638
6544
|
}]
|
|
5639
6545
|
)
|
|
5640
6546
|
```
|
|
@@ -5651,7 +6557,7 @@ client.admin.points.triggers.update(
|
|
|
5651
6557
|
<dl>
|
|
5652
6558
|
<dd>
|
|
5653
6559
|
|
|
5654
|
-
**
|
|
6560
|
+
**reward_id:** `String` — The UUID of the reward.
|
|
5655
6561
|
|
|
5656
6562
|
</dd>
|
|
5657
6563
|
</dl>
|
|
@@ -5659,7 +6565,7 @@ client.admin.points.triggers.update(
|
|
|
5659
6565
|
<dl>
|
|
5660
6566
|
<dd>
|
|
5661
6567
|
|
|
5662
|
-
**request:** `Internal::Types::Array[Trophy::Types::
|
|
6568
|
+
**request:** `Internal::Types::Array[Trophy::Types::UpdateRewardTriggersRequestItem]`
|
|
5663
6569
|
|
|
5664
6570
|
</dd>
|
|
5665
6571
|
</dl>
|
|
@@ -5667,7 +6573,7 @@ client.admin.points.triggers.update(
|
|
|
5667
6573
|
<dl>
|
|
5668
6574
|
<dd>
|
|
5669
6575
|
|
|
5670
|
-
**request_options:** `Trophy::Admin::
|
|
6576
|
+
**request_options:** `Trophy::Admin::Rewards::Triggers::RequestOptions`
|
|
5671
6577
|
|
|
5672
6578
|
</dd>
|
|
5673
6579
|
</dl>
|
|
@@ -5679,7 +6585,7 @@ client.admin.points.triggers.update(
|
|
|
5679
6585
|
</dl>
|
|
5680
6586
|
</details>
|
|
5681
6587
|
|
|
5682
|
-
<details><summary><code>client.admin.
|
|
6588
|
+
<details><summary><code>client.admin.rewards.triggers.<a href="/lib/trophy/admin/rewards/triggers/client.rb">get</a>(reward_id, id) -> Trophy::Types::AdminRewardTrigger</code></summary>
|
|
5683
6589
|
<dl>
|
|
5684
6590
|
<dd>
|
|
5685
6591
|
|
|
@@ -5691,7 +6597,7 @@ client.admin.points.triggers.update(
|
|
|
5691
6597
|
<dl>
|
|
5692
6598
|
<dd>
|
|
5693
6599
|
|
|
5694
|
-
Get a single
|
|
6600
|
+
Get a single reward trigger by ID.
|
|
5695
6601
|
</dd>
|
|
5696
6602
|
</dl>
|
|
5697
6603
|
</dd>
|
|
@@ -5706,9 +6612,9 @@ Get a single points trigger by ID.
|
|
|
5706
6612
|
<dd>
|
|
5707
6613
|
|
|
5708
6614
|
```ruby
|
|
5709
|
-
client.admin.
|
|
5710
|
-
|
|
5711
|
-
id: "
|
|
6615
|
+
client.admin.rewards.triggers.get(
|
|
6616
|
+
reward_id: "550e8400-e29b-41d4-a716-446655440000",
|
|
6617
|
+
id: "880b1700-b52e-44a7-d049-779988770003"
|
|
5712
6618
|
)
|
|
5713
6619
|
```
|
|
5714
6620
|
</dd>
|
|
@@ -5724,7 +6630,7 @@ client.admin.points.triggers.get(
|
|
|
5724
6630
|
<dl>
|
|
5725
6631
|
<dd>
|
|
5726
6632
|
|
|
5727
|
-
**
|
|
6633
|
+
**reward_id:** `String` — The UUID of the reward.
|
|
5728
6634
|
|
|
5729
6635
|
</dd>
|
|
5730
6636
|
</dl>
|
|
@@ -5732,7 +6638,7 @@ client.admin.points.triggers.get(
|
|
|
5732
6638
|
<dl>
|
|
5733
6639
|
<dd>
|
|
5734
6640
|
|
|
5735
|
-
**id:** `String` — The UUID of the
|
|
6641
|
+
**id:** `String` — The UUID of the reward trigger.
|
|
5736
6642
|
|
|
5737
6643
|
</dd>
|
|
5738
6644
|
</dl>
|
|
@@ -5740,7 +6646,7 @@ client.admin.points.triggers.get(
|
|
|
5740
6646
|
<dl>
|
|
5741
6647
|
<dd>
|
|
5742
6648
|
|
|
5743
|
-
**request_options:** `Trophy::Admin::
|
|
6649
|
+
**request_options:** `Trophy::Admin::Rewards::Triggers::RequestOptions`
|
|
5744
6650
|
|
|
5745
6651
|
</dd>
|
|
5746
6652
|
</dl>
|