Skip to content

Commit ad3039a

Browse files
committed
Merge branch 'ADP-5686' into develop
2 parents ac24881 + a8b2316 commit ad3039a

1 file changed

Lines changed: 26 additions & 24 deletions

File tree

src/content/docs/developer-cli/developer-cli-reference.mdx

Lines changed: 26 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,8 @@ All `list` commands also accept pagination flags:
2929

3030
## Apps
3131

32+
Manage the apps in your Adapty account. For Dashboard-based configuration, see [App settings](general).
33+
3234
### adapty apps list
3335

3436
List all apps in your Adapty account.
@@ -90,7 +92,7 @@ At least one flag is required. `--platform` cannot be changed after creation.
9092

9193
### adapty access-levels list
9294

93-
List all access levels for an app.
95+
List all [access levels](access-level) for an app.
9496

9597
```bash
9698
adapty access-levels list --app <app-id>
@@ -104,7 +106,7 @@ Accepts [pagination flags](#global-flags).
104106

105107
### adapty access-levels get
106108

107-
Get details for a specific access level.
109+
Get details for a specific [access level](access-level).
108110

109111
```bash
110112
adapty access-levels get --app <app-id> <access-level-id>
@@ -120,7 +122,7 @@ adapty access-levels get --app <app-id> <access-level-id>
120122

121123
### adapty access-levels create
122124

123-
Create a new access level.
125+
Create a new [access level](access-level).
124126

125127
```bash
126128
adapty access-levels create --app <app-id> --sdk-id "pro" --title "Pro"
@@ -134,7 +136,7 @@ adapty access-levels create --app <app-id> --sdk-id "pro" --title "Pro"
134136

135137
### adapty access-levels update
136138

137-
Update an existing access level.
139+
Update an existing [access level](access-level).
138140

139141
```bash
140142
adapty access-levels update --app <app-id> <access-level-id> --title "Pro Access"
@@ -155,7 +157,7 @@ adapty access-levels update --app <app-id> <access-level-id> --title "Pro Access
155157

156158
### adapty products list
157159

158-
List all products for an app.
160+
List all [products](product) for an app.
159161

160162
```bash
161163
adapty products list --app <app-id>
@@ -169,7 +171,7 @@ Accepts [pagination flags](#global-flags).
169171

170172
### adapty products get
171173

172-
Get details for a specific product.
174+
Get details for a specific [product](product).
173175

174176
```bash
175177
adapty products get --app <app-id> <product-id>
@@ -185,7 +187,7 @@ adapty products get --app <app-id> <product-id>
185187

186188
### adapty products create
187189

188-
Create a new product.
190+
Create a new [product](product).
189191

190192
```bash
191193
adapty products create --app <app-id> --title "Monthly" --access-level-id <access-level-id> --period monthly --ios-product-id com.example.monthly
@@ -195,15 +197,15 @@ adapty products create --app <app-id> --title "Monthly" --access-level-id <acces
195197
|---|---|---|
196198
| `--app` | Yes | App ID (UUID) |
197199
| `--title` | Yes | Product title |
198-
| `--access-level-id` | Yes | Access level ID (UUID) this product unlocks |
200+
| `--access-level-id` | Yes | [Access level](access-level) ID (UUID) this product unlocks |
199201
| `--period` | Yes | Subscription period: `weekly`, `monthly`, `2_months`, `3_months`, `6_months`, `yearly`, `lifetime` |
200202
| `--ios-product-id` | At least one platform required | Product ID from App Store Connect |
201203
| `--android-product-id` | At least one platform required | Product ID from Google Play Console |
202204
| `--android-base-plan-id` | Required with `--android-product-id` unless `--period lifetime` | Base plan ID from Google Play Console |
203205

204206
### adapty products update
205207

206-
Replace all fields of an existing product.
208+
Replace all fields of an existing [product](product).
207209

208210
```bash
209211
adapty products update --app <app-id> <product-id> --title "Monthly" --access-level-id <access-level-id> --period monthly --ios-product-id com.example.monthly
@@ -219,7 +221,7 @@ This command replaces all product fields. All required flags must be provided, e
219221
|---|---|---|
220222
| `--app` | Yes | App ID (UUID) |
221223
| `--title` | Yes | Product title |
222-
| `--access-level-id` | Yes | Access level ID (UUID) this product unlocks |
224+
| `--access-level-id` | Yes | [Access level](access-level) ID (UUID) this product unlocks |
223225
| `--period` | Yes | Subscription period: `weekly`, `monthly`, `2_months`, `3_months`, `6_months`, `yearly`, `lifetime` |
224226
| `--ios-product-id` | At least one platform required | Product ID from App Store Connect |
225227
| `--android-product-id` | At least one platform required | Product ID from Google Play Console |
@@ -229,7 +231,7 @@ This command replaces all product fields. All required flags must be provided, e
229231

