@redis-iris/agent-playbook 1.0.0 → 1.1.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.
Files changed (81) hide show
  1. package/README.md +5 -3
  2. package/dist/commonjs/controlplane/funcs/delete-extraction-binding.d.ts +3 -0
  3. package/dist/commonjs/controlplane/funcs/delete-extraction-binding.d.ts.map +1 -1
  4. package/dist/commonjs/controlplane/funcs/delete-extraction-binding.js +3 -0
  5. package/dist/commonjs/controlplane/funcs/delete-extraction-binding.js.map +1 -1
  6. package/dist/commonjs/controlplane/funcs/list-databases.d.ts +1 -1
  7. package/dist/commonjs/controlplane/funcs/list-databases.js +1 -1
  8. package/dist/commonjs/controlplane/lib/config.d.ts +2 -2
  9. package/dist/commonjs/controlplane/lib/config.js +2 -2
  10. package/dist/commonjs/controlplane/models/cloud-database.d.ts +5 -0
  11. package/dist/commonjs/controlplane/models/cloud-database.d.ts.map +1 -1
  12. package/dist/commonjs/controlplane/models/cloud-database.js +2 -0
  13. package/dist/commonjs/controlplane/models/cloud-database.js.map +1 -1
  14. package/dist/commonjs/controlplane/models/database-requirement-type.d.ts +27 -0
  15. package/dist/commonjs/controlplane/models/database-requirement-type.d.ts.map +1 -0
  16. package/dist/commonjs/controlplane/models/database-requirement-type.js +61 -0
  17. package/dist/commonjs/controlplane/models/database-requirement-type.js.map +1 -0
  18. package/dist/commonjs/controlplane/models/database-requirement.d.ts +33 -0
  19. package/dist/commonjs/controlplane/models/database-requirement.d.ts.map +1 -0
  20. package/dist/commonjs/controlplane/models/database-requirement.js +55 -0
  21. package/dist/commonjs/controlplane/models/database-requirement.js.map +1 -0
  22. package/dist/commonjs/controlplane/models/index.d.ts +2 -0
  23. package/dist/commonjs/controlplane/models/index.d.ts.map +1 -1
  24. package/dist/commonjs/controlplane/models/index.js +2 -0
  25. package/dist/commonjs/controlplane/models/index.js.map +1 -1
  26. package/dist/commonjs/controlplane/models/list-databases-response-content.d.ts +2 -0
  27. package/dist/commonjs/controlplane/models/list-databases-response-content.d.ts.map +1 -1
  28. package/dist/commonjs/controlplane/models/list-databases-response-content.js +2 -0
  29. package/dist/commonjs/controlplane/models/list-databases-response-content.js.map +1 -1
  30. package/dist/commonjs/controlplane/sdk/sdk.d.ts +4 -1
  31. package/dist/commonjs/controlplane/sdk/sdk.d.ts.map +1 -1
  32. package/dist/commonjs/controlplane/sdk/sdk.js +4 -1
  33. package/dist/commonjs/controlplane/sdk/sdk.js.map +1 -1
  34. package/dist/commonjs/lib/config.d.ts +2 -2
  35. package/dist/commonjs/lib/config.js +2 -2
  36. package/dist/esm/controlplane/funcs/delete-extraction-binding.d.ts +3 -0
  37. package/dist/esm/controlplane/funcs/delete-extraction-binding.d.ts.map +1 -1
  38. package/dist/esm/controlplane/funcs/delete-extraction-binding.js +3 -0
  39. package/dist/esm/controlplane/funcs/delete-extraction-binding.js.map +1 -1
  40. package/dist/esm/controlplane/funcs/list-databases.d.ts +1 -1
  41. package/dist/esm/controlplane/funcs/list-databases.js +1 -1
  42. package/dist/esm/controlplane/lib/config.d.ts +2 -2
  43. package/dist/esm/controlplane/lib/config.js +2 -2
  44. package/dist/esm/controlplane/models/cloud-database.d.ts +5 -0
  45. package/dist/esm/controlplane/models/cloud-database.d.ts.map +1 -1
  46. package/dist/esm/controlplane/models/cloud-database.js +2 -0
  47. package/dist/esm/controlplane/models/cloud-database.js.map +1 -1
  48. package/dist/esm/controlplane/models/database-requirement-type.d.ts +27 -0
  49. package/dist/esm/controlplane/models/database-requirement-type.d.ts.map +1 -0
  50. package/dist/esm/controlplane/models/database-requirement-type.js +25 -0
  51. package/dist/esm/controlplane/models/database-requirement-type.js.map +1 -0
  52. package/dist/esm/controlplane/models/database-requirement.d.ts +33 -0
  53. package/dist/esm/controlplane/models/database-requirement.d.ts.map +1 -0
  54. package/dist/esm/controlplane/models/database-requirement.js +18 -0
  55. package/dist/esm/controlplane/models/database-requirement.js.map +1 -0
  56. package/dist/esm/controlplane/models/index.d.ts +2 -0
  57. package/dist/esm/controlplane/models/index.d.ts.map +1 -1
  58. package/dist/esm/controlplane/models/index.js +2 -0
  59. package/dist/esm/controlplane/models/index.js.map +1 -1
  60. package/dist/esm/controlplane/models/list-databases-response-content.d.ts +2 -0
  61. package/dist/esm/controlplane/models/list-databases-response-content.d.ts.map +1 -1
  62. package/dist/esm/controlplane/models/list-databases-response-content.js +2 -0
  63. package/dist/esm/controlplane/models/list-databases-response-content.js.map +1 -1
  64. package/dist/esm/controlplane/sdk/sdk.d.ts +4 -1
  65. package/dist/esm/controlplane/sdk/sdk.d.ts.map +1 -1
  66. package/dist/esm/controlplane/sdk/sdk.js +4 -1
  67. package/dist/esm/controlplane/sdk/sdk.js.map +1 -1
  68. package/dist/esm/lib/config.d.ts +2 -2
  69. package/dist/esm/lib/config.js +2 -2
  70. package/jsr.json +1 -1
  71. package/package.json +1 -1
  72. package/src/controlplane/funcs/delete-extraction-binding.ts +3 -0
  73. package/src/controlplane/funcs/list-databases.ts +1 -1
  74. package/src/controlplane/lib/config.ts +2 -2
  75. package/src/controlplane/models/cloud-database.ts +9 -0
  76. package/src/controlplane/models/database-requirement-type.ts +37 -0
  77. package/src/controlplane/models/database-requirement.ts +61 -0
  78. package/src/controlplane/models/index.ts +2 -0
  79. package/src/controlplane/models/list-databases-response-content.ts +6 -0
  80. package/src/controlplane/sdk/sdk.ts +4 -1
  81. package/src/lib/config.ts +2 -2
