@redis-iris/agent-playbook 0.1.0-alpha.4 → 0.1.0-beta.2
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/FUNCTIONS.md +12 -46
- package/README.md +135 -53
- package/RUNTIMES.md +1 -1
- package/dist/commonjs/controlplane/core.d.ts +1 -1
- package/dist/commonjs/controlplane/core.d.ts.map +1 -1
- package/dist/commonjs/controlplane/core.js +3 -3
- package/dist/commonjs/controlplane/core.js.map +1 -1
- package/dist/commonjs/controlplane/funcs/clear-playbook.d.ts +3 -3
- package/dist/commonjs/controlplane/funcs/clear-playbook.d.ts.map +1 -1
- package/dist/commonjs/controlplane/funcs/clear-playbook.js.map +1 -1
- package/dist/commonjs/controlplane/funcs/create-extraction-binding.d.ts +4 -4
- package/dist/commonjs/controlplane/funcs/create-extraction-binding.d.ts.map +1 -1
- package/dist/commonjs/controlplane/funcs/create-extraction-binding.js +1 -1
- package/dist/commonjs/controlplane/funcs/create-extraction-binding.js.map +1 -1
- package/dist/commonjs/controlplane/funcs/create-playbook.d.ts +3 -3
- package/dist/commonjs/controlplane/funcs/create-playbook.d.ts.map +1 -1
- package/dist/commonjs/controlplane/funcs/create-playbook.js.map +1 -1
- package/dist/commonjs/controlplane/funcs/delete-extraction-binding.d.ts +3 -3
- package/dist/commonjs/controlplane/funcs/delete-extraction-binding.d.ts.map +1 -1
- package/dist/commonjs/controlplane/funcs/delete-extraction-binding.js.map +1 -1
- package/dist/commonjs/controlplane/funcs/delete-model-credential.d.ts +3 -3
- package/dist/commonjs/controlplane/funcs/delete-model-credential.d.ts.map +1 -1
- package/dist/commonjs/controlplane/funcs/delete-model-credential.js.map +1 -1
- package/dist/commonjs/controlplane/funcs/delete-playbook.d.ts +3 -3
- package/dist/commonjs/controlplane/funcs/delete-playbook.d.ts.map +1 -1
- package/dist/commonjs/controlplane/funcs/delete-playbook.js.map +1 -1
- package/dist/commonjs/controlplane/funcs/get-extraction-binding.d.ts +3 -3
- package/dist/commonjs/controlplane/funcs/get-extraction-binding.d.ts.map +1 -1
- package/dist/commonjs/controlplane/funcs/get-extraction-binding.js.map +1 -1
- package/dist/commonjs/controlplane/funcs/get-model-credential.d.ts +3 -3
- package/dist/commonjs/controlplane/funcs/get-model-credential.d.ts.map +1 -1
- package/dist/commonjs/controlplane/funcs/get-model-credential.js.map +1 -1
- package/dist/commonjs/controlplane/funcs/get-network-info.d.ts +3 -3
- package/dist/commonjs/controlplane/funcs/get-network-info.d.ts.map +1 -1
- package/dist/commonjs/controlplane/funcs/get-network-info.js.map +1 -1
- package/dist/commonjs/controlplane/funcs/get-playbook.d.ts +4 -4
- package/dist/commonjs/controlplane/funcs/get-playbook.d.ts.map +1 -1
- package/dist/commonjs/controlplane/funcs/get-playbook.js +1 -1
- package/dist/commonjs/controlplane/funcs/get-playbook.js.map +1 -1
- package/dist/commonjs/controlplane/funcs/list-databases.d.ts +3 -3
- package/dist/commonjs/controlplane/funcs/list-databases.d.ts.map +1 -1
- package/dist/commonjs/controlplane/funcs/list-databases.js.map +1 -1
- package/dist/commonjs/controlplane/funcs/list-extraction-bindings.d.ts +3 -3
- package/dist/commonjs/controlplane/funcs/list-extraction-bindings.d.ts.map +1 -1
- package/dist/commonjs/controlplane/funcs/list-extraction-bindings.js.map +1 -1
- package/dist/commonjs/controlplane/funcs/list-extraction-stores.d.ts +4 -4
- package/dist/commonjs/controlplane/funcs/list-extraction-stores.d.ts.map +1 -1
- package/dist/commonjs/controlplane/funcs/list-extraction-stores.js +1 -1
- package/dist/commonjs/controlplane/funcs/list-extraction-stores.js.map +1 -1
- package/dist/commonjs/controlplane/funcs/list-models.d.ts +3 -3
- package/dist/commonjs/controlplane/funcs/list-models.d.ts.map +1 -1
- package/dist/commonjs/controlplane/funcs/list-models.js.map +1 -1
- package/dist/commonjs/controlplane/funcs/list-playbooks.d.ts +4 -4
- package/dist/commonjs/controlplane/funcs/list-playbooks.d.ts.map +1 -1
- package/dist/commonjs/controlplane/funcs/list-playbooks.js +1 -1
- package/dist/commonjs/controlplane/funcs/list-playbooks.js.map +1 -1
- package/dist/commonjs/controlplane/funcs/put-model-credential.d.ts +3 -3
- package/dist/commonjs/controlplane/funcs/put-model-credential.d.ts.map +1 -1
- package/dist/commonjs/controlplane/funcs/put-model-credential.js.map +1 -1
- package/dist/commonjs/controlplane/funcs/update-extraction-binding.d.ts +3 -3
- package/dist/commonjs/controlplane/funcs/update-extraction-binding.d.ts.map +1 -1
- package/dist/commonjs/controlplane/funcs/update-extraction-binding.js.map +1 -1
- package/dist/commonjs/controlplane/funcs/update-playbook.d.ts +3 -3
- package/dist/commonjs/controlplane/funcs/update-playbook.d.ts.map +1 -1
- package/dist/commonjs/controlplane/funcs/update-playbook.js.map +1 -1
- package/dist/commonjs/controlplane/lib/config.d.ts +2 -2
- package/dist/commonjs/controlplane/lib/config.js +2 -2
- package/dist/commonjs/controlplane/lib/config.js.map +1 -1
- package/dist/commonjs/controlplane/lib/env.d.ts +2 -2
- package/dist/commonjs/controlplane/lib/env.d.ts.map +1 -1
- package/dist/commonjs/controlplane/lib/env.js +8 -3
- package/dist/commonjs/controlplane/lib/env.js.map +1 -1
- package/dist/commonjs/controlplane/lib/sdks.js +1 -1
- package/dist/commonjs/controlplane/lib/sdks.js.map +1 -1
- package/dist/commonjs/controlplane/lib/security.js +1 -1
- package/dist/commonjs/controlplane/lib/security.js.map +1 -1
- package/dist/commonjs/controlplane/models/create-extraction-binding-request-content.d.ts +2 -2
- package/dist/commonjs/controlplane/models/create-extraction-binding-response-content.d.ts +4 -4
- package/dist/commonjs/controlplane/models/create-playbook-response-content.d.ts +3 -0
- package/dist/commonjs/controlplane/models/create-playbook-response-content.d.ts.map +1 -1
- package/dist/commonjs/controlplane/models/create-playbook-response-content.js.map +1 -1
- package/dist/commonjs/controlplane/models/delete-extraction-binding-response-content.d.ts +4 -4
- package/dist/commonjs/controlplane/models/errors/{playbook-service-error.d.ts → agent-playbooks-service-error.d.ts} +2 -2
- package/dist/commonjs/controlplane/models/errors/agent-playbooks-service-error.d.ts.map +1 -0
- package/dist/commonjs/controlplane/models/errors/{playbook-service-error.js → agent-playbooks-service-error.js} +5 -5
- package/dist/commonjs/controlplane/models/errors/agent-playbooks-service-error.js.map +1 -0
- package/dist/commonjs/controlplane/models/errors/api-error.d.ts +2 -2
- package/dist/commonjs/controlplane/models/errors/api-error.d.ts.map +1 -1
- package/dist/commonjs/controlplane/models/errors/api-error.js +2 -2
- package/dist/commonjs/controlplane/models/errors/api-error.js.map +1 -1
- package/dist/commonjs/controlplane/models/errors/authentication-error-response-content.d.ts +2 -2
- package/dist/commonjs/controlplane/models/errors/authentication-error-response-content.d.ts.map +1 -1
- package/dist/commonjs/controlplane/models/errors/authentication-error-response-content.js +2 -2
- package/dist/commonjs/controlplane/models/errors/authentication-error-response-content.js.map +1 -1
- package/dist/commonjs/controlplane/models/errors/bad-request-error-response-content.d.ts +2 -2
- package/dist/commonjs/controlplane/models/errors/bad-request-error-response-content.d.ts.map +1 -1
- package/dist/commonjs/controlplane/models/errors/bad-request-error-response-content.js +2 -2
- package/dist/commonjs/controlplane/models/errors/bad-request-error-response-content.js.map +1 -1
- package/dist/commonjs/controlplane/models/errors/conflict-error-response-content.d.ts +2 -2
- package/dist/commonjs/controlplane/models/errors/conflict-error-response-content.d.ts.map +1 -1
- package/dist/commonjs/controlplane/models/errors/conflict-error-response-content.js +2 -2
- package/dist/commonjs/controlplane/models/errors/conflict-error-response-content.js.map +1 -1
- package/dist/commonjs/controlplane/models/errors/extraction-conflict-error-response-content.d.ts +2 -2
- package/dist/commonjs/controlplane/models/errors/extraction-conflict-error-response-content.d.ts.map +1 -1
- package/dist/commonjs/controlplane/models/errors/extraction-conflict-error-response-content.js +2 -2
- package/dist/commonjs/controlplane/models/errors/extraction-conflict-error-response-content.js.map +1 -1
- package/dist/commonjs/controlplane/models/errors/extraction-forbidden-error-response-content.d.ts +2 -2
- package/dist/commonjs/controlplane/models/errors/extraction-forbidden-error-response-content.d.ts.map +1 -1
- package/dist/commonjs/controlplane/models/errors/extraction-forbidden-error-response-content.js +2 -2
- package/dist/commonjs/controlplane/models/errors/extraction-forbidden-error-response-content.js.map +1 -1
- package/dist/commonjs/controlplane/models/errors/failed-dependency-error-response-content.d.ts +2 -2
- package/dist/commonjs/controlplane/models/errors/failed-dependency-error-response-content.d.ts.map +1 -1
- package/dist/commonjs/controlplane/models/errors/failed-dependency-error-response-content.js +2 -2
- package/dist/commonjs/controlplane/models/errors/failed-dependency-error-response-content.js.map +1 -1
- package/dist/commonjs/controlplane/models/errors/index.d.ts +1 -1
- package/dist/commonjs/controlplane/models/errors/index.d.ts.map +1 -1
- package/dist/commonjs/controlplane/models/errors/index.js +1 -1
- package/dist/commonjs/controlplane/models/errors/index.js.map +1 -1
- package/dist/commonjs/controlplane/models/errors/not-found-error-response-content.d.ts +2 -2
- package/dist/commonjs/controlplane/models/errors/not-found-error-response-content.d.ts.map +1 -1
- package/dist/commonjs/controlplane/models/errors/not-found-error-response-content.js +2 -2
- package/dist/commonjs/controlplane/models/errors/not-found-error-response-content.js.map +1 -1
- package/dist/commonjs/controlplane/models/errors/playbook-service-unavailable-error-response-content.d.ts +2 -2
- package/dist/commonjs/controlplane/models/errors/playbook-service-unavailable-error-response-content.d.ts.map +1 -1
- package/dist/commonjs/controlplane/models/errors/playbook-service-unavailable-error-response-content.js +2 -2
- package/dist/commonjs/controlplane/models/errors/playbook-service-unavailable-error-response-content.js.map +1 -1
- package/dist/commonjs/controlplane/models/errors/resource-suspended-error-response-content.d.ts +2 -2
- package/dist/commonjs/controlplane/models/errors/resource-suspended-error-response-content.d.ts.map +1 -1
- package/dist/commonjs/controlplane/models/errors/resource-suspended-error-response-content.js +2 -2
- package/dist/commonjs/controlplane/models/errors/resource-suspended-error-response-content.js.map +1 -1
- package/dist/commonjs/controlplane/models/errors/response-validation-error.d.ts +2 -2
- package/dist/commonjs/controlplane/models/errors/response-validation-error.d.ts.map +1 -1
- package/dist/commonjs/controlplane/models/errors/response-validation-error.js +2 -2
- package/dist/commonjs/controlplane/models/errors/response-validation-error.js.map +1 -1
- package/dist/commonjs/controlplane/models/errors/timeout-error-response-content.d.ts +2 -2
- package/dist/commonjs/controlplane/models/errors/timeout-error-response-content.d.ts.map +1 -1
- package/dist/commonjs/controlplane/models/errors/timeout-error-response-content.js +2 -2
- package/dist/commonjs/controlplane/models/errors/timeout-error-response-content.js.map +1 -1
- package/dist/commonjs/controlplane/models/errors/unexpected-error-response-content.d.ts +2 -2
- package/dist/commonjs/controlplane/models/errors/unexpected-error-response-content.d.ts.map +1 -1
- package/dist/commonjs/controlplane/models/errors/unexpected-error-response-content.js +2 -2
- package/dist/commonjs/controlplane/models/errors/unexpected-error-response-content.js.map +1 -1
- package/dist/commonjs/controlplane/models/extraction-binding-source.d.ts +1 -1
- package/dist/commonjs/controlplane/models/extraction-binding-status.d.ts +0 -1
- package/dist/commonjs/controlplane/models/extraction-binding-status.d.ts.map +1 -1
- package/dist/commonjs/controlplane/models/extraction-binding-status.js +0 -1
- package/dist/commonjs/controlplane/models/extraction-binding-status.js.map +1 -1
- package/dist/commonjs/controlplane/models/extraction-binding.d.ts +4 -4
- package/dist/commonjs/controlplane/models/extraction-job-configuration.d.ts +1 -1
- package/dist/commonjs/controlplane/models/extraction-job.d.ts +0 -4
- package/dist/commonjs/controlplane/models/extraction-job.d.ts.map +1 -1
- package/dist/commonjs/controlplane/models/extraction-job.js +0 -1
- package/dist/commonjs/controlplane/models/extraction-job.js.map +1 -1
- package/dist/commonjs/controlplane/models/get-extraction-binding-response-content.d.ts +4 -4
- package/dist/commonjs/controlplane/models/get-playbook-response-content.d.ts +3 -0
- package/dist/commonjs/controlplane/models/get-playbook-response-content.d.ts.map +1 -1
- package/dist/commonjs/controlplane/models/get-playbook-response-content.js.map +1 -1
- package/dist/commonjs/controlplane/models/playbook-state.d.ts +7 -0
- package/dist/commonjs/controlplane/models/playbook-state.d.ts.map +1 -1
- package/dist/commonjs/controlplane/models/playbook-state.js +4 -0
- package/dist/commonjs/controlplane/models/playbook-state.js.map +1 -1
- package/dist/commonjs/controlplane/models/playbook.d.ts +3 -0
- package/dist/commonjs/controlplane/models/playbook.d.ts.map +1 -1
- package/dist/commonjs/controlplane/models/playbook.js.map +1 -1
- package/dist/commonjs/controlplane/models/update-extraction-binding-request-content.d.ts +1 -1
- package/dist/commonjs/controlplane/models/update-extraction-binding-response-content.d.ts +4 -4
- package/dist/commonjs/controlplane/models/update-playbook-response-content.d.ts +3 -0
- package/dist/commonjs/controlplane/models/update-playbook-response-content.d.ts.map +1 -1
- package/dist/commonjs/controlplane/models/update-playbook-response-content.js.map +1 -1
- package/dist/commonjs/controlplane/sdk/sdk.d.ts +5 -5
- package/dist/commonjs/controlplane/sdk/sdk.d.ts.map +1 -1
- package/dist/commonjs/controlplane/sdk/sdk.js +7 -7
- package/dist/commonjs/controlplane/sdk/sdk.js.map +1 -1
- package/dist/commonjs/index.d.ts +2 -2
- package/dist/commonjs/index.d.ts.map +1 -1
- package/dist/commonjs/index.js +2 -2
- package/dist/commonjs/index.js.map +1 -1
- package/dist/commonjs/lib/config.d.ts +2 -2
- package/dist/commonjs/lib/config.js +2 -2
- package/dist/commonjs/lib/config.js.map +1 -1
- package/dist/commonjs/lib/env.d.ts +3 -3
- package/dist/commonjs/lib/env.d.ts.map +1 -1
- package/dist/commonjs/lib/env.js +12 -6
- package/dist/commonjs/lib/env.js.map +1 -1
- package/dist/commonjs/lib/sdks.js +1 -1
- package/dist/commonjs/lib/sdks.js.map +1 -1
- package/dist/commonjs/lib/security.js +1 -1
- package/dist/commonjs/lib/security.js.map +1 -1
- package/dist/esm/controlplane/core.d.ts +1 -1
- package/dist/esm/controlplane/core.d.ts.map +1 -1
- package/dist/esm/controlplane/core.js +1 -1
- package/dist/esm/controlplane/core.js.map +1 -1
- package/dist/esm/controlplane/funcs/clear-playbook.d.ts +3 -3
- package/dist/esm/controlplane/funcs/clear-playbook.d.ts.map +1 -1
- package/dist/esm/controlplane/funcs/clear-playbook.js.map +1 -1
- package/dist/esm/controlplane/funcs/create-extraction-binding.d.ts +4 -4
- package/dist/esm/controlplane/funcs/create-extraction-binding.d.ts.map +1 -1
- package/dist/esm/controlplane/funcs/create-extraction-binding.js +1 -1
- package/dist/esm/controlplane/funcs/create-extraction-binding.js.map +1 -1
- package/dist/esm/controlplane/funcs/create-playbook.d.ts +3 -3
- package/dist/esm/controlplane/funcs/create-playbook.d.ts.map +1 -1
- package/dist/esm/controlplane/funcs/create-playbook.js.map +1 -1
- package/dist/esm/controlplane/funcs/delete-extraction-binding.d.ts +3 -3
- package/dist/esm/controlplane/funcs/delete-extraction-binding.d.ts.map +1 -1
- package/dist/esm/controlplane/funcs/delete-extraction-binding.js.map +1 -1
- package/dist/esm/controlplane/funcs/delete-model-credential.d.ts +3 -3
- package/dist/esm/controlplane/funcs/delete-model-credential.d.ts.map +1 -1
- package/dist/esm/controlplane/funcs/delete-model-credential.js.map +1 -1
- package/dist/esm/controlplane/funcs/delete-playbook.d.ts +3 -3
- package/dist/esm/controlplane/funcs/delete-playbook.d.ts.map +1 -1
- package/dist/esm/controlplane/funcs/delete-playbook.js.map +1 -1
- package/dist/esm/controlplane/funcs/get-extraction-binding.d.ts +3 -3
- package/dist/esm/controlplane/funcs/get-extraction-binding.d.ts.map +1 -1
- package/dist/esm/controlplane/funcs/get-extraction-binding.js.map +1 -1
- package/dist/esm/controlplane/funcs/get-model-credential.d.ts +3 -3
- package/dist/esm/controlplane/funcs/get-model-credential.d.ts.map +1 -1
- package/dist/esm/controlplane/funcs/get-model-credential.js.map +1 -1
- package/dist/esm/controlplane/funcs/get-network-info.d.ts +3 -3
- package/dist/esm/controlplane/funcs/get-network-info.d.ts.map +1 -1
- package/dist/esm/controlplane/funcs/get-network-info.js.map +1 -1
- package/dist/esm/controlplane/funcs/get-playbook.d.ts +4 -4
- package/dist/esm/controlplane/funcs/get-playbook.d.ts.map +1 -1
- package/dist/esm/controlplane/funcs/get-playbook.js +1 -1
- package/dist/esm/controlplane/funcs/get-playbook.js.map +1 -1
- package/dist/esm/controlplane/funcs/list-databases.d.ts +3 -3
- package/dist/esm/controlplane/funcs/list-databases.d.ts.map +1 -1
- package/dist/esm/controlplane/funcs/list-databases.js.map +1 -1
- package/dist/esm/controlplane/funcs/list-extraction-bindings.d.ts +3 -3
- package/dist/esm/controlplane/funcs/list-extraction-bindings.d.ts.map +1 -1
- package/dist/esm/controlplane/funcs/list-extraction-bindings.js.map +1 -1
- package/dist/esm/controlplane/funcs/list-extraction-stores.d.ts +4 -4
- package/dist/esm/controlplane/funcs/list-extraction-stores.d.ts.map +1 -1
- package/dist/esm/controlplane/funcs/list-extraction-stores.js +1 -1
- package/dist/esm/controlplane/funcs/list-extraction-stores.js.map +1 -1
- package/dist/esm/controlplane/funcs/list-models.d.ts +3 -3
- package/dist/esm/controlplane/funcs/list-models.d.ts.map +1 -1
- package/dist/esm/controlplane/funcs/list-models.js.map +1 -1
- package/dist/esm/controlplane/funcs/list-playbooks.d.ts +4 -4
- package/dist/esm/controlplane/funcs/list-playbooks.d.ts.map +1 -1
- package/dist/esm/controlplane/funcs/list-playbooks.js +1 -1
- package/dist/esm/controlplane/funcs/list-playbooks.js.map +1 -1
- package/dist/esm/controlplane/funcs/put-model-credential.d.ts +3 -3
- package/dist/esm/controlplane/funcs/put-model-credential.d.ts.map +1 -1
- package/dist/esm/controlplane/funcs/put-model-credential.js.map +1 -1
- package/dist/esm/controlplane/funcs/update-extraction-binding.d.ts +3 -3
- package/dist/esm/controlplane/funcs/update-extraction-binding.d.ts.map +1 -1
- package/dist/esm/controlplane/funcs/update-extraction-binding.js.map +1 -1
- package/dist/esm/controlplane/funcs/update-playbook.d.ts +3 -3
- package/dist/esm/controlplane/funcs/update-playbook.d.ts.map +1 -1
- package/dist/esm/controlplane/funcs/update-playbook.js.map +1 -1
- package/dist/esm/controlplane/lib/config.d.ts +2 -2
- package/dist/esm/controlplane/lib/config.js +2 -2
- package/dist/esm/controlplane/lib/config.js.map +1 -1
- package/dist/esm/controlplane/lib/env.d.ts +2 -2
- package/dist/esm/controlplane/lib/env.d.ts.map +1 -1
- package/dist/esm/controlplane/lib/env.js +8 -3
- package/dist/esm/controlplane/lib/env.js.map +1 -1
- package/dist/esm/controlplane/lib/sdks.js +1 -1
- package/dist/esm/controlplane/lib/sdks.js.map +1 -1
- package/dist/esm/controlplane/lib/security.js +1 -1
- package/dist/esm/controlplane/lib/security.js.map +1 -1
- package/dist/esm/controlplane/models/create-extraction-binding-request-content.d.ts +2 -2
- package/dist/esm/controlplane/models/create-extraction-binding-response-content.d.ts +4 -4
- package/dist/esm/controlplane/models/create-playbook-response-content.d.ts +3 -0
- package/dist/esm/controlplane/models/create-playbook-response-content.d.ts.map +1 -1
- package/dist/esm/controlplane/models/create-playbook-response-content.js.map +1 -1
- package/dist/esm/controlplane/models/delete-extraction-binding-response-content.d.ts +4 -4
- package/dist/esm/controlplane/models/errors/{playbook-service-error.d.ts → agent-playbooks-service-error.d.ts} +2 -2
- package/dist/esm/controlplane/models/errors/agent-playbooks-service-error.d.ts.map +1 -0
- package/dist/esm/controlplane/models/errors/{playbook-service-error.js → agent-playbooks-service-error.js} +3 -3
- package/dist/esm/controlplane/models/errors/agent-playbooks-service-error.js.map +1 -0
- package/dist/esm/controlplane/models/errors/api-error.d.ts +2 -2
- package/dist/esm/controlplane/models/errors/api-error.d.ts.map +1 -1
- package/dist/esm/controlplane/models/errors/api-error.js +2 -2
- package/dist/esm/controlplane/models/errors/api-error.js.map +1 -1
- package/dist/esm/controlplane/models/errors/authentication-error-response-content.d.ts +2 -2
- package/dist/esm/controlplane/models/errors/authentication-error-response-content.d.ts.map +1 -1
- package/dist/esm/controlplane/models/errors/authentication-error-response-content.js +2 -2
- package/dist/esm/controlplane/models/errors/authentication-error-response-content.js.map +1 -1
- package/dist/esm/controlplane/models/errors/bad-request-error-response-content.d.ts +2 -2
- package/dist/esm/controlplane/models/errors/bad-request-error-response-content.d.ts.map +1 -1
- package/dist/esm/controlplane/models/errors/bad-request-error-response-content.js +2 -2
- package/dist/esm/controlplane/models/errors/bad-request-error-response-content.js.map +1 -1
- package/dist/esm/controlplane/models/errors/conflict-error-response-content.d.ts +2 -2
- package/dist/esm/controlplane/models/errors/conflict-error-response-content.d.ts.map +1 -1
- package/dist/esm/controlplane/models/errors/conflict-error-response-content.js +2 -2
- package/dist/esm/controlplane/models/errors/conflict-error-response-content.js.map +1 -1
- package/dist/esm/controlplane/models/errors/extraction-conflict-error-response-content.d.ts +2 -2
- package/dist/esm/controlplane/models/errors/extraction-conflict-error-response-content.d.ts.map +1 -1
- package/dist/esm/controlplane/models/errors/extraction-conflict-error-response-content.js +2 -2
- package/dist/esm/controlplane/models/errors/extraction-conflict-error-response-content.js.map +1 -1
- package/dist/esm/controlplane/models/errors/extraction-forbidden-error-response-content.d.ts +2 -2
- package/dist/esm/controlplane/models/errors/extraction-forbidden-error-response-content.d.ts.map +1 -1
- package/dist/esm/controlplane/models/errors/extraction-forbidden-error-response-content.js +2 -2
- package/dist/esm/controlplane/models/errors/extraction-forbidden-error-response-content.js.map +1 -1
- package/dist/esm/controlplane/models/errors/failed-dependency-error-response-content.d.ts +2 -2
- package/dist/esm/controlplane/models/errors/failed-dependency-error-response-content.d.ts.map +1 -1
- package/dist/esm/controlplane/models/errors/failed-dependency-error-response-content.js +2 -2
- package/dist/esm/controlplane/models/errors/failed-dependency-error-response-content.js.map +1 -1
- package/dist/esm/controlplane/models/errors/index.d.ts +1 -1
- package/dist/esm/controlplane/models/errors/index.d.ts.map +1 -1
- package/dist/esm/controlplane/models/errors/index.js +1 -1
- package/dist/esm/controlplane/models/errors/index.js.map +1 -1
- package/dist/esm/controlplane/models/errors/not-found-error-response-content.d.ts +2 -2
- package/dist/esm/controlplane/models/errors/not-found-error-response-content.d.ts.map +1 -1
- package/dist/esm/controlplane/models/errors/not-found-error-response-content.js +2 -2
- package/dist/esm/controlplane/models/errors/not-found-error-response-content.js.map +1 -1
- package/dist/esm/controlplane/models/errors/playbook-service-unavailable-error-response-content.d.ts +2 -2
- package/dist/esm/controlplane/models/errors/playbook-service-unavailable-error-response-content.d.ts.map +1 -1
- package/dist/esm/controlplane/models/errors/playbook-service-unavailable-error-response-content.js +2 -2
- package/dist/esm/controlplane/models/errors/playbook-service-unavailable-error-response-content.js.map +1 -1
- package/dist/esm/controlplane/models/errors/resource-suspended-error-response-content.d.ts +2 -2
- package/dist/esm/controlplane/models/errors/resource-suspended-error-response-content.d.ts.map +1 -1
- package/dist/esm/controlplane/models/errors/resource-suspended-error-response-content.js +2 -2
- package/dist/esm/controlplane/models/errors/resource-suspended-error-response-content.js.map +1 -1
- package/dist/esm/controlplane/models/errors/response-validation-error.d.ts +2 -2
- package/dist/esm/controlplane/models/errors/response-validation-error.d.ts.map +1 -1
- package/dist/esm/controlplane/models/errors/response-validation-error.js +2 -2
- package/dist/esm/controlplane/models/errors/response-validation-error.js.map +1 -1
- package/dist/esm/controlplane/models/errors/timeout-error-response-content.d.ts +2 -2
- package/dist/esm/controlplane/models/errors/timeout-error-response-content.d.ts.map +1 -1
- package/dist/esm/controlplane/models/errors/timeout-error-response-content.js +2 -2
- package/dist/esm/controlplane/models/errors/timeout-error-response-content.js.map +1 -1
- package/dist/esm/controlplane/models/errors/unexpected-error-response-content.d.ts +2 -2
- package/dist/esm/controlplane/models/errors/unexpected-error-response-content.d.ts.map +1 -1
- package/dist/esm/controlplane/models/errors/unexpected-error-response-content.js +2 -2
- package/dist/esm/controlplane/models/errors/unexpected-error-response-content.js.map +1 -1
- package/dist/esm/controlplane/models/extraction-binding-source.d.ts +1 -1
- package/dist/esm/controlplane/models/extraction-binding-status.d.ts +0 -1
- package/dist/esm/controlplane/models/extraction-binding-status.d.ts.map +1 -1
- package/dist/esm/controlplane/models/extraction-binding-status.js +0 -1
- package/dist/esm/controlplane/models/extraction-binding-status.js.map +1 -1
- package/dist/esm/controlplane/models/extraction-binding.d.ts +4 -4
- package/dist/esm/controlplane/models/extraction-job-configuration.d.ts +1 -1
- package/dist/esm/controlplane/models/extraction-job.d.ts +0 -4
- package/dist/esm/controlplane/models/extraction-job.d.ts.map +1 -1
- package/dist/esm/controlplane/models/extraction-job.js +0 -1
- package/dist/esm/controlplane/models/extraction-job.js.map +1 -1
- package/dist/esm/controlplane/models/get-extraction-binding-response-content.d.ts +4 -4
- package/dist/esm/controlplane/models/get-playbook-response-content.d.ts +3 -0
- package/dist/esm/controlplane/models/get-playbook-response-content.d.ts.map +1 -1
- package/dist/esm/controlplane/models/get-playbook-response-content.js.map +1 -1
- package/dist/esm/controlplane/models/playbook-state.d.ts +7 -0
- package/dist/esm/controlplane/models/playbook-state.d.ts.map +1 -1
- package/dist/esm/controlplane/models/playbook-state.js +4 -0
- package/dist/esm/controlplane/models/playbook-state.js.map +1 -1
- package/dist/esm/controlplane/models/playbook.d.ts +3 -0
- package/dist/esm/controlplane/models/playbook.d.ts.map +1 -1
- package/dist/esm/controlplane/models/playbook.js.map +1 -1
- package/dist/esm/controlplane/models/update-extraction-binding-request-content.d.ts +1 -1
- package/dist/esm/controlplane/models/update-extraction-binding-response-content.d.ts +4 -4
- package/dist/esm/controlplane/models/update-playbook-response-content.d.ts +3 -0
- package/dist/esm/controlplane/models/update-playbook-response-content.d.ts.map +1 -1
- package/dist/esm/controlplane/models/update-playbook-response-content.js.map +1 -1
- package/dist/esm/controlplane/sdk/sdk.d.ts +5 -5
- package/dist/esm/controlplane/sdk/sdk.d.ts.map +1 -1
- package/dist/esm/controlplane/sdk/sdk.js +5 -5
- package/dist/esm/controlplane/sdk/sdk.js.map +1 -1
- package/dist/esm/index.d.ts +2 -2
- package/dist/esm/index.d.ts.map +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/esm/index.js.map +1 -1
- package/dist/esm/lib/config.d.ts +2 -2
- package/dist/esm/lib/config.js +2 -2
- package/dist/esm/lib/config.js.map +1 -1
- package/dist/esm/lib/env.d.ts +3 -3
- package/dist/esm/lib/env.d.ts.map +1 -1
- package/dist/esm/lib/env.js +12 -6
- package/dist/esm/lib/env.js.map +1 -1
- package/dist/esm/lib/sdks.js +1 -1
- package/dist/esm/lib/sdks.js.map +1 -1
- package/dist/esm/lib/security.js +1 -1
- package/dist/esm/lib/security.js.map +1 -1
- package/jsr.json +1 -1
- package/package.json +3 -3
- package/src/controlplane/core.ts +1 -1
- package/src/controlplane/funcs/clear-playbook.ts +7 -7
- package/src/controlplane/funcs/create-extraction-binding.ts +8 -8
- package/src/controlplane/funcs/create-playbook.ts +7 -7
- package/src/controlplane/funcs/delete-extraction-binding.ts +7 -7
- package/src/controlplane/funcs/delete-model-credential.ts +7 -7
- package/src/controlplane/funcs/delete-playbook.ts +7 -7
- package/src/controlplane/funcs/get-extraction-binding.ts +7 -7
- package/src/controlplane/funcs/get-model-credential.ts +7 -7
- package/src/controlplane/funcs/get-network-info.ts +7 -7
- package/src/controlplane/funcs/get-playbook.ts +8 -8
- package/src/controlplane/funcs/list-databases.ts +7 -7
- package/src/controlplane/funcs/list-extraction-bindings.ts +7 -7
- package/src/controlplane/funcs/list-extraction-stores.ts +8 -8
- package/src/controlplane/funcs/list-models.ts +7 -7
- package/src/controlplane/funcs/list-playbooks.ts +8 -8
- package/src/controlplane/funcs/put-model-credential.ts +7 -7
- package/src/controlplane/funcs/update-extraction-binding.ts +7 -7
- package/src/controlplane/funcs/update-playbook.ts +7 -7
- package/src/controlplane/lib/config.ts +2 -2
- package/src/controlplane/lib/env.ts +10 -5
- package/src/controlplane/lib/sdks.ts +1 -1
- package/src/controlplane/lib/security.ts +1 -1
- package/src/controlplane/models/create-extraction-binding-request-content.ts +2 -2
- package/src/controlplane/models/create-extraction-binding-response-content.ts +4 -4
- package/src/controlplane/models/create-playbook-response-content.ts +3 -0
- package/src/controlplane/models/delete-extraction-binding-response-content.ts +4 -4
- package/src/controlplane/models/errors/{playbook-service-error.ts → agent-playbooks-service-error.ts} +2 -2
- package/src/controlplane/models/errors/api-error.ts +2 -2
- package/src/controlplane/models/errors/authentication-error-response-content.ts +4 -2
- package/src/controlplane/models/errors/bad-request-error-response-content.ts +2 -2
- package/src/controlplane/models/errors/conflict-error-response-content.ts +2 -2
- package/src/controlplane/models/errors/extraction-conflict-error-response-content.ts +2 -2
- package/src/controlplane/models/errors/extraction-forbidden-error-response-content.ts +2 -2
- package/src/controlplane/models/errors/failed-dependency-error-response-content.ts +4 -2
- package/src/controlplane/models/errors/index.ts +1 -1
- package/src/controlplane/models/errors/not-found-error-response-content.ts +2 -2
- package/src/controlplane/models/errors/playbook-service-unavailable-error-response-content.ts +2 -2
- package/src/controlplane/models/errors/resource-suspended-error-response-content.ts +2 -2
- package/src/controlplane/models/errors/response-validation-error.ts +2 -2
- package/src/controlplane/models/errors/timeout-error-response-content.ts +2 -2
- package/src/controlplane/models/errors/unexpected-error-response-content.ts +2 -2
- package/src/controlplane/models/extraction-binding-source.ts +1 -1
- package/src/controlplane/models/extraction-binding-status.ts +0 -1
- package/src/controlplane/models/extraction-binding.ts +4 -4
- package/src/controlplane/models/extraction-job-configuration.ts +1 -1
- package/src/controlplane/models/extraction-job.ts +0 -5
- package/src/controlplane/models/get-extraction-binding-response-content.ts +4 -4
- package/src/controlplane/models/get-playbook-response-content.ts +3 -0
- package/src/controlplane/models/playbook-state.ts +7 -0
- package/src/controlplane/models/playbook.ts +3 -0
- package/src/controlplane/models/update-extraction-binding-request-content.ts +1 -1
- package/src/controlplane/models/update-extraction-binding-response-content.ts +4 -4
- package/src/controlplane/models/update-playbook-response-content.ts +3 -0
- package/src/controlplane/sdk/sdk.ts +5 -5
- package/src/index.ts +2 -2
- package/src/lib/config.ts +2 -2
- package/src/lib/env.ts +15 -9
- package/src/lib/sdks.ts +1 -1
- package/src/lib/security.ts +1 -1
- package/dist/commonjs/controlplane/models/errors/playbook-service-error.d.ts.map +0 -1
- package/dist/commonjs/controlplane/models/errors/playbook-service-error.js.map +0 -1
- package/dist/esm/controlplane/models/errors/playbook-service-error.d.ts.map +0 -1
- package/dist/esm/controlplane/models/errors/playbook-service-error.js.map +0 -1
package/FUNCTIONS.md
CHANGED
|
@@ -1,9 +1,5 @@
|
|
|
1
1
|
# Standalone Functions
|
|
2
2
|
|
|
3
|
-
> [!NOTE]
|
|
4
|
-
> This section is useful if you are using a bundler and targeting browsers and
|
|
5
|
-
> runtimes where the size of an application affects performance and load times.
|
|
6
|
-
|
|
7
3
|
Every method in this SDK is also available as a standalone function. This
|
|
8
4
|
alternative API is suitable when targeting the browser or serverless runtimes
|
|
9
5
|
and using a bundler to build your application since all unused functionality
|
|
@@ -13,7 +9,7 @@ impact on the application's final bundle size which grows very slowly as you use
|
|
|
13
9
|
more and more functionality from this SDK.
|
|
14
10
|
|
|
15
11
|
Calling methods through the main SDK class remains a valid and generally more
|
|
16
|
-
|
|
12
|
+
ergonomic option. Standalone functions represent an optimisation for a
|
|
17
13
|
specific category of applications.
|
|
18
14
|
|
|
19
15
|
## Example
|
|
@@ -27,7 +23,7 @@ import { discoverEntries } from "@redis-iris/agent-playbook/funcs/discover-entri
|
|
|
27
23
|
const playbook = new PlaybookCore({
|
|
28
24
|
serverURL: "https://api.example.com",
|
|
29
25
|
playbookId: "<id>",
|
|
30
|
-
apiKey: "<
|
|
26
|
+
apiKey: "<AGENT_PLAYBOOKS_API_KEY>",
|
|
31
27
|
});
|
|
32
28
|
|
|
33
29
|
async function run() {
|
|
@@ -59,45 +55,15 @@ run();
|
|
|
59
55
|
|
|
60
56
|
## Result types
|
|
61
57
|
|
|
62
|
-
Standalone functions
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
code.
|
|
67
|
-
|
|
68
|
-
> We use the term "known errors" because standalone functions, and JavaScript
|
|
69
|
-
> code in general, can still throw unexpected errors such as `TypeError`s,
|
|
70
|
-
> `RangeError`s and `DOMException`s. Exhaustively catching all errors may be
|
|
71
|
-
> something this SDK addresses in the future. Nevertheless, there is still a lot
|
|
72
|
-
> of benefit from capturing most errors and turning them into values.
|
|
73
|
-
|
|
74
|
-
The second reason for this style of programming is because these functions will
|
|
75
|
-
typically be used in front-end applications where exception throwing is
|
|
76
|
-
sometimes discouraged or considered unidiomatic. React and similar ecosystems
|
|
77
|
-
and libraries tend to promote this style of programming so that components
|
|
78
|
-
render useful content under all states (loading, success, error and so on).
|
|
79
|
-
|
|
80
|
-
The general pattern when calling standalone functions looks like this:
|
|
81
|
-
|
|
82
|
-
```typescript
|
|
83
|
-
import { Core } from "<sdk-package-name>";
|
|
84
|
-
import { fetchSomething } from "<sdk-package-name>/funcs/fetchSomething.js";
|
|
85
|
-
|
|
86
|
-
const client = new Core();
|
|
58
|
+
Standalone functions return a `Result<Value, Error>` for known API, validation,
|
|
59
|
+
and transport failures. Check `result.ok` before reading `result.value` or
|
|
60
|
+
`result.error`. Unexpected failures, such as exceptions from caller-provided
|
|
61
|
+
code, can still throw.
|
|
87
62
|
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
throw result.error;
|
|
93
|
-
}
|
|
94
|
-
|
|
95
|
-
console.log(result.value);
|
|
96
|
-
}
|
|
97
|
-
|
|
98
|
-
run();
|
|
99
|
-
```
|
|
63
|
+
Use `PlaybookCore` for data-plane functions and `AgentPlaybooksServiceCore` from
|
|
64
|
+
`@redis-iris/agent-playbook/controlplane/core.js` for control-plane functions.
|
|
65
|
+
Their credentials and model namespaces are independent. A control-plane example
|
|
66
|
+
is included in the [control-plane reference](docs/controlplane/README.md#standalone-functions).
|
|
100
67
|
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
`any` depending on your TypeScript settings).
|
|
68
|
+
The package release tests cover Node.js 20, 22, and 24. Browser, Bun, Deno, and
|
|
69
|
+
serverless runtime compatibility has not been validated.
|
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @redis-iris/agent-playbook
|
|
2
2
|
|
|
3
|
-
TypeScript SDK for Redis
|
|
3
|
+
TypeScript SDK for Redis AgentPlaybooks: manage Playbooks and author, publish, and retrieve FAQs and Skills.
|
|
4
4
|
|
|
5
5
|
[](https://www.speakeasy.com/?utm_source=@redis-iris/agent-playbook&utm_campaign=typescript)
|
|
6
6
|
[](https://opensource.org/licenses/MIT)
|
|
@@ -9,7 +9,7 @@ TypeScript SDK for Redis Agent Playbook: manage Playbooks and author, publish, a
|
|
|
9
9
|
<!-- Start Summary [summary] -->
|
|
10
10
|
## Summary
|
|
11
11
|
|
|
12
|
-
Redis
|
|
12
|
+
Redis AgentPlaybooks: Public type-specific FAQ and Skill authoring, publication, and exact-version API.
|
|
13
13
|
|
|
14
14
|
For more information about the API: [Redis AI documentation](https://redis.io/docs/latest/develop/ai/)
|
|
15
15
|
<!-- End Summary [summary] -->
|
|
@@ -25,32 +25,58 @@ For more information about the API: [Redis AI documentation](https://redis.io/do
|
|
|
25
25
|
broader product context; [npm](https://www.npmjs.com/package/@redis-iris/agent-playbook)
|
|
26
26
|
lists published package versions.
|
|
27
27
|
|
|
28
|
-
|
|
29
|
-
|
|
28
|
+
The examples and workflows on this page form the Playbook SDK guide. The Redis AI
|
|
29
|
+
documentation provides broader product context.
|
|
30
30
|
|
|
31
31
|
## Two clients, one package
|
|
32
32
|
|
|
33
|
-
|
|
33
|
+
AgentPlaybooks is the product; a Playbook is one instance managed by a user or operator.
|
|
34
|
+
|
|
35
|
+
`AgentPlaybooksService` manages Playbook resources on the control plane. `Playbook`
|
|
34
36
|
performs content operations against one Playbook on the data plane. Each client
|
|
35
37
|
has its own endpoint, credential, timeout, retry configuration, and HTTP transport.
|
|
36
38
|
|
|
37
39
|
```typescript
|
|
38
|
-
import { Playbook,
|
|
40
|
+
import { Playbook, AgentPlaybooksService } from "@redis-iris/agent-playbook";
|
|
39
41
|
|
|
40
|
-
const service = new
|
|
41
|
-
serverURL: process.env["
|
|
42
|
-
token: process.env["
|
|
42
|
+
const service = new AgentPlaybooksService({
|
|
43
|
+
serverURL: process.env["AGENT_PLAYBOOKS_CONTROL_PLANE_URL"]!,
|
|
44
|
+
token: process.env["AGENT_PLAYBOOKS_SERVICE_TOKEN"]!,
|
|
43
45
|
});
|
|
44
|
-
const
|
|
46
|
+
const instance = await service.getPlaybook(process.env["AGENT_PLAYBOOKS_PLAYBOOK_ID"]!);
|
|
45
47
|
const playbook = new Playbook({
|
|
46
|
-
serverURL: process.env["
|
|
47
|
-
apiKey: process.env["
|
|
48
|
-
playbookId:
|
|
48
|
+
serverURL: process.env["AGENT_PLAYBOOKS_DATA_PLANE_URL"]!,
|
|
49
|
+
apiKey: process.env["AGENT_PLAYBOOKS_API_KEY"]!,
|
|
50
|
+
playbookId: instance.playbookId,
|
|
49
51
|
});
|
|
50
52
|
const faqs = await playbook.listFaqs();
|
|
51
53
|
console.log(faqs);
|
|
52
54
|
```
|
|
53
55
|
|
|
56
|
+
Set these connection values before running the example:
|
|
57
|
+
|
|
58
|
+
| Variable | Value |
|
|
59
|
+
| --- | --- |
|
|
60
|
+
| `AGENT_PLAYBOOKS_CONTROL_PLANE_URL` | Your deployment's control-plane endpoint |
|
|
61
|
+
| `AGENT_PLAYBOOKS_DATA_PLANE_URL` | Its separate data-plane endpoint |
|
|
62
|
+
| `AGENT_PLAYBOOKS_SERVICE_TOKEN` | An authorized control-plane bearer token |
|
|
63
|
+
| `AGENT_PLAYBOOKS_API_KEY` | An agent key scoped to the selected Playbook |
|
|
64
|
+
| `AGENT_PLAYBOOKS_PLAYBOOK_ID` | The service-issued ID of that Playbook |
|
|
65
|
+
| `AGENT_PLAYBOOKS_DEBUG` | Enable data-plane HTTP debug logging |
|
|
66
|
+
| `AGENT_PLAYBOOKS_SERVICE_DEBUG` | Enable control-plane HTTP debug logging |
|
|
67
|
+
|
|
68
|
+
The SDKs automatically read the API key, Playbook ID, service token, and debug
|
|
69
|
+
settings when the corresponding constructor option is omitted. Explicit options
|
|
70
|
+
win, followed by `AGENT_PLAYBOOKS_*` variables, then legacy aliases:
|
|
71
|
+
`PLAYBOOK_API_KEY`, `PLAYBOOK_PLAYBOOK_ID`, `PLAYBOOK_DEBUG`,
|
|
72
|
+
`PLAYBOOK_SERVICE_TOKEN`, and `PLAYBOOK_SERVICE_DEBUG`. An explicitly set empty
|
|
73
|
+
new variable suppresses its legacy alias. These aliases do not modify the process
|
|
74
|
+
environment or allow credentials to cross between the two clients.
|
|
75
|
+
|
|
76
|
+
The URL variables above are application settings used by these examples. Both
|
|
77
|
+
clients require an explicit `server_url` (Python) or `serverURL` (TypeScript);
|
|
78
|
+
the core SDKs do not automatically read URLs from the environment.
|
|
79
|
+
|
|
54
80
|
Use an authorized control-plane bearer token for `token` and a resource-scoped
|
|
55
81
|
agent key for `apiKey`. TypeScript accepts an async credential provider for either
|
|
56
82
|
argument. Pass environment variables explicitly, as above. Creating a Playbook
|
|
@@ -69,10 +95,21 @@ they can wrap the same caller-supplied fetch function.
|
|
|
69
95
|
Control-plane types are isolated under
|
|
70
96
|
`@redis-iris/agent-playbook/controlplane/models`, with errors under
|
|
71
97
|
`@redis-iris/agent-playbook/controlplane/models/errors`. The existing `/models`
|
|
72
|
-
and `/models/errors` exports remain data-plane types. `
|
|
98
|
+
and `/models/errors` exports remain data-plane types. `AgentPlaybooksServiceOptions`
|
|
73
99
|
is exported at the package root. See the control-plane reference
|
|
74
100
|
for provisioning, lifecycle, clear, and extraction-management operations.
|
|
75
101
|
|
|
102
|
+
The control-plane client covers:
|
|
103
|
+
|
|
104
|
+
| Task | Methods |
|
|
105
|
+
| --- | --- |
|
|
106
|
+
| Provision and manage instances | `createPlaybook`, `listPlaybooks`, `getPlaybook`, `updatePlaybook`, `deletePlaybook` |
|
|
107
|
+
| Clear content administratively | `clearPlaybook` (requires `product_admin` or `suite_admin`) |
|
|
108
|
+
| Manage extraction | `listExtractionStores`, `listExtractionBindings`, `createExtractionBinding`, `getExtractionBinding`, `updateExtractionBinding`, `deleteExtractionBinding` |
|
|
109
|
+
| Discover supported models | `listModels` |
|
|
110
|
+
| Discover cloud resources | `listDatabases`, `getNetworkInfo` |
|
|
111
|
+
| Manage cloud model credentials | `getModelCredential`, `putModelCredential`, `deleteModelCredential` |
|
|
112
|
+
|
|
76
113
|
### Deployment availability
|
|
77
114
|
|
|
78
115
|
The shared control-plane operations work with both cloud and on-prem deployments.
|
|
@@ -87,28 +124,71 @@ constructor deployment flag is required: configure the appropriate endpoint.
|
|
|
87
124
|
Credential reads return status only, never a provider API key. These provider
|
|
88
125
|
credentials are separate from the control-plane token and data-plane agent key.
|
|
89
126
|
|
|
90
|
-
|
|
91
|
-
|
|
127
|
+
Cloud resource management and database discovery require the cloud session
|
|
128
|
+
cookie (`JSESSIONID`) and CSRF header (`X-CSRF-Token`) in addition to the operator
|
|
129
|
+
token; supply these through the client’s HTTP transport. Cloud
|
|
92
130
|
responses expose typed endpoint accessibility, egress addresses, and database
|
|
93
131
|
network metadata. These optional fields may be absent on-prem.
|
|
94
132
|
|
|
133
|
+
### Extraction binding access and readiness
|
|
134
|
+
|
|
135
|
+
Store suggestions are scoped to the tenant and do not grant access. Creating a
|
|
136
|
+
binding synchronously checks the caller's management consent, same-account RAM
|
|
137
|
+
store ownership, destination readiness, and execution scope. A foreign or missing
|
|
138
|
+
source is refused without revealing its metadata.
|
|
139
|
+
|
|
140
|
+
A new binding returns `ready` with `enabled=false`. Enable it with an update that
|
|
141
|
+
passes its `version` as `expectedVersion`. Every explicit enable revalidates source
|
|
142
|
+
consent and ownership with the current caller and can recover a blocked binding.
|
|
143
|
+
Pausing or deleting requires destination management access and makes no source or
|
|
144
|
+
grant-administration request. Runtime failures can mark a binding `blocked`;
|
|
145
|
+
clients must tolerate unknown `blockedReason` values.
|
|
146
|
+
|
|
147
|
+
Scan cadence is deployment-owned worker configuration. Binding requests and
|
|
148
|
+
responses omit `intervalSeconds`; `idleWindowSeconds` remains user-configurable.
|
|
149
|
+
|
|
95
150
|
## Release status
|
|
96
151
|
|
|
97
|
-
This SDK is
|
|
98
|
-
without a major-version increment. The prepared npm release is `0.1.0-
|
|
99
|
-
matching Python `0.1.
|
|
152
|
+
This SDK is a beta prerelease. Breaking changes may land between beta releases
|
|
153
|
+
without a major-version increment. The prepared npm release is `0.1.0-beta.2`,
|
|
154
|
+
matching Python `0.1.0b2`. Install an exact published version and upgrade intentionally:
|
|
100
155
|
|
|
101
156
|
```bash
|
|
102
|
-
npm install @redis-iris/agent-playbook@0.1.0-
|
|
157
|
+
npm install @redis-iris/agent-playbook@0.1.0-beta.2
|
|
103
158
|
```
|
|
104
159
|
|
|
105
160
|
Node.js 20 or later is required. Both ESM and CommonJS imports are supported.
|
|
106
161
|
|
|
107
162
|
The generated snippets below use `<id>`, `https://api.example.com`, and
|
|
108
|
-
`<
|
|
163
|
+
`<AGENT_PLAYBOOKS_API_KEY>` as placeholders. Replace them with your deployment URL,
|
|
109
164
|
bearer token, and service-issued IDs before running a snippet. In particular,
|
|
110
165
|
`<id>` does not satisfy the Playbook ID format and is rejected before a request.
|
|
111
166
|
|
|
167
|
+
## Upgrading to beta.2
|
|
168
|
+
|
|
169
|
+
Extraction job responses no longer expose `intervalSeconds`, and
|
|
170
|
+
`ExtractionBindingStatus` no longer declares `preparing`. Successful binding
|
|
171
|
+
creation returns `ready` and disabled; remove preparation polling and enable
|
|
172
|
+
explicitly after reviewing the binding. Remove reads of the retired scan-cadence
|
|
173
|
+
field and configure cadence on the deployment instead.
|
|
174
|
+
|
|
175
|
+
Cloud list/detail responses can report `state=unavailable` while preserving saved
|
|
176
|
+
configuration and omitting live database enrichment. This read state does not
|
|
177
|
+
confirm deletion or probe content Redis health. It cannot be submitted in a
|
|
178
|
+
mutation; writable states remain `ready` and `suspended`.
|
|
179
|
+
|
|
180
|
+
## Upgrading to beta.1
|
|
181
|
+
|
|
182
|
+
The control-plane client is now `AgentPlaybooksService`, replacing
|
|
183
|
+
`PlaybookService` without a compatibility alias. Update imports from both
|
|
184
|
+
`@redis-iris/agent-playbook` and `@redis-iris/agent-playbook/controlplane`.
|
|
185
|
+
Rename `PlaybookServiceOptions` to `AgentPlaybooksServiceOptions`, and import
|
|
186
|
+
`AgentPlaybooksServiceError` from the control-plane errors subpath in place of
|
|
187
|
+
`PlaybookServiceError`. The data-plane client remains `Playbook`. Environment variables now use the
|
|
188
|
+
product prefix `AGENT_PLAYBOOKS`; the previous runtime names remain fallback
|
|
189
|
+
aliases as described above. Endpoints are unchanged. Both clients are regenerated
|
|
190
|
+
from the same Iris main revision recorded in the contract provenance.
|
|
191
|
+
|
|
112
192
|
## Upgrading from alpha.2
|
|
113
193
|
|
|
114
194
|
Alpha.3 requires a server with the updated proposal contract. Publish both SDKs
|
|
@@ -126,7 +206,7 @@ increment `evidenceCount`/`evidence_count`. Proposal list/search support action
|
|
|
126
206
|
entry type selectors. `listProposals` now takes optional `actionType` and `entryType`
|
|
127
207
|
before `RequestOptions`; move positional options to the eighth argument. The data-plane clear operation and its models have been removed;
|
|
128
208
|
use explicit FAQ/Skill deletion operations when needed. Administrative clear is
|
|
129
|
-
available separately through `
|
|
209
|
+
available separately through `AgentPlaybooksService.clearPlaybook`.
|
|
130
210
|
|
|
131
211
|
Proposal input content is distinct from normalized read content; only FAQ-add
|
|
132
212
|
proposals are supported. Future response union members are retained in `raw`
|
|
@@ -142,6 +222,8 @@ contract for future actions without content.
|
|
|
142
222
|
* [Documentation](#documentation)
|
|
143
223
|
* [Two clients, one package](#two-clients-one-package)
|
|
144
224
|
* [Release status](#release-status)
|
|
225
|
+
* [Upgrading to beta.2](#upgrading-to-beta2)
|
|
226
|
+
* [Upgrading to beta.1](#upgrading-to-beta1)
|
|
145
227
|
* [Upgrading from alpha.2](#upgrading-from-alpha2)
|
|
146
228
|
* [SDK Installation](#sdk-installation)
|
|
147
229
|
* [Requirements](#requirements)
|
|
@@ -168,25 +250,25 @@ The SDK can be installed with either [npm](https://www.npmjs.com/), [pnpm](https
|
|
|
168
250
|
### NPM
|
|
169
251
|
|
|
170
252
|
```bash
|
|
171
|
-
npm add @redis-iris/agent-playbook@0.1.0-
|
|
253
|
+
npm add @redis-iris/agent-playbook@0.1.0-beta.2
|
|
172
254
|
```
|
|
173
255
|
|
|
174
256
|
### PNPM
|
|
175
257
|
|
|
176
258
|
```bash
|
|
177
|
-
pnpm add @redis-iris/agent-playbook@0.1.0-
|
|
259
|
+
pnpm add @redis-iris/agent-playbook@0.1.0-beta.2
|
|
178
260
|
```
|
|
179
261
|
|
|
180
262
|
### Bun
|
|
181
263
|
|
|
182
264
|
```bash
|
|
183
|
-
bun add @redis-iris/agent-playbook@0.1.0-
|
|
265
|
+
bun add @redis-iris/agent-playbook@0.1.0-beta.2
|
|
184
266
|
```
|
|
185
267
|
|
|
186
268
|
### Yarn
|
|
187
269
|
|
|
188
270
|
```bash
|
|
189
|
-
yarn add @redis-iris/agent-playbook@0.1.0-
|
|
271
|
+
yarn add @redis-iris/agent-playbook@0.1.0-beta.2
|
|
190
272
|
```
|
|
191
273
|
|
|
192
274
|
> [!NOTE]
|
|
@@ -197,7 +279,7 @@ yarn add @redis-iris/agent-playbook@0.1.0-alpha.3
|
|
|
197
279
|
|
|
198
280
|
Node.js 20 or later is required. CI validates Node 20, 22, and 24, including
|
|
199
281
|
ESM and CommonJS imports. The client uses Fetch and Web Streams APIs. Browser,
|
|
200
|
-
Bun, and Deno compatibility has not been validated for this
|
|
282
|
+
Bun, and Deno compatibility has not been validated for this beta release.
|
|
201
283
|
<!-- No Requirements [requirements] -->
|
|
202
284
|
|
|
203
285
|
<!-- Start SDK Example Usage [usage] -->
|
|
@@ -213,7 +295,7 @@ import { Playbook } from "@redis-iris/agent-playbook";
|
|
|
213
295
|
const playbook = new Playbook({
|
|
214
296
|
serverURL: "https://api.example.com",
|
|
215
297
|
playbookId: "<id>",
|
|
216
|
-
apiKey: "<
|
|
298
|
+
apiKey: "<AGENT_PLAYBOOKS_API_KEY>",
|
|
217
299
|
});
|
|
218
300
|
|
|
219
301
|
async function run() {
|
|
@@ -260,7 +342,7 @@ import { Playbook } from "@redis-iris/agent-playbook";
|
|
|
260
342
|
const playbook = new Playbook({
|
|
261
343
|
serverURL: "https://api.example.com",
|
|
262
344
|
playbookId: "<id>",
|
|
263
|
-
apiKey: "<
|
|
345
|
+
apiKey: "<AGENT_PLAYBOOKS_API_KEY>",
|
|
264
346
|
});
|
|
265
347
|
|
|
266
348
|
async function run() {
|
|
@@ -310,7 +392,7 @@ import { Playbook } from "@redis-iris/agent-playbook";
|
|
|
310
392
|
const playbook = new Playbook({
|
|
311
393
|
serverURL: "https://api.example.com",
|
|
312
394
|
playbookId: "<id>",
|
|
313
|
-
apiKey: "<
|
|
395
|
+
apiKey: "<AGENT_PLAYBOOKS_API_KEY>",
|
|
314
396
|
});
|
|
315
397
|
|
|
316
398
|
async function run() {
|
|
@@ -338,7 +420,7 @@ import { Playbook } from "@redis-iris/agent-playbook";
|
|
|
338
420
|
const playbook = new Playbook({
|
|
339
421
|
serverURL: "https://api.example.com",
|
|
340
422
|
playbookId: "<id>",
|
|
341
|
-
apiKey: "<
|
|
423
|
+
apiKey: "<AGENT_PLAYBOOKS_API_KEY>",
|
|
342
424
|
});
|
|
343
425
|
|
|
344
426
|
async function run() {
|
|
@@ -379,7 +461,7 @@ import { Playbook } from "@redis-iris/agent-playbook";
|
|
|
379
461
|
const playbook = new Playbook({
|
|
380
462
|
serverURL: "https://api.example.com",
|
|
381
463
|
playbookId: "<id>",
|
|
382
|
-
apiKey: "<
|
|
464
|
+
apiKey: "<AGENT_PLAYBOOKS_API_KEY>",
|
|
383
465
|
});
|
|
384
466
|
|
|
385
467
|
async function run() {
|
|
@@ -422,7 +504,7 @@ import { Playbook } from "@redis-iris/agent-playbook";
|
|
|
422
504
|
const playbook = new Playbook({
|
|
423
505
|
serverURL: "https://api.example.com",
|
|
424
506
|
playbookId: "<id>",
|
|
425
|
-
apiKey: "<
|
|
507
|
+
apiKey: "<AGENT_PLAYBOOKS_API_KEY>",
|
|
426
508
|
});
|
|
427
509
|
|
|
428
510
|
async function run() {
|
|
@@ -455,7 +537,7 @@ import { Playbook } from "@redis-iris/agent-playbook";
|
|
|
455
537
|
const playbook = new Playbook({
|
|
456
538
|
serverURL: "https://api.example.com",
|
|
457
539
|
playbookId: "<id>",
|
|
458
|
-
apiKey: "<
|
|
540
|
+
apiKey: "<AGENT_PLAYBOOKS_API_KEY>",
|
|
459
541
|
});
|
|
460
542
|
|
|
461
543
|
async function run() {
|
|
@@ -492,7 +574,7 @@ import { Playbook } from "@redis-iris/agent-playbook";
|
|
|
492
574
|
const playbook = new Playbook({
|
|
493
575
|
serverURL: "https://api.example.com",
|
|
494
576
|
playbookId: "<id>",
|
|
495
|
-
apiKey: "<
|
|
577
|
+
apiKey: "<AGENT_PLAYBOOKS_API_KEY>",
|
|
496
578
|
});
|
|
497
579
|
|
|
498
580
|
async function run() {
|
|
@@ -549,7 +631,7 @@ import { Playbook } from "@redis-iris/agent-playbook";
|
|
|
549
631
|
const playbook = new Playbook({
|
|
550
632
|
serverURL: "https://api.example.com",
|
|
551
633
|
playbookId: "<id>",
|
|
552
|
-
apiKey: "<
|
|
634
|
+
apiKey: "<AGENT_PLAYBOOKS_API_KEY>",
|
|
553
635
|
});
|
|
554
636
|
|
|
555
637
|
async function run() {
|
|
@@ -591,7 +673,7 @@ import { Playbook } from "@redis-iris/agent-playbook";
|
|
|
591
673
|
const playbook = new Playbook({
|
|
592
674
|
serverURL: "https://api.example.com",
|
|
593
675
|
playbookId: "<id>",
|
|
594
|
-
apiKey: "<
|
|
676
|
+
apiKey: "<AGENT_PLAYBOOKS_API_KEY>",
|
|
595
677
|
});
|
|
596
678
|
|
|
597
679
|
async function run() {
|
|
@@ -627,7 +709,7 @@ import { Playbook } from "@redis-iris/agent-playbook";
|
|
|
627
709
|
const playbook = new Playbook({
|
|
628
710
|
serverURL: "https://api.example.com",
|
|
629
711
|
playbookId: "pb_0123456789abcdef0123456789abcdef",
|
|
630
|
-
apiKey: "<
|
|
712
|
+
apiKey: "<AGENT_PLAYBOOKS_API_KEY>",
|
|
631
713
|
});
|
|
632
714
|
const content = {
|
|
633
715
|
intents: ["Where is my refund?"],
|
|
@@ -662,7 +744,7 @@ import { readFile } from "node:fs/promises";
|
|
|
662
744
|
import { Playbook } from "@redis-iris/agent-playbook";
|
|
663
745
|
|
|
664
746
|
const playbook = new Playbook({ serverURL: "https://api.example.com",
|
|
665
|
-
playbookId: "pb_0123456789abcdef0123456789abcdef", apiKey: "<
|
|
747
|
+
playbookId: "pb_0123456789abcdef0123456789abcdef", apiKey: "<AGENT_PLAYBOOKS_API_KEY>" });
|
|
666
748
|
const content = { intents: ["Resolve a late delivery"], attributes: { audience: "support" } };
|
|
667
749
|
const created = await playbook.createSkill({ entryKey: "late-delivery-resolution", content,
|
|
668
750
|
packageBase64: (await readFile("late-delivery-resolution-v1.zip")).toString("base64") });
|
|
@@ -681,7 +763,7 @@ console.log(await playbook.listSkills(), await playbook.listSkillVersions(skillI
|
|
|
681
763
|
import { Playbook } from "@redis-iris/agent-playbook";
|
|
682
764
|
|
|
683
765
|
const playbook = new Playbook({ serverURL: "https://api.example.com",
|
|
684
|
-
playbookId: "pb_0123456789abcdef0123456789abcdef", apiKey: "<
|
|
766
|
+
playbookId: "pb_0123456789abcdef0123456789abcdef", apiKey: "<AGENT_PLAYBOOKS_API_KEY>" });
|
|
685
767
|
const filter = { eq: { name: "audience", value: "support" } };
|
|
686
768
|
console.log(await playbook.searchFaqs({ query: "Where is my refund?", filter, minimumScore: 0.72, limit: 5 }));
|
|
687
769
|
console.log(await playbook.searchSkills({ query: "Resolve a late delivery", filter, minimumScore: 0.72, limit: 5 }));
|
|
@@ -711,7 +793,7 @@ import { randomUUID } from "node:crypto";
|
|
|
711
793
|
import { Playbook } from "@redis-iris/agent-playbook";
|
|
712
794
|
|
|
713
795
|
const playbook = new Playbook({ serverURL: "https://api.example.com",
|
|
714
|
-
playbookId: "pb_0123456789abcdef0123456789abcdef", apiKey: "<
|
|
796
|
+
playbookId: "pb_0123456789abcdef0123456789abcdef", apiKey: "<AGENT_PLAYBOOKS_API_KEY>" });
|
|
715
797
|
const action = { add: { target: { newEntry: { entryKey: "refund-bank-delay" } },
|
|
716
798
|
candidate: { content: { payload: { faq: { question: "Why hasn't my refund appeared?",
|
|
717
799
|
answer: "The issuing bank controls final posting time." } } } } } };
|
|
@@ -767,7 +849,7 @@ import { createHash } from "node:crypto";
|
|
|
767
849
|
import { Playbook } from "@redis-iris/agent-playbook";
|
|
768
850
|
|
|
769
851
|
const playbook = new Playbook({ serverURL: "https://api.example.com",
|
|
770
|
-
playbookId: "pb_0123456789abcdef0123456789abcdef", apiKey: "<
|
|
852
|
+
playbookId: "pb_0123456789abcdef0123456789abcdef", apiKey: "<AGENT_PLAYBOOKS_API_KEY>" });
|
|
771
853
|
const skillId = "ent_0123456789abcdef0123456789abcdef";
|
|
772
854
|
const version = await playbook.getSkillVersion(skillId, 1);
|
|
773
855
|
if (!("skill" in version.content.payload)) throw new Error("Expected a Skill payload");
|
|
@@ -789,9 +871,9 @@ if (descriptor.digest !== "sha256:" + digest.toString("hex") || header !== "sha-
|
|
|
789
871
|
|
|
790
872
|
This SDK supports the following security scheme globally:
|
|
791
873
|
|
|
792
|
-
| Name | Type | Scheme | Environment Variable
|
|
793
|
-
| -------- | ---- | ----------- |
|
|
794
|
-
| `apiKey` | http | HTTP Bearer | `
|
|
874
|
+
| Name | Type | Scheme | Environment Variable |
|
|
875
|
+
| -------- | ---- | ----------- | ------------------------- |
|
|
876
|
+
| `apiKey` | http | HTTP Bearer | `AGENT_PLAYBOOKS_API_KEY` |
|
|
795
877
|
|
|
796
878
|
To authenticate with the API the `apiKey` parameter must be set when initializing the SDK client instance. For example:
|
|
797
879
|
```typescript
|
|
@@ -799,7 +881,7 @@ import { Playbook } from "@redis-iris/agent-playbook";
|
|
|
799
881
|
|
|
800
882
|
const playbook = new Playbook({
|
|
801
883
|
serverURL: "https://api.example.com",
|
|
802
|
-
apiKey: "<
|
|
884
|
+
apiKey: "<AGENT_PLAYBOOKS_API_KEY>",
|
|
803
885
|
playbookId: "<id>",
|
|
804
886
|
});
|
|
805
887
|
|
|
@@ -954,7 +1036,7 @@ digest bytes and must not be compared as strings.
|
|
|
954
1036
|
## Global Parameters
|
|
955
1037
|
|
|
956
1038
|
A client is bound to one Playbook. Set `playbookId` in the constructor or set the
|
|
957
|
-
`
|
|
1039
|
+
`AGENT_PLAYBOOKS_PLAYBOOK_ID` environment variable. The constructor option takes precedence.
|
|
958
1040
|
Methods do not expose a per-operation `playbookId` override; create another client
|
|
959
1041
|
to use a different Playbook. Supply `serverURL` explicitly for each client.
|
|
960
1042
|
|
|
@@ -964,7 +1046,7 @@ import { Playbook } from "@redis-iris/agent-playbook";
|
|
|
964
1046
|
const playbook = new Playbook({
|
|
965
1047
|
serverURL: "https://api.example.com",
|
|
966
1048
|
playbookId: "pb_0123456789abcdef0123456789abcdef",
|
|
967
|
-
apiKey: "<
|
|
1049
|
+
apiKey: "<AGENT_PLAYBOOKS_API_KEY>",
|
|
968
1050
|
});
|
|
969
1051
|
const result = await playbook.getPlaybookHealth();
|
|
970
1052
|
console.log(result);
|
|
@@ -1006,7 +1088,7 @@ import * as errors from "@redis-iris/agent-playbook/models/errors";
|
|
|
1006
1088
|
const playbook = new Playbook({
|
|
1007
1089
|
serverURL: "https://api.example.com",
|
|
1008
1090
|
playbookId: "<id>",
|
|
1009
|
-
apiKey: "<
|
|
1091
|
+
apiKey: "<AGENT_PLAYBOOKS_API_KEY>",
|
|
1010
1092
|
});
|
|
1011
1093
|
|
|
1012
1094
|
async function run() {
|
|
@@ -1134,7 +1216,7 @@ httpClient.addHook("requestError", (error, request) => {
|
|
|
1134
1216
|
console.groupEnd();
|
|
1135
1217
|
});
|
|
1136
1218
|
|
|
1137
|
-
const
|
|
1219
|
+
const playbook = new Playbook({ serverURL: "https://api.example.com",
|
|
1138
1220
|
playbookId: "pb_0123456789abcdef0123456789abcdef", httpClient });
|
|
1139
1221
|
```
|
|
1140
1222
|
<!-- No Custom HTTP Client [http-client] -->
|
|
@@ -1151,11 +1233,11 @@ You can pass a logger that matches `console`'s interface as an SDK option.
|
|
|
1151
1233
|
```typescript
|
|
1152
1234
|
import { Playbook } from "@redis-iris/agent-playbook";
|
|
1153
1235
|
|
|
1154
|
-
const
|
|
1236
|
+
const playbook = new Playbook({ serverURL: "https://api.example.com",
|
|
1155
1237
|
playbookId: "pb_0123456789abcdef0123456789abcdef", debugLogger: console });
|
|
1156
1238
|
```
|
|
1157
1239
|
|
|
1158
|
-
You can also enable a default debug logger by setting an environment variable `
|
|
1240
|
+
You can also enable a default debug logger by setting an environment variable `AGENT_PLAYBOOKS_DEBUG` to true.
|
|
1159
1241
|
<!-- No Debugging [debug] -->
|
|
1160
1242
|
|
|
1161
1243
|
<!-- Placeholder for Future Speakeasy SDK Sections -->
|
|
@@ -1164,7 +1246,7 @@ You can also enable a default debug logger by setting an environment variable `P
|
|
|
1164
1246
|
|
|
1165
1247
|
## Maturity
|
|
1166
1248
|
|
|
1167
|
-
This SDK is
|
|
1249
|
+
This SDK is a beta prerelease. Pin an exact published version and upgrade intentionally.
|
|
1168
1250
|
|
|
1169
1251
|
## Contributions
|
|
1170
1252
|
|
package/RUNTIMES.md
CHANGED
|
@@ -10,7 +10,7 @@ This SDK is intended to be used in JavaScript runtimes that support ECMAScript 2
|
|
|
10
10
|
[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
|
|
11
11
|
[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
|
|
12
12
|
|
|
13
|
-
This
|
|
13
|
+
This beta package requires **Node.js 20 or later**. CI validates Node 20, 22,
|
|
14
14
|
and 24, including ESM and CommonJS imports, compiled TypeScript declarations,
|
|
15
15
|
HTTP behavior, and the packed npm artifact.
|
|
16
16
|
|
|
@@ -5,6 +5,6 @@ import { ClientSDK } from "./lib/sdks.js";
|
|
|
5
5
|
* application and passed around through some dependency injection mechanism to
|
|
6
6
|
* parts of an application that need to make SDK calls.
|
|
7
7
|
*/
|
|
8
|
-
export declare class
|
|
8
|
+
export declare class AgentPlaybooksServiceCore extends ClientSDK {
|
|
9
9
|
}
|
|
10
10
|
//# sourceMappingURL=core.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../../../src/controlplane/core.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;;;;GAKG;AACH,qBAAa,
|
|
1
|
+
{"version":3,"file":"core.d.ts","sourceRoot":"","sources":["../../../src/controlplane/core.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,SAAS,EAAE,MAAM,eAAe,CAAC;AAE1C;;;;;GAKG;AACH,qBAAa,yBAA0B,SAAQ,SAAS;CAAG"}
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
* Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
|
|
4
4
|
*/
|
|
5
5
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
6
|
-
exports.
|
|
6
|
+
exports.AgentPlaybooksServiceCore = void 0;
|
|
7
7
|
const sdks_js_1 = require("./lib/sdks.js");
|
|
8
8
|
/**
|
|
9
9
|
* A minimal client to use when calling standalone SDK functions. Typically, an
|
|
@@ -11,7 +11,7 @@ const sdks_js_1 = require("./lib/sdks.js");
|
|
|
11
11
|
* application and passed around through some dependency injection mechanism to
|
|
12
12
|
* parts of an application that need to make SDK calls.
|
|
13
13
|
*/
|
|
14
|
-
class
|
|
14
|
+
class AgentPlaybooksServiceCore extends sdks_js_1.ClientSDK {
|
|
15
15
|
}
|
|
16
|
-
exports.
|
|
16
|
+
exports.AgentPlaybooksServiceCore = AgentPlaybooksServiceCore;
|
|
17
17
|
//# sourceMappingURL=core.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"core.js","sourceRoot":"","sources":["../../../src/controlplane/core.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,2CAA0C;AAE1C;;;;;GAKG;AACH,
|
|
1
|
+
{"version":3,"file":"core.js","sourceRoot":"","sources":["../../../src/controlplane/core.ts"],"names":[],"mappings":";AAAA;;GAEG;;;AAEH,2CAA0C;AAE1C;;;;;GAKG;AACH,+BAAuC,SAAQ,mBAAS;CAAG"}
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { AgentPlaybooksServiceCore } from "../core.js";
|
|
2
2
|
import { RequestOptions } from "../lib/sdks.js";
|
|
3
|
+
import { AgentPlaybooksServiceError } from "../models/errors/agent-playbooks-service-error.js";
|
|
3
4
|
import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/http-client-errors.js";
|
|
4
5
|
import * as errors from "../models/errors/index.js";
|
|
5
|
-
import { PlaybookServiceError } from "../models/errors/playbook-service-error.js";
|
|
6
6
|
import { ResponseValidationError } from "../models/errors/response-validation-error.js";
|
|
7
7
|
import { SDKValidationError } from "../models/errors/sdk-validation-error.js";
|
|
8
8
|
import * as models from "../models/index.js";
|
|
@@ -11,5 +11,5 @@ import { Result } from "../types/fp.js";
|
|
|
11
11
|
/**
|
|
12
12
|
* Administratively clears all (default), entries, or proposals from a ready Playbook, preserving configuration and index readiness. Requires product_admin or suite_admin. Cleanup is not atomic across content: failures can leave partial progress; retry the same scope after resolving the failure. Without new writes, repeating a successful clear removes no additional entry families.
|
|
13
13
|
*/
|
|
14
|
-
export declare function clearPlaybook(client:
|
|
14
|
+
export declare function clearPlaybook(client: AgentPlaybooksServiceCore, playbookId: string, scope?: models.ClearScope | undefined, options?: RequestOptions): APIPromise<Result<models.ClearPlaybookResponseContent, errors.BadRequestErrorResponseContent | errors.AuthenticationErrorResponseContent | errors.ExtractionForbiddenErrorResponseContent | errors.NotFoundErrorResponseContent | errors.TimeoutErrorResponseContent | errors.ResourceSuspendedErrorResponseContent | errors.FailedDependencyErrorResponseContent | errors.UnexpectedErrorResponseContent | errors.PlaybookServiceUnavailableErrorResponseContent | AgentPlaybooksServiceError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
|
|
15
15
|
//# sourceMappingURL=clear-playbook.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"clear-playbook.d.ts","sourceRoot":"","sources":["../../../../src/controlplane/funcs/clear-playbook.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,
|
|
1
|
+
{"version":3,"file":"clear-playbook.d.ts","sourceRoot":"","sources":["../../../../src/controlplane/funcs/clear-playbook.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAC;AAMvD,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,EAAE,0BAA0B,EAAE,MAAM,mDAAmD,CAAC;AAC/F,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,wCAAwC,CAAC;AAChD,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,+CAA+C,CAAC;AACxF,OAAO,EAAE,kBAAkB,EAAE,MAAM,0CAA0C,CAAC;AAC9E,OAAO,KAAK,MAAM,MAAM,oBAAoB,CAAC;AAE7C,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;GAEG;AACH,wBAAgB,aAAa,CAC3B,MAAM,EAAE,yBAAyB,EACjC,UAAU,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,MAAM,CAAC,UAAU,GAAG,SAAS,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,MAAM,CAAC,4BAA4B,EACjC,MAAM,CAAC,8BAA8B,GACrC,MAAM,CAAC,kCAAkC,GACzC,MAAM,CAAC,uCAAuC,GAC9C,MAAM,CAAC,4BAA4B,GACnC,MAAM,CAAC,2BAA2B,GAClC,MAAM,CAAC,qCAAqC,GAC5C,MAAM,CAAC,oCAAoC,GAC3C,MAAM,CAAC,8BAA8B,GACrC,MAAM,CAAC,8CAA8C,GACrD,0BAA0B,GAC1B,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAOA"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"clear-playbook.js","sourceRoot":"","sources":["../../../../src/controlplane/funcs/clear-playbook.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGH,sDAAoE;AACpE,4CAAiD;AACjD,MAAY,CAAC,+CAA2B;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;
|
|
1
|
+
{"version":3,"file":"clear-playbook.js","sourceRoot":"","sources":["../../../../src/controlplane/funcs/clear-playbook.ts"],"names":[],"mappings":";AAAA;;GAEG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGH,sDAAoE;AACpE,4CAAiD;AACjD,MAAY,CAAC,+CAA2B;AACxC,wDAAkD;AAClD,kDAA8C;AAE9C,oDAA4E;AAC5E,0CAA2C;AAS3C,MAAY,MAAM,sDAAkC;AAGpD,MAAY,MAAM,+CAA2B;AAC7C,MAAY,UAAU,0DAAsC;AAC5D,gDAAwD;AAGxD;;GAEG;AACH,uBACE,MAAiC,EACjC,UAAkB,EAClB,KAAqC,EACrC,OAAwB,EAsBxB;IACA,OAAO,IAAI,qBAAU,CAAC,GAAG,CACvB,MAAM,EACN,UAAU,EACV,KAAK,EACL,OAAO,CACR,CAAC,CAAC;AAAA,CACJ;AAED,KAAK,UAAU,GAAG,CAChB,MAAiC,EACjC,UAAkB,EAClB,KAAqC,EACrC,OAAwB,EAyBxB;IACA,MAAM,KAAK,GAAoC;QAC7C,UAAU,EAAE,UAAU;QACtB,KAAK,EAAE,KAAK;KACb,CAAC;IAEF,MAAM,MAAM,GAAG,IAAA,sBAAS,EACtB,KAAK,EACL,CAAC,KAAK,EAAE,EAAE,CAAC,UAAU,CAAC,mCAAmC,CAAC,KAAK,CAAC,KAAK,CAAC,EACtE,yBAAyB,CAC1B,CAAC;IACF,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IACzC,CAAC;IACD,MAAM,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC;IAC7B,MAAM,IAAI,GAAG,IAAI,CAAC;IAElB,MAAM,UAAU,GAAG;QACjB,UAAU,EAAE,IAAA,2BAAY,EAAC,YAAY,EAAE,OAAO,CAAC,UAAU,EAAE;YACzD,OAAO,EAAE,KAAK;YACd,YAAY,EAAE,SAAS;SACxB,CAAC;KACH,CAAC;IACF,MAAM,IAAI,GAAG,IAAA,mBAAU,EAAC,kCAAkC,CAAC,CAAC,UAAU,CAAC,CAAC;IAExE,MAAM,KAAK,GAAG,IAAA,8BAAe,EAAC;QAC5B,OAAO,EAAE,OAAO,CAAC,KAAK;KACvB,CAAC,CAAC;IAEH,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,IAAA,0BAAU,EAAC;QACrC,MAAM,EAAE,kBAAkB;KAC3B,CAAC,CAAC,CAAC;IAEJ,MAAM,SAAS,GAAG,MAAM,IAAA,6BAAe,EAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;IAC/D,MAAM,aAAa,GAAG,SAAS,IAAI,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;IACpE,MAAM,eAAe,GAAG,IAAA,mCAAqB,EAAC,aAAa,CAAC,CAAC;IAE7D,MAAM,OAAO,GAAG;QACd,OAAO,EAAE,MAAM,CAAC,QAAQ;QACxB,OAAO,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,IAAI,EAAE;QACpD,WAAW,EAAE,eAAe;QAC5B,YAAY,EAAE,IAAI;QAElB,gBAAgB,EAAE,eAAe;QAEjC,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK;QACrC,WAAW,EAAE,OAAO,EAAE,OAAO;eACxB,MAAM,CAAC,QAAQ,CAAC,WAAW;eAC3B,EAAE,QAAQ,EAAE,MAAM,EAAE;QACzB,UAAU,EAAE,OAAO,EAAE,UAAU,IAAI,CAAC,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,CAAC;KACvE,CAAC;IAEF,MAAM,UAAU,GAAG,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE;QAChD,QAAQ,EAAE,eAAe;QACzB,MAAM,EAAE,MAAM;QACd,OAAO,EAAE,OAAO,EAAE,SAAS;QAC3B,IAAI,EAAE,IAAI;QACV,OAAO,EAAE,OAAO;QAChB,KAAK,EAAE,KAAK;QACZ,IAAI,EAAE,IAAI;QACV,SAAS,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS;QACpC,SAAS,EAAE,OAAO,EAAE,SAAS,IAAI,MAAM,CAAC,QAAQ,CAAC,SAAS,IAAI,CAAC,CAAC;KACjE,EAAE,OAAO,CAAC,CAAC;IACZ,IAAI,CAAC,UAAU,CAAC,EAAE,EAAE,CAAC;QACnB,OAAO,CAAC,UAAU,EAAE,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;IAC7C,CAAC;IACD,MAAM,GAAG,GAAG,UAAU,CAAC,KAAK,CAAC;IAE7B,MAAM,QAAQ,GAAG,MAAM,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE;QACrC,OAAO;QACP,iBAAiB,EAAE,CAAC,UAAkB,EAAE,EAAE,CACxC,IAAA,yBAAe,EAAC,EAAE,MAAM,EAAE,UAAU,EAAc,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QACrE,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IACH,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;QACjB,OAAO,CAAC,QAAQ,EAAE,EAAE,MAAM,EAAE,eAAe,EAAE,OAAO,EAAE,GAAG,EAAE,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC;IAEhC,MAAM,cAAc,GAAG;QACrB,QAAQ,EAAE,EAAE,QAAQ,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,EAAE;KAC/C,CAAC;IAEF,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,CAAC,KAAK,CAoB5B,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,0CAA0C,CAAC,EAC9D,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,4CAA4C,CAAC,EACnE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,gDAAgD,CAAC,EACvE,CAAC,CAAC,OAAO,CACP,GAAG,EACH,MAAM,CAAC,qDAAqD,CAC7D,EACD,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,0CAA0C,CAAC,EACjE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,yCAAyC,CAAC,EAChE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,mDAAmD,CAAC,EAC1E,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,kDAAkD,CAAC,EACzE,CAAC,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,4CAA4C,CAAC,EACnE,CAAC,CAAC,OAAO,CACP,GAAG,EACH,MAAM,CAAC,4DAA4D,CACpE,EACD,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,EACb,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CACd,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,WAAW,EAAE,cAAc,EAAE,CAAC,CAAC;IAClD,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;QACf,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;IAClE,CAAC;IAED,OAAO,CAAC,MAAM,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,CAAC,CAAC;AAAA,CACjE"}
|