230232
### adapty paywalls list
231233

232-
List all paywalls for an app.
234+
List all [paywalls](paywalls) for an app.
233235

234236
```bash
235237
adapty paywalls list --app <app-id>
@@ -243,7 +245,7 @@ Accepts [pagination flags](#global-flags).
243245

244246
### adapty paywalls get
245247

246-
Get details for a specific paywall.
248+
Get details for a specific [paywall](paywalls).
247249

248250
```bash
249251
adapty paywalls get --app <app-id> <paywall-id>
@@ -259,7 +261,7 @@ adapty paywalls get --app <app-id> <paywall-id>
259261

260262
### adapty paywalls create
261263

262-
Create a new paywall.
264+
Create a new [paywall](paywalls).
263265

264266
```bash
265267
adapty paywalls create --app <app-id> --title "Default Paywall" --product-id <product-id>
@@ -269,11 +271,11 @@ adapty paywalls create --app <app-id> --title "Default Paywall" --product-id <pr
269271
|---|---|---|
270272
| `--app` | Yes | App ID (UUID) |
271273
| `--title` | Yes | Paywall title |
272-
| `--product-id` | Yes | Product ID (UUID). Repeat for multiple products: `--product-id <id1> --product-id <id2>` |
274+
| `--product-id` | Yes | [Product](product) ID (UUID). Repeat for multiple products: `--product-id <id1> --product-id <id2>` |
273275

274276
### adapty paywalls update
275277

276-
Replace all fields of an existing paywall.
278+
Replace all fields of an existing [paywall](paywalls).
277279

278280
```bash
279281
adapty paywalls update --app <app-id> <paywall-id> --title "Default Paywall" --product-id <product-id>
@@ -289,13 +291,13 @@ This command replaces all paywall fields, including the full product list.
289291
|---|---|---|
290292
| `--app` | Yes | App ID (UUID) |
291293
| `--title` | Yes | Paywall title |
292-
| `--product-id` | Yes | Product ID (UUID). Repeat for multiple products: `--product-id <id1> --product-id <id2>` |
294+
| `--product-id` | Yes | [Product](product) ID (UUID). Repeat for multiple products: `--product-id <id1> --product-id <id2>` |
293295

294296
## Placements
295297

296298
### adapty placements list
297299

298-
List all placements for an app.
300+
List all [placements](placements) for an app.
299301

300302
```bash
301303
adapty placements list --app <app-id>
@@ -309,7 +311,7 @@ Accepts [pagination flags](#global-flags).
309311

310312
### adapty placements get
311313

312-
Get details for a specific placement.
314+
Get details for a specific [placement](placements).
313315

314316
```bash
315317
adapty placements get --app <app-id> <placement-id>
@@ -325,7 +327,7 @@ adapty placements get --app <app-id> <placement-id>
325327

326328
### adapty placements create
327329

328-
Create a new placement.
330+
Create a new [placement](placements).
329331

330332
```bash
331333
adapty placements create --app <app-id> --title "Main" --developer-id "main" --paywall-id <paywall-id>
@@ -335,12 +337,12 @@ adapty placements create --app <app-id> --title "Main" --developer-id "main" --p
335337
|---|---|---|
336338
| `--app` | Yes | App ID (UUID) |
337339
| `--title` | Yes | Placement title |
338-
| `--developer-id` | Yes | String identifier used in app code to request this placement |
339-
| `--paywall-id` | Yes | Paywall ID (UUID) to show at this placement |
340+
| `--developer-id` | Yes | String identifier used in app code to request this [placement](placements) |
341+
| `--paywall-id` | Yes | [Paywall](paywalls) ID (UUID) to show at this placement |
340342

341343
### adapty placements update
342344

343-
Replace all fields of an existing placement.
345+
Replace all fields of an existing [placement](placements).
344346

345347
```bash
346348
adapty placements update --app <app-id> <placement-id> --title "Main" --developer-id "main" --paywall-id <paywall-id>
@@ -354,8 +356,8 @@ adapty placements update --app <app-id> <placement-id> --title "Main" --develope
354356
|---|---|---|
355357
| `--app` | Yes | App ID (UUID) |
356358
| `--title` | Yes | Placement title |
357-
| `--developer-id` | Yes | String identifier used in app code to request this placement |
358-
| `--paywall-id` | Yes | Paywall ID (UUID) to show at this placement |
359+
| `--developer-id` | Yes | String identifier used in app code to request this [placement](placements) |
360+
| `--paywall-id` | Yes | [Paywall](paywalls) ID (UUID) to show at this placement |
359361

360362
## Auth
361363

0 commit comments

Comments
 (0)