@@ -0,0 +1,61 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { safeParse } from "../lib/schemas.js";
7
+ import { Result as SafeParseResult } from "../types/fp.js";
8
+ import {
9
+ DatabaseRequirementType,
10
+ DatabaseRequirementType$inboundSchema,
11
+ } from "./database-requirement-type.js";
12
+ import { SDKValidationError } from "./errors/sdk-validation-error.js";
13
+
14
+ /**
15
+ * One requirement and the parameters it checks. Members that do not apply to the type are absent.
16
+ */
17
+ export type DatabaseRequirement = {
18
+ /**
19
+ * A requirement a product places on a Redis Cloud database.
20
+ */
21
+ type: DatabaseRequirementType;
22
+ /**
23
+ * Accepted Redis Cloud database types, such as `Pro` or `Essentials`
24
+ */
25
+ databaseTypes?: Array<string> | undefined;
26
+ /**
27
+ * Lowest accepted version, inclusive
28
+ */
29
+ minVersion?: string | undefined;
30
+ /**
31
+ * Highest accepted version, inclusive
32
+ */
33
+ maxVersion?: string | undefined;
34
+ /**
35
+ * Accepted maxmemory policies
36
+ */
37
+ policies?: Array<string> | undefined;
38
+ };
39
+
40
+ /** @internal */
41
+ export const DatabaseRequirement$inboundSchema: z.ZodType<
42
+ DatabaseRequirement,
43
+ z.ZodTypeDef,
44
+ unknown
45
+ > = z.object({
46
+ type: DatabaseRequirementType$inboundSchema,
47
+ databaseTypes: z.array(z.string()).optional(),
48
+ minVersion: z.string().optional(),
49
+ maxVersion: z.string().optional(),
50
+ policies: z.array(z.string()).optional(),
51
+ });
52
+
53
+ export function databaseRequirementFromJSON(
54
+ jsonString: string,
55
+ ): SafeParseResult<DatabaseRequirement, SDKValidationError> {
56
+ return safeParse(
57
+ jsonString,
58
+ (x) => DatabaseRequirement$inboundSchema.parse(JSON.parse(x)),
59
+ `Failed to parse 'DatabaseRequirement' from JSON`,
60
+ );
61
+ }
@@ -13,6 +13,8 @@ export * from "./create-playbook-request-content.js";
13
13
  export * from "./create-playbook-response-content.js";
