@spec0/sdk-public-platform 1.17.3 → 1.19.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/dist/generated/index.d.ts +5 -0
- package/dist/generated/index.d.ts.map +1 -1
- package/dist/generated/index.js.map +1 -1
- package/dist/generated/models/EntitlementV1.d.ts +22 -0
- package/dist/generated/models/EntitlementV1.d.ts.map +1 -0
- package/dist/generated/models/EntitlementV1.js +3 -0
- package/dist/generated/models/EntitlementV1.js.map +1 -0
- package/dist/generated/models/MockApiKeyV1.d.ts +15 -0
- package/dist/generated/models/MockApiKeyV1.d.ts.map +1 -0
- package/dist/generated/models/MockApiKeyV1.js +3 -0
- package/dist/generated/models/MockApiKeyV1.js.map +1 -0
- package/dist/generated/models/MockServerIdPath.d.ts +2 -0
- package/dist/generated/models/MockServerIdPath.d.ts.map +1 -0
- package/dist/generated/models/MockServerIdPath.js +3 -0
- package/dist/generated/models/MockServerIdPath.js.map +1 -0
- package/dist/generated/models/OrgEntitlementsResponseV1.d.ts +9 -0
- package/dist/generated/models/OrgEntitlementsResponseV1.d.ts.map +1 -0
- package/dist/generated/models/OrgEntitlementsResponseV1.js +3 -0
- package/dist/generated/models/OrgEntitlementsResponseV1.js.map +1 -0
- package/dist/generated/models/OrgSummaryResponseV1.d.ts +3 -1
- package/dist/generated/models/OrgSummaryResponseV1.d.ts.map +1 -1
- package/dist/generated/models/PlanLimitExceededProblem.d.ts +34 -0
- package/dist/generated/models/PlanLimitExceededProblem.d.ts.map +1 -0
- package/dist/generated/models/PlanLimitExceededProblem.js +3 -0
- package/dist/generated/models/PlanLimitExceededProblem.js.map +1 -0
- package/dist/generated/services/PublicApisService.d.ts +8 -0
- package/dist/generated/services/PublicApisService.d.ts.map +1 -1
- package/dist/generated/services/PublicApisService.js +16 -1
- package/dist/generated/services/PublicApisService.js.map +1 -1
- package/dist/generated/services/PublicMocksService.d.ts +38 -0
- package/dist/generated/services/PublicMocksService.d.ts.map +1 -1
- package/dist/generated/services/PublicMocksService.js +66 -0
- package/dist/generated/services/PublicMocksService.js.map +1 -1
- package/dist/generated/services/PublicOrgsService.d.ts +16 -0
- package/dist/generated/services/PublicOrgsService.d.ts.map +1 -1
- package/dist/generated/services/PublicOrgsService.js +24 -0
- package/dist/generated/services/PublicOrgsService.js.map +1 -1
- package/package.json +1 -1
- package/src/generated/index.ts +5 -0
- package/src/generated/models/EntitlementV1.ts +26 -0
- package/src/generated/models/MockApiKeyV1.ts +19 -0
- package/src/generated/models/MockServerIdPath.ts +5 -0
- package/src/generated/models/OrgEntitlementsResponseV1.ts +13 -0
- package/src/generated/models/OrgSummaryResponseV1.ts +3 -1
- package/src/generated/models/PlanLimitExceededProblem.ts +38 -0
- package/src/generated/services/PublicApisService.ts +16 -1
- package/src/generated/services/PublicMocksService.ts +75 -0
- package/src/generated/services/PublicOrgsService.ts +25 -0
|
@@ -11,11 +11,16 @@ export type { AuthError } from './models/AuthError.js';
|
|
|
11
11
|
export type { CiConfigResponseV1 } from './models/CiConfigResponseV1.js';
|
|
12
12
|
export type { CreateMockRequestV1 } from './models/CreateMockRequestV1.js';
|
|
13
13
|
export type { CreateMockResponseV1 } from './models/CreateMockResponseV1.js';
|
|
14
|
+
export type { EntitlementV1 } from './models/EntitlementV1.js';
|
|
14
15
|
export type { EnvTargetV1 } from './models/EnvTargetV1.js';
|
|
15
16
|
export type { GovernanceWarningV1 } from './models/GovernanceWarningV1.js';
|
|
17
|
+
export type { MockApiKeyV1 } from './models/MockApiKeyV1.js';
|
|
16
18
|
export type { MockItemV1 } from './models/MockItemV1.js';
|
|
19
|
+
export type { MockServerIdPath } from './models/MockServerIdPath.js';
|
|
20
|
+
export type { OrgEntitlementsResponseV1 } from './models/OrgEntitlementsResponseV1.js';
|
|
17
21
|
export type { OrgSlugPath } from './models/OrgSlugPath.js';
|
|
18
22
|
export type { OrgSummaryResponseV1 } from './models/OrgSummaryResponseV1.js';
|
|
23
|
+
export type { PlanLimitExceededProblem } from './models/PlanLimitExceededProblem.js';
|
|
19
24
|
export type { Problem } from './models/Problem.js';
|
|
20
25
|
export type { PublicApiIdPath } from './models/PublicApiIdPath.js';
|
|
21
26
|
export type { PublicApiListItem } from './models/PublicApiListItem.js';
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/generated/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC7E,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,YAAY,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAEvD,YAAY,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AACvE,YAAY,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACzE,YAAY,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACzE,YAAY,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,YAAY,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AACvE,YAAY,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AACvD,YAAY,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACzE,YAAY,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAC3E,YAAY,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAC7E,YAAY,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,YAAY,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAC3E,YAAY,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,YAAY,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,YAAY,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAC7E,YAAY,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AACnD,YAAY,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AACnE,YAAY,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AACvE,YAAY,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AACnE,YAAY,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AACjF,YAAY,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AACnF,YAAY,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AAC3F,YAAY,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC/E,YAAY,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACzE,YAAY,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AACvF,YAAY,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC/E,YAAY,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AACrE,YAAY,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAC7E,YAAY,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAC3E,YAAY,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAC7E,YAAY,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC/E,YAAY,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AACjD,YAAY,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC/E,YAAY,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,YAAY,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAEvF,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/generated/index.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,iBAAiB,EAAE,WAAW,EAAE,MAAM,6BAA6B,CAAC;AAC7E,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAC5C,YAAY,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAEvD,YAAY,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AACvE,YAAY,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACzE,YAAY,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACzE,YAAY,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,YAAY,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AACvE,YAAY,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AACvD,YAAY,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACzE,YAAY,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAC3E,YAAY,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAC7E,YAAY,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC/D,YAAY,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,YAAY,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAC3E,YAAY,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAC7D,YAAY,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,YAAY,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AACrE,YAAY,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AACvF,YAAY,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,YAAY,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAC7E,YAAY,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AACrF,YAAY,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AACnD,YAAY,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AACnE,YAAY,EAAE,iBAAiB,EAAE,MAAM,+BAA+B,CAAC;AACvE,YAAY,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AACnE,YAAY,EAAE,sBAAsB,EAAE,MAAM,oCAAoC,CAAC;AACjF,YAAY,EAAE,uBAAuB,EAAE,MAAM,qCAAqC,CAAC;AACnF,YAAY,EAAE,2BAA2B,EAAE,MAAM,yCAAyC,CAAC;AAC3F,YAAY,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC/E,YAAY,EAAE,kBAAkB,EAAE,MAAM,gCAAgC,CAAC;AACzE,YAAY,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AACvF,YAAY,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC/E,YAAY,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AACrE,YAAY,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAC7E,YAAY,EAAE,mBAAmB,EAAE,MAAM,iCAAiC,CAAC;AAC3E,YAAY,EAAE,oBAAoB,EAAE,MAAM,kCAAkC,CAAC;AAC7E,YAAY,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC/E,YAAY,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AACjD,YAAY,EAAE,qBAAqB,EAAE,MAAM,mCAAmC,CAAC;AAC/E,YAAY,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACzD,YAAY,EAAE,yBAAyB,EAAE,MAAM,uCAAuC,CAAC;AAEvF,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,+BAA+B,CAAC;AAChE,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,iBAAiB,EAAE,MAAM,iCAAiC,CAAC;AACpE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC;AACtE,OAAO,EAAE,qBAAqB,EAAE,MAAM,qCAAqC,CAAC;AAC5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,kCAAkC,CAAC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/generated/index.ts"],"names":[],"mappings":";;;AAAA,+DAA+D;AAC/D,0BAA0B;AAC1B,oBAAoB;AACpB,oBAAoB;AACpB,kDAA8C;AAArC,uGAAA,QAAQ,OAAA;AACjB,oEAA6E;AAApE,yHAAA,iBAAiB,OAAA;AAAE,mHAAA,WAAW,OAAA;AACvC,gDAA4C;AAAnC,qGAAA,OAAO,OAAA;
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/generated/index.ts"],"names":[],"mappings":";;;AAAA,+DAA+D;AAC/D,0BAA0B;AAC1B,oBAAoB;AACpB,oBAAoB;AACpB,kDAA8C;AAArC,uGAAA,QAAQ,OAAA;AACjB,oEAA6E;AAApE,yHAAA,iBAAiB,OAAA;AAAE,mHAAA,WAAW,OAAA;AACvC,gDAA4C;AAAnC,qGAAA,OAAO,OAAA;AA2ChB,wEAAoE;AAA3D,yHAAA,iBAAiB,OAAA;AAC1B,oEAAgE;AAAvD,qHAAA,eAAe,OAAA;AACxB,0EAAsE;AAA7D,2HAAA,kBAAkB,OAAA;AAC3B,wEAAoE;AAA3D,yHAAA,iBAAiB,OAAA;AAC1B,gFAA4E;AAAnE,iIAAA,qBAAqB,OAAA;AAC9B,0EAAsE;AAA7D,2HAAA,kBAAkB,OAAA;AAC3B,gFAA4E;AAAnE,iIAAA,qBAAqB,OAAA;AAC9B,0EAAsE;AAA7D,2HAAA,kBAAkB,OAAA"}
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
export type EntitlementV1 = {
|
|
2
|
+
/**
|
|
3
|
+
* Feature key, the same value a plan-limit 402 names in `feature`. Currently
|
|
4
|
+
* `max_internal_apis`, `max_mock_servers` and `max_public_apis`; more may be added,
|
|
5
|
+
* so ignore keys you don't recognise.
|
|
6
|
+
*
|
|
7
|
+
*/
|
|
8
|
+
key: string;
|
|
9
|
+
/**
|
|
10
|
+
* The plan's limit. -1 means unlimited.
|
|
11
|
+
*/
|
|
12
|
+
limit: number;
|
|
13
|
+
/**
|
|
14
|
+
* Current count, measured the way the limit is enforced.
|
|
15
|
+
*/
|
|
16
|
+
used: number;
|
|
17
|
+
/**
|
|
18
|
+
* False when the plan allows none of this feature (a limit of 0).
|
|
19
|
+
*/
|
|
20
|
+
enabled: boolean;
|
|
21
|
+
};
|
|
22
|
+
//# sourceMappingURL=EntitlementV1.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"EntitlementV1.d.ts","sourceRoot":"","sources":["../../../src/generated/models/EntitlementV1.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,aAAa,GAAG;IAC1B;;;;;OAKG;IACH,GAAG,EAAE,MAAM,CAAC;IACZ;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"EntitlementV1.js","sourceRoot":"","sources":["../../../src/generated/models/EntitlementV1.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
export type MockApiKeyV1 = {
|
|
2
|
+
/**
|
|
3
|
+
* The mock's public id.
|
|
4
|
+
*/
|
|
5
|
+
mockServerId: string;
|
|
6
|
+
/**
|
|
7
|
+
* The key to send as `X-Mock-API-Key` when calling the mock.
|
|
8
|
+
*/
|
|
9
|
+
apiKey: string;
|
|
10
|
+
/**
|
|
11
|
+
* A short prefix of the key that is safe to display.
|
|
12
|
+
*/
|
|
13
|
+
apiKeyPreview: string;
|
|
14
|
+
};
|
|
15
|
+
//# sourceMappingURL=MockApiKeyV1.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"MockApiKeyV1.d.ts","sourceRoot":"","sources":["../../../src/generated/models/MockApiKeyV1.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,YAAY,GAAG;IACzB;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IACrB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;CACvB,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"MockApiKeyV1.js","sourceRoot":"","sources":["../../../src/generated/models/MockApiKeyV1.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"MockServerIdPath.d.ts","sourceRoot":"","sources":["../../../src/generated/models/MockServerIdPath.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"MockServerIdPath.js","sourceRoot":"","sources":["../../../src/generated/models/MockServerIdPath.ts"],"names":[],"mappings":""}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
import type { EntitlementV1 } from './EntitlementV1.js';
|
|
2
|
+
export type OrgEntitlementsResponseV1 = {
|
|
3
|
+
/**
|
|
4
|
+
* The org's effective plan id (e.g. `FREE`, `PRO`, `ENTERPRISE`).
|
|
5
|
+
*/
|
|
6
|
+
plan: string;
|
|
7
|
+
features: Array<EntitlementV1>;
|
|
8
|
+
};
|
|
9
|
+
//# sourceMappingURL=OrgEntitlementsResponseV1.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"OrgEntitlementsResponseV1.d.ts","sourceRoot":"","sources":["../../../src/generated/models/OrgEntitlementsResponseV1.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACxD,MAAM,MAAM,yBAAyB,GAAG;IACtC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,QAAQ,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC;CAChC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"OrgEntitlementsResponseV1.js","sourceRoot":"","sources":["../../../src/generated/models/OrgEntitlementsResponseV1.ts"],"names":[],"mappings":""}
|
|
@@ -6,7 +6,9 @@ export type OrgSummaryResponseV1 = {
|
|
|
6
6
|
mockServerCount?: number;
|
|
7
7
|
teamCount?: number;
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* The org's effective plan id (e.g. `FREE`, `PRO`), the plan its limits are
|
|
10
|
+
* enforced against.
|
|
11
|
+
*
|
|
10
12
|
*/
|
|
11
13
|
plan?: string;
|
|
12
14
|
};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OrgSummaryResponseV1.d.ts","sourceRoot":"","sources":["../../../src/generated/models/OrgSummaryResponseV1.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB
|
|
1
|
+
{"version":3,"file":"OrgSummaryResponseV1.d.ts","sourceRoot":"","sources":["../../../src/generated/models/OrgSummaryResponseV1.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf,CAAC"}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* A Problem (RFC 9457) for a plan limit. `feature`, `limit`, `used` and `plan` are
|
|
3
|
+
* extension members; `detail` is a plain sentence meant for a person.
|
|
4
|
+
*
|
|
5
|
+
*/
|
|
6
|
+
export type PlanLimitExceededProblem = {
|
|
7
|
+
/**
|
|
8
|
+
* Always `https://spec0.io/problems/plan-limit-exceeded`.
|
|
9
|
+
*/
|
|
10
|
+
type: string;
|
|
11
|
+
title: string;
|
|
12
|
+
status: number;
|
|
13
|
+
detail: string;
|
|
14
|
+
instance?: string;
|
|
15
|
+
/**
|
|
16
|
+
* The limit that was hit, matching a `key` from
|
|
17
|
+
* `GET /api/v1/public/orgs/entitlements`.
|
|
18
|
+
*
|
|
19
|
+
*/
|
|
20
|
+
feature: string;
|
|
21
|
+
/**
|
|
22
|
+
* The plan's limit for this feature.
|
|
23
|
+
*/
|
|
24
|
+
limit: number;
|
|
25
|
+
/**
|
|
26
|
+
* How many the org has now.
|
|
27
|
+
*/
|
|
28
|
+
used: number;
|
|
29
|
+
/**
|
|
30
|
+
* The org's effective plan id.
|
|
31
|
+
*/
|
|
32
|
+
plan: string;
|
|
33
|
+
};
|
|
34
|
+
//# sourceMappingURL=PlanLimitExceededProblem.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PlanLimitExceededProblem.d.ts","sourceRoot":"","sources":["../../../src/generated/models/PlanLimitExceededProblem.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IACd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"PlanLimitExceededProblem.js","sourceRoot":"","sources":["../../../src/generated/models/PlanLimitExceededProblem.ts"],"names":[],"mappings":""}
|
|
@@ -24,6 +24,10 @@ export declare class PublicApisService {
|
|
|
24
24
|
* same `publicApiId` update the existing one. Each call records an immutable version
|
|
25
25
|
* snapshot keyed on `version`.
|
|
26
26
|
*
|
|
27
|
+
* Creating a new public API counts against the plan's `max_public_apis` limit;
|
|
28
|
+
* publishing a new version of an existing one never does. At the limit, a create
|
|
29
|
+
* returns 402 with the limit, the current count and the plan.
|
|
30
|
+
*
|
|
27
31
|
* @returns PublicPublishResponseV1 Publish succeeded (idempotent on re-publish of the same tag+spec)
|
|
28
32
|
* @throws ApiError
|
|
29
33
|
*/
|
|
@@ -53,6 +57,10 @@ export declare class PublicApisService {
|
|
|
53
57
|
* - `team` accepts a UUID or slug; when omitted the API lands in the org's
|
|
54
58
|
* "Unassigned APIs" team.
|
|
55
59
|
*
|
|
60
|
+
* Creating a new API counts against the plan's `max_internal_apis` limit; publishing
|
|
61
|
+
* a new version of an API that already exists never does. At the limit, a create
|
|
62
|
+
* returns 402 with the limit, the current count and the plan.
|
|
63
|
+
*
|
|
56
64
|
* @returns TeamPublishResponseV1 Publish result
|
|
57
65
|
* @throws ApiError
|
|
58
66
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PublicApisService.d.ts","sourceRoot":"","sources":["../../../src/generated/services/PublicApisService.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAClF,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AACpF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAC9E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,wCAAwC,CAAC;AACxF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAGtE,qBAAa,iBAAiB;IAC5B;;;;;OAKG;WACW,cAAc,IAAI,iBAAiB,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAU3E
|
|
1
|
+
{"version":3,"file":"PublicApisService.d.ts","sourceRoot":"","sources":["../../../src/generated/services/PublicApisService.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,iCAAiC,CAAC;AAC1E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,0BAA0B,CAAC;AAC5D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,gCAAgC,CAAC;AACxE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,8BAA8B,CAAC;AACpE,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAClF,OAAO,KAAK,EAAE,uBAAuB,EAAE,MAAM,sCAAsC,CAAC;AACpF,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAC9E,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,wCAAwC,CAAC;AACxF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAGtE,qBAAa,iBAAiB;IAC5B;;;;;OAKG;WACW,cAAc,IAAI,iBAAiB,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAU3E;;;;;;;;;;;;OAYG;WACW,gBAAgB,CAAC,EAC7B,WAAW,GACZ,EAAE;QACD,WAAW,EAAE,sBAAsB,CAAC;KACrC,GAAG,iBAAiB,CAAC,uBAAuB,CAAC;IAkB9C;;;;;;;;;;OAUG;WACW,YAAY,IAAI,iBAAiB,CAAC,KAAK,CAAC,iBAAiB,CAAC,CAAC;IAUzE;;;;;;;;;;;;;;;;;OAiBG;WACW,cAAc,CAAC,EAC3B,WAAW,GACZ,EAAE;QACD,WAAW,EAAE,oBAAoB,CAAC;KACnC,GAAG,iBAAiB,CAAC,qBAAqB,CAAC;IAoB5C;;;;;;;;;;;OAWG;WACW,aAAa,CAAC,EAC1B,KAAK,GACN,EAAE;QACD,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,iBAAiB,CAAC,IAAI,CAAC;IAc3B;;;;;;;;;;;;;;;;OAgBG;WACW,cAAc,CAAC,EAC3B,KAAK,GACN,EAAE;QACD,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,iBAAiB,CAAC,MAAM,CAAC;IAc7B;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;WACW,uBAAuB,CAAC,EACpC,KAAK,GACN,EAAE;QACD,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,iBAAiB,CAAC,KAAK,CAAC,WAAW,CAAC,CAAC;IAczC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;WACW,uBAAuB,CAAC,EACpC,KAAK,GACN,EAAE;QACD,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,iBAAiB,CAAC,kBAAkB,CAAC;IAczC;;;;;;;;;OASG;WACW,mBAAmB,CAAC,EAChC,KAAK,GACN,EAAE;QACD,KAAK,EAAE,MAAM,CAAC;KACf,GAAG,iBAAiB,CAAC,KAAK,CAAC,qBAAqB,CAAC,CAAC;IAcnD;;;;;;;;OAQG;WACW,mBAAmB,CAAC,EAChC,KAAK,EACL,GAAG,GACJ,EAAE;QACD,KAAK,EAAE,MAAM,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;KACb,GAAG,iBAAiB,CAAC,MAAM,CAAC;IAe7B;;;;;;;;;OASG;WACW,yBAAyB,CAAC,EACtC,WAAW,EACX,WAAW,GACZ,EAAE;QACD,WAAW,EAAE,MAAM,CAAC;QACpB,WAAW,EAAE,yBAAyB,CAAC;KACxC,GAAG,iBAAiB,CAAC,eAAe,CAAC;IAgBtC;;;;;;;OAOG;WACW,eAAe,CAAC,EAC5B,WAAW,GACZ,EAAE;QACD,WAAW,EAAE,MAAM,CAAC;KACrB,GAAG,iBAAiB,CAAC,IAAI,CAAC;CAc5B"}
|
|
@@ -26,6 +26,10 @@ class PublicApisService {
|
|
|
26
26
|
* same `publicApiId` update the existing one. Each call records an immutable version
|
|
27
27
|
* snapshot keyed on `version`.
|
|
28
28
|
*
|
|
29
|
+
* Creating a new public API counts against the plan's `max_public_apis` limit;
|
|
30
|
+
* publishing a new version of an existing one never does. At the limit, a create
|
|
31
|
+
* returns 402 with the limit, the current count and the plan.
|
|
32
|
+
*
|
|
29
33
|
* @returns PublicPublishResponseV1 Publish succeeded (idempotent on re-publish of the same tag+spec)
|
|
30
34
|
* @throws ApiError
|
|
31
35
|
*/
|
|
@@ -38,7 +42,10 @@ class PublicApisService {
|
|
|
38
42
|
errors: {
|
|
39
43
|
400: `Bad request`,
|
|
40
44
|
401: `Missing, invalid, expired, or revoked token`,
|
|
41
|
-
402: `
|
|
45
|
+
402: `The org's plan limit for this kind of resource has been reached. The body names
|
|
46
|
+
the limit, the current count and the plan, so a client can explain it without
|
|
47
|
+
parsing \`detail\`.
|
|
48
|
+
`,
|
|
42
49
|
403: `Token does not carry the required scope`,
|
|
43
50
|
409: `Version tag already exists with different spec content`,
|
|
44
51
|
},
|
|
@@ -76,6 +83,10 @@ class PublicApisService {
|
|
|
76
83
|
* - `team` accepts a UUID or slug; when omitted the API lands in the org's
|
|
77
84
|
* "Unassigned APIs" team.
|
|
78
85
|
*
|
|
86
|
+
* Creating a new API counts against the plan's `max_internal_apis` limit; publishing
|
|
87
|
+
* a new version of an API that already exists never does. At the limit, a create
|
|
88
|
+
* returns 402 with the limit, the current count and the plan.
|
|
89
|
+
*
|
|
79
90
|
* @returns TeamPublishResponseV1 Publish result
|
|
80
91
|
* @throws ApiError
|
|
81
92
|
*/
|
|
@@ -88,6 +99,10 @@ class PublicApisService {
|
|
|
88
99
|
errors: {
|
|
89
100
|
400: `Bad request`,
|
|
90
101
|
401: `Missing, invalid, expired, or revoked token`,
|
|
102
|
+
402: `The org's plan limit for this kind of resource has been reached. The body names
|
|
103
|
+
the limit, the current count and the plan, so a client can explain it without
|
|
104
|
+
parsing \`detail\`.
|
|
105
|
+
`,
|
|
91
106
|
403: `Token does not carry the required scope`,
|
|
92
107
|
404: `Resource not found (or not visible to the calling org)`,
|
|
93
108
|
409: `Breaking change detected in same major version (when oasdiff is enabled and \`semver\` is not set)`,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PublicApisService.js","sourceRoot":"","sources":["../../../src/generated/services/PublicApisService.ts"],"names":[],"mappings":";;;AAgBA,mDAA6C;AAC7C,mDAA0D;AAC1D,MAAa,iBAAiB;IAC5B;;;;;OAKG;IACI,MAAM,CAAC,cAAc;QAC1B,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,qBAAqB;YAC1B,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;aAC/C;SACF,CAAC,CAAC;IACL,CAAC;IACD
|
|
1
|
+
{"version":3,"file":"PublicApisService.js","sourceRoot":"","sources":["../../../src/generated/services/PublicApisService.ts"],"names":[],"mappings":";;;AAgBA,mDAA6C;AAC7C,mDAA0D;AAC1D,MAAa,iBAAiB;IAC5B;;;;;OAKG;IACI,MAAM,CAAC,cAAc;QAC1B,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,qBAAqB;YAC1B,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;aAC/C;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;;;;;OAYG;IACI,MAAM,CAAC,gBAAgB,CAAC,EAC7B,WAAW,GAGZ;QACC,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,qBAAqB;YAC1B,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;YAC7B,MAAM,EAAE;gBACN,GAAG,EAAE,aAAa;gBAClB,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE;;;SAGJ;gBACD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;aAC9D;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;;;OAUG;IACI,MAAM,CAAC,YAAY;QACxB,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,0BAA0B;YAC/B,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;aAC/C;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;;;;;;;;;;OAiBG;IACI,MAAM,CAAC,cAAc,CAAC,EAC3B,WAAW,GAGZ;QACC,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,0BAA0B;YAC/B,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;YAC7B,MAAM,EAAE;gBACN,GAAG,EAAE,aAAa;gBAClB,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE;;;SAGJ;gBACD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;gBAC7D,GAAG,EAAE,oGAAoG;gBACzG,GAAG,EAAE,kDAAkD;aACxD;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;;;;OAWG;IACI,MAAM,CAAC,aAAa,CAAC,EAC1B,KAAK,GAGN;QACC,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,kCAAkC;YACvC,IAAI,EAAE;gBACJ,OAAO,EAAE,KAAK;aACf;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;aAC9D;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;;;;;;;;;OAgBG;IACI,MAAM,CAAC,cAAc,CAAC,EAC3B,KAAK,GAGN;QACC,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,uCAAuC;YAC5C,IAAI,EAAE;gBACJ,OAAO,EAAE,KAAK;aACf;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;aAC9D;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACI,MAAM,CAAC,uBAAuB,CAAC,EACpC,KAAK,GAGN;QACC,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,+CAA+C;YACpD,IAAI,EAAE;gBACJ,OAAO,EAAE,KAAK;aACf;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;aAC9D;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACI,MAAM,CAAC,uBAAuB,CAAC,EACpC,KAAK,GAGN;QACC,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,4CAA4C;YACjD,IAAI,EAAE;gBACJ,OAAO,EAAE,KAAK;aACf;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;aAC9D;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;;OASG;IACI,MAAM,CAAC,mBAAmB,CAAC,EAChC,KAAK,GAGN;QACC,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,2CAA2C;YAChD,IAAI,EAAE;gBACJ,OAAO,EAAE,KAAK;aACf;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;aAC9D;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;OAQG;IACI,MAAM,CAAC,mBAAmB,CAAC,EAChC,KAAK,EACL,GAAG,GAIJ;QACC,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,iDAAiD;YACtD,IAAI,EAAE;gBACJ,OAAO,EAAE,KAAK;gBACd,KAAK,EAAE,GAAG;aACX;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;aAC9D;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;;OASG;IACI,MAAM,CAAC,yBAAyB,CAAC,EACtC,WAAW,EACX,WAAW,GAIZ;QACC,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,8CAA8C;YACnD,IAAI,EAAE;gBACJ,aAAa,EAAE,WAAW;aAC3B;YACD,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;YAC7B,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;aAC9D;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;OAOG;IACI,MAAM,CAAC,eAAe,CAAC,EAC5B,WAAW,GAGZ;QACC,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,mCAAmC;YACxC,IAAI,EAAE;gBACJ,aAAa,EAAE,WAAW;aAC3B;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;aAC9D;SACF,CAAC,CAAC;IACL,CAAC;CACF;AAjYD,8CAiYC"}
|
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import type { CreateMockRequestV1 } from '../models/CreateMockRequestV1.js';
|
|
2
2
|
import type { CreateMockResponseV1 } from '../models/CreateMockResponseV1.js';
|
|
3
|
+
import type { MockApiKeyV1 } from '../models/MockApiKeyV1.js';
|
|
3
4
|
import type { MockItemV1 } from '../models/MockItemV1.js';
|
|
4
5
|
import type { RefreshMockResponseV1 } from '../models/RefreshMockResponseV1.js';
|
|
5
6
|
import type { CancelablePromise } from '../core/CancelablePromise.js';
|
|
@@ -20,6 +21,10 @@ export declare class PublicMocksService {
|
|
|
20
21
|
* Provide either `apiId` or `apiName`. If a mock already exists for the
|
|
21
22
|
* (api, team) pair the existing one is returned (idempotent).
|
|
22
23
|
*
|
|
24
|
+
* A new mock counts against the plan's `max_mock_servers` limit; returning an
|
|
25
|
+
* existing one does not. At the limit this returns 402 with the limit, the current
|
|
26
|
+
* count and the plan.
|
|
27
|
+
*
|
|
23
28
|
* @returns CreateMockResponseV1 Mock server (existing or freshly created)
|
|
24
29
|
* @throws ApiError
|
|
25
30
|
*/
|
|
@@ -49,6 +54,39 @@ export declare class PublicMocksService {
|
|
|
49
54
|
static refreshPublicMock({ mockServerId, }: {
|
|
50
55
|
mockServerId: string;
|
|
51
56
|
}): CancelablePromise<RefreshMockResponseV1>;
|
|
57
|
+
/**
|
|
58
|
+
* Reveal a mock server's API key
|
|
59
|
+
* Returns the key a client sends (as `X-Mock-API-Key`) to call this mock. The full
|
|
60
|
+
* key is only in the response when a mock is first created, so this is how a client
|
|
61
|
+
* that didn't keep it, or runs on another machine, gets it back.
|
|
62
|
+
*
|
|
63
|
+
* The key is a credential for calling the mock, so revealing it needs `manage` on the
|
|
64
|
+
* mock (the owning team, the mock's owner, or an org admin), not just the ability to
|
|
65
|
+
* see that it exists. Every reveal is audit-logged.
|
|
66
|
+
*
|
|
67
|
+
* Keyed on the mock's public id, which does not change when the mock is refreshed.
|
|
68
|
+
* Cross-org returns 404, not 403, so the existence of a mock is not leaked.
|
|
69
|
+
*
|
|
70
|
+
* @returns MockApiKeyV1 The mock's current API key
|
|
71
|
+
* @throws ApiError
|
|
72
|
+
*/
|
|
73
|
+
static getPublicMockApiKey({ mockServerId, }: {
|
|
74
|
+
mockServerId: string;
|
|
75
|
+
}): CancelablePromise<MockApiKeyV1>;
|
|
76
|
+
/**
|
|
77
|
+
* Replace a mock server's API key
|
|
78
|
+
* Issues a new key for the mock and returns it. The previous key stops working
|
|
79
|
+
* immediately, so anything configured with it needs the new one.
|
|
80
|
+
*
|
|
81
|
+
* Same authorization as revealing the key (`manage` on the mock), audit-logged, and
|
|
82
|
+
* cross-org returns 404.
|
|
83
|
+
*
|
|
84
|
+
* @returns MockApiKeyV1 The newly issued key
|
|
85
|
+
* @throws ApiError
|
|
86
|
+
*/
|
|
87
|
+
static regeneratePublicMockApiKey({ mockServerId, }: {
|
|
88
|
+
mockServerId: string;
|
|
89
|
+
}): CancelablePromise<MockApiKeyV1>;
|
|
52
90
|
/**
|
|
53
91
|
* Delete a mock server owned by the calling org
|
|
54
92
|
* Hard-deletes the mock server and removes its association with the parent API.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PublicMocksService.d.ts","sourceRoot":"","sources":["../../../src/generated/services/PublicMocksService.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAC9E,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAGtE,qBAAa,kBAAkB;IAC7B;;;;;;;;;OASG;WACW,eAAe,IAAI,iBAAiB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAUrE
|
|
1
|
+
{"version":3,"file":"PublicMocksService.d.ts","sourceRoot":"","sources":["../../../src/generated/services/PublicMocksService.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kCAAkC,CAAC;AAC5E,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAC9E,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AAC9D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,oCAAoC,CAAC;AAChF,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAGtE,qBAAa,kBAAkB;IAC7B;;;;;;;;;OASG;WACW,eAAe,IAAI,iBAAiB,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IAUrE;;;;;;;;;;;OAWG;WACW,gBAAgB,CAAC,EAC7B,WAAW,GACZ,EAAE;QACD,WAAW,EAAE,mBAAmB,CAAC;KAClC,GAAG,iBAAiB,CAAC,oBAAoB,CAAC;IAkB3C;;;;;;;;;;;;;;;;;;;OAmBG;WACW,iBAAiB,CAAC,EAC9B,YAAY,GACb,EAAE;QACD,YAAY,EAAE,MAAM,CAAC;KACtB,GAAG,iBAAiB,CAAC,qBAAqB,CAAC;IAc5C;;;;;;;;;;;;;;;OAeG;WACW,mBAAmB,CAAC,EAChC,YAAY,GACb,EAAE;QACD,YAAY,EAAE,MAAM,CAAC;KACtB,GAAG,iBAAiB,CAAC,YAAY,CAAC;IAiBnC;;;;;;;;;;OAUG;WACW,0BAA0B,CAAC,EACvC,YAAY,GACb,EAAE;QACD,YAAY,EAAE,MAAM,CAAC;KACtB,GAAG,iBAAiB,CAAC,YAAY,CAAC;IAcnC;;;;;;;;OAQG;WACW,gBAAgB,CAAC,EAC7B,YAAY,GACb,EAAE;QACD,YAAY,EAAE,MAAM,CAAC;KACtB,GAAG,iBAAiB,CAAC,IAAI,CAAC;CAc5B"}
|
|
@@ -29,6 +29,10 @@ class PublicMocksService {
|
|
|
29
29
|
* Provide either `apiId` or `apiName`. If a mock already exists for the
|
|
30
30
|
* (api, team) pair the existing one is returned (idempotent).
|
|
31
31
|
*
|
|
32
|
+
* A new mock counts against the plan's `max_mock_servers` limit; returning an
|
|
33
|
+
* existing one does not. At the limit this returns 402 with the limit, the current
|
|
34
|
+
* count and the plan.
|
|
35
|
+
*
|
|
32
36
|
* @returns CreateMockResponseV1 Mock server (existing or freshly created)
|
|
33
37
|
* @throws ApiError
|
|
34
38
|
*/
|
|
@@ -41,6 +45,10 @@ class PublicMocksService {
|
|
|
41
45
|
errors: {
|
|
42
46
|
400: `Bad request`,
|
|
43
47
|
401: `Missing, invalid, expired, or revoked token`,
|
|
48
|
+
402: `The org's plan limit for this kind of resource has been reached. The body names
|
|
49
|
+
the limit, the current count and the plan, so a client can explain it without
|
|
50
|
+
parsing \`detail\`.
|
|
51
|
+
`,
|
|
44
52
|
403: `Token does not carry the required scope`,
|
|
45
53
|
404: `Resource not found (or not visible to the calling org)`,
|
|
46
54
|
},
|
|
@@ -80,6 +88,64 @@ class PublicMocksService {
|
|
|
80
88
|
},
|
|
81
89
|
});
|
|
82
90
|
}
|
|
91
|
+
/**
|
|
92
|
+
* Reveal a mock server's API key
|
|
93
|
+
* Returns the key a client sends (as `X-Mock-API-Key`) to call this mock. The full
|
|
94
|
+
* key is only in the response when a mock is first created, so this is how a client
|
|
95
|
+
* that didn't keep it, or runs on another machine, gets it back.
|
|
96
|
+
*
|
|
97
|
+
* The key is a credential for calling the mock, so revealing it needs `manage` on the
|
|
98
|
+
* mock (the owning team, the mock's owner, or an org admin), not just the ability to
|
|
99
|
+
* see that it exists. Every reveal is audit-logged.
|
|
100
|
+
*
|
|
101
|
+
* Keyed on the mock's public id, which does not change when the mock is refreshed.
|
|
102
|
+
* Cross-org returns 404, not 403, so the existence of a mock is not leaked.
|
|
103
|
+
*
|
|
104
|
+
* @returns MockApiKeyV1 The mock's current API key
|
|
105
|
+
* @throws ApiError
|
|
106
|
+
*/
|
|
107
|
+
static getPublicMockApiKey({ mockServerId, }) {
|
|
108
|
+
return (0, request_js_1.request)(OpenAPI_js_1.OpenAPI, {
|
|
109
|
+
method: 'GET',
|
|
110
|
+
url: '/api/v1/public/mocks/{mockServerId}/api-key',
|
|
111
|
+
path: {
|
|
112
|
+
'mockServerId': mockServerId,
|
|
113
|
+
},
|
|
114
|
+
errors: {
|
|
115
|
+
401: `Missing, invalid, expired, or revoked token`,
|
|
116
|
+
403: `Token does not carry the required scope`,
|
|
117
|
+
404: `Resource not found (or not visible to the calling org)`,
|
|
118
|
+
409: `The key was issued before keys were stored recoverably and cannot be revealed.
|
|
119
|
+
Regenerate it once.
|
|
120
|
+
`,
|
|
121
|
+
},
|
|
122
|
+
});
|
|
123
|
+
}
|
|
124
|
+
/**
|
|
125
|
+
* Replace a mock server's API key
|
|
126
|
+
* Issues a new key for the mock and returns it. The previous key stops working
|
|
127
|
+
* immediately, so anything configured with it needs the new one.
|
|
128
|
+
*
|
|
129
|
+
* Same authorization as revealing the key (`manage` on the mock), audit-logged, and
|
|
130
|
+
* cross-org returns 404.
|
|
131
|
+
*
|
|
132
|
+
* @returns MockApiKeyV1 The newly issued key
|
|
133
|
+
* @throws ApiError
|
|
134
|
+
*/
|
|
135
|
+
static regeneratePublicMockApiKey({ mockServerId, }) {
|
|
136
|
+
return (0, request_js_1.request)(OpenAPI_js_1.OpenAPI, {
|
|
137
|
+
method: 'POST',
|
|
138
|
+
url: '/api/v1/public/mocks/{mockServerId}/api-key/regenerate',
|
|
139
|
+
path: {
|
|
140
|
+
'mockServerId': mockServerId,
|
|
141
|
+
},
|
|
142
|
+
errors: {
|
|
143
|
+
401: `Missing, invalid, expired, or revoked token`,
|
|
144
|
+
403: `Token does not carry the required scope`,
|
|
145
|
+
404: `Resource not found (or not visible to the calling org)`,
|
|
146
|
+
},
|
|
147
|
+
});
|
|
148
|
+
}
|
|
83
149
|
/**
|
|
84
150
|
* Delete a mock server owned by the calling org
|
|
85
151
|
* Hard-deletes the mock server and removes its association with the parent API.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PublicMocksService.js","sourceRoot":"","sources":["../../../src/generated/services/PublicMocksService.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"PublicMocksService.js","sourceRoot":"","sources":["../../../src/generated/services/PublicMocksService.ts"],"names":[],"mappings":";;;AAUA,mDAA6C;AAC7C,mDAA0D;AAC1D,MAAa,kBAAkB;IAC7B;;;;;;;;;OASG;IACI,MAAM,CAAC,eAAe;QAC3B,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,sBAAsB;YAC3B,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;aAC/C;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;;;;OAWG;IACI,MAAM,CAAC,gBAAgB,CAAC,EAC7B,WAAW,GAGZ;QACC,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,sBAAsB;YAC3B,IAAI,EAAE,WAAW;YACjB,SAAS,EAAE,kBAAkB;YAC7B,MAAM,EAAE;gBACN,GAAG,EAAE,aAAa;gBAClB,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE;;;SAGJ;gBACD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;aAC9D;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;;;;;;;;;;;;OAmBG;IACI,MAAM,CAAC,iBAAiB,CAAC,EAC9B,YAAY,GAGb;QACC,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,6CAA6C;YAClD,IAAI,EAAE;gBACJ,cAAc,EAAE,YAAY;aAC7B;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;aAC9D;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;;;;;;;;OAeG;IACI,MAAM,CAAC,mBAAmB,CAAC,EAChC,YAAY,GAGb;QACC,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,6CAA6C;YAClD,IAAI,EAAE;gBACJ,cAAc,EAAE,YAAY;aAC7B;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;gBAC7D,GAAG,EAAE;;SAEJ;aACF;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;;;OAUG;IACI,MAAM,CAAC,0BAA0B,CAAC,EACvC,YAAY,GAGb;QACC,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,MAAM;YACd,GAAG,EAAE,wDAAwD;YAC7D,IAAI,EAAE;gBACJ,cAAc,EAAE,YAAY;aAC7B;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;aAC9D;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;OAQG;IACI,MAAM,CAAC,gBAAgB,CAAC,EAC7B,YAAY,GAGb;QACC,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,QAAQ;YAChB,GAAG,EAAE,qCAAqC;YAC1C,IAAI,EAAE;gBACJ,cAAc,EAAE,YAAY;aAC7B;YACD,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;gBAC9C,GAAG,EAAE,wDAAwD;aAC9D;SACF,CAAC,CAAC;IACL,CAAC;CACF;AA1LD,gDA0LC"}
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import type { OrgEntitlementsResponseV1 } from '../models/OrgEntitlementsResponseV1.js';
|
|
1
2
|
import type { OrgSummaryResponseV1 } from '../models/OrgSummaryResponseV1.js';
|
|
2
3
|
import type { CancelablePromise } from '../core/CancelablePromise.js';
|
|
3
4
|
export declare class PublicOrgsService {
|
|
@@ -10,5 +11,20 @@ export declare class PublicOrgsService {
|
|
|
10
11
|
* @throws ApiError
|
|
11
12
|
*/
|
|
12
13
|
static getOrgSummary(): CancelablePromise<OrgSummaryResponseV1>;
|
|
14
|
+
/**
|
|
15
|
+
* The calling org's plan limits and current usage
|
|
16
|
+
* What the org's plan allows and how much of it is in use, so a client can tell
|
|
17
|
+
* someone they're at a limit before an action fails rather than after.
|
|
18
|
+
*
|
|
19
|
+
* Each feature carries the same `key` that a 402 names in its `feature` field. A
|
|
20
|
+
* `limit` of -1 means unlimited. `used` is counted the same way the limit is
|
|
21
|
+
* enforced, so `used >= limit` means the next create will be refused.
|
|
22
|
+
*
|
|
23
|
+
* Read-only; any member token with `read:apis` can call it.
|
|
24
|
+
*
|
|
25
|
+
* @returns OrgEntitlementsResponseV1 Plan and per-feature usage
|
|
26
|
+
* @throws ApiError
|
|
27
|
+
*/
|
|
28
|
+
static getOrgEntitlements(): CancelablePromise<OrgEntitlementsResponseV1>;
|
|
13
29
|
}
|
|
14
30
|
//# sourceMappingURL=PublicOrgsService.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PublicOrgsService.d.ts","sourceRoot":"","sources":["../../../src/generated/services/PublicOrgsService.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAC9E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAGtE,qBAAa,iBAAiB;IAC5B;;;;;;;OAOG;WACW,aAAa,IAAI,iBAAiB,CAAC,oBAAoB,CAAC;
|
|
1
|
+
{"version":3,"file":"PublicOrgsService.d.ts","sourceRoot":"","sources":["../../../src/generated/services/PublicOrgsService.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,wCAAwC,CAAC;AACxF,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AAC9E,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAGtE,qBAAa,iBAAiB;IAC5B;;;;;;;OAOG;WACW,aAAa,IAAI,iBAAiB,CAAC,oBAAoB,CAAC;IAUtE;;;;;;;;;;;;;OAaG;WACW,kBAAkB,IAAI,iBAAiB,CAAC,yBAAyB,CAAC;CAUjF"}
|
|
@@ -22,6 +22,30 @@ class PublicOrgsService {
|
|
|
22
22
|
},
|
|
23
23
|
});
|
|
24
24
|
}
|
|
25
|
+
/**
|
|
26
|
+
* The calling org's plan limits and current usage
|
|
27
|
+
* What the org's plan allows and how much of it is in use, so a client can tell
|
|
28
|
+
* someone they're at a limit before an action fails rather than after.
|
|
29
|
+
*
|
|
30
|
+
* Each feature carries the same `key` that a 402 names in its `feature` field. A
|
|
31
|
+
* `limit` of -1 means unlimited. `used` is counted the same way the limit is
|
|
32
|
+
* enforced, so `used >= limit` means the next create will be refused.
|
|
33
|
+
*
|
|
34
|
+
* Read-only; any member token with `read:apis` can call it.
|
|
35
|
+
*
|
|
36
|
+
* @returns OrgEntitlementsResponseV1 Plan and per-feature usage
|
|
37
|
+
* @throws ApiError
|
|
38
|
+
*/
|
|
39
|
+
static getOrgEntitlements() {
|
|
40
|
+
return (0, request_js_1.request)(OpenAPI_js_1.OpenAPI, {
|
|
41
|
+
method: 'GET',
|
|
42
|
+
url: '/api/v1/public/orgs/entitlements',
|
|
43
|
+
errors: {
|
|
44
|
+
401: `Missing, invalid, expired, or revoked token`,
|
|
45
|
+
403: `Token does not carry the required scope`,
|
|
46
|
+
},
|
|
47
|
+
});
|
|
48
|
+
}
|
|
25
49
|
}
|
|
26
50
|
exports.PublicOrgsService = PublicOrgsService;
|
|
27
51
|
//# sourceMappingURL=PublicOrgsService.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"PublicOrgsService.js","sourceRoot":"","sources":["../../../src/generated/services/PublicOrgsService.ts"],"names":[],"mappings":";;;
|
|
1
|
+
{"version":3,"file":"PublicOrgsService.js","sourceRoot":"","sources":["../../../src/generated/services/PublicOrgsService.ts"],"names":[],"mappings":";;;AAOA,mDAA6C;AAC7C,mDAA0D;AAC1D,MAAa,iBAAiB;IAC5B;;;;;;;OAOG;IACI,MAAM,CAAC,aAAa;QACzB,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,6BAA6B;YAClC,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;aAC/C;SACF,CAAC,CAAC;IACL,CAAC;IACD;;;;;;;;;;;;;OAaG;IACI,MAAM,CAAC,kBAAkB;QAC9B,OAAO,IAAA,oBAAS,EAAC,oBAAO,EAAE;YACxB,MAAM,EAAE,KAAK;YACb,GAAG,EAAE,kCAAkC;YACvC,MAAM,EAAE;gBACN,GAAG,EAAE,6CAA6C;gBAClD,GAAG,EAAE,yCAAyC;aAC/C;SACF,CAAC,CAAC;IACL,CAAC;CACF;AA3CD,8CA2CC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@spec0/sdk-public-platform",
|
|
3
|
-
"version": "1.
|
|
3
|
+
"version": "1.19.0",
|
|
4
4
|
"description": "TypeScript SDK for Spec0's public API surface (https://app.spec0.io). Generated from the OpenAPI spec published at spec0/spec0-platform.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"main": "./dist/index.js",
|
package/src/generated/index.ts
CHANGED
|
@@ -16,11 +16,16 @@ export type { AuthError } from './models/AuthError.js';
|
|
|
16
16
|
export type { CiConfigResponseV1 } from './models/CiConfigResponseV1.js';
|
|
17
17
|
export type { CreateMockRequestV1 } from './models/CreateMockRequestV1.js';
|
|
18
18
|
export type { CreateMockResponseV1 } from './models/CreateMockResponseV1.js';
|
|
19
|
+
export type { EntitlementV1 } from './models/EntitlementV1.js';
|
|
19
20
|
export type { EnvTargetV1 } from './models/EnvTargetV1.js';
|
|
20
21
|
export type { GovernanceWarningV1 } from './models/GovernanceWarningV1.js';
|
|
22
|
+
export type { MockApiKeyV1 } from './models/MockApiKeyV1.js';
|
|
21
23
|
export type { MockItemV1 } from './models/MockItemV1.js';
|
|
24
|
+
export type { MockServerIdPath } from './models/MockServerIdPath.js';
|
|
25
|
+
export type { OrgEntitlementsResponseV1 } from './models/OrgEntitlementsResponseV1.js';
|
|
22
26
|
export type { OrgSlugPath } from './models/OrgSlugPath.js';
|
|
23
27
|
export type { OrgSummaryResponseV1 } from './models/OrgSummaryResponseV1.js';
|
|
28
|
+
export type { PlanLimitExceededProblem } from './models/PlanLimitExceededProblem.js';
|
|
24
29
|
export type { Problem } from './models/Problem.js';
|
|
25
30
|
export type { PublicApiIdPath } from './models/PublicApiIdPath.js';
|
|
26
31
|
export type { PublicApiListItem } from './models/PublicApiListItem.js';
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
/* generated using openapi-typescript-codegen -- do not edit */
|
|
2
|
+
/* istanbul ignore file */
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
/* eslint-disable */
|
|
5
|
+
export type EntitlementV1 = {
|
|
6
|
+
/**
|
|
7
|
+
* Feature key, the same value a plan-limit 402 names in `feature`. Currently
|
|
8
|
+
* `max_internal_apis`, `max_mock_servers` and `max_public_apis`; more may be added,
|
|
9
|
+
* so ignore keys you don't recognise.
|
|
10
|
+
*
|
|
11
|
+
*/
|
|
12
|
+
key: string;
|
|
13
|
+
/**
|
|
14
|
+
* The plan's limit. -1 means unlimited.
|
|
15
|
+
*/
|
|
16
|
+
limit: number;
|
|
17
|
+
/**
|
|
18
|
+
* Current count, measured the way the limit is enforced.
|
|
19
|
+
*/
|
|
20
|
+
used: number;
|
|
21
|
+
/**
|
|
22
|
+
* False when the plan allows none of this feature (a limit of 0).
|
|
23
|
+
*/
|
|
24
|
+
enabled: boolean;
|
|
25
|
+
};
|
|
26
|
+
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
/* generated using openapi-typescript-codegen -- do not edit */
|
|
2
|
+
/* istanbul ignore file */
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
/* eslint-disable */
|
|
5
|
+
export type MockApiKeyV1 = {
|
|
6
|
+
/**
|
|
7
|
+
* The mock's public id.
|
|
8
|
+
*/
|
|
9
|
+
mockServerId: string;
|
|
10
|
+
/**
|
|
11
|
+
* The key to send as `X-Mock-API-Key` when calling the mock.
|
|
12
|
+
*/
|
|
13
|
+
apiKey: string;
|
|
14
|
+
/**
|
|
15
|
+
* A short prefix of the key that is safe to display.
|
|
16
|
+
*/
|
|
17
|
+
apiKeyPreview: string;
|
|
18
|
+
};
|
|
19
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
/* generated using openapi-typescript-codegen -- do not edit */
|
|
2
|
+
/* istanbul ignore file */
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
/* eslint-disable */
|
|
5
|
+
import type { EntitlementV1 } from './EntitlementV1.js';
|
|
6
|
+
export type OrgEntitlementsResponseV1 = {
|
|
7
|
+
/**
|
|
8
|
+
* The org's effective plan id (e.g. `FREE`, `PRO`, `ENTERPRISE`).
|
|
9
|
+
*/
|
|
10
|
+
plan: string;
|
|
11
|
+
features: Array<EntitlementV1>;
|
|
12
|
+
};
|
|
13
|
+
|
|
@@ -10,7 +10,9 @@ export type OrgSummaryResponseV1 = {
|
|
|
10
10
|
mockServerCount?: number;
|
|
11
11
|
teamCount?: number;
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
13
|
+
* The org's effective plan id (e.g. `FREE`, `PRO`), the plan its limits are
|
|
14
|
+
* enforced against.
|
|
15
|
+
*
|
|
14
16
|
*/
|
|
15
17
|
plan?: string;
|
|
16
18
|
};
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
/* generated using openapi-typescript-codegen -- do not edit */
|
|
2
|
+
/* istanbul ignore file */
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
/* eslint-disable */
|
|
5
|
+
/**
|
|
6
|
+
* A Problem (RFC 9457) for a plan limit. `feature`, `limit`, `used` and `plan` are
|
|
7
|
+
* extension members; `detail` is a plain sentence meant for a person.
|
|
8
|
+
*
|
|
9
|
+
*/
|
|
10
|
+
export type PlanLimitExceededProblem = {
|
|
11
|
+
/**
|
|
12
|
+
* Always `https://spec0.io/problems/plan-limit-exceeded`.
|
|
13
|
+
*/
|
|
14
|
+
type: string;
|
|
15
|
+
title: string;
|
|
16
|
+
status: number;
|
|
17
|
+
detail: string;
|
|
18
|
+
instance?: string;
|
|
19
|
+
/**
|
|
20
|
+
* The limit that was hit, matching a `key` from
|
|
21
|
+
* `GET /api/v1/public/orgs/entitlements`.
|
|
22
|
+
*
|
|
23
|
+
*/
|
|
24
|
+
feature: string;
|
|
25
|
+
/**
|
|
26
|
+
* The plan's limit for this feature.
|
|
27
|
+
*/
|
|
28
|
+
limit: number;
|
|
29
|
+
/**
|
|
30
|
+
* How many the org has now.
|
|
31
|
+
*/
|
|
32
|
+
used: number;
|
|
33
|
+
/**
|
|
34
|
+
* The org's effective plan id.
|
|
35
|
+
*/
|
|
36
|
+
plan: string;
|
|
37
|
+
};
|
|
38
|
+
|
|
@@ -39,6 +39,10 @@ export class PublicApisService {
|
|
|
39
39
|
* same `publicApiId` update the existing one. Each call records an immutable version
|
|
40
40
|
* snapshot keyed on `version`.
|
|
41
41
|
*
|
|
42
|
+
* Creating a new public API counts against the plan's `max_public_apis` limit;
|
|
43
|
+
* publishing a new version of an existing one never does. At the limit, a create
|
|
44
|
+
* returns 402 with the limit, the current count and the plan.
|
|
45
|
+
*
|
|
42
46
|
* @returns PublicPublishResponseV1 Publish succeeded (idempotent on re-publish of the same tag+spec)
|
|
43
47
|
* @throws ApiError
|
|
44
48
|
*/
|
|
@@ -55,7 +59,10 @@ export class PublicApisService {
|
|
|
55
59
|
errors: {
|
|
56
60
|
400: `Bad request`,
|
|
57
61
|
401: `Missing, invalid, expired, or revoked token`,
|
|
58
|
-
402: `
|
|
62
|
+
402: `The org's plan limit for this kind of resource has been reached. The body names
|
|
63
|
+
the limit, the current count and the plan, so a client can explain it without
|
|
64
|
+
parsing \`detail\`.
|
|
65
|
+
`,
|
|
59
66
|
403: `Token does not carry the required scope`,
|
|
60
67
|
409: `Version tag already exists with different spec content`,
|
|
61
68
|
},
|
|
@@ -93,6 +100,10 @@ export class PublicApisService {
|
|
|
93
100
|
* - `team` accepts a UUID or slug; when omitted the API lands in the org's
|
|
94
101
|
* "Unassigned APIs" team.
|
|
95
102
|
*
|
|
103
|
+
* Creating a new API counts against the plan's `max_internal_apis` limit; publishing
|
|
104
|
+
* a new version of an API that already exists never does. At the limit, a create
|
|
105
|
+
* returns 402 with the limit, the current count and the plan.
|
|
106
|
+
*
|
|
96
107
|
* @returns TeamPublishResponseV1 Publish result
|
|
97
108
|
* @throws ApiError
|
|
98
109
|
*/
|
|
@@ -109,6 +120,10 @@ export class PublicApisService {
|
|
|
109
120
|
errors: {
|
|
110
121
|
400: `Bad request`,
|
|
111
122
|
401: `Missing, invalid, expired, or revoked token`,
|
|
123
|
+
402: `The org's plan limit for this kind of resource has been reached. The body names
|
|
124
|
+
the limit, the current count and the plan, so a client can explain it without
|
|
125
|
+
parsing \`detail\`.
|
|
126
|
+
`,
|
|
112
127
|
403: `Token does not carry the required scope`,
|
|
113
128
|
404: `Resource not found (or not visible to the calling org)`,
|
|
114
129
|
409: `Breaking change detected in same major version (when oasdiff is enabled and \`semver\` is not set)`,
|
|
@@ -4,6 +4,7 @@
|
|
|
4
4
|
/* eslint-disable */
|
|
5
5
|
import type { CreateMockRequestV1 } from '../models/CreateMockRequestV1.js';
|
|
6
6
|
import type { CreateMockResponseV1 } from '../models/CreateMockResponseV1.js';
|
|
7
|
+
import type { MockApiKeyV1 } from '../models/MockApiKeyV1.js';
|
|
7
8
|
import type { MockItemV1 } from '../models/MockItemV1.js';
|
|
8
9
|
import type { RefreshMockResponseV1 } from '../models/RefreshMockResponseV1.js';
|
|
9
10
|
import type { CancelablePromise } from '../core/CancelablePromise.js';
|
|
@@ -35,6 +36,10 @@ export class PublicMocksService {
|
|
|
35
36
|
* Provide either `apiId` or `apiName`. If a mock already exists for the
|
|
36
37
|
* (api, team) pair the existing one is returned (idempotent).
|
|
37
38
|
*
|
|
39
|
+
* A new mock counts against the plan's `max_mock_servers` limit; returning an
|
|
40
|
+
* existing one does not. At the limit this returns 402 with the limit, the current
|
|
41
|
+
* count and the plan.
|
|
42
|
+
*
|
|
38
43
|
* @returns CreateMockResponseV1 Mock server (existing or freshly created)
|
|
39
44
|
* @throws ApiError
|
|
40
45
|
*/
|
|
@@ -51,6 +56,10 @@ export class PublicMocksService {
|
|
|
51
56
|
errors: {
|
|
52
57
|
400: `Bad request`,
|
|
53
58
|
401: `Missing, invalid, expired, or revoked token`,
|
|
59
|
+
402: `The org's plan limit for this kind of resource has been reached. The body names
|
|
60
|
+
the limit, the current count and the plan, so a client can explain it without
|
|
61
|
+
parsing \`detail\`.
|
|
62
|
+
`,
|
|
54
63
|
403: `Token does not carry the required scope`,
|
|
55
64
|
404: `Resource not found (or not visible to the calling org)`,
|
|
56
65
|
},
|
|
@@ -94,6 +103,72 @@ export class PublicMocksService {
|
|
|
94
103
|
},
|
|
95
104
|
});
|
|
96
105
|
}
|
|
106
|
+
/**
|
|
107
|
+
* Reveal a mock server's API key
|
|
108
|
+
* Returns the key a client sends (as `X-Mock-API-Key`) to call this mock. The full
|
|
109
|
+
* key is only in the response when a mock is first created, so this is how a client
|
|
110
|
+
* that didn't keep it, or runs on another machine, gets it back.
|
|
111
|
+
*
|
|
112
|
+
* The key is a credential for calling the mock, so revealing it needs `manage` on the
|
|
113
|
+
* mock (the owning team, the mock's owner, or an org admin), not just the ability to
|
|
114
|
+
* see that it exists. Every reveal is audit-logged.
|
|
115
|
+
*
|
|
116
|
+
* Keyed on the mock's public id, which does not change when the mock is refreshed.
|
|
117
|
+
* Cross-org returns 404, not 403, so the existence of a mock is not leaked.
|
|
118
|
+
*
|
|
119
|
+
* @returns MockApiKeyV1 The mock's current API key
|
|
120
|
+
* @throws ApiError
|
|
121
|
+
*/
|
|
122
|
+
public static getPublicMockApiKey({
|
|
123
|
+
mockServerId,
|
|
124
|
+
}: {
|
|
125
|
+
mockServerId: string,
|
|
126
|
+
}): CancelablePromise<MockApiKeyV1> {
|
|
127
|
+
return __request(OpenAPI, {
|
|
128
|
+
method: 'GET',
|
|
129
|
+
url: '/api/v1/public/mocks/{mockServerId}/api-key',
|
|
130
|
+
path: {
|
|
131
|
+
'mockServerId': mockServerId,
|
|
132
|
+
},
|
|
133
|
+
errors: {
|
|
134
|
+
401: `Missing, invalid, expired, or revoked token`,
|
|
135
|
+
403: `Token does not carry the required scope`,
|
|
136
|
+
404: `Resource not found (or not visible to the calling org)`,
|
|
137
|
+
409: `The key was issued before keys were stored recoverably and cannot be revealed.
|
|
138
|
+
Regenerate it once.
|
|
139
|
+
`,
|
|
140
|
+
},
|
|
141
|
+
});
|
|
142
|
+
}
|
|
143
|
+
/**
|
|
144
|
+
* Replace a mock server's API key
|
|
145
|
+
* Issues a new key for the mock and returns it. The previous key stops working
|
|
146
|
+
* immediately, so anything configured with it needs the new one.
|
|
147
|
+
*
|
|
148
|
+
* Same authorization as revealing the key (`manage` on the mock), audit-logged, and
|
|
149
|
+
* cross-org returns 404.
|
|
150
|
+
*
|
|
151
|
+
* @returns MockApiKeyV1 The newly issued key
|
|
152
|
+
* @throws ApiError
|
|
153
|
+
*/
|
|
154
|
+
public static regeneratePublicMockApiKey({
|
|
155
|
+
mockServerId,
|
|
156
|
+
}: {
|
|
157
|
+
mockServerId: string,
|
|
158
|
+
}): CancelablePromise<MockApiKeyV1> {
|
|
159
|
+
return __request(OpenAPI, {
|
|
160
|
+
method: 'POST',
|
|
161
|
+
url: '/api/v1/public/mocks/{mockServerId}/api-key/regenerate',
|
|
162
|
+
path: {
|
|
163
|
+
'mockServerId': mockServerId,
|
|
164
|
+
},
|
|
165
|
+
errors: {
|
|
166
|
+
401: `Missing, invalid, expired, or revoked token`,
|
|
167
|
+
403: `Token does not carry the required scope`,
|
|
168
|
+
404: `Resource not found (or not visible to the calling org)`,
|
|
169
|
+
},
|
|
170
|
+
});
|
|
171
|
+
}
|
|
97
172
|
/**
|
|
98
173
|
* Delete a mock server owned by the calling org
|
|
99
174
|
* Hard-deletes the mock server and removes its association with the parent API.
|
|
@@ -2,6 +2,7 @@
|
|
|
2
2
|
/* istanbul ignore file */
|
|
3
3
|
/* tslint:disable */
|
|
4
4
|
/* eslint-disable */
|
|
5
|
+
import type { OrgEntitlementsResponseV1 } from '../models/OrgEntitlementsResponseV1.js';
|
|
5
6
|
import type { OrgSummaryResponseV1 } from '../models/OrgSummaryResponseV1.js';
|
|
6
7
|
import type { CancelablePromise } from '../core/CancelablePromise.js';
|
|
7
8
|
import { OpenAPI } from '../core/OpenAPI.js';
|
|
@@ -25,4 +26,28 @@ export class PublicOrgsService {
|
|
|
25
26
|
},
|
|
26
27
|
});
|
|
27
28
|
}
|
|
29
|
+
/**
|
|
30
|
+
* The calling org's plan limits and current usage
|
|
31
|
+
* What the org's plan allows and how much of it is in use, so a client can tell
|
|
32
|
+
* someone they're at a limit before an action fails rather than after.
|
|
33
|
+
*
|
|
34
|
+
* Each feature carries the same `key` that a 402 names in its `feature` field. A
|
|
35
|
+
* `limit` of -1 means unlimited. `used` is counted the same way the limit is
|
|
36
|
+
* enforced, so `used >= limit` means the next create will be refused.
|
|
37
|
+
*
|
|
38
|
+
* Read-only; any member token with `read:apis` can call it.
|
|
39
|
+
*
|
|
40
|
+
* @returns OrgEntitlementsResponseV1 Plan and per-feature usage
|
|
41
|
+
* @throws ApiError
|
|
42
|
+
*/
|
|
43
|
+
public static getOrgEntitlements(): CancelablePromise<OrgEntitlementsResponseV1> {
|
|
44
|
+
return __request(OpenAPI, {
|
|
45
|
+
method: 'GET',
|
|
46
|
+
url: '/api/v1/public/orgs/entitlements',
|
|
47
|
+
errors: {
|
|
48
|
+
401: `Missing, invalid, expired, or revoked token`,
|
|
49
|
+
403: `Token does not carry the required scope`,
|
|
50
|
+
},
|
|
51
|
+
});
|
|
52
|
+
}
|
|
28
53
|
}
|