@superwall/cli 2.1.0 → 2.2.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.
- package/README.md +12 -2
- package/dist/{apple-CSzNTGHM.js → apple-Bcr_PteR.js} +13 -13
- package/dist/auth.d.ts +1 -1
- package/dist/auth.js +3 -3
- package/dist/{billing-C3Q8DBU2.js → billing-CWM1ds3K.js} +3 -3
- package/dist/{bind-BumHTi9O.js → bind-DEYxsnZD.js} +4 -4
- package/dist/{build-Bpviiclc.js → build--oQKfZU6.js} +6 -6
- package/dist/{client-BL0f_yGf.js → client-CimFymxG.js} +7 -3
- package/dist/{create-BUcVG4Ab.js → create-BG9n4fvs.js} +22 -22
- package/dist/{create-CfK3PeKA.js → create-DTAyHkxb.js} +6 -6
- package/dist/create-kT2C9k4h.js +19 -0
- package/dist/{doctor-BWqIYcMn.js → doctor-BkygMUe2.js} +6 -6
- package/dist/{drivers-CPhdPkW5.js → drivers-C6eXj5-r.js} +3 -3
- package/dist/entry.js +19 -19
- package/dist/{environment-eBXjELoN.js → environment-CQn323uB.js} +15 -2
- package/dist/{existing-BltvQiX5.js → existing-CvOluc9U.js} +2 -2
- package/dist/held-Bwkhufdj.js +16 -0
- package/dist/{held-DgnTFMl3.js → held-QM7yfrXq.js} +6 -6
- package/dist/{integrate-BRsqoe01.js → integrate-Ci_MLkQG.js} +21 -21
- package/dist/{login-BbTIrCFT.js → login-BIAWgdzM.js} +256 -33
- package/dist/{login-BCEH5q0U.js → login-DLi71nJq.js} +1 -1
- package/dist/login-Dy9N5ZDH.js +16 -0
- package/dist/{lookup-rr1AkCJA.js → lookup-DZFrfzO0.js} +2 -2
- package/dist/{migrate-C9X2Vz81.js → migrate-BKF1WckS.js} +21 -21
- package/dist/{notification-url-CV86qiKP.js → notification-url-erXQ1edb.js} +2 -2
- package/dist/{open-CcpXotHG.js → open-BjvGVwJf.js} +10 -10
- package/dist/{org-BQQDo7wm.js → org-CvPGVSBF.js} +2 -2
- package/dist/{paths-CRlU72cq.js → paths-oRuC18Kt.js} +1 -1
- package/dist/{playbook-DVMXN7fh.js → playbook-CtTj1HBK.js} +10 -10
- package/dist/{promote-Da8xctzy.js → promote-BkJYISza.js} +16 -16
- package/dist/push-BIizJJOn.js +22 -0
- package/dist/{push-D6R9icWN.js → push-Ul2SW87i.js} +4 -4
- package/dist/{registry-BYVD-_h6.js → registry-OmPZ6dj0.js} +407 -177
- package/dist/{resources-DLON3-61.js → resources-FIrK7pE9.js} +1 -1
- package/dist/{run-Co-BwhOg.js → run-CwEY1eu5.js} +2 -2
- package/dist/{scan-CKuk-_6W.js → scan-CpbfZ2ju.js} +1 -1
- package/dist/scan-DjyvuWel.js +4 -0
- package/dist/{scope-DV22_Ufm.js → scope-BSqVfZvy.js} +4 -4
- package/dist/{selection-C2_KbLuo.js → selection-CHnVk8uw.js} +3 -3
- package/dist/server-BTveynqC.js +22 -0
- package/dist/{server-D0d2oP-5.js → server-D5xl5iKO.js} +66 -16
- package/dist/{session-B-Uz0cQ7.js → session-6lnJ0shD.js} +1 -1
- package/dist/{session-C4rbE3VS.js → session-BFwasPVq.js} +9 -8
- package/dist/session-Ds6tLC19.js +6 -0
- package/dist/skills/superwall/references/data-analytics.md +7 -8
- package/dist/skills/superwall-framework/SKILL.md +36 -4
- package/dist/skills/superwall-framework/references/examples.md +1 -0
- package/dist/skills/superwall-framework/references/migrate-from-editor.md +18 -4
- package/dist/{skills-CLGJuMnF.js → skills-B8uSuanf.js} +8 -8
- package/dist/{skills-CZcpnEnG.js → skills-D7sG0xom.js} +4 -4
- package/dist/{spinner-C2U6QBJ9.js → spinner-TZeZEeVv.js} +3 -3
- package/dist/{storage-CerJ5KLP.d.ts → storage-BbJF7z3l.d.ts} +1 -0
- package/dist/{storage-6h9vyiAz.js → storage-DqKJe13V.js} +12 -2
- package/dist/storekit-C_LFh8qy.js +16 -0
- package/dist/{storekit-CinJra3V.js → storekit-uyT3DWo4.js} +3 -3
- package/dist/{telemetry-DKyDhURo.js → telemetry-D_uIIuSk.js} +1 -1
- package/dist/{token-DaxQgQkv.js → token-BJsLGoSX.js} +1 -1
- package/dist/tools.d.ts +11 -9
- package/dist/tools.js +389 -161
- package/dist/{upgrade-DPo0a4Es.js → upgrade-BRM51As6.js} +1 -1
- package/dist/{upgrade-ffseQDMx.js → upgrade-DV_rmhyV.js} +2 -2
- package/package.json +2 -2
- package/dist/create-BSfvpWoD.js +0 -19
- package/dist/held-CPve03KJ.js +0 -16
- package/dist/login-BPOONe7n.js +0 -16
- package/dist/push-BV-grvQg.js +0 -22
- package/dist/scan-B88OlWOt.js +0 -4
- package/dist/server-C4f6ccUr.js +0 -22
- package/dist/session-BuvArt1j.js +0 -6
- package/dist/storekit-CK9JmM2D.js +0 -16
|
@@ -1,21 +1,21 @@
|
|
|
1
1
|
import { a as stripAnsi, l as readJson, o as cache, r as formatJson, t as blocks } from "./output-Ggzq5_-t.js";
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import { a as withQuery$1, t as ApiError } from "./client-
|
|
5
|
-
import { C as listKeySources, S as listBundleIdSuggestions, T as replaceRevenueProvider, _ as checkServerNotifications, b as importAppKey, c as resolveAscOrgApi, d as runAscDocs, f as parseParams, h as REVENUE_INTEGRATIONS, i as savedKey, l as resolveAscTeam, m as KEY_LABEL, n as testModeWarning, p as KEY_KINDS, r as chooseKeyApp, t as upsertHeldKey, u as sendAscRequest, v as copyAppKey, w as removeAppKey, x as keyKind, y as findIntegrations } from "./held-
|
|
2
|
+
import { a as CHANNEL, g as TELEMETRY_KEY, h as TELEMETRY_HOST, t as API_HOST, v as VERSION, x as detectAgent } from "./environment-CQn323uB.js";
|
|
3
|
+
import { n as readSession } from "./storage-DqKJe13V.js";
|
|
4
|
+
import { a as withQuery$1, t as ApiError } from "./client-CimFymxG.js";
|
|
5
|
+
import { C as listKeySources, S as listBundleIdSuggestions, T as replaceRevenueProvider, _ as checkServerNotifications, b as importAppKey, c as resolveAscOrgApi, d as runAscDocs, f as parseParams, h as REVENUE_INTEGRATIONS, i as savedKey, l as resolveAscTeam, m as KEY_LABEL, n as testModeWarning, p as KEY_KINDS, r as chooseKeyApp, t as upsertHeldKey, u as sendAscRequest, v as copyAppKey, w as removeAppKey, x as keyKind, y as findIntegrations } from "./held-QM7yfrXq.js";
|
|
6
6
|
import { n as readDefaultApp, r as readOnboardedApp, t as readAnonymousId, u as writeDefaultApp } from "./config-BO1Y87kV.js";
|
|
7
|
-
import { a as defineCommand, d as readInput, i as defineCatalog, r as UsageError, t as apiCall } from "./spinner-
|
|
7
|
+
import { a as defineCommand, d as readInput, i as defineCatalog, r as UsageError, t as apiCall } from "./spinner-TZeZEeVv.js";
|
|
8
8
|
import { n as fg, t as THEME } from "./theme-DUsCh-Vd.js";
|
|
9
|
-
import { n as runWhoami } from "./session-
|
|
10
|
-
import { A as parseJson, M as listOrgGroups, O as isRecord, P as orgIdOf, i as createEntitlement, j as textField, l as isAppScoped, m as listResource, n as createApplication, o as createProduct, p as listProjects, r as createCampaign, s as createProject, t as RESOURCES, v as platformLabel, w as rowName } from "./resources-
|
|
11
|
-
import { n as orgForNewProject } from "./org-
|
|
12
|
-
import { n as findApplication, r as findProject, t as appNotFound } from "./lookup-
|
|
13
|
-
import { a as pickScope, i as pickProject, n as chooseApp, r as pickOrganization, t as boundOrganization } from "./scope-
|
|
9
|
+
import { n as runWhoami } from "./session-6lnJ0shD.js";
|
|
10
|
+
import { A as parseJson, M as listOrgGroups, O as isRecord, P as orgIdOf, i as createEntitlement, j as textField, l as isAppScoped, m as listResource, n as createApplication, o as createProduct, p as listProjects, r as createCampaign, s as createProject, t as RESOURCES, v as platformLabel, w as rowName } from "./resources-FIrK7pE9.js";
|
|
11
|
+
import { n as orgForNewProject } from "./org-CvPGVSBF.js";
|
|
12
|
+
import { n as findApplication, r as findProject, t as appNotFound } from "./lookup-DZFrfzO0.js";
|
|
13
|
+
import { a as pickScope, i as pickProject, n as chooseApp, r as pickOrganization, t as boundOrganization } from "./scope-BSqVfZvy.js";
|
|
14
14
|
import { a as listAscConfigs, i as findAppNotificationUrl, o as removeAscConfig, t as ascProxy } from "./client-BZ1UbpXz.js";
|
|
15
15
|
import { i as listUnimportedAscProducts, n as findAscAppId, r as listAscApps, t as ascTypeDisplay } from "./products-DH_fK9tY.js";
|
|
16
16
|
import { n as readResourceFlags, r as textOf, t as fieldName } from "./input-vi0bou04.js";
|
|
17
|
-
import { a as runAscNotificationUrlSet, i as printServerNotifications, t as describeNotificationUrl } from "./notification-url-
|
|
18
|
-
import { t as platformForIntegration } from "./bind-
|
|
17
|
+
import { a as runAscNotificationUrlSet, i as printServerNotifications, t as describeNotificationUrl } from "./notification-url-erXQ1edb.js";
|
|
18
|
+
import { t as platformForIntegration } from "./bind-DEYxsnZD.js";
|
|
19
19
|
import pc from "picocolors";
|
|
20
20
|
|
|
21
21
|
//#region src/ui/help-layout.ts
|
|
@@ -76,12 +76,47 @@ function renderPage(page) {
|
|
|
76
76
|
const command = defineCommand({
|
|
77
77
|
name: "login",
|
|
78
78
|
summary: "Log in to Superwall in your browser, or with an API key",
|
|
79
|
+
details: "Without a terminal (a coding agent, --json), login prints the link and code and returns at once; once the link is approved, `superwall login --poll` finishes it. A new account needs --org-name, and --app-name with --platform also creates its first app.",
|
|
79
80
|
flags: {
|
|
80
81
|
apiKey: {
|
|
81
82
|
type: "string",
|
|
82
83
|
value: "key",
|
|
83
84
|
describe: "Log in with an API key instead of the browser, for CI"
|
|
84
85
|
},
|
|
86
|
+
poll: {
|
|
87
|
+
type: "boolean",
|
|
88
|
+
describe: "Finish a login started without a terminal, once it's approved in the browser"
|
|
89
|
+
},
|
|
90
|
+
timeout: {
|
|
91
|
+
type: "number",
|
|
92
|
+
value: "seconds",
|
|
93
|
+
describe: "With --poll, seconds to wait for approval before returning (default 60)"
|
|
94
|
+
},
|
|
95
|
+
orgName: {
|
|
96
|
+
type: "string",
|
|
97
|
+
value: "name",
|
|
98
|
+
describe: "Create this organization if the account has none"
|
|
99
|
+
},
|
|
100
|
+
appName: {
|
|
101
|
+
type: "string",
|
|
102
|
+
value: "name",
|
|
103
|
+
describe: "With --org-name, also create this app as the organization's first"
|
|
104
|
+
},
|
|
105
|
+
platform: {
|
|
106
|
+
type: "string",
|
|
107
|
+
value: "platform",
|
|
108
|
+
choices: [
|
|
109
|
+
"ios",
|
|
110
|
+
"android",
|
|
111
|
+
"web"
|
|
112
|
+
],
|
|
113
|
+
describe: "Platform of the --app-name app"
|
|
114
|
+
},
|
|
115
|
+
bundleId: {
|
|
116
|
+
type: "string",
|
|
117
|
+
value: "id",
|
|
118
|
+
describe: "Bundle ID of the --app-name app"
|
|
119
|
+
},
|
|
85
120
|
host: {
|
|
86
121
|
type: "string",
|
|
87
122
|
value: "url",
|
|
@@ -95,13 +130,19 @@ const command = defineCommand({
|
|
|
95
130
|
hidden: true
|
|
96
131
|
}
|
|
97
132
|
},
|
|
98
|
-
examples: [
|
|
133
|
+
examples: [
|
|
134
|
+
["login", "Approve the login in your browser"],
|
|
135
|
+
["login --api-key <key>", "Log in on a server or in CI"],
|
|
136
|
+
["login --json", "From an agent: print the link to approve and return"],
|
|
137
|
+
["login --poll --json", "From an agent: finish the login once it's approved"],
|
|
138
|
+
["login --poll --org-name Acme --app-name Acme --platform ios", "From an agent: finish a new account's login and create its first app"]
|
|
139
|
+
],
|
|
99
140
|
auth: "none",
|
|
100
141
|
json: true,
|
|
101
142
|
prompts: true,
|
|
102
143
|
mcp: false,
|
|
103
144
|
async run(ctx, input) {
|
|
104
|
-
const { runLogin } = await import("./login-
|
|
145
|
+
const { runLogin } = await import("./login-Dy9N5ZDH.js");
|
|
105
146
|
return runLogin(ctx, input);
|
|
106
147
|
}
|
|
107
148
|
});
|
|
@@ -117,7 +158,7 @@ const command$1 = defineCommand({
|
|
|
117
158
|
prompts: true,
|
|
118
159
|
mcp: false,
|
|
119
160
|
async run(ctx) {
|
|
120
|
-
const { runLogout } = await import("./session-
|
|
161
|
+
const { runLogout } = await import("./session-Ds6tLC19.js");
|
|
121
162
|
return runLogout(ctx);
|
|
122
163
|
}
|
|
123
164
|
});
|
|
@@ -257,7 +298,9 @@ arrive twice. Count revenue the way the dashboard does:
|
|
|
257
298
|
WHERE applicationId = {app:UInt64}
|
|
258
299
|
AND (integration IN {revenue_integrations:Array(String)} OR source = 'sdk')
|
|
259
300
|
AND NOT (coalesce(integration, '') = 'revenue_cat' AND store = 'STRIPE')
|
|
260
|
-
--param name=value adds any other parameter
|
|
301
|
+
--param name=value adds any other parameter.
|
|
302
|
+
|
|
303
|
+
The backend forces SQL to readonly=1. Before executing SQL it may provision a ClickHouse user and role, persist credentials and reconcile access policies for the organization. SQL read-only mode does not prevent these setup changes.`,
|
|
261
304
|
args: { sql: {
|
|
262
305
|
describe: "SQL query (or pass it with --file / stdin)",
|
|
263
306
|
mcp: "required"
|
|
@@ -283,7 +326,7 @@ arrive twice. Count revenue the way the dashboard does:
|
|
|
283
326
|
auth: "required",
|
|
284
327
|
json: true,
|
|
285
328
|
prompts: false,
|
|
286
|
-
mcp: "
|
|
329
|
+
mcp: "write",
|
|
287
330
|
run(ctx, input) {
|
|
288
331
|
return runQuery(ctx, input);
|
|
289
332
|
}
|
|
@@ -616,6 +659,7 @@ const command$5 = defineCommand({
|
|
|
616
659
|
const command$6 = defineCommand({
|
|
617
660
|
name: "get",
|
|
618
661
|
summary: "Make GET requests to the Superwall API",
|
|
662
|
+
details: "Executes an arbitrary Superwall GET endpoint. Most retrieve account data, but the analytics query endpoint can provision credentials and reconcile existing access policies before running read-only SQL.",
|
|
619
663
|
args: { path: {
|
|
620
664
|
describe: "API path, e.g. /v2/products",
|
|
621
665
|
required: true
|
|
@@ -625,7 +669,7 @@ const command$6 = defineCommand({
|
|
|
625
669
|
auth: "required",
|
|
626
670
|
json: true,
|
|
627
671
|
prompts: false,
|
|
628
|
-
mcp: "
|
|
672
|
+
mcp: "write",
|
|
629
673
|
run(ctx, { args, flags }) {
|
|
630
674
|
return runApiRequest(ctx, ctx.api, {
|
|
631
675
|
verb: "get",
|
|
@@ -640,6 +684,7 @@ const command$6 = defineCommand({
|
|
|
640
684
|
const command$7 = defineCommand({
|
|
641
685
|
name: "patch",
|
|
642
686
|
summary: "Make PATCH requests to the Superwall API",
|
|
687
|
+
details: "Executes an arbitrary Superwall PATCH endpoint. Depending on the path, it overwrites account configuration or redirects webhook delivery to a caller-supplied HTTPS destination.",
|
|
643
688
|
args: { path: {
|
|
644
689
|
describe: "API path, e.g. /v2/products",
|
|
645
690
|
required: true
|
|
@@ -649,7 +694,7 @@ const command$7 = defineCommand({
|
|
|
649
694
|
auth: "required",
|
|
650
695
|
json: true,
|
|
651
696
|
prompts: false,
|
|
652
|
-
mcp: "
|
|
697
|
+
mcp: "destructive",
|
|
653
698
|
run(ctx, { args, flags }) {
|
|
654
699
|
return runApiRequest(ctx, ctx.api, {
|
|
655
700
|
verb: "patch",
|
|
@@ -664,6 +709,7 @@ const command$7 = defineCommand({
|
|
|
664
709
|
const command$8 = defineCommand({
|
|
665
710
|
name: "post",
|
|
666
711
|
summary: "Make POST requests to the Superwall API",
|
|
712
|
+
details: "Executes an arbitrary Superwall POST endpoint. Depending on the path, it can archive, reset, publish, resend events or create a webhook to a caller-supplied HTTPS destination. Repeating a call may repeat its effects.",
|
|
667
713
|
args: { path: {
|
|
668
714
|
describe: "API path, e.g. /v2/products",
|
|
669
715
|
required: true
|
|
@@ -673,7 +719,7 @@ const command$8 = defineCommand({
|
|
|
673
719
|
auth: "required",
|
|
674
720
|
json: true,
|
|
675
721
|
prompts: false,
|
|
676
|
-
mcp: "
|
|
722
|
+
mcp: "destructive",
|
|
677
723
|
run(ctx, { args, flags }) {
|
|
678
724
|
return runApiRequest(ctx, ctx.api, {
|
|
679
725
|
verb: "post",
|
|
@@ -741,7 +787,7 @@ function renderOperationHelp(spec, operation) {
|
|
|
741
787
|
});
|
|
742
788
|
const common = [[cmd("--app <app>"), "A Superwall app of the organization whose App Store Connect key to use"], [cmd("--team <id>"), "Apple team id, when your organization has several"]];
|
|
743
789
|
if (operation.effect !== "read") common.push([cmd("--dry-run"), "Print every request it would send; send no change"]);
|
|
744
|
-
if (operation.
|
|
790
|
+
if (operation.confirm) common.push([cmd("-y, --yes"), "Go ahead without asking"]);
|
|
745
791
|
common.push([cmd("--json"), "Machine-readable output"]);
|
|
746
792
|
return renderPage({
|
|
747
793
|
name: `${spec.name} ${operation.name}`,
|
|
@@ -1406,21 +1452,21 @@ function parseFlag(key, flag$1, raw) {
|
|
|
1406
1452
|
}
|
|
1407
1453
|
return parseChoice(key, flag$1, text);
|
|
1408
1454
|
}
|
|
1409
|
-
function parseArg(command$
|
|
1455
|
+
function parseArg(command$68, arg, word) {
|
|
1410
1456
|
if (word === void 0 || !arg.choices) return word;
|
|
1411
1457
|
const found = arg.choices.find((choice) => choice.toLowerCase() === word.toLowerCase());
|
|
1412
|
-
if (!found) throw new UsageError(`${command$
|
|
1458
|
+
if (!found) throw new UsageError(`${command$68} takes <${arg.name}> as one of: ${arg.choices.join(", ")} (not "${word}").`);
|
|
1413
1459
|
return found;
|
|
1414
1460
|
}
|
|
1415
|
-
function parseInput(command$
|
|
1461
|
+
function parseInput(command$68, operation, words, raw) {
|
|
1416
1462
|
const specs = operation.flags ?? {};
|
|
1417
|
-
for (const key of Object.keys(raw)) if (!(key in specs) && !(key in COMMON_FLAGS)) throw new UsageError(`${command$
|
|
1463
|
+
for (const key of Object.keys(raw)) if (!(key in specs) && !(key in COMMON_FLAGS)) throw new UsageError(`${command$68} has no --${kebab(key)}. Run superwall ${command$68} --help for its flags.`);
|
|
1418
1464
|
const flags = Object.fromEntries(Object.entries(specs).map(([key, flag$1]) => [key, parseFlag(key, flag$1, raw[key])]));
|
|
1419
|
-
for (const [key, flag$1] of Object.entries(specs)) if (flag$1.required && flags[key] === void 0) throw new UsageError(`${command$
|
|
1465
|
+
for (const [key, flag$1] of Object.entries(specs)) if (flag$1.required && flags[key] === void 0) throw new UsageError(`${command$68} needs --${kebab(key)}.`);
|
|
1420
1466
|
const specArgs = operation.args ?? [];
|
|
1421
|
-
if (words.length > specArgs.length) throw new UsageError(`${command$
|
|
1422
|
-
const args = Object.fromEntries(specArgs.map((arg, index) => [arg.name, parseArg(command$
|
|
1423
|
-
for (const arg of specArgs) if (arg.required && args[arg.name] === void 0) throw new UsageError(`${command$
|
|
1467
|
+
if (words.length > specArgs.length) throw new UsageError(`${command$68} doesn't take "${words.slice(specArgs.length).join(" ")}".`);
|
|
1468
|
+
const args = Object.fromEntries(specArgs.map((arg, index) => [arg.name, parseArg(command$68, arg, words[index])]));
|
|
1469
|
+
for (const arg of specArgs) if (arg.required && args[arg.name] === void 0) throw new UsageError(`${command$68} needs <${arg.name}>.`);
|
|
1424
1470
|
return {
|
|
1425
1471
|
args,
|
|
1426
1472
|
flags,
|
|
@@ -1701,6 +1747,7 @@ const command$10 = defineAscResource({
|
|
|
1701
1747
|
}, {
|
|
1702
1748
|
name: "set",
|
|
1703
1749
|
summary: "Sell it in these territories",
|
|
1750
|
+
details: "Replaces the set of available territories and can remove existing sale availability.",
|
|
1704
1751
|
flags: {
|
|
1705
1752
|
subscription: TARGET_FLAGS.subscription,
|
|
1706
1753
|
iap: TARGET_FLAGS.iap,
|
|
@@ -1715,7 +1762,7 @@ const command$10 = defineAscResource({
|
|
|
1715
1762
|
describe: "Also territories Apple adds later (default: with all)"
|
|
1716
1763
|
}
|
|
1717
1764
|
},
|
|
1718
|
-
effect: "
|
|
1765
|
+
effect: "destructive",
|
|
1719
1766
|
run: runAvailabilitySet
|
|
1720
1767
|
}],
|
|
1721
1768
|
examples: [["asc availability get --subscription <id>", "Where it is sold"], ["asc availability set --iap <id> --available-territories USA,CAN", "Sell it in two territories"]]
|
|
@@ -2135,6 +2182,7 @@ const command$11 = defineAscResource({
|
|
|
2135
2182
|
required: true
|
|
2136
2183
|
}, VERSION_ARG],
|
|
2137
2184
|
flags: VERSION_FLAGS,
|
|
2185
|
+
confirm: true,
|
|
2138
2186
|
effect: "destructive",
|
|
2139
2187
|
run: runBuildsAttach
|
|
2140
2188
|
},
|
|
@@ -2146,6 +2194,7 @@ const command$11 = defineAscResource({
|
|
|
2146
2194
|
describe: "The build's id",
|
|
2147
2195
|
required: true
|
|
2148
2196
|
}],
|
|
2197
|
+
confirm: true,
|
|
2149
2198
|
effect: "destructive",
|
|
2150
2199
|
run: runBuildsExpire
|
|
2151
2200
|
}
|
|
@@ -3013,6 +3062,7 @@ const command$15 = defineAscResource({
|
|
|
3013
3062
|
{
|
|
3014
3063
|
name: "update",
|
|
3015
3064
|
summary: "Change an in-app purchase",
|
|
3065
|
+
details: "PATCH replaces existing IAP fields, including family-sharing configuration when accepted by Apple.",
|
|
3016
3066
|
args: [{
|
|
3017
3067
|
name: "id",
|
|
3018
3068
|
describe: "The in-app purchase's id",
|
|
@@ -3034,7 +3084,7 @@ const command$15 = defineAscResource({
|
|
|
3034
3084
|
describe: "A note for App Review"
|
|
3035
3085
|
}
|
|
3036
3086
|
},
|
|
3037
|
-
effect: "
|
|
3087
|
+
effect: "destructive",
|
|
3038
3088
|
run: runIapsUpdate
|
|
3039
3089
|
},
|
|
3040
3090
|
{
|
|
@@ -3045,6 +3095,7 @@ const command$15 = defineAscResource({
|
|
|
3045
3095
|
describe: "The in-app purchase's id",
|
|
3046
3096
|
required: true
|
|
3047
3097
|
}],
|
|
3098
|
+
confirm: true,
|
|
3048
3099
|
effect: "destructive",
|
|
3049
3100
|
run: runIapsDelete
|
|
3050
3101
|
}
|
|
@@ -3101,6 +3152,7 @@ of the product; changes go to its editable version, and an approved product gets
|
|
|
3101
3152
|
{
|
|
3102
3153
|
name: "update",
|
|
3103
3154
|
summary: "Change the localization in --locale",
|
|
3155
|
+
details: "Overwrites the existing localization. Updating can also create a missing editable draft.",
|
|
3104
3156
|
flags: {
|
|
3105
3157
|
...TARGET_FLAGS,
|
|
3106
3158
|
locale: {
|
|
@@ -3125,7 +3177,7 @@ of the product; changes go to its editable version, and an approved product gets
|
|
|
3125
3177
|
describe: "The app name shown with a group (groups only)"
|
|
3126
3178
|
}
|
|
3127
3179
|
},
|
|
3128
|
-
effect: "
|
|
3180
|
+
effect: "destructive",
|
|
3129
3181
|
run: runLocalizationsUpdate
|
|
3130
3182
|
},
|
|
3131
3183
|
{
|
|
@@ -3140,6 +3192,7 @@ of the product; changes go to its editable version, and an approved product gets
|
|
|
3140
3192
|
required: true
|
|
3141
3193
|
}
|
|
3142
3194
|
},
|
|
3195
|
+
confirm: true,
|
|
3143
3196
|
effect: "destructive",
|
|
3144
3197
|
run: runLocalizationsDelete
|
|
3145
3198
|
}
|
|
@@ -3281,6 +3334,7 @@ const command$17 = defineAscResource({
|
|
|
3281
3334
|
{
|
|
3282
3335
|
name: "update",
|
|
3283
3336
|
summary: "Change the version's text in one locale",
|
|
3337
|
+
details: "PATCH overwrites existing App Store version localization text and URLs.",
|
|
3284
3338
|
args: [VERSION_ARG],
|
|
3285
3339
|
flags: {
|
|
3286
3340
|
...VERSION_FLAGS,
|
|
@@ -3292,7 +3346,7 @@ const command$17 = defineAscResource({
|
|
|
3292
3346
|
},
|
|
3293
3347
|
...METADATA_FIELDS
|
|
3294
3348
|
},
|
|
3295
|
-
effect: "
|
|
3349
|
+
effect: "destructive",
|
|
3296
3350
|
run: runMetadataUpdate
|
|
3297
3351
|
},
|
|
3298
3352
|
{
|
|
@@ -3416,7 +3470,7 @@ A purchase_key is for the app's bundle ID; an app with none gets --bundle-id sav
|
|
|
3416
3470
|
prompts: true,
|
|
3417
3471
|
mcp: false,
|
|
3418
3472
|
async run(ctx, input) {
|
|
3419
|
-
const { runAscKeysCreate } = await import("./create-
|
|
3473
|
+
const { runAscKeysCreate } = await import("./create-kT2C9k4h.js");
|
|
3420
3474
|
return runAscKeysCreate(ctx, input);
|
|
3421
3475
|
}
|
|
3422
3476
|
});
|
|
@@ -3652,7 +3706,9 @@ const command$20 = defineCommand({
|
|
|
3652
3706
|
details: `Without --from it tries every key your organization has and saves the first Apple
|
|
3653
3707
|
confirms, both kinds when none is named; exit 1 when a kind is still missing. With --from
|
|
3654
3708
|
it copies that app's key. Never saves an unconfirmed key unless a person passes
|
|
3655
|
-
--allow-unconfirmed, and creates nothing at Apple
|
|
3709
|
+
--allow-unconfirmed, and creates nothing at Apple.
|
|
3710
|
+
|
|
3711
|
+
With --from, replaces the target app's saved key.`,
|
|
3656
3712
|
args: { kind: {
|
|
3657
3713
|
describe: "api_key or purchase_key (both when left out; needed with --from)",
|
|
3658
3714
|
choices: KEY_KINDS
|
|
@@ -3682,7 +3738,7 @@ it copies that app's key. Never saves an unconfirmed key unless a person passes
|
|
|
3682
3738
|
auth: "required",
|
|
3683
3739
|
json: true,
|
|
3684
3740
|
prompts: true,
|
|
3685
|
-
mcp: "
|
|
3741
|
+
mcp: "destructive",
|
|
3686
3742
|
run(ctx, { args, flags }) {
|
|
3687
3743
|
const kind = keyKind(args.kind);
|
|
3688
3744
|
const app$1 = {
|
|
@@ -3801,7 +3857,7 @@ With --app it saves the key you hold on that app instead, as asc keys create --k
|
|
|
3801
3857
|
prompts: true,
|
|
3802
3858
|
mcp: false,
|
|
3803
3859
|
async run(ctx, { args, flags }) {
|
|
3804
|
-
const { upsertHeldKey: upsertHeldKey$1 } = await import("./held-
|
|
3860
|
+
const { upsertHeldKey: upsertHeldKey$1 } = await import("./held-Bwkhufdj.js");
|
|
3805
3861
|
return upsertHeldKey$1(ctx, {
|
|
3806
3862
|
action: "update",
|
|
3807
3863
|
key: {
|
|
@@ -3859,7 +3915,9 @@ const command$25 = defineCommand({
|
|
|
3859
3915
|
name: "asc notification-url set",
|
|
3860
3916
|
summary: "Write this app's URL where Apple has none",
|
|
3861
3917
|
details: `Never replaces another server's URL: a conflict is reported and left alone (exit 1).
|
|
3862
|
-
It leaves the revenue provider alone unless --set-revenue-provider is passed
|
|
3918
|
+
It leaves the revenue provider alone unless --set-revenue-provider is passed.
|
|
3919
|
+
|
|
3920
|
+
Passing --set-revenue-provider overwrites the app's existing revenue-provider selection.`,
|
|
3863
3921
|
flags: {
|
|
3864
3922
|
setRevenueProvider: {
|
|
3865
3923
|
type: "boolean",
|
|
@@ -3880,7 +3938,7 @@ It leaves the revenue provider alone unless --set-revenue-provider is passed.`,
|
|
|
3880
3938
|
auth: "required",
|
|
3881
3939
|
json: true,
|
|
3882
3940
|
prompts: true,
|
|
3883
|
-
mcp: "
|
|
3941
|
+
mcp: "destructive",
|
|
3884
3942
|
run(ctx, input) {
|
|
3885
3943
|
return runAscNotificationUrlSet(ctx, input);
|
|
3886
3944
|
}
|
|
@@ -4050,6 +4108,7 @@ priced in --territory and equalized.`,
|
|
|
4050
4108
|
{
|
|
4051
4109
|
name: "create",
|
|
4052
4110
|
summary: "Create an introductory offer in every territory",
|
|
4111
|
+
details: "Creates introductory offers in the selected territories. New offers with overlapping dates overwrite existing introductory offers.",
|
|
4053
4112
|
flags: {
|
|
4054
4113
|
subscription: {
|
|
4055
4114
|
type: "string",
|
|
@@ -4102,12 +4161,13 @@ priced in --territory and equalized.`,
|
|
|
4102
4161
|
describe: "When it ends"
|
|
4103
4162
|
}
|
|
4104
4163
|
},
|
|
4105
|
-
effect: "
|
|
4164
|
+
effect: "destructive",
|
|
4106
4165
|
run: runOffersCreate
|
|
4107
4166
|
},
|
|
4108
4167
|
{
|
|
4109
4168
|
name: "update",
|
|
4110
4169
|
summary: "Change when one offer ends",
|
|
4170
|
+
details: "PATCH changes an existing introductory offer end date, potentially ending the offer earlier.",
|
|
4111
4171
|
args: [{
|
|
4112
4172
|
name: "id",
|
|
4113
4173
|
describe: "The offer's id",
|
|
@@ -4119,7 +4179,7 @@ priced in --territory and equalized.`,
|
|
|
4119
4179
|
describe: "When it ends",
|
|
4120
4180
|
required: true
|
|
4121
4181
|
} },
|
|
4122
|
-
effect: "
|
|
4182
|
+
effect: "destructive",
|
|
4123
4183
|
run: runOffersUpdate
|
|
4124
4184
|
},
|
|
4125
4185
|
{
|
|
@@ -4134,6 +4194,7 @@ priced in --territory and equalized.`,
|
|
|
4134
4194
|
value: "id",
|
|
4135
4195
|
describe: "Delete all of this subscription's offers"
|
|
4136
4196
|
} },
|
|
4197
|
+
confirm: true,
|
|
4137
4198
|
effect: "destructive",
|
|
4138
4199
|
run: runOffersDelete
|
|
4139
4200
|
}
|
|
@@ -4148,7 +4209,9 @@ const command$27 = defineCommand({
|
|
|
4148
4209
|
summary: "Any App Store Connect PATCH request, its body checked against Apple's schema",
|
|
4149
4210
|
details: `Each -d names an attribute or a relationship of the body; its type comes from Apple's
|
|
4150
4211
|
schema and its id from the path. A body the schema would refuse is stopped before it is
|
|
4151
|
-
sent (--force sends it as-is). superwall asc docs <path> patch lists the fields
|
|
4212
|
+
sent (--force sends it as-is). superwall asc docs <path> patch lists the fields.
|
|
4213
|
+
|
|
4214
|
+
Executes an arbitrary App Store Connect PATCH through the signed proxy, with schema validation unless force is set. It can overwrite attributes, relationships and distribution settings.`,
|
|
4152
4215
|
args: { path: {
|
|
4153
4216
|
describe: "The App Store Connect path, e.g. /v1/apps",
|
|
4154
4217
|
required: true
|
|
@@ -4177,7 +4240,7 @@ sent (--force sends it as-is). superwall asc docs <path> patch lists the fields.
|
|
|
4177
4240
|
auth: "required",
|
|
4178
4241
|
json: true,
|
|
4179
4242
|
prompts: true,
|
|
4180
|
-
mcp: "
|
|
4243
|
+
mcp: "destructive",
|
|
4181
4244
|
async run(ctx, { args, flags }) {
|
|
4182
4245
|
const response = await sendAscRequest(ctx, "patch", args.path, {
|
|
4183
4246
|
data: flags.d,
|
|
@@ -4195,7 +4258,9 @@ const command$28 = defineCommand({
|
|
|
4195
4258
|
summary: "Any App Store Connect POST request, its body checked against Apple's schema",
|
|
4196
4259
|
details: `Each -d names an attribute or a relationship of the body; its type comes from Apple's
|
|
4197
4260
|
schema. A body the schema would refuse is stopped before it is sent (--force sends it
|
|
4198
|
-
as-is). superwall asc docs <path> post lists the fields
|
|
4261
|
+
as-is). superwall asc docs <path> post lists the fields.
|
|
4262
|
+
|
|
4263
|
+
Executes an arbitrary App Store Connect POST through the signed proxy, with schema validation unless force is set. It can submit reviews, release versions or replace price schedules; repeating a call may repeat its effects.`,
|
|
4199
4264
|
args: { path: {
|
|
4200
4265
|
describe: "The App Store Connect path, e.g. /v1/apps",
|
|
4201
4266
|
required: true
|
|
@@ -4224,7 +4289,7 @@ as-is). superwall asc docs <path> post lists the fields.`,
|
|
|
4224
4289
|
auth: "required",
|
|
4225
4290
|
json: true,
|
|
4226
4291
|
prompts: true,
|
|
4227
|
-
mcp: "
|
|
4292
|
+
mcp: "destructive",
|
|
4228
4293
|
async run(ctx, { args, flags }) {
|
|
4229
4294
|
const response = await sendAscRequest(ctx, "post", args.path, {
|
|
4230
4295
|
data: flags.d,
|
|
@@ -4277,6 +4342,7 @@ an in-app purchase replaces its price schedule; Apple equalizes the other territ
|
|
|
4277
4342
|
{
|
|
4278
4343
|
name: "set",
|
|
4279
4344
|
summary: "Price it in one territory and equalize every other",
|
|
4345
|
+
details: "Replaces an IAP price schedule or updates subscription prices across available territories. Existing-subscriber price preservation is optional.",
|
|
4280
4346
|
flags: {
|
|
4281
4347
|
subscription: TARGET_FLAGS.subscription,
|
|
4282
4348
|
iap: TARGET_FLAGS.iap,
|
|
@@ -4301,7 +4367,7 @@ an in-app purchase replaces its price schedule; Apple equalizes the other territ
|
|
|
4301
4367
|
describe: "Subscriptions: when the price takes effect (default now)"
|
|
4302
4368
|
}
|
|
4303
4369
|
},
|
|
4304
|
-
effect: "
|
|
4370
|
+
effect: "destructive",
|
|
4305
4371
|
run: runPricesSet
|
|
4306
4372
|
}
|
|
4307
4373
|
],
|
|
@@ -4595,6 +4661,7 @@ release on before the version is released; pause, resume and complete steer it a
|
|
|
4595
4661
|
{
|
|
4596
4662
|
name: "submit",
|
|
4597
4663
|
summary: "Submit a version for App Review, with in-app products alongside",
|
|
4664
|
+
details: "Adds the version and optional products to a review submission and sets submitted=true, changing the existing review workflow.",
|
|
4598
4665
|
args: [VERSION_ARG],
|
|
4599
4666
|
flags: {
|
|
4600
4667
|
...VERSION_FLAGS,
|
|
@@ -4614,7 +4681,7 @@ release on before the version is released; pause, resume and complete steer it a
|
|
|
4614
4681
|
describe: "A subscription group to submit with it (repeatable)"
|
|
4615
4682
|
}
|
|
4616
4683
|
},
|
|
4617
|
-
effect: "
|
|
4684
|
+
effect: "destructive",
|
|
4618
4685
|
run: runReleaseSubmit
|
|
4619
4686
|
},
|
|
4620
4687
|
{
|
|
@@ -4622,12 +4689,14 @@ release on before the version is released; pause, resume and complete steer it a
|
|
|
4622
4689
|
summary: "Release a version that is pending developer release",
|
|
4623
4690
|
args: [VERSION_ARG],
|
|
4624
4691
|
flags: VERSION_FLAGS,
|
|
4692
|
+
confirm: true,
|
|
4625
4693
|
effect: "destructive",
|
|
4626
4694
|
run: runReleaseRelease
|
|
4627
4695
|
},
|
|
4628
4696
|
{
|
|
4629
4697
|
name: "phased",
|
|
4630
4698
|
summary: "Start, pause, resume or complete the version's phased release",
|
|
4699
|
+
details: "Starts, pauses, resumes or completes phased distribution. Completing releases to all users; other actions replace rollout state, subject to Apple’s transition guards.",
|
|
4631
4700
|
args: [{
|
|
4632
4701
|
name: "action",
|
|
4633
4702
|
describe: "What to do",
|
|
@@ -4635,7 +4704,7 @@ release on before the version is released; pause, resume and complete steer it a
|
|
|
4635
4704
|
choices: PHASED_ACTIONS
|
|
4636
4705
|
}, VERSION_ARG],
|
|
4637
4706
|
flags: VERSION_FLAGS,
|
|
4638
|
-
effect: "
|
|
4707
|
+
effect: "destructive",
|
|
4639
4708
|
run: runReleasePhased
|
|
4640
4709
|
},
|
|
4641
4710
|
{
|
|
@@ -4684,7 +4753,9 @@ const command$33 = defineCommand({
|
|
|
4684
4753
|
summary: "Submit subscriptions, groups and in-app purchases for App Review",
|
|
4685
4754
|
details: `Adds the latest version of each to the app's open review submission, or a new one,
|
|
4686
4755
|
then submits it. Apple reviews a first subscription or in-app purchase together with
|
|
4687
|
-
an app version
|
|
4756
|
+
an app version.
|
|
4757
|
+
|
|
4758
|
+
Starts Apple review for products/groups and submits the review submission. This is an outbound workflow transition, not only creation of a local draft.`,
|
|
4688
4759
|
flags: {
|
|
4689
4760
|
ascApp: {
|
|
4690
4761
|
type: "string",
|
|
@@ -4725,7 +4796,7 @@ an app version.`,
|
|
|
4725
4796
|
auth: "required",
|
|
4726
4797
|
json: true,
|
|
4727
4798
|
prompts: true,
|
|
4728
|
-
mcp: "
|
|
4799
|
+
mcp: "destructive",
|
|
4729
4800
|
run(ctx, { flags }) {
|
|
4730
4801
|
return runAscSubmit(ctx, {
|
|
4731
4802
|
ascApp: flags.ascApp,
|
|
@@ -4899,6 +4970,7 @@ const command$34 = defineAscResource({
|
|
|
4899
4970
|
{
|
|
4900
4971
|
name: "update",
|
|
4901
4972
|
summary: "Rename a group",
|
|
4973
|
+
details: "PATCH replaces the existing group reference name.",
|
|
4902
4974
|
args: [{
|
|
4903
4975
|
name: "id",
|
|
4904
4976
|
describe: "The subscription group's id",
|
|
@@ -4910,7 +4982,7 @@ const command$34 = defineAscResource({
|
|
|
4910
4982
|
describe: "The group's new name in App Store Connect",
|
|
4911
4983
|
required: true
|
|
4912
4984
|
} },
|
|
4913
|
-
effect: "
|
|
4985
|
+
effect: "destructive",
|
|
4914
4986
|
run: runSubscriptionGroupsUpdate
|
|
4915
4987
|
},
|
|
4916
4988
|
{
|
|
@@ -4921,6 +4993,7 @@ const command$34 = defineAscResource({
|
|
|
4921
4993
|
describe: "The subscription group's id",
|
|
4922
4994
|
required: true
|
|
4923
4995
|
}],
|
|
4996
|
+
confirm: true,
|
|
4924
4997
|
effect: "destructive",
|
|
4925
4998
|
run: runSubscriptionGroupsDelete
|
|
4926
4999
|
}
|
|
@@ -5037,7 +5110,7 @@ Exit codes
|
|
|
5037
5110
|
prompts: true,
|
|
5038
5111
|
mcp: false,
|
|
5039
5112
|
async run(ctx, input) {
|
|
5040
|
-
const { runSetupApple } = await import("./apple-
|
|
5113
|
+
const { runSetupApple } = await import("./apple-Bcr_PteR.js");
|
|
5041
5114
|
return runSetupApple(ctx, input);
|
|
5042
5115
|
}
|
|
5043
5116
|
});
|
|
@@ -5364,6 +5437,7 @@ state and what is still missing.`,
|
|
|
5364
5437
|
{
|
|
5365
5438
|
name: "update",
|
|
5366
5439
|
summary: "Change a subscription",
|
|
5440
|
+
details: "PATCH replaces subscription attributes, including period, group level and family-sharing configuration when accepted by Apple.",
|
|
5367
5441
|
args: [{
|
|
5368
5442
|
name: "id",
|
|
5369
5443
|
describe: "The subscription's id",
|
|
@@ -5396,7 +5470,7 @@ state and what is still missing.`,
|
|
|
5396
5470
|
describe: "A note for App Review"
|
|
5397
5471
|
}
|
|
5398
5472
|
},
|
|
5399
|
-
effect: "
|
|
5473
|
+
effect: "destructive",
|
|
5400
5474
|
run: runSubscriptionsUpdate
|
|
5401
5475
|
},
|
|
5402
5476
|
{
|
|
@@ -5407,6 +5481,7 @@ state and what is still missing.`,
|
|
|
5407
5481
|
describe: "The subscription's id",
|
|
5408
5482
|
required: true
|
|
5409
5483
|
}],
|
|
5484
|
+
confirm: true,
|
|
5410
5485
|
effect: "destructive",
|
|
5411
5486
|
run: runSubscriptionsDelete
|
|
5412
5487
|
}
|
|
@@ -5506,6 +5581,7 @@ off iOS, --platform. --earliest-release-date (2026-11-01T08:00:00-07:00) goes wi
|
|
|
5506
5581
|
{
|
|
5507
5582
|
name: "update",
|
|
5508
5583
|
summary: "Change a version",
|
|
5584
|
+
details: "PATCH overwrites version fields, release type and earliest release date; it can change automatic-release behavior.",
|
|
5509
5585
|
args: [VERSION_ARG],
|
|
5510
5586
|
flags: {
|
|
5511
5587
|
...VERSION_FLAGS,
|
|
@@ -5531,7 +5607,7 @@ off iOS, --platform. --earliest-release-date (2026-11-01T08:00:00-07:00) goes wi
|
|
|
5531
5607
|
describe: "The copyright line"
|
|
5532
5608
|
}
|
|
5533
5609
|
},
|
|
5534
|
-
effect: "
|
|
5610
|
+
effect: "destructive",
|
|
5535
5611
|
run: runVersionsUpdate
|
|
5536
5612
|
},
|
|
5537
5613
|
{
|
|
@@ -5539,6 +5615,7 @@ off iOS, --platform. --earliest-release-date (2026-11-01T08:00:00-07:00) goes wi
|
|
|
5539
5615
|
summary: "Delete a version while it is still editable",
|
|
5540
5616
|
args: [VERSION_ARG],
|
|
5541
5617
|
flags: VERSION_FLAGS,
|
|
5618
|
+
confirm: true,
|
|
5542
5619
|
effect: "destructive",
|
|
5543
5620
|
run: runVersionsDelete
|
|
5544
5621
|
}
|
|
@@ -5628,31 +5705,32 @@ const LIST_QUERY = [
|
|
|
5628
5705
|
"offset",
|
|
5629
5706
|
"all"
|
|
5630
5707
|
];
|
|
5631
|
-
const op = (group$1, action, method, path, summary, doc, rest = {}) => ({
|
|
5708
|
+
const op = (group$1, action, effect, method, path, summary, doc, rest = {}) => ({
|
|
5632
5709
|
group: group$1,
|
|
5633
5710
|
action,
|
|
5634
5711
|
method,
|
|
5635
5712
|
path,
|
|
5636
5713
|
summary,
|
|
5637
5714
|
doc,
|
|
5638
|
-
...rest
|
|
5715
|
+
...rest,
|
|
5716
|
+
effect
|
|
5639
5717
|
});
|
|
5640
5718
|
const list$1 = (group$1, path, summary, doc, rest = {}) => {
|
|
5641
|
-
return op(group$1, "list", "GET", path, summary, doc, {
|
|
5719
|
+
return op(group$1, "list", "read", "GET", path, summary, doc, {
|
|
5642
5720
|
paged: "query",
|
|
5643
5721
|
query: LIST_QUERY,
|
|
5644
5722
|
...rest
|
|
5645
5723
|
});
|
|
5646
5724
|
};
|
|
5647
5725
|
const byId = (group$1, path, summary, doc, rest = {}) => {
|
|
5648
|
-
return op(group$1, "get", "GET", path, summary, doc, {
|
|
5726
|
+
return op(group$1, "get", "read", "GET", path, summary, doc, {
|
|
5649
5727
|
positional: "id",
|
|
5650
5728
|
query: ["fields"],
|
|
5651
5729
|
...rest
|
|
5652
5730
|
});
|
|
5653
5731
|
};
|
|
5654
5732
|
const find = (group$1, path, summary, doc, rest = {}) => {
|
|
5655
|
-
return op(group$1, "find", "POST", path, summary, doc, {
|
|
5733
|
+
return op(group$1, "find", "read", "POST", path, summary, doc, {
|
|
5656
5734
|
body: "selector",
|
|
5657
5735
|
paged: "selector",
|
|
5658
5736
|
query: SELECTOR_QUERY,
|
|
@@ -5663,45 +5741,51 @@ const ASA_OPERATIONS = [
|
|
|
5663
5741
|
list$1("campaigns", "/campaigns", "List campaigns", "get-all-campaigns"),
|
|
5664
5742
|
byId("campaigns", "/campaigns/{id}", "Get a campaign", "get-a-campaign"),
|
|
5665
5743
|
find("campaigns", "/campaigns/find", "Find campaigns with a selector", "find-campaigns"),
|
|
5666
|
-
op("campaigns", "create", "POST", "/campaigns", "Create a campaign", "create-a-campaign", {
|
|
5744
|
+
op("campaigns", "create", "destructive", "POST", "/campaigns", "Create a campaign", "create-a-campaign", {
|
|
5745
|
+
details: "Creates a campaign with a budget and caller-selected status. ENABLED permits advertising once Apple’s serving requirements are met; this is not restricted to paused drafts.",
|
|
5667
5746
|
body: "object",
|
|
5668
5747
|
flags: CAMPAIGN_FIELDS
|
|
5669
5748
|
}),
|
|
5670
|
-
op("campaigns", "update", "PUT", "/campaigns/{id}", "Update a campaign", "update-a-campaign", {
|
|
5749
|
+
op("campaigns", "update", "destructive", "PUT", "/campaigns/{id}", "Update a campaign", "update-a-campaign", {
|
|
5750
|
+
details: "Overwrites campaign status, countries and daily/lifetime budgets; can enable spending or pause delivery.",
|
|
5671
5751
|
positional: "id",
|
|
5672
5752
|
body: "object",
|
|
5673
5753
|
envelope: "campaign",
|
|
5674
5754
|
flags: CAMPAIGN_FIELDS
|
|
5675
5755
|
}),
|
|
5676
|
-
op("campaigns", "delete", "DELETE", "/campaigns/{id}", "Delete a campaign", "delete-a-campaign", { positional: "id" }),
|
|
5756
|
+
op("campaigns", "delete", "destructive", "DELETE", "/campaigns/{id}", "Delete a campaign", "delete-a-campaign", { positional: "id" }),
|
|
5677
5757
|
list$1("adgroups", "/campaigns/{campaign}/adgroups", "List ad groups in a campaign", "get-all-ad-groups"),
|
|
5678
5758
|
byId("adgroups", "/campaigns/{campaign}/adgroups/{id}", "Get an ad group", "get-an-ad-group"),
|
|
5679
5759
|
find("adgroups", "/campaigns/{campaign}/adgroups/find", "Find ad groups in a campaign", "find-ad-groups"),
|
|
5680
5760
|
find("adgroups", "/adgroups/find", "Find ad groups across the org", "find-ad-groups-(org-level)"),
|
|
5681
|
-
op("adgroups", "create", "POST", "/campaigns/{campaign}/adgroups", "Create an ad group", "create-an-ad-group", {
|
|
5761
|
+
op("adgroups", "create", "destructive", "POST", "/campaigns/{campaign}/adgroups", "Create an ad group", "create-an-ad-group", {
|
|
5762
|
+
details: "Creates a bid-bearing ad group. An enabled group in an eligible live campaign can begin serving and spending immediately.",
|
|
5682
5763
|
body: "object",
|
|
5683
5764
|
flags: ADGROUP_FIELDS
|
|
5684
5765
|
}),
|
|
5685
|
-
op("adgroups", "update", "PUT", "/campaigns/{campaign}/adgroups/{id}", "Update an ad group", "update-an-ad-group", {
|
|
5766
|
+
op("adgroups", "update", "destructive", "PUT", "/campaigns/{campaign}/adgroups/{id}", "Update an ad group", "update-an-ad-group", {
|
|
5767
|
+
details: "Overwrites ad-group status, bids, CPA goal, dates and Search Match behavior.",
|
|
5686
5768
|
positional: "id",
|
|
5687
5769
|
body: "object",
|
|
5688
5770
|
flags: ADGROUP_FIELDS
|
|
5689
5771
|
}),
|
|
5690
|
-
op("adgroups", "delete", "DELETE", "/campaigns/{campaign}/adgroups/{id}", "Delete an ad group", "delete-an-ad-group", { positional: "id" }),
|
|
5772
|
+
op("adgroups", "delete", "destructive", "DELETE", "/campaigns/{campaign}/adgroups/{id}", "Delete an ad group", "delete-an-ad-group", { positional: "id" }),
|
|
5691
5773
|
list$1("keywords", "/campaigns/{campaign}/adgroups/{adgroup}/targetingkeywords", "List targeting keywords in an ad group", "get-all-targeting-keywords-in-an-ad-group"),
|
|
5692
5774
|
byId("keywords", "/campaigns/{campaign}/adgroups/{adgroup}/targetingkeywords/{id}", "Get a targeting keyword", "get-a-targeting-keyword-in-an-ad-group"),
|
|
5693
5775
|
find("keywords", "/campaigns/{campaign}/adgroups/targetingkeywords/find", "Find targeting keywords across a campaign", "find-targeting-keywords-in-a-campaign"),
|
|
5694
|
-
op("keywords", "create", "POST", "/campaigns/{campaign}/adgroups/{adgroup}/targetingkeywords/bulk", "Create targeting keywords (bulk)", "create-targeting-keywords", {
|
|
5776
|
+
op("keywords", "create", "destructive", "POST", "/campaigns/{campaign}/adgroups/{adgroup}/targetingkeywords/bulk", "Create targeting keywords (bulk)", "create-targeting-keywords", {
|
|
5777
|
+
details: "Creates targeting keywords, which can be ACTIVE with bids in a live ad group and enable spending.",
|
|
5695
5778
|
body: "array",
|
|
5696
5779
|
flags: KEYWORD_FIELDS
|
|
5697
5780
|
}),
|
|
5698
|
-
op("keywords", "update", "PUT", "/campaigns/{campaign}/adgroups/{adgroup}/targetingkeywords/bulk", "Update targeting keywords (bulk)", "update-targeting-keywords", {
|
|
5781
|
+
op("keywords", "update", "destructive", "PUT", "/campaigns/{campaign}/adgroups/{adgroup}/targetingkeywords/bulk", "Update targeting keywords (bulk)", "update-targeting-keywords", {
|
|
5782
|
+
details: "Bulk-overwrites targeting keyword status, match type or bids.",
|
|
5699
5783
|
positional: "id",
|
|
5700
5784
|
body: "array",
|
|
5701
5785
|
flags: KEYWORD_FIELDS
|
|
5702
5786
|
}),
|
|
5703
|
-
op("keywords", "delete", "DELETE", "/campaigns/{campaign}/adgroups/{adgroup}/targetingkeywords/{id}", "Delete a targeting keyword", "delete-a-targeting-keyword", { positional: "ids" }),
|
|
5704
|
-
op("keywords", "delete", "POST", "/campaigns/{campaign}/adgroups/{adgroup}/targetingkeywords/delete/bulk", "Delete targeting keywords (bulk)", "delete-targeting-keywords", {
|
|
5787
|
+
op("keywords", "delete", "destructive", "DELETE", "/campaigns/{campaign}/adgroups/{adgroup}/targetingkeywords/{id}", "Delete a targeting keyword", "delete-a-targeting-keyword", { positional: "ids" }),
|
|
5788
|
+
op("keywords", "delete", "destructive", "POST", "/campaigns/{campaign}/adgroups/{adgroup}/targetingkeywords/delete/bulk", "Delete targeting keywords (bulk)", "delete-targeting-keywords", {
|
|
5705
5789
|
positional: "ids",
|
|
5706
5790
|
body: "ids"
|
|
5707
5791
|
}),
|
|
@@ -5711,29 +5795,31 @@ const ASA_OPERATIONS = [
|
|
|
5711
5795
|
byId("negative-keywords", "/campaigns/{campaign}/adgroups/{adgroup}/negativekeywords/{id}", "Get an ad group negative keyword", "get-an-ad-group-negative-keyword"),
|
|
5712
5796
|
find("negative-keywords", "/campaigns/{campaign}/negativekeywords/find", "Find campaign negative keywords", "find-campaign-negative-keywords"),
|
|
5713
5797
|
find("negative-keywords", "/campaigns/{campaign}/adgroups/negativekeywords/find", "Find ad group negative keywords across a campaign", "find-ad-group-negative-keywords", { level: "adgroup" }),
|
|
5714
|
-
op("negative-keywords", "create", "POST", "/campaigns/{campaign}/negativekeywords/bulk", "Create campaign negative keywords (bulk)", "create-campaign-negative-keywords", {
|
|
5798
|
+
op("negative-keywords", "create", "write", "POST", "/campaigns/{campaign}/negativekeywords/bulk", "Create campaign negative keywords (bulk)", "create-campaign-negative-keywords", {
|
|
5715
5799
|
body: "array",
|
|
5716
5800
|
flags: NEGATIVE_FIELDS
|
|
5717
5801
|
}),
|
|
5718
|
-
op("negative-keywords", "create", "POST", "/campaigns/{campaign}/adgroups/{adgroup}/negativekeywords/bulk", "Create ad group negative keywords (bulk)", "create-ad-group-negative-keywords", {
|
|
5802
|
+
op("negative-keywords", "create", "write", "POST", "/campaigns/{campaign}/adgroups/{adgroup}/negativekeywords/bulk", "Create ad group negative keywords (bulk)", "create-ad-group-negative-keywords", {
|
|
5719
5803
|
body: "array",
|
|
5720
5804
|
flags: NEGATIVE_FIELDS
|
|
5721
5805
|
}),
|
|
5722
|
-
op("negative-keywords", "update", "PUT", "/campaigns/{campaign}/negativekeywords/bulk", "Update campaign negative keywords (bulk)", "update-campaign-negative-keywords", {
|
|
5806
|
+
op("negative-keywords", "update", "destructive", "PUT", "/campaigns/{campaign}/negativekeywords/bulk", "Update campaign negative keywords (bulk)", "update-campaign-negative-keywords", {
|
|
5807
|
+
details: "Bulk-overwrites negative keyword configuration and can change which traffic is excluded.",
|
|
5723
5808
|
positional: "id",
|
|
5724
5809
|
body: "array",
|
|
5725
5810
|
flags: NEGATIVE_FIELDS
|
|
5726
5811
|
}),
|
|
5727
|
-
op("negative-keywords", "update", "PUT", "/campaigns/{campaign}/adgroups/{adgroup}/negativekeywords/bulk", "Update ad group negative keywords (bulk)", "update-ad-group-negative-keywords", {
|
|
5812
|
+
op("negative-keywords", "update", "destructive", "PUT", "/campaigns/{campaign}/adgroups/{adgroup}/negativekeywords/bulk", "Update ad group negative keywords (bulk)", "update-ad-group-negative-keywords", {
|
|
5813
|
+
details: "Bulk-overwrites negative keyword configuration and can change which traffic is excluded.",
|
|
5728
5814
|
positional: "id",
|
|
5729
5815
|
body: "array",
|
|
5730
5816
|
flags: NEGATIVE_FIELDS
|
|
5731
5817
|
}),
|
|
5732
|
-
op("negative-keywords", "delete", "POST", "/campaigns/{campaign}/negativekeywords/delete/bulk", "Delete campaign negative keywords", "delete-campaign-negative-keywords", {
|
|
5818
|
+
op("negative-keywords", "delete", "destructive", "POST", "/campaigns/{campaign}/negativekeywords/delete/bulk", "Delete campaign negative keywords", "delete-campaign-negative-keywords", {
|
|
5733
5819
|
positional: "ids",
|
|
5734
5820
|
body: "ids"
|
|
5735
5821
|
}),
|
|
5736
|
-
op("negative-keywords", "delete", "POST", "/campaigns/{campaign}/adgroups/{adgroup}/negativekeywords/delete/bulk", "Delete ad group negative keywords", "delete-ad-group-negative-keywords", {
|
|
5822
|
+
op("negative-keywords", "delete", "destructive", "POST", "/campaigns/{campaign}/adgroups/{adgroup}/negativekeywords/delete/bulk", "Delete ad group negative keywords", "delete-ad-group-negative-keywords", {
|
|
5737
5823
|
positional: "ids",
|
|
5738
5824
|
body: "ids"
|
|
5739
5825
|
}),
|
|
@@ -5741,20 +5827,22 @@ const ASA_OPERATIONS = [
|
|
|
5741
5827
|
byId("ads", "/campaigns/{campaign}/adgroups/{adgroup}/ads/{id}", "Get an ad", "get-an-ad"),
|
|
5742
5828
|
find("ads", "/campaigns/{campaign}/ads/find", "Find ads in a campaign", "find-ads"),
|
|
5743
5829
|
find("ads", "/ads/find", "Find ads across the org", "find-ads-(org-level)"),
|
|
5744
|
-
op("ads", "create", "POST", "/campaigns/{campaign}/adgroups/{adgroup}/ads", "Create an ad", "create-an-ad", {
|
|
5830
|
+
op("ads", "create", "destructive", "POST", "/campaigns/{campaign}/adgroups/{adgroup}/ads", "Create an ad", "create-an-ad", {
|
|
5831
|
+
details: "Creates an ad assigned to a creative. An ENABLED ad in an eligible live group can begin serving and spending immediately.",
|
|
5745
5832
|
body: "object",
|
|
5746
5833
|
flags: AD_FIELDS
|
|
5747
5834
|
}),
|
|
5748
|
-
op("ads", "update", "PUT", "/campaigns/{campaign}/adgroups/{adgroup}/ads/{id}", "Update an ad", "update-an-ad", {
|
|
5835
|
+
op("ads", "update", "destructive", "PUT", "/campaigns/{campaign}/adgroups/{adgroup}/ads/{id}", "Update an ad", "update-an-ad", {
|
|
5836
|
+
details: "Overwrites ad status/name; pausing or enabling changes delivery.",
|
|
5749
5837
|
positional: "id",
|
|
5750
5838
|
body: "object",
|
|
5751
5839
|
flags: [NAME, STATUS]
|
|
5752
5840
|
}),
|
|
5753
|
-
op("ads", "delete", "DELETE", "/campaigns/{campaign}/adgroups/{adgroup}/ads/{id}", "Delete an ad", "delete-an-ad", { positional: "id" }),
|
|
5841
|
+
op("ads", "delete", "destructive", "DELETE", "/campaigns/{campaign}/adgroups/{adgroup}/ads/{id}", "Delete an ad", "delete-an-ad", { positional: "id" }),
|
|
5754
5842
|
list$1("creatives", "/creatives", "List creatives", "get-all-creatives"),
|
|
5755
5843
|
byId("creatives", "/creatives/{id}", "Get a creative", "get-a-creative", { query: ["fields", "include-deleted-assets"] }),
|
|
5756
5844
|
find("creatives", "/creatives/find", "Find creatives with a selector", "find-creatives"),
|
|
5757
|
-
op("creatives", "create", "POST", "/creatives", "Create a creative", "create-a-creative", {
|
|
5845
|
+
op("creatives", "create", "write", "POST", "/creatives", "Create a creative", "create-a-creative", {
|
|
5758
5846
|
body: "object",
|
|
5759
5847
|
flags: [
|
|
5760
5848
|
ADAM_ID,
|
|
@@ -5772,7 +5860,7 @@ const ASA_OPERATIONS = [
|
|
|
5772
5860
|
]
|
|
5773
5861
|
}),
|
|
5774
5862
|
byId("product-pages", "/apps/{adamId}/product-pages/{id}", "Get a product page", "get-product-pages-by-identifier", { query: ["adam-id"] }),
|
|
5775
|
-
op("product-pages", "locales", "GET", "/apps/{adamId}/product-pages/{id}/locale-details", "Get a product page's locales", "get-product-page-locales", {
|
|
5863
|
+
op("product-pages", "locales", "read", "GET", "/apps/{adamId}/product-pages/{id}/locale-details", "Get a product page's locales", "get-product-page-locales", {
|
|
5776
5864
|
positional: "id",
|
|
5777
5865
|
query: [
|
|
5778
5866
|
"adam-id",
|
|
@@ -5781,45 +5869,46 @@ const ASA_OPERATIONS = [
|
|
|
5781
5869
|
"expand"
|
|
5782
5870
|
]
|
|
5783
5871
|
}),
|
|
5784
|
-
op("product-pages", "countries", "GET", "/countries-or-regions", "List supported countries or regions", "get-supported-countries-or-regions", { query: ["countries"] }),
|
|
5785
|
-
op("product-pages", "device-sizes", "GET", "/creativeappmappings/devices", "List app preview device sizes", "get-app-preview-device-sizes"),
|
|
5872
|
+
op("product-pages", "countries", "read", "GET", "/countries-or-regions", "List supported countries or regions", "get-supported-countries-or-regions", { query: ["countries"] }),
|
|
5873
|
+
op("product-pages", "device-sizes", "read", "GET", "/creativeappmappings/devices", "List app preview device sizes", "get-app-preview-device-sizes"),
|
|
5786
5874
|
find("ad-rejections", "/product-page-reasons/find", "Find ad creative rejection reasons", "find-ad-creative-rejection-reasons"),
|
|
5787
5875
|
byId("ad-rejections", "/product-page-reasons/{id}", "Get an ad creative rejection reason", "gets-a-product-page-reason"),
|
|
5788
5876
|
find("ad-rejections", "/apps/{adamId}/assets/find", "Find an app's assets", "find-app-assets", {
|
|
5789
5877
|
action: "assets",
|
|
5878
|
+
details: "Retrieves asset metadata with a selector using POST; does not modify assets or start a job.",
|
|
5790
5879
|
query: [...SELECTOR_QUERY, "adam-id"]
|
|
5791
5880
|
}),
|
|
5792
|
-
op("reports", "campaigns", "POST", "/reports/campaigns", "Campaign-level report", "get-campaign-level-reports", {
|
|
5881
|
+
op("reports", "campaigns", "read", "POST", "/reports/campaigns", "Campaign-level report", "get-campaign-level-reports", {
|
|
5793
5882
|
body: "report",
|
|
5794
5883
|
flags: REPORT_FLAGS
|
|
5795
5884
|
}),
|
|
5796
|
-
op("reports", "adgroups", "POST", "/reports/campaigns/{campaign}/adgroups", "Ad group-level report", "get-ad-group-level-reports", {
|
|
5885
|
+
op("reports", "adgroups", "read", "POST", "/reports/campaigns/{campaign}/adgroups", "Ad group-level report", "get-ad-group-level-reports", {
|
|
5797
5886
|
body: "report",
|
|
5798
5887
|
flags: REPORT_FLAGS
|
|
5799
5888
|
}),
|
|
5800
|
-
op("reports", "keywords", "POST", "/reports/campaigns/{campaign}/keywords", "Keyword-level report", "get-keyword-level-reports", {
|
|
5889
|
+
op("reports", "keywords", "read", "POST", "/reports/campaigns/{campaign}/keywords", "Keyword-level report", "get-keyword-level-reports", {
|
|
5801
5890
|
body: "report",
|
|
5802
5891
|
flags: REPORT_FLAGS
|
|
5803
5892
|
}),
|
|
5804
|
-
op("reports", "keywords", "POST", "/reports/campaigns/{campaign}/adgroups/{adgroup}/keywords", "Keyword-level report within an ad group", "get-keyword-level-within-ad-group-reports", {
|
|
5893
|
+
op("reports", "keywords", "read", "POST", "/reports/campaigns/{campaign}/adgroups/{adgroup}/keywords", "Keyword-level report within an ad group", "get-keyword-level-within-ad-group-reports", {
|
|
5805
5894
|
body: "report",
|
|
5806
5895
|
flags: REPORT_FLAGS
|
|
5807
5896
|
}),
|
|
5808
|
-
op("reports", "searchterms", "POST", "/reports/campaigns/{campaign}/searchterms", "Search term-level report", "get-search-term-level-reports", {
|
|
5897
|
+
op("reports", "searchterms", "read", "POST", "/reports/campaigns/{campaign}/searchterms", "Search term-level report", "get-search-term-level-reports", {
|
|
5809
5898
|
body: "report",
|
|
5810
5899
|
flags: REPORT_FLAGS
|
|
5811
5900
|
}),
|
|
5812
|
-
op("reports", "searchterms", "POST", "/reports/campaigns/{campaign}/adgroups/{adgroup}/searchterms", "Search term-level report within an ad group", "get-search-term-level-within-ad-group-reports", {
|
|
5901
|
+
op("reports", "searchterms", "read", "POST", "/reports/campaigns/{campaign}/adgroups/{adgroup}/searchterms", "Search term-level report within an ad group", "get-search-term-level-within-ad-group-reports", {
|
|
5813
5902
|
body: "report",
|
|
5814
5903
|
flags: REPORT_FLAGS
|
|
5815
5904
|
}),
|
|
5816
|
-
op("reports", "ads", "POST", "/reports/campaigns/{campaign}/ads", "Ad-level report", "get-ad-level-reports", {
|
|
5905
|
+
op("reports", "ads", "read", "POST", "/reports/campaigns/{campaign}/ads", "Ad-level report", "get-ad-level-reports", {
|
|
5817
5906
|
body: "report",
|
|
5818
5907
|
flags: REPORT_FLAGS
|
|
5819
5908
|
}),
|
|
5820
5909
|
list$1("impression-share", "/custom-reports", "List impression share reports", "get-all-impression-share-reports"),
|
|
5821
5910
|
byId("impression-share", "/custom-reports/{id}", "Get an impression share report", "get-a-single-impression-share-report"),
|
|
5822
|
-
op("impression-share", "create", "POST", "/custom-reports", "Request an impression share report", "impression-share-report", {
|
|
5911
|
+
op("impression-share", "create", "write", "POST", "/custom-reports", "Request an impression share report", "impression-share-report", {
|
|
5823
5912
|
body: "object",
|
|
5824
5913
|
flags: [
|
|
5825
5914
|
NAME,
|
|
@@ -5830,7 +5919,7 @@ const ASA_OPERATIONS = [
|
|
|
5830
5919
|
flag("metrics", "metrics", "list", "Comma-separated metrics")
|
|
5831
5920
|
]
|
|
5832
5921
|
}),
|
|
5833
|
-
op("apps", "search", "GET", "/search/apps", "Search the App Store for apps", "search-for-ios-apps", {
|
|
5922
|
+
op("apps", "search", "read", "GET", "/search/apps", "Search the App Store for apps", "search-for-ios-apps", {
|
|
5834
5923
|
positional: "query",
|
|
5835
5924
|
paged: "query",
|
|
5836
5925
|
query: [
|
|
@@ -5842,11 +5931,12 @@ const ASA_OPERATIONS = [
|
|
|
5842
5931
|
}),
|
|
5843
5932
|
find("apps", "/apps/{adamId}/eligibilities/find", "Find an app's eligibility records", "find-app-eligibility-records", {
|
|
5844
5933
|
action: "eligibility",
|
|
5934
|
+
details: "Retrieves app eligibility records using POST; does not change eligibility or start a job.",
|
|
5845
5935
|
positional: "adam-id"
|
|
5846
5936
|
}),
|
|
5847
|
-
op("apps", "get", "GET", "/apps/{adamId}", "Get app details", "get-app-details", { positional: "adam-id" }),
|
|
5848
|
-
op("apps", "localized", "GET", "/apps/{adamId}/locale-details", "Get localized app details", "get-localized-app-details", { positional: "adam-id" }),
|
|
5849
|
-
op("geo", "search", "GET", "/search/geo", "Search geolocations", "search-for-geolocations", {
|
|
5937
|
+
op("apps", "get", "read", "GET", "/apps/{adamId}", "Get app details", "get-app-details", { positional: "adam-id" }),
|
|
5938
|
+
op("apps", "localized", "read", "GET", "/apps/{adamId}/locale-details", "Get localized app details", "get-localized-app-details", { positional: "adam-id" }),
|
|
5939
|
+
op("geo", "search", "read", "GET", "/search/geo", "Search geolocations", "search-for-geolocations", {
|
|
5850
5940
|
positional: "query",
|
|
5851
5941
|
paged: "query",
|
|
5852
5942
|
query: [
|
|
@@ -5857,20 +5947,25 @@ const ASA_OPERATIONS = [
|
|
|
5857
5947
|
"all"
|
|
5858
5948
|
]
|
|
5859
5949
|
}),
|
|
5860
|
-
op("geo", "get", "POST", "/search/geo", "Look up geolocations by id", "get-a-list-of-geo-locations", {
|
|
5950
|
+
op("geo", "get", "read", "POST", "/search/geo", "Look up geolocations by id", "get-a-list-of-geo-locations", {
|
|
5951
|
+
details: "Retrieves geolocations by ID using POST; does not create locations or start a job.",
|
|
5861
5952
|
positional: "ids",
|
|
5862
5953
|
body: "geo",
|
|
5863
5954
|
query: ["entity"]
|
|
5864
5955
|
}),
|
|
5865
5956
|
list$1("budget-orders", "/budgetorders", "List budget orders", "get-all-budget-orders"),
|
|
5866
5957
|
byId("budget-orders", "/budgetorders/{id}", "Get a budget order", "get-a-budget-order"),
|
|
5867
|
-
op("budget-orders", "create", "POST", "/budgetorders", "Create a budget order", "create-a-budget-order", {
|
|
5868
|
-
|
|
5958
|
+
op("budget-orders", "create", "destructive", "POST", "/budgetorders", "Create a budget order", "create-a-budget-order", {
|
|
5959
|
+
details: "Creates a financial budget order for the organization. Apple can return it ACTIVE; the request is not restricted to a draft allocation.",
|
|
5960
|
+
body: "object"
|
|
5961
|
+
}),
|
|
5962
|
+
op("budget-orders", "update", "destructive", "PUT", "/budgetorders/{id}", "Update a budget order", "update-a-budget-order", {
|
|
5963
|
+
details: "Overwrites a financial budget order using an unrestricted request body.",
|
|
5869
5964
|
positional: "id",
|
|
5870
5965
|
body: "object"
|
|
5871
5966
|
}),
|
|
5872
|
-
op("acls", "list", "GET", "/acls", "List the orgs this API user can access", "get-user-acl"),
|
|
5873
|
-
op("me", "get", "GET", "/me", "Show the calling API user", "get-me-details")
|
|
5967
|
+
op("acls", "list", "read", "GET", "/acls", "List the orgs this API user can access", "get-user-acl"),
|
|
5968
|
+
op("me", "get", "read", "GET", "/me", "Show the calling API user", "get-me-details")
|
|
5874
5969
|
];
|
|
5875
5970
|
const PLACEHOLDERS = [
|
|
5876
5971
|
"campaign",
|
|
@@ -6070,7 +6165,7 @@ function renderAsaHelp(words) {
|
|
|
6070
6165
|
usage: formatAsaUsage(op$1),
|
|
6071
6166
|
summary: variants.map((variant) => variant.summary).join("; "),
|
|
6072
6167
|
flags: formatAsaFlags(op$1, variants),
|
|
6073
|
-
details: `Apple's schema for it: superwall asa docs ${group$1} ${action}`
|
|
6168
|
+
details: [...new Set(variants.map((variant) => variant.details).filter(Boolean)), `Apple's schema for it: superwall asa docs ${group$1} ${action}`].join("\n\n")
|
|
6074
6169
|
});
|
|
6075
6170
|
}
|
|
6076
6171
|
|
|
@@ -6867,17 +6962,17 @@ function toolOf$1(group$1, action) {
|
|
|
6867
6962
|
description: "Ad group negative keywords instead of the campaign's"
|
|
6868
6963
|
};
|
|
6869
6964
|
}
|
|
6870
|
-
const
|
|
6965
|
+
const effect = variants.some((variant) => variant.effect === "destructive") ? "destructive" : variants.every((variant) => variant.effect === "read") ? "read" : "write";
|
|
6871
6966
|
return {
|
|
6872
6967
|
words: [group$1, action],
|
|
6873
6968
|
summary: variants.map((variant) => variant.summary).join("; "),
|
|
6874
|
-
details: `Apple's schema for it: the asa_docs tool with "${group$1} ${action}"
|
|
6969
|
+
details: [...new Set(variants.map((variant) => variant.details).filter(Boolean)), `Apple's schema for it: the asa_docs tool with "${group$1} ${action}".`].join("\n\n"),
|
|
6875
6970
|
positionals,
|
|
6876
6971
|
input: {
|
|
6877
6972
|
properties,
|
|
6878
6973
|
required: [...new Set(required)]
|
|
6879
6974
|
},
|
|
6880
|
-
effect
|
|
6975
|
+
effect
|
|
6881
6976
|
};
|
|
6882
6977
|
}
|
|
6883
6978
|
async function listAsaTools() {
|
|
@@ -7529,6 +7624,7 @@ const command$42 = defineCommand({
|
|
|
7529
7624
|
const command$43 = defineCommand({
|
|
7530
7625
|
name: "asa post",
|
|
7531
7626
|
summary: "Any POST request to the Apple Search Ads API",
|
|
7627
|
+
details: "Executes an arbitrary Apple Ads POST. It can bulk-delete resources, activate advertising or create financial budget orders; repeating a call may repeat its effects.",
|
|
7532
7628
|
args: { path: {
|
|
7533
7629
|
describe: "Apple Search Ads API path, e.g. /campaigns (the /api/v5 prefix is added)",
|
|
7534
7630
|
required: true
|
|
@@ -7557,7 +7653,7 @@ const command$43 = defineCommand({
|
|
|
7557
7653
|
auth: "required",
|
|
7558
7654
|
json: true,
|
|
7559
7655
|
prompts: false,
|
|
7560
|
-
mcp: "
|
|
7656
|
+
mcp: "destructive",
|
|
7561
7657
|
async run(ctx, { args, flags }) {
|
|
7562
7658
|
const res = await runAsaRequest(ctx, ctx.api, {
|
|
7563
7659
|
verb: "post",
|
|
@@ -7575,6 +7671,7 @@ const command$43 = defineCommand({
|
|
|
7575
7671
|
const command$44 = defineCommand({
|
|
7576
7672
|
name: "asa put",
|
|
7577
7673
|
summary: "Any PUT request to the Apple Search Ads API",
|
|
7674
|
+
details: "Executes an arbitrary Apple Ads PUT. It can overwrite bids, targeting, budgets and delivery status.",
|
|
7578
7675
|
args: { path: {
|
|
7579
7676
|
describe: "Apple Search Ads API path, e.g. /campaigns (the /api/v5 prefix is added)",
|
|
7580
7677
|
required: true
|
|
@@ -7603,7 +7700,7 @@ const command$44 = defineCommand({
|
|
|
7603
7700
|
auth: "required",
|
|
7604
7701
|
json: true,
|
|
7605
7702
|
prompts: false,
|
|
7606
|
-
mcp: "
|
|
7703
|
+
mcp: "destructive",
|
|
7607
7704
|
async run(ctx, { args, flags }) {
|
|
7608
7705
|
const res = await runAsaRequest(ctx, ctx.api, {
|
|
7609
7706
|
verb: "put",
|
|
@@ -7646,7 +7743,7 @@ const command$45 = defineCommand({
|
|
|
7646
7743
|
mcp: false,
|
|
7647
7744
|
channel: "next",
|
|
7648
7745
|
async run(ctx, { args, flags }) {
|
|
7649
|
-
const { runBuildPipeline } = await import("./build
|
|
7746
|
+
const { runBuildPipeline } = await import("./build--oQKfZU6.js");
|
|
7650
7747
|
await runBuildPipeline({
|
|
7651
7748
|
output: ctx.output,
|
|
7652
7749
|
json: ctx.json
|
|
@@ -7708,7 +7805,7 @@ const command$46 = defineCommand({
|
|
|
7708
7805
|
mcp: false,
|
|
7709
7806
|
channel: "next",
|
|
7710
7807
|
async run(ctx, { args, flags }) {
|
|
7711
|
-
const { runCreate } = await import("./create-
|
|
7808
|
+
const { runCreate } = await import("./create-BG9n4fvs.js");
|
|
7712
7809
|
return runCreate(ctx, {
|
|
7713
7810
|
dir: args.dir,
|
|
7714
7811
|
...flags
|
|
@@ -7752,7 +7849,7 @@ const command$47 = defineCommand({
|
|
|
7752
7849
|
mcp: false,
|
|
7753
7850
|
channel: "next",
|
|
7754
7851
|
async run(ctx, { args, flags }) {
|
|
7755
|
-
const { runStudio } = await import("./server-
|
|
7852
|
+
const { runStudio } = await import("./server-BTveynqC.js");
|
|
7756
7853
|
await runStudio({
|
|
7757
7854
|
dirs: args.dir,
|
|
7758
7855
|
port: flags.port,
|
|
@@ -7793,7 +7890,7 @@ const command$48 = defineCommand({
|
|
|
7793
7890
|
mcp: false,
|
|
7794
7891
|
channel: "next",
|
|
7795
7892
|
async run(ctx, input) {
|
|
7796
|
-
const { runPromote } = await import("./promote-
|
|
7893
|
+
const { runPromote } = await import("./promote-BkJYISza.js");
|
|
7797
7894
|
return runPromote(ctx, input);
|
|
7798
7895
|
}
|
|
7799
7896
|
});
|
|
@@ -7838,7 +7935,7 @@ const command$49 = defineCommand({
|
|
|
7838
7935
|
mcp: false,
|
|
7839
7936
|
channel: "next",
|
|
7840
7937
|
async run(ctx, input) {
|
|
7841
|
-
const { runPush } = await import("./push-
|
|
7938
|
+
const { runPush } = await import("./push-BIizJJOn.js");
|
|
7842
7939
|
return runPush(ctx, input, true);
|
|
7843
7940
|
}
|
|
7844
7941
|
});
|
|
@@ -7883,7 +7980,7 @@ const command$50 = defineCommand({
|
|
|
7883
7980
|
mcp: false,
|
|
7884
7981
|
channel: "next",
|
|
7885
7982
|
async run(ctx, input) {
|
|
7886
|
-
const { runPush } = await import("./push-
|
|
7983
|
+
const { runPush } = await import("./push-BIizJJOn.js");
|
|
7887
7984
|
return runPush(ctx, input, false);
|
|
7888
7985
|
}
|
|
7889
7986
|
});
|
|
@@ -8000,7 +8097,7 @@ function resourceHelp(resource) {
|
|
|
8000
8097
|
})),
|
|
8001
8098
|
{
|
|
8002
8099
|
title: "Related",
|
|
8003
|
-
lines: table((resource.related ?? []).map(([command$
|
|
8100
|
+
lines: table((resource.related ?? []).map(([command$68, text]) => [`superwall ${command$68}`, pc.dim(text)]), ([left]) => left.length)
|
|
8004
8101
|
},
|
|
8005
8102
|
{
|
|
8006
8103
|
title: "Examples",
|
|
@@ -8272,7 +8369,7 @@ async function createApp(context, api, nameArg, fields) {
|
|
|
8272
8369
|
let name = nameArg;
|
|
8273
8370
|
let platform = textOf(fields.platform);
|
|
8274
8371
|
if (interactive && (!name || !platform)) {
|
|
8275
|
-
const { scanProject } = await import("./scan-
|
|
8372
|
+
const { scanProject } = await import("./scan-DjyvuWel.js");
|
|
8276
8373
|
const detected = (await scanProject(context.installDir).catch(() => null))?.apps[0];
|
|
8277
8374
|
if (detected && !name && !platform) {
|
|
8278
8375
|
ui.info(`Detected \`${detected.framework.name}\`` + (detected.details ? ` · \`${detected.details}\`` : ""));
|
|
@@ -8511,7 +8608,7 @@ async function runResource(ctx, resource, action, value$1, value2, flags) {
|
|
|
8511
8608
|
if (action === "create") return create(ctx, ctx.api, resource, value$1, value2, flags);
|
|
8512
8609
|
if (action === "use" && resource === "apps") return useApp(ctx, ctx.api, value$1);
|
|
8513
8610
|
if (action === "storekit" && resource === "products") {
|
|
8514
|
-
const { writeStoreKit } = await import("./storekit-
|
|
8611
|
+
const { writeStoreKit } = await import("./storekit-C_LFh8qy.js");
|
|
8515
8612
|
return writeStoreKit(ctx, ctx.api, flags.fields.out);
|
|
8516
8613
|
}
|
|
8517
8614
|
throw new Error(`Unknown action "${action}" for ${resource}.`);
|
|
@@ -8525,15 +8622,15 @@ async function runOperation(ctx, owner, resource, op$1, args, flags) {
|
|
|
8525
8622
|
}
|
|
8526
8623
|
const toFlag = (field) => `--${field.replace(/_/g, "-")}`;
|
|
8527
8624
|
async function callOperation(context, owner, resource, op$1, ids, flags, merged = {}) {
|
|
8528
|
-
const command$
|
|
8625
|
+
const command$68 = `superwall ${owner === resource ? "" : `${owner.name} `}${resource.name} ${op$1.name}`;
|
|
8529
8626
|
const { method, path: template } = op$1;
|
|
8530
|
-
if (!method || !template) throw new Error(`${command$
|
|
8627
|
+
if (!method || !template) throw new Error(`${command$68} has no API endpoint.`);
|
|
8531
8628
|
const spec = await apiCall(context, "Loading the API reference", () => findSpec(op$1));
|
|
8532
8629
|
const args = [...ids];
|
|
8533
8630
|
const ctx = owner.appArg && args[0] && !context.target.app ? withApp(context, args.shift()) : context;
|
|
8534
8631
|
const positional = positionalParams(op$1);
|
|
8535
|
-
if (args.length < positional.length) throw new Error(`Usage: ${command$
|
|
8536
|
-
if (args.length > positional.length) throw new Error(`${command$
|
|
8632
|
+
if (args.length < positional.length) throw new Error(`Usage: ${command$68} ${usageOf(owner, op$1)}\nRun \`${command$68} --help\` for its flags.`);
|
|
8633
|
+
if (args.length > positional.length) throw new Error(`${command$68} takes ${positional.length || "no"} argument${positional.length === 1 ? "" : "s"}; got "${args.slice(positional.length).join(" ")}".`);
|
|
8537
8634
|
const pathValues = /* @__PURE__ */ new Map();
|
|
8538
8635
|
const query = {};
|
|
8539
8636
|
const queryNames = new Set(spec?.params.filter((param) => param.in === "query").map((param) => param.name));
|
|
@@ -8553,7 +8650,7 @@ async function callOperation(context, owner, resource, op$1, ids, flags, merged
|
|
|
8553
8650
|
if (queryParam) query[field] = coerce(raw, queryParam.type);
|
|
8554
8651
|
else if (bodyField) body[field] = coerce(raw, bodyField.type);
|
|
8555
8652
|
else if (!spec) (sendsBody ? body : query)[field] = raw;
|
|
8556
|
-
else throw new Error(`${command$
|
|
8653
|
+
else throw new Error(`${command$68} has no ${toFlag(field)}. \`${command$68} --help\` lists what it takes.`);
|
|
8557
8654
|
}
|
|
8558
8655
|
Object.assign(sendsBody ? body : query, parseParams(flags.data));
|
|
8559
8656
|
await fillScope(ctx, op$1, spec, pathValues, query, body);
|
|
@@ -8562,11 +8659,11 @@ async function callOperation(context, owner, resource, op$1, ids, flags, merged
|
|
|
8562
8659
|
});
|
|
8563
8660
|
if (missing$1.length > 0) {
|
|
8564
8661
|
const needs = missing$1.map((param) => `${toFlag(param.name)} <${param.type.replace(/"/g, "").replace(/ \| /g, "|")}>`);
|
|
8565
|
-
throw new Error(`${command$
|
|
8662
|
+
throw new Error(`${command$68} needs ${needs.join(" and ")}.`);
|
|
8566
8663
|
}
|
|
8567
8664
|
const url = withQuery(template.replace(/\{([^}]+)\}/g, (_, param) => {
|
|
8568
8665
|
const value$1 = pathValues.get(param);
|
|
8569
|
-
if (value$1 === void 0) throw new Error(`${command$
|
|
8666
|
+
if (value$1 === void 0) throw new Error(`${command$68} needs ${param}.`);
|
|
8570
8667
|
return encodeURIComponent(value$1);
|
|
8571
8668
|
}), query);
|
|
8572
8669
|
if (ctx.dryRun) return renderValue(ctx, {
|
|
@@ -8642,6 +8739,7 @@ function coerce(raw, type) {
|
|
|
8642
8739
|
return text;
|
|
8643
8740
|
}
|
|
8644
8741
|
if (type === "null") return null;
|
|
8742
|
+
if (text === "null" && type.split("|").some((part) => part.trim() === "null")) return null;
|
|
8645
8743
|
return typeof raw === "number" && !/\b(number|integer)\b/.test(type) ? text : raw;
|
|
8646
8744
|
}
|
|
8647
8745
|
function withQuery(path, params) {
|
|
@@ -8677,7 +8775,7 @@ async function dispatch(ctx, owner, words, flags) {
|
|
|
8677
8775
|
const nested = rest[0] ? findNested(owner, rest[0]) : void 0;
|
|
8678
8776
|
if (nested) rest = rest.slice(1);
|
|
8679
8777
|
const resource = nested ?? owner;
|
|
8680
|
-
const command$
|
|
8778
|
+
const command$68 = nested ? `${owner.name} ${nested.name}` : owner.name;
|
|
8681
8779
|
if (rest[0] && /^(\d+|https?:\/\/.*)$/.test(rest[0]) && findOperation(resource, "get")) rest = ["get", ...rest];
|
|
8682
8780
|
const [opName, ...args] = rest;
|
|
8683
8781
|
if (!opName) {
|
|
@@ -8689,7 +8787,7 @@ async function dispatch(ctx, owner, words, flags) {
|
|
|
8689
8787
|
if (!op$1) {
|
|
8690
8788
|
const known = resource.operations.map((candidate) => candidate.name);
|
|
8691
8789
|
const nestedNames = nested ? [] : (owner.nested ?? []).map((candidate) => candidate.name);
|
|
8692
|
-
throw new UsageError(`${command$
|
|
8790
|
+
throw new UsageError(`${command$68} has no "${opName}". It takes: ${[...known, ...nestedNames].join(", ")}.\nRun superwall ${command$68} --help for what each does.`, command$68);
|
|
8693
8791
|
}
|
|
8694
8792
|
await runOperation(ctx, owner, resource, op$1, args, flags);
|
|
8695
8793
|
}
|
|
@@ -8807,8 +8905,6 @@ async function toolOf(owner, resource, op$1, flags) {
|
|
|
8807
8905
|
if (!required.includes(name)) required.push(name);
|
|
8808
8906
|
}
|
|
8809
8907
|
for (const name of op$1.mcpOmit ?? []) delete properties[name];
|
|
8810
|
-
const readOnly = op$1.method === "GET" || op$1.name === "list" || op$1.name === "get";
|
|
8811
|
-
const effect = op$1.destructive ? "destructive" : readOnly ? "read" : "write";
|
|
8812
8908
|
return {
|
|
8813
8909
|
words,
|
|
8814
8910
|
summary: op$1.summary,
|
|
@@ -8818,7 +8914,7 @@ async function toolOf(owner, resource, op$1, flags) {
|
|
|
8818
8914
|
properties,
|
|
8819
8915
|
required
|
|
8820
8916
|
},
|
|
8821
|
-
effect: op$1.mcp ?? effect
|
|
8917
|
+
effect: op$1.mcp ?? op$1.effect
|
|
8822
8918
|
};
|
|
8823
8919
|
}
|
|
8824
8920
|
async function listResourceTools(owner, flags) {
|
|
@@ -8884,8 +8980,58 @@ function defineResource(resource) {
|
|
|
8884
8980
|
}
|
|
8885
8981
|
|
|
8886
8982
|
//#endregion
|
|
8887
|
-
//#region src/commands/main/
|
|
8983
|
+
//#region src/commands/main/annotations.ts
|
|
8888
8984
|
const command$51 = defineResource({
|
|
8985
|
+
name: "annotations",
|
|
8986
|
+
summary: "Releases, campaigns and incidents marked on an app's charts",
|
|
8987
|
+
operations: [
|
|
8988
|
+
{
|
|
8989
|
+
name: "list",
|
|
8990
|
+
summary: "Annotations of an app",
|
|
8991
|
+
effect: "read",
|
|
8992
|
+
details: "With --from and --to, only those overlapping that window.",
|
|
8993
|
+
method: "GET",
|
|
8994
|
+
path: "/v2/applications/{application_id}/chart_annotations",
|
|
8995
|
+
list: true
|
|
8996
|
+
},
|
|
8997
|
+
{
|
|
8998
|
+
name: "get",
|
|
8999
|
+
summary: "One annotation",
|
|
9000
|
+
effect: "read",
|
|
9001
|
+
method: "GET",
|
|
9002
|
+
path: "/v2/applications/{application_id}/chart_annotations/{chart_annotation_id}"
|
|
9003
|
+
},
|
|
9004
|
+
{
|
|
9005
|
+
name: "create",
|
|
9006
|
+
summary: "Mark a moment or a span on every chart of an app",
|
|
9007
|
+
effect: "write",
|
|
9008
|
+
method: "POST",
|
|
9009
|
+
path: "/v2/applications/{application_id}/chart_annotations"
|
|
9010
|
+
},
|
|
9011
|
+
{
|
|
9012
|
+
name: "update",
|
|
9013
|
+
summary: "Change an annotation",
|
|
9014
|
+
effect: "destructive",
|
|
9015
|
+
details: "Overwrites only the fields supplied. --end-at null turns a span into a point; --description null removes the description.",
|
|
9016
|
+
method: "PATCH",
|
|
9017
|
+
path: "/v2/applications/{application_id}/chart_annotations/{chart_annotation_id}"
|
|
9018
|
+
},
|
|
9019
|
+
{
|
|
9020
|
+
name: "delete",
|
|
9021
|
+
summary: "Delete an annotation",
|
|
9022
|
+
effect: "destructive",
|
|
9023
|
+
details: "Removes it from every chart of the app. This can't be undone.",
|
|
9024
|
+
method: "DELETE",
|
|
9025
|
+
path: "/v2/applications/{application_id}/chart_annotations/{chart_annotation_id}",
|
|
9026
|
+
destructive: true
|
|
9027
|
+
}
|
|
9028
|
+
],
|
|
9029
|
+
examples: [["annotations list --app <app>", "Everything marked on an app's charts"], ["annotations create --app <app> --label \"v4.2.0 released\" --start-at 2026-10-28T14:00:00Z", "Mark today's release"]]
|
|
9030
|
+
});
|
|
9031
|
+
|
|
9032
|
+
//#endregion
|
|
9033
|
+
//#region src/commands/main/apps.ts
|
|
9034
|
+
const command$52 = defineResource({
|
|
8889
9035
|
name: "apps",
|
|
8890
9036
|
summary: "Every app you can open",
|
|
8891
9037
|
appArg: true,
|
|
@@ -8893,6 +9039,7 @@ const command$51 = defineResource({
|
|
|
8893
9039
|
{
|
|
8894
9040
|
name: "list",
|
|
8895
9041
|
summary: "Every app, by organization and project",
|
|
9042
|
+
effect: "read",
|
|
8896
9043
|
handler: "resource",
|
|
8897
9044
|
usage: "",
|
|
8898
9045
|
flags: [["--search <text>", "Only projects or apps whose id, name or bundle ID contains this"], ["--limit <n>", "At most this many projects"]]
|
|
@@ -8900,12 +9047,14 @@ const command$51 = defineResource({
|
|
|
8900
9047
|
{
|
|
8901
9048
|
name: "get",
|
|
8902
9049
|
summary: "Everything about one app: bundle ID, Apple team, keys, URLs",
|
|
9050
|
+
effect: "read",
|
|
8903
9051
|
handler: "apps.get",
|
|
8904
9052
|
usage: "<app>"
|
|
8905
9053
|
},
|
|
8906
9054
|
{
|
|
8907
9055
|
name: "create",
|
|
8908
9056
|
summary: "Add an app to a project",
|
|
9057
|
+
effect: "write",
|
|
8909
9058
|
handler: "resource",
|
|
8910
9059
|
usage: "--name <name> --platform <platform>",
|
|
8911
9060
|
flags: [
|
|
@@ -8918,6 +9067,7 @@ const command$51 = defineResource({
|
|
|
8918
9067
|
{
|
|
8919
9068
|
name: "update",
|
|
8920
9069
|
summary: "Change its bundle ID, Apple team ID, URL scheme, support URL, ...",
|
|
9070
|
+
effect: "destructive",
|
|
8921
9071
|
handler: "apps.update",
|
|
8922
9072
|
method: "PATCH",
|
|
8923
9073
|
path: "/v2/projects/{id}/applications/{application_id}/settings",
|
|
@@ -8935,11 +9085,14 @@ const command$51 = defineResource({
|
|
|
8935
9085
|
run in test mode under it, it says how many and asks.
|
|
8936
9086
|
--revenue-provider chooses which events the dashboard's revenue figures count. Events from
|
|
8937
9087
|
both sources keep arriving and being stored; it says what changes and asks first.
|
|
8938
|
-
Outside a terminal both need --yes
|
|
9088
|
+
Outside a terminal both need --yes.
|
|
9089
|
+
|
|
9090
|
+
Overwrites app settings, including routing, revenue provider and bundle ID. Changing the bundle ID can put deployed builds into test mode.`
|
|
8939
9091
|
},
|
|
8940
9092
|
{
|
|
8941
9093
|
name: "use",
|
|
8942
9094
|
summary: "Make it the app commands use when --app is left out",
|
|
9095
|
+
effect: "write",
|
|
8943
9096
|
handler: "resource",
|
|
8944
9097
|
usage: "<app>",
|
|
8945
9098
|
mcp: false
|
|
@@ -8947,6 +9100,7 @@ Outside a terminal both need --yes.`
|
|
|
8947
9100
|
{
|
|
8948
9101
|
name: "statistics",
|
|
8949
9102
|
summary: "Users, revenue and conversion, as the dashboard's overview shows them",
|
|
9103
|
+
effect: "read",
|
|
8950
9104
|
method: "GET",
|
|
8951
9105
|
path: "/v2/projects/{id}/applications/{application_id}/statistics",
|
|
8952
9106
|
details: `The overview figures, computed as the dashboard computes them. Pass --environment and
|
|
@@ -8960,6 +9114,7 @@ For anything the overview doesn't show, run SQL with \`superwall query\`.`,
|
|
|
8960
9114
|
{
|
|
8961
9115
|
name: "transactions",
|
|
8962
9116
|
summary: "Its most recent transactions, as the dashboard lists them",
|
|
9117
|
+
effect: "read",
|
|
8963
9118
|
method: "GET",
|
|
8964
9119
|
path: "/v2/projects/{id}/applications/{application_id}/recent-transactions",
|
|
8965
9120
|
details: `The dashboard's recent-transactions list. Pass --environment, --from and --to.
|
|
@@ -8973,6 +9128,7 @@ To count, group or filter transactions, run SQL with \`superwall query\`.`,
|
|
|
8973
9128
|
{
|
|
8974
9129
|
name: "notices",
|
|
8975
9130
|
summary: "What the dashboard warns about on its overview",
|
|
9131
|
+
effect: "read",
|
|
8976
9132
|
method: "GET",
|
|
8977
9133
|
path: "/v2/projects/{id}/applications/{application_id}/overview-notices",
|
|
8978
9134
|
bind: {
|
|
@@ -9128,7 +9284,7 @@ function renderAccountTree(tree) {
|
|
|
9128
9284
|
|
|
9129
9285
|
//#endregion
|
|
9130
9286
|
//#region src/commands/main/bootstrap.ts
|
|
9131
|
-
const command$
|
|
9287
|
+
const command$53 = defineCommand({
|
|
9132
9288
|
name: "bootstrap",
|
|
9133
9289
|
summary: "Everything at once: projects, apps, campaigns, products",
|
|
9134
9290
|
details: "The complete account tree: organizations, projects, apps, campaigns and their placements,\npaywalls, products and entitlements.",
|
|
@@ -9161,25 +9317,28 @@ const command$52 = defineCommand({
|
|
|
9161
9317
|
|
|
9162
9318
|
//#endregion
|
|
9163
9319
|
//#region src/commands/main/campaigns.ts
|
|
9164
|
-
const command$
|
|
9320
|
+
const command$54 = defineResource({
|
|
9165
9321
|
name: "campaigns",
|
|
9166
9322
|
summary: "Who sees which paywall, and when",
|
|
9167
9323
|
operations: [
|
|
9168
9324
|
{
|
|
9169
9325
|
name: "list",
|
|
9170
9326
|
summary: "Campaigns of an app",
|
|
9327
|
+
effect: "read",
|
|
9171
9328
|
handler: "resource",
|
|
9172
9329
|
flags: LIST_FLAGS
|
|
9173
9330
|
},
|
|
9174
9331
|
{
|
|
9175
9332
|
name: "get",
|
|
9176
9333
|
summary: "One campaign with its audiences and placements",
|
|
9334
|
+
effect: "read",
|
|
9177
9335
|
method: "GET",
|
|
9178
9336
|
path: "/v2/campaigns/{id}"
|
|
9179
9337
|
},
|
|
9180
9338
|
{
|
|
9181
9339
|
name: "create",
|
|
9182
9340
|
summary: "Create a campaign that a placement triggers",
|
|
9341
|
+
effect: "write",
|
|
9183
9342
|
handler: "resource",
|
|
9184
9343
|
usage: "--description <text> --placement <placement>",
|
|
9185
9344
|
flags: [["--description <text>", "What the campaign is for"], ["--placement <name>", "The event that triggers it"]]
|
|
@@ -9187,12 +9346,15 @@ const command$53 = defineResource({
|
|
|
9187
9346
|
{
|
|
9188
9347
|
name: "update",
|
|
9189
9348
|
summary: "Change a campaign",
|
|
9349
|
+
details: "Overwrites supplied campaign description and notes. To change delivery mode, use placement update tools.",
|
|
9350
|
+
effect: "destructive",
|
|
9190
9351
|
method: "PATCH",
|
|
9191
9352
|
path: "/v2/campaigns/{id}"
|
|
9192
9353
|
},
|
|
9193
9354
|
{
|
|
9194
9355
|
name: "archive",
|
|
9195
9356
|
summary: "Archive it",
|
|
9357
|
+
effect: "destructive",
|
|
9196
9358
|
method: "POST",
|
|
9197
9359
|
path: "/v2/campaigns/{id}/archive",
|
|
9198
9360
|
destructive: true
|
|
@@ -9200,18 +9362,22 @@ const command$53 = defineResource({
|
|
|
9200
9362
|
{
|
|
9201
9363
|
name: "unarchive",
|
|
9202
9364
|
summary: "Bring it back",
|
|
9365
|
+
effect: "write",
|
|
9203
9366
|
method: "POST",
|
|
9204
9367
|
path: "/v2/campaigns/{id}/unarchive"
|
|
9205
9368
|
},
|
|
9206
9369
|
{
|
|
9207
9370
|
name: "prioritize",
|
|
9208
9371
|
summary: "Put it first",
|
|
9372
|
+
details: "Enabling priority clears priority on other campaigns in the app before prioritizing this campaign.",
|
|
9373
|
+
effect: "destructive",
|
|
9209
9374
|
method: "POST",
|
|
9210
9375
|
path: "/v2/campaigns/{id}/prioritize"
|
|
9211
9376
|
},
|
|
9212
9377
|
{
|
|
9213
9378
|
name: "counts",
|
|
9214
9379
|
summary: "How many users each audience assigned",
|
|
9380
|
+
effect: "read",
|
|
9215
9381
|
method: "GET",
|
|
9216
9382
|
path: "/v2/campaigns/{id}/assignment-counts",
|
|
9217
9383
|
details: "Exactly what the dashboard shows. For anything else about revenue, users or events, run SQL with `query`."
|
|
@@ -9225,6 +9391,7 @@ const command$53 = defineResource({
|
|
|
9225
9391
|
{
|
|
9226
9392
|
name: "create",
|
|
9227
9393
|
summary: "Trigger it on an event",
|
|
9394
|
+
effect: "destructive",
|
|
9228
9395
|
method: "POST",
|
|
9229
9396
|
path: "/v2/campaigns/{id}/placements",
|
|
9230
9397
|
destructive: true
|
|
@@ -9232,12 +9399,15 @@ const command$53 = defineResource({
|
|
|
9232
9399
|
{
|
|
9233
9400
|
name: "update",
|
|
9234
9401
|
summary: "Change a placement",
|
|
9402
|
+
details: "Changes event name, enabled state or delivery mode and refreshes live configuration. Can stop or redirect an existing trigger.",
|
|
9403
|
+
effect: "destructive",
|
|
9235
9404
|
method: "PATCH",
|
|
9236
9405
|
path: "/v2/campaigns/{id}/placements/{placement_id}"
|
|
9237
9406
|
},
|
|
9238
9407
|
{
|
|
9239
9408
|
name: "delete",
|
|
9240
9409
|
summary: "Stop triggering it on an event",
|
|
9410
|
+
effect: "destructive",
|
|
9241
9411
|
method: "DELETE",
|
|
9242
9412
|
path: "/v2/campaigns/{id}/placements/{placement_id}",
|
|
9243
9413
|
destructive: true
|
|
@@ -9251,12 +9421,15 @@ const command$53 = defineResource({
|
|
|
9251
9421
|
{
|
|
9252
9422
|
name: "create",
|
|
9253
9423
|
summary: "Add an audience",
|
|
9424
|
+
details: "Appends an audience after existing audiences. It is enabled unless disabled explicitly; existing audience precedence is preserved.",
|
|
9425
|
+
effect: "write",
|
|
9254
9426
|
method: "POST",
|
|
9255
9427
|
path: "/v2/campaigns/{id}/audiences"
|
|
9256
9428
|
},
|
|
9257
9429
|
{
|
|
9258
9430
|
name: "update",
|
|
9259
9431
|
summary: "Change its rules or name",
|
|
9432
|
+
effect: "destructive",
|
|
9260
9433
|
method: "PATCH",
|
|
9261
9434
|
path: "/v2/campaigns/{id}/audiences/{audience_id}",
|
|
9262
9435
|
destructive: true
|
|
@@ -9264,6 +9437,7 @@ const command$53 = defineResource({
|
|
|
9264
9437
|
{
|
|
9265
9438
|
name: "delete",
|
|
9266
9439
|
summary: "Remove an audience",
|
|
9440
|
+
effect: "destructive",
|
|
9267
9441
|
method: "DELETE",
|
|
9268
9442
|
path: "/v2/campaigns/{id}/audiences/{audience_id}",
|
|
9269
9443
|
destructive: true
|
|
@@ -9271,18 +9445,23 @@ const command$53 = defineResource({
|
|
|
9271
9445
|
{
|
|
9272
9446
|
name: "duplicate",
|
|
9273
9447
|
summary: "Copy an audience",
|
|
9448
|
+
details: "Copies the audience and variants into a paused audience immediately after the source. Legacy or duplicate ranks can trigger a rewrite of existing audience ranks.",
|
|
9449
|
+
effect: "destructive",
|
|
9274
9450
|
method: "POST",
|
|
9275
9451
|
path: "/v2/campaigns/{id}/audiences/{audience_id}/duplicate"
|
|
9276
9452
|
},
|
|
9277
9453
|
{
|
|
9278
9454
|
name: "reorder",
|
|
9279
9455
|
summary: "Set the order audiences are matched in",
|
|
9456
|
+
details: "Replaces matching precedence for existing audiences; existing users may match a different audience.",
|
|
9457
|
+
effect: "destructive",
|
|
9280
9458
|
method: "PUT",
|
|
9281
9459
|
path: "/v2/campaigns/{id}/audiences/order"
|
|
9282
9460
|
},
|
|
9283
9461
|
{
|
|
9284
9462
|
name: "reset",
|
|
9285
9463
|
summary: "Forget who was assigned to it",
|
|
9464
|
+
effect: "destructive",
|
|
9286
9465
|
method: "POST",
|
|
9287
9466
|
path: "/v2/campaigns/{id}/audiences/{audience_id}/reset",
|
|
9288
9467
|
destructive: true
|
|
@@ -9290,6 +9469,7 @@ const command$53 = defineResource({
|
|
|
9290
9469
|
{
|
|
9291
9470
|
name: "readout",
|
|
9292
9471
|
summary: "How its variants are doing: conversion and revenue per variant",
|
|
9472
|
+
effect: "read",
|
|
9293
9473
|
method: "GET",
|
|
9294
9474
|
path: "/v2/campaigns/{id}/audiences/{audience_id}/readout",
|
|
9295
9475
|
details: "Exactly what the dashboard shows. For anything else about revenue, users or events, run SQL with `query`."
|
|
@@ -9297,6 +9477,7 @@ const command$53 = defineResource({
|
|
|
9297
9477
|
{
|
|
9298
9478
|
name: "users",
|
|
9299
9479
|
summary: "Users it matched",
|
|
9480
|
+
effect: "read",
|
|
9300
9481
|
method: "GET",
|
|
9301
9482
|
path: "/v2/campaigns/{id}/audiences/{audience_id}/users",
|
|
9302
9483
|
list: true
|
|
@@ -9304,6 +9485,7 @@ const command$53 = defineResource({
|
|
|
9304
9485
|
{
|
|
9305
9486
|
name: "purchasers",
|
|
9306
9487
|
summary: "Users who bought after seeing it",
|
|
9488
|
+
effect: "read",
|
|
9307
9489
|
method: "GET",
|
|
9308
9490
|
path: "/v2/campaigns/{id}/audiences/{audience_id}/purchasers",
|
|
9309
9491
|
details: "Exactly what the dashboard shows. For anything else about revenue, users or events, run SQL with `query`.",
|
|
@@ -9318,12 +9500,15 @@ const command$53 = defineResource({
|
|
|
9318
9500
|
{
|
|
9319
9501
|
name: "create",
|
|
9320
9502
|
summary: "Add a variant",
|
|
9503
|
+
details: "Adding the first treatment without a percentage gives it 100% and zeroes existing variant weights, including the holdout. This can change live traffic.",
|
|
9504
|
+
effect: "destructive",
|
|
9321
9505
|
method: "POST",
|
|
9322
9506
|
path: "/v2/campaigns/{id}/audiences/{audience_id}/variants"
|
|
9323
9507
|
},
|
|
9324
9508
|
{
|
|
9325
9509
|
name: "update",
|
|
9326
9510
|
summary: "Change its paywall",
|
|
9511
|
+
effect: "destructive",
|
|
9327
9512
|
method: "PATCH",
|
|
9328
9513
|
path: "/v2/campaigns/{id}/audiences/{audience_id}/variants/{variant_id}",
|
|
9329
9514
|
destructive: true
|
|
@@ -9331,6 +9516,7 @@ const command$53 = defineResource({
|
|
|
9331
9516
|
{
|
|
9332
9517
|
name: "delete",
|
|
9333
9518
|
summary: "Remove a variant",
|
|
9519
|
+
effect: "destructive",
|
|
9334
9520
|
method: "DELETE",
|
|
9335
9521
|
path: "/v2/campaigns/{id}/audiences/{audience_id}/variants/{variant_id}",
|
|
9336
9522
|
destructive: true
|
|
@@ -9338,6 +9524,8 @@ const command$53 = defineResource({
|
|
|
9338
9524
|
{
|
|
9339
9525
|
name: "weights",
|
|
9340
9526
|
summary: "Set each variant's share of traffic",
|
|
9527
|
+
details: "Overwrites allocation percentages for existing variants and changes live traffic distribution.",
|
|
9528
|
+
effect: "destructive",
|
|
9341
9529
|
method: "PUT",
|
|
9342
9530
|
path: "/v2/campaigns/{id}/audiences/{audience_id}/weights"
|
|
9343
9531
|
}
|
|
@@ -9354,25 +9542,28 @@ const command$53 = defineResource({
|
|
|
9354
9542
|
|
|
9355
9543
|
//#endregion
|
|
9356
9544
|
//#region src/commands/main/entitlements.ts
|
|
9357
|
-
const command$
|
|
9545
|
+
const command$55 = defineResource({
|
|
9358
9546
|
name: "entitlements",
|
|
9359
9547
|
summary: "What a purchase unlocks",
|
|
9360
9548
|
operations: [
|
|
9361
9549
|
{
|
|
9362
9550
|
name: "list",
|
|
9363
9551
|
summary: "Entitlements of a project",
|
|
9552
|
+
effect: "read",
|
|
9364
9553
|
handler: "resource",
|
|
9365
9554
|
flags: LIST_FLAGS
|
|
9366
9555
|
},
|
|
9367
9556
|
{
|
|
9368
9557
|
name: "get",
|
|
9369
9558
|
summary: "One entitlement",
|
|
9559
|
+
effect: "read",
|
|
9370
9560
|
method: "GET",
|
|
9371
9561
|
path: "/v2/entitlements/{id}"
|
|
9372
9562
|
},
|
|
9373
9563
|
{
|
|
9374
9564
|
name: "create",
|
|
9375
9565
|
summary: "Create an entitlement",
|
|
9566
|
+
effect: "write",
|
|
9376
9567
|
handler: "resource",
|
|
9377
9568
|
usage: "--identifier <identifier>",
|
|
9378
9569
|
flags: [["--identifier <id>", "What the SDK checks for, e.g. pro"]]
|
|
@@ -9380,12 +9571,15 @@ const command$54 = defineResource({
|
|
|
9380
9571
|
{
|
|
9381
9572
|
name: "update",
|
|
9382
9573
|
summary: "Change an entitlement",
|
|
9574
|
+
details: "Can rename the SDK entitlement identifier and replace its product associations, in addition to overwriting text and metadata.",
|
|
9575
|
+
effect: "destructive",
|
|
9383
9576
|
method: "PATCH",
|
|
9384
9577
|
path: "/v2/entitlements/{id}"
|
|
9385
9578
|
},
|
|
9386
9579
|
{
|
|
9387
9580
|
name: "delete",
|
|
9388
9581
|
summary: "Delete an entitlement",
|
|
9582
|
+
effect: "destructive",
|
|
9389
9583
|
method: "DELETE",
|
|
9390
9584
|
path: "/v2/entitlements/{id}",
|
|
9391
9585
|
destructive: true
|
|
@@ -9398,6 +9592,7 @@ const command$54 = defineResource({
|
|
|
9398
9592
|
{
|
|
9399
9593
|
name: "list",
|
|
9400
9594
|
summary: "Grants of an entitlement",
|
|
9595
|
+
effect: "read",
|
|
9401
9596
|
method: "GET",
|
|
9402
9597
|
path: "/v2/entitlements/{id}/grants",
|
|
9403
9598
|
list: true
|
|
@@ -9405,6 +9600,7 @@ const command$54 = defineResource({
|
|
|
9405
9600
|
{
|
|
9406
9601
|
name: "create",
|
|
9407
9602
|
summary: "Grant an existing entitlement manually to a device, optionally linked to an app user ID",
|
|
9603
|
+
effect: "write",
|
|
9408
9604
|
details: "Grants promotional access, optionally until an expiry time, without charging the user or creating a paid subscription. Returns an error when an active grant already exists.",
|
|
9409
9605
|
method: "POST",
|
|
9410
9606
|
path: "/v2/entitlements/{id}/grants"
|
|
@@ -9412,6 +9608,7 @@ const command$54 = defineResource({
|
|
|
9412
9608
|
{
|
|
9413
9609
|
name: "delete",
|
|
9414
9610
|
summary: "Take a grant back",
|
|
9611
|
+
effect: "destructive",
|
|
9415
9612
|
method: "DELETE",
|
|
9416
9613
|
path: "/v2/entitlements/{id}/grants/{grant_id}",
|
|
9417
9614
|
destructive: true
|
|
@@ -9423,13 +9620,14 @@ const command$54 = defineResource({
|
|
|
9423
9620
|
|
|
9424
9621
|
//#endregion
|
|
9425
9622
|
//#region src/commands/main/events.ts
|
|
9426
|
-
const command$
|
|
9623
|
+
const command$56 = defineResource({
|
|
9427
9624
|
name: "events",
|
|
9428
9625
|
summary: "Events sent to your webhooks",
|
|
9429
9626
|
operations: [
|
|
9430
9627
|
{
|
|
9431
9628
|
name: "list",
|
|
9432
9629
|
summary: "Recent events",
|
|
9630
|
+
effect: "read",
|
|
9433
9631
|
method: "GET",
|
|
9434
9632
|
path: "/v2/projects/{project_id}/events",
|
|
9435
9633
|
list: true
|
|
@@ -9437,12 +9635,14 @@ const command$55 = defineResource({
|
|
|
9437
9635
|
{
|
|
9438
9636
|
name: "get",
|
|
9439
9637
|
summary: "One event",
|
|
9638
|
+
effect: "read",
|
|
9440
9639
|
method: "GET",
|
|
9441
9640
|
path: "/v2/projects/{project_id}/events/{event_id}"
|
|
9442
9641
|
},
|
|
9443
9642
|
{
|
|
9444
9643
|
name: "attempts",
|
|
9445
9644
|
summary: "Its delivery attempts",
|
|
9645
|
+
effect: "read",
|
|
9446
9646
|
method: "GET",
|
|
9447
9647
|
path: "/v2/projects/{project_id}/events/{event_id}/attempts",
|
|
9448
9648
|
list: true
|
|
@@ -9450,6 +9650,8 @@ const command$55 = defineResource({
|
|
|
9450
9650
|
{
|
|
9451
9651
|
name: "retry",
|
|
9452
9652
|
summary: "Deliver it again",
|
|
9653
|
+
details: "Resends an event to its configured webhook destination. Delivery cannot be recalled and may duplicate downstream processing.",
|
|
9654
|
+
effect: "destructive",
|
|
9453
9655
|
method: "POST",
|
|
9454
9656
|
path: "/v2/projects/{project_id}/events/{event_id}/retry"
|
|
9455
9657
|
}
|
|
@@ -9459,37 +9661,42 @@ const command$55 = defineResource({
|
|
|
9459
9661
|
|
|
9460
9662
|
//#endregion
|
|
9461
9663
|
//#region src/commands/main/paywalls.ts
|
|
9462
|
-
const command$
|
|
9664
|
+
const command$57 = defineResource({
|
|
9463
9665
|
name: "paywalls",
|
|
9464
9666
|
summary: "Paywalls in the dashboard",
|
|
9465
9667
|
operations: [
|
|
9466
9668
|
{
|
|
9467
9669
|
name: "list",
|
|
9468
9670
|
summary: "Paywalls of an app",
|
|
9671
|
+
effect: "read",
|
|
9469
9672
|
handler: "resource",
|
|
9470
9673
|
flags: LIST_FLAGS
|
|
9471
9674
|
},
|
|
9472
9675
|
{
|
|
9473
9676
|
name: "get",
|
|
9474
9677
|
summary: "One paywall",
|
|
9678
|
+
effect: "read",
|
|
9475
9679
|
method: "GET",
|
|
9476
9680
|
path: "/v2/paywalls/{id}"
|
|
9477
9681
|
},
|
|
9478
9682
|
{
|
|
9479
9683
|
name: "create",
|
|
9480
9684
|
summary: "Create a paywall",
|
|
9685
|
+
effect: "write",
|
|
9481
9686
|
method: "POST",
|
|
9482
9687
|
path: "/v2/paywalls"
|
|
9483
9688
|
},
|
|
9484
9689
|
{
|
|
9485
9690
|
name: "duplicate",
|
|
9486
9691
|
summary: "Copy a paywall",
|
|
9692
|
+
effect: "write",
|
|
9487
9693
|
method: "POST",
|
|
9488
9694
|
path: "/v2/paywalls/{id}/duplicate"
|
|
9489
9695
|
},
|
|
9490
9696
|
{
|
|
9491
9697
|
name: "publish",
|
|
9492
9698
|
summary: "Publish the latest saved draft of a paywall",
|
|
9699
|
+
effect: "destructive",
|
|
9493
9700
|
details: "Replaces its currently deployed version and refreshes app configuration. This can change the paywall shown to users by campaigns that use it.",
|
|
9494
9701
|
method: "POST",
|
|
9495
9702
|
path: "/v2/paywalls/{id}/publish",
|
|
@@ -9498,6 +9705,7 @@ const command$56 = defineResource({
|
|
|
9498
9705
|
{
|
|
9499
9706
|
name: "archive",
|
|
9500
9707
|
summary: "Archive it",
|
|
9708
|
+
effect: "destructive",
|
|
9501
9709
|
method: "POST",
|
|
9502
9710
|
path: "/v2/paywalls/{id}/archive",
|
|
9503
9711
|
destructive: true
|
|
@@ -9505,12 +9713,14 @@ const command$56 = defineResource({
|
|
|
9505
9713
|
{
|
|
9506
9714
|
name: "unarchive",
|
|
9507
9715
|
summary: "Bring it back",
|
|
9716
|
+
effect: "write",
|
|
9508
9717
|
method: "POST",
|
|
9509
9718
|
path: "/v2/paywalls/{id}/unarchive"
|
|
9510
9719
|
},
|
|
9511
9720
|
{
|
|
9512
9721
|
name: "versions",
|
|
9513
9722
|
summary: "Versions pushed from code",
|
|
9723
|
+
effect: "read",
|
|
9514
9724
|
method: "GET",
|
|
9515
9725
|
path: "/v2/paywalls/{id}/versions",
|
|
9516
9726
|
list: true
|
|
@@ -9521,25 +9731,28 @@ const command$56 = defineResource({
|
|
|
9521
9731
|
|
|
9522
9732
|
//#endregion
|
|
9523
9733
|
//#region src/commands/main/products.ts
|
|
9524
|
-
const command$
|
|
9734
|
+
const command$58 = defineResource({
|
|
9525
9735
|
name: "products",
|
|
9526
9736
|
summary: "Products and their store prices",
|
|
9527
9737
|
operations: [
|
|
9528
9738
|
{
|
|
9529
9739
|
name: "list",
|
|
9530
9740
|
summary: "Products of a project",
|
|
9741
|
+
effect: "read",
|
|
9531
9742
|
handler: "resource",
|
|
9532
9743
|
flags: LIST_FLAGS
|
|
9533
9744
|
},
|
|
9534
9745
|
{
|
|
9535
9746
|
name: "get",
|
|
9536
9747
|
summary: "One product",
|
|
9748
|
+
effect: "read",
|
|
9537
9749
|
method: "GET",
|
|
9538
9750
|
path: "/v2/products/{id}"
|
|
9539
9751
|
},
|
|
9540
9752
|
{
|
|
9541
9753
|
name: "create",
|
|
9542
9754
|
summary: "Create a product",
|
|
9755
|
+
effect: "write",
|
|
9543
9756
|
handler: "resource",
|
|
9544
9757
|
usage: "--identifier <identifier>",
|
|
9545
9758
|
flags: [
|
|
@@ -9556,6 +9769,7 @@ const command$57 = defineResource({
|
|
|
9556
9769
|
{
|
|
9557
9770
|
name: "update",
|
|
9558
9771
|
summary: "Change a product",
|
|
9772
|
+
effect: "destructive",
|
|
9559
9773
|
method: "PATCH",
|
|
9560
9774
|
path: "/v2/products/{id}",
|
|
9561
9775
|
destructive: true
|
|
@@ -9563,6 +9777,7 @@ const command$57 = defineResource({
|
|
|
9563
9777
|
{
|
|
9564
9778
|
name: "delete",
|
|
9565
9779
|
summary: "Delete a product",
|
|
9780
|
+
effect: "destructive",
|
|
9566
9781
|
method: "DELETE",
|
|
9567
9782
|
path: "/v2/products/{id}",
|
|
9568
9783
|
destructive: true
|
|
@@ -9570,12 +9785,14 @@ const command$57 = defineResource({
|
|
|
9570
9785
|
{
|
|
9571
9786
|
name: "impact",
|
|
9572
9787
|
summary: "What deleting it would break",
|
|
9788
|
+
effect: "read",
|
|
9573
9789
|
method: "GET",
|
|
9574
9790
|
path: "/v2/products/{id}/delete-impact"
|
|
9575
9791
|
},
|
|
9576
9792
|
{
|
|
9577
9793
|
name: "storekit",
|
|
9578
9794
|
summary: "Write a StoreKit configuration file for Xcode",
|
|
9795
|
+
effect: "write",
|
|
9579
9796
|
handler: "resource",
|
|
9580
9797
|
flags: [["--out <file>", "Where to write it"]],
|
|
9581
9798
|
mcp: false
|
|
@@ -9586,13 +9803,14 @@ const command$57 = defineResource({
|
|
|
9586
9803
|
|
|
9587
9804
|
//#endregion
|
|
9588
9805
|
//#region src/commands/main/users.ts
|
|
9589
|
-
const command$
|
|
9806
|
+
const command$59 = defineResource({
|
|
9590
9807
|
name: "users",
|
|
9591
9808
|
summary: "Your app's users: subscriptions, entitlements, attributes",
|
|
9592
9809
|
operations: [
|
|
9593
9810
|
{
|
|
9594
9811
|
name: "get",
|
|
9595
9812
|
summary: "Find a user by app user ID",
|
|
9813
|
+
effect: "read",
|
|
9596
9814
|
method: "GET",
|
|
9597
9815
|
path: "/v2/users/resolve",
|
|
9598
9816
|
args: ["app_user_id"]
|
|
@@ -9600,6 +9818,7 @@ const command$58 = defineResource({
|
|
|
9600
9818
|
{
|
|
9601
9819
|
name: "subscriptions",
|
|
9602
9820
|
summary: "Every subscription they have had, one row each",
|
|
9821
|
+
effect: "read",
|
|
9603
9822
|
method: "GET",
|
|
9604
9823
|
path: "/v3/users/{app_user_id}/subscriptions",
|
|
9605
9824
|
details: "The full history. For a one-glance answer (are they paying, status, lifetime value), use summary."
|
|
@@ -9607,6 +9826,7 @@ const command$58 = defineResource({
|
|
|
9607
9826
|
{
|
|
9608
9827
|
name: "summary",
|
|
9609
9828
|
summary: "One answer: are they paying, their status, spend, MRR and lifetime value",
|
|
9829
|
+
effect: "read",
|
|
9610
9830
|
method: "GET",
|
|
9611
9831
|
path: "/v2/users/{app_user_id}/subscription-summary",
|
|
9612
9832
|
details: "For every subscription they have had, use subscriptions."
|
|
@@ -9614,30 +9834,36 @@ const command$58 = defineResource({
|
|
|
9614
9834
|
{
|
|
9615
9835
|
name: "entitlements",
|
|
9616
9836
|
summary: "What they have access to now",
|
|
9837
|
+
effect: "read",
|
|
9617
9838
|
method: "GET",
|
|
9618
9839
|
path: "/v2/users/{app_user_id}/active-entitlements"
|
|
9619
9840
|
},
|
|
9620
9841
|
{
|
|
9621
9842
|
name: "attributes",
|
|
9622
9843
|
summary: "Attributes the SDK set on them",
|
|
9844
|
+
effect: "read",
|
|
9623
9845
|
method: "GET",
|
|
9624
9846
|
path: "/v3/users/{app_user_id}/attributes"
|
|
9625
9847
|
},
|
|
9626
9848
|
{
|
|
9627
9849
|
name: "update",
|
|
9628
9850
|
summary: "Set attributes on them",
|
|
9851
|
+
details: "Queues attribute updates that replace stored user attribute values and can change audience matching.",
|
|
9852
|
+
effect: "destructive",
|
|
9629
9853
|
method: "POST",
|
|
9630
9854
|
path: "/v3/users/{app_user_id}/attributes"
|
|
9631
9855
|
},
|
|
9632
9856
|
{
|
|
9633
9857
|
name: "aliases",
|
|
9634
9858
|
summary: "Their other IDs",
|
|
9859
|
+
effect: "read",
|
|
9635
9860
|
method: "GET",
|
|
9636
9861
|
path: "/v3/users/{app_user_id}/aliases"
|
|
9637
9862
|
},
|
|
9638
9863
|
{
|
|
9639
9864
|
name: "events",
|
|
9640
9865
|
summary: "What they did, newest first",
|
|
9866
|
+
effect: "read",
|
|
9641
9867
|
method: "GET",
|
|
9642
9868
|
path: "/v2/users/{app_user_id}/events",
|
|
9643
9869
|
list: true
|
|
@@ -9648,13 +9874,14 @@ const command$58 = defineResource({
|
|
|
9648
9874
|
|
|
9649
9875
|
//#endregion
|
|
9650
9876
|
//#region src/commands/main/webhooks.ts
|
|
9651
|
-
const command$
|
|
9877
|
+
const command$60 = defineResource({
|
|
9652
9878
|
name: "webhooks",
|
|
9653
9879
|
summary: "Endpoints that receive your events",
|
|
9654
9880
|
operations: [
|
|
9655
9881
|
{
|
|
9656
9882
|
name: "list",
|
|
9657
9883
|
summary: "Webhook endpoints of a project",
|
|
9884
|
+
effect: "read",
|
|
9658
9885
|
method: "GET",
|
|
9659
9886
|
path: "/v2/projects/{project_id}/webhook_endpoints",
|
|
9660
9887
|
list: true
|
|
@@ -9662,12 +9889,14 @@ const command$59 = defineResource({
|
|
|
9662
9889
|
{
|
|
9663
9890
|
name: "get",
|
|
9664
9891
|
summary: "One endpoint",
|
|
9892
|
+
effect: "read",
|
|
9665
9893
|
method: "GET",
|
|
9666
9894
|
path: "/v2/projects/{project_id}/webhook_endpoints/{endpoint_id}"
|
|
9667
9895
|
},
|
|
9668
9896
|
{
|
|
9669
9897
|
name: "create",
|
|
9670
9898
|
summary: "Add an endpoint",
|
|
9899
|
+
effect: "write",
|
|
9671
9900
|
details: "Delivers subscribed events to the HTTPS URL you specify.",
|
|
9672
9901
|
method: "POST",
|
|
9673
9902
|
path: "/v2/projects/{project_id}/webhook_endpoints"
|
|
@@ -9675,13 +9904,17 @@ const command$59 = defineResource({
|
|
|
9675
9904
|
{
|
|
9676
9905
|
name: "update",
|
|
9677
9906
|
summary: "Change an endpoint",
|
|
9678
|
-
|
|
9907
|
+
effect: "destructive",
|
|
9908
|
+
details: `Changes where or which subscribed events are delivered; the destination can be any HTTPS URL you specify.
|
|
9909
|
+
|
|
9910
|
+
Overwrites destination, filters, headers and disabled state; can stop or redirect existing event delivery.`,
|
|
9679
9911
|
method: "PATCH",
|
|
9680
9912
|
path: "/v2/projects/{project_id}/webhook_endpoints/{endpoint_id}"
|
|
9681
9913
|
},
|
|
9682
9914
|
{
|
|
9683
9915
|
name: "delete",
|
|
9684
9916
|
summary: "Remove an endpoint",
|
|
9917
|
+
effect: "destructive",
|
|
9685
9918
|
method: "DELETE",
|
|
9686
9919
|
path: "/v2/projects/{project_id}/webhook_endpoints/{endpoint_id}",
|
|
9687
9920
|
destructive: true
|
|
@@ -9689,6 +9922,7 @@ const command$59 = defineResource({
|
|
|
9689
9922
|
{
|
|
9690
9923
|
name: "rotate-secret",
|
|
9691
9924
|
summary: "Issue a new signing secret",
|
|
9925
|
+
effect: "destructive",
|
|
9692
9926
|
method: "POST",
|
|
9693
9927
|
path: "/v2/projects/{project_id}/webhook_endpoints/{endpoint_id}/rotate_secret",
|
|
9694
9928
|
destructive: true
|
|
@@ -9696,6 +9930,7 @@ const command$59 = defineResource({
|
|
|
9696
9930
|
{
|
|
9697
9931
|
name: "attempts",
|
|
9698
9932
|
summary: "Its delivery attempts",
|
|
9933
|
+
effect: "read",
|
|
9699
9934
|
method: "GET",
|
|
9700
9935
|
path: "/v2/projects/{project_id}/webhook_endpoints/{endpoint_id}/attempts",
|
|
9701
9936
|
list: true
|
|
@@ -9703,6 +9938,7 @@ const command$59 = defineResource({
|
|
|
9703
9938
|
{
|
|
9704
9939
|
name: "stats",
|
|
9705
9940
|
summary: "Its delivery statistics",
|
|
9941
|
+
effect: "read",
|
|
9706
9942
|
method: "GET",
|
|
9707
9943
|
path: "/v2/projects/{project_id}/webhook_endpoints/{endpoint_id}/stats"
|
|
9708
9944
|
}
|
|
@@ -9712,7 +9948,7 @@ const command$59 = defineResource({
|
|
|
9712
9948
|
|
|
9713
9949
|
//#endregion
|
|
9714
9950
|
//#region src/commands/support/doctor.ts
|
|
9715
|
-
const command$
|
|
9951
|
+
const command$61 = defineCommand({
|
|
9716
9952
|
name: "doctor",
|
|
9717
9953
|
summary: "Check the health of your Superwall integration",
|
|
9718
9954
|
flags: { installDir },
|
|
@@ -9722,7 +9958,7 @@ const command$60 = defineCommand({
|
|
|
9722
9958
|
prompts: true,
|
|
9723
9959
|
mcp: false,
|
|
9724
9960
|
async run(ctx) {
|
|
9725
|
-
const { runDoctor } = await import("./doctor-
|
|
9961
|
+
const { runDoctor } = await import("./doctor-BkygMUe2.js");
|
|
9726
9962
|
return runDoctor(ctx);
|
|
9727
9963
|
}
|
|
9728
9964
|
});
|
|
@@ -9758,15 +9994,6 @@ function linkedApp(cwd = proc?.cwd() ?? "") {
|
|
|
9758
9994
|
applicationId: app$1?.applicationId
|
|
9759
9995
|
};
|
|
9760
9996
|
}
|
|
9761
|
-
const AGENT_ENV = [
|
|
9762
|
-
["CLAUDECODE", "claude-code"],
|
|
9763
|
-
["CODEX_SANDBOX", "codex"],
|
|
9764
|
-
["CURSOR_AGENT", "cursor"],
|
|
9765
|
-
["GEMINI_CLI", "gemini-cli"]
|
|
9766
|
-
];
|
|
9767
|
-
function detectAgent(env = proc?.env ?? {}) {
|
|
9768
|
-
return AGENT_ENV.find(([key]) => env[key])?.[1];
|
|
9769
|
-
}
|
|
9770
9997
|
function readAttachments(paths) {
|
|
9771
9998
|
if (paths.length > MAX_FILES) throw new Error(`Attach at most ${MAX_FILES} files.`);
|
|
9772
9999
|
return paths.map((path) => {
|
|
@@ -9877,10 +10104,12 @@ async function runFeedback(ctx, { args, flags }) {
|
|
|
9877
10104
|
|
|
9878
10105
|
//#endregion
|
|
9879
10106
|
//#region src/commands/support/feedback.ts
|
|
9880
|
-
const command$
|
|
10107
|
+
const command$62 = defineCommand({
|
|
9881
10108
|
name: "feedback",
|
|
9882
10109
|
summary: "Report a bug or send feedback to the Superwall team",
|
|
9883
|
-
details:
|
|
10110
|
+
details: `Goes straight to the Superwall team. Pass the app it happened in so the team can find the account. Report anything you confirm doesn't work, as a reproducible report with every ID and version in context. Without a shell, paste the relevant part of a log into the message: a tool cannot attach files.
|
|
10111
|
+
|
|
10112
|
+
Sends the supplied message and context to the Superwall team as a persisted event. Sending cannot be undone; repeating the call can send duplicate feedback.`,
|
|
9884
10113
|
args: { message: { describe: "What happened: what you ran, what you expected, what you got (asked when left out)" } },
|
|
9885
10114
|
flags: {
|
|
9886
10115
|
title: {
|
|
@@ -9930,13 +10159,13 @@ const command$61 = defineCommand({
|
|
|
9930
10159
|
auth: "optional",
|
|
9931
10160
|
json: true,
|
|
9932
10161
|
prompts: true,
|
|
9933
|
-
mcp: "
|
|
10162
|
+
mcp: "destructive",
|
|
9934
10163
|
run: (ctx, input) => runFeedback(ctx, input)
|
|
9935
10164
|
});
|
|
9936
10165
|
|
|
9937
10166
|
//#endregion
|
|
9938
10167
|
//#region src/commands/support/skills.ts
|
|
9939
|
-
const command$
|
|
10168
|
+
const command$63 = defineCommand({
|
|
9940
10169
|
name: "skills",
|
|
9941
10170
|
summary: "Install or update the Superwall agent skills for your coding agents",
|
|
9942
10171
|
flags: {
|
|
@@ -9965,14 +10194,14 @@ const command$62 = defineCommand({
|
|
|
9965
10194
|
prompts: true,
|
|
9966
10195
|
mcp: false,
|
|
9967
10196
|
async run(ctx, input) {
|
|
9968
|
-
const { runSkills } = await import("./skills-
|
|
10197
|
+
const { runSkills } = await import("./skills-B8uSuanf.js");
|
|
9969
10198
|
return runSkills(ctx, input);
|
|
9970
10199
|
}
|
|
9971
10200
|
});
|
|
9972
10201
|
|
|
9973
10202
|
//#endregion
|
|
9974
10203
|
//#region src/commands/support/upgrade.ts
|
|
9975
|
-
const command$
|
|
10204
|
+
const command$64 = defineCommand({
|
|
9976
10205
|
name: "upgrade",
|
|
9977
10206
|
summary: "Update the CLI to the latest version",
|
|
9978
10207
|
examples: [["upgrade", "Install the latest version globally with npm"]],
|
|
@@ -9981,14 +10210,14 @@ const command$63 = defineCommand({
|
|
|
9981
10210
|
prompts: true,
|
|
9982
10211
|
mcp: false,
|
|
9983
10212
|
async run(ctx) {
|
|
9984
|
-
const { runUpgrade } = await import("./upgrade-
|
|
10213
|
+
const { runUpgrade } = await import("./upgrade-DV_rmhyV.js");
|
|
9985
10214
|
return runUpgrade(ctx);
|
|
9986
10215
|
}
|
|
9987
10216
|
});
|
|
9988
10217
|
|
|
9989
10218
|
//#endregion
|
|
9990
10219
|
//#region src/commands/workflows/integrate.ts
|
|
9991
|
-
const command$
|
|
10220
|
+
const command$65 = defineCommand({
|
|
9992
10221
|
name: "integrate",
|
|
9993
10222
|
summary: "Set up the SDK, placements, and dashboard in your app",
|
|
9994
10223
|
flags: {
|
|
@@ -10020,8 +10249,8 @@ const command$64 = defineCommand({
|
|
|
10020
10249
|
prompts: true,
|
|
10021
10250
|
mcp: false,
|
|
10022
10251
|
async run(ctx, { flags }) {
|
|
10023
|
-
const { runIntegrate } = await import("./integrate-
|
|
10024
|
-
const { printPlaybook } = await import("./playbook-
|
|
10252
|
+
const { runIntegrate } = await import("./integrate-Ci_MLkQG.js");
|
|
10253
|
+
const { printPlaybook } = await import("./playbook-CtTj1HBK.js");
|
|
10025
10254
|
if (flags.skill) return printPlaybook(ctx.installDir, "integrate");
|
|
10026
10255
|
await runIntegrate({
|
|
10027
10256
|
...ctx,
|
|
@@ -10033,7 +10262,7 @@ const command$64 = defineCommand({
|
|
|
10033
10262
|
|
|
10034
10263
|
//#endregion
|
|
10035
10264
|
//#region src/commands/workflows/migrate.ts
|
|
10036
|
-
const command$
|
|
10265
|
+
const command$66 = defineCommand({
|
|
10037
10266
|
name: "migrate",
|
|
10038
10267
|
summary: "Migrate from RevenueCat / Adapty / Qonversion",
|
|
10039
10268
|
summaryOn: { next: "Migrate from RevenueCat / Adapty / Qonversion, or rebuild a dashboard paywall or a native screen as code" },
|
|
@@ -10081,8 +10310,8 @@ const command$65 = defineCommand({
|
|
|
10081
10310
|
prompts: true,
|
|
10082
10311
|
mcp: false,
|
|
10083
10312
|
async run(ctx, { args, flags }) {
|
|
10084
|
-
const { runPaywallMigration, runProviderMigration, runScreenMigration } = await import("./migrate-
|
|
10085
|
-
const { printPlaybook } = await import("./playbook-
|
|
10313
|
+
const { runPaywallMigration, runProviderMigration, runScreenMigration } = await import("./migrate-BKF1WckS.js");
|
|
10314
|
+
const { printPlaybook } = await import("./playbook-CtTj1HBK.js");
|
|
10086
10315
|
if (flags.screen !== void 0) return runScreenMigration(ctx, {
|
|
10087
10316
|
path: flags.screen,
|
|
10088
10317
|
screenshot: flags.screenshot
|
|
@@ -10095,7 +10324,7 @@ const command$65 = defineCommand({
|
|
|
10095
10324
|
|
|
10096
10325
|
//#endregion
|
|
10097
10326
|
//#region src/commands/workflows/review.ts
|
|
10098
|
-
const command$
|
|
10327
|
+
const command$67 = defineCommand({
|
|
10099
10328
|
name: "review",
|
|
10100
10329
|
summary: "Review an existing Superwall setup end to end",
|
|
10101
10330
|
flags: {
|
|
@@ -10116,8 +10345,8 @@ const command$66 = defineCommand({
|
|
|
10116
10345
|
prompts: true,
|
|
10117
10346
|
mcp: false,
|
|
10118
10347
|
async run(ctx, { flags }) {
|
|
10119
|
-
const { runReview } = await import("./integrate-
|
|
10120
|
-
const { printPlaybook } = await import("./playbook-
|
|
10348
|
+
const { runReview } = await import("./integrate-Ci_MLkQG.js");
|
|
10349
|
+
const { printPlaybook } = await import("./playbook-CtTj1HBK.js");
|
|
10121
10350
|
if (flags.skill) return printPlaybook(ctx.installDir, flags.fix ? "review-fix" : "review");
|
|
10122
10351
|
await runReview(ctx, flags.fix);
|
|
10123
10352
|
}
|
|
@@ -10131,9 +10360,9 @@ const GROUPS = [
|
|
|
10131
10360
|
title: "Workflows",
|
|
10132
10361
|
notes: ["Each takes --skill to print the playbook instead of running."],
|
|
10133
10362
|
commands: [
|
|
10134
|
-
command$
|
|
10135
|
-
command$
|
|
10136
|
-
command$
|
|
10363
|
+
command$65,
|
|
10364
|
+
command$67,
|
|
10365
|
+
command$66
|
|
10137
10366
|
]
|
|
10138
10367
|
},
|
|
10139
10368
|
{
|
|
@@ -10155,15 +10384,16 @@ const GROUPS = [
|
|
|
10155
10384
|
title: "Commands",
|
|
10156
10385
|
notes: ["superwall <command> --help lists its operations; <operation> --help, its flags."],
|
|
10157
10386
|
commands: [
|
|
10158
|
-
command$52,
|
|
10159
|
-
command$51,
|
|
10160
|
-
command$57,
|
|
10161
|
-
command$54,
|
|
10162
10387
|
command$53,
|
|
10163
|
-
command$
|
|
10388
|
+
command$52,
|
|
10164
10389
|
command$58,
|
|
10390
|
+
command$55,
|
|
10391
|
+
command$54,
|
|
10392
|
+
command$57,
|
|
10165
10393
|
command$59,
|
|
10166
|
-
command$
|
|
10394
|
+
command$60,
|
|
10395
|
+
command$56,
|
|
10396
|
+
command$51
|
|
10167
10397
|
]
|
|
10168
10398
|
},
|
|
10169
10399
|
{
|
|
@@ -10364,10 +10594,10 @@ proxy uses. No command prints a private key, and none revokes a key at Apple.`
|
|
|
10364
10594
|
id: "support",
|
|
10365
10595
|
title: "Support & updates",
|
|
10366
10596
|
commands: [
|
|
10367
|
-
command$
|
|
10368
|
-
command$62,
|
|
10597
|
+
command$61,
|
|
10369
10598
|
command$63,
|
|
10370
|
-
command$
|
|
10599
|
+
command$64,
|
|
10600
|
+
command$62
|
|
10371
10601
|
]
|
|
10372
10602
|
}
|
|
10373
10603
|
];
|
|
@@ -10377,7 +10607,7 @@ function visible(channel) {
|
|
|
10377
10607
|
function listGroups() {
|
|
10378
10608
|
return GROUPS.filter((group$1) => visible(group$1.channel)).map((group$1) => ({
|
|
10379
10609
|
...group$1,
|
|
10380
|
-
commands: group$1.commands.filter((command$
|
|
10610
|
+
commands: group$1.commands.filter((command$68) => visible(command$68.channel))
|
|
10381
10611
|
}));
|
|
10382
10612
|
}
|
|
10383
10613
|
|