14
14
  export * from "./data-plane-endpoint.js";
15
15
  export * from "./database-binding.js";
16
+ export * from "./database-requirement-type.js";
17
+ export * from "./database-requirement.js";
16
18
  export * from "./delete-extraction-binding-response-content.js";
17
19
  export * from "./discovery-config-update.js";
18
20
  export * from "./discovery-config.js";
@@ -9,9 +9,14 @@ import {
9
9
  CloudDatabase,
10
10
  CloudDatabase$inboundSchema,
11
11
  } from "./cloud-database.js";
12
+ import {
13
+ DatabaseRequirement,
14
+ DatabaseRequirement$inboundSchema,
15
+ } from "./database-requirement.js";
12
16
  import { SDKValidationError } from "./errors/sdk-validation-error.js";
13
17
 
14
18
  export type ListDatabasesResponseContent = {
19
+ requirements: Array<DatabaseRequirement>;
15
20
  items: Array<CloudDatabase>;
16
21
  };
17
22
 
@@ -21,6 +26,7 @@ export const ListDatabasesResponseContent$inboundSchema: z.ZodType<
21
26
  z.ZodTypeDef,
22
27
  unknown
23
28
  > = z.object({
29
+ requirements: z.array(DatabaseRequirement$inboundSchema),
24
30
  items: z.array(CloudDatabase$inboundSchema),
25
31
  });
26
32
 
@@ -31,7 +31,7 @@ export class AgentPlaybooksService extends ClientSDK {
31
31
  * Cloud only: list account databases
32
32
  *
33
33
  * @remarks
34
- * Lists account databases using Playbook eligibility. Free plans remain visible even when ineligible or not ready. Requires JSESSIONID and X-CSRF-Token in addition to the operator JWT.
34
+ * Lists every account database with the requirements Playbook places on a database and the ones each database fails. Requires JSESSIONID and X-CSRF-Token in addition to the operator JWT.
35
35
  */
36
36
  async listDatabases(
37
37
  options?: RequestOptions,
@@ -230,6 +230,9 @@ export class AgentPlaybooksService extends ClientSDK {
230
230
  ));
231
231
  }
232
232
 
233
+ /**
234
+ * Disables and removes the owned binding and scheduling metadata before returning. The 202 response retains the final DELETING snapshot for compatibility; subsequent GET returns 404. Cleanup failures can be retried with the same binding ID, including an existing DELETING binding. An already removed or replaced binding returns 404 without affecting a replacement. No Agent Memory call or source permission is required.
235
+ */
233
236
  async deleteExtractionBinding(
234
237
  playbookId: string,
235
238
  bindingId: string,
package/src/lib/config.ts CHANGED
@@ -49,8 +49,8 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
49
49
  export const SDK_METADATA = {
50
50
  language: "typescript",
51
51
  openapiDocVersion: "1.0.0",
52
- sdkVersion: "1.0.0",
52
+ sdkVersion: "1.1.0",
53
53
  genVersion: "2.948.4",
54
54
  userAgent:
55
- "speakeasy-sdk/typescript 1.0.0 2.948.4 1.0.0 @redis-iris/agent-playbook",
55
+ "speakeasy-sdk/typescript 1.1.0 2.948.4 1.0.0 @redis-iris/agent-playbook",
56
56
  } as const;